Module: Spree::Preferences::Preferable

Extended by:
ActiveSupport::Concern
Included in:
Base, Configuration
Defined in:
lib/spree/core/preferences/preferable.rb

Instance Method Summary collapse

Instance Method Details

#clear_preferencesObject



98
99
100
# File 'lib/spree/core/preferences/preferable.rb', line 98

def clear_preferences
  preferences.keys.each { |pref| preferences.delete pref }
end

#default_preferencesObject



90
91
92
93
94
95
96
# File 'lib/spree/core/preferences/preferable.rb', line 90

def default_preferences
  Hash[
    defined_preferences.map do |preference|
      [preference, preference_default(preference)]
    end
  ]
end

#defined_preferencesObject



77
78
79
80
81
# File 'lib/spree/core/preferences/preferable.rb', line 77

def defined_preferences
  methods.grep(/\Apreferred_.*=\Z/).map do |pref_method|
    pref_method.to_s.gsub(/\Apreferred_|=\Z/, '').to_sym
  end
end

#deprecated_preferencesObject



83
84
85
86
87
88
# File 'lib/spree/core/preferences/preferable.rb', line 83

def deprecated_preferences
  defined_preferences.each_with_object([]) do |pref_name, array|
    deprecated_message = preference_deprecated(pref_name)
    array << { name: pref_name, message: deprecated_message } unless deprecated_message.nil?
  end
end

#get_preference(name) ⇒ Object



44
45
46
47
# File 'lib/spree/core/preferences/preferable.rb', line 44

def get_preference(name)
  has_preference! name
  send self.class.preference_getter_method(name)
end

#has_preference!(name) ⇒ Object

Raises:

  • (NoMethodError)


69
70
71
# File 'lib/spree/core/preferences/preferable.rb', line 69

def has_preference!(name)
  raise NoMethodError, "#{name} preference not defined" unless has_preference? name
end

#has_preference?(name) ⇒ Boolean

Returns:

  • (Boolean)


73
74
75
# File 'lib/spree/core/preferences/preferable.rb', line 73

def has_preference?(name)
  respond_to? self.class.preference_getter_method(name)
end

#preference_default(name) ⇒ Object



59
60
61
62
# File 'lib/spree/core/preferences/preferable.rb', line 59

def preference_default(name)
  has_preference! name
  send self.class.preference_default_getter_method(name)
end

#preference_deprecated(name) ⇒ Object



64
65
66
67
# File 'lib/spree/core/preferences/preferable.rb', line 64

def preference_deprecated(name)
  has_preference! name
  send(self.class.preference_deprecated_getter_method(name))
end

#preference_type(name) ⇒ Object



54
55
56
57
# File 'lib/spree/core/preferences/preferable.rb', line 54

def preference_type(name)
  has_preference! name
  send self.class.preference_type_getter_method(name)
end

#set_preference(name, value) ⇒ Object



49
50
51
52
# File 'lib/spree/core/preferences/preferable.rb', line 49

def set_preference(name, value)
  has_preference! name
  send self.class.preference_setter_method(name), value
end