semantic_navigation 0.0.1 → 0.0.2

data/Changelog.md

@@ -0,0 +1,17 @@
+### 0.0.2 / Unknown
+
+* Definition of default render options (active_class and show_ids)
+* Definition of the private render options to each menu item
+* Definition of default option that says render submenu always or only then parent is active
+* Raise error on undefined helper methods calls
+* Raise error on undefined menu render calls
+* Added helper method to render active name item
+* Added helper method to render active item parent name
+* Changed helper method to render menu
+* Added prefixes for menu, item, name ids
+* Added conditions for rendering (function show_if)
+* Added breadcrumbs rendering
+
+### 0.0.1 / December 23th, 2011
+
+* Initial release [Sergey Gribovski]

data/README.md

@@ -8,7 +8,7 @@ The purpose of this gem is to generate simple and usefull navigation. You can de
 
 Write the gem dependency in your Gemfile:
 ```
-gem 'semantic_navigation', :git => 'git://github.com/fr33z3/semantic_navigation.git'
+gem 'semantic_navigation'
 ```
 
 Make the install by bundler

data/lib/semantic_navigation/configuration.rb

@@ -3,34 +3,44 @@ require 'semantic_navigation/item'
 module SemanticNavigation
   class Configuration
     
-    attr_accessor :active_class, :create_ids, :show_submenu 
-
-    class << self
-      def run
-        instance = self.new
-        yield instance if block_given?
-        instance
-      end
+    def self.run
+      instance = self.new
+      yield instance if block_given?
+      instance
     end
 
     def initialize
-      @active_class = 'active'
-      @create_ids = true
-      @show_submenu = false
       @menus = {}
     end
   
     def method_missing(name, *args)
-      menu = Item.new(name.to_s, args, self)
-      @menus.merge!({name => menu})
-      yield menu if block_given?
+      name = name.to_s
+      if name.chomp('=') != name
+        SemanticNavigation::Item.set_default_option(name.chop,args[0])
+      else  
+        menu = Item.new(name, args, nil)
+        @menus.merge!({name.to_sym => menu})
+        yield menu if block_given?
+      end
     end
 
-    def render(view_object, name)
+    def render(name, command = :render)
       if @menus[name.to_sym]
-        return @menus[name.to_sym].render(view_object)
+        if command == :render
+          return @menus[name.to_sym].render
+        elsif command == :active_item_name
+          item = @menus[name.to_sym].find_active_item
+          !item.nil? ? item.name : ''
+        elsif command == :active_item_parent_name
+          item = @menus[name.to_sym].find_active_item
+          !item.nil? && !item.parent.nil? ? item.parent.name : ''
+        elsif command == :breadcrumb
+          return @menus[name.to_sym].render_breadcrumb
+        else
+          raise NoMethodError.new("Wrong menu render parameter:`#{command.to_s}`")
+        end
       else
-        return nil  
+        raise NoMethodError.new("No such menu name:`#{name}` check your #{Rails.root}/config/semantic_navigation.rb) file")
       end
     end
 

data/lib/semantic_navigation/core/procs.rb

@@ -0,0 +1,15 @@
+module SemanticNavigation
+  module Core
+    module Procs
+    
+      def show_if
+        @condition = Proc.new
+      end
+      
+      def render_item?
+        !@condition.nil? ? @condition.call : true
+      end
+           
+    end
+  end
+end

data/lib/semantic_navigation/core/render.rb

@@ -0,0 +1,67 @@
+module SemanticNavigation
+  module Core
+    module Render
+      
+      def render
+        return nil if !render_item?
+        if @parent
+          sub = @active || show_submenu? ? render_submenu : nil
+          link = view_object.link_to @name, @url_options, :class => classes, :id => a_id
+          view_object.content_tag(:li, link + sub, :id => li_id, :class => classes)
+        else
+          render_submenu
+        end  
+      end
+      
+      def set_as_active
+        @active = true
+        @parent.set_as_active if @parent
+      end
+      
+      def find_active_item
+        item = nil
+        if active?
+          item = self
+        elsif @active
+          @sub_items.each do |s|
+            buff = s.find_active_item
+            item = buff if !buff.nil?
+          end
+        end
+        item
+      end 
+      
+      def render_breadcrumb
+        breadcrumb = nil
+        if @active
+          if @name
+            link = view_object.link_to @name, @url_options, :id => a_id
+            breadcrumb = view_object.content_tag(:li, link + breadcrumb_name, :id => li_id) if @name  
+          end
+          buff = @sub_items.map{|s| s.render_breadcrumb}.find{|s| !s.nil?}
+          if !breadcrumb.nil?
+            breadcrumb += buff if !buff.nil?
+          else
+            breadcrumb = buff
+          end
+        end
+        breadcrumb = view_object.content_tag(:ul, breadcrumb, :id => ul_id, :class => breadcrumb_classes) if !@parent
+        breadcrumb
+      end
+      
+      private
+  
+      def render_submenu
+        if @sub_items.count > 0
+          sub = @sub_items.map{|s| s.render}.sum
+          view_object.content_tag(:ul, sub, :id => ul_id) if sub != 0
+        end
+      end
+    
+      def active?
+        !@parent.nil? ? view_object.current_page?(@url_options) : false
+      end
+    end  
+  end
+end
+

data/lib/semantic_navigation/helper_methods.rb

@@ -1,11 +1,12 @@
 module SemanticNavigation::HelperMethods
   
-  def method_missing(name)
-    name_parts = name.to_s.split('_')
-    if (name_parts.count == 3 && name_parts[0] == 'render' && name_parts[2] == 'menu')
-      semantic_navigation_config.render(self, name_parts[1])
+  def method_missing(name, command = :render)
+    name = name.to_s
+    if name[0..6] == 'render_'
+      SemanticNavigation::Item.set_default_option('view_object',self)
+      semantic_navigation_config.render(name[7..-1], command)
     else
-      super
+      raise NoMethodError.new("NoMethodError:#{name}")
     end
   end
 

data/lib/semantic_navigation/item.rb

@@ -1,15 +1,42 @@
+require 'semantic_navigation/core/render'
+require 'semantic_navigation/core/procs'
 module SemanticNavigation
   class Item
- 
+    include Core::Render
+    include Core::Procs
+    
+    #Menu variables
+    @@active_class = 'active'
+    @@show_active_class = true
+    @@show_menu_id = true
+    @@show_submenu = false
+    @@menu_prefix = ''
+    
+    #Item variables
+    @@item_perfix = ''
+    @@name_prefix = ''
+    @@show_name_id = true
+    @@show_item_id = true
+    
+    #Breadcrumb variables
+    @@breadcrumb_divider = "/"
+        
+    
+    
+    attr_accessor :active_class, :show_active_class, :show_menu_id,
+                  :show_item_id, :show_name_id, :show_submenu,
+                  :menu_prefix, :item_prefix, :name_prefix,
+                  :item_classes,
+                  :name, :parent
+    
     def initialize(id, args, parent)
       @item_id = id
       @name = args.first
       @url_options = args.second
       @parent = parent
-      
       @sub_items = []
-      @active_class = 'active'
-      @active = false
+      
+      set_as_active if active?
     end
 
     def method_missing(name, *args)
@@ -18,44 +45,59 @@ module SemanticNavigation
       yield item if block_given?
     end
 
-    def render(view_object)
-      @view_object = view_object
-      if parent
-        set_as_active if active?
-        sub = render_subitems
-        link = view_object.link_to @name, @url_options, :class => classes, :id => @item_id
-        view_object.content_tag(:li, link + sub, :id => @item_id, :class => classes)
-      else
-        render_subitems
-      end  
-    end
-
-    def set_as_active
-      @active = true
-      parent.set_as_active if parent
+    def self.set_default_option(name, value)
+      class_variable_set("@@#{name}".to_sym, value)
     end
     
     private
     
-    def render_subitems
-      if @sub_items.count > 0
-        sub = @sub_items.map{|s| s.render(@view_object)}.sum
-        @view_object.content_tag(:ul, sub, :id => @item_id)
-      end
+    def ul_id
+      prefix = @menu_prefix.nil? ? @@menu_prefix : @menu_prefix
+      flag = @show_menu_id.nil? ? @@show_menu_id : @show_menu_id
+      flag ? prefix+@item_id : nil
+    end
+    
+    def li_id
+      prefix = @item_prefix.nil? ? @@item_prefix : @item_prefix
+      flag = @show_item_id.nil? ? @@show_item_id : @show_item_id
+      flag ? prefix+@item_id : nil
+    end
+    
+    def a_id
+      prefix = @name_prefix.nil? ? @@name_prefix : @name_prefix
+      flag = @show_name_id.nil? ? @@show_name_id : @show_name_id
+      flag ? prefix+@item_id : nil
     end
     
     def classes
-      if @active
-        @active_class
+      class_array = []
+      class_array << item_classes
+      active_class = @active_class.nil? ? @@active_class : @active_class
+      flag = @show_active_class.nil? ? @@show_active_class : @show_active_class
+      if @active && flag
+        class_array << active_class
       end
+      class_array.flatten.join(' ')
     end
     
-    def active?
-      @view_object.current_page?(@url_options)
+    def view_object
+      @@view_object
     end
     
-    def parent
-      @parent.is_a?(SemanticNavigation::Item) ? @parent : nil
+    def show_submenu?
+      @show_submenu.nil? ? @@show_submenu : @show_submenu
+    end
+    
+    def breadcrumb_name
+      @@breadcrumb_divider.html_safe
+    end
+    
+    def breadcrumb_classes
+      if @@breadcrumb_classes.is_a? Array
+        return @@breadcrumb_classes.join(' ')
+      else
+        return @@breadcrumb_classes
+      end
     end
     
   end

data/lib/semantic_navigation/version.rb

@@ -1,3 +1,3 @@
 module SemanticNavigation
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/tasks/templates/semantic_navigation.rb

@@ -1,15 +1,57 @@
 #This file need to create the navigation in your app.
+#You can learn more about how to customize your menu reading the wiki
+#Wiki pages link: https://github.com/fr33z3/semantic_navigation/wiki/_pages
 SemanticNavigation::Configuration.run do |config|
 
-  #That's the creation of the navigation menu
-  config.navigation do |n|
-    n.main 'Main', :controller => :dashboard, :action => :index
-    n.about 'About', :controller => :about, :action => :index do |a|
-      a.company 'About company', :controller => :about, :action => :company
-      a.employes 'About our employes', :controller => :about, :action => :employes
-    end
-    n.feed_back 'Feedback', :controller => :feed_back, :action => :index
-  end
-  #You can render this menu by calling method render_navigation_menu
+  #What's the name of the active menu class will be (the dafault is 'active')
+  #config.active_class = 'active';
+  
+  #Do you want to show active class? (default = true)
+  #config.show_active_class = true
+  
+  #Create the item ids (in the `li` tag) automatically (default = true)?
+  #config.show_item_id = true
+  
+  #Create the menu ids (in the `ul` tag) automatically (default = true)?
+  #config.show_menu_id = true
+  
+  #Create the name id (in the `a` tag) automatically (default = true)?
+  #config.show_name_id = true
+  
+  #Show the submenu only when the menu is active (default = false)
+  #config.show_submenu = false
+  
+  #Add menu prefix (`ul` tag)
+  #config.menu_prefix = 'menu_'
+  
+  #Add item prefix (`li` tag)
+  #config.item_prefix = 'item_'
+  
+  #Add name preifx (`a` tag)
+  #config.name_prefix = 'name_'
+  
+  #Define breadcrumb divider
+  #config.breadcrumb_divider = "<span class ='divider'>/</span>"
+  
+  #Define bread crumb classes
+  #config.breadcrumb_classes = "breadcrumb"
+  
+  #That's how you can create your userbar menu
+  #config.userbar do |userbar|
+  #  userbar.signin :controller => :session, :action => :signin, :if => current_user.nil?
+  #  userbar.signout :controller => :session, :action => :signout, :if => !current_user.nil?
+  #end
+  #so you can use the helper 'render_userbar_menu' to render it.
+
+  #That's the creation of the `navigation` menu
+  #config.navigation {|n|
+  #  n.dashboard 'Dashboard', :controller => :dashboard, :action => :index do |d|
+  #    d.first 'First', :controller => :first, :action => :index do |f|
+  #      f.sub_first 'Sub First', sub_first_index_path
+  #      f.sub_second 'Sub Second', :controller => :sub_second, :action => :index
+  #    end
+  #  end
+  #  n.second 'Help', :controller => :second, :action => :index
+  #}
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: semantic_navigation
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Sergey Gribovski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-22 00:00:00 Z
+date: 2011-12-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -60,11 +60,14 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- Changelog.md
 - Gemfile
 - README.md
 - Rakefile
 - lib/semantic_navigation.rb
 - lib/semantic_navigation/configuration.rb
+- lib/semantic_navigation/core/procs.rb
+- lib/semantic_navigation/core/render.rb
 - lib/semantic_navigation/helper_methods.rb
 - lib/semantic_navigation/item.rb
 - lib/semantic_navigation/railtie.rb