simple-navigation 2.7.3 → 3.0.0.beta1

data/lib/simple_navigation/adapters/padrino.rb

@@ -0,0 +1,20 @@
+module SimpleNavigation
+  module Adapters
+    class Padrino < Sinatra
+      
+      def self.register
+        SimpleNavigation.set_env(PADRINO_ROOT, PADRINO_ENV)
+        ::Padrino::Application.send(:helpers, SimpleNavigation::Helpers)
+      end
+            
+      def link_to(name, url, options={})
+        context.link_to name, url, options
+      end
+      
+      def content_tag(type, content, options={})
+        context.content_tag type, content, options
+      end
+      
+    end
+  end
+end

data/lib/simple_navigation/adapters/rails.rb

@@ -0,0 +1,93 @@
+module SimpleNavigation
+  module Adapters
+    class Rails < Base
+            
+      attr_reader :controller, :template
+
+      def self.register
+        SimpleNavigation.set_env(rails_root, rails_env)        
+        ActionController::Base.send(:include, SimpleNavigation::Helpers)
+        ActionController::Base.send(:helper_method, :render_navigation)
+      end
+      
+      def initialize(context)
+        @controller = extract_controller_from context
+        @template = template_from @controller
+        @request = @template.request if @template
+      end
+      
+      def request_uri
+        return '' unless request
+        return request.fullpath if request.respond_to?(:fullpath)
+        request.request_uri
+      end
+      
+      def request_path
+        return '' unless request
+        request.path
+      end
+      
+      def context_for_eval
+        raise 'no context set for evaluation the config file' unless template || controller
+        template || controller
+      end
+      
+      def current_page?(url)
+        template.current_page?(url) if template
+      end
+      
+      def link_to(name, url, options={})
+        template.link_to(html_safe(name), url, options) if template
+      end
+      
+      def content_tag(type, content, options={})
+        template.content_tag(type, html_safe(content), options) if template
+      end
+      
+      protected
+      
+      def self.rails_root
+        rails3? ? ::Rails.root : ::RAILS_ROOT
+      end
+      
+      def self.rails_env
+        rails3? ? ::Rails.env : ::RAILS_ENV
+      end
+      
+      def self.rails3?
+        ::Rails::VERSION::MAJOR == 3
+      end
+      
+      def template_from(controller)
+        controller.instance_variable_get(:@template) || (controller.respond_to?(:view_context) ? controller.view_context : nil)
+      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
+      
+      # Extracts a controller from the context.
+      def extract_controller_from(context)
+        if context.respond_to? :controller
+          context.controller
+        else
+          context
+        end
+      end
+         
+    end
+  end
+end
+
+# Initializer for Rails3
+if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  module SimpleNavigation                                                                                                
+    class Railtie < Rails::Railtie                                                                                       
+      initializer "simple_navigation.register" do |app|                                                             
+        SimpleNavigation.register
+      end                                                                                                                
+    end                                                                                                                  
+  end
+end

data/lib/simple_navigation/adapters/sinatra.rb

@@ -0,0 +1,76 @@
+module SimpleNavigation
+  module Adapters
+    class Sinatra < Base
+      
+      def self.register
+        SimpleNavigation.set_env(sinatra_root, sinatra_environment)
+        ::Sinatra::Application.send(:helpers, SimpleNavigation::Helpers)
+      end
+      
+      def initialize(context)
+        @context = context
+        @request = context.request
+      end
+
+      def context_for_eval
+        raise 'no context set for evaluation the config file' unless context
+        context
+      end
+      
+      def request_uri
+        request.fullpath
+      end
+      
+      def request_path
+        request.path
+      end
+      
+      def current_page?(url)
+        url_string = CGI.unescape(url)
+        if url_string.index("?")
+          uri = request_uri
+        else
+          uri = request_uri.split('?').first
+        end
+        if url_string =~ /^\w+:\/\//
+          url_string == "#{request.protocol}#{request.host_with_port}#{uri}"
+        else
+          url_string == uri
+        end        
+      end
+      
+      def link_to(name, url, options={})
+        "<a href='#{url}' #{to_attributes(options)}>#{name}</a>"
+      end
+      
+      def content_tag(type, content, options={})
+        "<#{type} #{to_attributes(options)}>#{content}</#{type}>"
+      end
+      
+      protected
+      
+      def self.sinatra_root
+        ::Sinatra::Application.root
+      end
+      
+      def self.sinatra_environment
+        ::Sinatra::Application.environment
+      end
+      
+      def to_attributes(options)
+        options.map {|k, v| "#{k}='#{v}'"}.join(' ')
+      end
+      
+    end
+  end
+end
+
+module SimpleNavigation
+  
+  # Adds registered method to SimpleNavigation. This is called when executing 'register SimpleNavigation'.
+  def self.registered(app)
+    register
+    app.helpers Helpers
+  end
+  
+end

data/lib/simple_navigation/core.rb

@@ -0,0 +1,5 @@
+require 'simple_navigation/core/configuration'
+require 'simple_navigation/core/item_adapter'
+require 'simple_navigation/core/item'
+require 'simple_navigation/core/item_container'
+require 'simple_navigation/core/items_provider'

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

@@ -1,29 +1,28 @@
 require 'singleton'
 
 module SimpleNavigation
-  
-  # Responsible for evaluating and handling the config/navigation.rb file. 
+
+  # Responsible for evaluating and handling the config/navigation.rb file.
   class Configuration
     include Singleton
-    
+
     attr_accessor :renderer, :selected_class, :autogenerate_item_ids, :id_generator, :auto_highlight
     attr_reader :render_all_levels, :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)
-        SimpleNavigation.set_template_from context
+      # Evals the config_file for the given navigation_context
+      def eval_config(navigation_context = :default)
         SimpleNavigation.context_for_eval.instance_eval(SimpleNavigation.config_files[navigation_context])
       end
-      
+
       # Starts processing the configuration
       def run(&block)
         block.call Configuration.instance
-      end    
-      
+      end
+
     end #class << self
-    
+
     # Sets the config's default-settings
     def initialize
       @renderer = SimpleNavigation.default_renderer || SimpleNavigation::Renderer::List
@@ -32,17 +31,17 @@ module SimpleNavigation
       @id_generator = Proc.new {|id| id.to_s }
       @auto_highlight = true
     end
-  
+
     # Adds a deprecation warning when this options is set in the config file
     def render_all_levels=(do_it)
       ActiveSupport::Deprecation.warn("Setting render_all_levels in the config-file has been deprected. Please use render_navigation(:expand_all => true) instead")
       @render_all_levels = do_it
     end
-  
+
     # This is the main method for specifying the navigation items. It can be used in two ways:
-    # 
+    #
     # 1. Declaratively specify your items in the config/navigation.rb file using a block. It then yields an SimpleNavigation::ItemContainer for adding navigation items.
-    # 1. Directly provide your items to the method (e.g. when loading your items from the database). Either specify 
+    # 1. Directly provide your items to the method (e.g. when loading your items from the database). Either specify
     #
     # ==== Example for block style
     #   config.items do |primary|
@@ -66,15 +65,11 @@ module SimpleNavigation
         @primary_navigation.items = SimpleNavigation::ItemsProvider.new(items_provider).items
       end
     end
-    
+
     # Returns true if the config_file has already been evaluated.
     def loaded?
       !@primary_navigation.nil?
     end    
-    
-    def context_for_eval
-      self.class.context_for_eval
-    end
         
   end  
   

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

@@ -1,13 +1,13 @@
 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, :highlights_on
     attr_writer :html_options
-    
+
     # see ItemContainer#item
     #
-    # The subnavigation (if any) is either provided by a block or passed in directly as <tt>items</tt> 
+    # The subnavigation (if any) is either provided by a block or passed in directly as <tt>items</tt>
     def initialize(container, key, name, url, options, items=nil, &sub_nav_block)
       @container = container
       @key = key
@@ -22,7 +22,7 @@ module SimpleNavigation
         @sub_navigation.items = items if items
       end
     end
-    
+
     # Returns true if this navigation item should be rendered as 'selected'.
     # An item is selected if
     #
@@ -33,14 +33,14 @@ module SimpleNavigation
     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. 
+    # It also adds the 'selected' class to the list of classes if necessary.
     def html_options
       default_options = self.autogenerate_item_ids? ? {:id => autogenerated_item_id} : {}
       options = default_options.merge(@html_options)
       options[:class] = [@html_options[:class], self.selected_class].flatten.compact.join(' ')
-      options.delete(:class) if options[:class].blank?
+      options.delete(:class) if options[:class].nil? || options[:class] == ''
       options
     end
 
@@ -57,9 +57,8 @@ module SimpleNavigation
       sub_navigation && sub_navigation.selected?
     end
 
-    # Return true if item has explicitly selected in controllers
     def selected_by_config?
-      key == @container.current_explicit_navigation
+      false
     end
 
     # Returns true if the item's url matches the request's current url.
@@ -68,7 +67,7 @@ module SimpleNavigation
         raise ArgumentError, ':highlights_on must be a regexp' unless highlights_on.instance_of?(Regexp)
         SimpleNavigation.request_uri =~ highlights_on
       elsif auto_highlight?
-        !!(root_path_match? || (SimpleNavigation.template && SimpleNavigation.template.current_page?(url)))
+        !!(root_path_match? || SimpleNavigation.current_page?(url))
       else
         false
       end
@@ -76,7 +75,7 @@ module SimpleNavigation
 
     # 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 == '/'
+      url == '/' && SimpleNavigation.request_path == '/'
     end
 
     # Returns true if the item's id should be added to the rendered output.

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

@@ -1,5 +1,7 @@
+require 'forwardable'
+
 module SimpleNavigation
-  
+
   # This class acts as an adapter to items that are not defined using the DSL in the config/navigation.rb, but directly provided inside the application.
   # When defining the items that way, every item you provide needs to define the following methods:
   #
@@ -8,34 +10,36 @@ module SimpleNavigation
   # * <tt>url</tt>
   #
   # and optionally
-  # 
+  #
   # * <tt>options</tt>
   # * <tt>items</tt> - if one of your items has a subnavigation it must respond to <tt>items</tt> providing the subnavigation.
   #
   # See SimpleNavigation::ItemContainer#item for the purpose of these methods.
   class ItemAdapter
-    delegate :key, :name, :url, :to => :item
+    extend Forwardable
     
+    def_delegators :item, :key, :name, :url
+
     attr_reader :item
 
     def initialize(item)
       @item = item
     end
-        
+
     # Returns the options for this item. If the wrapped item does not implement an options method, an empty hash is returned.
     def options
       @item.respond_to?(:options) ? @item.options : {}
     end
-    
+
     # Returns the items (subnavigation) for this item if it responds to :items and the items-collection is not empty. Returns nil otherwise.
     def items
       (@item.respond_to?(:items) && !(@item.items.nil? || @item.items.empty?)) ? @item.items : nil
     end
-    
+
     # Converts this Item into a SimpleNavigation::Item
     def to_simple_navigation_item(item_container)
       SimpleNavigation::Item.new(item_container, key, name, url, options, items)
     end
-    
+
   end
 end

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

@@ -1,25 +1,25 @@
 module SimpleNavigation
-  
+
   # Holds the Items for a navigation 'level'.
   class ItemContainer
-    
+
     attr_reader :items, :level
     attr_accessor :renderer, :dom_id, :dom_class, :auto_highlight
-    
+
     def initialize(level=1) #:nodoc:
       @level = level
       @items = []
       @renderer = SimpleNavigation.config.renderer
       @auto_highlight = true
     end
-    
-    # Creates a new navigation item. 
+
+    # 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>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>any html_attributes</tt> - will be included in the rendered navigation item (e.g. id, class etc.)
@@ -30,7 +30,7 @@ module SimpleNavigation
     #   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.
     # * <tt>:method</tt> - Specifies the http-method for the generated link - default is :get.
-    # * <tt>:highlights_on</tt> - if autohighlighting is turned off and/or you want to explicitly specify 
+    # * <tt>:highlights_on</tt> - if autohighlighting is turned off and/or you want to explicitly specify
     #   when the item should be highlighted, you can set a regexp which is matched againstthe current URI.
     #
     # The <tt>block</tt> - if specified - will hold the item's sub_navigation.
@@ -66,7 +66,7 @@ module SimpleNavigation
       end
       return nil
     end
-  
+
     # Renders the items in this ItemContainer using the configured renderer.
     #
     # The options are the same as in the view's render_navigation call (they get passed on)
@@ -92,14 +92,7 @@ module SimpleNavigation
     # 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)
+      items.find {|i| i.selected?}
     end
 
     # Returns the active item_container for the specified level
@@ -117,7 +110,7 @@ module SimpleNavigation
     end
 
     private
-    
+
     def selected_sub_navigation?
       !!(selected_item && selected_item.sub_navigation)
     end
@@ -127,7 +120,7 @@ module SimpleNavigation
       [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
@@ -137,7 +130,7 @@ module SimpleNavigation
           raise ArgumentError, ":if or :unless must be procs or lambdas"
       end
     end
-    
+
   end
-  
+
 end