discourse/lib/enum.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

54 lines
1.4 KiB
Ruby
Raw Permalink Normal View History

# frozen_string_literal: true
class Enum < Hash
2013-03-01 07:07:44 -05:00
# 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.
2013-03-01 07:07:44 -05:00
#
# 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
2013-03-01 07:07:44 -05:00
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
2013-03-01 07:07:44 -05:00
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 { |d| d.keep_if { |k| keys.include?(k) } }
2013-03-01 07:07:44 -05:00
end
# Public: Create a subset of enum, preserve all items but specified ones.
def except(*keys)
dup.tap { |d| d.delete_if { |k| keys.include?(k) } }
2013-03-01 07:07:44 -05:00
end
end