Module: Storytime::Enum

Extended by:
ActiveSupport::Concern
Defined in:
app/models/concerns/storytime/enum.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object

:nodoc:



4
5
6
7
 
# File 'app/models/concerns/storytime/enum.rb', line 4

def self.extended(base) # :nodoc:
  base.class_attribute(:defined_enums)
  base.defined_enums = {}
end

Instance Method Details

#enum(definitions) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'app/models/concerns/storytime/enum.rb', line 14

def enum(definitions)
  klass = self
  definitions.each do |name, values|
    # statuses = { }
    enum_values = ActiveSupport::HashWithIndifferentAccess.new
    name        = name.to_sym

    # def self.statuses statuses end
    klass.singleton_class.send(:define_method, name.to_s.pluralize) { enum_values }

    _enum_methods_module.module_eval do
      # def status=(value) self[:status] = statuses[value] end
      define_method("#{name}=") { |value|
        if enum_values.has_key?(value) || value.blank?
          self[name] = enum_values[value]
        elsif enum_values.has_value?(value)
          # Assigning a value directly is not a end-user feature, hence it's not documented.
          # This is used internally to make building objects from the generated scopes work
          # as expected, i.e. +Conversation.archived.build.archived?+ should be true.
          self[name] = value
        else
          raise ArgumentError, "'#{value}' is not a valid #{name}"
        end
      }

      # def status() statuses.key self[:status] end
      define_method(name) { enum_values.key self[name] }

      # def status_before_type_cast() statuses.key self[:status] end
      define_method("#{name}_before_type_cast") { enum_values.key self[name] }

      pairs = values.respond_to?(:each_pair) ? values.each_pair : values.each_with_index
      pairs.each do |value, i|
        enum_values[value] = i

        # def active?() status == 0 end
        define_method("#{value}?") { self[name] == i }

        # def active!() update! status: :active end
        define_method("#{value}!") { update! name => value }

        # scope :active, -> { where status: 0 }
        klass.scope value, -> { klass.where name => i }
      end
    end
    defined_enums[name.to_s] = enum_values
  end
end

#inherited(base) ⇒ Object

:nodoc:



9
10
11
12
 
# File 'app/models/concerns/storytime/enum.rb', line 9

def inherited(base) # :nodoc:
  base.defined_enums = defined_enums.deep_dup
  super
end