RubyGems - zen - Versions diffs - 0.2.7 → 0.2.8 - Mend

zen 0.2.7 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (303) hide show

data/lib/zen/layout/admin.xhtml CHANGED Viewed

@@ -1,24 +1,15 @@
 <!DOCTYPE html>
 <html lang="#{plugin(:settings, :get, :language).value}">
     <head>
-        <meta charset="utf-8" />
-        <!-- Load all stylesheets -->
-         #{::Zen::Asset.build(:stylesheet)}
-        <title>#{@page_title}</title>
+        #{render_file(__DIR__('../view/head.xhtml'))}
     </head>
     <body id="admin">
         <div id="top">
             <header class="container">
-                <!--
-                Main navigation of the backend. Navigation items may be excluded if the user
-                doesn't have the required permissions for the extension that created it.
-                -->
                 <nav id="main_nav" class="grid_12">
                     #{Zen::Package.build_menu("left", extension_permissions)}
                     <ul class="right clearfix">
                         <li>
                             <a href="/admin/users/logout">
@@ -39,7 +30,7 @@
                 </nav>
             </header>
         </div>
         #{render_file(__DIR__('../view/main.xhtml'))}
         #{render_file(__DIR__('../view/bottom.xhtml'))}
     </body>

data/lib/zen/layout/login.xhtml CHANGED Viewed

@@ -1,12 +1,7 @@
 <!DOCTYPE html>
 <html lang="#{plugin(:settings, :get, :language).value}">
     <head>
-        <meta charset="utf-8" />
-        <!-- Load all stylesheets -->
-        #{::Zen::Asset.build(:stylesheet)}
-        <title>#{@page_title}</title>
+        #{render_file(__DIR__('../view/head.xhtml'))}
     </head>
     <body id="login">

data/lib/zen/model/methods.rb CHANGED Viewed

@@ -3,10 +3,10 @@ module Sequel
   #:nodoc:
   class Model
     ##
-    # Retrieves all primary values and an optional column and returns the results as
-    # an array of hashes in which the keys of these hashes are the IDs and the values
-    # the values of the specified column. This array can be used when creating <select>
-    # elements using the BlueForm helper.
+    # Retrieves all primary values and an optional column and returns the
+    # results as an array of hashes in which the keys of these hashes are the
+    # IDs and the values the values of the specified column. This array can be
+    # used when creating <select> elements using the BlueForm helper.
     #
     # @example
     #  Sections::Model::Section.pk_hash(:name) # => {1 => 'Blog', 2 => 'General'}
@@ -24,5 +24,5 @@ module Sequel
       return hash
     end
-  end
-end
+  end # Model
+end # Sequel

data/lib/zen/model/settings.rb CHANGED Viewed

@@ -1,15 +1,16 @@
 Zen::Language.load('zen_models')
-# When passing a hash to update() or create() we'll ignore any keys that don't belong
-# in the table. This allows you to directly pass request.params to these methods
-# without having to filter the hash yourself.
+# When passing a hash to update() or create() we'll ignore any keys that don't
+# belong in the table. This allows you to directly pass request.params to these
+# methods without having to filter the hash yourself.
 Sequel::Model.strict_param_setting = false
 # Load all the required plugins
 Sequel::Model.plugin :validation_helpers
 Sequel::Model.plugin :association_pks
-Sequel.extension(:migration)
+Sequel.extension :migration
+Sequel.extension :pagination
 Sequel::Plugins::ValidationHelpers::DEFAULT_OPTIONS.merge!(
 {

data/lib/zen/package.rb CHANGED Viewed

@@ -5,13 +5,13 @@ require __DIR__('package/base')
 #:nodoc:
 module Zen
   ##
-  # Module used for registering extensions and themes, setting their details and the
-  # whole shebang. Packages follow the same directory structure as Rubygems and can
-  # actually be installed using either Rubygems or by storing them in a custom directory.
-  # As long as you require the correct file you're good to go.
+  # Module used for registering extensions and themes, setting their details and
+  # the whole shebang. Packages follow the same directory structure as Rubygems
+  # and can actually be installed using either Rubygems or by storing them in a
+  # custom directory. As long as you require the correct file you're good to go.
   #
-  # Packages are added or "described" using a simple block and the add() method as
-  # following:
+  # Packages are added or "described" using a simple block and the add() method
+  # as following:
   #
   #     Zen::Package.add do |ext|
   #       # ....
@@ -29,12 +29,13 @@ module Zen
   #
   # ## ACL
   #
-  # Packages allow developers to register controllers for the ACL system that ships with
-  # Zen. Doing this means a user can set controller specific rules in the backend without
-  # having to write any code. In order to register a set of controllers you'll need to
-  # set the "controllers" attribute in the package block to a hash. The keys of this hash
-  # should be a human readable name of the controller and the values the full namespace
-  # of the controller as either a string or a constants:
+  # Packages allow developers to register controllers for the ACL system that
+  # ships with Zen. Doing this means a user can set controller specific rules
+  # in the backend without having to write any code. In order to register a set
+  # of controllers you'll need to set the "controllers" attribute in the package
+  # block to a hash. The keys of this hash should be a human readable name of
+  # the controller and the values the full namespace of the controller as either
+  # a string or a constants:
   #
   #     Zen::Package.add do |pkg|
   #       pkg.controllers = {
@@ -44,12 +45,15 @@ module Zen
   #
   # ## Menu Items
   #
-  # The package system easily allows modules to add navigation/sub-navigation elements
-  # to the backend menu. Each extension can have an attribute named "menu", this attribute
-  # is an array of hashes. Each hash must have the following 2 keys (they're symbols):
+  # The package system easily allows modules to add navigation/sub-navigation
+  # elements to the backend menu. Each extension can have an attribute named
+  # "menu", this attribute is an array of hashes. Each hash must have the
+  # following 2 keys (they're symbols):
   #
-  # * title: the value used for both the title tag and the text of the anchor element
-  # * url: the URI the navigation item will point to. Leading slash isn't required
+  # * title: the value used for both the title tag and the text of the anchor
+  #   element
+  # * url: the URI the navigation item will point to. Leading slash isn't
+  #   required
   #
   # Optionally you can specify child elements using the "children" key. This key
   # will again contain an array of hashes just like regular navigation elements.
@@ -64,21 +68,23 @@ module Zen
   #       :children => [{:title => "Child", :url => "admin/dashboard/child"}]
   #     }]
   #
-  # Once a certain number of navigation elements have been added you can generate the
-  # HTML for a fully fledged navigation menu using the build_menu() method. This method
-  # uses Gestalt to build the HTML and also takes care of permissions for each user/module.
+  # Once a certain number of navigation elements have been added you can
+  # generate the HTML for a fully fledged navigation menu using the
+  # build_menu() method. This method uses Gestalt to build the HTML and also
+  # takes care of permissions for each user/module.
   #
   # ## Migrations
   #
-  # If your package uses it's own database tables it's best to use migrations as these make
-  # it very easy to install/uninstall the extension. Migrations should be put in the root
-  # directory of your extension. For example, if your extension is in "foobar" the
-  # migrations should be located in "foobar/migrations", the lib directory in "foobar/lib",
-  # etc.
+  # If your package uses it's own database tables it's best to use migrations as
+  # these make it very easy to install/uninstall the extension. Migrations
+  # should be put in the root directory of your extension. For example, if your
+  # extension is in "foobar" the migrations should be located in
+  # "foobar/migrations", the lib directory in "foobar/lib", etc.
   #
-  # Migrations can be executed using the Thor task "package:migrate" or "db:migrate",
-  # the latter will install all packages while the first one will only install the
-  # specified packages. For more information on these tasks execute the following command:
+  # Migrations can be executed using the Thor task "package:migrate" or
+  # "db:migrate", the latter will install all packages while the first one will
+  # only install the specified packages. For more information on these tasks
+  # execute the following command:
   #
   #     $ rake -T
   #
@@ -87,8 +93,8 @@ module Zen
   #
   module Package
     ##
-    # Hash containing all the registered packages. The keys of this hash are the names
-    # of all packages and the values the instances of Zen::Package::Base.
+    # Hash containing all the registered packages. The keys of this hash are the
+    # names of all packages and the values the instances of Zen::Package::Base.
     #
     # @author Yorick Peterse
     # @since  0.2.5
@@ -104,8 +110,9 @@ module Zen
     Controllers = []
     ##
-    # Adds a new package along with all it's details such as the name, author, version
-    # and so on. Extensions can be added using a simple block as following:
+    # Adds a new package along with all it's details such as the name, author,
+    # version and so on. Extensions can be added using a simple block as
+    # following:
     #
     #     Zen::Package.add do |ext|
     #       ext.name   = "name"
@@ -121,12 +128,13 @@ module Zen
     # * url
     # * directory
     #
-    # You can also set "migration_dir" to a directory with all migrations. By default
-    # Zen will assume that it's 2 levels above your root directory.
+    # You can also set "migration_dir" to a directory with all migrations. By
+    # default Zen will assume that it's 2 levels above your root directory.
     #
     # @author Yorick Peterse
     # @since  0.1
-    # @yield  [package] Object containing all setters and getters for each package.
+    # @yield  [package] Object containing all setters and getters for each
+    # package.
     #
     def self.add
       package = Zen::Package::Base.new
@@ -185,12 +193,13 @@ module Zen
     # of which each list item can contain N sub items.
     #
     # @author Yorick Peterse
-    # @param  [String] css_class A string of CSS classes to apply to the main UL element.
+    # @param  [String] html_class A string of CSS classes to apply to the main UL
+    # element.
     # @param  [Hash] permissions Hash containing the permissions as returned by
     # Ramaze::Helper::ACL.extension_permissions
     # @since  0.1
     #
-    def self.build_menu(css_class = '', permissions = {})
+    def self.build_menu(html_class = '', permissions = {})
       @g           = Ramaze::Gestalt.new
       @permissions = permissions
       menu_items   = []
@@ -209,7 +218,7 @@ module Zen
         item[:title]
       end
-      @g.ul :class => css_class do
+      @g.ul :class => html_class do
         if !menu_items.empty?
           menu_items.each do |m|
             self.nav_list(m)

data/lib/zen/package/all.rb CHANGED Viewed

@@ -1,8 +1,6 @@
-##
-# Loads all core packages that ship with Zen. Note that it's important to load these
-# packages in the correct order as otherwise migrations that create foreign keys might
-# not work.
-#
+# Loads all core packages that ship with Zen. Note that it's important to load
+# these packages in the correct order as otherwise migrations that create
+# foreign keys might not work.
 require __DIR__('users/lib/users')
 require __DIR__('settings/lib/settings')
 require __DIR__('sections/lib/sections')

data/lib/zen/package/base.rb CHANGED Viewed

@@ -3,7 +3,8 @@ module Zen
   #:nodoc:
   module Package
     ##
-    # Base class used to store the data about packages such as the name, directory, etc.
+    # Base class used to store the data about packages such as the name,
+    # directory, etc.
     #
     # @author Yorick Peterse
     # @since  0.2.5
@@ -32,8 +33,8 @@ module Zen
       # 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.
+      # Array containing all controllers for the package. These classes will be
+      # used by the ACL system.
       attr_accessor :controllers
       ##
@@ -56,7 +57,6 @@ module Zen
           raise(::Zen::ValidationError, "The package #{name} already exists.")
         end
       end
-    end
-  end
-end
+    end # Base
+  end # Package
+end # Zen

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

@@ -1,3 +1,6 @@
+# Update the helper path before loading the controllers
+Ramaze::HelpersHelper.options.paths.push(__DIR__('categories'))
 require __DIR__('categories/model/category_group')
 require __DIR__('categories/model/category')
 require __DIR__('categories/controller/category_groups')
@@ -14,8 +17,8 @@ Zen::Package.add do |p|
   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.about         = "Module for managing categories. Categories can be used to
+organize section entries."
   p.directory     = __DIR__('categories')
   p.migration_dir = __DIR__('../migrations')
@@ -37,6 +40,8 @@ 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.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 CHANGED Viewed

@@ -3,10 +3,10 @@ module Categories
   #:nodoc:
   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.
-    # When adding a new entry categories aren't required so you're free to ignore
-    # them if you don't need them.
+    # 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. When adding a new entry categories aren't required so
+    # you're free to ignore them if you don't need them.
     #
     # @author Yorick Peterse
     # @since  0.1
@@ -14,7 +14,8 @@ module Categories
     class Categories < Zen::Controller::AdminController
       include ::Categories::Model
-      map('/admin/categories')
+      map '/admin/categories'
+      helper :category
       before_all do
         csrf_protection(:save, :delete) do
@@ -23,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:
       #
@@ -37,9 +38,6 @@ module Categories
       def initialize
         super
-        @form_save_url   = Categories.r(:save)
-        @form_delete_url = Categories.r(:delete)
         Zen::Language.load('categories')
         Zen::Language.load('category_groups')
@@ -59,22 +57,26 @@ module Categories
       # * read
       #
       # @author Yorick Peterse
-      # @param  [Integer] category_group_id The ID of the category group that's currently
-      # being managed by the user.
+      # @param  [Fixnum] category_group_id The ID of the category group that's
+      # currently being managed by the user.
       # @since  0.1
       #
-      def index category_group_id
-        if !user_authorized?([:read])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+      def index(category_group_id)
+        require_permissions(:read)
         set_breadcrumbs(
-          anchor_to(lang('category_groups.titles.index'), CategoryGroups.r(:index)),
+          CategoryGroups.a(lang('category_groups.titles.index'), :index),
           lang('categories.titles.index')
         )
-        @category_group_id = category_group_id.to_i
-        @categories        = CategoryGroup[@category_group_id].categories
+        # Validate the category group
+        category_group     = validate_category_group(category_group_id)
+        @category_group_id = category_group_id
+        @categories        = Category.filter(
+          :category_group_id => category_group_id
+        )
+        @categories = paginate(@categories)
       end
       ##
@@ -90,24 +92,30 @@ module Categories
       # @param  [Integer] id The ID of the category to edit.
       # @since  0.1
       #
-      def edit category_group_id, id
-        if !user_authorized?([:read, :update])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+      def edit(category_group_id, id)
+        require_permissions(:read, :update)
         set_breadcrumbs(
-          anchor_to(lang('category_groups.titles.index'), CategoryGroups.r(:index)),
-          anchor_to(lang('categories.titles.index'), Categories.r(:index, category_group_id)),
+          CategoryGroups.a(
+            lang('category_groups.titles.index'), :index
+          ),
+          Categories.a(
+            lang('categories.titles.index'), :index, category_group_id
+          ),
           lang('categories.titles.edit')
         )
-        @category_group_id = category_group_id.to_i
+        validate_category_group(category_group_id)
+        @category_group_id = category_group_id
         if flash[:form_data]
           @category = flash[:form_data]
         else
-          @category = Category[id.to_i]
+          @category = validate_category(id, category_group_id)
         end
+        render_view(:form)
       end
       ##
@@ -122,19 +130,25 @@ module Categories
       # @param  [Integer] category_group_id The ID of the category group.
       # @since  0.1
       #
-      def new category_group_id
-        if !user_authorized?([:read, :create])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+      def new(category_group_id)
+        require_permissions(:read, :create)
         set_breadcrumbs(
-          anchor_to(lang('category_groups.titles.index'), CategoryGroups.r(:index)),
-          anchor_to(lang('categories.titles.index'), Categories.r(:index, category_group_id)),
+          CategoryGroups.a(
+            lang('category_groups.titles.index'), :index
+          ),
+          Categories.a(
+            lang('categories.titles.index'), :index, category_group_id
+          ),
           lang('categories.titles.new')
         )
-        @category_group_id = category_group_id.to_i
+        validate_category_group(category_group_id)
+        @category_group_id = category_group_id
         @category          = Category.new
+        render_view(:form)
       end
       ##
@@ -150,25 +164,33 @@ module Categories
       # @since  0.1
       #
       def save
-        if !user_authorized?([:create, :update])
-          respond(lang('zen_general.errors.not_authorized'), 403)
-        end
+        # Fetch all the required fields
         post = request.subset(
-          :id, :parent_id, :name, :description, :slug, :category_group_id
+          :id,
+          :parent_id,
+          :name,
+          :description,
+          :slug,
+          :category_group_id
         )
+        # Validate the category group
+        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?
-          @category   = Category[post['id']]
+          require_permissions(:update)
+          category    = validate_category(post['id'], post['category_group_id'])
           save_action = :save
         else
-          @category   = Category.new
+          require_permissions(:create)
+          category    = Category.new
           save_action = :new
         end
-        # Remove various keys
         post.delete('slug') if post['slug'].empty?
         post.delete('id')
@@ -178,17 +200,19 @@ module Categories
         # Try to update the category
         begin
-          @category.update(post)
+          category.update(post)
           message(:success, flash_success)
         rescue
           message(:error, flash_error)
-          flash[:form_errors] = @category.errors
-          flash[:form_data]   = @category
+          flash[:form_errors] = category.errors
+          flash[:form_data]   = category
+          redirect_referrer
         end
-        if @category.id
-          redirect(Categories.r(:edit, post['category_group_id'], @category.id))
+        if category.id
+          redirect(Categories.r(:edit, post['category_group_id'], category.id))
         else
           redirect(Categories.r(:new, post['category_group_id']))
         end
@@ -196,9 +220,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:
       #
@@ -208,14 +232,13 @@ 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_ids, :category_group_id)
         # Obviously we'll require some IDs
-        if !request.params['category_ids'] or request.params['category_ids'].empty?
+        if !request.params['category_ids'] \
+        or request.params['category_ids'].empty?
           message(:error, lang('categories.errors.no_delete'))
           redirect(Categories.r(:index, post['category_group_id']))
         end
@@ -225,8 +248,11 @@ module Categories
           begin
             Category[id].destroy
             message(:success, lang('categories.success.delete'))
-          rescue
+          rescue => e
+            Ramaze::Log.error(e.inspect)
             message(:error, lang('categories.errors.delete') % id)
+            redirect_referrer
           end
         end