zen 0.1a → 0.2

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

@@ -0,0 +1,216 @@
+module Categories
+  module Controllers
+    ##
+    # 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
+    #
+    class CategoryGroups < Zen::Controllers::AdminController
+      include ::Categories::Models
+
+      map '/admin/category-groups'
+      trait :extension_identifier => 'com.zen.categories'
+      
+      before_all do
+        csrf_protection(:save, :delete) do
+          respond(lang('zen_general.errors.csrf'), 403)
+        end
+      end
+      
+      ##
+      # 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:
+      #
+      # * category_groups
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def initialize
+        super
+        
+        @form_save_url   = CategoryGroups.r(:save)
+        @form_delete_url = CategoryGroups.r(:delete)
+        
+        Zen::Language.load('category_groups')
+        
+        # Set the page title
+        if !action.method.nil?
+          method      = action.method.to_s
+          @page_title = lang("category_groups.titles.#{method}") rescue nil
+        end
+      end
+      
+      ##
+      # Show an overview of all existing category groups and allow the user
+      # to create new category groups or manage individual categories.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def index
+        if !user_authorized?([:read])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        set_breadcrumbs(lang('category_groups.titles.index'))
+        
+        @category_groups = CategoryGroup.all
+      end
+      
+      ##
+      # Edit an existing category group based on the ID specified in the URL.
+      # This method requires the following permissions:
+      #
+      # * read
+      # * update
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def edit id
+        if !user_authorized?([:read, :update])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        set_breadcrumbs(
+          anchor_to(lang('category_groups.titles.index'), CategoryGroups.r(:index)),
+          lang('category_groups.titles.edit')
+        )
+        
+        if flash[:form_data]
+          @category_group = flash[:form_data]
+        else
+          @category_group = CategoryGroup[id]
+        end
+      end
+      
+      ##
+      # Create a new category group. This method requires the following permissions:
+      #
+      # * create
+      # * read
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def new
+        if !user_authorized?([:create, :read])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        set_breadcrumbs(
+          anchor_to(lang('category_groups.titles.index'), CategoryGroups.r(:index)),
+          lang('category_groups.titles.new')
+        )
+        
+        @category_group = CategoryGroup.new
+      end
+
+      ##
+      # Save or create a new category group based on the current POST data.
+      # This method requires the following permissions:
+      #
+      # * create
+      # * update
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #    
+      def save
+        if !user_authorized?([:create, :update])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+        
+        post = request.params.dup
+        
+        if post['id'] and !post['id'].empty?
+          @category_group = CategoryGroup[post['id'].to_i]
+          save_action     = :save
+        else
+          @category_group = CategoryGroup.new
+          save_action     = :new
+        end
+        
+        flash_success = lang("category_groups.success.#{save_action}")
+        flash_error   = lang("category_groups.errors.#{save_action}")
+        
+        begin
+          @category_group.update(post)
+          notification(:success, lang('category_groups.titles.index'), flash_success)
+        rescue
+          notification(:error, lang('category_groups.titles.index'), flash_error)
+
+          flash[:form_data]   = @category_group
+          flash[:form_errors] = @category_group.errors
+        end
+        
+        if !@category_group.nil? and @category_group.id
+          redirect(CategoryGroups.r(:edit, @category_group.id))
+        else  
+          redirect(CategoryGroups.r(:new))
+        end
+      end
+      
+      ##
+      # 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.
+      #
+      # This method requires the following permissions:
+      #
+      # * delete
+      #
+      # @author Yorick Peterse
+      # @since  0.1
+      #
+      def delete
+        if !user_authorized?([:delete])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+
+        post = request.params.dup
+        
+        if !post['category_group_ids'] or post['category_group_ids'].empty?
+          notification(
+            :error, 
+            lang('category_groups.titles.index'), 
+            lang('category_groups.errors.no_delete')
+          )
+
+          redirect(CategoryGroups.r(:index))
+        end
+        
+        post['category_group_ids'].each do |id|
+          begin
+            CategoryGroup[id.to_i].destroy
+            notification(
+              :success, 
+              lang('category_groups.titles.index'), 
+              lang('category_groups.success.delete')
+            )
+          rescue
+            notification(
+              :error, 
+              lang('category_groups.titles.index'), 
+              lang('category_groups.errors.delete') % id
+            )
+          end
+        end
+        
+        redirect(CategoryGroups.r(:index))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+---
+titles:
+  index : 'Categories'
+  edit  : 'Edit Category'
+  new   : 'Add Category'
+
+labels:
+  id          : '#'
+  name        : 'Name'
+  description : 'Description'
+  parent      : 'Parent'
+  slug        : 'Slug'
+
+placeholders:
+  name : 'The name of the category'
+  slug : 'A URL friendly name of the category'
+
+messages:
+  no_categories : 'No categories have been created yet.'
+
+success:
+  new    : 'The category has been created.'
+  save   : 'The category has been modified.'
+  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."
+
+buttons:
+  new    : 'Add Category'
+  save   : 'Save Category'
+  delete : 'Delete selected categories'

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

@@ -0,0 +1,32 @@
+---
+titles:
+  index : 'Category Groups'
+  edit  : 'Edit Category Group'
+  new   : 'Add Category Group'
+
+labels:
+  id          : '#'
+  name        : 'Name'
+  description : 'Description'
+  manage      : 'Manage Categories'
+
+placeholders:
+  name : 'The name of the category group'
+
+messages:
+  no_groups : 'No category groups have been created yet.'
+
+success:
+  new    : 'The category group has been created.'
+  save   : 'The category group has been modified.'
+  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.'
+
+buttons:
+  new    : 'Add group'
+  save   : 'Save group'
+  delete : 'Delete selected groups'

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

@@ -0,0 +1,16 @@
+#:nodoc:
+module Categories
+  #:nodoc:
+  module Liquid
+    ##
+    #
+    #
+    # @author Yorick Peterse
+    # @since  0.2
+    # @todo   Create this tag you lazy bum!
+    #
+    class Categories < ::Liquid::Block
+
+    end
+  end
+end

data/lib/zen/{packages → package}/categories/lib/categories/model/category.rb

@@ -1,8 +1,9 @@
+#:nodoc:
 module Categories
+  #:nodoc:
   module Models
     ##
-    # 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)
@@ -20,10 +21,10 @@ module Categories
     # @since  0.1
     #
     class Category < Sequel::Model
-      one_to_one :category_groups
-      many_to_one :parent, :class => self
+      many_to_one :category_group , :class => "Categories::Models::CategoryGroup"
+      many_to_one :parent         , :class => self
       
-      plugin :sluggable, :source => :name, :freeze => false
+      plugin :sluggable, :source => :name, :frozen => false
       
       ##
       # Validation rules for our model.
@@ -32,10 +33,9 @@ module Categories
       # @since  0.1
       #
       def validate
-        validates_presence        [:name]
-        validates_presence        [:slug] unless new?
-        validates_max_length 255, [:name, :slug]
-        validates_unique          [:slug]
+        validates_presence    :name
+        validates_max_length  255, [:name, :slug]
+        validates_unique      :slug
       end
     end
   end

data/lib/zen/{packages → package}/categories/lib/categories/model/category_group.rb

@@ -1,4 +1,6 @@
+#:nodoc:
 module Categories
+  #:nodoc:
   module Models
     ##
     # Model that represents a single category group. Each category group
@@ -11,8 +13,8 @@ module Categories
     # and should be no longer than 255 characters.
     #
     class CategoryGroup < Sequel::Model
-      one_to_many :categories
-      many_to_many :sections
+      one_to_many  :categories, :class => "Categories::Models::Category"
+      many_to_many :sections  , :class => "Sections::Models::Section"
       
       ##
       # Validation rules for our model.
@@ -21,8 +23,8 @@ module Categories
       # @since  0.1
       #
       def validate
-        validates_presence        [:name]
-        validates_max_length 255, [:name]
+        validates_presence        :name
+        validates_max_length 255, :name
       end
     end
   end

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

@@ -0,0 +1,7 @@
+<article>
+    <header>
+        <h1>#{get_breadcrumbs}</h1>
+    </header>
+    
+    #{render_partial :form}
+</article>

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

@@ -0,0 +1,59 @@
+#{
+form_for(
+  @category, :method => :post, :action => @form_save_url, :id => :category_form
+) do |f|
+
+  f.input_hidden(:category_group_id, @category_group_id)
+  f.input_hidden(:id               , @category.id)
+  f.input_hidden(:csrf_token       , get_csrf_token)
+  
+  f.g.div(:id => 'general') do
+    f.input_text(
+      lang('categories.labels.name'), 
+      :name, 
+      :placeholder => lang('categories.placeholders.name'), 
+      :required    => :required, 
+      :maxlength   => 255
+    )
+
+    f.input_text(
+      lang('categories.labels.slug'),
+      :slug, 
+      :placeholder => lang('categories.placeholders.slug')
+    )
+    
+    # Generate the dropdown that contains all possible parent categories
+    parent_categories = {}
+    Categories::Models::CategoryGroup[@category_group_id].categories.each do |c|
+      if c.id != @category.id
+        parent_categories[c.id] = c.name
+      end
+    end
+
+    parent_categories[nil] = '--'
+    
+    if !parent_categories.empty?
+      f.select(
+        lang('categories.labels.parent'), 
+        :parent_id, 
+        :values   => parent_categories, 
+        :size     => 1, 
+        :selected => @category.parent_id
+      )
+    end
+    
+    f.textarea(
+      lang('categories.labels.description'), 
+      :description, 
+      :rows => 8
+    )
+  end
+  
+  f.g.div(:class => "clearfix") do
+    f.g.div(:class => "button") do
+      f.g.input(:type => 'submit', :value => lang('categories.buttons.save'))
+    end
+  end
+
+end
+}

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

@@ -0,0 +1,78 @@
+<article>
+    <header>
+        <h1>#{get_breadcrumbs}</h1>
+    </header>
+    
+    <form method="post" action="#{@form_delete_url}">
+        <input type="hidden" name="csrf_token" value="#{get_csrf_token}" />
+        <input type="hidden" name="category_group_id" value="#{@category_group_id}" />
+        
+        <?r if @categories and !@categories.empty? ?>
+        
+        <table class="table">
+            <thead>
+                <tr>
+                    <?r if user_authorized?([:delete]) ?>
+                    <th>
+                        <input type="checkbox" />
+                    </th>
+                    <?r end ?>
+                    
+                    <th>#{lang('categories.labels.id')}</th>
+                    <th>#{lang('categories.labels.name')}</th>
+                    <th>#{lang('categories.labels.slug')}</th>
+                    <th>#{lang('categories.labels.parent')}</th>
+                </tr>
+            </thead>
+            <tbody>
+                <?r @categories.each do |category| ?>
+                <tr>
+                    <?r if user_authorized?([:delete]) ?>
+                    <td>
+                        <input type="checkbox" name="category_ids[]" value="#{category.id}" />
+                    </td>
+                    <?r end ?>
+                    
+                    <td>#{category.id}</td>
+                    
+                    <?r if user_authorized?([:update]) ?>
+                    <td>
+                        #{anchor_to(
+                          category.name, 
+                          Categories::Controllers::Categories.r(:edit, @category_group_id, category.id)
+                        )}
+                    </td>
+                    <?r else ?>
+                    <td>#{category.name}</td>
+                    <?r end ?>
+                    
+                    <td>#{category.slug}</td>
+                    <td>#{category.parent.name if category.parent.respond_to?(:name)}</td>
+                </tr>
+                <?r end ?>
+            </tbody>
+        </table>
+        
+        <?r else ?>
+        <p>#{lang('categories.messages.no_categories')}</p>
+        <?r end ?>
+        
+        <div class="clearfix">
+            <?r if user_authorized?([:create]) ?>
+            <div class="button">
+                #{anchor_to(
+                  lang('categories.buttons.new'), 
+                  Categories::Controllers::Categories.r(:new, @category_group_id)
+                )}
+            </div>
+            <?r end ?>
+            
+            <?r if user_authorized?([:delete]) and @categories and !@categories.empty? ?>
+            <div class="button">
+                <input type="submit" value="#{lang('categories.buttons.delete')}" />
+            </div>
+            <?r end ?>
+            
+        </div>
+    </form>
+</article>