jordanyeo-simple-navigation 3.11.0

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

@@ -0,0 +1,29 @@
+module SimpleNavigation
+  module Renderer
+    
+    # Renders the navigation items as a object tree serialized as a json string, can also output raw ruby Hashes
+    class Json < SimpleNavigation::Renderer::Base
+      
+      def render(item_container)
+        results = hash_render(item_container)
+        results = results.to_json unless options[:as_hash]
+        results
+      end
+
+      private
+
+      def hash_render(item_container)
+        return nil if item_container.nil?
+        item_container.items.map do |item|
+          item_hash = { 
+            :name => item.name, 
+            :url => item.url, 
+            :selected => item.selected?,
+            :items => hash_render(item.sub_navigation)
+          }
+        end        
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module SimpleNavigation
+  module Renderer
+
+    # Renders an ItemContainer as a <div> element and its containing items as <a> elements.
+    # It adds the 'selected' class to the <a> element that is currently active.
+    #
+    # The Links renderer cannot be used to render nested navigations. If you would like it to use with nested navigations, you have to render each level separately.
+    #
+    # By default, the renderer sets the item's key as dom_id for the rendered <a> element unless the config option <tt>autogenerate_item_ids</tt> is set to false.
+    # The id can also be explicitely specified by setting the id in the html-options of the 'item' method in the config/navigation.rb file.
+    # The ItemContainer's dom_class and dom_id are applied to the surrounding <div> element.
+    #
+    class Links < SimpleNavigation::Renderer::Base
+      def render(item_container)
+        div_content = item_container.items.inject([]) do |list, item|
+          list << tag_for(item)
+        end.join(join_with)
+        content_tag(:div, div_content, {:id => item_container.dom_id, :class => item_container.dom_class})
+      end
+
+      protected
+
+      def join_with
+        @join_with ||= options[:join_with] || ""
+      end
+
+      def options_for(item)
+        {:method => item.method}.merge(item.html_options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module SimpleNavigation
+  module Renderer
+
+    # Renders an ItemContainer as a <ul> element and its containing items as <li> elements.
+    # It adds the 'selected' class to li element AND the link inside the li element that is currently active.
+    #
+    # If the sub navigation should be included (based on the level and expand_all options), it renders another <ul> containing the sub navigation inside the active <li> element.
+    #
+    # By default, the renderer sets the item's key as dom_id for the rendered <li> element unless the config option <tt>autogenerate_item_ids</tt> is set to false.
+    # The id can also be explicitely specified by setting the id in the html-options of the 'item' method in the config/navigation.rb file.
+    class List < SimpleNavigation::Renderer::Base
+      def render(item_container)
+        list_content = item_container.items.inject([]) do |list, item|
+          li_options = item.html_options.reject {|k, v| k == :link}
+          li_content = tag_for(item)
+          if include_sub_navigation?(item)
+            li_content << render_sub_navigation_for(item)
+          end
+          list << content_tag(:li, li_content, li_options)
+        end.join
+        if skip_if_empty? && item_container.empty?
+          ''
+        else  
+          content_tag((options[:ordered] ? :ol : :ul), list_content , {:id => item_container.dom_id, :class => item_container.dom_class}) 
+        end
+      end
+    end
+  end
+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/rails/init.rb

@@ -0,0 +1 @@
+SimpleNavigation.register

data/spec/lib/simple_navigation/adapters/padrino_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe SimpleNavigation::Adapters::Padrino do
+
+  def create_adapter
+    SimpleNavigation::Adapters::Padrino.new(@context)
+  end
+  
+  before(:each) do
+    @request = stub(:request)
+    @content = stub(:content)
+    @context = stub(:context, :request => @request)
+    @adapter = create_adapter
+  end
+  
+  describe 'link_to' do
+    it "should delegate to context" do
+      @context.should_receive(:link_to).with('name', 'url', :my_option => true)
+      @adapter.link_to('name', 'url', :my_option => true)
+    end
+  end
+  
+  describe 'content_tag' do
+    it "should delegate to context" do
+      @content.should_receive(:html_safe).and_return('content')
+      @context.should_receive(:content_tag).with('type', 'content', :my_option => true)
+      @adapter.content_tag('type', @content, :my_option => true)
+    end
+  end
+  
+end

data/spec/lib/simple_navigation/adapters/rails_spec.rb

@@ -0,0 +1,287 @@
+require 'spec_helper'
+
+describe SimpleNavigation::Adapters::Rails do
+
+  def create_adapter
+    SimpleNavigation::Adapters::Rails.new(@context)
+  end
+
+  before(:each) do
+    @context = stub(:context)
+    @controller = stub(:controller)
+    @context.stub!(:controller => @controller)
+    @request = stub(:request)
+    @template = stub(:template, :request => @request)
+    @adapter = create_adapter
+  end
+  
+  describe 'self.register' do
+    before(:each) do
+      ActionController::Base.stub!(:include)
+    end
+    it "should call set_env" do
+      SimpleNavigation.should_receive(:set_env).with('./', 'test')
+      SimpleNavigation.register
+    end
+    it "should extend the ActionController::Base with the Helpers" do
+      ActionController::Base.should_receive(:include).with(SimpleNavigation::Helpers)
+      SimpleNavigation.register
+    end
+    it "should install the helper methods in the controller" do
+      ActionController::Base.should_receive(:helper_method).with(:render_navigation)
+      ActionController::Base.should_receive(:helper_method).with(:active_navigation_item_name)
+      ActionController::Base.should_receive(:helper_method).with(:active_navigation_item_key)
+      ActionController::Base.should_receive(:helper_method).with(:active_navigation_item)
+      ActionController::Base.should_receive(:helper_method).with(:active_navigation_item_container)
+      SimpleNavigation.register
+    end
+    
+  end
+
+  describe 'initialize' do
+    context 'regarding setting the request' do
+      context 'template is present' do
+        before(:each) do
+          @controller.stub!(:instance_variable_get => @template)
+          @adapter = create_adapter
+        end
+        it {@adapter.request.should == @request}
+      end
+      context 'template is not present' do
+        before(:each) do
+          @controller.stub!(:instance_variable_get => nil)
+        end
+        it {@adapter.request.should be_nil}
+      end
+    end
+    context 'regarding setting the controller' do
+      it "should set the controller" do
+        @adapter.controller.should == @controller
+      end
+    end
+    context 'regarding setting the template' do
+      context 'template is stored in controller as instance_var (Rails2)' do
+        context 'template is set' do
+          before(:each) do
+            @controller.stub!(:instance_variable_get => @template)
+            @adapter = create_adapter
+          end
+          it {@adapter.template.should == @template}
+         end
+        context 'template is not set' do
+          before(:each) do
+            @controller.stub!(:instance_variable_get => nil)
+            @adapter = create_adapter
+          end
+          it {@adapter.template.should be_nil}
+        end
+      end
+      context 'template is stored in controller as view_context (Rails3)' do
+        context 'template is set' do
+          before(:each) do            
+            @controller.stub!(:view_context => @template)
+            @adapter = create_adapter
+          end
+          it {@adapter.template.should == @template}
+        end
+        context 'template is not set' do
+          before(:each) do            
+            @controller.stub!(:view_context => nil)
+            @adapter = create_adapter
+          end
+          it {@adapter.template.should be_nil}
+        end
+      end
+    end    
+  end
+  
+  describe 'request_uri' do
+    context 'request is set' do
+      context 'fullpath is defined on request' do
+        before(:each) do
+          @request = stub(:request, :fullpath => '/fullpath')
+          @adapter.stub!(:request => @request)
+        end
+        it {@adapter.request_uri.should == '/fullpath'}
+      end
+      context 'fullpath is not defined on request' do
+        before(:each) do
+          @request = stub(:request, :request_uri => '/request_uri')
+          @adapter.stub!(:request => @request)
+        end
+        it {@adapter.request_uri.should == '/request_uri'}
+      end
+    end
+    context 'request is not set' do
+      before(:each) do
+        @adapter.stub!(:request => nil)
+      end
+      it {@adapter.request_uri.should == ''}
+    end
+  end
+  
+  describe 'request_path' do
+    context 'request is set' do
+      before(:each) do
+        @request = stub(:request, :path => '/request_path')
+        @adapter.stub!(:request => @request)
+      end
+      it {@adapter.request_path.should == '/request_path'}
+    end
+    context 'request is not set' do
+      before(:each) do
+        @adapter.stub!(:request => nil)
+      end
+      it {@adapter.request_path.should == ''}
+    end
+  end
+  
+  describe 'context_for_eval' do
+    context 'controller is present' do
+      before(:each) do
+        @controller = stub(:controller)
+        @adapter.instance_variable_set(:@controller, @controller)
+      end
+      context 'template is present' do
+        before(:each) do
+          @template = stub(:template)
+          @adapter.instance_variable_set(:@template, @template)
+        end
+        it {@adapter.context_for_eval.should == @template}
+      end
+      context 'template is not present' do
+        before(:each) do
+          @adapter.instance_variable_set(:@template, nil)
+        end
+        it {@adapter.context_for_eval.should == @controller}
+      end
+    end
+    context 'controller is not present' do
+      before(:each) do
+        @adapter.instance_variable_set(:@controller, nil)
+      end
+      context 'template is present' do
+        before(:each) do
+          @template = stub(:template)
+          @adapter.instance_variable_set(:@template, @template)
+        end
+        it {@adapter.context_for_eval.should == @template}
+      end
+      context 'template is not present' do
+        before(:each) do
+          @adapter.instance_variable_set(:@template, nil)
+        end
+        it {lambda {@adapter.context_for_eval}.should raise_error}
+      end
+    end
+  end
+  
+  describe 'current_page?' do
+    context 'template is set' do
+      before(:each) do
+        @adapter.stub!(:template => @template)
+      end
+      it "should delegate the call to the template" do
+        @template.should_receive(:current_page?).with(:page)
+        @adapter.current_page?(:page)
+      end
+    end
+    context 'template is not set' do
+      before(:each) do
+        @adapter.stub!(:template => nil)
+      end
+      it {@adapter.should_not be_current_page(:page)}
+    end
+  end
+  
+  describe 'link_to' do
+    context 'template is set' do
+      before(:each) do
+        @adapter.stub!(:template => @template)
+        @adapter.stub!(:html_safe => 'safe_text')
+        @options = stub(:options)
+      end
+      it "should delegate the call to the template (with html_safe text)" do
+        @template.should_receive(:link_to).with('safe_text', 'url', @options)
+        @adapter.link_to('text', 'url', @options)
+      end
+    end
+    context 'template is not set' do
+      before(:each) do
+        @adapter.stub!(:template => nil)
+      end
+      it {@adapter.link_to('text', 'url', @options).should be_nil}
+    end
+  end
+  
+  describe 'content_tag' do
+    context 'template is set' do
+      before(:each) do
+        @adapter.stub!(:template => @template)
+        @adapter.stub!(:html_safe => 'safe_text')
+        @options = stub(:options)
+      end
+      it "should delegate the call to the template (with html_safe text)" do
+        @template.should_receive(:content_tag).with(:div, 'safe_text', @options)
+        @adapter.content_tag(:div, 'text', @options)
+      end
+    end
+    context 'template is not set' do
+      before(:each) do
+        @adapter.stub!(:template => nil)
+      end
+      it {@adapter.content_tag(:div, 'text', @options).should be_nil}
+    end
+  end
+  
+  describe 'self.extract_controller_from' do
+    context 'object responds to controller' do
+      before(:each) do
+        @context.stub!(:controller => @controller)
+      end
+      it "should return the controller" do
+        @adapter.send(:extract_controller_from, @context).should == @controller
+      end
+    end
+    context 'object does not respond to controller' do
+      before(:each) do
+        @context = stub(:context)
+      end
+      it "should return the context" do
+        @adapter.send(:extract_controller_from, @context).should == @context
+      end
+    end
+  end
+  
+  describe 'html_safe' do
+    before(:each) do
+      @input = stub :input
+    end
+    context 'input does respond to html_safe' do
+      before(:each) do
+        @safe = stub :safe
+        @input.stub!(:html_safe => @safe)
+      end
+      it {@adapter.send(:html_safe, @input).should == @safe}
+    end
+    context 'input does not respond to html_safe' do
+      it {@adapter.send(:html_safe, @input).should == @input}
+    end
+  end
+  
+  describe 'template_from' do
+    context 'Rails3' do 
+      before(:each) do
+        @controller.stub!(:view_context => 'view')
+      end
+      it {@adapter.send(:template_from, @controller).should == 'view'}
+    end
+    context 'Rails2' do
+      before(:each) do
+        @controller.instance_variable_set(:@template, 'view')
+      end
+      it {@adapter.send(:template_from, @controller).should == 'view'}
+    end
+  end
+  
+end

data/spec/lib/simple_navigation/adapters/sinatra_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe SimpleNavigation::Adapters::Sinatra do
+
+  def create_adapter
+    SimpleNavigation::Adapters::Sinatra.new(@context)
+  end
+
+  before(:each) do
+    @context = stub(:context)
+    @request = stub(:request, :fullpath => '/full?param=true', :path => '/full')
+    @context.stub!(:request => @request)
+    @adapter = create_adapter
+  end
+
+  describe 'context_for_eval' do
+    it "should raise error if no context" do
+      @adapter.stub!(:context => nil)
+      lambda {@adapter.context_for_eval}.should raise_error
+    end
+    it "should return the context" do
+      @adapter.context_for_eval.should == @context
+    end
+  end
+
+  describe 'request_uri' do
+    it {@adapter.request_uri.should == '/full?param=true'}
+  end
+
+  describe 'request_path' do
+    it {@adapter.request_path.should == '/full'}
+  end
+
+  describe 'current_page?' do
+    before(:each) do
+      @request.stub!(:scheme => 'http', :host_with_port => 'my_host:5000')
+    end
+
+    describe 'when URL is not encoded' do
+      it {@adapter.current_page?('/full?param=true').should be_true}
+      it {@adapter.current_page?('/full?param3=true').should be_false}
+      it {@adapter.current_page?('/full').should be_true}
+      it {@adapter.current_page?('http://my_host:5000/full?param=true').should be_true}
+      it {@adapter.current_page?('http://my_host:5000/full?param3=true').should be_false}
+      it {@adapter.current_page?('http://my_host:5000/full').should be_true}
+      it {@adapter.current_page?('https://my_host:5000/full').should be_false}
+      it {@adapter.current_page?('http://my_host:6000/full').should be_false}
+      it {@adapter.current_page?('http://my_other_host:5000/full').should be_false}
+    end
+
+    describe 'when URL is encoded' do
+      before(:each) do
+        @request.stub!(:fullpath => '/full%20with%20spaces?param=true', :path => '/full%20with%20spaces')
+      end
+
+      it {@adapter.current_page?('/full%20with%20spaces?param=true').should be_true}
+      it {@adapter.current_page?('/full%20with%20spaces?param3=true').should be_false}
+      it {@adapter.current_page?('/full%20with%20spaces').should be_true}
+      it {@adapter.current_page?('http://my_host:5000/full%20with%20spaces?param=true').should be_true}
+      it {@adapter.current_page?('http://my_host:5000/full%20with%20spaces?param3=true').should be_false}
+      it {@adapter.current_page?('http://my_host:5000/full%20with%20spaces').should be_true}
+      it {@adapter.current_page?('https://my_host:5000/full%20with%20spaces').should be_false}
+      it {@adapter.current_page?('http://my_host:6000/full%20with%20spaces').should be_false}
+      it {@adapter.current_page?('http://my_other_host:5000/full%20with%20spaces').should be_false}
+    end
+  end
+
+  describe 'link_to' do
+    it "should return a link" do
+      @adapter.link_to('link', 'url', :class => 'clazz', :id => 'id').should == "<a href='url' class='clazz' id='id'>link</a>"
+    end
+  end
+
+  describe 'content_tag' do
+    it "should return a tag" do
+      @adapter.content_tag(:div, 'content', :class => 'clazz', :id => 'id').should == "<div class='clazz' id='id'>content</div>"
+    end
+  end
+
+end