zen 0.2.4.1 → 0.2.5

data/lib/zen/package/base.rb

@@ -0,0 +1,62 @@
+#:nodoc:
+module Zen
+  #:nodoc:
+  module Package
+    ##
+    # Base class used to store the data about packages such as the name, directory, etc.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    class Base
+      include ::Zen::Validation
+
+      # The name of the package
+      attr_accessor :name
+
+      # The author of the package
+      attr_accessor :author
+
+      # A small description about the package
+      attr_accessor :about
+
+      # The URL to the website of the package
+      attr_accessor :url
+
+      # The root directory of the package
+      attr_accessor :directory
+
+      # Array containing the navigation items for the package
+      attr_accessor :menu
+
+      # Path to the directory containing all migrations
+      attr_accessor :migration_dir
+
+      # Array containing all controllers for the package. These classes will be used
+      # by the ACL system.
+      attr_accessor :controllers
+
+      ##
+      # Validates all the attributes.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      #
+      def validate
+        validates_presence([:name, :author, :about, :directory, :controllers])
+        validates_format(:name, /[a-z0-9_\-]+/)
+        validates_filepath(:directory)
+
+        if !migration_dir.nil?
+          validates_filepath(:migration_dir)
+        end
+
+        # Check if the package hasn't been registered yet
+        if ::Zen::Package::Registered.key?(name.to_sym)
+          raise(::Zen::ValidationError, "The package #{name} already exists.")
+        end
+      end
+
+    end
+  end
+end

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

@@ -1,23 +1,42 @@
+require __DIR__('categories/model/category_group')
+require __DIR__('categories/model/category')
+require __DIR__('categories/controller/category_groups')
+require __DIR__('categories/controller/categories')
+require __DIR__('categories/plugin/categories')
 
-# Load all the classes such as controllers, models and so on.
-require __DIR__ 'categories/model/category_group'
-require __DIR__ 'categories/model/category'
-
-require __DIR__ 'categories/controller/category_groups'
-require __DIR__ 'categories/controller/categories'
+# Load the language pack manually so it can be used in the block below
+Zen::Language.options.paths.push(__DIR__('categories'))
+Zen::Language.load('categories')
+Zen::Language.load('category_groups')
 
 # Describe what this package is all about
 Zen::Package.add do |p|
-  p.name          = 'Categories'
+  p.name          = 'categories'
   p.author        = 'Yorick Peterse'
   p.url           = 'http://yorickpeterse.com/'
-  p.about         = "Module for managing categories. Categories can be used to organize section entries."
-  p.identifier    = 'com.zen.categories'
+  p.about         = "Module for managing categories. Categories can be used to organize 
+section entries."
+
   p.directory     = __DIR__('categories')
   p.migration_dir = __DIR__('../migrations')
   
   p.menu = [{
-    :title => "Categories",
+    :title => lang('categories.titles.index'),
     :url   => "admin/category-groups"
   }]
+
+  # Register all controllers
+  p.controllers = {
+    lang('categories.titles.index')      => Categories::Controller::Categories,
+    lang('category_groups.titles.index') => Categories::Controller::CategoryGroups
+  }
+end
+
+# Register our plugins
+Zen::Plugin.add do |p|
+  p.name   = 'categories'
+  p.author = 'Yorick Peterse'
+  p.url    = 'http://yorickpeterse.com/'
+  p.about  = 'Plugin that makes it easier to retrieve categories and category groups.'
+  p.plugin = Categories::Plugin::Categories
 end

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module Categories 
   #:nodoc:
-  module Controllers
+  module Controller
     ##
     # Categories can be seen as "tags" for your section entries. They describe the
     # type of entry just like tags except that categories generally cover larger elements.
@@ -11,11 +11,10 @@ module Categories
     # @author Yorick Peterse
     # @since  0.1
     #
-    class Categories < Zen::Controllers::AdminController
-      include ::Categories::Models
+    class Categories < Zen::Controller::AdminController
+      include ::Categories::Model
       
-      map '/admin/categories'
-      trait :extension_identifier => 'com.zen.categories'
+      map('/admin/categories')
       
       before_all do
         csrf_protection(:save, :delete) do

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

@@ -1,5 +1,5 @@
 module Categories
-  module Controllers
+  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
@@ -9,11 +9,10 @@ module Categories
     # @author Yorick Peterse
     # @since  0.1
     #
-    class CategoryGroups < Zen::Controllers::AdminController
-      include ::Categories::Models
+    class CategoryGroups < Zen::Controller::AdminController
+      include ::Categories::Model
 
-      map '/admin/category-groups'
-      trait :extension_identifier => 'com.zen.categories'
+      map('/admin/category-groups')
       
       before_all do
         csrf_protection(:save, :delete) do

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

@@ -22,9 +22,10 @@ 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.'
+  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.'
 
 buttons:
   new    : 'Add group'

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module Categories
   #:nodoc:
-  module Models
+  module Model
     ##
     # Model that represents a single category. This model has the following relations:
     #
@@ -21,7 +21,7 @@ module Categories
     # @since  0.1
     #
     class Category < Sequel::Model
-      many_to_one :category_group , :class => "Categories::Models::CategoryGroup"
+      many_to_one :category_group , :class => "Categories::Model::CategoryGroup"
       many_to_one :parent         , :class => self
       
       plugin :sluggable, :source => :name, :frozen => false

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module Categories
   #:nodoc:
-  module Models
+  module Model
     ##
     # Model that represents a single category group. Each category group
     # has the following relations to other models:
@@ -13,8 +13,8 @@ module Categories
     # and should be no longer than 255 characters.
     #
     class CategoryGroup < Sequel::Model
-      one_to_many  :categories, :class => "Categories::Models::Category"
-      many_to_many :sections  , :class => "Sections::Models::Section"
+      one_to_many  :categories, :class => "Categories::Model::Category"
+      many_to_many :sections  , :class => "Sections::Model::Section"
       
       ##
       # Validation rules for our model.

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

@@ -0,0 +1,130 @@
+#:nodoc
+module Categories
+  #:nodoc
+  module Plugin
+    ##
+    # The Categories plugin can be used to display a list of categories
+    #
+    # ## Usage
+    #
+    # A basic example of how to use this plugin looks like the following:
+    #
+    #     plugin(:categories, :group => 'blog').each do |category|
+    #       puts category[:name]
+    #     end
+    #
+    # For more information about the available options see 
+    # Zen::Plugin::Categories#initialize().
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    class Categories
+      include ::Categories::Model
+      include ::Zen::Plugin::Helper
+
+      ##
+      # 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.
+      #
+      def initialize(options = {})
+        @options = {
+          :limit    => 20,
+          :offset   => 0,
+          :group    => nil,
+          :category => nil
+        }.merge(options)
+
+        # Validate the specified options
+        if @options[:group].nil? and @options[:category].nil?
+          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.")
+        end
+
+        group_class = @options[:group].class
+        cat_class   = @options[:category].class
+        allowed     = [Integer, String, Fixnum]
+
+        # Validate the types
+        if !@options[:group].nil?
+          validate_type(@options[:group], :group, allowed)
+        end
+
+        if !@options[:category].nil?
+          validate_type(@options[:category], :category, allowed)
+        end
+
+        validate_type(@options[:limit] , :limit , [Fixnum, Integer])
+        validate_type(@options[:offset], :offset, [Fixnum, Integer])
+      end
+
+      ##
+      # Retrieves all categories based on the given configuration options.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @return [Array] A list of all categories.
+      #
+      def call
+        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
+            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.
+          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.
+          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
+            categories = Category[@options[:category]]
+          else
+            categories = Category[:slug => @options[:category]]
+          end
+        end
+
+        # Convert all categories to a hash
+        if categories.class == Array
+          categories.each_with_index do |cat, index|
+            categories[index] = cat.values
+          end
+        else
+          categories = categories.values
+        end
+
+        return categories
+      end
+
+    end
+  end
+end

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

@@ -24,7 +24,7 @@ form_for(
     
     # Generate the dropdown that contains all possible parent categories
     parent_categories = {}
-    Categories::Models::CategoryGroup[@category_group_id].categories.each do |c|
+    Categories::Model::CategoryGroup[@category_group_id].categories.each do |c|
       if c.id != @category.id
         parent_categories[c.id] = c.name
       end

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

@@ -39,7 +39,7 @@
                     <td>
                         #{anchor_to(
                           category.name, 
-                          Categories::Controllers::Categories.r(:edit, @category_group_id, category.id)
+                          Categories::Controller::Categories.r(:edit, @category_group_id, category.id)
                         )}
                     </td>
                     <?r else ?>
@@ -62,7 +62,7 @@
             <div class="button">
                 #{anchor_to(
                   lang('categories.buttons.new'), 
-                  Categories::Controllers::Categories.r(:new, @category_group_id)
+                  Categories::Controller::Categories.r(:new, @category_group_id)
                 )}
             </div>
             <?r end ?>

data/lib/zen/package/categories/lib/categories/view/admin/category-groups/index.xhtml

@@ -20,7 +20,9 @@
                     <th>#{lang('category_groups.labels.id')}</th>
                     <th>#{lang('category_groups.labels.name')}</th>
                     
-                    <?r if user_authorized?([:create]) ?>
+                    <?r if user_authorized?(
+                      [:read], true, 'Categories::Controller::Categories'
+                    ) ?>
                     <th></th>
                     <?r end ?>
                 </tr>
@@ -30,7 +32,8 @@
                 <tr>
                     <?r if user_authorized?([:delete]) ?>
                     <td>
-                        <input type="checkbox" name="category_group_ids[]" value="#{group.id}" />
+                        <input type="checkbox" name="category_group_ids[]" 
+                        value="#{group.id}" />
                     </td>
                     <?r end ?>
                     
@@ -40,18 +43,20 @@
                     <td>
                         #{anchor_to(
                           group.name, 
-                          Categories::Controllers::CategoryGroups.r(:edit, group.id)
+                          Categories::Controller::CategoryGroups.r(:edit, group.id)
                         )}
                     </td>
                     <?r else ?>
                     <td>#{group.name}</td>
                     <?r end ?>
                     
-                    <?r if user_authorized?([:create]) ?>
+                    <?r if user_authorized?(
+                      [:read], true, 'Categories::Controller::Categories'
+                    ) ?>
                     <td>
                         #{anchor_to(
                           lang('category_groups.labels.manage'), 
-                          Categories::Controllers::Categories.r(:index, group.id)
+                          Categories::Controller::Categories.r(:index, group.id)
                         )}
                     </td>
                     <?r end ?>
@@ -70,7 +75,7 @@
             <div class="button">
                 #{anchor_to(
                   lang('category_groups.buttons.new'), 
-                  Categories::Controllers::CategoryGroups.r(:new)
+                  Categories::Controller::CategoryGroups.r(:new)
                 )}
             </div>
             <?r end ?>

data/lib/zen/package/comments/lib/comments.rb

@@ -1,25 +1,35 @@
+require __DIR__('comments/model/comment.rb')
+require __DIR__('comments/controller/comments')
+require __DIR__('comments/controller/comments_form')
+require __DIR__('comments/plugin/comments')
 
-# Load all our classes
-require __DIR__ 'comments/model/comment.rb'
-require __DIR__ 'comments/controller/comments'
-require __DIR__ 'comments/controller/comments_form'
-require __DIR__ 'comments/liquid/comments'
-require __DIR__ 'comments/liquid/comment_form'
-
-Liquid::Template.register_tag('comments'    , Comments::Liquid::Comments)
-Liquid::Template.register_tag('comment_form', Comments::Liquid::CommentForm)
+Zen::Language.options.paths.push(__DIR__('comments'))
+Zen::Language.load('comments')
 
 Zen::Package.add do |p|
-  p.name          = 'Comments'
+  p.name          = 'comments'
   p.author        = 'Yorick Peterse'
   p.url           = 'http://yorickpeterse.com/'
-  p.about         = "Allow users to post comments on any given section entry (as long as the section allows it)."
-  p.identifier    = 'com.zen.comments'
+  p.about         = "Allow users to post comments on any given section entry (as long as 
+the section allows it)."
+
   p.directory     = __DIR__('comments')
   p.migration_dir = __DIR__('../migrations')
   
   p.menu = [{
-    :title => "Comments",
+    :title => lang('comments.titles.index'),
     :url   => "admin/comments"
   }]
+
+  p.controllers = {
+    lang('comments.titles.index') => Comments::Controller::Comments
+  }
+end
+
+Zen::Plugin.add do |p|
+  p.name    = 'comments'
+  p.author  = 'Yorick Peterse'
+  p.url     = 'http://yorickpeterse.com/'
+  p.about   = 'Plugin that can be used to retrieve comments.'
+  p.plugin  = Comments::Plugin::Comments
 end