zen 0.2.4.1 → 0.2.5

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

@@ -0,0 +1,85 @@
+#:nodoc:
+module Sections
+  #:nodoc:
+  module Plugin
+    ##
+    # Plugin that can be used to display sections and their details. If you want to 
+    # display section entries instead you should use the plugin 
+    # Sections::Plugin::SectionEntries.
+    #
+    # ## Usage
+    #
+    #     section = plugin(:sections, :section => 10)
+    #     section.name # => "My Section"
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    class Sections
+      include ::Zen::Plugin::Helper
+      include ::Sections::Model
+
+      ##
+      # Creates a new instance of the plugin and saves/validates the given configuration
+      # options.
+      #
+      # @example
+      #  plugin = Sections::Plugin::Sections.new(:section => 10)
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @param  [Hash] options Hash with a set of configuration files to use.
+      #
+      def initialize(options = {})
+        @options = {
+          :limit   => 20,
+          :offset  => 0,
+          :section => nil
+        }.merge(options)
+
+        validate_type(@options[:limit]  , :limit  , [Fixnum, Integer])
+        validate_type(@options[:offset] , :offset , [Fixnum, Integer])
+        validate_type(@options[:section], :section, [NilClass, Integer, Fixnum, String])
+      end
+
+      ##
+      # Retrieves the section(s) based on the given configuration options. When multiple
+      # sections are retrieved they're returned as an array, otherwise a single instance
+      # of Sections::Model::Sections will be returned.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @return [Array/Sections::Model::Section] List of all sections that were retrieved
+      # or an instance of Sections::Model::Section in case a specific section was retrieved
+      # from the database.
+      #
+      def call
+        # Retrieve a single section
+        if !@options[:section].nil?
+          # Retrieve a section by it's slug
+          if @options[:section].class == String
+            sections = Section[:slug => @options[:section]]
+          # Retrieve a section by it's ID
+          else
+            sections = Section[@options[:section]]
+          end
+        # Retrieve mutliple sections
+        else
+          sections = Section.limit(@options[:limit], @options[:offset]).all
+        end
+
+        # Convert every section to a hash
+        if sections.class == Array
+          sections.each_with_index do |section, index|
+            sections[index] = section.values
+          end
+        else
+          sections = sections.values
+        end
+
+        return sections
+      end
+
+    end
+  end
+end

data/lib/zen/package/sections/lib/sections/view/admin/form.xhtml

@@ -70,7 +70,7 @@ form_for(@section, :method => 'post', :action => @form_save_url, :id => :section
     f.select(
       lang('sections.labels.comment_format'), 
       :comment_format,
-      :values   => @format_hash, 
+      :values   => Zen::Plugin::Markup::Engines, 
       :selected => @section.comment_format, 
       :size     => 1
     )

data/lib/zen/package/sections/lib/sections/view/admin/index.xhtml

@@ -22,7 +22,9 @@
                     <th>#{lang('sections.labels.slug')}</th>
                     <th>#{lang('sections.labels.comment_allow')}</th>
                     
-                    <?r if user_authorized?([:create]) ?>
+                    <?r if user_authorized?(
+                      [:read], true, 'Sections::Controller::SectionEntries'
+                    ) ?>
                     <th></th>
                     <?r end ?>
                 </tr>
@@ -42,7 +44,7 @@
                     <td>
                         #{anchor_to(
                           section.name, 
-                          Sections::Controllers::Sections.r(:edit, section.id), 
+                          Sections::Controller::Sections.r(:edit, section.id), 
                           :title => section.name
                         )}
                     </td>
@@ -55,11 +57,13 @@
                         #{@boolean_hash.invert[section.comment_allow]}
                     </td>
                     
-                    <?r if user_authorized?([:create]) ?>
+                    <?r if user_authorized?(
+                      [:read], true, 'Sections::Controller::SectionEntries'
+                    ) ?>
                     <td>
                         #{anchor_to(
                           lang('sections.labels.manage_entries'), 
-                          Sections::Controllers::SectionEntries.r(:index, section.id)
+                          Sections::Controller::SectionEntries.r(:index, section.id)
                         )}
                     </td>
                     <?r end ?>
@@ -77,7 +81,7 @@
             <div class="button">
                 #{anchor_to(
                   lang('sections.buttons.new'),
-                  Sections::Controllers::Sections.r(:new)
+                  Sections::Controller::Sections.r(:new)
                 )}
             </div>    
             <?r end ?>

data/lib/zen/package/sections/lib/sections/view/admin/section-entries/index.xhtml

@@ -40,7 +40,7 @@
                     <td>
                         #{anchor_to(
                           entry.title, 
-                          Sections::Controllers::SectionEntries.r(:edit, @section_id, entry.id)
+                          Sections::Controller::SectionEntries.r(:edit, @section_id, entry.id)
                         )}
                     </td>
                     <?r else ?>
@@ -66,7 +66,7 @@
             <div class="button">
                 #{anchor_to(
                   lang('section_entries.buttons.new'), 
-                  Sections::Controllers::SectionEntries.r(:new, @section_id)
+                  Sections::Controller::SectionEntries.r(:new, @section_id)
                 )}
             </div>
             <?r end ?>

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

@@ -1,21 +1,156 @@
+require __DIR__('settings/model/setting')
+require __DIR__('settings/controller/settings')
+require __DIR__('settings/plugin/settings')
 
-require __DIR__ 'settings/model/setting'
-require __DIR__ 'settings/controller/settings'
-require __DIR__ 'settings/liquid/setting'
-
-Liquid::Template.register_tag('setting', Settings::Liquid::Setting)
+Zen::Language.options.paths.push(__DIR__('settings'))
+Zen::Language.load('settings')
 
+# Register the package
 Zen::Package.add do |p|
-  p.name          = 'Settings'
+  p.name          = 'settings'
   p.author        = 'Yorick Peterse'
   p.url           = 'http://yorickpeterse.com/'
-  p.about         = 'Module for managing settings such as the default module, whether or not to allow registration, etc.'
-  p.identifier    = 'com.zen.settings'
+  p.about         = 'Module for managing settings such as the default module, whether or 
+not to allow registration, etc.'
+
   p.directory     = __DIR__('settings')
   p.migration_dir = __DIR__('../migrations')
   
   p.menu = [{
-    :title => "Settings",
-    :url   => "admin/settings"
+    :title => lang('settings.titles.index'),
+    :url   => 'admin/settings'
   }] 
+
+  p.controllers = {
+    lang('settings.titles.index') => Settings::Controller::Settings
+  }
+end
+
+# Create all variables required for the settings
+section_hash = {}
+theme_hash   = {}
+
+begin
+  Sections::Model::Section.select(:name, :slug).each do |s|
+    section_hash[s.slug] = s.name
+  end
+rescue => e
+  Ramaze::Log.warn("The settings plugin failed to retrieve all sections: #{e.message}")
+end
+
+Zen::Theme::Registered.each do |name, theme|
+  name             = name.to_s
+  theme_hash[name] = name
+end
+
+# ------
+
+# Register the plugin
+Zen::Plugin.add do |plugin|
+  plugin.name       = 'settings'
+  plugin.author     = 'Yorick Peterse'
+  plugin.url        = 'http://yorickpeterse.com/'
+  plugin.about      = 'Plugin that can be used to register, retrieve and migrate settings.'
+  plugin.plugin     = Settings::Plugin::Settings
+end
+
+# Register all setting groups
+plugin(:settings, :register_group) do |group|
+  group.title = 'General'
+  group.name  = 'general'
+end
+
+plugin(:settings, :register_group) do |group|
+  group.title = 'Security'
+  group.name  = 'security'
+end
+
+# Register all settings
+plugin(:settings, :register) do |setting|
+  setting.title       = lang('settings.labels.website_name')
+  setting.description = lang('settings.placeholders.website_name')
+  setting.name        = 'website_name'
+  setting.group       = 'general'
+  setting.default     = 'Zen'
+  setting.type        = 'textbox'
+end
+
+plugin(:settings, :register) do |setting|
+  setting.title       = lang('settings.labels.website_description')
+  setting.description = lang('settings.placeholders.website_description')
+  setting.name        = 'website_description'
+  setting.group       = 'general'
+  setting.type        = 'textarea'
+end
+
+plugin(:settings, :register) do |setting|
+  setting.title       = lang('settings.labels.website_enabled')
+  setting.description = lang('settings.placeholders.website_enabled')
+  setting.name        = 'website_enabled'
+  setting.group       = 'general'
+  setting.type        = 'radio'
+  setting.default     = '1'
+  setting.values      = {
+    lang('zen_general.special.boolean_hash.true')  => '1',
+    lang('zen_general.special.boolean_hash.false') => '0'
+  }
+end
+
+plugin(:settings, :register) do |setting|
+  setting.title       = lang('settings.labels.language')
+  setting.description = lang('settings.placeholders.language')
+  setting.name        = 'language'
+  setting.group       = 'general'
+  setting.default     = 'en'
+  setting.type        = 'select'
+  setting.values      = {
+    'en' => lang('zen_general.special.language_hash.en')
+  }
+end
+
+plugin(:settings, :register) do |setting|
+  setting.title       = lang('settings.labels.default_section')
+  setting.description = lang('settings.placeholders.default_section')
+  setting.name        = 'default_section'
+  setting.group       = 'general'
+  setting.type        = 'select'
+  setting.values      = section_hash
+end
+
+plugin(:settings, :register) do |setting|
+  setting.title       = lang('settings.labels.theme')
+  setting.description = lang('settings.placeholders.theme')
+  setting.name        = 'theme'
+  setting.group       = 'general'
+  setting.type        = 'select'
+  setting.values      = theme_hash
+end
+
+plugin(:settings, :register) do |setting|
+  setting.title       = lang('settings.labels.enable_antispam')
+  setting.description = lang('settings.placeholders.enable_antispam')
+  setting.name        = 'enable_antispam'
+  setting.group       = 'security'
+  setting.type        = 'radio'
+  setting.values      = {
+    lang('zen_general.special.boolean_hash.true')  => '1',
+    lang('zen_general.special.boolean_hash.false') => '0'
+  }
+end
+
+plugin(:settings, :register) do |setting|
+  setting.title       = lang('settings.labels.defensio_key')
+  setting.description = lang('settings.placeholders.defensio_key')
+  setting.name        = 'defensio_key'
+  setting.group       = 'security'
+  setting.type        = 'textbox'
+end
+
+# Migrate all settings
+begin
+  plugin(:settings, :migrate)
+rescue
+  Ramaze::Log.warn(
+    "Failed to migrate the current settings, make sure the database table is up to date."
+  )
 end

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module Settings
   #:nodoc:
-  module Controllers
+  module Controller
     ##
     # Controller for managing settings. Each setting is saved as a separate
     # row in the database, making management and retrieving them easier.
@@ -9,11 +9,10 @@ module Settings
     # @author Yorick Peterse
     # @since  0.1
     #
-    class Settings < Zen::Controllers::AdminController
-      include ::Settings::Models
+    class Settings < Zen::Controller::AdminController
+      include ::Settings::Model
 
-      map   "/admin/settings"
-      trait :extension_identifier => 'com.zen.settings'
+      map('/admin/settings')
       
       before_all do
         csrf_protection(:save, :delete) do
@@ -36,8 +35,6 @@ module Settings
         
         @form_save_url = Settings.r(:save)
 
-        Zen::Language.load('settings')
-        
         # Set the page title
         if !action.method.nil?
           method      = action.method.to_sym
@@ -66,17 +63,17 @@ module Settings
         
         set_breadcrumbs(lang('settings.titles.index'))
         
-        settings  = Setting.all
-        @settings = {}
+        @settings_ordered = {}
+        @groups           = ::Settings::Plugin::Settings::Registered[:groups]
         
         # Organize the settings so that each item is a child
         # item of it's group.
-        settings.each do |s|
-          if !@settings.key?(s.group_key)
-            @settings[s.group_key.to_s] = []
+        ::Settings::Plugin::Settings::Registered[:settings].each do |name, setting|
+          if !@settings_ordered.key?(setting.group)
+            @settings_ordered[setting.group] = []
           end
           
-          @settings[s.group_key.to_s].push(s)
+          @settings_ordered[setting.group].push(setting)
         end
       end
       
@@ -102,19 +99,26 @@ module Settings
 
         flash_success = lang('settings.success.save')
         flash_error   = lang('settings.errors.save')
-        
-        begin
-          post.each do |key, value|
-            @setting = Setting[:key => key].update(:value => value)  
+
+        # Update all settings
+        post.each do |key, value|
+          setting = Setting[:name => key]
+
+          begin
+            # Update the DB record
+            setting.update(:value => value)
+            notification(:success, lang('settings.titles.index'), flash_success)
+
+            # Update the internal settings
+            if ::Zen::Settings[key.to_sym] != value
+              ::Zen::Settings[key.to_sym] = value
+            end
+          rescue
+            notification(:error, lang('settings.titles.index'), flash_error)
+            flash[:form_errors] = setting.errors
           end
-          
-          notification(:success, lang('settings.titles.index'), flash_success)
-        rescue
-          notification(:error, lang('settings.titles.index'), flash_error)
-          
-          flash[:form_errors] = @setting.errors
         end
-        
+
         redirect_referrer
       end
     end

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

@@ -12,6 +12,16 @@ labels:
   enable_antispam      : 'Enable anti-spam'
   defensio_key         : 'Defensio API key'
 
+placeholders:
+  website_name        : 'The name of the website.'
+  website_description : 'The description of the website.'
+  website_enabled     : 'Whether or not the website is available to non admins.'
+  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 Defensio's anti-spam system should be used."
+  defensio_key        : 'The API key to use for the Defensio anti-spam system.'
+
 tabs:
   general   : 'General'
   security  : 'Security'

data/lib/zen/package/settings/lib/settings/model/setting.rb

@@ -1,12 +1,12 @@
 #:nodoc:
 module Settings
   #:nodoc:
-  module Models
+  module Model
     ##
     # Model that represents a single setting. This model is also used to retrieve
     # all possible values for a certain settngs. This is done by calling a method
     # that matches the format get_SETTING-NAME_values. For example, a setting named "theme"
-    # would result in a call to Settings::Models::Setting#get_theme_values.
+    # would result in a call to Settings::Model::Setting#get_theme_values.
     #
     # In order to add new method you'll have to monkey patch this model as following:
     #
@@ -23,7 +23,6 @@ module Settings
     # idea to refactor this and put it in it's own class/plugin/whatever.
     #
     class Setting < Sequel::Model
-      include ::Zen::Language
 
       ##
       # Retrieves all settings and returns them as a key/value hash.
@@ -42,72 +41,12 @@ module Settings
             value = s.value
           end
           
-          settings[s.key.to_sym] = value
+          settings[s.name.to_sym] = value
         end
         
         return settings
       end
 
-      ##
-      # Generates the possible values for the setting "website_enabled".
-      #
-      # @author Yorick Peterse
-      # @since  0.2
-      # @return [Hash]
-      #
-      def self.get_website_enabled_values
-        hash = {
-          lang('zen_general.special.boolean_hash.true')  => '1',
-          lang('zen_general.special.boolean_hash.false') => '0'
-        }
-
-        return hash
-      end
-
-      ##
-      # Generates the possible values for the setting "language".
-      #
-      # @author Yorick Peterse
-      # @since  0.2
-      # @return [Hash]
-      #
-      def self.get_language_values
-        return ::Zen.languages
-      end
-
-      ##
-      # Generates the possible values for the setting "default_section".
-      #
-      # @author Yorick Peterse
-      # @since  0.2
-      # @return [Hash]
-      #
-      def self.get_default_section_values 
-        section_hash = {}
-
-        ::Sections::Models::Section.select(:name, :slug).each do |s|
-          section_hash[s.slug] = s.name
-        end
-
-        return section_hash
-      end
-
-      ##
-      # Generates the possible values for the setting "theme".
-      #
-      # @author Yorick Peterse
-      # @since  0.2
-      # @return [Hash]
-      #
-      def self.get_theme_values
-        theme_hash = {}
-
-        Zen::Theme.themes.each do |ident, theme|
-          theme_hash[ident] = theme.name
-        end
-
-        return theme_hash
-      end
     end
   end
 end