zen 0.2.7 → 0.2.8

data/lib/zen/package/sections/lib/sections/model/section_entry_status.rb

@@ -0,0 +1,13 @@
+module Sections
+  module Model
+    ##
+    # Model for managing the statuses of each section entry.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.8
+    #
+    class SectionEntryStatus < Sequel::Model
+      many_to_one :section_entry, :class => 'Sections::Model::SectionEntryStatus' 
+    end # SectionEntryStatus
+  end # Model
+end # Sections

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

@@ -3,10 +3,10 @@ module Sections
   #:nodoc:
   module Plugin
     ##
-    # The SectionEntries plugin can be used to retrieve section entries as well as the
-    # associated comments and user data. This allows you to relatively easily build a list
-    # of entries (e.g. blog articles) without having to retrieve and process the 
-    # associated data manually.
+    # The SectionEntries plugin can be used to retrieve section entries as well
+    # as the associated comments and user data. This allows you to relatively
+    # easily build a list of entries (e.g. blog articles) without having to
+    # retrieve and process the associated data manually.
     #
     # ## Usage
     #
@@ -17,9 +17,9 @@ module Sections
     #       puts e[:title]
     #     end
     #
-    # The values of custom fields are stored under the key :fields. This key contains a
-    # hash where the keys are the slugs of the custom fields and the values the values for
-    # the current entry.
+    # The values of custom fields are stored under the key :fields. This key
+    # contains a hash where the keys are the slugs of the custom fields and the
+    # values the values for the current entry.
     #
     #     entries.each do |e|
     #       e[:fields][:thumbnail]
@@ -39,7 +39,8 @@ module Sections
     #       end
     #     end
     #
-    # For a full list of available options see Sections::Plugin::SectionEntries.initialize.
+    # For a full list of available options see
+    # Sections::Plugin::SectionEntries.initialize.
     #
     # @author Yorick Peterse
     # @since  0.2.5
@@ -49,31 +50,32 @@ module Sections
       include ::Sections::Model
 
       ##
-      # Creates a new instance of the plugin and validates/stores the given configuration
-      # options. Please note that you always need to either specify a section from which
-      # to retrieve all entries or a single entry in order to use this plugin. You can
-      # retrieve a list of entries (or just a single one) by specifying the ID or the 
-      # slug:
+      # Creates a new instance of the plugin and validates/stores the given
+      # configuration options. Please note that you always need to either
+      # specify a section from which to retrieve all entries or a single entry
+      # in order to use this plugin. You can retrieve a list of entries (or just
+      # a single one) by specifying the ID or the slug:
       #
       #     plugin(:section_entries, :section => 'blog')
       #     plugin(:section_entries, :section => 10)
       #
       # @author Yorick Peterse
       # @since  0.2.5
-      # @param  [Hash] options Hash with a collection of custom configuration options that
-      # determine how and what entries should be retrieved.
+      # @param  [Hash] options Hash with a collection of custom configuration
+      # options that determine how and what entries should be retrieved.
       # @option options [Fixnum/Integer] :limit
       # @option options [Fixnum/Integer] :offset
       # @option options [NilClass/String/Integer/Fixnum] :section
       # @option options [NilClass/String/Integer/Fixnum] :entry
-      # @option options [TrueClass] :markup When set to true the markup of all entries will
-      # be converted to the desired output (usually this is HTML).
-      # @option options [TrueClass] :comments When set to true all comments for each entry
-      # will be retrieved.
-      # @option options [TrueClass] :comment_markup When set to true the markup of comments
-      # will be converted to the desired output.
-      # @option options [TrueClass] :categories When set to true all categories for each
-      # entry will be retrieved as well.
+      # @option options [TrueClass] :markup When set to true the markup of all
+      # entries will be converted to the desired output (usually this is HTML).
+      # @option options [TrueClass] :comments When set to true all comments for
+      # each entry will be retrieved. Set to false by default.
+      # @option options [TrueClass] :comment_markup When set to true the markup
+      # of comments will be converted to the desired output.
+      # @option options [TrueClass] :categories When set to true all categories
+      # for each entry will be retrieved as well. This is set to false by
+      # default.
       #
       def initialize(options = {})
         @options = {
@@ -82,29 +84,36 @@ module Sections
           :section        => nil,
           :entry          => nil,
           :markup         => true,
-          :comments       => true,
+          :comments       => false,
           :comment_markup => true,
-          :categories     => true
+          :categories     => false
         }.merge(options)
 
         validate_type(@options[:limit]   , :limit   , [Fixnum, Integer])
         validate_type(@options[:offset]  , :limit   , [Fixnum, Integer])
-        validate_type(@options[:section] , :section , [NilClass, String, Integer, Fixnum])
-        validate_type(@options[:entry]   , :entry   , [NilClass, String, Integer, Fixnum])
+
+        validate_type(
+          @options[:section], :section, [NilClass, String, Integer, Fixnum]
+        )
+
+        validate_type(
+          @options[:entry], :entry, [NilClass, String, Integer, Fixnum]
+        )
+
         validate_type(@options[:markup]  , :markup  , [TrueClass, FalseClass])
         validate_type(@options[:comments], :comments, [TrueClass, FalseClass])
 
         if @options[:section].nil? and @options[:entry].nil?
           raise(
-            ArgumentError, 
+            ArgumentError,
             "You need to specify either an entry or a section to retrieve."
           )
         end
       end
 
       ##
-      # Fetches all the data and converts everything to a hash. Once this is done either
-      # an array of entries or a single entry hash will be returned.
+      # Fetches all the data and converts everything to a hash. Once this is
+      # done either an array of entries or a single entry hash will be returned.
       #
       # @author Yorick Peterse
       # @since  0.2.5
@@ -112,14 +121,18 @@ module Sections
       #
       def call
         # Create the list with models to load using eager()
-        eager_models = [:custom_field_values, :categories, :section, :user]
+        eager_models = [:custom_field_values, :user]
         filter_hash  = {}
 
         if @options[:comments] === true
           eager_models.push(:comments)
         end
+        
+        if @options[:categories] === true
+          eager_models.push(:categories)
+        end
 
-        # Retrieve multiple entries
+        # Get the section ID based on either the slug or ID.
         if !@options[:section].nil?
           # Retrieve the section by it's slug
           if @options[:section].class == String
@@ -142,6 +155,10 @@ module Sections
           end
         end
 
+        # Get the correct status to retrieve
+        filter_hash[:section_entry_status_id] = \
+          ::Sections::Model::SectionEntryStatus[:name => 'published'].id
+
         # Get the entries
         entries = SectionEntry.filter(filter_hash) \
           .eager(*eager_models) \
@@ -152,10 +169,6 @@ module Sections
 
         # Loop through all entries so we can process our custom field values
         entries.each_with_index do |entry, index|
-          if comment_format.nil?
-            comment_format = entry.section.comment_format
-          end
-
           field_values = {}
           user         = {}
           comments     = []
@@ -176,6 +189,10 @@ module Sections
 
           # Get all the comments if the developer wants them
           if @options[:comments] === true
+            if comment_format.nil?
+              comment_format = entry.section.comment_format
+            end
+
             entry.comments.each do |c|
               comment = c.values
 
@@ -185,7 +202,9 @@ module Sections
 
               # Convert the comment's markup
               if @options[:comment_markup]
-                comment[:comment] = plugin(:markup, comment_format, comment[:comment])
+                comment[:comment] = plugin(
+                  :markup, comment_format, comment[:comment]
+                )
               end
 
               comments.push(comment)
@@ -198,8 +217,10 @@ module Sections
           end
 
           # Get all categories
-          categories = entry.categories.map do |cat|
-            cat.values
+          if @options[:categories] === true
+            categories = entry.categories.map do |cat|
+              cat.values
+            end
           end
 
           # Convert the entry to a hash and re-assign all data

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

@@ -3,8 +3,8 @@ 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 
+    # 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
@@ -20,8 +20,8 @@ module Sections
       include ::Sections::Model
 
       ##
-      # Creates a new instance of the plugin and saves/validates the given configuration
-      # options.
+      # Creates a new instance of the plugin and saves/validates the given
+      # configuration options.
       #
       # @example
       #  plugin = Sections::Plugin::Sections.new(:section => 10)
@@ -39,19 +39,22 @@ module Sections
 
         validate_type(@options[:limit]  , :limit  , [Fixnum, Integer])
         validate_type(@options[:offset] , :offset , [Fixnum, Integer])
-        validate_type(@options[:section], :section, [NilClass, Integer, Fixnum, String])
+
+        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.
+      # 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.
+      # @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

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

@@ -1,107 +1,110 @@
-<div class="tabs">
-    <ul>
-        <li>
-            <a href="#general" title="#{lang('sections.tabs.general')}">
-                #{lang('sections.tabs.general')}
-            </a>
-        </li>
-        <li>
-            <a href="#comments" title="#{lang('sections.tabs.comment_settings')}">
-                #{lang('sections.tabs.comment_settings')}
-            </a>
-        </li>
-        <li>
-            <a href="#groups" title="#{lang('sections.tabs.group_assignments')}">
-                #{lang('sections.tabs.group_assignments')}
-            </a>
-        </li>
-    </ul>
-</div>
-  
-#{
-form_for(@section, :method => 'post', :action => @form_save_url, :id => :section_form) do |f|
+<article>
+    <header>
+        <h1>#{get_breadcrumbs}</h1>
+    </header>
 
-  f.input_hidden(:id, @section.id)
-  f.input_hidden(:csrf_token, get_csrf_token)
-  
-  f.g.div(:id => 'general') do
+    <div class="tabs">
+        <ul>
+            <li>
+                <a href="#general" title="#{lang('sections.tabs.general')}">
+                    #{lang('sections.tabs.general')}
+                </a>
+            </li>
+            <li>
+                <a href="#comments"
+                title="#{lang('sections.tabs.comment_settings')}">
+                    #{lang('sections.tabs.comment_settings')}
+                </a>
+            </li>
+            <li>
+                <a href="#groups"
+                title="#{lang('sections.tabs.group_assignments')}">
+                    #{lang('sections.tabs.group_assignments')}
+                </a>
+            </li>
+        </ul>
+    </div>
 
-    f.input_text(
-      lang('sections.labels.name'), 
-      :name
-    )
+    #{
+    form_for(
+      @section,
+      :method => 'post',
+      :action => Sections::Controller::Sections.r(:save),
+      :id     => :section_form
+    ) do |f|
+      f.input_hidden(:id        , @section.id)
+      f.input_hidden(:csrf_token, get_csrf_token)
 
-    f.input_text(
-      lang('sections.labels.slug'), 
-      :slug
-    )
+      f.g.div(:id => 'general') do
+        f.input_text(
+          lang('sections.labels.name'),
+          :name
+        )
 
-    f.textarea(
-      lang('sections.labels.description'), 
-      :description, 
-      :rows => 8
-    )
+        f.input_text(
+          lang('sections.labels.slug'),
+          :slug
+        )
 
-  end
-  
-  f.g.div(:id => 'comments') do
+        f.textarea(
+          lang('sections.labels.description'),
+          :description,
+          :rows => 8
+        )
+      end # f.g.div(:id => 'general')
 
-    f.input_radio(
-      lang('sections.labels.comment_allow'), 
-      :comment_allow, 
-      @section.comment_allow,
-      :values => @boolean_hash 
-    )
-    
-    f.input_radio(
-      lang('sections.labels.comment_require_account'),
-      :comment_require_account, 
-      @section.comment_require_account,
-      :values => @boolean_hash
-    )
-      
-    f.input_radio(
-      lang('sections.labels.comment_moderate'), 
-      :comment_moderate, 
-      @section.comment_moderate,
-      :values => @boolean_hash
-    )
-      
-    f.select(
-      lang('sections.labels.comment_format'), 
-      :comment_format,
-      :values   => Zen::Plugin::Markup::Engines, 
-      :selected => @section.comment_format, 
-      :size     => 1
-    )
+      f.g.div(:id => 'comments') do
+        f.input_radio(
+          lang('sections.labels.comment_allow'),
+          :comment_allow,
+          @section.comment_allow,
+          :values => @boolean_hash.invert
+        )
 
-  end
-  
-  f.g.div(:id => 'groups') do
+        f.input_radio(
+          lang('sections.labels.comment_require_account'),
+          :comment_require_account,
+          @section.comment_require_account,
+          :values => @boolean_hash.invert
+        )
 
-    f.select(
-      lang('sections.labels.custom_field_groups'), 
-      :custom_field_group_pks, 
-      :values   => @custom_field_group_pk_hash,
-      :multiple => :multiple,
-      :selected => @section.custom_field_group_pks
-    )
-    
-    f.select(
-      lang('sections.labels.category_groups'), 
-      :category_group_pks, 
-      :values   => @category_group_pk_hash,
-      :multiple => :multiple, 
-      :selected => @section.category_group_pks
-    )
+        f.input_radio(
+          lang('sections.labels.comment_moderate'),
+          :comment_moderate,
+          @section.comment_moderate,
+          :values => @boolean_hash.invert
+        )
 
-  end
-  
-  f.g.div(:class => 'clearfix') do
-    f.g.div(:class => 'button') do
-      f.g.input(:type => 'submit', :value => lang('sections.buttons.save'))
-    end
-  end
+        f.select(
+          lang('sections.labels.comment_format'),
+          :comment_format,
+          :values   => Zen::Plugin::Markup::Engines,
+          :selected => @section.comment_format,
+          :size     => 1
+        )
+      end # f.g.div(:id => 'comments')
+
+      f.g.div(:id => 'groups') do
+        f.select(
+          lang('sections.labels.custom_field_groups'),
+          :custom_field_group_pks,
+          :values   => @custom_field_group_pk_hash,
+          :multiple => :multiple,
+          :selected => @section.custom_field_group_pks
+        )
 
-end
-}
+        f.select(
+          lang('sections.labels.category_groups'),
+          :category_group_pks,
+          :values   => @category_group_pk_hash,
+          :multiple => :multiple,
+          :selected => @section.category_group_pks
+        )
+      end # f.g.div(:id => 'groups')
+
+      f.g.div(:class => 'button') do
+        f.g.input(:type => 'submit', :value => lang('sections.buttons.save'))
+      end
+    end
+    }
+</article>