Module: Ruby::Enum::ClassMethods

Defined in:
lib/ruby-enum/enum.rb

Instance Method Summary collapse

Instance Method Details

#const_missing(key) ⇒ Object

Raises:



45
46
47
 
# File 'lib/ruby-enum/enum.rb', line 45

def const_missing(key)
  raise Ruby::Enum::Errors::UninitializedConstantError, name: name, key: key
end

#define(key, value) ⇒ Object

Define an enumerated value.

Parameters

key

Enumerator key.

value

Enumerator value.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/ruby-enum/enum.rb', line 23

def define(key, value)
  @_enum_hash ||= {}
  @_enums_by_value ||= {}

  validate_key!(key)
  validate_value!(value)

  store_new_instance(key, value)

  if upper?(key.to_s)
    const_set key, value
  else
    define_singleton_method(key) { value }
  end
end

#each(&block) ⇒ Object

Iterate over all enumerated values. Required for Enumerable mixin



51
52
53
 
# File 'lib/ruby-enum/enum.rb', line 51

def each(&block)
  @_enum_hash.each(&block)
end

#key(v) ⇒ Object

Gets the key symbol for the specified value.

Parameters

v

The string value to parse.

Returns the corresponding key symbol or nil.



107
108
109
110
 
# File 'lib/ruby-enum/enum.rb', line 107

def key(v)
  enum = @_enums_by_value[v]
  enum.key if enum
end

#key?(k) ⇒ Boolean

Whether the specified key exists in this enum.

Parameters

k

The string key to check.

Returns true if the key exists, false otherwise.

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/ruby-enum/enum.rb', line 76

def key?(k)
  @_enum_hash.key?(k)
end

#keys ⇒ Object

Returns all enum keys.



113
114
115
 
# File 'lib/ruby-enum/enum.rb', line 113

def keys
  @_enum_hash.values.map(&:key)
end

#parse(k) ⇒ Object

Attempt to parse an enum key and return the corresponding value.

Parameters

k

The key string to parse.

Returns the corresponding value or nil.



62
63
64
65
66
67
68
 
# File 'lib/ruby-enum/enum.rb', line 62

def parse(k)
  k = k.to_s.upcase
  each do |key, enum|
    return enum.value if key.to_s.upcase == k
  end
  nil
end

#store_new_instance(key, value) ⇒ Object 



39
40
41
42
43
 
# File 'lib/ruby-enum/enum.rb', line 39

def store_new_instance(key, value)
  new_instance = new(key, value)
  @_enum_hash[key] = new_instance
  @_enums_by_value[value] = new_instance
end

#to_h ⇒ Object 



122
123
124
125
126
 
# File 'lib/ruby-enum/enum.rb', line 122

def to_h
  Hash[@_enum_hash.map do |key, enum|
    [key, enum.value]
  end]
end

#value(k) ⇒ Object

Gets the string value for the specified key.

Parameters

k

The key symbol to get the value for.

Returns the corresponding enum instance or nil.



86
87
88
89
 
# File 'lib/ruby-enum/enum.rb', line 86

def value(k)
  enum = @_enum_hash[k]
  enum.value if enum
end

#value?(v) ⇒ Boolean

Whether the specified value exists in this enum.

Parameters

k

The string value to check.

Returns true if the value exists, false otherwise.

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/ruby-enum/enum.rb', line 97

def value?(v)
  @_enums_by_value.key?(v)
end

#values ⇒ Object

Returns all enum values.



118
119
120
 
# File 'lib/ruby-enum/enum.rb', line 118

def values
  @_enum_hash.values.map(&:value)
end