Module: Ibrain::Preferences::Preferable
- Extended by:
- ActiveSupport::Concern
- Included in:
- Configuration
- Defined in:
- lib/ibrain/preferences/preferable.rb
Overview
Preferable allows defining preference accessor methods.
A class including Preferable must implement #preferences which should return an object responding to .fetch(key), []=(key, val), and .delete(key).
It may also define a ‘#context_for_default` method. It should return an array with the arguments to be provided to a proc used as the `default:` keyword for a preference.
The generated writer method performs typecasting before assignment into the preferences object.
Examples:
# Ibrain::Base includes Preferable and defines preferences as a serialized
# column.
class Settings < Ibrain::Base
preference :color, :string, default: 'red'
preference :temperature, :integer, default: 21
end
s = Settings.new
s.preferred_color # => 'red'
s.preferred_temperature # => 21
s.preferred_color = 'blue'
s.preferred_color # => 'blue'
# Typecasting is performed on assignment
s.preferred_temperature = '24'
s.preferred_color # => 24
# Modifications have been made to the .preferences hash
s.preferences #=> {color: 'blue', temperature: 24}
# Save the changes. All handled by activerecord
s.save!
Each preference gets rendered as a form field in Ibrain backend.
As not all supported preference types are representable as a form field, only some of them get rendered per default. Arrays and Hashes for instance are supported preference field types, but do not represent well as a form field.
Overwrite allowed_admin_form_preference_types
in your class 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/ibrain/admin/shared/preference_fields/
Instance Method Summary collapse
-
#default_preferences ⇒ Hash{Symbol => Object}
Default for all preferences defined on this class.
-
#defined_preferences ⇒ Array<Symbol>
All preferences defined on this class.
-
#get_preference(name) ⇒ Object
Get a preference.
-
#has_preference!(name) ⇒ Object
Raises an exception if the
name
preference is not defined on this class. -
#has_preference?(name) ⇒ Boolean
If preference exists on this class.
-
#preference_default(name) ⇒ Object
The default for preference
name
. -
#preference_type(name) ⇒ Symbol
The type of preference
name
. -
#set_preference(name, value) ⇒ Object
Set a preference.
Instance Method Details
#default_preferences ⇒ Hash{Symbol => Object}
Returns Default for all preferences defined on this class.
114 115 116 117 118 |
# File 'lib/ibrain/preferences/preferable.rb', line 114 def default_preferences defined_preferences.index_with do |preference| preference_default(preference) end end |
#defined_preferences ⇒ Array<Symbol>
Returns All preferences defined on this class.
109 110 111 |
# File 'lib/ibrain/preferences/preferable.rb', line 109 def defined_preferences self.class.defined_preferences end |
#get_preference(name) ⇒ Object
Get a preference
69 70 71 72 |
# File 'lib/ibrain/preferences/preferable.rb', line 69 def get_preference(name) has_preference! name send self.class.preference_getter_method(name) end |
#has_preference!(name) ⇒ Object
Raises an exception if the name
preference is not defined on this class
98 99 100 |
# File 'lib/ibrain/preferences/preferable.rb', line 98 def has_preference!(name) raise NoMethodError.new "#{name} preference not defined" unless has_preference? name end |
#has_preference?(name) ⇒ Boolean
Returns if preference exists on this class.
104 105 106 |
# File 'lib/ibrain/preferences/preferable.rb', line 104 def has_preference?(name) defined_preferences.include?(name.to_sym) end |
#preference_default(name) ⇒ Object
Returns The default for preference name
.
91 92 93 94 |
# File 'lib/ibrain/preferences/preferable.rb', line 91 def preference_default(name) has_preference! name send self.class.preference_default_getter_method(name) end |
#preference_type(name) ⇒ Symbol
Returns The type of preference name
.
84 85 86 87 |
# File 'lib/ibrain/preferences/preferable.rb', line 84 def preference_type(name) has_preference! name send self.class.preference_type_getter_method(name) end |
#set_preference(name, value) ⇒ Object
Set a preference
77 78 79 80 |
# File 'lib/ibrain/preferences/preferable.rb', line 77 def set_preference(name, value) has_preference! name send self.class.preference_setter_method(name), value end |