zen 0.2.8 → 0.3b

data/lib/zen/package/settings/lib/settings/language/en/settings.yml

@@ -1,36 +0,0 @@
----
-titles:
-  index: 'Settings'
-
-labels:
-  website_name         : 'Website name'
-  website_description  : 'Website description'
-  language             : 'Language'
-  frontend_language    : 'Frontend language'
-  default_section      : 'Default section'
-  theme                : 'Theme'
-  enable_antispam      : 'Enable anti-spam'
-  date_format          : 'Date format'
-
-placeholders:
-  website_name        : 'The name of the website.'
-  website_description : 'The description of the website.'
-  language            : 'The language to use for the system.'
-  default_section     : 'The default section to use on the homepage.'
-  theme               : 'The frontend theme to use.'
-  enable_antispam     : 'Whether or not anti-spam protection should be used for comments'
-  frontend_language   : 'The language to use for the frontend of the website.'
-  date_format         : 'A custom format used for all the dates displayed in the backend.'
-
-tabs:
-  general  : 'General'
-  security : 'Security'
-
-buttons:
-  save: 'Save'
-
-success:
-  save: 'The settings have been saved.'
-
-errors:
-  save: 'The settings could not be saved.'

data/lib/zen/package/settings/lib/settings/language/nl/settings.yml

@@ -1,37 +0,0 @@
----
-titles:
-  index: 'Instellingen'
-
-labels:
-  website_name       : 'Website naam'
-  website_description: 'Website beschrijving'
-  language           : 'Taal'
-  frontend_langauge  : 'Taal voor bezoekers'
-  default_section    : 'Standaard sectie'
-  theme              : 'Thema'
-  enable_antispam    : 'Anti-spam inschakelen'
-  date_format        : 'Datum formaat'
-
-placeholders:
-  website_name       : 'De naam van de website.'
-  website_description: 'De beschrijving van de website.'
-  language           : 'De taal die gebruikt moet worden voor het admin gedeelte.'
-  default_section    : 'De standaard sectie die moet worden gebruikt.'
-  theme              : 'Het thema dat bezoekers zullen zien.'
-  enable_antispam    : 'Waarde die aangeeft of het anti-spam systeem moet worden gebruikt 
-voor reacties.'
-  frontend_language  : 'De taal die gebruikt moet worden voor bezoekers.'
-  date_format        : 'Het formaat van de datum voor het admin gedeelte.'
-
-tabs:
-  general : 'Algemeen'
-  security: 'Beveiliging'
-
-buttons:
-  save: 'Opslaan'
-
-success:
-  save: 'De instellingen zijn opgeslagen.'
-
-errors:
-  save: 'De instellingen konden niet worden opgeslagen.'

data/lib/zen/package/settings/lib/settings/plugin/group_base.rb

@@ -1,39 +0,0 @@
-#:nodoc:
-module Settings
-  #:nodoc:
-  module Plugin
-    ##
-    # Base class used for setting groups.
-    #
-    # @author Yorick Peterse
-    # @since  0.2.5
-    #
-    class GroupBase
-      include ::Zen::Validation
-
-      # The name of the group
-      attr_accessor :name
-
-      # The title of the group, displayed in the GUI
-      attr_accessor :title
-
-      ##
-      # Validates all attributes of this class.
-      #
-      # @author Yorick Peterse
-      # @since  0.2.5
-      #
-      def validate
-        validates_presence([:name, :title])
-        validates_format(:name, /[a-z0-9_\-]+/)
-
-        if ::Settings::Plugin::Settings::Registered[:groups].key?(name)
-          raise(
-            ::Zen::ValidationError,
-            "The setting group #{name} has already been registered."
-          )
-        end
-      end
-    end # GroupBase
-  end # Plugin
-end # Settings

data/lib/zen/package/settings/lib/settings/plugin/setting_base.rb

@@ -1,133 +0,0 @@
-#: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_writer :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
-
-      ##
-      # Updates the value of a setting both in the cache and the SQL database.
-      #
-      # @author Yorick Peterse
-      # @since  0.2.6.1
-      # @param  [String] value The value to set the setting to.
-      #
-      def value=(value)
-        # First we'll update the SQL database
-        ::Settings::Model::Setting[:name => name].update(:value => value)
-
-        # Sync the cache
-        ::Ramaze::Cache.settings.store(name, value)
-      end
-
-      ##
-      # Retrieves the setting. If it exists in the cache the cache's value is used,
-      # otherwise it will be retrieved from the SQL database and cached.
-      #
-      # @author Yorick Peterse
-      # @since  0.2.6.1
-      #
-      def value
-        val = ::Ramaze::Cache.settings.fetch(name)
-
-        # Get the setting from the database
-        if val.nil?
-          setting = ::Settings::Model::Setting[:name => name]
-
-          # If the value is also nil we'll use the default value
-          if setting.value.nil? or setting.value.empty?
-            val = setting.default
-          else
-            val = setting.value
-          end
-
-          ::Ramaze::Cache.settings.store(name, val)
-        end
-
-        return val
-      end
-
-      ##
-      # Retrieves the possible values for the setting. If the value is a Proc or Lambda 
-      # (or anything else that responds to call()) it will be called and it's return 
-      # value is used.
-      # 
-      # @author Yorick Peterse
-      # @since  0.2.8
-      # @return [Mixed]
-      #
-      def values
-        if @values.respond_to?(:call)
-          return @values.call
-        else
-          return @values
-        end
-      end
-    end # SettingBase
-  end # Plugin
-end # Settings

data/lib/zen/package/settings/lib/settings/plugin/settings.rb

@@ -1,251 +0,0 @@
-require __DIR__('group_base')
-require __DIR__('setting_base')
-
-#:nodoc:
-module Settings
-  #:nodoc:
-  module Plugin
-    ##
-    # The settings plugin is a plugin that can be used to register and migrate settings
-    # without having to manually insert the data. Previously you'd have to manually insert
-    # the data into the settings table at some point and the process of loading 
-    # translation keys and possible values was a pain. This this plugin was created to
-    # solve most of those problems.
-    #
-    # ## Adding Settings
-    #
-    # In order to add a setting you'll first need to ensure there's at least a single
-    # setting group available. These groups don't add any extra features or whatsoever but
-    # are used to display settings in different tabs in the backend interface. In order to
-    # register a new group you'd write the following code:
-    #
-    #     plugin(:settings, :register_group) do |group|
-    #       group.title = 'My Group'
-    #       group.name  = 'my_group'
-    #     end
-    # 
-    # When registering a group you only need to specify a title and a name. The name is
-    # used to associate a setting with it's group and thus should always be unique. The
-    # title is displayed in the tab for the specific settings group.
-    # 
-    # Once a setting group has been added we can add a setting as following:
-    #
-    #     plugin(:settings, :register) do |setting|
-    #       setting.title       = 'My Setting'
-    #       setting.description = 'This is my setting!'
-    #       setting.name        = 'my_setting'
-    #       setting.group       = 'my_group'
-    #       setting.type        = 'select'
-    #       setting.values      = ['yorick', 'zen']
-    #       setting.default     = 'yorick'
-    #     end
-    #
-    # Note that the values array (or hash) is used to determine the possible values for
-    # a field. These values will only be used for elements that only allow a user to 
-    # choose a single value (e.g. a checkbox). For the type getter/setter you can use
-    # any of the following values:
-    #
-    # * textbox
-    # * textarea
-    # * radio
-    # * checkbox
-    # * date
-    # * select
-    # * select_multiple
-    # 
-    # ## Migrating Settings
-    #
-    # Once a setting has been added you still have to migrate it. Zen takes care of this
-    # so usually you don't need to manually migrate your settings. If you do want to 
-    # migrate them however you can simple execute the following code:
-    #
-    #     plugin(:settings, :migrate)
-    #
-    # ## Removing Settings
-    #
-    # If you ever need to remove a setting both from the database and the system you can
-    # do so as following:
-    #
-    #     plugin(:settings, :remove, ['name1', 'name2'])
-    #
-    # You don't have to specify an array of names, you can also specify the name of a 
-    # single setting to delete.
-    #
-    # @author Yorick Peterse
-    # @since  0.2.5
-    #
-    class Settings
-      include ::Zen::Plugin::Helper
-      include ::Settings::Model
-
-      ##
-      # Hash containing all registered settings and setting groups.
-      #
-      # @author Yorick Peterse
-      # @since  0.2.5
-      #
-      Registered = {
-        :groups   => {},
-        :settings => {}
-      }
-
-      ##
-      # Creates a new instance of the plugin and saves the given arguments as instance
-      # variables so they can be used by Settings::Plugin::Settings.call.
-      #
-      # @author Yorick Peterse
-      # @since  0.2.5
-      # @param  [Symbol/String] action The action (method) to execute.
-      # @param  [Array] args Array containing all additional arguments.
-      # @param  [Proc] block An optional block containing extra details.
-      # a setting.
-      #
-      def initialize(action, *args, &block)
-        # Validate the given action
-        if !respond_to?(action)
-          raise(ArgumentError, "The action #{action} does not exist.")
-        end
-
-        validate_type(action, :action, [Symbol, String])
-
-        @action, @args, @block = action, args, block
-      end
-
-      ##
-      # Executes the action set in the construct and returns the results.
-      #
-      # @author Yorick Peterse
-      # @since  0.2.5
-      # @return [Mixed]
-      #
-      def call
-        return send(@action, *@args, &@block)
-      end
-
-      ##
-      # Registers a new setting group using the specified block.
-      #
-      # @example
-      #  plugin(:settings, :register_group) do |group|
-      #    group.name  = 'example'
-      #    group.title = 'Example group'
-      #  end
-      #
-      # @author Yorick Peterse
-      # @since  0.2.5
-      #
-      def register_group
-        group = GroupBase.new
-
-        yield group
-
-        # Validate the group
-        group.validate
-
-        # Store the group
-        Registered[:groups][group.name] = group
-      end
-
-      ##
-      # Registers a new setting using the specified block.
-      #
-      # @example
-      #  plugin(:settings, :register) do |setting|
-      #    setting.name    = 'example'
-      #    setting.title   = 'Example setting'
-      #    setting.group   = 'example'
-      #    setting.type    = 'select'
-      #    setting.value   = ['yorick', 'chuck']
-      #  end
-      #
-      # @author Yorick Peterse
-      # @since  0.2.5
-      #
-      def register
-        setting = SettingBase.new
-
-        yield setting
-
-        # Validate all attributes
-        setting.validate
-
-        Registered[:settings][setting.name] = setting
-      end
-
-      ##
-      # Gets the setting for the given name.
-      #
-      # @author Yorick Peterse
-      # @since  0.2.5
-      # @param  [String] name The name of the setting to retrieve.
-      # @return [Zen::StrictStruct]
-      #
-      def get(name)
-        validate_type(name, :name, [String, Symbol])
-
-        name = name.to_s
-
-        if !Registered[:settings].key?(name)
-          raise(ArgumentError, "The setting #{name} doesn't exist.")
-        end
-
-        return Registered[:settings][name]
-      end
-
-      ##
-      # Inserts all settings into the database. This method will ignore the settings that
-      # have already been inserted into the database.
-      #
-      # @author Yorick Peterse
-      # @since  0.2.5
-      #
-      def migrate
-        settings = Setting.all.map { |s| s.name }
-
-        Registered[:settings].each do |name, setting|
-          name = name.to_s
-
-          if !settings.include?(name)
-            # For some reason using the Settings model generates nil errors 
-            # when this method is called from a migration so we'll insert them
-            # the non-model way.
-            Zen.database[:settings].insert(
-              :name    => setting.name,
-              :group   => setting.group,
-              :default => setting.default,
-              :type    => setting.type
-            )
-
-          # Update everything but the value
-          else
-            Zen.database[:settings].filter[:name => setting.name].update(
-              :group   => setting.group, 
-              :default => setting.default, 
-              :type    => setting.type
-            )
-          end
-        end
-      end
-
-      ##
-      # Removes the settings who's names match those specified in the array. The values
-      # of these settings will also be removed from the database.
-      #
-      # @author Yorick Peterse
-      # @since  0.2.5
-      # @param  [Array] namese An array with setting names to remove.
-      #
-      def remove(names)
-        if names.class != Array
-          names = [names]
-        end
-
-        names.each do |i|
-          Registered[:settings].delete(i)
-        end
-
-        Setting.filter(:name => names).delete
-      end
-    end # Settings
-  end # Plugin
-end # Settings