zen 0.2.8 → 0.3b

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

@@ -1,4 +1,3 @@
-#:nodoc:
 module Ramaze
   #:nodoc:
   module Helper
@@ -6,7 +5,6 @@ module Ramaze
     # Small helper for the Menus package mainly used to reduce the amount of
     # code in controllers.
     #
-    # @author Yorick Peterse
     # @since  0.2a
     #
     module Menu
@@ -14,11 +12,10 @@ module Ramaze
       # 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  [Fixnum] menu_id The ID of the menu to validate.
       # @return [Menus::Model::Menu] The menu that was specified in case it's
-      # valid.
+      #  valid.
       #
       def validate_menu(menu_id)
         menu = ::Menus::Model::Menu[menu_id]
@@ -34,11 +31,10 @@ module Ramaze
       ##
       # Validates a menu item and returns it if it's valid.
       #
-      # @author Yorick Peterse
       # @since  0.2.8
       # @param  [Fixnum] menu_item_id The ID of the menu item to validate.
       # @param  [Fixnum] menu_id The ID of the menu the item belongs to, used
-      # when redirecting the user.
+      #  when redirecting the user.
       # @return [Menus::Model::MenuItem]
       #
       def validate_menu_item(menu_item_id, menu_id)
@@ -64,7 +60,6 @@ module Ramaze
       #      |
       #      |_ Sub 1
       #
-      # @author Yorick Peterse
       # @since  0.2a
       # @param  [Fixnum] menu_id The ID of the current menu group.
       # @return [Hash]
@@ -91,7 +86,6 @@ module Ramaze
       ##
       # Helper method for retrieving descendant navigation items.
       #
-      # @author Yorick Peterse
       # @since  0.2a
       # @param  [Menus::Model::MenuItem] item A MenuItem instance
       # @param  [Fixnum] spaces The amount of unbreakable spaces to use.

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

@@ -0,0 +1,114 @@
+require 'ramaze/gestalt'
+
+module Ramaze
+  module Helper
+    ##
+    # Helper that allows you to render navigation menus in your templates.
+    #
+    # @since  0.3
+    #
+    module MenuFrontend
+      ##
+      # Renders a navigation menu's items based on the menu slug or ID.
+      #
+      # @example Render a menu by it's slug
+      #  render_menu('main')
+      #
+      # @example Render a menu by it's ID
+      #  render_menu(2)
+      #
+      # @example Render a menu without sub items
+      #  render_menu('main', :sub => false)
+      #
+      # @since  0.3
+      # @param  [String|Fixnum] menu The slug or ID of a menu to render.
+      # @param  [Hash] options A hash containing various options to customize
+      #  the return value.
+      # @option options [Fixnum] :limit The amount of menu items to display. Set
+      #  to 20 by default.
+      # @option options [TrueClass|FalseClass] :sub Boolean that indicates if
+      #  sub items should be rendered or not, set to true by default.
+      # @option options [Symbol] :order The sort order method to call, can
+      #  either be ``:asc`` or ``:desc``, set to ``:asc`` by default.
+      # @return [String]
+      #
+      def render_menu(menu, options = {})
+        options = {
+          :limit => 20,
+          :sub   => true,
+          :order => :asc
+        }.merge(options)
+
+        menu  = Menus::Model::Menu.find_by_pk_or_slug(menu)
+        items = Menus::Model::MenuItem \
+          .filter(:parent_id => nil, :menu_id => menu.id) \
+          .limit(options[:limit]) \
+          .order(:sort_order.send(options[:order])) \
+          .eager(:parent) \
+          .all
+
+        g     = Ramaze::Gestalt.new
+        attrs = {}
+        tree  = {}
+
+        if !menu.html_class.nil? and !menu.html_class.empty?
+          attrs[:class] = menu.html_class
+        end
+
+        if !menu.html_id.nil? and !menu.html_id.empty?
+          attrs[:id] = menu.html_id
+        end
+
+        # Build the HTML
+        g.ul(attrs) do
+          items.each do |item|
+            if item.parent_id.nil?
+              render_menu_item(item, g, options)
+            end
+          end
+        end
+
+        return g.to_s
+      end
+
+      private
+
+      ##
+      # Generates the HTML for a single menu item.
+      #
+      # @since  0.3
+      # @param  [Menus::Model::MenuItem] item The menu item to render.
+      # @param  [Ramaze::Gestalt] g An instance of ``Ramaze::Gestalt`` to use
+      #  for building the HTML.
+      # @param  [Hash] options A hash of options, see the options hash for
+      #  {Ramaze::Helper::MenuFrontend#render_menu} for more information.
+      #
+      def render_menu_item(item, g, options = {})
+        attrs = {}
+
+        if !item.html_class.nil? and !item.html_class.empty?
+          attrs[:class] = item.html_class
+        end
+
+        if !item.html_id.nil? and !item.html_id.empty?
+          attrs[:id] = item.html_id
+        end
+
+        g.li(attrs) do
+          g.a(:href => item.url, :title => item.name) { item.name }
+
+          # Render any sub menu items
+          if options[:sub] == true
+            children = item.children
+
+            if !children.empty?
+              g.ul(:class => :children) do
+                children.each { |child| render_menu_item(child, g, options) }
+              end
+            end
+          end
+        end
+      end
+    end # MenuFrontend
+  end # Helper
+end # Ramaze

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

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'en'
+  trans.name     = 'menu_items'
+
+  trans.translate do |t|
+    t['titles.index'] = 'Menu Items'
+    t['titles.edit']  = 'Edit Menu Item'
+    t['titles.new']   = 'Create Menu Item'
+
+    t['labels.id']         = '#'
+    t['labels.parent_id']  = 'Parent'
+    t['labels.name']       = 'Name'
+    t['labels.url']        = 'URL'
+    t['labels.order']      = 'Order'
+    t['labels.html_class'] = 'HTML class'
+    t['labels.html_id']    = 'HTML ID'
+
+    t['descriptions.name']       = 'The text that will be displayed in the link.'
+    t['descriptions.url']        = 'The location to which the link will point.'
+    t['descriptions.order']      = 'A number that indicates the sort order.'
+    t['descriptions.html_id']    = 'Specify an ID to apply to this item.'
+    t['descriptions.html_class'] = 'Specify a class name (or multiple names) ' \
+      'to apply to this item.'
+
+    t['messages.no_items'] = 'No menu items were found.'
+
+    t['buttons.new']    = 'Add menu item'
+    t['buttons.save']   = 'Save menu item'
+    t['buttons.delete'] = 'Delete selected menu items'
+
+    t['success.new']    = 'The menu item has been created.'
+    t['success.save']   = 'The menu item has been modified.'
+    t['success.delete'] = 'The selected menu items have been deleted.'
+
+    t['errors.new']          = 'The menu item could not be created.'
+    t['errors.save']         = 'The menu item could not be modified.'
+    t['errors.delete']       = 'The menu item with ID #%s could not be deleted.'
+    t['errors.no_delete']    = 'You need to specify at least one item to delete.'
+    t['errors.invalid_item'] = 'The specified menu item is invalid.'
+
+    t['permissions.show']   = 'Show menu item'
+    t['permissions.edit']   = 'Edit menu item'
+    t['permissions.new']    = 'Add menu item'
+    t['permissions.delete'] = 'Delete menu item'
+  end
+end

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

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'en'
+  trans.name     = 'menus'
+
+  trans.translate do |t|
+    t['titles.index'] = 'Menus'
+    t['titles.edit']  = 'Edit Menu'
+    t['titles.new']   = 'Add Menu'
+
+    t['labels.id']           = '#'
+    t['labels.name']         = 'Name'
+    t['labels.slug']         = 'Slug'
+    t['labels.description']  = 'Description'
+    t['labels.html_class']   = 'HTML class'
+    t['labels.html_id']      = 'HTML ID'
+    t['labels.manage_items'] = 'Manage menu items'
+
+    t['descriptions.name']       = 'Specify the name of the menu.'
+    t['descriptions.slug']       = 'Specify the URL friendly name of the menu.'
+    t['descriptions.html_class'] = 'A number of classes to apply to the menu.'
+    t['descriptions.html_id']    = 'An ID to apply to the menu.'
+
+    t['messages.no_menus'] = 'No menus were found.'
+
+    t['buttons.new']    = 'Add menu'
+    t['buttons.save']   = 'Save menu'
+    t['buttons.delete'] = 'Delete selected menus'
+
+    t['success.new']    = 'The menu has been created.'
+    t['success.save']   = 'The menu has been modified.'
+    t['success.delete'] = 'The selected menus have been deleted.'
+
+    t['errors.new']          = 'The menu could not be created.'
+    t['errors.save']         = 'The menu could not be modified.'
+    t['errors.delete']       = 'The menu with ID #%s could not be deleted.'
+    t['errors.no_delete']    = 'You need to specify at least one menu to delete.'
+    t['errors.invalid_menu'] = 'The specified menu is invalid.'
+
+    t['permissions.show']   = 'Show menu'
+    t['permissions.edit']   = 'Edit menu'
+    t['permissions.new']    = 'Add menu'
+    t['permissions.delete'] = 'Delete menu'
+
+    t['description'] = 'Manage menus and menu items.'
+  end
+end

data/lib/zen/package/menus/lib/menus/language/nl/menu_items.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'nl'
+  trans.name     = 'menu_items'
+
+  trans.translate do |t|
+    t['titles.index'] = 'Menu items'
+    t['titles.edit']  = 'Menu item aanpassen'
+    t['titles.new']   = 'Menu item aanmaken'
+
+    t['labels.id']         = '#'
+    t['labels.parent_id']  = 'Hoofd item'
+    t['labels.name']       = 'Naam'
+    t['labels.url']        = 'URL'
+    t['labels.order']      = 'Volgorde'
+    t['labels.html_class'] = 'HTML klasse'
+    t['labels.html_id']    = 'HTML ID'
+
+    t['descriptions.name']       = 'De naam/label van het menu item.'
+    t['descriptions.url']        = 'De URL van het menu item.'
+    t['descriptions.order']      = 'De sorteer volgorde.'
+    t['descriptions.html_class'] = 'Een of meerdere klasses voor dit item.'
+    t['descriptions.html_id']    = 'Een ID voor dit item.'
+
+    t['messages.no_items'] = 'Er zijn geen menu items gevonden.'
+
+    t['buttons.new']    = 'Menu item toevoegen'
+    t['buttons.save']   = 'Menu item opslaan'
+    t['buttons.delete'] = 'Geselecteerde menu items verwijderen'
+
+    t['success.new']    = 'Het menu item is aangemaakt.'
+    t['success.save']   = 'Het menu item is aangepast.'
+    t['success.delete'] = 'De menu items zijn verwijderd.'
+
+    t['errors.new']       = 'Het menu item kon niet worden aangemaakt.'
+    t['errors.save']      = 'Het menu item kon niet worden aangepast.'
+    t['errors.delete']    = 'Het menu item met ID #%s kon niet worden verwijderd.'
+    t['errors.no_delete'] = 'U moet ten minste 1 item specificeren ' \
+      'om te verwijderen.'
+    t['errors.invalid_item'] = 'Het opgegeven menu item is ongeldig.'
+
+    t['permissions.show']   = 'Menu item weergeven'
+    t['permissions.edit']   = 'Menu item aanpassen'
+    t['permissions.new']    = 'Menu item toevoegen'
+    t['permissions.delete'] = 'Menu item verwijderen'
+  end
+end

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

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'nl'
+  trans.name     = 'menus'
+
+  trans.translate do |t|
+    t['titles.index'] = 'Menu\'s'
+    t['titles.edit']  = 'Menu aanpassen'
+    t['titles.new']   = 'Menu aanmaken'
+
+    t['labels.id']           = '#'
+    t['labels.name']         = 'Naam'
+    t['labels.slug']         = 'Slug'
+    t['labels.description']  = 'Beschrijving'
+    t['labels.html_class']   = 'HTML klasse'
+    t['labels.html_id']      = 'HTML ID'
+    t['labels.manage_items'] = 'Menu items beheren'
+
+    t['descriptions.name'] = 'De naam van het menu.'
+    t['descriptions.slug'] = 'Een URL vriendelijke versie van de ' \
+      'menu naam.'
+    t['descriptions.html_class'] = 'Een of meerdere klasses voor dit menu.'
+    t['descriptions.html_id']    = 'Een ID voor dit menu.'
+
+    t['messages.no_menus'] = 'Er zijn geen menu\'s gevonden.'
+
+    t['buttons.new']    = 'Menu toevoegen'
+    t['buttons.save']   = 'Menu opslaan'
+    t['buttons.delete'] = 'Geselecteerde menu\'s verwijderen'
+
+    t['success.new']    = 'Het menu is aangemaakt.'
+    t['success.save']   = 'Het menu is aangepast.'
+    t['success.delete'] = 'De geselecteerde menu\'s zijn verwijderd.'
+
+    t['errors.new']       = 'Het menu kon niet worden aangemaakt.'
+    t['errors.save']      = 'Het menu kon niet worden aangepast.'
+    t['errors.delete']    = 'Het menu met ID #%s kon niet worden verwijderd.'
+    t['errors.no_delete'] = 'U moet ten minste 1 menu specificeren ' \
+      'om te verwijderen.'
+    t['errors.invalid_menu'] = 'Het opgegeven menu is ongeldig.'
+
+    t['description'] = 'Beheren van menu\'s en menu items.'
+
+    t['permissions.show']   = 'Menu weergeven'
+    t['permissions.edit']   = 'Menu aanpassen'
+    t['permissions.new']    = 'Menu toevoegen'
+    t['permissions.delete'] = 'Menu verwijderen'
+  end
+end

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

@@ -1,37 +1,44 @@
-#:nodoc:
 module Menus
   #:nodoc:
   module Model
     ##
-    # Model used for managing groups of menu items. This model uses the 
-    # following Sequel plugins:
+    # Model used for managing groups of menu items.
     #
-    # * sluggable
-    #
-    # @author Yorick Peterse
     # @since  0.2a
     #
     class Menu < Sequel::Model
+      include Zen::Model::Helper
+
       plugin :sluggable, :source => :name, :freeze => false
 
-      # Define our relations
-      one_to_many :menu_items, :class => "Menus::Model::MenuItem"
+      one_to_many :menu_items, :class => 'Menus::Model::MenuItem'
+
+      ##
+      # Searches for a set of menus.
+      #
+      # @since  16-10-2011
+      # @param  [String] query The search query.
+      # @return [Mixed]
+      #
+      def self.search(query)
+        return filter(
+          search_column(:name, query) |
+          search_column(:html_class, query) |
+          search_column(:html_id, query)
+        )
+      end
 
       ##
       # Specifies all validates rules used when creating or updating a menu.
-      # A slug will be generated when a menu is first created but after that 
-      # they are required to ensure that they don't collide with existing slugs.
       #
-      # @author Yorick Peterse
       # @since  0.2a
       #
       def validate
-        validates_presence :name
-        validates_presence :slug unless new? 
-        validates_unique   :slug
-      
-        # Prevent people from entering random crap for class and ID names
-        validates_format(/^[a-zA-Z\-_0-9]*/, [:html_class, :html_id])
+        validates_presence(:name)
+        validates_unique(:slug)
+        validates_max_length(255, [:name, :slug, :html_class, :html_id])
+        validates_format(/^[a-zA-Z\-_0-9\s]*$/, :html_class)
+        validates_format(/^[a-zA-Z\-_0-9]*$/  , :html_id)
       end
     end # Menu
   end # Model

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

@@ -1,36 +1,60 @@
-#:nodoc:
 module Menus
   #:nodoc:
   module Model
     ##
     # Model used for managing individual menu items in a group.
-    # This model uses the following plugins:
     #
-    # * tree
-    #
-    # @author Yorick Peterse
     # @since  0.2a
     #
     class MenuItem < Sequel::Model
+      include Zen::Model::Helper
+
       plugin :tree, :order => :sort_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 
+      # Searches for a set of menu items.
+      #
+      # @since  16-10-2011
+      # @param  [String] query The search query.
+      # @return [Mixed]
+      #
+      def self.search(query)
+        return filter(
+          search_column(:name, query) |
+          search_column(:html_class, query) |
+          search_column(:html_id, query)
+        )
+      end
+
+      ##
+      # Specifies all validation rules that will be used when creating or
       # updating a menu item.
       #
-      # @author Yorick Peterse
       # @since  0.2a
       #
       def validate
-        validates_presence :name
-        validates_presence :url
-        validates_integer  [:sort_order, :parent_id]
-        
-        # Prevent people from entering random crap for class and ID names
-        validates_format(/^[a-zA-Z\-_0-9]*/, [:html_class, :html_id])
+        validates_presence([:name, :url])
+        validates_max_length(255, [:name, :url, :html_class, :html_id])
+        validates_integer([:sort_order, :parent_id])
+        validates_format(/^[a-zA-Z\-_0-9\s]*$/, :html_class)
+        validates_format(/^[a-zA-Z\-_0-9]*$/  , :html_id)
+      end
+
+      ##
+      # Sets the ID of the parent navigation item but *only* if it's not empty
+      # and not the same as the current ID.
+      #
+      # @since  0.3
+      # @param  [Fixnum] parent_id The ID of the parent navigation item.
+      #
+      def parent_id=(parent_id)
+        if !(parent_id.respond_to?(:empty?) and !parent_id.empty?) \
+        and parent_id != self.id
+          super(parent_id)
+        end
       end
     end # MenuItem
   end # Model