simple-navigation 3.1.1 → 3.2.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+*3.2.0
+
+* Added Renderer::Text for rendering selected navigation items without markup (useful for dynamic page titles). Credits to Tim Cowlishaw.
+* Added ability to add custom markup around item names specifying a name_generator in the config file. Thanks to Jack Dempsey.
+
 *3.1.1
 
 * Item#selected_by_url? now strips anchors from the item's url before comparing it with the current request's url. Credits to opengovernment.

data/VERSION

@@ -1 +1 @@
-3.1.1
+3.2.0

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

@@ -17,6 +17,10 @@ SimpleNavigation::Configuration.run do |navigation|
   # The example below would add a prefix to each key.
   # navigation.id_generator = Proc.new {|key| "my-prefix-#{key}"}
 
+  # If you need to add custom html around item names, you can define a proc that will be called with the name you pass in to the navigation.
+  # The example below shows how to wrap items spans.
+  # navigation.name_generator = Proc.new {|name| "<span>#{name}</span>"}
+
   # The auto highlight feature is turned on by default.
   # This turns it off globally (for the whole plugin)
   # navigation.auto_highlight = false

data/lib/simple_navigation.rb

@@ -24,7 +24,8 @@ module SimpleNavigation
   self.registered_renderers = {
     :list         => SimpleNavigation::Renderer::List,
     :links        => SimpleNavigation::Renderer::Links,
-    :breadcrumbs  => SimpleNavigation::Renderer::Breadcrumbs
+    :breadcrumbs  => SimpleNavigation::Renderer::Breadcrumbs,
+    :text         => SimpleNavigation::Renderer::Text
   }
   
   class << self

data/lib/simple_navigation/core/configuration.rb

@@ -6,7 +6,7 @@ module SimpleNavigation
   class Configuration
     include Singleton
 
-    attr_accessor :renderer, :selected_class, :autogenerate_item_ids, :id_generator, :auto_highlight
+    attr_accessor :renderer, :selected_class, :autogenerate_item_ids, :id_generator, :auto_highlight, :name_generator
     attr_reader :primary_navigation
 
     class << self
@@ -29,6 +29,7 @@ module SimpleNavigation
       @selected_class = 'selected'
       @autogenerate_item_ids = true
       @id_generator = Proc.new {|id| id.to_s }
+      @name_generator = Proc.new {|name| name}
       @auto_highlight = true
     end
 

data/lib/simple_navigation/core/item.rb

@@ -2,7 +2,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, :highlights_on
+    attr_reader :key, :url, :sub_navigation, :method, :highlights_on
     attr_writer :html_options
 
     # see ItemContainer#item
@@ -25,6 +25,18 @@ module SimpleNavigation
       end
     end
 
+    # Returns the item's name. If option :apply_generator is set to true (default),
+    # the name will be passed to the name_generator specified in the configuration.
+    #
+    def name(options = {})
+      options.reverse_merge!(:apply_generator => true)
+      if (options[:apply_generator])
+        SimpleNavigation.config.name_generator.call(@name)
+      else
+        @name
+      end
+    end
+
     # Returns true if this navigation item should be rendered as 'selected'.
     # An item is selected if
     #

data/lib/simple_navigation/rendering.rb

@@ -6,5 +6,6 @@ module SimpleNavigation
     autoload :List, 'simple_navigation/rendering/renderer/list'
     autoload :Links, 'simple_navigation/rendering/renderer/links'
     autoload :Breadcrumbs, 'simple_navigation/rendering/renderer/breadcrumbs'
+    autoload :Text, 'simple_navigation/rendering/renderer/text'
   end
-end
+end

data/lib/simple_navigation/rendering/helpers.rb

@@ -55,7 +55,7 @@ module SimpleNavigation
       options[:level] = :leaves if options[:level] == :all
       active_item_container = SimpleNavigation.active_item_container_for(options[:level])
       if active_item_container && !active_item_container.selected_item.nil?
-        active_item_container.selected_item.name
+        active_item_container.selected_item.name(:apply_generator => false)
       else
         ''
       end

data/lib/simple_navigation/rendering/renderer/text.rb

@@ -0,0 +1,26 @@
+module SimpleNavigation
+  module Renderer
+    
+    # Renders the 'chain' of selected navigation items as simple text items, joined with an optional separator (similar to breadcrumbs, but without markup).
+    #
+    class Text < SimpleNavigation::Renderer::Base
+      
+      def render(item_container)
+        list(item_container).compact.join(options[:join_with] || " ")
+      end
+
+      private
+
+      def list(item_container)
+        item_container.items.inject([]) do |array, item|
+          if item.selected?
+            array + [item.name(:apply_generator => false)] + (include_sub_navigation?(item) ? list(item.sub_navigation) : [])
+          else
+            array
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/lib/simple_navigation/core/configuration_spec.rb

@@ -52,6 +52,9 @@ describe SimpleNavigation::Configuration do
     it "should set the id_generator" do
       @config.id_generator.should_not be_nil
     end
+    it "should set the name_generator" do
+      @config.name_generator.should_not be_nil
+    end
   end
   describe 'items' do
     before(:each) do

data/spec/lib/simple_navigation/core/item_spec.rb

@@ -118,6 +118,18 @@ describe SimpleNavigation::Item do
     
   end
 
+  describe 'name' do
+    before(:each) do
+      SimpleNavigation.config.stub!(:name_generator => Proc.new {|name| "<span>#{name}</span>"})  
+    end
+    context 'default (generator is applied)' do
+      it {@item.name.should == "<span>name</span>"}
+    end
+    context 'generator is skipped' do
+      it {@item.name(:apply_generator => false).should == 'name'}
+    end
+  end
+
   describe 'selected?' do
     context 'explicitly selected' do
       before(:each) do

data/spec/lib/simple_navigation/rendering/helpers_spec.rb

@@ -39,6 +39,15 @@ describe SimpleNavigation::Helpers do
       context 'container does not have selected item' do
         it {@controller.active_navigation_item_name.should == ''}
       end
+      context 'custom name generator set' do
+        before(:each) do
+          select_item(:subnav1)
+          SimpleNavigation.config.name_generator = Proc.new {|name| "<span>name</span>"}
+        end
+        it "should not apply the generator" do
+          @controller.active_navigation_item_name(:level => 1).should == 'invoices'
+        end
+      end
     end
     context 'no active item_container for desired level' do
       it {@controller.active_navigation_item_name(:level => 5).should == ''}

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

@@ -30,6 +30,25 @@ describe SimpleNavigation::Renderer::List do
         HTML::Selector.new('li a').select(render).should have(3).entries
       end
 
+      context 'concerning item names' do
+        context 'with a custom name generator defined' do
+          before(:each) do
+            SimpleNavigation.config.name_generator = Proc.new {|name| "<span>name</span>"}
+          end
+          it "should apply the name generator" do
+            HTML::Selector.new('li a span').select(render).should have(3).entries
+          end
+        end
+        context 'no customer generator defined' do
+          before(:each) do
+            SimpleNavigation.config.name_generator = Proc.new {|name| "name"}
+          end
+          it "should apply the name generator" do
+            HTML::Selector.new('li a span').select(render).should have(0).entries
+          end
+        end
+      end
+
       context 'concerning html attributes' do
         context 'default case (no options defined for link tag)' do
           it "should pass the specified html_options to the li element" do

data/spec/lib/simple_navigation/rendering/renderer/text_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe SimpleNavigation::Renderer::Text do
+
+  describe 'render' do
+
+    def render(current_nav=nil, options={:level => :all})
+      primary_navigation = primary_container
+      select_item(current_nav)
+      setup_renderer_for SimpleNavigation::Renderer::Text, :rails, options
+      @renderer.render(primary_navigation)
+    end
+    context 'regarding result' do
+
+      it "should render the selected page" do
+        render(:invoices).should == "invoices"
+      end
+
+      context 'nested sub_navigation' do
+        it "should add an entry for each selected item" do
+          render(:subnav1).should == "invoices subnav1"
+        end
+      end
+
+      context 'with a custom seperator specified' do
+        it "should separate the items with the separator" do
+          render(:subnav1, :join_with => " | ").should == "invoices | subnav1" 
+        end
+      end
+      
+      context 'custom name generator is set' do
+        before(:each) do
+          SimpleNavigation.config.name_generator = Proc.new {|name| "<span>name</span>"}
+        end
+        it "should not apply the name generator (since it is text only)" do
+          render(:subnav1, :join_with => " | ").should == "invoices | subnav1" 
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple-navigation
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 15
   prerelease: false
   segments: 
   - 3
-  - 1
-  - 1
-  version: 3.1.1
+  - 2
+  - 0
+  version: 3.2.0
 platform: ruby
 authors: 
 - Andi Schacke
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-13 00:00:00 +01:00
+date: 2011-02-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,6 +87,7 @@ files:
 - lib/simple_navigation/rendering/renderer/breadcrumbs.rb
 - lib/simple_navigation/rendering/renderer/links.rb
 - lib/simple_navigation/rendering/renderer/list.rb
+- lib/simple_navigation/rendering/renderer/text.rb
 - rails/init.rb
 - spec/lib/simple_navigation/adapters/padrino_spec.rb
 - spec/lib/simple_navigation/adapters/rails_spec.rb
@@ -102,6 +103,7 @@ files:
 - spec/lib/simple_navigation/rendering/renderer/breadcrumbs_spec.rb
 - spec/lib/simple_navigation/rendering/renderer/links_spec.rb
 - spec/lib/simple_navigation/rendering/renderer/list_spec.rb
+- spec/lib/simple_navigation/rendering/renderer/text_spec.rb
 - spec/lib/simple_navigation_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -154,5 +156,6 @@ test_files:
 - spec/lib/simple_navigation/rendering/renderer/breadcrumbs_spec.rb
 - spec/lib/simple_navigation/rendering/renderer/links_spec.rb
 - spec/lib/simple_navigation/rendering/renderer/list_spec.rb
+- spec/lib/simple_navigation/rendering/renderer/text_spec.rb
 - spec/lib/simple_navigation_spec.rb
 - spec/spec_helper.rb