krasivotokak-simple-navigation 1.4.1

data/lib/simple_navigation/item.rb

@@ -0,0 +1,48 @@
+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)
+      @key = key
+      @method = options.delete(:method)
+      @name = name
+      @url = url
+      @html_options = options
+      if sub_nav_block
+        @sub_navigation = ItemContainer.new
+        sub_nav_block.call @sub_navigation
+      end
+    end
+    
+    # Returns true if this navigation item should be rendered as 'selected' for the specified current_navigation.
+    def selected?(current_navigation)
+      key == current_navigation
+    end
+        
+    # 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_class = self.autogenerate_item_ids? ? key.to_s : nil
+      @html_options
+      @html_options[:class] = [default_class, @html_options[:class], self.selected_class(current_navigation)].flatten.compact.uniq.join(' ')
+      @html_options.delete(:class) if @html_options[:class].blank? 
+      @html_options
+    end
+        
+    def selected_class(current_navigation) #:nodoc:
+      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

@@ -0,0 +1,69 @@
+module SimpleNavigation
+  
+  # Holds the Items for a navigation 'level' (either the primary_navigation or a sub_navigation).
+  class ItemContainer
+    
+    attr_reader :items
+    attr_accessor :renderer, :dom_id, :dom_class
+    
+    def initialize #:nodoc:
+      @items = []
+      @renderer = Configuration.instance.renderer
+    end
+    
+    # Creates a new navigation item. 
+    #
+    # The <tt>key</tt> is a symbol which uniquely defines your navigation item in the scope of the primary_navigation or the sub_navigation.
+    # 
+    # The <tt>name</tt> will be displayed in the rendered navigation. This can also be a call to your I18n-framework.
+    #
+    # The <tt>url</tt> is the address that the generated item points to. You can also use url_helpers (named routes, restful routes helper, url_for etc.) 
+    #
+    # The <tt>options</tt> can be used to specify the following things:
+    # * <tt>html_attributes</tt> - will be included in the rendered navigation item (e.g. id, class etc.)
+    # * <tt>:if</tt> - Specifies a proc to call to determine if the item should
+    #   be rendered (e.g. <tt>:if => Proc.new { current_user.admin? }</tt>). The
+    #   proc should evaluate to a true or false value and is evaluated in the context of the view.
+    # * <tt>:unless</tt> - Specifies a proc to call to determine if the item should not
+    #   be rendered (e.g. <tt>:unless => Proc.new { current_user.admin? }</tt>). The
+    #   proc should evaluate to a true or false value and is evaluated in the context of the view.
+    #
+    # The <tt>block</tt> - if specified - will hold the item's sub_navigation.
+    def item(key, name, url, options={}, &block)
+      (@items << Item.new(key, name, url, options, block)) if should_add_item?(options)
+    end
+
+    # Returns the Item with the specified key, nil otherwise.
+    def [](navi_key)
+      items.find {|i| i.key == navi_key}
+    end
+  
+    # Renders the items in this ItemContainer using the configured renderer.
+    #
+    # Set <tt>include_sub_navigation</tt> to true if you want to nest the sub_navigation into the active primary_navigation
+    def render(current_navigation, include_sub_navigation=false, current_sub_navigation=nil)
+      self.renderer.new(current_navigation, current_sub_navigation).render(self, include_sub_navigation)
+    end
+
+    private
+    
+    # partially borrowed from ActionSupport::Callbacks
+    def should_add_item?(options) #:nodoc:
+      [options.delete(:if)].flatten.compact.all? { |m| evaluate_method(m) } &&
+      ![options.delete(:unless)].flatten.compact.any? { |m| evaluate_method(m) }
+    end
+    
+    # partially borrowed from ActionSupport::Callbacks
+    def evaluate_method(method) #:nodoc:
+      case method
+        when Proc, Method
+          method.call
+        else
+          raise ArgumentError, ":if or :unless must be procs or lambdas"
+      end
+    end
+
+    
+  end
+  
+end

data/lib/simple_navigation/renderer/base.rb

@@ -0,0 +1,44 @@
+module SimpleNavigation
+  module Renderer
+    
+    # This is the base class for all renderers.
+    #
+    # A renderer is responsible for rendering an ItemContainer (primary or a sub_navigation) and its containing items to HTML.
+    # It must be initialized with the current_navigation for the rendered ItemContainer and 
+    # optionally with the current_sub_navigation (if the sub_navigation will be nested).
+    class Base
+      include ActionView::Helpers::UrlHelper
+      include ActionView::Helpers::TagHelper
+      
+      attr_reader :current_navigation, :current_sub_navigation, :controller
+
+      class << self
+        
+        # Delegates method calls to the controller.
+        def controller_method(*methods)
+          methods.each do |method|
+            delegate method, :to => :controller
+          end
+        end
+        
+      end
+
+      controller_method :form_authenticity_token, :protect_against_forgery?, :request_forgery_protection_token
+      
+      def initialize(current_navigation, current_sub_navigation=nil) #:nodoc:
+        @current_navigation = current_navigation
+        @current_sub_navigation = current_sub_navigation
+        @controller = SimpleNavigation.controller
+      end
+            
+      # Renders the specified ItemContainer to HTML.
+      #
+      # If <tt>include_sub_navigation</tt> is set to true, the renderer should nest the sub_navigation for the active navigation 
+      # inside that navigation item.  
+      def render(item_container, include_sub_navigation=false)
+        raise 'subclass responsibility'
+      end
+            
+    end
+  end
+end

data/lib/simple_navigation/renderer/list.rb

@@ -0,0 +1,30 @@
+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.
+    #
+    # By default, the renderer sets the item's key as dom_id for the rendered <li> element. The id can be explicitely specified by setting
+    # the id in the html-options of the 'item' method in the config/navigation.rb file.
+    class List < Renderer::Base
+
+      def render(item_container, include_sub_navigation=false)
+        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)
+          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.join, {:class => %(#{item_container.dom_class} #{item_container.dom_id})})
+      end
+
+    end
+  end
+end

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/simple-navigation.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple-navigation}
+  s.version = "1.4.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andi Schacke", "Alexander Semyonov"]
+  s.date = %q{2009-08-31}
+  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.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.5}
+  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/item_spec.rb",
+     "spec/lib/simple_navigation/controller_methods_spec.rb",
+     "spec/lib/simple_navigation/item_container_spec.rb",
+     "spec/lib/simple_navigation/helpers_spec.rb",
+     "spec/lib/simple_navigation/configuration_spec.rb",
+     "spec/lib/simple_navigation/renderer/list_spec.rb",
+     "spec/lib/simple_navigation/renderer/base_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 = 3
+
+    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

@@ -0,0 +1,101 @@
+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)
+      @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
+  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
+  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
+
+  
+end
+
+

data/spec/lib/simple_navigation/controller_methods_spec.rb

@@ -0,0 +1,77 @@
+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 'set_navigation if navigation-method has not been called" do
+        @controller.respond_to?(:set_navigation).should be_false
+      end
+      it 'should create an instance-method "set_navigation" when being called' do
+        call_navigation(:key)
+        @controller.respond_to?(: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.set_navigation
+      end
+    end
+    
+  end
+  
+  describe 'instance_methods' do
+    
+    describe 'current_navigation' do
+      it "should set the current_primary_navigation as specified" do
+        @controller.current_navigation(:first)
+        @controller.instance_variable_get(:@current_primary_navigation).should == :first
+      end
+      it "should set the current_secondary_navigation as specified" do
+        @controller.current_navigation(:first, :second)
+        @controller.instance_variable_get(:@current_secondary_navigation).should == :second
+      end
+      it "should set the current_secondary_navigation to nil if no secondary is specified" do
+        @controller.current_navigation(:first)
+        @controller.instance_variable_get(:@current_secondary_navigation).should be_nil
+      end
+    end
+    
+  end
+  
+end