zen 0.1a → 0.2

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

@@ -0,0 +1,231 @@
+#:nodoc:
+module Menus
+  #:nodoc:
+  module Controllers
+    ##
+    # Controller for managing menu groups. Individual navigation items are managed using
+    # the menu items controller, simply named "menu_items".
+    #
+    # @author Yorick Peterse
+    # @since  0.2a
+    #
+    class Menus < Zen::Controllers::AdminController
+      include ::Menus::Models
+
+      map   '/admin/menus'
+      trait :extension_identifier => 'com.zen.menus'
+      
+      before_all do
+        csrf_protection(:save, :delete) do
+          respond(lang('zen_general.errors.csrf'), 403)
+        end
+      end
+      
+      ##
+      # Initializes the class and loads all required language packs.
+      #
+      # This method loads the following language files:
+      #
+      # * menus
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      #
+      def initialize
+        super
+        
+        @form_save_url   = Menus.r(:save)
+        @form_delete_url = Menus.r(:delete)
+        
+        Zen::Language.load('menus')
+        
+        # Set the page title
+        if !action.method.nil?
+          method      = action.method.to_sym
+          @page_title = lang("menus.titles.#{method}") rescue nil
+        end
+      end
+      
+      ##
+      # Shows an overview of all exisitng menus and a few properties of these
+      # groups such as the name, slug and the amount of items in that group.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      #
+      def index
+        if !user_authorized?([:read])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+
+        # Set our breadcrumbs
+        set_breadcrumbs(lang('menus.titles.index'))
+
+        # Get all menus
+        @menus = Menu.all
+      end
+      
+      ##
+      # Show a form that allows the user to edit the details (such as the name and slug)
+      # of a menu group. This method can not be used to manage all menu items for this 
+      # group.
+      #
+      # This method requires the following permissions:
+      #
+      # * read
+      # * update
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      #
+      def edit(id)
+        if !user_authorized?([:read, :update])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+
+        set_breadcrumbs(
+          anchor_to(lang('menus.titles.index'), Menus.r(:index)), 
+          @page_title
+        )
+        
+        if flash[:form_data]
+          @menu = flash[:form_data]
+        else
+          @menu = Menu[id]
+        end
+      end
+      
+      ##
+      # Show a form that can be used to create a new menu group. Once a menu group has
+      # been created users can start adding navigation items to the group.
+      #
+      # This method requires the following permissions:
+      #
+      # * create
+      # * read
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      #
+      def new
+        if !user_authorized?([:create, :read])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+
+        # Breadcrumbs, om nom nom!
+        set_breadcrumbs(
+          anchor_to(lang('menus.titles.index'), Menus.r(:index)), 
+          @page_title
+        )
+
+        @menu = Menu.new
+      end
+      
+      ##
+      # Saves the changes made to an existing menu group or creates a new group using the
+      # supplied POST data. In order to detect this forms that contain data of an existing
+      # group should have a hidden field named "id", the value of this field is the primary
+      # value of the menu group of which the changes should be saved.
+      #
+      # This method requires the following permissions:
+      #
+      # * create
+      # * update
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      #      
+      def save
+        if !user_authorized?([:create, :update])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+
+        # Fetch the POST data and store it in a variable so it's a bit easier to work with
+        post = request.params.dup
+
+        # Determine if we're creating a new group or modifying an existing one.
+        if !post['id'].empty?
+          @menu       = Menu[post['id'].to_i]
+          save_action = :save
+        else
+          @menu       = Menu.new
+          save_action = :new
+        end
+
+        # Set our notifications
+        flash_success = lang("menus.success.#{save_action}")
+        flash_error   = lang("menus.errors.#{save_action}")
+
+        # Let's see if we can insert/update the data
+        begin
+          @menu.update(post)
+          notification(:success, lang('menus.titles.index'), flash_success)
+        rescue
+          notification(:error, lang('menus.titles.index'), flash_error)
+
+          flash[:form_data]   = @menu
+          flash[:form_errors] = @menu.errors
+        end
+
+        # Redrect the user to the proper page
+        if @menu.id
+          redirect(Menus.r(:edit, @menu.id))
+        else
+          redirect_referrer
+        end
+      end
+
+      ##
+      # Deletes a number of navigation menus based on the supplied primary values.
+      # These primary values should be stored in a POST array called "menu_ids".
+      #
+      # This method requires the following permissions:
+      #
+      # * delete
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      #      
+      def delete
+        if !user_authorized?([:delete])
+          respond(lang('zen_general.errors.not_authorized'), 403)
+        end
+
+        post = request.params.dup
+
+        # We always require a set of IDs
+        if !post['menu_ids'] or post['menu_ids'].empty?
+          notification(
+            :error, 
+            lang('menus.titles.index'), 
+            lang('menus.errors.no_delete')
+          )
+
+          redirect_referrer
+        end
+
+        # Time to delete all menus
+        post['menu_ids'].each do |id|
+          begin
+            Menu[id.to_i].destroy
+          rescue
+            notification(
+              :error, 
+              lang('menus.titles.index'), 
+              lang('menus.errors.delete') % id
+            )
+
+            redirect_referrer
+          end
+        end
+
+        notification(:success, lang('menus.titles.index'), lang('menus.success.delete'))
+        redirect_referrer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+#:nodoc:
+module Ramaze
+  #:nodoc:
+  module Helper
+    ##
+    # Small helper for the Menus package mainly used to reduce the amount of code
+    # in controllers.
+    #
+    # @author Yorick Peterse
+    # @since  0.2a
+    #
+    module MenuItem
+      ##
+      # Checks if there is a menu for the given ID. If this isn't the case the user
+      # will be redirected back to the index page of the menus controller.
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      # @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?
+          notification(
+            :error, 
+            @menu_items_lang.titles[:index], 
+            @menu_items_lang.errors[:invalid_menu]
+          )
+
+          redirect(::Menus::Controllers::Menus.r(:index))
+        end
+      end
+
+      ##
+      # Builds a hierarchy of navigation items and all their sub items. The generated
+      # structure looks like the following:
+      #
+      #     Root
+      #      |
+      #      |_ Sub
+      #      | |
+      #      | |_ Sub sub
+      #      |
+      #      |_ Sub 1
+      # 
+      # @author Yorick Peterse
+      # @since  0.2a
+      # @param  [Integer] menu_id The ID of the current menu group.
+      # @return [Hash]
+      #
+      def menu_item_tree(menu_id)
+        menu_items = ::Menus::Models::MenuItem.filter(
+          :menu_id   => menu_id, 
+          :parent_id => nil
+        )
+
+        @menu_items_hash = {nil => '--'}
+
+        menu_items.each do |item|
+          @menu_items_hash[item.id] = item.name
+
+          item.descendants.each do |i|
+            self.descendant_items(i, 2)
+          end
+        end
+
+        return @menu_items_hash
+      end
+
+      ##
+      # Helper method for retrieving descendant navigation items.
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      # @param  [Menus::Models::MenuItem] item A MenuItem instance
+      # @param  [Integer] spaces The amount of unbreakable spaces to use.
+      #
+      def descendant_items(item, spaces)
+        return if @menu_items_hash.key?(item.id)
+
+        nbsps = ''
+        spaces.times { nbsps += " " }
+        @menu_items_hash[item.id] = nbsps + item.name
+        descendants               = item.descendants
+
+        if !descendants.empty?
+          descendants.each do |i|
+            self.descendant_items(i, spaces + 2)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zen/package/menus/lib/menus/language/en/menu_items.yml

@@ -0,0 +1,41 @@
+---
+titles:
+  index  : 'Menu Items'
+  edit   : 'Edit Menu Item'
+  new    : 'Create Menu Item'
+
+labels:
+  id         : '#'
+  parent_id  : 'Parent'
+  name       : 'Name'
+  url        : 'URL'
+  order      : 'Order'
+  css_class  : 'CSS class'
+  css_id     : 'CSS ID'
+
+placeholders:
+  name       : 'The text that will be displayed in the link.'
+  url        : 'The location to which the link will point.'
+  order      : 'A number that indicates the sort order.'
+  css_class  : 'Specify a class name to use for stylesheets.'
+  css_id     : 'Specify an ID to use for stylesheets.'
+
+messages:
+  no_items : 'No menu items have been added yet.'
+
+buttons:
+  new     : 'Add menu item'
+  save    : 'Save menu item'
+  delete  : 'Delete selected menu items'
+
+success:
+  new     : 'The menu item has been created.'
+  save    : 'The menu item has been modified.'
+  delete  : 'The selected menu items have been deleted.'
+
+errors:
+  new           : 'The menu item could not be created.'
+  save          : 'The menu item could not be modified.'
+  delete        : 'The menu item with ID #%s could not be deleted.'
+  no_delete     : 'You need to specify at least one item to delete.'
+  invalid_menu  : 'The specified menu was invalid or no longer exists.'

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

@@ -0,0 +1,39 @@
+---
+titles:
+  index  : 'Menus'
+  edit   : 'Edit Menu'
+  new    : 'Add Menu'
+
+labels:
+  id            : '#'
+  name          : 'Name'
+  slug          : 'Slug'
+  description   : 'Description'
+  css_class     : 'CSS class'
+  css_id        : 'CSS ID'
+  manage_items  : 'Manage menu items'
+
+placeholders:
+  name       : 'Specify the name of the menu.'
+  slug       : 'Specify the URL friendly name of the menu.'
+  css_class  : 'Specify a class to use in stylesheets.'
+  css_id     : 'Specify an ID to use in stylesheets.'
+
+messages:
+  no_menus: 'No menus have been added yet.'
+
+buttons:
+  new     : 'Add menu'
+  save    : 'Save menu'
+  delete  : 'Delete selected menus'
+
+success:
+  new     : 'The menu has been created.'
+  save    : 'The menu has been modified.'
+  delete  : 'The selected menus have been deleted.'
+
+errors:
+  new        : 'The menu could not be created.'
+  save       : 'The menu could not be modified.'
+  delete     : 'The menu with ID #%s could not be deleted.'
+  no_delete  : 'You need to specify at least one menu to delete.'

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

@@ -0,0 +1,152 @@
+require 'ramaze/gestalt'
+
+#:nodoc:
+module Menus
+  #:nodoc:
+  module Liquid
+    ##
+    # The menus tag can be used to display all menu items for a given menu slug or ID.
+    # Basic usage of this tag is as following:
+    #
+    #     {% menus slug="main" %}
+    #
+    # Given we had a menu of which the slug is "main" the output would look like the this:
+    #
+    #     <ul>
+    #         <li>
+    #             <a href="http://zen-cms.com/" title="Zen CMS">Zen CMS</a>
+    #         </li>
+    #     </ul>
+    #
+    # This tag takes the following arguments: 
+    #
+    # * slug: the slug of the menu for which to retrieve all items.
+    # * id: the ID of the menu for which to retrieve all items.
+    # * order: string (either "asc" or "desc") that will be used to order the menu items.
+    #
+    # If both the slug and ID are specified the ID will be used instead of the slug.
+    #
+    # @example
+    #  {% menus slug="main" order="asc" %}
+    #
+    # @author Yorick Peterse
+    # @since  0.2a
+    #
+    class Menus < ::Liquid::Tag
+      include ::Zen::Liquid::General
+
+      ##
+      # Initializes the tag class and converts the arguments string into a key/value
+      # hash.
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      # @param  [String] tag_name The name of the tag ("menus").
+      # @param  [String] arguments All arguments passed as key="value" combinations.
+      # @param  [String] tokens All tokens passed to the tag.
+      # 
+      def initialize(tag_name = 'menus', arguments = '', tokens = '')
+        super
+
+        @arguments = {
+          'order' => 'desc'
+        }.merge(parse_key_values(arguments))
+
+        @args_parsed = false
+      end
+
+      ##
+      # Retrieves the specified menu, generates the HTML and renders the Liquid template.
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      # @param  [Liquid::Context] context The current Liquid instance.
+      # @return [String] The HTML for the specified navigation menu. 
+      #
+      def render(context)
+        if @args_parsed == false
+          @arguments = merge_context(@arguments, context) 
+        end
+
+        @args_parsed = true
+        menu_items   = []
+        
+        if @arguments.key?('id')
+          menu = ::Menus::Models::Menu[@arguments['slug'].to_i]
+
+        elsif @arguments.key?('slug')
+          menu = ::Menus::Models::Menu[:slug => @arguments['slug']]
+
+        else
+          raise(
+            ArgumentError, 
+            "You need to specify either the ID or the slug in order to retrieve a menu."
+          )
+        end
+
+        return if menu.nil?
+
+        menu_items = ::Menus::Models::MenuItem.filter(:menu_id => menu.id)
+          .order(:order.send(@arguments['order']))
+        
+        # Build the navigation menu
+        @g                 = ::Ramaze::Gestalt.new
+        attributes         = {}
+        attributes[:class] = menu.css_class if !menu.css_class.nil?
+        attributes[:id]    = menu.css_id if !menu.css_id.nil?
+
+        # Organize all menu items in a parent/child hierachy
+        items_ordered = {}
+
+        @g.ul(attributes) do
+          menu_items.each do |item| 
+            if item.parent_id.nil?
+              self.menu_item(item)
+            end
+          end
+        end
+
+        return @g.to_s
+      end
+
+      ##
+      # Helper method used for generating a <li> and <a> tag for the current navigation 
+      # item. If the item has any sub items those will be generated as well.
+      #
+      # @author Yorick Peterse
+      # @since  0.2a
+      # @param  [Object] item The current navigation item
+      #
+      def menu_item(item)
+        attributes         = {}
+        
+        if !item.css_class.nil? and !item.css_class.empty?
+          attributes[:class] = item.css_class
+        end
+
+        if !item.css_id.nil? and !item.css_id.empty?
+          attributes[:id] = item.css_id
+        end
+
+        children = item.children
+
+        @g.li(attributes) do
+          if !item.url.nil? and !item.url.empty?
+            @g.a(:href => item.url, :title => item.name) { item.name }
+          else
+            @g.span { item.name }
+          end
+          
+          if !children.empty?
+            @g.ul(:class => :children) do
+              item.children.each do |i| 
+                self.menu_item(i)
+              end
+            end
+          end
+        end # end of @g.li(attributes) do
+      end
+
+    end
+  end
+end