simple-navigation-ext 0.0.1

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

@@ -0,0 +1,37 @@
+module SimpleNavigation
+  module Renderer
+
+    # Renders an ItemContainer as a <div> element and its containing items as <a> elements.
+    # It only renders 'selected' elements.
+    #
+    # 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 Breadcrumbs < SimpleNavigation::Renderer::Base
+
+      def render(item_container)
+        content_tag(:div, a_tags(item_container).join(join_with), {:id => item_container.dom_id, :class => item_container.dom_class})
+      end
+
+      protected
+
+      def a_tags(item_container)
+        item_container.items.inject([]) do |list, item|
+          if item.selected?
+            list << link_to(item.name, item.url, {:method => item.method}.merge(item.html_options.except(:class,:id))) if item.selected?
+            if include_sub_navigation?(item)
+              list.concat a_tags(item.sub_navigation)
+            end
+          end
+          list
+        end
+      end
+
+      def join_with
+        @join_with ||= options[:join_with] || " "
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,25 @@
+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 << link_to(item.name, item.url, {:method => item.method}.merge(item.html_options))
+        end.join
+        content_tag(:div, div_content, {:id => item_container.dom_id, :class => item_container.dom_class})
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,47 @@
+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 = link_to(item.name, item.url, link_options_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(:ul, list_content, {:id => item_container.dom_id, :class => item_container.dom_class}) 
+        end
+      end
+      
+      protected
+      
+      # Extracts the options relevant for the generated link
+      #
+      def link_options_for(item)
+        special_options = {:method => item.method, :class => item.selected_class}.reject {|k, v| v.nil? }
+        link_options = item.html_options[:link]
+        return special_options unless link_options
+        opts = special_options.merge(link_options)
+        opts[:class] = [link_options[:class], item.selected_class].flatten.compact.join(' ')
+        opts.delete(:class) if opts[:class].nil? || opts[:class] == ''
+        opts
+      end
+      
+      
+    end
+  
+  end
+end

data/lib/simple_navigation/rendering.rb

@@ -0,0 +1,10 @@
+require 'simple_navigation/rendering/helpers'
+require 'simple_navigation/rendering/renderer/base'
+
+module SimpleNavigation
+  module Renderer
+    autoload :List, 'simple_navigation/rendering/renderer/list'
+    autoload :Links, 'simple_navigation/rendering/renderer/links'
+    autoload :Breadcrumbs, 'simple_navigation/rendering/renderer/breadcrumbs'
+  end
+end

data/lib/simple_navigation.rb

@@ -0,0 +1,162 @@
+# cherry picking active_support stuff
+require 'active_support/core_ext/array'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/module/attribute_accessors'
+
+require 'simple_navigation/core'
+require 'simple_navigation/rendering'
+require 'simple_navigation/adapters'
+
+require 'forwardable'
+
+# A plugin for generating a simple navigation. See README for resources on usage instructions.
+module SimpleNavigation
+  
+  mattr_accessor :adapter_class, :adapter, :config_files, :config_file_paths, :default_renderer, :registered_renderers, :root, :environment
+
+  # Cache for loaded config files
+  self.config_files = {}
+
+  # Allows for multiple config_file_paths. Needed if a plugin itself uses simple-navigation and therefore has its own config file
+  self.config_file_paths = []
+  
+  # Maps renderer keys to classes. The keys serve as shortcut in the render_navigation calls (:renderer => :list)
+  self.registered_renderers = {
+    :list         => SimpleNavigation::Renderer::List,
+    :links        => SimpleNavigation::Renderer::Links,
+    :breadcrumbs  => SimpleNavigation::Renderer::Breadcrumbs
+  }
+  
+  class << self
+    extend Forwardable
+    
+    def_delegators :adapter, :request, :request_uri, :request_path, :context_for_eval, :current_page?
+    def_delegators :adapter_class, :register
+
+    # Sets the root path and current environment as specified. Also sets the default config_file_path.
+    def set_env(root, environment)
+      self.root = root
+      self.environment = environment
+      self.config_file_paths << SimpleNavigation.default_config_file_path
+    end
+
+    # Returns the current framework in which the plugin is running.
+    def framework
+      return :rails if defined?(Rails)
+      return :padrino if defined?(Padrino)
+      return :sinatra if defined?(Sinatra)
+      raise 'simple_navigation currently only works for Rails, Sinatra and Padrino apps'
+    end
+    
+    # Loads the adapter for the current framework
+    def load_adapter
+      self.adapter_class = case framework
+      when :rails
+        SimpleNavigation::Adapters::Rails
+      when :sinatra
+        SimpleNavigation::Adapters::Sinatra
+      when :padrino
+        SimpleNavigation::Adapters::Padrino
+      end
+    end
+
+    # Creates a new adapter instance based on the context in which render_navigation has been called.
+    def init_adapter_from(context)
+      self.adapter = self.adapter_class.new(context)
+    end
+  
+    def default_config_file_path
+      File.join(SimpleNavigation.root, 'config')
+    end
+
+    # Returns true if the config_file for specified context does exist.
+    def config_file?(navigation_context = :default)
+      !!config_file(navigation_context)
+    end
+
+    # Returns the path to the config file for the given navigation context or nil if no matching config file can be found.
+    # If multiple config_paths are set, it returns the first matching path.
+    def config_file(navigation_context = :default)
+      config_file_paths.collect { |path| File.join(path, config_file_name(navigation_context)) }.detect {|full_path| File.exists?(full_path)}
+    end
+
+    # Returns the name of the config file for the given navigation_context
+    def config_file_name(navigation_context = :default)
+      prefix = navigation_context == :default ? '' : "#{navigation_context.to_s.underscore}_"
+      "#{prefix}navigation.rb"      
+    end
+    
+    # Resets the list of config_file_paths to the specified path
+    def config_file_path=(path)
+      self.config_file_paths = [path]
+    end
+
+    # Reads the config_file for the specified navigation_context and stores it for later evaluation.
+    def load_config(navigation_context = :default)
+      raise "Config file '#{config_file_name(navigation_context)}' not found in path(s) #{config_file_paths.join(', ')}!" unless config_file?(navigation_context)      
+      if self.environment == 'production'
+        self.config_files[navigation_context] ||= IO.read(config_file(navigation_context))
+      else
+        self.config_files[navigation_context] = IO.read(config_file(navigation_context))
+      end
+    end
+
+    # Returns the singleton instance of the SimpleNavigation::Configuration
+    def config
+      SimpleNavigation::Configuration.instance
+    end
+
+    # Returns the ItemContainer that contains the items for the primary navigation
+    def primary_navigation
+      config.primary_navigation
+    end
+
+    # Returns the active item container for the specified level. Valid levels are
+    # * :all - in this case the primary_navigation is returned.
+    # * :leaves - the 'deepest' active item_container will be returned
+    # * a specific level - the active item_container for the specified level will be returned
+    # * a range of levels - the active item_container for the range's minimum will be returned
+    #
+    # Returns nil if there is no active item_container for the specified level.
+    def active_item_container_for(level)
+      case level
+      when :all
+        self.primary_navigation
+      when :leaves
+        self.primary_navigation.active_leaf_container
+      when Integer
+        self.primary_navigation.active_item_container_for(level)
+      when Range
+        self.primary_navigation.active_item_container_for(level.min)
+      else
+        raise ArgumentError, "Invalid navigation level: #{level}"
+      end
+    end
+        
+    # Registers a renderer.
+    #
+    # === Example
+    # To register your own renderer:
+    #
+    #   SimpleNavigation.register_renderer :my_renderer => My::RendererClass
+    #
+    # Then in the view you can call:
+    #
+    #   render_navigation(:renderer => :my_renderer)
+    def register_renderer(renderer_hash)
+      self.registered_renderers.merge!(renderer_hash)
+    end
+    
+    private
+    
+    def apply_defaults(options)
+      options[:level] = options.delete(:levels) if options[:levels]
+      {:context => :default, :level => :all}.merge(options)
+    end
+    
+
+  end
+
+end
+
+SimpleNavigation.load_adapter

data/rails/init.rb

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

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

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe SimpleNavigation::Adapters::Padrino do
+
+  def create_adapter
+    SimpleNavigation::Adapters::Padrino.new(@context)
+  end
+  
+  before(:each) do
+    @request = stub(:request)
+    @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
+      @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,284 @@
+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)
+      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,60 @@
+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!(:protocol => 'http://', :host_with_port => 'my_host:5000')
+    end
+    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?('http://my_host:6000/full').should be_false}
+    it {@adapter.current_page?('http://my_other_host:5000/full').should be_false}
+  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