class ActiveSettings::Config::Definition
Attributes
Public Class Methods
Configuration ‘definitions’ are metadata held in memory that add restriction and description to individual config entries.
By default ActiveSettings’ configuration machinery is open and ad-hoc: config items are just globally-accessible variables. They’re created when first mentioned and then available in all parts of the application. The definition mechanism is a way to place limits on that behavior. It allows you to protect a config entry, to specify the values it can take and to validate it when it changes. In the next update it will also allow you to declare that a config item is global or site-specific.
The actual defining is done by ActiveSettings::Config#define and usually in a block like this:
ActiveSettings::Config.configure do |config| config.namespace('users', :allow_change => true) do |users| users.define 'allow_password_reset?', :label => 'Allow password reset?' end end
See the method documentation in ActiveSettings::Config
for options and conventions.
# File lib/active_settings/config/definition.rb, line 27 def initialize(options={}) [:empty, :default, :type, :label, :notes, :validate_with, :select_from, :allow_blank, :allow_change, :allow_display, :units, :definer].each do |attribute| instance_variable_set "@#{attribute}".to_sym, options[attribute] end end
Public Instance Methods
Returns true unless :allow_blank has been explicitly set to false. Defaults to true. A config item that does not allow_blank
must be set or it will not be valid.
# File lib/active_settings/config/definition.rb, line 126 def allow_blank? true unless allow_blank == false end
Returns true if the definition included a :type => :boolean parameter. Config
entries that end in ‘?’ are automatically considered boolean, whether a type is declared or not. config.boolean? may therefore differ from config.definition.boolean?
# File lib/active_settings/config/definition.rb, line 44 def boolean? type == :boolean end
Returns true if the definition included a :type => :date parameter
# File lib/active_settings/config/definition.rb, line 60 def date? type == :date end
Returns true if the definition included an :empty flag, which should only be the case for the blank, unrestricting definitions created when an undefined config item is set or got.
# File lib/active_settings/config/definition.rb, line 37 def empty? !!empty end
Returns true if the definition included a :type => :integer parameter
# File lib/active_settings/config/definition.rb, line 55 def integer? type == :integer end
in definitions we accept anything that options_for_select would normally take here we standardises on an options array-of-arrays so that it’s easier to validate input
# File lib/active_settings/config/definition.rb, line 80 def normalize_selection(choices) choices = choices.to_a if Hash === choices choices = choices.collect{|c| (c.is_a? Array) ? c : [c,c]} end
Returns true if the value is one of the permitted selections. Not case-sensitive.
# File lib/active_settings/config/definition.rb, line 119 def selectable?(value) return true unless selector? selection.map(&:last).map(&:downcase).include?(value.downcase) end
If the config item is a selector and :select_from specifies [name, value] pairs (as hash or array), this will return the name corresponding to the currently selected value.
# File lib/active_settings/config/definition.rb, line 88 def selected(value) if value && selector? && pair = selection.find{|s| s.last == value} pair.first end end
Returns the list of possible values for this config entry in a form suitable for passing to options_for_select. if :select_from is a proc it is called first with no arguments and its return value passed through.
# File lib/active_settings/config/definition.rb, line 67 def selection if selector? choices = select_from choices = choices.call if choices.respond_to? :call choices = normalize_selection(choices) choices.unshift ['","'] if allow_blank? choices end end
Returns true if the definition included a :select_from parameter (either as list or proc).
# File lib/active_settings/config/definition.rb, line 50 def selector? !select_from.blank? end
Returns true unless :allow_change has been explicitly set to false. Defaults to true. A config item that is not settable cannot be changed in the running application.
# File lib/active_settings/config/definition.rb, line 132 def settable? true unless allow_change == false end
Checks the supplied value against the validation rules for this definition. There are several ways in which validations might be defined or implied:
-
if :validate_with specifies a block, the setting object is passed to the block
-
if :type is :integer, we test that the supplied string resolves to a valid integer
-
if the config item is a selector we test that its value is one of the permitted options
-
if :allow_blank has been set to false, we test that the value is not blank
# File lib/active_settings/config/definition.rb, line 101 def validate(setting) if allow_blank? return if setting.value.blank? else setting.errors.add :value, :blank if setting.value.blank? end if validate_with.is_a? Proc validate_with.call(setting) end if selector? setting.errors.add :value, :not_permitted unless selectable?(setting.value) end if integer? Integer(setting.value) rescue setting.errors.add :value, :not_a_number end end
Returns true unless :allow_change has been explicitly set to false. Defaults to true. A config item that is not visible cannot be displayed in a view.
# File lib/active_settings/config/definition.rb, line 138 def visible? true unless allow_display == false end