Class: Enumerize::Attribute

Inherits:
Object
  • Object
show all
Defined in:
lib/enumerize/attribute.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(klass, name, options = {}) ⇒ Attribute

Returns a new instance of Attribute.

Raises:

  • (ArgumentError) 


5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/enumerize/attribute.rb', line 5

def initialize(klass, name, options={})
  raise ArgumentError, ':in option is required' unless options[:in]

  extend Multiple if options[:multiple]

  @klass  = klass
  @name   = name.to_sym

  value_class = options.fetch(:value_class, Value)
  @values = Array(options[:in]).map { |v| value_class.new(self, *v) }

  @value_hash = Hash[@values.map { |v| [v.value.to_s, v] }]
  @value_hash.merge! Hash[@values.map { |v| [v.to_s, v] }]

  if options[:i18n_scope]
    raise ArgumentError, ':i18n_scope option accepts only String or Array of strings' unless Array(options[:i18n_scope]).all? { |s| s.is_a?(String) }
    @i18n_scope = options[:i18n_scope]
  end

  if options[:default]
    @default_value = find_default_value(options[:default])
    raise ArgumentError, 'invalid default value' unless @default_value
  end
end

Instance Attribute Details

#default_value ⇒ Object (readonly)

Returns the value of attribute default_value.



3
4
5
 
# File 'lib/enumerize/attribute.rb', line 3

def default_value
  @default_value
end

#i18n_scope ⇒ Object (readonly)

Returns the value of attribute i18n_scope.



3
4
5
 
# File 'lib/enumerize/attribute.rb', line 3

def i18n_scope
  @i18n_scope
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



3
4
5
 
# File 'lib/enumerize/attribute.rb', line 3

def name
  @name
end

#values ⇒ Object (readonly)

Returns the value of attribute values.



3
4
5
 
# File 'lib/enumerize/attribute.rb', line 3

def values
  @values
end

Instance Method Details

#define_methods!(mod) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/enumerize/attribute.rb', line 73

def define_methods!(mod)
  mod.module_eval "    def \#{name}\n      if defined?(super)\n        self.class.enumerized_attributes[:\#{name}].find_value(super)\n      elsif respond_to?(:read_attribute)\n        self.class.enumerized_attributes[:\#{name}].find_value(read_attribute(:\#{name}))\n      else\n        if defined?(@\#{name})\n          self.class.enumerized_attributes[:\#{name}].find_value(@\#{name})\n        else\n          @\#{name} = nil\n        end\n      end\n    end\n\n    def \#{name}=(new_value)\n      allowed_value_or_nil = self.class.enumerized_attributes[:\#{name}].find_value(new_value)\n      allowed_value_or_nil = allowed_value_or_nil.value unless allowed_value_or_nil.nil?\n\n      if defined?(super)\n        super allowed_value_or_nil\n      elsif respond_to?(:write_attribute, true)\n        write_attribute '\#{name}', allowed_value_or_nil\n      else\n        @\#{name} = allowed_value_or_nil\n      end\n\n      _enumerized_values_for_validation['\#{name}'] = new_value.nil? ? nil : new_value.to_s\n\n      allowed_value_or_nil\n    end\n\n    def \#{name}_text\n      self.\#{name} && self.\#{name}.text\n    end\n\n    def \#{name}_value\n      self.\#{name} && self.\#{name}.value\n    end\n  RUBY\nend\n", __FILE__, __LINE__ + 1

#find_default_value(value) ⇒ Object 



30
31
32
33
34
35
36
 
# File 'lib/enumerize/attribute.rb', line 30

def find_default_value(value)
  if value.respond_to?(:call)
    value
  else
    find_value(value)
  end
end

#find_value(value) ⇒ Object 



38
39
40
 
# File 'lib/enumerize/attribute.rb', line 38

def find_value(value)
  @value_hash[value.to_s] unless value.nil?
end

#i18n_scopes ⇒ Object 



42
43
44
45
46
47
48
49
50
 
# File 'lib/enumerize/attribute.rb', line 42

def i18n_scopes
  @i18n_scopes ||= if i18n_scope
    scopes = Array(i18n_scope)
  elsif @klass.respond_to?(:model_name)
    scopes = ["enumerize.#{@klass.model_name.i18n_key}.#{name}"]
  else
    []
  end
end

#options(options = {}) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/enumerize/attribute.rb', line 52

def options(options = {})
  values = if options.empty?
    @values
  else
    raise ArgumentError, 'Options cannot have both :only and :except' if options[:only] && options[:except]

    only = Array(options[:only]).map(&:to_s)
    except = Array(options[:except]).map(&:to_s)

    @values.reject do |value|
      if options[:only]
        !only.include?(value)
      elsif options[:except]
        except.include?(value)
      end
    end
  end

  values.map { |v| [v.text, v.to_s] }
end