zen 0.2.4.1 → 0.2.5

data/lib/zen/package/custom_fields/lib/custom_fields/view/admin/custom-fields/index.xhtml

@@ -41,7 +41,7 @@
                     <td>
                         #{anchor_to(
                           field.name, 
-                          CustomFields::Controllers::CustomFields.r(:edit, @custom_field_group_id, field.id), 
+                          CustomFields::Controller::CustomFields.r(:edit, @custom_field_group_id, field.id), 
                           :title => field.name
                         )}
                     </td>
@@ -51,7 +51,7 @@
                     
                     <td>#{field.slug}</td>
                     <td>#{lang("custom_fields.special.type_hash.#{field.type}")}</td>
-                    <td>#{@format_hash[field.format]}</td>
+                    <td>#{Zen::Plugin::Markup::Engines[field.format]}</td>
                 </tr>
                 <?r end ?>
             </tbody>
@@ -68,7 +68,7 @@
             <div class="button">
                 #{anchor_to(
                   lang('custom_fields.buttons.new'),
-                  CustomFields::Controllers::CustomFields.r(:new, @custom_field_group_id)
+                  CustomFields::Controller::CustomFields.r(:new, @custom_field_group_id)
                 )}
             </div>
             <?r end ?>

data/lib/zen/package/menus/lib/menus.rb

@@ -1,58 +1,40 @@
+Ramaze::HelpersHelper.options.paths.push(__DIR__('menus'))
 
-# Update the list of helper paths
-Ramaze::HelpersHelper.options.paths << __DIR__('menus')
-
-# Load all our models
 require __DIR__('menus/model/menu')
 require __DIR__('menus/model/menu_item')
-
-# Load all controllers
 require __DIR__('menus/controller/menus')
 require __DIR__('menus/controller/menu_items')
+require __DIR__('menus/plugin/menus')
 
-# Load all Liquid tags and register them
-require __DIR__('menus/liquid/menus')
-
-Liquid::Template.register_tag('menus', Menus::Liquid::Menus)
+Zen::Language.options.paths.push(__DIR__('menus'))
+Zen::Language.load('menus')
+Zen::Language.load('menu_items')
 
-# Describe the package
 Zen::Package.add do |p|
-  # The name of the package
-  p.name        = 'Menus' 
-
-  # The person/company that made the package
-  p.author      = 'Yorick Peterse'
-
-  # A URL to a page about the package
-  p.url         = 'http://zen-cms.com/userguide/menus'
-
-  # Describe what your theme or extension does.
-  p.about       = 'The Menus extension allows you to easily create navigation menus 
+  p.name          = 'menus' 
+  p.author        = 'Yorick Peterse'
+  p.url           = 'http://zen-cms.com/userguide/menus'
+  p.about         = 'The Menus extension allows you to easily create navigation menus 
 for the frontend.'
 
-  ## 
-  # An identifier is a unique string for your package in the following format: 
-  # 
-  # * com.AUTHOR.NAME for extensions
-  # * com.AUTHOR.themes.NAME for themes
-  #
-  # An example of this would be "com.zen.sections" or "com.zen.themes.zen_website".
-  #
-  p.identifier  = 'com.zen.menus'
-
-  ##
-  # Path to the directory containing the controllers, models, etc.
-  #
-  p.directory   = __DIR__('menus')
-
-  ##
-  # Path to the directory containing all migrations for this package.
-  #
+  p.directory     = __DIR__('menus')
   p.migration_dir = __DIR__('../migrations')
-  
-  # Note that themes can not have menu items (they'll be ignored).
+
   p.menu = [{
-    :title => "Menus",
+    :title => lang('menus.titles.index'),
     :url   => "/admin/menus"
   }]
+
+  p.controllers = {
+    lang('menus.titles.index')      => Menus::Controller::Menus, 
+    lang('menu_items.titles.index') => Menus::Controller::MenuItems
+  }
+end
+
+Zen::Plugin.add do |p|
+  p.name    = 'menus'
+  p.author  = 'Yorick Peterse'
+  p.url     = 'http://yorickpeterse.com/'
+  p.about   = 'Plugin that can be used to display a navigation menu.'
+  p.plugin  = Menus::Plugin::Menus
 end

data/lib/zen/package/menus/lib/menus/controller/menu_items.rb

@@ -1,19 +1,18 @@
 #:nodoc:
 module Menus
   #:nodoc:
-  module Controllers
+  module Controller
     ##
     # Controller for managing individual navigation items that belong to a menu. 
     #
     # @author Yorick Peterse
     # @since  0.2a
     #
-    class MenuItems < ::Zen::Controllers::AdminController
-      include ::Menus::Models
+    class MenuItems < ::Zen::Controller::AdminController
+      include ::Menus::Model
 
-      map    '/admin/menu-items'
-      trait  :extension_identifier => 'com.zen.menus'
-      helper :menu_item
+      map('/admin/menu-items')
+      helper(:menu_item)
       
       before_all do
         csrf_protection(:save, :delete) do

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module Menus
   #:nodoc:
-  module Controllers
+  module Controller
     ##
     # Controller for managing menu groups. Individual navigation items are managed using
     # the menu items controller, simply named "menu_items".
@@ -9,11 +9,10 @@ module Menus
     # @author Yorick Peterse
     # @since  0.2a
     #
-    class Menus < Zen::Controllers::AdminController
-      include ::Menus::Models
+    class Menus < Zen::Controller::AdminController
+      include ::Menus::Model
 
-      map   '/admin/menus'
-      trait :extension_identifier => 'com.zen.menus'
+      map('/admin/menus')
       
       before_all do
         csrf_protection(:save, :delete) do
@@ -154,6 +153,11 @@ module Menus
         else
           @menu       = Menu.new
           save_action = :new
+
+          # Delete the slug if it's empty
+          if post['slug'].empty?
+            post.delete('slug')
+          end
         end
 
         # Set our notifications

data/lib/zen/package/menus/lib/menus/helper/menu_item.rb

@@ -19,14 +19,14 @@ module Ramaze
       # @param  [Integer] menu_id The ID of the menu to validate.
       #
       def validate_menu(menu_id = nil)
-        if !menu_id or ::Menus::Models::Menu[menu_id].nil?
+        if !menu_id or ::Menus::Model::Menu[menu_id].nil?
           notification(
             :error, 
             @menu_items_lang.titles[:index], 
             @menu_items_lang.errors[:invalid_menu]
           )
 
-          redirect(::Menus::Controllers::Menus.r(:index))
+          redirect(::Menus::Controller::Menus.r(:index))
         end
       end
 
@@ -48,7 +48,7 @@ module Ramaze
       # @return [Hash]
       #
       def menu_item_tree(menu_id)
-        menu_items = ::Menus::Models::MenuItem.filter(
+        menu_items = ::Menus::Model::MenuItem.filter(
           :menu_id   => menu_id, 
           :parent_id => nil
         )
@@ -71,7 +71,7 @@ module Ramaze
       #
       # @author Yorick Peterse
       # @since  0.2a
-      # @param  [Menus::Models::MenuItem] item A MenuItem instance
+      # @param  [Menus::Model::MenuItem] item A MenuItem instance
       # @param  [Integer] spaces The amount of unbreakable spaces to use.
       #
       def descendant_items(item, spaces)

data/lib/zen/package/menus/lib/menus/model/menu.rb

@@ -1,7 +1,7 @@
 #:nodoc:
 module Menus
   #:nodoc:
-  module Models
+  module Model
     ##
     # Model used for managing groups of menu items. This model uses the following
     # Sequel plugins:
@@ -15,7 +15,7 @@ module Menus
       plugin :sluggable, :source => :name, :freeze => false
 
       # Define our relations
-      one_to_many :menu_items, :class => "Menus::Models::MenuItem"
+      one_to_many :menu_items, :class => "Menus::Model::MenuItem"
 
       ##
       # Specifies all validates rules used when creating or updating a menu.

data/lib/zen/package/menus/lib/menus/model/menu_item.rb

@@ -1,7 +1,7 @@
 #:nodoc:
 module Menus
   #:nodoc:
-  module Models
+  module Model
     ##
     # Model used for managing individual menu items in a group.
     # This model uses the following plugins:
@@ -14,6 +14,9 @@ module Menus
     class MenuItem < Sequel::Model
       plugin :tree, :order => :order
 
+      many_to_one :menu  , :class => 'Menus::Model::Menu'
+      many_to_one :parent, :class => self
+
       ##
       # Specifies all validation rules that will be used when creating or updating a 
       # menu item.

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

@@ -0,0 +1,152 @@
+require 'ramaze/gestalt'
+
+#:nodoc:
+module Menus
+  #:nodoc:
+  module Plugin
+    ##
+    # Plugin for displaying navigation menus. This plugin will take care of recursively
+    # displaying all sub items and various other tasks, you merely have to set a few
+    # options and then you can sit back and enjoy.
+    #
+    # ## Usage
+    #
+    #     menu = plugin(:menus, :menu => 'userguide', :sub => true)
+    #
+    # Calling this plugin will result in a string with HTML being returned. If you were
+    # to use this plugin in an Etanni template you'd have to wrap the call in #{} in order
+    # to actually display the menu.
+    #
+    # For more information about all the available options see 
+    # Menus::Plugin::Menus#initialize().
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    class Menus
+      include ::Zen::Plugin::Helper
+      include ::Menus::Model
+
+      ##
+      # Creates a new instance of the plugin and saves the configuration options.
+      #
+      # @example
+      #  plugin = Menus::Plugin::Menus.new(:limit => 10, :offset => 0, :sub => false)
+      #
+      # @author Yorick Peterse
+      # @since 0.2.5
+      # @param [Hash] options Hash with configuration options.
+      # @option options [Integer/Fixnum] :limit The maximum amount of root items to 
+      # retrieve.
+      # @option options [Integer/Fixnum] :offset The row offset for all root elements.
+      # @option options [Fixnum/Integer/String] :menu The ID or slug of the menu for which
+      # to retrieve all menu items.
+      # @option options [Boolean] :sub When set to false sub items will be ignored. This
+      # option is set to true by default.
+      # 
+      def initialize(options = {})
+        @options = {
+          :limit  => 20,
+          :offset => 0,
+          :menu   => nil,
+          :sub    => true
+        }.merge(options)
+
+        validate_type(@options[:limit] , :limit , [Integer, Fixnum])
+        validate_type(@options[:offset], :offset, [Integer, Fixnum])
+        validate_type(@options[:menu]  , :menu  , [String, Integer, Fixnum])
+      end
+
+      ##
+      # Renders the navigation menu based on the given configuration options.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @return [String] The HTML for the navigation menu.
+      #
+      def call
+        # Retrieve the menu 
+        if @options[:menu].class == String
+          menu = Menu[:slug => @options[:menu]]
+        else
+          menu = Menu[@options[:menu]]
+        end
+
+        return if !menu
+
+        # Get all menu items
+        menu_items = MenuItem.filter(:menu_id => menu.id, :parent_id => nil)
+          .limit(@options[:limit], @options[:offset])
+          .all
+        
+        @g         = Ramaze::Gestalt.new
+        attributes = {}
+        items_tree = {}
+
+        # Set the attributes for the main <ul> elements
+        if !menu.css_class.nil?
+          attributes[:class] = menu.css_class
+        end
+
+        if !menu.css_id.nil?
+          attributes[:id] = menu.css_id
+        end
+
+        # Time to build the HTML
+        @g.ul(attributes) do
+          menu_items.each do |item|
+            if item.parent_id.nil?
+              generate_item(item)
+            end
+          end
+        end
+
+        return @g.to_s
+      end
+
+      private
+
+      ##
+      # Generates the HTML for a single <li> element and all sub elements.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5 
+      # @param  [Object] item An instance of the MenuItem model as returned by Sequel.
+      #
+      def generate_item(item)
+        attributes = {}
+
+        if !item.css_class.nil?
+          attributes[:class] = item.css_class
+        end
+
+        if !item.css_id.nil?
+          attributes[:id] = item.css_id
+        end
+
+        # Get all child elements
+        children = item.children
+
+        # Render the <li> tag
+        @g.li(attributes) do
+          # Do we have a URL?
+          if !item.url.nil? and !item.url.empty?
+            @g.a(:href => item.url, :title => item.name) { item.name }
+          else
+            @g.span { item.name }
+          end
+
+          # Generate all the sub elements
+          if !children.empty? and @options[:sub] === true
+            @g.ul(:class => :children) do
+              children.each do |child|
+                generate_item(child)
+              end
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/zen/package/menus/lib/menus/view/admin/menu-items/form.xhtml

@@ -27,7 +27,7 @@ form_for(
 
   # Generate the dropdown that contains all possible parent menu items    
   parent_items = {}
-  Menus::Models::Menu[@menu_id.to_i].menu_items.each do |i|
+  Menus::Model::Menu[@menu_id.to_i].menu_items.each do |i|
     if i.id != @menu_item.id
       parent_items[i.id] = i.name
     end

data/lib/zen/package/menus/lib/menus/view/admin/menu-items/index.xhtml

@@ -37,11 +37,11 @@
 
                     <td>#{item.id}</td>
 
-                    <?r if user_authorized?([:edit]) ?>
+                    <?r if user_authorized?([:update]) ?>
                     <td>
                         #{anchor_to(
                           item.name, 
-                          Menus::Controllers::MenuItems.r(:edit, @menu_id, item.id)
+                          Menus::Controller::MenuItems.r(:edit, @menu_id, item.id)
                         )}
                     </td>
                     <?r else ?>
@@ -68,7 +68,7 @@
             <div class="button">
                 #{anchor_to(
                   lang('menu_items.buttons.new'), 
-                  Menus::Controllers::MenuItems.r(:new, @menu_id)
+                  Menus::Controller::MenuItems.r(:new, @menu_id)
                 )}
             </div>
             <?r end ?>

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

@@ -23,7 +23,7 @@
                     <th>#{lang('menus.labels.css_class')}</th>
                     <th>#{lang('menus.labels.css_id')}</th>
 
-                    <?r if user_authorized?([:create, :read]) ?>
+                    <?r if user_authorized?([:read], true, 'Menus::Controller::MenuItems') ?>
                     <th></th>
                     <?r end ?>
                 </tr>
@@ -39,12 +39,12 @@
                     <?r end ?>
 
                     <td>#{menu.id}</td>
-
-                    <?r if user_authorized?([:edit]) ?>
+                    
+                    <?r if user_authorized?([:update]) ?>
                     <td>
                         #{anchor_to(
                           menu.name, 
-                          Menus::Controllers::Menus.r(:edit, menu.id)
+                          Menus::Controller::Menus.r(:edit, menu.id)
                         )}
                     </td>
                     <?r else ?>
@@ -55,11 +55,11 @@
                     <td>#{menu.css_class}</td>
                     <td>#{menu.css_id}</td>
 
-                    <?r if user_authorized?([:create, :read]) ?>
+                    <?r if user_authorized?([:read], true, 'Menus::Controller::MenuItems') ?>
                     <td>
                         #{anchor_to(
                           lang('menus.labels.manage_items'), 
-                          Menus::Controllers::MenuItems.r(:index, menu.id)
+                          Menus::Controller::MenuItems.r(:index, menu.id)
                         )}
                     </td>
                     <?r end ?>
@@ -78,7 +78,7 @@
             <div class="button">
                 #{anchor_to(
                   lang('menus.buttons.new'), 
-                  Menus::Controllers::Menus.r(:new) 
+                  Menus::Controller::Menus.r(:new) 
                 )}
             </div>
             <?r end ?>