simple-navigation 1.4.2 → 2.0.0

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 rdoc
-pkg
+pkg
+coverage

data/CHANGELOG

@@ -1,3 +1,11 @@
+*2.0.0
+
+* added auto_highlight feature. Active navigation is determined by comparing urls, no need to explicitly set it in the controllers anymore. Thanks to Jack Dempsey and Florian Hanke for the support on this.
+* added ability to create multi-level navigations (not just limited to primary and secondary navigation). Thanks again to Jack Dempsey for the motivation ;-) 
+* simplified the process to explicitly set the navigation in the controller (where needed) - only deepest level has to be specified
+* made auto_highlight feature configurable both on global and item_container's level 
+* config file is now evaluated in template if ever possible (not in controller anymore)
+
 *1.4.2
 
 * explicitly loading all source files when requiring 'simple_navigation'.

data/README

@@ -1,7 +1,8 @@
 
 == Simple Navigation
 
-Simple Navigation is a plugin for creating a navigation (optionally with sub navigation) for your rails app.
+Simple Navigation is a ruby library for creating navigations (with multiple levels) for your Ruby on Rails application.
+If you upgrade to version 2.x.x please recheck the updated documentation on http://wiki.github.com/andi/simple-navigation.
 
 Source code:
   git://github.com/andi/simple-navigation.git
@@ -9,6 +10,9 @@ Source code:
 Documentation: 
   http://wiki.github.com/andi/simple-navigation
 
+RDoc:
+  http://andi.rubyforge.org
+
 Online Demo:
   http://simple-navigation-demo.andischacke.com
 

data/Rakefile

@@ -11,6 +11,16 @@ Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_files = FileList['spec/**/*_spec.rb']
 end
 
+namespace :spec do
+  desc "Run all specs with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec,/Users/']
+  end
+end
+
 desc 'Generate documentation for the simple_navigation plugin.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
@@ -24,10 +34,10 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "simple-navigation"
-    gemspec.summary = "Simple Navigation is a ruby library for creating a navigation (optionally with sub navigation) for your rails app."
+    gemspec.summary = "Simple Navigation is a ruby library for creating navigations (with multiple levels) for your Ruby on Rails application."
     gemspec.email = "andreas.schacke@gmail.com"
     gemspec.homepage = "http://github.com/andi/simple-navigation"
-    gemspec.description = "Simple Navigation is a ruby library for creating a navigation (optionally with sub navigation) for your rails app."
+    gemspec.description = "With the simple-navigation gem installed you can easily create multilevel navigations for your Ruby on Rails applications. The navigation is defined in a single configuration file. It supports automatic as well as explicit highlighting of the currently active navigation."
     gemspec.authors = ["Andi Schacke"]
     gemspec.rdoc_options = ["--inline-source", "--charset=UTF-8"]
     gemspec.files += ["CHANGELOG"]
@@ -36,6 +46,6 @@ begin
   Jeweler::RubyforgeTasks.new do |rubyforge|
     rubyforge.doc_task = "rdoc"
   end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+rescue LoadError => e
+  puts "Jeweler not available (#{e}). Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 2
-:major: 1
-:minor: 4
+:patch: 0
+:major: 2
+:minor: 0

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

@@ -12,10 +12,14 @@ SimpleNavigation::Configuration.run do |navigation|
   # driven hovering menus like the jquery superfish plugin
   # navigation.render_all_levels = true
   
-  # Item keys are normally added to list items.
-  # this setting turns that off
+  # Item keys are normally added to list items as id.
+  # This setting turns that off
   # navigation.autogenerate_item_ids = false
 
+  # The auto highlight feature is turned on by default.
+  # This turns it off globally (for the whole plugin)
+  # navigation.auto_highlight = false
+
   # Define the primary navigation
   navigation.items do |primary|
     # Add an item to the primary navigation. The following params apply:
@@ -42,6 +46,9 @@ SimpleNavigation::Configuration.run do |navigation|
     # works for all levels of the menu
     # primary.dom_id = 'menu-id'
     # primary.dom_class = 'menu-class'
+    
+    # You can turn off auto highlighting for a specific level
+    # primary.auto_highlight = false
   
   end
   

data/lib/simple_navigation/configuration.rb

@@ -6,25 +6,30 @@ module SimpleNavigation
   class Configuration
     include Singleton
     
-    attr_accessor :renderer
-    attr_accessor :selected_class
-    attr_accessor :render_all_levels
-    attr_accessor :autogenerate_item_ids
+    attr_accessor :renderer, :selected_class, :render_all_levels, :autogenerate_item_ids, :auto_highlight
     attr_reader :primary_navigation
 
     class << self
 
       # Evals the config_file for the given navigation_context inside the specified context (usually a controller or view)
       def eval_config(context, navigation_context = :default)
-        context.instance_eval(SimpleNavigation.config_files[navigation_context])
         SimpleNavigation.controller = extract_controller_from context
+        SimpleNavigation.template = SimpleNavigation.controller.instance_variable_get(:@template)
+        context_for_eval.instance_eval(SimpleNavigation.config_files[navigation_context])
       end
-
+      
       # Starts processing the configuration
       def run(&block)
         block.call Configuration.instance
       end    
 
+      # Returns the context in which the config file should be evaluated.
+      # This is preferably the template, otherwise te controller
+      def context_for_eval
+        raise 'no context set for evaluation the config file' unless SimpleNavigation.template || SimpleNavigation.controller
+        SimpleNavigation.template || SimpleNavigation.controller
+      end
+
       # Extracts a controller from the context.
       def extract_controller_from(context)
         if context.respond_to? :controller
@@ -33,8 +38,8 @@ module SimpleNavigation
           context
         end
       end
-
-    end
+      
+    end #class << self
     
     # Sets the config's default-settings
     def initialize
@@ -42,6 +47,7 @@ module SimpleNavigation
       @selected_class = 'selected'
       @render_all_levels = false
       @autogenerate_item_ids = true
+      @auto_highlight = true
     end
   
     # Yields an SimpleNavigation::ItemContainer for adding navigation items

data/lib/simple_navigation/controller_methods.rb

@@ -1,9 +1,12 @@
 #TODO: add :except and :only options to navigation method
 module SimpleNavigation
   
-  # Adds methods for handling the current 'active' navigation to the controllers.
+  # Adds methods for explicitely setting the current 'active' navigation to the controllers.
+  # Since version 2.0.0 the simple_navigation plugin determines the active navigation based on the current url by default (auto highlighting),
+  # so explicitely defining the active navigation in the controllers is only needed for edge cases where automatic highlighting does not work.
   # 
-  # On the controller class level, use the navigation method to set the active navigation for all actions in the controller.
+  # On the controller class level, use the <tt>navigation</tt> method to set the active navigation for all actions in the controller.
+  # Let's assume that we have a primary navigation item :account which in turn has a sub navigation item :settings.
   # 
   # ==== Examples
   #   class AccountController << ActionController
@@ -12,15 +15,16 @@ module SimpleNavigation
   #   end
   #
   #   class AccountSettingsController << ActionController
-  #     navigation :account, :settings
+  #     navigation :settings
   #     ...
   #   end
   #
-  # The first example sets the current_primary_navigation to :account for all actions. No active sub_navigation.
-  # The second example sets the current_primary_navigation to :account and the current_sub_navigation to :settings.
+  # The first example sets the current primary navigation to :account for all actions. No active sub_navigation.
+  # The second example sets the current sub navigation to :settings and since it is a child of :account the current primary navigation is set to :account.
   # 
-  # On the controller instance level, use the current_navigation method to define the active navigation for a specific action. 
-  # The navigation item that is set in current_navigation overrides the one defined on the controller class level (see navigation method).
+  # On the controller instance level, use the <tt>current_navigation</tt> method to define the active navigation for a specific action. 
+  # The navigation item that is set in <tt>current_navigation</tt> overrides the one defined on the controller class level (see <tt>navigation</tt> method).
+  # Thus if you have an :account primary item with a :special sub navigation item:
   #
   # ==== Example
   #   class AccountController << ActionController
@@ -28,13 +32,15 @@ module SimpleNavigation
   #     
   #     def your_special_action
   #       ...
-  #       current_navigation :account, :special
+  #       current_navigation :special
   #     end
   #   end
   #
-  # The code above still sets the active primary navigation to :account but also sets the sub_navigation to :special for 'your_special_action'.
+  # The code above still sets the active primary navigation to :account for all actions, but sets the sub_navigation to :account -> :special for 'your_special_action'.
   #
-  # Note: The specified symbols must match the keys for your navigation items in your config/navigation.rb file.
+  # Note 1: As you can see above you just have to set the navigation item of your 'deepest' navigation level as active and all its parents are marked as active, too.
+  #
+  # Note 2: The specified symbols must match the keys for your navigation items in your config/navigation.rb file.
   module ControllerMethods
     def self.included(base) #:nodoc:
       base.class_eval do
@@ -48,26 +54,24 @@ module SimpleNavigation
     module ClassMethods
       # Sets the active navigation for all actions in this controller.
       #
-      # The specified symbols must match the keys for your navigation items in your config/navigation.rb file.  
-      def navigation(primary_navigation, sub_navigation=nil)
+      # The specified symbol must match the keys for your navigation items in your config/navigation.rb file.  
+      def navigation(*args)
         self.class_eval do
-          define_method :set_navigation do
-            current_navigation(primary_navigation, sub_navigation)
+          define_method :sn_set_navigation do
+            current_navigation(*args)
           end
-          before_filter :set_navigation
+          before_filter :sn_set_navigation
         end
       end
     end
   
     module InstanceMethods
-      
       # Sets the active navigation. Call this method in any action to override the controller-wide active navigation
       # specified by navigation.
       #
-      # The specified symbols must match the keys for your navigation items in your config/navigation.rb file.
-      def current_navigation(primary_navigation, sub_navigation=nil)
-        @current_primary_navigation = primary_navigation
-        @current_secondary_navigation = sub_navigation
+      # The specified symbol must match the keys for your navigation items in your config/navigation.rb file.
+      def current_navigation(*args)
+        @sn_current_navigation_args = args
       end
     end
 

data/lib/simple_navigation/helpers.rb

@@ -2,63 +2,78 @@ module SimpleNavigation
   
   # View helpers to render the navigation.
   #
-  # Use render_primary_navigation to render your primary navigation with the configured renderer.
-  # Use render_sub_navigation to render the sub navigation belonging to the active primary navigation.
-  # Use render_navigation to render the primary navigation with the corresponding sub navigation rendered inside primary navigation item which is active.
+  # Use render_navigation as following to render your navigation:
+  # * call <tt>render_navigation</tt> without :level option to render your navigation as nested tree.
+  # * call <tt>render_navigation(:level => x)</tt> to render a specific navigation level (e.g. :level => 1 to render your primary navigation, :level => 2 to render the sub navigation and so forth)
   # 
   # ==== Examples (using Haml)
-  #   #primary_navigation= render_primary_navigation
+  #   #primary_navigation= render_navigation(:level => 1)
   #   
-  #   #sub_navigation= render_sub_navigation
+  #   #sub_navigation= render_navigation(:level => 2)
   #
-  #   #main_navigation= render_navigation
+  #   #nested_navigation= render_navigation
   #
+  # Please note that <tt>render_primary_navigation</tt> and <tt>render_sub_navigation</tt> still work, but have been deprecated and may be removed in a future release.
   module Helpers
     
     # Renders the navigation according to the specified options-hash. 
     #
     # The following options are supported:
-    # * <tt>level</tt> - defaults to :nested which renders the the sub_navigation for an active primary_navigation inside that active primary_navigation item. 
-    #   Other possible levels are :primary which only renders the primary_navigation (also see render_primary_navigation) and :secondary which only renders the sub_navigation (see render_sub_navigation).
-    # * <tt>context</tt> - specifies the context for which you would render the navigation. Defaults to :default which loads the default navigation.rb (i.e. config/navigation.rb)
-    #   if you specify a context then the plugin tries to load the configuration file for that context, e.g. if you call <tt>render_navigation(:context => :admin)</tt> the file config/admin_navigation.rb
+    # * <tt>:level</tt> - defaults to :nested which renders the the sub_navigation for an active primary_navigation inside that active primary_navigation item. 
+    #   Specify a specific level to only render that level of navigation (e.g. :level => 1 for primary_navigation etc...).
+    # * <tt>:context</tt> - specifies the context for which you would render the navigation. Defaults to :default which loads the default navigation.rb (i.e. config/navigation.rb).
+    #   If you specify a context then the plugin tries to load the configuration file for that context, e.g. if you call <tt>render_navigation(:context => :admin)</tt> the file config/admin_navigation.rb
     #   will be loaded and used for rendering the navigation.
     #   
     def render_navigation(*args)
       args = [Hash.new] if args.empty?
-      default_options = {:context => :default, :level => :nested}
-      level, navigation_context = case args.first 
-      when Hash
-        options = default_options.merge(args.first)
-        [options[:level], options[:context]]
-      when Symbol
-        [args[0], default_options.merge(args[1] || {})[:context]]
-      else
-        raise ArgumentError, "Invalid arguments"
-      end
-      SimpleNavigation.load_config(navigation_context)
-      SimpleNavigation::Configuration.eval_config(self, navigation_context)
-      case level
-      when :primary
-        SimpleNavigation.primary_navigation.render(@current_primary_navigation)
-      when :secondary
-        primary = SimpleNavigation.primary_navigation[@current_primary_navigation]
-        primary.sub_navigation.render(@current_secondary_navigation) if primary && primary.sub_navigation
+      options = extract_backwards_compatible_options(*args)
+      options = {:context => :default, :level => :nested}.merge(options)
+      SimpleNavigation.load_config(options[:context])
+      SimpleNavigation::Configuration.eval_config(self, options[:context])
+      SimpleNavigation.handle_explicit_navigation
+      case options[:level]
+      when Integer
+        active_item_container = SimpleNavigation.active_item_container_for(options[:level])
+        active_item_container.render if active_item_container
       when :nested
-        SimpleNavigation.primary_navigation.render(@current_primary_navigation, true, @current_secondary_navigation)
+        SimpleNavigation.primary_navigation.render(true)
       else
-        raise ArgumentError, "Invalid navigation level: #{level}"
+        raise ArgumentError, "Invalid navigation level: #{options[:level]}"
       end
     end
     
-    # Renders the primary_navigation with the configured renderer. Calling render_navigation(:level => :primary) has the same effect.
+    # Deprecated. Renders the primary_navigation with the configured renderer. Calling render_navigation(:level => 0) has the same effect.
     def render_primary_navigation(options = {})
-      render_navigation(options.merge(:level => :primary))
+      ActiveSupport::Deprecation.warn("SimpleNavigation::Helpers.render_primary_navigation has been deprected. Please use render_navigation(:level => 1) instead")
+      render_navigation(options.merge(:level => 1))
     end
     
-    # Renders the sub_navigation with the configured renderer. Calling render_navigation(:level => :secondary) has the same effect.
+    # Deprecated. Renders the sub_navigation with the configured renderer. Calling render_navigation(:level => 1) has the same effect.
     def render_sub_navigation(options = {})
-      render_navigation(options.merge(:level => :secondary))
+      ActiveSupport::Deprecation.warn("SimpleNavigation::Helpers.render_primary_navigation has been deprected. Please use render_navigation(:level => 2) instead")
+      render_navigation(options.merge(:level => 2))
+    end
+
+    private
+
+    def extract_backwards_compatible_options(*args)
+      case args.first
+      when Hash
+        options = args.first
+        options[:level] = 1 if options[:level] == :primary
+        options[:level] = 2 if options[:level] == :secondary
+      when Symbol
+        raise ArgumentError, "Invalid arguments" unless [:primary, :secondary, :nested].include? args.first
+        options = Hash.new
+        options[:level] = args.first
+        options[:level] = 1 if options[:level] == :primary
+        options[:level] = 2 if options[:level] == :secondary
+        options.merge!(args[1] || {})
+      else
+        raise ArgumentError, "Invalid arguments"
+      end
+      options
     end
     
   end

data/lib/simple_navigation/item.rb

@@ -6,43 +6,84 @@ module SimpleNavigation
     attr_writer :html_options
     
     # see ItemContainer#item
-    def initialize(key, name, url, options, sub_nav_block)
+    def initialize(container, key, name, url, options, sub_nav_block) #:nodoc:
+      @container = container
       @key = key
       @method = options.delete(:method)
       @name = name
       @url = url
       @html_options = options
       if sub_nav_block
-        @sub_navigation = ItemContainer.new
+        @sub_navigation = ItemContainer.new(@container.level + 1)
         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
+    # Returns true if this navigation item should be rendered as 'selected'.
+    # An item is selected if
+    #
+    # * it has been explicitly selected in a controller or
+    # * it has a subnavigation and one of its subnavigation items is selected or
+    # * its url matches the url of the current request (auto highlighting)
+    #
+    def selected?
+      @selected = @selected || selected_by_config? || selected_by_subnav? || selected_by_url?
     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)
+    def html_options
       default_options = self.autogenerate_item_ids? ? {:id => key.to_s} : {}
       options = default_options.merge(@html_options)
-      options[:class] = [@html_options[:class], self.selected_class(current_navigation)].flatten.compact.join(' ')
-      options.delete(:class) if options[:class].blank? 
+      options[:class] = [@html_options[:class], self.selected_class].flatten.compact.join(' ')
+      options.delete(:class) if options[:class].blank?
       options
     end
-        
-    def selected_class(current_navigation) #:nodoc:
-      selected?(current_navigation) ? SimpleNavigation.config.selected_class : nil
+
+    # Returns the configured selected_class if the item is selected, nil otherwise
+    #
+    def selected_class
+      selected? ? SimpleNavigation.config.selected_class : nil
     end
-    
-    
+
     protected
-    
+
+    # Returns true if item has a subnavigation and the sub_navigation is selected
+    def selected_by_subnav?
+      sub_navigation && sub_navigation.selected?
+    end
+
+    # Return true if item has explicitly selected in controllers
+    def selected_by_config?
+      key == @container.current_explicit_navigation
+    end
+
+    # Returns true if the item's url matches the request's current url.
+    def selected_by_url?
+      if auto_highlight?
+        !!(root_path_match? || (SimpleNavigation.template && SimpleNavigation.template.current_page?(url)))
+      else
+        false
+      end
+    end
+
+    # Returns true if both the item's url and the request's url are root_path
+    def root_path_match?
+      url == '/' && SimpleNavigation.controller.request.path == '/'
+    end
+
+    # Converts url to url_hash. Accesses routing system, quite slow... Not used at the moment
+    # def hash_for_url(url) #:nodoc:
+    #   ActionController::Routing::Routes.recognize_path(url, {:method => (method || :get)})
+    # end
+
     def autogenerate_item_ids?
       SimpleNavigation.config.autogenerate_item_ids
     end
-        
+
+    def auto_highlight?
+      SimpleNavigation.config.auto_highlight && @container.auto_highlight
+    end
+
   end
 end

data/lib/simple_navigation/item_container.rb

@@ -1,14 +1,16 @@
 module SimpleNavigation
   
-  # Holds the Items for a navigation 'level' (either the primary_navigation or a sub_navigation).
+  # Holds the Items for a navigation 'level'.
   class ItemContainer
     
-    attr_reader :items
-    attr_accessor :renderer, :dom_id, :dom_class
+    attr_reader :items, :level
+    attr_accessor :renderer, :dom_id, :dom_class, :auto_highlight
     
-    def initialize #:nodoc:
+    def initialize(level=1) #:nodoc:
+      @level = level
       @items = []
-      @renderer = Configuration.instance.renderer
+      @renderer = SimpleNavigation.config.renderer
+      @auto_highlight = true
     end
     
     # Creates a new navigation item. 
@@ -30,23 +32,72 @@ module SimpleNavigation
     #
     # 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)
+      (@items << SimpleNavigation::Item.new(self, 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
+
+    # Returns the level of the item specified by navi_key.
+    # Recursively works its way down the item's sub_navigations if the desired item is not found directly in this container's items.
+    # Returns nil item cannot be found.
+    #
+    def level_for_item(navi_key)
+      my_item = self[navi_key]
+      return self.level if my_item
+      items.each do |i|
+        if i.sub_navigation
+          level = i.sub_navigation.level_for_item(navi_key)
+          return level unless level.nil?
+        end
+      end
+      return nil
+    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)
+    # Set <tt>include_sub_navigation</tt> to true if you want to nest the sub_navigation into the active parent_navigation
+    def render(include_sub_navigation=false)
+      self.renderer.new.render(self, include_sub_navigation)
+    end
+
+    # Returns true if any of this container's items is selected.
+    #
+    def selected?
+      items.any? {|i| i.selected?}
+    end
+
+    # Returns the currently selected item, nil if no item is selected.
+    #
+    def selected_item
+      self[current_explicit_navigation] || items.find {|i| i.selected?}
+    end
+
+    # Returns the current navigation that has been explicitely defined in the controller for this container's level.
+    # Returns nil if no explicit current navigation has been set.
+    #
+    def current_explicit_navigation
+      SimpleNavigation.current_navigation_for(level)
+    end
+
+    # Returns the active item_container for the specified level
+    # (recursively looks up items in selected sub_navigation if level is deeper than this container's level).
+    #
+    def active_item_container_for(desired_level)
+      return self if self.level == desired_level
+      return nil unless selected_sub_navigation?
+      return selected_item.sub_navigation.active_item_container_for(desired_level)
     end
 
     private
     
+    def selected_sub_navigation?
+      !!(selected_item && selected_item.sub_navigation)
+    end
+
     # partially borrowed from ActionSupport::Callbacks
     def should_add_item?(options) #:nodoc:
       [options.delete(:if)].flatten.compact.all? { |m| evaluate_method(m) } &&
@@ -62,7 +113,6 @@ module SimpleNavigation
           raise ArgumentError, ":if or :unless must be procs or lambdas"
       end
     end
-
     
   end
   

data/lib/simple_navigation/renderer/base.rb

@@ -3,14 +3,12 @@ module SimpleNavigation
     
     # 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).
+    # A renderer is responsible for rendering an ItemContainer and its containing items to HTML.
     class Base
       include ActionView::Helpers::UrlHelper
       include ActionView::Helpers::TagHelper
       
-      attr_reader :current_navigation, :current_sub_navigation, :controller
+      attr_reader :controller
 
       class << self
         
@@ -25,16 +23,18 @@ module SimpleNavigation
 
       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
+      def initialize #:nodoc:
         @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.  
+      # inside that navigation item.
+      #
+      # A renderer should also take the option SimpleNavigation.config.render_all_levels into account. If it is set to true then it should render all navigation levels
+      # independent of the <tt>include_sub_navigation</tt> option.
+      #  
       def render(item_container, include_sub_navigation=false)
         raise 'subclass responsibility'
       end