Class: ActiveEnum::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/active_enum/base.rb

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.store=(value) ⇒ Object

Sets the attribute store

Parameters:

  • value —

    the value to set the attribute store to.



8
9
10
 
# File 'lib/active_enum/base.rb', line 8

def store=(value)
  @store = value
end

Class Method Details

.[](index) ⇒ Object 



91
92
93
 
# File 'lib/active_enum/base.rb', line 91

def [](index)
  get(index)
end

.each(&block) ⇒ Object 



44
45
46
 
# File 'lib/active_enum/base.rb', line 44

def each(&block)
  all.each(&block)
end

.get(index, raise_on_not_found: ActiveEnum.raise_on_not_found) ⇒ Object

Access id or name value. Pass an id number to retrieve the name or a symbol or string to retrieve the matching id.



85
86
87
88
89
 
# File 'lib/active_enum/base.rb', line 85

def get(index, raise_on_not_found:  ActiveEnum.raise_on_not_found)
  row = get_value(index, raise_on_not_found)
  return if row.nil?
  index.is_a?(Integer) ? row[1] : row[0]
end

.ids ⇒ Object

Array of all enum id values



49
50
51
 
# File 'lib/active_enum/base.rb', line 49

def ids
  store.values.map { |v| v[0] }
end

.include?(value) ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/active_enum/base.rb', line 95

def include?(value)
  !get_value(value, false).nil?
end

.inherited(subclass) ⇒ Object 



10
11
12
 
# File 'lib/active_enum/base.rb', line 10

def inherited(subclass)
  ActiveEnum.enum_classes << subclass
end

.length ⇒ Object Also known as: size

Return count of values defined



78
79
80
 
# File 'lib/active_enum/base.rb', line 78

def length
  store.values.length
end

.meta(index, raise_on_not_found: ActiveEnum.raise_on_not_found) ⇒ Object

Access any meta data defined for a given id or name. Returns a hash.



100
101
102
103
 
# File 'lib/active_enum/base.rb', line 100

def meta(index, raise_on_not_found: ActiveEnum.raise_on_not_found)
  row = get_value(index, raise_on_not_found)
  row[2] || {} if row
end

.names ⇒ Object

Array of all enum name values



54
55
56
 
# File 'lib/active_enum/base.rb', line 54

def names
  store.values.map { |v| v[1] }
end

.order(order) ⇒ Object

Specify order enum values are returned. Allowed values are :asc, :desc or :natural



28
29
30
31
32
33
34
35
36
 
# File 'lib/active_enum/base.rb', line 28

def order(order)
  raise "Invalid order '#{order}' in #{self}" unless order.in?([:asc, :desc, :as_defined, :natural])

  if order == :as_defined
    ActiveSupport::Deprecation.warn("You are using the order :as_defined which has been deprecated. Use :natural.")
    order = :natural
  end
  @order = order
end

.to_grouped_select(group_by, group_transform: ActiveEnum.default_select_group_transform, value_transform: ActiveEnum.default_select_value_transform) ⇒ Object

Return enum values in a nested array suitable to pass to a Rails form grouped select helper.



64
65
66
67
68
 
# File 'lib/active_enum/base.rb', line 64

def to_grouped_select(group_by, group_transform: ActiveEnum.default_select_group_transform, value_transform: ActiveEnum.default_select_value_transform)
  store.values.group_by { |(_id, _name, meta)| (meta || {})[group_by] }.map { |group, collection|
    [ group_transform.call(group), collection.map { |(id, name, _meta)| [ name.html_safe, id ] } ]
  }
end

.to_h ⇒ Object

Return a simple hash of key value pairs id => name for each value



71
72
73
74
75
 
# File 'lib/active_enum/base.rb', line 71

def to_h
  store.values.inject({}) { |hash, row|
    hash.merge(row[0] => row[1])
  }
end

.to_select(value_transform: ActiveEnum.default_select_value_transform) ⇒ Object

Return enum values in an array suitable to pass to a Rails form select helper.



59
60
61
 
# File 'lib/active_enum/base.rb', line 59

def to_select(value_transform: ActiveEnum.default_select_value_transform)
  store.values.map(&value_transform)
end

.value(enum_value) ⇒ Object

Define enum values.

Examples:

value :id => 1, :name => 'Foo'
value :name => 'Foo' # implicit id, incrementing from 1.
value 1 => 'Foo'



21
22
23
 
# File 'lib/active_enum/base.rb', line 21

def value(enum_value)
  store.set(*id_and_name_and_meta(enum_value))
end

.values ⇒ Object Also known as: all

Array of arrays of stored values defined id, name, meta values hash



39
40
41
 
# File 'lib/active_enum/base.rb', line 39

def values
  store.values
end