discourse/lib/enum.rb
Sam Saffron 30990006a9 DEV: enable frozen string literal on all files
This reduces chances of errors where consumers of strings mutate inputs
and reduces memory usage of the app.

Test suite passes now, but there may be some stuff left, so we will run
a few sites on a branch prior to merging
2019-05-13 09:31:32 +08:00

58 lines
1.4 KiB
Ruby

# frozen_string_literal: true
class Enum < Hash
# Public: Initialize an enum.
#
# members - Array of enum members or Hash of enum members.
# Array of enum members may also contain a hash of options:
# :start - the number of first enum member. Defaults to 1.
#
# Examples
#
# FRUITS = Enum.new(:apple, :orange, :kiwi) # array
# FRUITS = Enum.new(:apple, :orange, :kiwi, start: 0) # array
# FRUITS = Enum.new(apple: 1, orange: 2, kiwi: 3) # hash
def initialize(*members)
super({})
if members[0].is_a?(Hash)
# hash
update Hash[members[0]]
else
# array
options = members.extract_options!
start = options.fetch(:start) { 1 }
update Hash[members.zip(start..members.count + start)]
end
end
# Public: Access the number/value of member.
#
# ids_or_value - number or value of member.
#
# Returns value if number was provided, and number if value was provided.
def [](id_or_value)
fetch(id_or_value) { key(id_or_value) }
end
# Public: Check if supplied member is valid.
def valid?(member)
has_key?(member)
end
# Public: Create a subset of enum, only include specified keys.
def only(*keys)
dup.tap do |d|
d.keep_if { |k| keys.include?(k) }
end
end
# Public: Create a subset of enum, preserve all items but specified ones.
def except(*keys)
dup.tap do |d|
d.delete_if { |k| keys.include?(k) }
end
end
end