zen 0.3 → 0.4

data/lib/zen/package.rb

@@ -1,4 +1,5 @@
 require 'ramaze/gestalt'
+require 'ostruct'
 require __DIR__('package/menu')
 
 module Zen
@@ -28,6 +29,7 @@ module Zen
   # * root: the root directory of the package, this path should point to the
   #   directory containing your ``helper/`` and ``language/`` directories as
   #   well as any ``public/`` directories.
+  # * An innstance of OpenStruct that can be used for storing custom data.
   #
   # Setting these (and other) attributes is very easy:
   #
@@ -135,6 +137,9 @@ module Zen
     # The directory to all migrations.
     attr_accessor :migrations
 
+    # Instance of OpenStruct that can be used for storing custom data.
+    attr_reader :env
+
     class << self
       ##
       # Adds a new package along with all it's details such as the name, author,
@@ -192,15 +197,20 @@ module Zen
       # @return [String]
       #
       def build_menu(html_class = 'navigation', permissions = [])
-        g = Ramaze::Gestalt.new
+        g     = Ramaze::Gestalt.new
+        attrs = {:class => html_class}
+
+        if html_class.nil? or html_class.empty?
+          attrs.delete(:class)
+        end
 
-        g.ul(:class => html_class) do
+        g.ul(attrs) do
           # Sort the hash
           keys = REGISTERED.keys.sort
 
           keys.each do |key|
             unless REGISTERED[key].menu.nil?
-              g.out << REGISTERED[key].menu.html(permissions)
+              REGISTERED[key].menu.each { |m| g.out << m.html(permissions) }
             end
           end
         end
@@ -209,6 +219,15 @@ module Zen
       end
     end # class << self
 
+    ##
+    # Creates a new instance of the package.
+    #
+    # @since 12-02-2012
+    #
+    def initialize
+      @env = OpenStruct.new
+    end
+
     ##
     # Sets the name of the package. The name of a package should be a short and
     # unique name. A human readable version can be set using title=().
@@ -254,7 +273,11 @@ module Zen
     #
     def formatted_title
       if url
-        return '<a href="%s" title="%s">%s</a>' % [url, title, title]
+        return '<a href="%s" title="%s" class="icon external">%s</a>' % [
+          url,
+          title,
+          title
+        ]
       else
         return title
       end
@@ -326,10 +349,11 @@ module Zen
     #
     def menu(title = nil, url = nil, options = {}, &block)
       if title.nil? and url.nil? and !block_given?
-        return @menu
+        return @menus || []
       end
 
-      @menu = Zen::Package::Menu.new(title, url, options, &block)
+      @menus ||= []
+      @menus << Zen::Package::Menu.new(title, url, options, &block)
     end
 
     ##
@@ -361,6 +385,8 @@ module Zen
     def permissions
       perms = {}
 
+      return perms if @permissions.nil?
+
       @permissions.each do |perm, title|
         begin
           perms[perm] = lang(title)

data/lib/zen/package/all.rb

@@ -3,6 +3,7 @@
 # foreign keys might not work.
 require __DIR__('settings/lib/settings')
 require __DIR__('users/lib/users')
+require __DIR__('dashboard/lib/dashboard')
 require __DIR__('sections/lib/sections')
 require __DIR__('comments/lib/comments')
 require __DIR__('categories/lib/categories')

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

@@ -7,11 +7,9 @@ Zen::Package.add do |p|
   p.root       = __DIR__('categories')
   p.migrations = __DIR__('../migrations')
 
-  p.menu(
-    'categories.titles.index',
+  p.menu 'categories.titles.index',
     '/admin/category-groups',
     :permission => :show_category_group
-  )
 
   p.permission :show_category_group  , 'category_groups.permissions.show'
   p.permission :edit_category_group  , 'category_groups.permissions.edit'
@@ -24,12 +22,14 @@ Zen::Package.add do |p|
   p.permission :delete_category, 'categories.permissions.delete'
 end
 
-Zen::Language.load('categories')
-Zen::Language.load('category_groups')
-
 require __DIR__('categories/model/category_group')
 require __DIR__('categories/model/category')
 require __DIR__('categories/controller/category_groups')
 require __DIR__('categories/controller/categories')
 
 Zen::Controller::FrontendController.helper(:category_frontend)
+
+Zen::Event.listen :post_start do
+  Zen::Language.load('categories')
+  Zen::Language.load('category_groups')
+end

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

@@ -15,7 +15,7 @@ module Categories
     # you've reached the categories overview you'll be presented with an
     # overview that looks like the following image:
     #
-    # ![Categories Overview](../../_static/categories/categories.png)
+    # ![Categories Overview](../../images/categories/categories.png)
     #
     # ## Adding/Editing Categories
     #
@@ -23,7 +23,7 @@ module Categories
     # If you want to create a new category instead you should click the button
     # "Add category". In both cases you'll end up with the following form:
     #
-    # ![New Category](../../_static/categories/new_category.png)
+    # ![New Category](../../images/categories/new_category.png)
     #
     # In this form you can specify the following fields:
     #
@@ -49,48 +49,18 @@ module Categories
     # * new_category
     # * delete_category
     #
-    # ## 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
     # @map    /admin/categories
-    # @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 Categories < Zen::Controller::AdminController
       map    '/admin/categories'
       helper :category
       title  'categories.titles.%s'
 
-      # Protect Categories#save() and Categories#delete() against CSRF attacks.
       csrf_protection :save, :delete
 
+      autosave Model::Category, Model::Category::COLUMNS, :edit_category
+
       ##
       # Show an overview of all existing categories and allow the user
       # manage these categories.
@@ -153,11 +123,8 @@ module Categories
 
         @category_group_id = category_group_id
 
-        if flash[:form_data]
-          @category = flash[:form_data]
-        else
-          @category = ::Categories::Model::Category.new
-        end
+        @category = Model::Category.new
+        @category.set(flash[:form_data]) if flash[:form_data]
 
         render_view(:form)
       end
@@ -189,12 +156,9 @@ module Categories
         validate_category_group(category_group_id)
 
         @category_group_id = category_group_id
+        @category          = validate_category(id, category_group_id)
 
-        if flash[:form_data]
-          @category = flash[:form_data]
-        else
-          @category = validate_category(id, category_group_id)
-        end
+        @category.set(flash[:form_data]) if flash[:form_data]
 
         render_view(:form)
       end
@@ -206,64 +170,43 @@ module Categories
       # @since      0.1
       # @permission edit_category (when editing a category)
       # @permission new_category (when creating a category)
-      # @event      before_edit_category
-      # @event      after_edit_category
-      # @event      before_new_category
-      # @event      after_new_category
       #
       def save
-        post = request.subset(
-          :id,
-          :parent_id,
-          :name,
-          :description,
-          :slug,
-          :category_group_id
-        )
+        id   = request.params['id']
+        post = post_fields(*Model::Category::COLUMNS)
 
         validate_category_group(post['category_group_id'])
 
         # Retrieve the category and set the notifications based on if the ID has
         # been specified or not.
-        if post['id'] and !post['id'].empty?
+        if id and !id.empty?
           authorize_user!(:edit_category)
 
-          category     = validate_category(post['id'], post['category_group_id'])
-          save_action  = :save
-          before_event = :before_edit_category
-          after_event  = :after_edit_category
+          category    = validate_category(id, post['category_group_id'])
+          save_action = :save
         else
           authorize_user!(:new_category)
 
-          category     = ::Categories::Model::Category.new
-          save_action  = :new
-          before_event = :before_new_category
-          after_event  = :after_new_category
+          category    = ::Categories::Model::Category.new
+          save_action = :new
         end
 
-        post.delete('id')
-
         success = lang("categories.success.#{save_action}")
         error   = lang("categories.errors.#{save_action}")
 
-        # Try to update the category
         begin
-          post.each { |k, v| category.send("#{k}=", v) }
-          Zen::Event.call(before_event, category)
-
+          category.set(post)
           category.save
         rescue => e
-          Ramaze::Log.error(e.inspect)
+          Ramaze::Log.error(e)
           message(:error, error)
 
           flash[:form_errors] = category.errors
-          flash[:form_data]   = category
+          flash[:form_data]   = post
 
           redirect_referrer
         end
 
-        Zen::Event.call(after_event, category)
-
         message(:success, success)
         redirect(Categories.r(:edit, category.category_group_id, category.id))
       end
@@ -276,13 +219,11 @@ module Categories
       #
       # @since      0.1
       # @permission delete_category
-      # @event      before_delete_category
-      # @event      after_delete_category
       #
       def delete
         authorize_user!(:delete_category)
 
-        post = request.subset(:category_ids)
+        post = post_fields(:category_ids)
 
         # Obviously we'll require some IDs
         if post['category_ids'].nil? or post['category_ids'].empty?
@@ -296,18 +237,14 @@ module Categories
 
           next if category.nil?
 
-          Zen::Event.call(:before_delete_category, category)
-
           begin
             category.destroy
           rescue => e
-            Ramaze::Log.error(e.inspect)
+            Ramaze::Log.error(e)
             message(:error, lang('categories.errors.delete') % id)
 
             redirect_referrer
           end
-
-          Zen::Event.call(:after_delete_category, category)
         end
 
         message(:success, lang('categories.success.delete'))

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

@@ -32,7 +32,7 @@ module Categories
     # ``/admin/category-groups``. This overview looks like the image displayed
     # below.
     #
-    # ![Category Group Overview](../../_static/categories/category_groups.png)
+    # ![Category Group Overview](../../images/categories/category_groups.png)
     #
     # Editing an existing group can be done by clicking on the name of a group
     # while managing the categories of a group is done by clicking the link
@@ -49,7 +49,7 @@ module Categories
     # existing group or create a new one. The form used to manage such a group
     # looks like the one in the image below.
     #
-    # ![New Category Group](../../_static/categories/new_category_group.png)
+    # ![New Category Group](../../images/categories/new_category_group.png)
     #
     # In this form you can set the following fields:
     #
@@ -66,50 +66,20 @@ module Categories
     # * new_category_group
     # * delete_category_group
     #
-    # ## Events
-    #
-    # All available events receive an instance of
-    # {Categories::Model::CategoyGroup}. 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.inspect)
-    #       end
-    #     end
-    #
     # @since  0.1
     # @map    /admin/category-groups
-    # @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 CategoryGroups < Zen::Controller::AdminController
       helper :category
       map    '/admin/category-groups'
       title  'category_groups.titles.%s'
 
-      # Protects CategoryGroups#save() and CategoryGroups#delete() against CSRF
-      # attacks.
       csrf_protection :save, :delete
 
+      autosave Model::CategoryGroup,
+        Model::CategoryGroup::COLUMNS,
+        :edit_category_group
+
       ##
       # Show an overview of all existing category groups and allow the user
       # to create new category groups or manage individual categories.
@@ -123,10 +93,10 @@ module Categories
         set_breadcrumbs(lang('category_groups.titles.index'))
 
         @category_groups = search do |query|
-          ::Categories::Model::CategoryGroup.search(query).order(:id.asc)
+          Model::CategoryGroup.search(query).order(:id.asc)
         end
 
-        @category_groups ||= ::Categories::Model::CategoryGroup.order(:id.asc)
+        @category_groups ||= Model::CategoryGroup.order(:id.asc)
         @category_groups   = paginate(@category_groups)
       end
 
@@ -145,7 +115,8 @@ module Categories
           lang('category_groups.titles.edit')
         )
 
-        @category_group = flash[:form_data] || validate_category_group(id)
+        @category_group = validate_category_group(id)
+        @category_group.set(flash[:form_data]) if flash[:form_data]
 
         render_view(:form)
       end
@@ -164,11 +135,8 @@ module Categories
           lang('category_groups.titles.new')
         )
 
-        if flash[:form_data]
-          @category_group = flash[:form_data]
-        else
-          @category_group = ::Categories::Model::CategoryGroup.new
-        end
+        @category_group = Model::CategoryGroup.new
+        @category_group.set(flash[:form_data]) if flash[:form_data]
 
         render_view(:form)
       end
@@ -181,54 +149,41 @@ module Categories
       # @since      0.1
       # @permission edit_category_group (when editing a group)
       # @permission new_category_group (when creating a group)
-      # @event      before_new_category_group
-      # @event      after_new_category_group
-      # @event      before_edit_category_group
-      # @event      after_edit_category_group
       #
       def save
-        post = request.subset(:id, :name, :description)
+        post = post_fields(*Model::CategoryGroup::COLUMNS)
+        id   = request.params['id']
 
         # Get/create the group and set the event names.
-        if post['id'] and !post['id'].empty?
+        if id and !id.empty?
           authorize_user!(:edit_category_group)
 
-          category_group = validate_category_group(post['id'])
+          category_group = validate_category_group(id)
           save_action    = :save
-          before_event   = :before_edit_category_group
-          after_event    = :after_edit_category_group
         else
           authorize_user!(:new_category_group)
 
-          category_group = ::Categories::Model::CategoryGroup.new
+          category_group = Model::CategoryGroup.new
           save_action    = :new
-          before_event   = :before_new_category_group
-          after_event    = :after_new_category_group
         end
 
         success = lang("category_groups.success.#{save_action}")
         error   = lang("category_groups.errors.#{save_action}")
 
-        post.delete('id')
-
         # Set the values, call the events and try to save the category group.
         begin
-          post.each { |k, v| category_group.send("#{k}=", v) }
-          Zen::Event.call(before_event, category_group)
-
+          category_group.set(post)
           category_group.save
         rescue => e
           message(:error, error)
-          Ramaze::Log.error(e.inspect)
+          Ramaze::Log.error(e)
 
-          flash[:form_data]   = category_group
+          flash[:form_data]   = post
           flash[:form_errors] = category_group.errors
 
           redirect_referrer
         end
 
-        Zen::Event.call(after_event, category_group)
-
         message(:success, success)
         redirect(CategoryGroups.r(:edit, category_group.id))
       end
@@ -239,13 +194,11 @@ module Categories
       #
       # @since      0.1
       # @permission delete_category_group
-      # @event      before_delete_category_group
-      # @event      after_delete_category_group
       #
       def delete
         authorize_user!(:delete_category_group)
 
-        post = request.subset(:category_group_ids)
+        post = post_fields(:category_group_ids)
 
         if post['category_group_ids'].nil? or post['category_group_ids'].empty?
           message(:error, lang('category_groups.errors.no_delete'))
@@ -253,22 +206,18 @@ module Categories
         end
 
         post['category_group_ids'].each do |id|
-          group = ::Categories::Model::CategoryGroup[id]
+          group = Model::CategoryGroup[id]
 
           next if group.nil?
 
-          Zen::Event.call(:before_delete_category_group, group)
-
           begin
             group.destroy
           rescue => e
-            Ramaze::Log.error(e.inspect)
+            Ramaze::Log.error(e)
             message(:error, lang('category_groups.errors.delete') % id)
 
             redirect_referrer
           end
-
-          Zen::Event.call(:after_delete_category_group, group)
         end
 
         message(:success, lang('category_groups.success.delete'))