semantic_navigation 0.0.13 → 0.0.14

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - ruby-head
+gemfile:
+  - gemfiles/rails3  

data/Changelog.md

@@ -1,3 +1,10 @@
+### 0.0.14
+* Now in render_if proc there is possibility to catch self(rendering element)
+* Items accept procs for links definitions
+* Fixed bug in active_item_for method
+* active_item_for now returns empty string instead of nil then no active items
+* added multiname support for items
+
 ### 0.0.13 / August 14, 2012
 
 * Bugfixes for support array of route like links

data/README.md

@@ -1,13 +1,20 @@
 This is semantic_navigation gem
 
 ###Purpose
-This gem generates the navigation for your Rails app.
-Really customizable and simple to use.
-Using this gem you have 4 types of renderers: menu, breadcrumb, tabs, and, pills
+Forget fat layouts, views and controllers. This gem will do all the menu staff for you.
+You simply just have to generate configuration file, fill it with your menu hierarchy and renderer it wherever you want.
 
-You can define different menus and render them separate.
+Symply and customizable it will make for you all the routings you were spending a lot of time before.
 
-Now with simple integration with a twitter-bootstrap CSS framework.
+* semantic_navigation supports defining as many separate menus as you want and they can be as deep as you need.
+* supports different styles of url definitions ('route#like', :symbols, 'strings', {hash: 'like'})
+* supports and array of urls for one item
+* supports procs for item name definitions - so you can have dynamic names
+* supports render conditions defined as proc where you have access to controller class variables, request params and even to the rendering item
+* supports multiname definitions where you can set the custom name for each renderer.
+* has renderers compatible with bootstrap - so if you using bootstrap it will be simplier
+* supports controller default styles overriding both - from configuration and view file
+* supports custom renderers
 
 ###How to install
 
@@ -33,9 +40,9 @@ Configure your navigation in config/semantic_navigation.rb
 <pre><code>
 SemanticNavigation::Configuration.run do
   navigate :root_menu do
-    item :header_item, nil, :name => 'Header'
+    header :header_item, :name => 'Header'
     item :first_item, '#', :name => 'First Item', :ico => :tag
-    item :divide
+    divider
     item :second_item, '#', :name => 'Second Item', :ico => :user
   end
 end
@@ -46,7 +53,17 @@ And try to render it in your layout(code in haml):
 .well
   = navigation_for :root_menu, :as => :bootstrap_list
 </code></pre>
+or
+<pre><code>
+.well
+  = bootstrap_list_for :root_menu
+</code></pre>
 
 Render the navigation using the semantic_navigation helper methods and options for them.
 
-For the information of how to configure and render your navigation read the <a href='https://github.com/fr33z3/semantic_navigation/wiki'>Wiki</a>
+For the information of how to configure and render your navigation read the <a href='https://github.com/fr33z3/semantic_navigation/wiki'>Wiki</a>
+
+Dependence:
+
+* Ruby >= 1.9.2
+* Rails >= 3.0.0 

data/Rakefile

@@ -2,3 +2,5 @@ require 'rspec/core/rake_task'
 require "bundler/gem_tasks"
 
 RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/gemfiles/rails3

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem 'semantic_navigation', :path => '..'
+gem 'rails', '>=3.1.0'
+gem 'rspec'
+gem 'rake'
+gem 'simplecov'

data/lib/generators/semantic_navigation/install/templates/semantic_navigation.rb

@@ -1,23 +1,27 @@
+#encoding: utf-8
 SemanticNavigation::Configuration.run do
   # Read wiki https://github.com/fr33z3/semantic_navigation/wiki to lear about
   # semantic_navigation configuration
   
+  #Override renderer default styles:
   #styles_for :list do
   #  show_navigation_active_class true
   #  navigation_active_class [:some_active_class]
   #end
   
+  # You can register your custom renderer:
   #register_renderer :some_renderer, SomeRendererClass
   
+  # The example of the navigation:
   #navigate :navigation do
-  #  item :header_item, :name => 'Header Item'
+  #  header :header_item, :name => 'Header Item'
   #  item :first_item, :first_item_route, :ico => 'user' do 
   #    item :sub_item, :sub_item_route do
   #      item :sub_sub_item, :sub_sub_item_route
   #    end
   #    item :second_sub, :second_sub_route, :ico => 'user'
   #  end
-  #  item :divide
+  #  divider
   #  item :second_item, :second_item_route
   #end
   

data/lib/semantic_navigation/configuration.rb

@@ -25,6 +25,7 @@ module SemanticNavigation
         renderer.instance_eval &@@render_styles[renderer_name]
       end
       options.keys.each{|key| renderer.send "#{key}=", options[key]}
+      renderer.name = renderer_name      
       navigation = @@navigations[menu_id]
       navigation.mark_active
       navigation.render(renderer)
@@ -54,6 +55,10 @@ module SemanticNavigation
     def self.view_object
       @@view_object
     end
+
+    def self.view_object=(view_object)
+      @@view_object = view_object
+    end
     
     def self.navigation(name)
       @@navigations[name]

data/lib/semantic_navigation/core/base.rb

@@ -2,11 +2,11 @@ module SemanticNavigation
   module Core
     class Base      
       
-      attr :id, :level, :classes, :active
+      attr_accessor :id, :level, :classes, :active
       attr_writer :render_if
       
       def render_if
-        !@render_if.nil? ? view_object.instance_eval(&@render_if) : true
+        !@render_if.nil? ? view_object.instance_exec(self, &@render_if) : true
       end
       
       def initialize(options, level)

data/lib/semantic_navigation/core/leaf.rb

@@ -1,32 +1,50 @@
 module SemanticNavigation
   module Core
     class Leaf < Base
-      attr :link_classes
+      attr_accessor :link_classes
       
       def url
-        @url.is_a?(Array) ? @url.first : @url
+        urls.first
       end
 
       def initialize(options, level)
         super options, level
       end
       
-      def name
-        rendering_name = @name || I18n.t("#{@i18n_name}.#{@id}", :default => '')
-        if rendering_name.is_a?(Proc)
-          view_object.instance_eval(&rendering_name).to_s
-        else
-          rendering_name
-        end
+      def name(renderer_name = nil)
+        rendering_name = @name
+        rendering_name = rendering_name[renderer_name.to_sym] || rendering_name[:default] if rendering_name.is_a?(Hash)
+        rendering_name = view_object.instance_eval(&rendering_name).to_s if rendering_name.is_a?(Proc)
+        rendering_name || i18n_name(renderer_name)
       end
       
       def mark_active
         if @url
-          @active = [@url].flatten(1).map{|u| current_page?(u) rescue false}.reduce(:"|")
+          @active = urls.map{|u| current_page?(u) rescue false}.reduce(:"|")
         else
           @active = false
         end
       end
+
+      private
+
+      def i18n_name(renderer_name = nil)
+        name = I18n.t("#{@i18n_name}.#{@id}", :default => '')
+        if name.is_a? Hash
+          name = name[renderer_name.to_sym] || name[:default]
+        end
+        name || ''
+      end
+
+      def urls
+        [@url].flatten(1).map do |url|
+          if url.is_a?(Proc)
+            view_object.instance_eval(&url) rescue ''
+          else
+            url
+          end
+        end
+      end
       
     end    
   end

data/lib/semantic_navigation/core/navigation.rb

@@ -1,7 +1,7 @@
 module SemanticNavigation
   module Core
     class Navigation < Base
-      attr :sub_elements
+      attr_accessor :sub_elements
       
       def initialize(options, level = 0)
         @sub_elements = []
@@ -24,6 +24,13 @@ module SemanticNavigation
           element.instance_eval &block
         else
           element = Leaf.new(options, @level+1)
+          #Deprecation warning message
+          #TODO:Should be deleted after moving the header and divider definition via item
+          if element.url.nil? && !element.name.empty?
+            puts 'Warning: do not define `headers` using `item` method. Use `header` instead. This logic will be deprecated soon.'
+          elsif element.url.nil? && element.name.empty?
+            puts 'Warning: do not define `dividers` using `item` method. Use `divider` instead. This logic will be deprecated soon.'
+          end
         end
         
         @sub_elements.push element
@@ -64,10 +71,10 @@ module SemanticNavigation
         if url.is_a? String
           controller_name, action_name = url.split('#')
           if controller_name && action_name
-            url = {:controller => controller_name, :action => action_name}
-          end
+            decoded_url = {:controller => controller_name, :action => action_name}  
+          end        
         end
-        url
+        decoded_url || url
       end
       
     end

data/lib/semantic_navigation/core/node.rb

@@ -1,10 +1,10 @@
 module SemanticNavigation
   module Core
     class Node < Navigation      
-      attr :link_classes, :node_classes
+      attr_accessor :link_classes, :node_classes
       
       def url
-        @url.is_a?(Array) ? @url.first : @url
+        urls.first
       end
       
       def initialize(options, level)
@@ -12,25 +12,37 @@ module SemanticNavigation
         super options, level
       end
       
-      def name
-        rendering_name = @name || i18n_name
-        if rendering_name.is_a?(Proc)
-          view_object.instance_eval(&rendering_name).to_s
-        else
-          rendering_name
-        end
+      def name(renderer_name = nil)
+        rendering_name = @name
+        rendering_name = rendering_name[renderer_name.to_sym] || rendering_name[:default] if rendering_name.is_a?(Hash)
+        rendering_name = view_object.instance_eval(&rendering_name).to_s if rendering_name.is_a?(Proc)
+        rendering_name || i18n_name(renderer_name)
       end
       
       def mark_active
         @sub_elements.each{|element| element.mark_active}
-        @active = [@url].flatten(1).map{|u| current_page?(u) rescue false}.reduce(:"|")
+        @active = urls.map{|u| current_page?(u) rescue false}.reduce(:"|")
         @active |= !@sub_elements.find{|element| element.active}.nil?
       end
             
       private
       
-      def i18n_name
-        I18n.t("#{@i18n_name}.#{@id}", :default => '')
+      def i18n_name(renderer_name = nil)
+        name = I18n.t("#{@i18n_name}.#{@id}", :default => '')
+        if name.is_a? Hash
+          name = name[renderer_name.to_sym] || name[:default]
+        end
+        name || ''
+      end
+
+      def urls
+        [@url].flatten(1).map do |url|
+          if url.is_a?(Proc)
+            view_object.instance_eval(&url) rescue ''
+          else
+            url
+          end          
+        end
       end
       
     end

data/lib/semantic_navigation/helper_methods.rb

@@ -7,13 +7,15 @@ module SemanticNavigation::HelperMethods
   end
   
   def active_item_for(name, level = nil)
+    SemanticNavigation::Configuration.view_object = self
     navigation = SemanticNavigation::Configuration.navigation(name)
+    navigation.mark_active
     item = navigation
     while !item.is_a?(SemanticNavigation::Core::Leaf) &&
           !item.sub_elements.find{|e| e.active}.nil? && 
           (!level.nil? ? item.level < level : true)
       item = item.sub_elements.find{|e| e.active}
     end
-    item.name if item != navigation
+    item != navigation ? item.name(:active_item_for) : ''
   end
 end

data/lib/semantic_navigation/renderers/bread_crumb.rb

@@ -25,7 +25,7 @@ module SemanticNavigation
       def node(object)
         content_tag(:li, nil, :id => show_id(:leaf, object.id),
                               :class => merge_classes(:leaf, object.active, object.classes)) do
-          link_to(object.name, object.url, :id => show_id(:link, object.id),
+          link_to(object_name(object), object.url, :id => show_id(:link, object.id),
                                            :class => merge_classes(:link, object.active, object.link_classes))
         end +
         content_tag(:li) do
@@ -38,10 +38,10 @@ module SemanticNavigation
         content_tag :li, nil, :id => show_id(:leaf, object.id),
                               :class => merge_classes(:leaf, object.active, object.classes) do
           if last_as_link
-            link_to object.name, object.url, :id => show_id(:link, object.id),
+            link_to object_name(object), object.url, :id => show_id(:link, object.id),
                                            :class => merge_classes(:link, object.active, object.link_classes)
           else
-            object.name
+            object_name(object)
           end
         end
       end

data/lib/semantic_navigation/renderers/list.rb

@@ -18,7 +18,7 @@ module SemanticNavigation
       def node(object)
         content_tag :li, nil, :id => show_id(:leaf, object.id),
                               :class => merge_classes(:leaf, object.active, object.classes) do
-          link_to(object.name, object.url, :id => show_id(:link, object.id),
+          link_to(object_name(object), object.url, :id => show_id(:link, object.id),
                                            :class => merge_classes(:link, object.active, object.link_classes))+
           yield
         end 
@@ -34,7 +34,7 @@ module SemanticNavigation
       def leaf(object)
         content_tag :li, nil, :id => show_id(:leaf, object.id),
                               :class => merge_classes(:leaf, object.active, object.classes) do
-          link_to object.name, object.url, :id => show_id(:link, object.id),
+          link_to object_name(object), object.url, :id => show_id(:link, object.id),
                                            :class => merge_classes(:link, object.active, object.link_classes)
         end
       end

data/lib/semantic_navigation/renderers/render_helpers.rb

@@ -29,7 +29,7 @@ module SemanticNavigation
       end
       
       module ClassMethods
-        
+
         def style_accessor(hash)
           hash.keys.each do |key|
             class_eval "
@@ -66,7 +66,7 @@ module SemanticNavigation
       end
       
       module InstanceMethods  
-        attr_accessor :from_level, :until_level, :except_for
+        attr_accessor :from_level, :until_level, :except_for, :name
         
         def level=(level)
           @from_level = level
@@ -103,6 +103,10 @@ module SemanticNavigation
         def show_id(name, id)
           id if send("show_#{name}_id")
         end
+
+        def object_name(object)
+          object.name(self.name)
+        end
         
       end
   

data/lib/semantic_navigation/twitter_bootstrap/breadcrumb.rb

@@ -33,7 +33,7 @@ module SemanticNavigation
         content_tag(:li, nil, :id => show_id(:leaf, object.id),
                               :class => merge_classes(:leaf, object.active, object.classes)) do
           [object.ico ? content_tag(:i,nil,:class => "icon-#{object.ico}") : ''.html_safe,
-          link_to(object.name, object.url, :id => show_id(:link, object.id),
+          link_to(object_name(object), object.url, :id => show_id(:link, object.id),
                                            :class => merge_classes(:link, object.active, object.link_classes)),
           content_tag(:span, nil, :class=> [:divider]) {breadcrumb_separator}].sum
         end +
@@ -45,10 +45,10 @@ module SemanticNavigation
                               :class => merge_classes(:leaf, object.active, object.classes) do
           [object.ico ? content_tag(:i,nil,:class => "icon-#{object.ico}") : ''.html_safe,
           if last_as_link
-            link_to(object.name, object.url, :id => show_id(:link, object.id),
-                                           :class => merge_classes(:link, object.active, object.link_classes))
+            link_to(object_name(object), object.url, :id => show_id(:link, object.id),
+                                             :class => merge_classes(:link, object.active, object.link_classes))
           else
-            object.name
+            object_name(object)
           end].sum
         end
       end

data/lib/semantic_navigation/twitter_bootstrap/list.rb

@@ -24,9 +24,9 @@ module SemanticNavigation
       def node(object)
         if object.ico
           name = [content_tag(:i,nil,:class => "icon-#{object.ico}"),
-                  object.name].sum
+                  object_name(object)].sum
         else
-          name = object.name
+          name = object_name(object)
         end
         
         content_tag :li, nil, :id => show_id(:leaf, object.id),
@@ -45,7 +45,7 @@ module SemanticNavigation
       end
       
       def leaf(object)
-        if object.name.empty? && object.url.nil?
+        if object_name(object).empty? && object.url.nil?
           classes = 'divider'
         elsif object.url.nil?
           classes = 'nav-header'
@@ -55,9 +55,9 @@ module SemanticNavigation
         
         if object.ico
           name = [content_tag(:i,nil,:class => "icon-#{object.ico}"),
-                  object.name].sum
+                  object_name(object)].sum
         else
-          name = object.name
+          name = object_name(object)
         end
                 
         content_tag :li, nil, :id => show_id(:leaf, object.id),
@@ -66,7 +66,7 @@ module SemanticNavigation
             name
           else
             link_to name, object.url, :id => show_id(:link, object.id),
-                                             :class => merge_classes(:link, object.active, object.link_classes)            
+                                      :class => merge_classes(:link, object.active, object.link_classes)            
           end
         end
       end