simple-navigation 1.2.2 → 1.3.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+rdoc
+pkg

data/CHANGELOG

@@ -1,4 +1,10 @@
-*master
+*1.3.0
+
+* render_all_levels-option allows to render all subnavigation independent from the active primary navigation ('full open tree'). Userful for javascript menus. Thanks to Richard Hulse.
+* ability to turn off automatic generation of dom_ids for the list items (autogenerate_item_ids). Credits again to Richard Hulse.
+* ability to specify dom_class for primary and secondary lists. Thanks Richard!
+
+*1.2.2
 
 * renderers now have access to request_forgery_protection stuff (this allows delete-links as navigation-items)
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
+:patch: 0
 :major: 1
-:minor: 2
-:patch: 2
+:minor: 3

data/generators/navigation_config/templates/config/navigation.rb

@@ -7,6 +7,15 @@ SimpleNavigation::Configuration.run do |navigation|
   # Specify the class that will be applied to active navigation items. Defaults to 'selected'
   # navigation.selected_class = 'your_selected_class'
   
+  # Normally only the current sub menu is renderedwhen render_navigation is called
+  # setting this to true render all submenus which is useful for javascript
+  # driven hovering menus like the jquery superfish plugin
+  # navigation.render_all_levels = true
+  
+  # Item keys are normally added to list items.
+  # this setting turns that off
+  # navigation.autogenerate_item_ids = false
+
   # Define the primary navigation
   navigation.items do |primary|
     # Add an item to the primary navigation. The following params apply:
@@ -28,6 +37,11 @@ SimpleNavigation::Configuration.run do |navigation|
     # thus you can use all the methods and vars you have available in the views.
     primary.item :key_3, 'Admin', url, :class => 'special', :if => Proc.new { current_user.admin? }
     primary.item :key_4, 'Account', url, :unless => Proc.new { logged_in? }
+
+    # you can also specify a css id or class to attach to this particular level
+    # works for all levels of the menu
+    # primary.dom_id = 'menu-id'
+    # primary.dom_class = 'menu-class'
   
   end
   

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/install.rb

@@ -0,0 +1,5 @@
+begin
+  puts IO.read(File.join(File.dirname(__FILE__), 'README'))
+rescue Exception => e
+  puts "The following error ocurred while installing the plugin: #{e.message}"
+end

data/lib/simple_navigation/configuration.rb

@@ -8,6 +8,8 @@ module SimpleNavigation
     
     attr_accessor :renderer
     attr_accessor :selected_class
+    attr_accessor :render_all_levels
+    attr_accessor :autogenerate_item_ids
     attr_reader :primary_navigation
 
     class << self
@@ -38,6 +40,8 @@ module SimpleNavigation
     def initialize
       @renderer = SimpleNavigation::Renderer::List
       @selected_class = 'selected'
+      @render_all_levels = false
+      @autogenerate_item_ids = true
     end
   
     # Yields an SimpleNavigation::ItemContainer for adding navigation items

data/lib/simple_navigation/item.rb

@@ -3,6 +3,7 @@ module SimpleNavigation
   # Represents an item in your navigation. Gets generated by the item method in the config-file.
   class Item
     attr_reader :key, :name, :url, :sub_navigation, :method
+    attr_writer :html_options
     
     # see ItemContainer#item
     def initialize(key, name, url, options, sub_nav_block)
@@ -25,7 +26,7 @@ module SimpleNavigation
     # Returns the html-options hash for the item, i.e. the options specified for this item in the config-file.
     # It also adds the 'selected' class to the list of classes if necessary. 
     def html_options(current_navigation)
-      default_options = {:id => key.to_s}
+      default_options = self.autogenerate_item_ids? ? {:id => key.to_s} : {}
       options = default_options.merge(@html_options)
       options[:class] = [@html_options[:class], self.selected_class(current_navigation)].flatten.compact.join(' ')
       options.delete(:class) if options[:class].blank? 
@@ -36,6 +37,12 @@ module SimpleNavigation
       selected?(current_navigation) ? SimpleNavigation.config.selected_class : nil
     end
     
+    
+    protected
+    
+    def autogenerate_item_ids?
+      SimpleNavigation.config.autogenerate_item_ids
+    end
         
   end
 end

data/lib/simple_navigation/item_container.rb

@@ -4,7 +4,7 @@ module SimpleNavigation
   class ItemContainer
     
     attr_reader :items
-    attr_accessor :renderer, :dom_id
+    attr_accessor :renderer, :dom_id, :dom_class
     
     def initialize #:nodoc:
       @items = []

data/lib/simple_navigation/renderer/list.rb

@@ -13,10 +13,16 @@ module SimpleNavigation
         list_content = item_container.items.inject([]) do |list, item|
           html_options = item.html_options(current_navigation)
           li_content = link_to(item.name, item.url, :class => item.selected_class(current_navigation), :method => item.method)
-          li_content << (item.sub_navigation.render(current_sub_navigation)) if include_sub_navigation && item.sub_navigation && item.selected?(current_navigation)
+          if item.sub_navigation
+            if SimpleNavigation.config.render_all_levels
+              li_content << (item.sub_navigation.render(current_sub_navigation))
+            else
+              li_content << (item.sub_navigation.render(current_sub_navigation)) if include_sub_navigation && item.selected?(current_navigation)
+            end
+          end  
           list << content_tag(:li, li_content, html_options)
         end
-        content_tag(:ul, list_content, {:id => item_container.dom_id})
+        content_tag(:ul, list_content, {:id => item_container.dom_id, :class => item_container.dom_class})
       end
       
     end

data/simple-navigation.gemspec

@@ -0,0 +1,76 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple-navigation}
+  s.version = "1.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andi Schacke"]
+  s.date = %q{2009-06-16}
+  s.description = %q{Simple Navigation is a ruby library for creating a navigation (optionally with sub navigation) for your rails app.}
+  s.email = %q{andreas.schacke@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "CHANGELOG",
+     "README",
+     "Rakefile",
+     "VERSION.yml",
+     "generators/navigation_config/USAGE",
+     "generators/navigation_config/navigation_config_generator.rb",
+     "generators/navigation_config/templates/config/navigation.rb",
+     "init.rb",
+     "install.rb",
+     "lib/simple_navigation.rb",
+     "lib/simple_navigation/configuration.rb",
+     "lib/simple_navigation/controller_methods.rb",
+     "lib/simple_navigation/helpers.rb",
+     "lib/simple_navigation/item.rb",
+     "lib/simple_navigation/item_container.rb",
+     "lib/simple_navigation/renderer/base.rb",
+     "lib/simple_navigation/renderer/list.rb",
+     "rails/init.rb",
+     "simple-navigation.gemspec",
+     "spec/lib/simple_navigation/configuration_spec.rb",
+     "spec/lib/simple_navigation/controller_methods_spec.rb",
+     "spec/lib/simple_navigation/helpers_spec.rb",
+     "spec/lib/simple_navigation/item_container_spec.rb",
+     "spec/lib/simple_navigation/item_spec.rb",
+     "spec/lib/simple_navigation/renderer/base_spec.rb",
+     "spec/lib/simple_navigation/renderer/list_spec.rb",
+     "spec/lib/simple_navigation_spec.rb",
+     "spec/spec_helper.rb",
+     "uninstall.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/andi/simple-navigation}
+  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{andi}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Simple Navigation is a ruby library for creating a navigation (optionally with sub navigation) for your rails app.}
+  s.test_files = [
+    "spec/lib/simple_navigation/configuration_spec.rb",
+     "spec/lib/simple_navigation/controller_methods_spec.rb",
+     "spec/lib/simple_navigation/helpers_spec.rb",
+     "spec/lib/simple_navigation/item_container_spec.rb",
+     "spec/lib/simple_navigation/item_spec.rb",
+     "spec/lib/simple_navigation/renderer/base_spec.rb",
+     "spec/lib/simple_navigation/renderer/list_spec.rb",
+     "spec/lib/simple_navigation_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/lib/simple_navigation/configuration_spec.rb

@@ -64,6 +64,12 @@ describe SimpleNavigation::Configuration do
     it "should set the selected_class to 'selected' as default" do
       @config.selected_class.should == 'selected'
     end
+    it "should set render_all_levels to false as default" do
+      @config.render_all_levels.should be_false
+    end
+    it "should set autogenerate_item_ids to true as default" do
+      @config.autogenerate_item_ids.should be_true
+    end
   end  
   describe 'items' do
     before(:each) do

data/spec/lib/simple_navigation/item_spec.rb

@@ -100,21 +100,47 @@ describe SimpleNavigation::Item do
     end
     
     describe 'id' do
-      context 'with id defined in options' do
+      context 'with autogenerate_item_ids == true' do
         before(:each) do
-          @options = {:id => 'my_id'}
-          @item = SimpleNavigation::Item.new(:my_key, 'name', 'url', @options, nil)
+          @item = SimpleNavigation::Item.new(:my_key, 'name', 'url', {}, nil)
+          @item.stub!(:autogenerate_item_ids? => true)
+        end
+        context 'with id defined in options' do
+          before(:each) do
+            @item.html_options = {:id => 'my_id'}
+          end
+          it {@item.html_options(:bla)[:id].should == 'my_id'}
         end
-        it {@item.html_options(:bla)[:id].should == 'my_id'}
-      end
       
-      context 'with no id definied in options (using default id)' do
+        context 'with no id definied in options (using default id)' do
+          before(:each) do
+            @item.html_options = {}
+          end
+          it {@item.html_options(:bla)[:id].should == 'my_key'}
+        end
+      end
+
+      context 'with autogenerate_item_ids == false' do
         before(:each) do
-          @options = {}
-          @item = SimpleNavigation::Item.new(:my_key, 'name', 'url', @options, nil)
+          @item = SimpleNavigation::Item.new(:my_key, 'name', 'url', {}, nil)
+          @item.stub!(:autogenerate_item_ids? => false)
+        end
+        context 'with id defined in options' do
+          before(:each) do
+            @item.html_options = {:id => 'my_id'}
+          end
+          it {@item.html_options(:bla)[:id].should == 'my_id'}
         end
-        it {@item.html_options(:bla)[:id].should == 'my_key'}
+      
+        context 'with no id definied in options (using default id)' do
+          before(:each) do
+            @item.html_options = {}
+          end
+          it {@item.html_options(:bla)[:id].should be_nil}
+        end
+     
       end
+
     end
         
   end

data/spec/lib/simple_navigation/renderer/list_spec.rb

@@ -23,6 +23,7 @@ describe SimpleNavigation::Renderer::List do
     def item_container(items)
       container = SimpleNavigation::ItemContainer.new
       container.dom_id = 'nav_dom_id'
+      container.dom_class = 'nav_dom_class'
       container.instance_variable_set(:@items, items)
       container
     end
@@ -43,6 +44,9 @@ describe SimpleNavigation::Renderer::List do
     it "the rendered ul-tag should have the specified dom_id" do
       HTML::Selector.new('ul#nav_dom_id').select(render).should have(1).entries
     end
+    it "the rendered ul-tag should have the specified class" do
+      HTML::Selector.new('ul.nav_dom_class').select(render).should have(1).entries
+    end
     it "should render a li tag for each item" do
       HTML::Selector.new('li').select(render).should have(3).entries
     end
@@ -88,6 +92,26 @@ describe SimpleNavigation::Renderer::List do
       it "should be possible to identify sub items using an html selector (using ids)" do
         HTML::Selector.new('#invoices #subnav1').select(render(:invoices, true)).should have(1).entries
       end
+      context 'render_all_levels = false' do
+        before(:each) do
+          SimpleNavigation.config.render_all_levels = false
+        end
+        it "should not render the invoices submenu if the user-primary is active" do
+          HTML::Selector.new('#invoices #subnav1').select(render(:users, true)).should be_empty
+          HTML::Selector.new('#invoices #subnav2').select(render(:users, true)).should be_empty
+        end
+      end
+      
+      context 'render_all_levels = true' do
+        before(:each) do
+          SimpleNavigation.config.render_all_levels = true
+        end
+        it "should render the invoices submenu even if the user-primary is active" do
+          HTML::Selector.new('#invoices #subnav1').select(render(:users, true)).should have(1).entry
+          HTML::Selector.new('#invoices #subnav2').select(render(:users, true)).should have(1).entry
+        end
+      end
+      
     end
     
   end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-14 00:00:00 +02:00
+date: 2009-06-16 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -22,12 +22,16 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
+- .gitignore
 - CHANGELOG
+- README
 - Rakefile
 - VERSION.yml
 - generators/navigation_config/USAGE
 - generators/navigation_config/navigation_config_generator.rb
 - generators/navigation_config/templates/config/navigation.rb
+- init.rb
+- install.rb
 - lib/simple_navigation.rb
 - lib/simple_navigation/configuration.rb
 - lib/simple_navigation/controller_methods.rb
@@ -37,6 +41,7 @@ files:
 - lib/simple_navigation/renderer/base.rb
 - lib/simple_navigation/renderer/list.rb
 - rails/init.rb
+- simple-navigation.gemspec
 - spec/lib/simple_navigation/configuration_spec.rb
 - spec/lib/simple_navigation/controller_methods_spec.rb
 - spec/lib/simple_navigation/helpers_spec.rb
@@ -46,7 +51,7 @@ files:
 - spec/lib/simple_navigation/renderer/list_spec.rb
 - spec/lib/simple_navigation_spec.rb
 - spec/spec_helper.rb
-- README
+- uninstall.rb
 has_rdoc: true
 homepage: http://github.com/andi/simple-navigation
 post_install_message: