strikeroff-simple-navigation 2.0.2

data/lib/simple_navigation/renderer/list.rb

@@ -0,0 +1,31 @@
+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, it renders another <ul> containing the sub navigation inside the active <li> element.
+    #
+    # If the SimpleNavigation.config.render_all_levels option is set to true, it always renders all levels of navigation (fully expanded tree).
+    #
+    # 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, include_sub_navigation=false, options={})
+        list_content = item_container.items.inject([]) do |list, item|
+          html_options = item.html_options
+          li_content = link_to(item.name, item.url, :class => item.selected_class, :method => item.method)
+          if item.sub_navigation
+            if SimpleNavigation.config.render_all_levels || (include_sub_navigation && item.selected?) || options[:all]
+              li_content << (item.sub_navigation.render(include_sub_navigation))
+            end
+          end
+          list << content_tag(:li, li_content, html_options)
+        end
+        content_tag(:ul, list_content.join, {:id => item_container.dom_id, :class => item_container.dom_class})
+      end
+
+    end
+  end
+end

data/lib/simple_navigation.rb

@@ -0,0 +1,118 @@
+# Load all source files (if this is not done explicitly some naming conflicts may occur if rails app has classes with the same name)
+require 'simple_navigation/configuration'
+require 'simple_navigation/helpers'
+require 'simple_navigation/controller_methods'
+require 'simple_navigation/item'
+require 'simple_navigation/item_container'
+require 'simple_navigation/renderer/base'
+require 'simple_navigation/renderer/list'
+
+# A plugin for generating a simple navigation. See README for resources on usage instructions.
+module SimpleNavigation
+
+  mattr_accessor :config_files, :config_file_path, :controller, :template, :explicit_current_navigation
+
+  self.config_files = {}
+  
+  class << self
+  
+    # Reads the config_file for the specified navigation_context and stores it for later evaluation.
+    def load_config(navigation_context = :default)
+      raise "config_file_path is not set!" unless self.config_file_path
+      raise "Config file '#{config_file_name(navigation_context)}' does not exists!" unless File.exists?(config_file_name(navigation_context))
+      if ::RAILS_ENV == 'production'
+        self.config_files[navigation_context] ||= IO.read(config_file_name(navigation_context))
+      else
+        self.config_files[navigation_context] = IO.read(config_file_name(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 path to the config_file for the given navigation_context
+    def config_file_name(navigation_context = :default)
+      file_name = navigation_context == :default ? '' : "#{navigation_context.to_s.underscore}_"
+      File.join(config_file_path, "#{file_name}navigation.rb")
+    end
+
+    def explicit_navigation_args
+      self.controller.instance_variable_get(:"@sn_current_navigation_args")
+    end
+
+    # Reads the current navigation for the specified level from the controller.
+    # Returns nil if there is no current navigation set for level.
+    def current_navigation_for(level)
+      self.controller.instance_variable_get(:"@sn_current_navigation_#{level}")
+    end
+
+    def active_item_container_for(level)
+      self.primary_navigation.active_item_container_for(level)
+    end
+    
+    # If any navigation has been explicitely set in the controller this method evaluates the specified args set in the controller and sets
+    # the correct instance variable in the controller.
+    def handle_explicit_navigation
+      if SimpleNavigation.explicit_navigation_args
+        begin
+          level, navigation = parse_explicit_navigation_args
+          self.controller.instance_variable_set(:"@sn_current_navigation_#{level}", navigation)
+        rescue
+          #we do nothing here
+          #TODO: check if this is the right way to handle wrong explicit navigation
+        end
+      end
+    end
+
+    private
+  
+    # TODO: refactor this ugly thing to make it nice and short
+    def parse_explicit_navigation_args
+      args = SimpleNavigation.explicit_navigation_args
+      args = [Hash.new] if args.empty?
+      if args.first.kind_of? Hash
+        options = args.first
+      else # args is a list of current navigation for several levels
+        options = {}
+        if args.size == 1 #only an navi-key has been specified, try to find out level
+          level = SimpleNavigation.primary_navigation.level_for_item(args.first)
+          options[:"level_#{level}"] = args.first if level
+        else
+          args.each_with_index {|arg, i| options[:"level_#{i + 1}"] = arg}
+        end
+      end
+      #only the deepest level is relevant
+      level = options.inject(0) do |max, kv|
+        kv.first.to_s =~ /level_(\d)/
+        max = $1.to_i if $1.to_i > max
+        max
+      end
+      raise ArgumentError, "Invalid level specified or item key not found" if level == 0
+      [level, options[:"level_#{level}"]]
+    end
+
+  end
+
+end
+
+SimpleNavigation.config_file_path = File.join(RAILS_ROOT, 'config') unless SimpleNavigation.config_file_path
+ActionController::Base.send(:include, SimpleNavigation::ControllerMethods)
+# TODOs for the next releases:
+# 1) add ability to specify explicit highlighting in the config-file itself (directly with the item)
+#    - item.highlight_on :controller => 'users', :action => 'show' ...^
+#   --> with that we can get rid of the controller_methods...
+#
+# 2) ability to turn off autohighlighting for a single item... 
+# 
+# 3) add JoinRenderer (HorizontalRenderer?) (wich does not render a list, but just the items joined with a specified char (e.g. | ))
+#
+# 4) Enhance SampleProject (more examples)
+#
+# 5) Make SampleProject public

data/rails/init.rb

@@ -0,0 +1,3 @@
+default_config_file_path = File.join(RAILS_ROOT, 'config')
+SimpleNavigation.config_file_path = default_config_file_path unless SimpleNavigation.config_file_path
+ActionController::Base.send(:include, SimpleNavigation::ControllerMethods)

data/spec/lib/simple_navigation/configuration_spec.rb

@@ -0,0 +1,162 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe SimpleNavigation::Configuration do
+  
+  before(:each) do
+    @config = SimpleNavigation::Configuration.instance
+  end
+  
+  describe 'self.run' do
+    it "should yield the singleton Configuration object" do
+      SimpleNavigation::Configuration.run do |c|
+        c.should == @config
+      end
+    end
+  end
+
+  describe 'self.eval_config' do
+    before(:each) do
+      @context = mock(:context)
+      @context.stub!(:instance_eval)
+      SimpleNavigation::Configuration.stub!(:context_for_eval => @context)
+      @config_files = {:default => 'default', :my_context => 'my_context'}
+      SimpleNavigation.stub!(:config_files).and_return(@config_files)
+    end
+    context "with default navigation context" do
+      it "should instance_eval the default config_file-string inside the context" do
+        @context.should_receive(:instance_eval).with('default')
+        SimpleNavigation::Configuration.eval_config(@context)
+      end    
+    end
+    context 'with non default navigation context' do
+      it "should instance_eval the specified config_file-string inside the context" do
+        @context.should_receive(:instance_eval).with('my_context')
+        SimpleNavigation::Configuration.eval_config(@context, :my_context)
+      end
+    end
+    it "should set the controller" do
+      @controller = stub(:controller)
+      SimpleNavigation::Configuration.should_receive(:extract_controller_from).with(@context).and_return(@controller)
+      SimpleNavigation.should_receive(:controller=).with(@controller)
+      SimpleNavigation::Configuration.eval_config(@context)
+    end
+    it "should set the template" do
+      @template = stub(:template)
+      @controller = stub(:controller, :instance_variable_get => @template)
+      SimpleNavigation.stub!(:controller => @controller)
+      SimpleNavigation.should_receive(:template=).with(@template)
+      SimpleNavigation::Configuration.eval_config(@context)
+    end
+  end
+
+  describe 'context_for_eval' do
+    context 'controller is present' do
+      before(:each) do
+        @controller = stub(:controller)
+        SimpleNavigation.stub!(:controller => @controller)
+      end
+      context 'template is present' do
+        before(:each) do
+          @template = stub(:template)
+          SimpleNavigation.stub!(:template => @template)
+        end
+        it {SimpleNavigation::Configuration.context_for_eval.should == @template}
+      end
+      context 'template is not present' do
+        before(:each) do
+          SimpleNavigation.stub!(:template => nil)
+        end
+        it {SimpleNavigation::Configuration.context_for_eval.should == @controller}
+      end
+    end
+    context 'controller is not present' do
+      before(:each) do
+        SimpleNavigation.stub!(:controller => nil)
+      end
+      context 'template is present' do
+        before(:each) do
+          @template = stub(:template)
+          SimpleNavigation.stub!(:template => @template)
+        end
+        it {SimpleNavigation::Configuration.context_for_eval.should == @template}
+      end
+      context 'template is not present' do
+        before(:each) do
+          SimpleNavigation.stub!(:template => nil)
+        end
+        it {lambda {SimpleNavigation::Configuration.context_for_eval}.should raise_error}
+      end
+    end
+  end
+
+  describe 'self.extract_controller_from' do
+    before(:each) do
+      @nav_context = stub(:nav_context)
+    end
+    
+    context 'object responds to controller' do
+      before(:each) do
+        @controller = stub(:controller)
+        @nav_context.stub!(:controller).and_return(@controller)
+      end
+      
+      it "should return the controller" do
+        SimpleNavigation::Configuration.extract_controller_from(@nav_context).should == @controller
+      end
+      
+    end
+    
+    context 'object does not respond to controller' do
+      it "should return the nav_context" do
+        SimpleNavigation::Configuration.extract_controller_from(@nav_context).should == @nav_context
+      end
+    end
+  end
+  
+  describe 'initialize' do
+    it "should set the List-Renderer as default upon initialize" do
+      @config.renderer.should == SimpleNavigation::Renderer::List
+    end
+    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
+    it "should set auto_highlight to true as default" do
+      @config.auto_highlight.should be_true
+    end
+  end  
+  describe 'items' do
+    before(:each) do
+      @container = stub(:items_container)
+      SimpleNavigation::ItemContainer.stub!(:new).and_return(@container)
+    end
+    it "should should yield an new ItemContainer" do
+      @config.items do |container|
+        container.should == @container
+      end
+    end
+    it "should assign the ItemContainer to an instance-var" do
+      @config.items {}
+      @config.primary_navigation.should == @container
+    end
+  end
+
+  describe 'loaded?' do
+    it "should return true if primary_nav is set" do
+      @config.instance_variable_set(:@primary_navigation, :bla)
+      @config.should be_loaded
+    end
+    it "should return false if no primary_nav is set" do
+      @config.instance_variable_set(:@primary_navigation, nil)
+      @config.should_not be_loaded
+    end
+  end
+  
+end
+
+

data/spec/lib/simple_navigation/controller_methods_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+ActionController::Base.send(:include, SimpleNavigation::ControllerMethods)
+
+describe SimpleNavigation::ControllerMethods do
+
+  def stub_loading_config
+    SimpleNavigation::Configuration.stub!(:load)
+  end
+
+  before(:each) do
+    stub_loading_config
+    class ApplicationController < ActionController::Base
+    end
+    @controller = ApplicationController.new
+  end
+  
+  describe 'when being included' do
+    it "should extend the ClassMethods" do
+      @controller.class.should respond_to(:navigation)
+    end
+    it "should include the InstanceMethods" do
+      @controller.should respond_to(:current_navigation)
+    end
+    it "should install the Helpers Module" do
+      [:render_navigation, :render_primary_navigation, :render_sub_navigation].each do |m|
+        @controller.master_helper_module.instance_methods.map(&:to_s).should include(m.to_s)
+      end
+    end
+  end
+  
+  describe 'class_methods' do
+    
+    describe 'navigation' do
+      
+      def call_navigation(key1, key2=nil)
+        @controller.class_eval do
+          navigation key1, key2
+        end
+      end
+      
+      it "should not have an instance-method 'sn_set_navigation' if navigation-method has not been called" do
+        @controller.respond_to?(:sn_set_navigation).should be_false
+      end
+      it 'should create an instance-method "sn_set_navigation" when being called' do
+        call_navigation(:key)
+        @controller.respond_to?(:sn_set_navigation).should be_true
+      end
+      it 'the created method should call current_navigation with the specified keys' do
+        call_navigation(:primary, :secondary)
+        @controller.should_receive(:current_navigation).with(:primary, :secondary)
+        @controller.sn_set_navigation
+      end
+    end
+    
+  end
+  
+  describe 'instance_methods' do
+    
+    describe 'current_navigation' do
+      it "should set the sn_current_navigation_args as specified" do
+        @controller.current_navigation(:first)
+        @controller.instance_variable_get(:@sn_current_navigation_args).should == [:first]
+      end
+      it "should set the sn_current_navigation_args as specified" do
+        @controller.current_navigation(:first, :second)
+        @controller.instance_variable_get(:@sn_current_navigation_args).should == [:first, :second]
+      end
+    end
+    
+  end
+  
+end

data/spec/lib/simple_navigation/helpers_spec.rb

@@ -0,0 +1,125 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe SimpleNavigation::Helpers do
+  class ControllerMock
+    include SimpleNavigation::Helpers
+  end
+  
+  before(:each) do
+    @controller = ControllerMock.new
+    SimpleNavigation.stub!(:load_config)
+    SimpleNavigation::Configuration.stub!(:eval_config)
+    @primary_navigation = stub(:primary_navigation, :null_object => true)
+    SimpleNavigation.stub!(:primary_navigation).and_return(@primary_navigation)
+  end
+  
+  describe 'render_navigation' do
+    describe 'regarding loading of the config-file' do
+      context 'no options specified' do
+        it "should load the config-file for the default context" do
+          SimpleNavigation.should_receive(:load_config).with(:default)
+          @controller.render_navigation
+        end
+      end
+      
+      context 'with options specified' do
+        it "should load the config-file for the specified context" do
+          SimpleNavigation.should_receive(:load_config).with(:my_context)
+          @controller.render_navigation(:context => :my_context)
+        end
+      end
+    end
+    
+    it "should eval the config on every request" do
+      SimpleNavigation::Configuration.should_receive(:eval_config).with(@controller, :default)
+      @controller.render_navigation
+    end
+    
+    context 'primary' do
+      it "should call render on the primary_navigation" do
+        @primary_navigation.should_receive(:render)
+        @controller.render_navigation(:primary)
+      end
+      it "should call render on the primary_navigation (specifying level through options)" do
+        @primary_navigation.should_receive(:render)
+        @controller.render_navigation(:level => :primary)
+      end
+      it "should call render on the primary_navigation (specifying level through options)" do
+        @primary_navigation.should_receive(:render)
+        @controller.render_navigation(:level => 1)
+      end
+    end
+    
+    context 'secondary' do
+      context 'with current_primary_navigation set' do
+        before(:each) do
+          @selected_item_container = stub(:selected_container, :null_object => true)
+          SimpleNavigation.stub!(:active_item_container_for => @selected_item_container)
+        end
+        it "should find the selected sub_navigation for the specified level" do
+          SimpleNavigation.should_receive(:active_item_container_for).with(2)
+          @controller.render_navigation(:secondary)
+        end
+        it "should find the selected sub_navigation for the specified level" do
+          SimpleNavigation.should_receive(:active_item_container_for).with(2)
+          @controller.render_navigation(:level => :secondary)
+        end
+        it "should find the selected sub_navigation for the specified level" do
+          SimpleNavigation.should_receive(:active_item_container_for).with(1)
+          @controller.render_navigation(:level => 1)
+        end
+        it "should call render on the active item_container" do
+          @selected_item_container.should_receive(:render)
+          @controller.render_navigation(:secondary)
+        end
+      end
+      context 'without an active item_container set' do
+        before(:each) do
+          SimpleNavigation.stub!(:active_item_container_for => nil)
+        end
+        it "should not raise an error" do
+          lambda{@controller.render_navigation(:secondary)}.should_not raise_error
+        end
+      end
+      
+    end
+    
+    context 'nested' do
+      it "should call render on the primary navigation with the include_subnavigation option set" do
+        @primary_navigation.should_receive(:render).with(true)
+        @controller.render_navigation(:nested)
+      end
+    end
+    
+    context 'unknown level' do
+      it "should raise an error" do
+        lambda {@controller.render_navigation(:unknown)}.should raise_error(ArgumentError)
+      end
+      it "should raise an error" do
+        lambda {@controller.render_navigation(:level => :unknown)}.should raise_error(ArgumentError)
+      end
+      it "should raise an error" do
+        lambda {@controller.render_navigation('level')}.should raise_error(ArgumentError)
+      end
+    end
+  end
+  
+  describe 'render_primary_navigation' do  
+    it "should delegate to render_navigation(:primary)" do
+      ActiveSupport::Deprecation.silence do
+        @controller.should_receive(:render_navigation).with(:level => 1)
+        @controller.render_primary_navigation
+      end
+    end
+  end
+  
+  describe 'render_sub_navigation' do
+    it "should delegate to render_navigation(:secondary)" do
+      ActiveSupport::Deprecation.silence do
+        @controller.should_receive(:render_navigation).with(:level => 2)
+        @controller.render_sub_navigation
+      end
+    end
+  end
+  
+end