zen 0.2.7 → 0.2.8

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

@@ -3,10 +3,10 @@ module Sections
   #:nodoc:
   module Controller
     ##
-    # Sections can be seen as mini applications inside your website.
-    # Examples of sections can be a blog, pages, a products listing, etc.
-    # Before being able to properly add section entries you need to assign
-    # the following data to a section:
+    # Sections can be seen as mini applications inside your website.  Examples
+    # of sections can be a blog, pages, a products listing, etc.  Before being
+    # able to properly add section entries you need to assign the following data
+    # to a section:
     #
     # * a category group
     # * a custom field group
@@ -17,10 +17,11 @@ module Sections
     class Sections < Zen::Controller::AdminController
       include ::Sections::Model
 
-      map '/admin'
+      map    '/admin'
+      helper :section
 
       # Load all required Javascript files
-      javascript ['zen/tabs']
+      javascript(['zen/lib/tabs'], :method => [:edit, :new])
 
       before_all do
         csrf_protection(:save, :delete) do
@@ -29,8 +30,8 @@ module Sections
       end
 
       ##
-      # Constructor method, called upon initialization. It's used to set the
-      # URL to which forms send their data and load the language pack.
+      # Constructor method, called upon initialization. It's used to set the URL
+      # to which forms send their data and load the language pack.
       #
       # This method loads the following language files:
       #
@@ -42,9 +43,6 @@ module Sections
       def initialize
         super
 
-        @form_save_url   = Sections.r(:save)
-        @form_delete_url = Sections.r(:delete)
-
         Zen::Language.load('sections')
 
         # Set the page title
@@ -52,6 +50,11 @@ module Sections
           method      = action.method.to_sym
           @page_title = lang("sections.titles.#{method}") rescue nil
         end
+
+        @boolean_hash = {
+          true  => lang('zen_general.special.boolean_hash.true'),
+          false => lang('zen_general.special.boolean_hash.false')
+        }
       end
 
       ##
@@ -66,13 +69,25 @@ module Sections
       # @since  0.1
       #
       def index
-        if !user_authorized?([:read])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:read)
 
         set_breadcrumbs(lang('sections.titles.index'))
 
-        @sections = Section.all
+        @sections = paginate(Section)
+      end
+
+      ##
+      # Hook that is executed before the edit() and new() methods.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      #
+      before(:edit, :new) do
+        @custom_field_group_pk_hash = CustomFields::Model::CustomFieldGroup \
+          .pk_hash(:name)
+
+        @category_group_pk_hash = Categories::Model::CategoryGroup \
+          .pk_hash(:name)
       end
 
       ##
@@ -84,27 +99,25 @@ module Sections
       # * update
       #
       # @author Yorick Peterse
-      # @param  [Integer] id The ID of the section to retrieve so that we can edit it.
+      # @param  [Integer] id The ID of the section to retrieve so that we can
+      # edit it.
       # @since  0.1
       #
       def edit(id)
-        if !user_authorized?([:read, :update])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:read, :update)
 
         set_breadcrumbs(
-          anchor_to(lang('sections.titles.index'), Sections.r(:index)),
+          Sections.a(lang('sections.titles.index'), :index),
           @page_title
         )
 
-        @custom_field_group_pk_hash = CustomFields::Model::CustomFieldGroup.pk_hash(:name)
-        @category_group_pk_hash     = Categories::Model::CategoryGroup.pk_hash(:name)
-
         if flash[:form_data]
           @section = flash[:form_data]
         else
-          @section = Section[id.to_i]
+          @section = validate_section(id)
         end
+
+        render_view(:form)
       end
 
       ##
@@ -119,24 +132,23 @@ module Sections
       # @since  0.1
       #
       def new
-        if !user_authorized?([:create, :read])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:create, :read)
 
         set_breadcrumbs(
-          anchor_to(lang('sections.titles.index'), Sections.r(:index)),
+          Sections.a(lang('sections.titles.index'), :index),
           @page_title
         )
 
-        @custom_field_group_pk_hash = CustomFields::Model::CustomFieldGroup.pk_hash(:name)
-        @category_group_pk_hash     = Categories::Model::CategoryGroup.pk_hash(:name)
-        @section                    = Section.new
+        @section = Section.new
+
+        render_view(:form)
       end
 
       ##
-      # Method used for processing the form data and redirecting the user back to
-      # the proper URL. Based on the value of a hidden field named "id" we'll determine
-      # if the data will be used to create a new section or to update an existing one.
+      # Method used for processing the form data and redirecting the user back
+      # to the proper URL. Based on the value of a hidden field named "id" we'll
+      # determine if the data will be used to create a new section or to update
+      # an existing one.
       #
       # This method requires the following permissions:
       #
@@ -147,19 +159,27 @@ module Sections
       # @since  0.1
       #
       def save
-        if !user_authorized?([:create, :update])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
-
         post = request.subset(
-          :id, :name, :slug, :description, :comment_allow, :comment_require_account,
-          :comment_moderate, :comment_format, :custom_field_group_pks, :category_group_pks
+          :id,
+          :name,
+          :slug,
+          :description,
+          :comment_allow,
+          :comment_require_account,
+          :comment_moderate,
+          :comment_format,
+          :custom_field_group_pks,
+          :category_group_pks
         )
 
         if post['id'] and !post['id'].empty?
-          @section      = Section[post['id']]
+          require_permissions(:update)
+
+          @section      = validate_section(post['id'])
           save_action   = :save
         else
+          require_permissions(:create)
+
           @section      = Section.new
           save_action   = :new
         end
@@ -167,11 +187,11 @@ module Sections
         flash_success = lang("sections.success.#{save_action}")
         flash_error   = lang("sections.errors.#{save_action}")
 
-
         post['custom_field_group_pks'] ||= []
         post['category_group_pks']     ||= []
 
-        # The primary keys have to be integers otherwise Sequel will soil it's pants
+        # The primary keys have to be integers otherwise Sequel will soil it's
+        # pants
         ['custom_field_group_pks', 'category_group_pks'].each do |k|
           post[k].map! { |value| value.to_i }
         end
@@ -195,6 +215,8 @@ module Sections
 
           flash[:form_data]   = @section
           flash[:form_errors] = @section.errors
+
+          redirect_referrer
         end
 
         if @section.id
@@ -205,10 +227,10 @@ module Sections
       end
 
       ##
-      # Delete an existing section. Poor section, what did he do wrong?
-      # In order to delete a section you'll need to send a POST request that contains
-      # a field named "section_ids[]". This field should contain the primary values of
-      # each section that has to be deleted.
+      # Delete an existing section. Poor section, what did he do wrong? In order
+      # to delete a section you'll need to send a POST request that contains a
+      # field named "section_ids[]". This field should contain the primary
+      # values of each section that has to be deleted.
       #
       # This method requires the following permissions:
       #
@@ -218,9 +240,7 @@ module Sections
       # @since  0.1
       #
       def delete
-        if !user_authorized?([:delete])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:delete)
 
         if !request.params['section_ids'] or request.params['section_ids'].empty?
           message(:error, lang('sections.errors.no_delete'))
@@ -234,6 +254,8 @@ module Sections
           rescue => e
             Ramaze::Log.error(e.inspect)
             message(:error, lang('sections.errors.delete') % id)
+
+            redirect_referrer
           end
         end
 

data/lib/zen/package/sections/lib/sections/helper/section.rb

@@ -0,0 +1,53 @@
+module Ramaze
+  module Helper
+    ##
+    # Helper for the sections package.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.8
+    #
+    module Section
+      ##
+      # Validates the section ID and returns the section if it's valid.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @param  [Fixnum] section_id The ID of the section to validate.
+      # @return [Sections::Model::Section]
+      #
+      def validate_section(section_id)
+        section = Sections::Model::Section[section_id]
+
+        if section.nil?
+          message(:error, lang('sections.errors.invalid_section'))
+          redirect(Sections::Controller::Sections.r(:index))
+        else
+          return section
+        end
+      end
+
+      ##
+      # Validates a section entry and returns it if it's valid.
+      #
+      # 
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @param  [Fixnum] section_entry_id The ID of the section entry to
+      # validate.
+      # @param  [Fixnum] section_id The ID of the section to use when
+      # redirecting the user to the overview of all entries.
+      # @return [Sections::Model::SectionEntry]
+      #
+      def validate_section_entry(section_entry_id, section_id)
+        entry = Sections::Model::SectionEntry[section_entry_id]
+
+        if entry.nil?
+          message(:error, lang('section_entries.errors.invalid_entry'))
+          redirect(Sections::Controller::SectionEntries.r(:index, section_id))
+        else
+          return entry
+        end
+      end
+    end # Section
+  end # Helper
+end # Ramaze

data/lib/zen/package/sections/lib/sections/language/en/section_entries.yml

@@ -27,10 +27,11 @@ messages:
   no_categories  : 'No categories have been assigned to the current section.'
 
 errors:
-  new        : 'Failed to create a new section entry.'
-  save       : 'Failed to save the section entry.'
-  delete     : 'Failed to delete the section entry with ID#%s'
-  no_delete  : "You haven't specified any section entries to delete."
+  new          : 'Failed to create a new section entry.'
+  save         : 'Failed to save the section entry.'
+  delete       : 'Failed to delete the section entry with ID#%s'
+  no_delete    : "You haven't specified any section entries to delete."
+  invalid_entry: 'The specified entry is invalid.'
 
 success:
   new     : 'The new section entry has been created.'

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

@@ -31,10 +31,11 @@ messages:
   no_sections: "No sections have been created yet."
 
 errors:
-  new        : 'Failed to create a new section.'
-  save       : 'Failed to modify the section.'
-  delete     : 'Failed to delete the section with ID #%s.'
-  no_delete  : 'You need to specify at least one section to delete.'
+  new            : 'Failed to create a new section.'
+  save           : 'Failed to modify the section.'
+  delete         : 'Failed to delete the section with ID #%s.'
+  no_delete      : 'You need to specify at least one section to delete.'
+  invalid_section: 'The specified section is invalid.'
 
 success:
   new     : 'The new section has been created.'

data/lib/zen/package/sections/lib/sections/language/nl/section_entries.yml

@@ -32,10 +32,11 @@ success:
   delete: 'Alle geselecteerde items zijn verwijderd.'
 
 errors:
-  new      : 'Het sectie item kon niet worden aangemaakt.'
-  save     : 'Het sectie item kon niet worden aangepast.'
-  delete   : 'Het sectie item met ID #%s kon niet worden verwijderd.'
-  no_delete: 'U moet ten minste 1 item specificeren om te verwijderen.'
+  new          : 'Het sectie item kon niet worden aangemaakt.'
+  save         : 'Het sectie item kon niet worden aangepast.'
+  delete       : 'Het sectie item met ID #%s kon niet worden verwijderd.'
+  no_delete    : 'U moet ten minste 1 item specificeren om te verwijderen.'
+  invalid_entry: 'Het opgegeven item is ongeldig.'
 
 buttons:
   new   : 'Sectie item toevoegen'

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

@@ -36,10 +36,11 @@ success:
   delete: 'Alle geselecteerde secties zijn verwijderd.'
 
 errors:
-  new      : 'De sectie kon niet worden aangemaakt.'
-  save     : 'De sectie kon niet worden aangepast.'
-  delete   : 'De sectie met ID #%s kon niet worden verwijderd.'
-  no_delete: 'U moet ten minste 1 sectie specificeren om te verwijderen.'
+  new            : 'De sectie kon niet worden aangemaakt.'
+  save           : 'De sectie kon niet worden aangepast.'
+  delete         : 'De sectie met ID #%s kon niet worden verwijderd.'
+  no_delete      : 'U moet ten minste 1 sectie specificeren om te verwijderen.'
+  invalid_section: 'De opgegeven sectie is ongeldig.'
 
 buttons:
   new   : 'Sectie toevoegen'

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

@@ -21,11 +21,18 @@ module Sections
       one_to_many(
         :section_entries, 
         :class => "Sections::Model::SectionEntry", 
-        :eager => [:custom_field_values]
+        :eager => [:custom_field_values, :section_entry_status]
       )
       
-      many_to_many(:custom_field_groups, :class => "CustomFields::Model::CustomFieldGroup")
-      many_to_many(:category_groups, :class => "Categories::Model::CategoryGroup")
+      many_to_many(
+        :custom_field_groups, 
+        :class => "CustomFields::Model::CustomFieldGroup"
+      )
+
+      many_to_many(
+        :category_groups, 
+        :class => "Categories::Model::CategoryGroup"
+      )
 
       plugin(:sluggable, :source => :name, :freeze => false)
       
@@ -36,12 +43,13 @@ module Sections
       # @since  0.1
       #
       def validate
-        validates_presence(
-          [
-            :name, :comment_allow, :comment_require_account, :comment_moderate, 
-            :comment_format
-          ]
-        )
+        validates_presence([
+          :name, 
+          :comment_allow, 
+          :comment_require_account, 
+          :comment_moderate, 
+          :comment_format
+        ])
 
         validates_presence(:slug) unless new?
         validates_max_length(255, [:name, :slug])

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

@@ -20,37 +20,216 @@ module Sections
     # @since  0.1
     #
     class SectionEntry < Sequel::Model
-      one_to_many(:comments, :class => "Comments::Model::Comment")
+      one_to_many(
+        :comments,
+        :class => "Comments::Model::Comment"
+      )
 
       one_to_many(
-        :custom_field_values, 
-        :class => "CustomFields::Model::CustomFieldValue", 
+        :custom_field_values,
+        :class => "CustomFields::Model::CustomFieldValue",
         :eager => [:custom_field]
       )
-      
-      many_to_one(:user       , :class => "Users::Model::User")
-      many_to_many(:categories, :class => "Categories::Model::Category")
-      many_to_one(:section    , :class => "Sections::Model::Section")
-      
+
+      many_to_one(
+        :user,
+        :class => "Users::Model::User"
+      )
+
+      many_to_many(
+        :categories,
+        :class => "Categories::Model::Category"
+      )
+
+      many_to_one(
+        :section,
+        :class => "Sections::Model::Section"
+      )
+
+      many_to_one(
+        :section_entry_status,
+        :class => 'Sections::Model::SectionEntryStatus'
+      )
+
       plugin(:sluggable , :source => :title     , :freeze => false)
       plugin(:timestamps, :create => :created_at, :update => false)
-      
+
       ##
       # Specify our validation rules.
       #
       # @author Yorick Peterse
       # @since  0.1
-      # 
+      #
       def validate
-        validates_presence([:title, :status, :user_id])
+        validates_presence([:title, :user_id])
         validates_presence(:slug) unless new?
+        validates_integer(:section_entry_status_id)
 
         # Check if the slug is unique for the current section
-        if !SectionEntry.filter({:slug => slug, :section_id => section_id}, ~{:id => id}) \
-          .all.empty?
+        if !SectionEntry \
+        .filter({:slug => slug, :section_id => section_id}, ~{:id => id}) \
+        .all.empty?
           errors.add(:slug, lang('zen_models.unique'))
         end
       end
+
+      ##
+      # Returns a hash containing all the entry statuses. The keys of this hash
+      # are the IDs and the values the names.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @return [Hash]
+      #
+      def self.status_hash
+        ::Zen::Language.load('section_entries')
+
+        statuses = {}
+
+        ::Sections::Model::SectionEntryStatus.all.each do |status|
+          statuses[status.id] = lang(
+            "section_entries.special.status_hash.#{status.name}"
+          )
+        end
+
+        return statuses
+      end
+
+      ##
+      # Retrieves all custom fields for a section entry.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @return [Array]
+      #
+      def custom_fields
+        return CustomFields::Model::CustomField.select_all(
+          :custom_fields
+        ).join(
+          :custom_field_groups,
+          :custom_field_groups__id => :custom_fields__custom_field_group_id
+        ).join(
+          :custom_field_groups_sections,
+          :custom_field_groups_sections__custom_field_group_id \
+            => :custom_field_groups__id
+        ).filter(
+          :custom_field_groups_sections__section_id => section_id
+        ).all
+      end
+
+      ##
+      # Retrieves all the possible categories for an entry and returns these as
+      # a hash. This hash is a multi dimensional hash where the keys are the
+      # names of all available category groups and the values hashes with the
+      # IDs and names of all the categories for that group.
+      #
+      # @example
+      #  e = Sections::Model::SectionEntry[1]
+      #  e.possible_categories # => {'Blog' => {1 => 'General', 2 => 'Code'}}
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @return [Hash]
+      #
+      def possible_categories
+        hash  = {}
+        query = Zen.database[:category_groups_sections] \
+          .select(
+            :categories__id,
+            :categories__name,
+            :category_groups__name => :category_group_name
+          ) \
+          .left_join(
+            :categories,
+            :category_groups_sections__category_group_id \
+              => :categories__category_group_id
+          ) \
+          .left_join(
+            :category_groups,
+            :category_groups_sections__category_group_id => :category_groups__id
+          ) \
+          .filter(
+            :category_groups_sections__section_id => section_id
+          ) \
+          .all
+
+        query.each do |row|
+          hash[row[:category_group_name]]           ||= {}
+          hash[row[:category_group_name]][row[:id]]   = row[:name]
+        end
+
+        return hash
+      end
+
+      ##
+      # Gathers all the custom field groups, custom fields and custom field
+      # values and returns them as a hash. This hash can be used in views to
+      # build the HTML for all the fields.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @return [Hash]
+      #
+      def custom_fields_hash
+        result    = {}
+        values    = {}
+        groups    = section.custom_field_groups
+        group_ids = groups.map { |g| g.id }
+        fields    = {}
+
+        # Get all the custom fields in one go rather than running a query for
+        # each group.
+        CustomFields::Model::CustomField.filter(
+          :custom_field_group_id => group_ids
+        ).each do |field|
+          fields[field.custom_field_group_id] ||= []
+          fields[field.custom_field_group_id].push(field)
+        end
+
+        # Index the custom field values hash so that the keys are the IDs of the
+        # custom fields and the values the instances of
+        # CustomFields::Model::CustomFieldValue.
+        custom_field_values.each do |val|
+          values[val.custom_field_id] = val
+        end
+
+        # Build the hash containing all the details of each field
+        groups.each do |group|
+          result[group.id] ||= {:name => group.name, :fields => []}
+
+          fields[group.id].each do |field|
+            m = field.custom_field_type.custom_field_method.name
+
+            begin
+              result[group.id][:fields].push(
+                CustomFields::BlueFormParameters.send(
+                  m, field, values[field.id]
+                )
+              )
+            rescue => e
+              Ramaze::Log.error(e)
+            end
+          end
+        end
+
+        return result
+      end
+
+      ##
+      # Hook that is executed before saving an existing section entry.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      #
+      def before_save
+        if self.section_entry_status_id.nil?
+          self.section_entry_status_id = ::Sections::Model::SectionEntryStatus[
+            :name => 'draft'
+          ].id
+        end
+
+        super
+      end
     end # SectionEntry
   end # Model
 end # Sections