module Spree::Preferences::PreferableClassMethods
Constants
- DEFAULT_ADMIN_FORM_PREFERENCE_TYPES
Public Instance Methods
allowed_admin_form_preference_types()
click to toggle source
List of preference types allowed as form fields in the Solidus
admin
Overwrite this method in your class that includes Spree::Preferable
if you want to provide more fields. If you do so, you also need to provide a preference field partial that lives in:
app/views/spree/admin/shared/preference_fields/
@return [Array]
# File lib/spree/preferences/preferable_class_methods.rb, line 105 def allowed_admin_form_preference_types DEFAULT_ADMIN_FORM_PREFERENCE_TYPES end
defined_preferences()
click to toggle source
# File lib/spree/preferences/preferable_class_methods.rb, line 17 def defined_preferences [] end
preference(name, type, options = {})
click to toggle source
Calls superclass method
# File lib/spree/preferences/preferable_class_methods.rb, line 21 def preference(name, type, options = {}) options.assert_valid_keys(:default, :encryption_key) if type == :encrypted_string preference_encryptor = preference_encryptor(options) options[:default] = preference_encryptor.encrypt(options[:default]) end default = options[:default] default = proc { 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 value = preferences.fetch(name) do default.call(*context_for_default) end value = preference_encryptor.decrypt(value) if preference_encryptor.present? value end define_method preference_setter_method(name) do |value| value = convert_preference_value(value, type, preference_encryptor) 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) do default.call(*context_for_default) end define_method preference_type_getter_method(name) do type end end
preference_default_getter_method(name)
click to toggle source
# File lib/spree/preferences/preferable_class_methods.rb, line 80 def preference_default_getter_method(name) "preferred_#{name}_default".to_sym end
preference_encryptor(options)
click to toggle source
# File lib/spree/preferences/preferable_class_methods.rb, line 88 def preference_encryptor(options) key = options[:encryption_key] || ENV['SOLIDUS_PREFERENCES_MASTER_KEY'] || Rails.application.credentials.secret_key_base Spree::Encryptor.new(key) end
preference_getter_method(name)
click to toggle source
# File lib/spree/preferences/preferable_class_methods.rb, line 72 def preference_getter_method(name) "preferred_#{name}".to_sym end
preference_setter_method(name)
click to toggle source
# File lib/spree/preferences/preferable_class_methods.rb, line 76 def preference_setter_method(name) "preferred_#{name}=".to_sym end
preference_type_getter_method(name)
click to toggle source
# File lib/spree/preferences/preferable_class_methods.rb, line 84 def preference_type_getter_method(name) "preferred_#{name}_type".to_sym end