Module: Spree::Preferences::PreferableClassMethods

Defined in:
lib/spree/preferences/preferable_class_methods.rb

Instance Method Summary collapse

Instance Method Details

#defined_preferencesObject



3
4
5
# File 'lib/spree/preferences/preferable_class_methods.rb', line 3

def defined_preferences
  []
end

#preference(name, type, options = {}) ⇒ Object



7
8
9
10
11
12
13
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
# File 'lib/spree/preferences/preferable_class_methods.rb', line 7

def preference(name, type, options = {})
  options.assert_valid_keys(:default)
  default = options[:default]
  default = ->{ options[:default] } unless default.is_a?(Proc)

  # The defined preferences on a class are all those defined directly on
  # that class as well as those defined on ancestors.
  # We store these as a class instance variable on each class which has a
  # preference. super() collects preferences defined on ancestors.
  singleton_preferences = (@defined_singleton_preferences ||= [])
  singleton_preferences << name.to_sym

  define_singleton_method :defined_preferences do
    super() + singleton_preferences
  end

  # cache_key will be nil for new objects, then if we check if there
  # is a pending preference before going to default
  define_method preference_getter_method(name) do
    preferences.fetch(name) do
      default.call
    end
  end

  define_method preference_setter_method(name) do |value|
    value = convert_preference_value(value, type)
    preferences[name] = value

    # If this is an activerecord object, we need to inform
    # ActiveRecord::Dirty that this value has changed, since this is an
    # in-place update to the preferences hash.
    preferences_will_change! if respond_to?(:preferences_will_change!)
  end

  define_method preference_default_getter_method(name), &default

  define_method preference_type_getter_method(name) do
    type
  end
end

#preference_default_getter_method(name) ⇒ Object



56
57
58
# File 'lib/spree/preferences/preferable_class_methods.rb', line 56

def preference_default_getter_method(name)
  "preferred_#{name}_default".to_sym
end

#preference_getter_method(name) ⇒ Object



48
49
50
# File 'lib/spree/preferences/preferable_class_methods.rb', line 48

def preference_getter_method(name)
  "preferred_#{name}".to_sym
end

#preference_setter_method(name) ⇒ Object



52
53
54
# File 'lib/spree/preferences/preferable_class_methods.rb', line 52

def preference_setter_method(name)
   "preferred_#{name}=".to_sym
end

#preference_type_getter_method(name) ⇒ Object



60
61
62
# File 'lib/spree/preferences/preferable_class_methods.rb', line 60

def preference_type_getter_method(name)
  "preferred_#{name}_type".to_sym
end