zen 0.2.7 → 0.2.8

data/lib/zen/package/categories/lib/categories/controller/category_groups.rb

@@ -1,10 +1,12 @@
+#:nodoc:
 module Categories
+  #:nodoc:
   module Controller
     ##
-    # Category groups can be used to group a number of categories into a single container.
-    # These groups are assigned to a section (rather than individual categories). It's
-    # important to remember that a section entry can't use a category group until it has
-    # been added to a section.
+    # Category groups can be used to group a number of categories into a single
+    # container. These groups are assigned to a section (rather than individual
+    # categories). It's important to remember that a section entry can't use a
+    # category group until it has been added to a section.
     #
     # @author Yorick Peterse
     # @since  0.1
@@ -12,7 +14,8 @@ module Categories
     class CategoryGroups < Zen::Controller::AdminController
       include ::Categories::Model
 
-      map('/admin/category-groups')
+      helper :category
+      map    '/admin/category-groups'
 
       before_all do
         csrf_protection(:save, :delete) do
@@ -21,8 +24,8 @@ module Categories
       end
 
       ##
-      # The constructor is used to set various options such as the form URLs and load
-      # the language pack for the categories module.
+      # The constructor is used to set various options such as the form URLs and
+      # load the language pack for the categories module.
       #
       # The following language files are loaded:
       #
@@ -34,9 +37,6 @@ module Categories
       def initialize
         super
 
-        @form_save_url   = CategoryGroups.r(:save)
-        @form_delete_url = CategoryGroups.r(:delete)
-
         Zen::Language.load('category_groups')
 
         # Set the page title
@@ -58,13 +58,11 @@ module Categories
       # @since  0.1
       #
       def index
-        if !user_authorized?([:read])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:read)
 
         set_breadcrumbs(lang('category_groups.titles.index'))
 
-        @category_groups = CategoryGroup.all
+        @category_groups = paginate(CategoryGroup)
       end
 
       ##
@@ -77,25 +75,26 @@ module Categories
       # @author Yorick Peterse
       # @since  0.1
       #
-      def edit id
-        if !user_authorized?([:read, :update])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+      def edit(id)
+        require_permissions(:read, :update)
 
         set_breadcrumbs(
-          anchor_to(lang('category_groups.titles.index'), CategoryGroups.r(:index)),
+          CategoryGroups.a(lang('category_groups.titles.index'), :index),
           lang('category_groups.titles.edit')
         )
 
         if flash[:form_data]
           @category_group = flash[:form_data]
         else
-          @category_group = CategoryGroup[id]
+          @category_group = validate_category_group(id)
         end
+
+        render_view(:form)
       end
 
       ##
-      # Create a new category group. This method requires the following permissions:
+      # Create a new category group. This method requires the following
+      # permissions:
       #
       # * create
       # * read
@@ -104,16 +103,16 @@ module Categories
       # @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('category_groups.titles.index'), CategoryGroups.r(:index)),
+          CategoryGroups.a(lang('category_groups.titles.index'), :index),
           lang('category_groups.titles.new')
         )
 
         @category_group = CategoryGroup.new
+
+        render_view(:form)
       end
 
       ##
@@ -127,18 +126,18 @@ module Categories
       # @since  0.1
       #
       def save
-        if !user_authorized?([:create, :update])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
-
         post = request.subset(:id, :name, :description)
 
         if post['id'] and !post['id'].empty?
-          @category_group = CategoryGroup[post['id']]
-          save_action     = :save
+          require_permissions(:update)
+
+          category_group = validate_category_group(post['id'])
+          save_action    = :save
         else
-          @category_group = CategoryGroup.new
-          save_action     = :new
+          require_permissions(:create)
+
+          category_group = CategoryGroup.new
+          save_action    = :new
         end
 
         # Set the messages
@@ -149,18 +148,20 @@ module Categories
 
         # Try to run the query
         begin
-          @category_group.update(post)
+          category_group.update(post)
           message(:success, flash_success)
         rescue => e
           message(:error, flash_error)
           Ramaze::Log.error(e.inspect)
 
-          flash[:form_data]   = @category_group
-          flash[:form_errors] = @category_group.errors
+          flash[:form_data]   = category_group
+          flash[:form_errors] = category_group.errors
+
+          redirect_referrer
         end
 
-        if !@category_group.nil? and @category_group.id
-          redirect(CategoryGroups.r(:edit, @category_group.id))
+        if !category_group.nil? and category_group.id
+          redirect(CategoryGroups.r(:edit, category_group.id))
         else
           redirect(CategoryGroups.r(:new))
         end
@@ -168,9 +169,9 @@ module Categories
 
       ##
       # Delete all specified category groups and their categories. In
-      # order to delete a number of groups an array of fields, named "category_group_ids"
-      # is required. This array will contain all the primary values of each group that
-      # has to be deleted.
+      # order to delete a number of groups an array of fields, named
+      # "category_group_ids" is required. This array will contain all the
+      # primary values of each group that has to be deleted.
       #
       # This method requires the following permissions:
       #
@@ -180,9 +181,7 @@ module Categories
       # @since  0.1
       #
       def delete
-        if !user_authorized?([:delete])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        require_permissions(:delete)
 
         post = request.subset(:category_group_ids)
 
@@ -198,6 +197,8 @@ module Categories
           rescue => e
             Ramaze::Log.error(e.inspect)
             message(:error, lang('category_groups.errors.delete') % id)
+
+            redirect_referrer
           end
         end
 

data/lib/zen/package/categories/lib/categories/helper/category.rb

@@ -0,0 +1,88 @@
+#:nodoc:
+module Ramaze
+  #:nodoc:
+  module Helper
+    ##
+    # Helper for the Categories package. Note that this helper requires the
+    # helper Ramaze::Helper::Message to be loaded.
+    #
+    # @author Yorick Peterse
+    # @since   0.2.8
+    #
+    module Category
+      ##
+      # Checks if the specified category group ID results in a valid instance of
+      # Categories::Model::CategoryGroup. If this is the case the object is
+      # returned, otherwise the user is redirected back to the overview of all
+      # category groups and is informed about the group being invalid.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @param  [Fixnum] category_group_id The ID of the category group to
+      # validate.
+      # @return [Categories::Model::CategoryGroup]
+      #
+      def validate_category_group(category_group_id)
+        group = ::Categories::Model::CategoryGroup[category_group_id]
+
+        if group.nil?
+          message(:error, lang('category_groups.errors.invalid_group'))
+          redirect(::Categories::Controller::CategoryGroups.r(:index))
+        else
+          return group
+        end
+      end
+
+      ##
+      # Similar to validate_category_group this method checks if a category is
+      # valid or not. If it's valid the object is returned, otherwise an error
+      # is displayed and the user is redirected back to the overview of
+      # categories.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @param  [Fixnum] category_id The ID of the category.
+      # @param  [Fixnum] category_group_id The ID of the category group, used
+      # when redirecting the user.
+      # @return [Categories::Model::Category]
+      #
+      def validate_category(category_id, category_group_id)
+        category = ::Categories::Model::Category[category_id]
+
+        if category.nil?
+          message(:error, lang('categories.errors.invalid_category'))
+          redirect(
+            ::Categories::Controller::Categories.r(:index, category_group_id)
+          )
+        else
+          return category
+        end
+      end
+
+      ##
+      # Method that extracts all the possible parent categories for a given
+      # category group ID.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.8
+      # @param  [Fixnum[ category_id The ID of the category, this one will be
+      # excluded from the hash.
+      # @param  [Fixnum] category_group_id The ID of a category group for which
+      # to retrieve all the possible parent items.
+      # @return [Hash]
+      #
+      def parent_categories(category_id, category_group_id)
+        parent_categories = {}
+
+        Categories::Model::CategoryGroup[category_group_id].categories \
+        .each do |c|
+          parent_categories[c.id] = c.name if c.id != category_id
+        end
+
+        parent_categories[nil] = '--'
+
+        return parent_categories
+      end
+    end # Category
+  end # Helper
+end # Ramaze

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

@@ -24,10 +24,11 @@ success:
   delete : 'The selected categories have been deleted.'
 
 errors:
-  new       : 'Failed to add a new category.'
-  save      : 'Failed to save the category.'
-  delete    : 'Failed to delete the category with ID #%s.'
-  no_delete : "You haven't specified any categories to delete."
+  new             : 'Failed to add a new category.'
+  save            : 'Failed to save the category.'
+  delete          : 'Failed to delete the category with ID #%s.'
+  no_delete       : "You haven't specified any categories to delete."
+  invalid_category: 'The specified category is invalid.'
 
 buttons:
   new    : 'Add Category'

data/lib/zen/package/categories/lib/categories/language/en/category_groups.yml

@@ -22,10 +22,11 @@ success:
   delete : 'The category group has been deleted.'
 
 errors:
-  new      : 'Failed to add a new category group.'
-  save     : 'Failed to modify the category group.'
-  delete   : 'Failed to delete the category group with ID #%s.'
-  no_delete: 'You need to specify at least one group to delete.'
+  new          : 'Failed to add a new category group.'
+  save         : 'Failed to modify the category group.'
+  delete       : 'Failed to delete the category group with ID #%s.'
+  no_delete    : 'You need to specify at least one group to delete.'
+  invalid_group: 'The specified category group is invalid.'
 
 buttons:
   new    : 'Add group'

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

@@ -28,10 +28,11 @@ success:
   delete: 'De categorie is verwijderd.'
 
 errors:
-  new      : 'De categorie kon niet worden aangemaakt.'
-  save     : 'De categorie kon niet worden aangepast.'
-  delete   : 'De categorie met ID #%s kon niet worden verwijderd.'
-  no_delete: 'U moet ten minste 1 categorie specificeren om te verwijderen.'
+  new             : 'De categorie kon niet worden aangemaakt.'
+  save            : 'De categorie kon niet worden aangepast.'
+  delete          : 'De categorie met ID #%s kon niet worden verwijderd.'
+  no_delete       : 'U moet ten minste 1 categorie specificeren om te verwijderen.'
+  invalid_category: 'De opgegeven categorie is ongeldig.'
 
 buttons:
   new   : 'Categorie aanmaken'

data/lib/zen/package/categories/lib/categories/language/nl/category_groups.yml

@@ -22,10 +22,11 @@ success:
   delete: 'De categorie groep is verwijderd.'
 
 errors:
-  new      : 'De categorie groep kon niet worden aangemaakt.'
-  save     : 'De categorie groep kon niet worden aangepast.'
-  delete   : 'De categorie groep met ID #%s kon niet worden verwijderd.'
-  no_delete: 'U moet ten minste 1 groep specificeren om te verwijderen.'
+  new          : 'De categorie groep kon niet worden aangemaakt.'
+  save         : 'De categorie groep kon niet worden aangepast.'
+  delete       : 'De categorie groep met ID #%s kon niet worden verwijderd.'
+  no_delete    : 'U moet ten minste 1 groep specificeren om te verwijderen.'
+  invalid_group: 'De opgegeven categorie groep is ongeldig.'
 
 buttons:
   new   : 'Groep aanmaken'

data/lib/zen/package/categories/lib/categories/model/category.rb

@@ -3,7 +3,8 @@ module Categories
   #:nodoc:
   module Model
     ##
-    # Model that represents a single category. This model has the following relations:
+    # Model that represents a single category. This model has the following 
+    # relations:
     #
     # * category groups (one to one)
     # * self (many to one)
@@ -12,17 +13,18 @@ module Categories
     #
     # * sluggable (source: "name")
     #
-    # When creating or saving a category the fields "name" and "slug" are required.
-    # The latter is only needed when saving an existing category as a slug will be
-    # generated whenever the field is empty. It's also important to remember
-    # that slugs have to be unique. For more info see the validate() method.
+    # When creating or saving a category the fields "name" and "slug" are 
+    # required. The latter is only needed when saving an existing category as a 
+    # slug will be generated whenever the field is empty. It's also important to 
+    # remember that slugs have to be unique. For more info see the validate() 
+    # method.
     #
     # @author Yorick Peterse
     # @since  0.1
     #
     class Category < Sequel::Model
-      many_to_one :category_group , :class => "Categories::Model::CategoryGroup"
-      many_to_one :parent         , :class => self
+      many_to_one :category_group, :class => "Categories::Model::CategoryGroup"
+      many_to_one :parent        , :class => self
       
       plugin :sluggable, :source => :name, :frozen => false
       
@@ -33,10 +35,10 @@ module Categories
       # @since  0.1
       #
       def validate
-        validates_presence    :name
-        validates_max_length  255, [:name, :slug]
-        validates_unique      :slug
+        validates_presence   :name
+        validates_max_length 255, [:name, :slug]
+        validates_unique     :slug
       end
-    end
-  end
-end
+    end # Category
+  end # Model
+end # Categories

data/lib/zen/package/categories/lib/categories/model/category_group.rb

@@ -26,6 +26,6 @@ module Categories
         validates_presence        :name
         validates_max_length 255, :name
       end
-    end
-  end
-end
+    end # CategoryGroup
+  end # Model
+end # Categories

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

@@ -13,7 +13,7 @@ module Categories
     #       puts category[:name]
     #     end
     #
-    # For more information about the available options see 
+    # For more information about the available options see
     # Zen::Plugin::Categories#initialize().
     #
     # @author Yorick Peterse
@@ -24,19 +24,23 @@ module Categories
       include ::Zen::Plugin::Helper
 
       ##
-      # Creates a new instance of the plugin and stores the configuration options.
+      # Creates a new instance of the plugin and stores the configuration
+      # options.
       #
       # @author Yorick Peterse
       # @since  0.2.5
-      # @param  [Hash] options Hash containing a set of options used to determine how the
-      # categories should be retrieved and which one should be retrieved.
-      # @option options [Integer] :limit The maximum amount of categories to retrieve.
-      # @option options [Integer] :offset The row offset, useful for pagination systems.
-      # @option options [String/Integer] :group The name or ID of the category group for 
-      # which to retrieve all categories.
-      # @option options [String/Integer] :category The slug or ID of the category to 
-      # retrieve. Setting this option will cause the plugin to ignore the offset and 
-      # limit options.
+      # @param  [Hash] options Hash containing a set of options used to
+      # determine how the categories should be retrieved and which one should
+      # be retrieved.
+      # @option options [Integer] :limit The maximum amount of categories to
+      # retrieve.
+      # @option options [Integer] :offset The row offset, useful for pagination
+      # systems.
+      # @option options [String/Integer] :group The name or ID of the category
+      # group for which to retrieve all categories.
+      # @option options [String/Integer] :category The slug or ID of the
+      # category to retrieve. Setting this option will cause the plugin to
+      # ignore the offset and limit options.
       #
       def initialize(options = {})
         @options = {
@@ -48,11 +52,17 @@ module Categories
 
         # Validate the specified options
         if @options[:group].nil? and @options[:category].nil?
-          raise(ArgumentError, "You need to specify either a category or category group.")
+          raise(
+            ArgumentError,
+            "You need to specify either a category or category group."
+          )
         end
 
         if !@options[:group].nil? and !@options[:category].nil?
-          raise(ArgumentError, "You can't specify both a category and a category group.")
+          raise(
+            ArgumentError,
+            "You can't specify both a category and a category group."
+          )
         end
 
         group_class = @options[:group].class
@@ -85,28 +95,30 @@ module Categories
         # Retrieve the categories for a given group]]
         if !@options[:group].nil?
           # Get the group for an ID or a name
-          if @options[:group].class == Integer or @options[:group].class == Fixnum
+          if @options[:group].class == Integer \
+          or @options[:group].class == Fixnum
             category_group = CategoryGroup[@options[:group]]
           else
             category_group = CategoryGroup[:name => @options[:group]]
           end
 
-          # Since we require a group in this case we'll raise an error if the group 
-          # doesn't exist. If we were to return an empty value this may confuse the 
-          # developer.
+          # Since we require a group in this case we'll raise an error if the
+          # group doesn't exist. If we were to return an empty value this may
+          # confuse the developer.
           if category_group.nil?
             raise("No category group could be found for \"#{@options[:group]}\"")
           end
 
-          # Get all the categories according to our specified configuration options
-          # and the category group that was retrieved earlier on.
+          # Get all the categories according to our specified configuration
+          # options and the category group that was retrieved earlier on.
           categories = Category.filter(:category_group_id => category_group.id) \
             .limit(@options[:limit], @options[:offset]) \
             .all
-          
+
         # Retrieve the category for the specified ID or slug
         else
-          if @options[:category].class == Integer or @options[:category].class == Fixnum
+          if @options[:category].class == Integer \
+          or @options[:category].class == Fixnum
             categories = Category[@options[:category]]
           else
             categories = Category[:slug => @options[:category]]
@@ -124,7 +136,6 @@ module Categories
 
         return categories
       end
-
-    end
-  end
-end
+    end # Categories
+  end # Plugin
+end # Categories