Contents

#:nodoc:
module Settings
  #:nodoc:
  module Plugin
    ##
    # Base class used for individual settings.
    #
    # @author Yorick Peterse
    # @since  0.2.5
    #
    class SettingBase
      include ::Zen::Validation

      ##
      # Array containing all possible setting types.
      #
      # @author Yorick Peterse
      # @since  0.2.5
      #
      Types = [
        'textbox', 'textarea', 'radio', 'checkbox', 'date', 'select', 'select_multiple'
      ]

      # The name of the setting
      attr_accessor :name
      
      # The title of the setting, displayed in the GUI
      attr_accessor :title
      
      # A small description about the setting
      attr_accessor :description
      
      # The name of the settings group this setting belongs to
      attr_accessor :group
      
      # The type of setting (e.g. textbox)
      attr_accessor :type
      
      # The possible values for the setting
      attr_accessor :values
      
      # The default value of the setting
      attr_accessor :default

      ##
      # Validates all attributes of this class.
      #
      # @author Yorick Peterse
      # @since  0.2.5
      #
      def validate
        validates_presence([:name, :title, :group, :type])

        # Validate the setting type
        if !Types.include?(type)
          raise(::Zen::ValidationError, "The setting type #{type} is invalid.")
        end

        # Check if the setting hasn't been registered yet
        if ::Settings::Plugin::Settings::Registered[:settings].key?(name)
          raise(
            ::Zen::ValidationError,
            "The setting #{name} has already been registered"
          )
        end

        # Validate the group
        if !::Settings::Plugin::Settings::Registered[:groups].key?(group)
          raise(::Zen::ValidationError, "The settings group #{group} doesn't exist.")
        end
      end
    end # SettingBase
  end # Plugin
end # Settings

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
zen-0.2.6	lib/zen/package/settings/lib/settings/plugin/setting_base.rb