simple-navigation 2.7.3 → 3.0.0.beta1

data/lib/simple_navigation/{items_provider.rb → core/items_provider.rb}

@@ -1,12 +1,12 @@
 module SimpleNavigation
-  
-  # Acts as a proxy to navigation items that are passed into the SimpleNavigation::Configuration#items method. It hides the logic 
+
+  # Acts as a proxy to navigation items that are passed into the SimpleNavigation::Configuration#items method. It hides the logic
   # for finding items from the Configuration object.
   #
   class ItemsProvider
-    
+
     attr_reader :provider
-    
+
     # It accepts the following types of provider:
     # * methodname as symbol - the specified method should return the relevant items and has to be available in the view (a helper method)
     # * object that responds to :items
@@ -17,11 +17,11 @@ module SimpleNavigation
     def initialize(provider)
       @provider = provider
     end
-    
+
     # Returns the navigation items
     def items
       if provider.instance_of?(Symbol)
-        SimpleNavigation.config.context_for_eval.send(provider)
+        SimpleNavigation.context_for_eval.send(provider)
       elsif provider.respond_to?(:items)
         provider.items
       elsif provider.respond_to?(:each)
@@ -30,6 +30,6 @@ module SimpleNavigation
         raise "items_provider either must be a symbol specifying the helper-method to call, an object with an items-method defined or an enumerable representing the items"
       end
     end
-    
+
   end
 end

data/lib/simple_navigation/{controller_methods.rb → rails_controller_methods.rb}

@@ -1,5 +1,52 @@
-#TODO: add :except and :only options to navigation method
 module SimpleNavigation
+
+  class << self
+
+    def explicit_navigation_args
+      self.adapter.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.adapter.controller.instance_variable_get(:"@sn_current_navigation_#{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
+        level, navigation = parse_explicit_navigation_args
+        self.adapter.controller.instance_variable_set(:"@sn_current_navigation_#{level}", navigation)
+      end
+    end
+
+    # 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 one 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  
   
   # 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),
@@ -46,8 +93,6 @@ module SimpleNavigation
       base.class_eval do
         extend ClassMethods
         include InstanceMethods
-        include SimpleNavigation::Helpers
-        base.helper_method :render_navigation, :render_primary_navigation, :render_sub_navigation
       end
     end
   
@@ -56,7 +101,6 @@ module SimpleNavigation
       #
       # The specified symbol must match the keys for your navigation items in your config/navigation.rb file.  
       def navigation(*args)
-        ActiveSupport::Deprecation.warn("Setting the active navigation in the controllers has been deprecated. Please use the new :highlights_on option in the config file for explicit highlighting")
         self.class_eval do
           define_method :sn_set_navigation do
             current_navigation(*args)
@@ -73,10 +117,28 @@ module SimpleNavigation
       #
       # The specified symbol must match the keys for your navigation items in your config/navigation.rb file.
       def current_navigation(*args)
-        ActiveSupport::Deprecation.warn("Setting the active navigation in the controllers has been deprecated. Please use the new :highlights_on option in the config file for explicit highlighting")
         @sn_current_navigation_args = args
       end
     end
 
   end
+  
+  class Item
+    
+    def selected_by_config?
+      key == SimpleNavigation.current_navigation_for(@container.level)
+    end
+    
+  end
+  
+  class ItemContainer
+    
+    def selected_item
+      self[SimpleNavigation.current_navigation_for(self.level)] || items.find {|i| i.selected?}
+    end
+    
+  end
+  
 end
+  
+ActionController::Base.send(:include, SimpleNavigation::ControllerMethods)

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/{helpers.rb → rendering/helpers.rb}

@@ -1,16 +1,16 @@
 module SimpleNavigation
-  
+
   # View helpers to render the navigation.
   #
   # Use render_navigation as following to render your navigation:
   # * call <tt>render_navigation</tt> without :level option to render your complete 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)
-  # * call <tt>render_navigation(:level => 2..3)</tt> to render navigation levels 2 and 3). 
+  # * call <tt>render_navigation(:level => 2..3)</tt> to render navigation levels 2 and 3).
   #   For example, you could use render_navigation(:level => 1) to render your primary navigation as tabs and render_navigation(:level => 2..3) to render the rest of the navigation as a tree in a sidebar.
-  # 
+  #
   # ==== Examples (using Haml)
   #   #primary_navigation= render_navigation(:level => 1)
-  #   
+  #
   #   #sub_navigation= render_navigation(:level => 2)
   #
   #   #nested_navigation= render_navigation
@@ -18,42 +18,40 @@ module SimpleNavigation
   #   #top_navigation= render_navigation(:level => 1..2)
   #   #sidebar_navigation= render_navigation(:level => 3)
   module Helpers
-    
-    # Renders the navigation according to the specified options-hash. 
+
+    # Renders the navigation according to the specified options-hash.
     #
     # The following options are supported:
-    # * <tt>:level</tt> - defaults to :all which renders the the sub_navigation for an active primary_navigation inside that active primary_navigation item. 
+    # * <tt>:level</tt> - defaults to :all 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...).
     #   Specifiy a Range of levels to render only those specific levels (e.g. :level => 1..2 to render both your first and second levels, maybe you want to render your third level somewhere else on the page)
     # * <tt>:expand_all</tt> - defaults to false. If set to true the all specified levels will be rendered as a fully expanded tree (always open). This is useful for javascript menus like Superfish.
     # * <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.
-    # * <tt>:items</tt> - you can specify the items directly (e.g. if items are dynamically generated from database). See SimpleNavigation::ItemsProvider for documentation on what to provide as items. 
+    # * <tt>:items</tt> - you can specify the items directly (e.g. if items are dynamically generated from database). See SimpleNavigation::ItemsProvider for documentation on what to provide as items.
     # * <tt>:renderer</tt> - specify the renderer to be used for rendering the navigation. Either provide the Class or a symbol matching a registered renderer. Defaults to :list (html list renderer).
     def render_navigation(*args)
       args = [Hash.new] if args.empty?
       options = extract_backwards_compatible_options(*args)
       options = {:context => :default, :level => :all}.merge(options)
       ctx = options.delete(:context)
-      SimpleNavigation.set_template_from self
-      if SimpleNavigation.config_file?(ctx)
-        SimpleNavigation.load_config(ctx) 
-        SimpleNavigation::Configuration.eval_config(self, ctx) 
-      end
+      SimpleNavigation.init_adapter_from self
+      SimpleNavigation.load_config(ctx) 
+      SimpleNavigation::Configuration.eval_config(ctx) 
       SimpleNavigation.config.items(options[:items]) if options[:items]
-      SimpleNavigation.handle_explicit_navigation
+      SimpleNavigation.handle_explicit_navigation if SimpleNavigation.respond_to?(:handle_explicit_navigation)
       raise "no primary navigation defined, either use a navigation config file or pass items directly to render_navigation" unless SimpleNavigation.primary_navigation
       active_item_container = SimpleNavigation.active_item_container_for(options[:level])
       active_item_container.render(options) unless active_item_container.nil?
     end
-    
+
     # Deprecated. Renders the primary_navigation with the configured renderer. Calling render_navigation(:level => 0) has the same effect.
     def render_primary_navigation(options = {})
       ActiveSupport::Deprecation.warn("SimpleNavigation::Helpers.render_primary_navigation has been deprecated. Please use render_navigation(:level => 1) instead")
       render_navigation(options.merge(:level => 1))
     end
-    
+
     # Deprecated. Renders the sub_navigation with the configured renderer. Calling render_navigation(:level => 1) has the same effect.
     def render_sub_navigation(options = {})
       ActiveSupport::Deprecation.warn("SimpleNavigation::Helpers.render_primary_navigation has been deprecated. Please use render_navigation(:level => 2) instead")
@@ -89,10 +87,10 @@ module SimpleNavigation
       end
       options
     end
-    
+
     def deprecated_api!
       ActiveSupport::Deprecation.warn("You are using a deprecated API of SimpleNavigation::Helpers.render_navigation, please check the documentation on http://wiki.github.com/andi/simple-navigation")
     end
-      
+
   end
 end

data/lib/simple_navigation/{renderer → rendering/renderer}/base.rb

@@ -1,70 +1,54 @@
+require 'forwardable'
+
 module SimpleNavigation
   module Renderer
-    
+
     # This is the base class for all renderers.
     #
     # 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 :controller, :options
-
-      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
+      extend Forwardable
+            
+      attr_reader :options, :adapter
       
+      def_delegators :adapter, :link_to, :content_tag
+            
       def initialize(options) #:nodoc:
         @options = options
-        @controller = SimpleNavigation.controller
+        @adapter = SimpleNavigation.adapter
       end
-            
+
       def expand_all?
         !!options[:expand_all]
       end
-      
+
       def level
         options[:level] || :all
       end
-      
+
       def skip_if_empty?
         !!options[:skip_if_empty]
-      end      
-      
+      end
+
       def include_sub_navigation?(item)
         consider_sub_navigation?(item) && expand_sub_navigation?(item)
-      end      
-      
+      end
+
       def render_sub_navigation_for(item)
         item.sub_navigation.render(self.options)
       end
-      
-      # Marks the specified input as html_safe (for Rails3). Does nothing if html_safe is not defined on input. 
-      #
-      def html_safe(input)
-        input.respond_to?(:html_safe) ? input.html_safe : input
-      end
                   
       # Renders the specified ItemContainer to HTML.
       #
       # When implementing a renderer, please consider to call include_sub_navigation? to determin
       # whether an item's sub_navigation should be rendered or not.
-      #  
+      #
       def render(item_container)
         raise 'subclass responsibility'
       end
-         
+
       protected
-      
+
       def consider_sub_navigation?(item)
         return false if item.sub_navigation.nil?
         case level
@@ -77,11 +61,10 @@ module SimpleNavigation
         end
         false
       end
-      
+
       def expand_sub_navigation?(item)
         expand_all? || item.selected?
       end
-      
             
     end
   end

data/lib/simple_navigation/{renderer → rendering/renderer}/breadcrumbs.rb

@@ -1,7 +1,7 @@
 module SimpleNavigation
   module Renderer
-    
-    # Renders an ItemContainer as a <div> element and its containing items as <a> elements. 
+
+    # 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.
@@ -9,10 +9,10 @@ module SimpleNavigation
     # The ItemContainer's dom_class and dom_id are applied to the surrounding <div> element.
     #
     class Breadcrumbs < SimpleNavigation::Renderer::Base
-      
+
       def render(item_container)
         a_tags = a_tags(item_container)
-        content_tag(:div, html_safe(a_tags(item_container).join(join_with)), {:id => item_container.dom_id, :class => item_container.dom_class})
+        content_tag(:div, a_tags(item_container).join(join_with), {:id => item_container.dom_id, :class => item_container.dom_class})
       end
 
       protected
@@ -20,9 +20,9 @@ module SimpleNavigation
       def a_tags(item_container)
         item_container.items.inject([]) do |list, item|
           if item.selected?
-            list << link_to(html_safe(item.name), item.url, {:method => item.method}.merge(item.html_options.except(:class,:id))) 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) 
+              list.concat a_tags(item.sub_navigation)
             end
           end
           list
@@ -33,6 +33,6 @@ module SimpleNavigation
         @join_with ||= options[:join_with] || " "
       end
     end
-    
+
   end
 end

data/lib/simple_navigation/{renderer → rendering/renderer}/links.rb

@@ -1,7 +1,7 @@
 module SimpleNavigation
   module Renderer
-    
-    # Renders an ItemContainer as a <div> element and its containing items as <a> elements. 
+
+    # 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.
@@ -11,15 +11,15 @@ module SimpleNavigation
     # 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(html_safe(item.name), item.url, {:method => item.method}.merge(item.html_options))
+          list << link_to(item.name, item.url, {:method => item.method}.merge(item.html_options))
         end.join
-        content_tag(:div, html_safe(div_content), {:id => item_container.dom_id, :class => item_container.dom_class})
+        content_tag(:div, div_content, {:id => item_container.dom_id, :class => item_container.dom_class})
       end
-      
+
     end
-    
+
   end
 end

data/lib/simple_navigation/{renderer → rendering/renderer}/list.rb

@@ -1,7 +1,7 @@
 module SimpleNavigation
   module Renderer
-    
-    # Renders an ItemContainer as a <ul> element and its containing items as <li> elements. 
+
+    # 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.
@@ -13,19 +13,19 @@ module SimpleNavigation
       def render(item_container)
         list_content = item_container.items.inject([]) do |list, item|
           html_options = item.html_options
-          li_content = link_to(html_safe(item.name), item.url, :class => item.selected_class, :method => item.method)
+          li_content = link_to(item.name, item.url, :class => item.selected_class, :method => item.method)
           if include_sub_navigation?(item)
             li_content << render_sub_navigation_for(item)
-          end  
+          end
           list << content_tag(:li, li_content, html_options)
         end.join
         if skip_if_empty? && item_container.empty?
           ''
         else  
-          content_tag(:ul, html_safe(list_content), {:id => item_container.dom_id, :class => item_container.dom_class}) 
+          content_tag(:ul, list_content, {:id => item_container.dom_id, :class => item_container.dom_class}) 
         end
       end
     end
-    
+
   end
 end

data/rails/init.rb

@@ -1,5 +1 @@
-if Rails::VERSION::MAJOR == 3
-  SimpleNavigation::Initializer::Rails3.run
-else
-  SimpleNavigation::Initializer::Rails2.run
-end
+SimpleNavigation.register