zen 0.3 → 0.4

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

@@ -4,16 +4,62 @@ module Categories
     ##
     # Model for managing and retrieving categories.
     #
-    # @since  0.1
+    # ## Events
+    #
+    # All available events will receive an instance of
+    # {Categories::Model::Category}. Do note that the event
+    # ``after_delete_category`` will receive an instance of this model *after*
+    # ``#destroy()`` has been invoked on the instance. This means that you can
+    # not save any changes made to the object as the database no longer
+    # exists.
+    #
+    # Say you want to notify a user whenever a category is removed you could do
+    # the following:
+    #
+    #     # "mail" can be installed by running gem install mail.
+    #     require 'mail'
+    #
+    #     Zen::Event.listen(:delete_category) do |category|
+    #       user = Users::Model::User[:name => 'admin']
+    #       Mail.deliver do
+    #         from    'example@domain.com'
+    #         to      user.email
+    #         subject "Category \"#{category.name}\" has been removed"
+    #           "has been removed from the database."
+    #       end
+    #     end
+    #
+    # @since 0.1
+    # @event before_new_category
+    # @event after_new_category
+    # @event before_edit_category
+    # @event after_edit_category
+    # @event before_delete_category
+    # @event after_delete_category
     #
     class Category < Sequel::Model
       include Zen::Model::Helper
 
+      ##
+      # Array containing the column names that can be set by the user.
+      #
+      # @since 17-02-2012
+      #
+      COLUMNS = [:parent_id, :name, :description, :slug, :category_group_id]
+
       many_to_one :category_group, :class => 'Categories::Model::CategoryGroup'
       many_to_one :parent        , :class => self
 
       plugin :sluggable, :source => :name, :frozen => false
 
+      plugin :events,
+        :before_create  => :before_new_category,
+        :after_create   => :after_new_category,
+        :before_update  => :before_edit_category,
+        :after_update   => :after_edit_category,
+        :before_destroy => :before_delete_category,
+        :after_destroy  => :after_delete_category
+
       ##
       # Searches for a set of category groups using the specified search query.
       #
@@ -35,6 +81,17 @@ module Categories
         validates_max_length(255, [:name, :slug])
         validates_unique(:slug)
       end
+
+      ##
+      # Hook that is executed before creating or saving an object.
+      #
+      # @since 03-01-2012
+      #
+      def before_save
+        sanitize_fields([:name, :slug, :description])
+
+        super
+      end
     end # Category
   end # Model
 end # Categories

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

@@ -4,13 +4,62 @@ module Categories
     ##
     # Model that represents a single category group.
     #
-    # @since  0.1
+    # ## Events
+    #
+    # All available events receive an instance of
+    # {Categories::Model::CategoryGroup}. However, the
+    # ``after_delete_category_group`` event will receive an instance that has
+    # already been removed from the database. This means that you can not make
+    # changes to the object and call ``#save()``.
+    #
+    # Example of logging when a new category group is created:
+    #
+    #     Zen::Event.listen(:after_new_category_group) do |group|
+    #       Ramaze::Log.info("New category: \"#{group.name}\"")
+    #     end
+    #
+    # Maybe you want to automatically add a category group to a section:
+    #
+    #     Zen::Event.listen(:after_new_category_group) do |group|
+    #       section = Sections::Model::Section[5]
+    #
+    #       begin
+    #         section.add_category_group(group)
+    #       rescue => e
+    #         Ramaze::Log.error(e)
+    #       end
+    #     end
+    #
+    # @since 0.1
+    # @event before_new_category_group
+    # @event after_new_category_group
+    # @event before_edit_category_group
+    # @event after_edit_category_group
+    # @event before_delete_category_group
+    # @event after_delete_category_group
     #
     class CategoryGroup < Sequel::Model
       include Zen::Model::Helper
 
+      ##
+      # Array containing the column names that can be set by the user.
+      #
+      # @since 17-02-2012
+      #
+      COLUMNS = [:name, :description]
+
       one_to_many  :categories, :class => 'Categories::Model::Category'
-      many_to_many :sections  , :class => 'Sections::Model::Section'
+      many_to_many :sections,   :class => 'Sections::Model::Section'
+
+      plugin :association_dependencies, :categories => :delete
+
+      plugin :events,
+        :before_create  => :before_new_category_group,
+        :after_create   => :after_new_category_group,
+        :before_update  => :before_edit_category_group,
+        :after_update   => :after_edit_category_group,
+        :before_destroy => :before_delete_category_group,
+        :after_destroy  => :after_delete_category_group
 
       ##
       # Searches for a set of category groups using the specified search query.
@@ -32,6 +81,17 @@ module Categories
         validates_presence(:name)
         validates_max_length(255, :name)
       end
+
+      ##
+      # Hook that is run before creating or saving an object.
+      #
+      # @since 03-01-2012
+      #
+      def before_save
+        sanitize_fields([:name, :description])
+
+        super
+      end
     end # CategoryGroup
   end # Model
 end # Categories

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

@@ -3,49 +3,55 @@
         <h1>#{get_breadcrumbs}</h1>
     </header>
 
-    #{form_for(
-      @category,
-      :method => :post,
-      :action => Categories::Controller::Categories.r(:save),
-      :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)
+    <div class="body">
+        #{form_for(
+          @category,
+          :method              => :post,
+          :action              => Categories::Controller::Categories.r(:save),
+          :id                  => :category_form,
+          :'data-autosave-url' => Categories::Controller::Categories \
+            .r(:autosave)
+        ) 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,
-          :title => lang('categories.descriptions.name'),
-          :required    => :required,
-          :maxlength   => 255
-        )
+          f.g.div(:id => 'general') do
+            f.input_text(
+              lang('categories.labels.name'),
+              :name,
+              :title => lang('categories.descriptions.name'),
+              :required    => :required,
+              :maxlength   => 255
+            )
 
-        f.input_text(
-          lang('categories.labels.slug'),
-          :slug,
-          :title => lang('categories.descriptions.slug'),
-          :maxlength   => 255
-        )
+            f.input_text(
+              lang('categories.labels.slug'),
+              :slug,
+              :title => lang('categories.descriptions.slug'),
+              :maxlength   => 255
+            )
 
-        f.select(
-          lang('categories.labels.parent'),
-          :parent_id,
-          :values   => parent_categories(@category.id, @category_group_id),
-          :size     => 1,
-          :selected => @category.parent_id
-        )
+            f.select(
+              lang('categories.labels.parent'),
+              :parent_id,
+              :values   => parent_categories(@category.id, @category_group_id),
+              :size     => 1,
+              :selected => @category.parent_id
+            )
 
-        f.textarea(
-          lang('categories.labels.description'),
-          :description,
-          :rows => 8
-        )
-      end
+            f.textarea(
+              lang('categories.labels.description'),
+              :description,
+              :rows => 8
+            )
+          end
 
-      f.g.div(:class => 'button') do
-        f.g.input(:type => 'submit', :value => lang('categories.buttons.save'))
-      end
-    end}
+          f.g.input(
+            :type  => 'submit',
+            :value => lang('categories.buttons.save'),
+            :class => 'button'
+          )
+        end}
+    </div>
 </section>

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

@@ -1,91 +1,90 @@
 <section>
-    #{render_search_form(
-      ::Categories::Controller::Categories.r(:index, @category_group_id)
-    )}
-
-    <header>
+    <header class="with_search">
         <h1>#{get_breadcrumbs}</h1>
+
+        #{render_search_form(
+          ::Categories::Controller::Categories.r(:index, @category_group_id)
+        )}
     </header>
 
-    <form method="post"
-    action="#{Categories::Controller::Categories.r(:delete)}">
-        <input type="hidden" name="csrf_token" value="#{get_csrf_token}" />
+    <div class="body">
+        <form method="post"
+        action="#{Categories::Controller::Categories.r(:delete)}">
+            <input type="hidden" name="csrf_token" value="#{get_csrf_token}" />
 
-        <?r if !@categories.empty? ?>
+            <?r if !@categories.empty? ?>
 
-        <table>
-            <thead>
-                <tr>
-                    <?r if user_authorized?(:delete_category) ?>
-                    <th class="no_sort">
-                        <input type="checkbox" />
-                    </th>
-                    <?r end ?>
+            <table>
+                <thead>
+                    <tr>
+                        <?r if user_authorized?(:delete_category) ?>
+                        <th class="no_sort">
+                            <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_category_group) ?>
-                    <td>
-                        <input type="checkbox" name="category_ids[]"
-                        value="#{category.id}" />
-                    </td>
-                    <?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_category_group) ?>
+                        <td>
+                            <input type="checkbox" name="category_ids[]"
+                            value="#{category.id}" />
+                        </td>
+                        <?r end ?>
 
-                    <td>#{category.id}</td>
-                    <td>
-                        #{if user_authorized?(:edit_category_group)
-                          Categories::Controller::Categories.a(
-                            category.name,
-                            :edit,
-                            @category_group_id,
-                            category.id
-                          )
-                        else
-                          category.name
-                        end}
-                    </td>
-                    <td>#{category.slug}</td>
-                    <td>
-                        #{category.parent.name \
-                        if category.parent.respond_to?(:name)}
-                    </td>
-                </tr>
-                <?r end ?>
-            </tbody>
-        </table>
+                        <td>#{category.id}</td>
+                        <td>
+                            #{if user_authorized?(:edit_category_group)
+                              edit_link(
+                                Categories::Controller::Categories.r(
+                                  :edit,
+                                  @category_group_id,
+                                  category.id
+                                ),
+                                category.name
+                              )
+                            else
+                              category.name
+                            end}
+                        </td>
+                        <td>#{category.slug}</td>
+                        <td>
+                            #{category.parent.name \
+                            if category.parent.respond_to?(:name)}
+                        </td>
+                    </tr>
+                    <?r end ?>
+                </tbody>
+            </table>
 
-        #{if @categories.respond_to?(:navigation) and @categories.page_count > 1
-          @categories.navigation
-        end}
+            #{render_pagination(@categories)}
 
-        <?r else ?>
+            <?r else ?>
 
-        <p>#{lang('categories.messages.no_categories')}</p>
+            <p>#{lang('categories.messages.no_categories')}</p>
 
-        <?r end ?>
+            <?r end ?>
 
-        <?r if user_authorized?(:new_category) ?>
-        <div class="button">
-            #{Categories::Controller::Categories.a(
-              lang('categories.buttons.new'),
-              :new,
-              @category_group_id
+            <?r if user_authorized?(:new_category) ?>
+            #{new_button(
+              Categories::Controller::Categories.r(
+                :new,
+                @category_group_id
+              ),
+              lang('categories.buttons.new')
             )}
-        </div>
-        <?r end ?>
+            <?r end ?>
 
-        <?r if user_authorized?(:delete_category) and !@categories.empty? ?>
-        <div class="button">
-            <input type="submit"
-            value="#{lang('categories.buttons.delete')}" />
-        </div>
-        <?r end ?>
-    </form>
+            <?r if user_authorized?(:delete_category) and !@categories.empty? ?>
+            #{delete_button(lang('categories.buttons.delete'))}
+            <?r end ?>
+        </form>
+    </div>
 </section>

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

@@ -3,34 +3,37 @@
         <h1>#{get_breadcrumbs}</h1>
     </header>
 
-    #{form_for(
-      @category_group,
-      :method => :post,
-      :action => Categories::Controller::CategoryGroups.r(:save),
-      :id     => :category_group_form
-    ) do |f|
-      f.input_hidden(:id        , @category_group.id)
-      f.input_hidden(:csrf_token, get_csrf_token)
+    <div class="body">
+        #{form_for(
+          @category_group,
+          :method              => :post,
+          :action              => Categories::Controller::CategoryGroups.r(:save),
+          :id                  => :category_group_form,
+          :'data-autosave-url' => Categories::Controller::CategoryGroups \
+            .r(:autosave)
+        ) do |f|
+          f.input_hidden(:id        , @category_group.id)
+          f.input_hidden(:csrf_token, get_csrf_token)
 
-      f.input_text(
-        lang('category_groups.labels.name'),
-        :name,
-        :title     => lang('category_groups.descriptions.name'),
-        :required  => :required,
-        :maxlength => 255
-      )
+          f.input_text(
+            lang('category_groups.labels.name'),
+            :name,
+            :title     => lang('category_groups.descriptions.name'),
+            :required  => :required,
+            :maxlength => 255
+          )
 
-      f.textarea(
-        lang('category_groups.labels.description'),
-        :description,
-        :rows => 8
-      )
+          f.textarea(
+            lang('category_groups.labels.description'),
+            :description,
+            :rows => 8
+          )
 
-      f.g.div(:class => 'button') do
         f.g.input(
           :type  => 'submit',
-          :value => lang('category_groups.buttons.save')
+          :value => lang('category_groups.buttons.save'),
+          :class => 'button'
         )
-      end
-    end}
+        end}
+    </div>
 </section>