simple-navigation 3.12.0 → 3.12.1

data/lib/simple_navigation/adapters/padrino.rb

@@ -1,20 +1,18 @@
 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={})
+
+      def link_to(name, url, options = {})
         context.link_to(name, url, options)
       end
-      
-      def content_tag(type, content, options={})
+
+      def content_tag(type, content, options = {})
         context.content_tag(type, content.html_safe, options)
       end
-      
     end
   end
-end
+end

data/lib/simple_navigation/adapters/rails.rb

@@ -1,97 +1,110 @@
 module SimpleNavigation
   module Adapters
     class Rails < Base
-            
       attr_reader :controller, :template
 
       def self.register
-        SimpleNavigation.set_env(rails_root, rails_env)        
+        SimpleNavigation.set_env(rails_root, rails_env)
         ActionController::Base.send(:include, SimpleNavigation::Helpers)
         SimpleNavigation::Helpers.instance_methods.each do |m|
           ActionController::Base.send(:helper_method, m.to_sym)
         end
       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
+
+        if request.respond_to?(:fullpath)
+          request.fullpath
+        else
+          request.request_uri
+        end
       end
-      
+
       def request_path
-        return '' unless request
-        request.path
+        request ? request.path : ''
       end
-      
+
       def context_for_eval
-        raise 'no context set for evaluation the config file' unless template || controller
-        template || controller
+        template   ||
+        controller ||
+        fail('no context set for evaluation the config file')
       end
-      
+
       def current_page?(url)
-        template.current_page?(url) if template
+        template && template.current_page?(url)
       end
-      
-      def link_to(name, url, options={})
-        template.link_to(link_title(name), url, options) if template
+
+      def link_to(name, url, options = {})
+        template && template.link_to(link_title(name), url, options)
       end
-      
-      def content_tag(type, content, options={})
-        template.content_tag(type, html_safe(content), options) if template
+
+      def content_tag(type, content, options = {})
+        template && template.content_tag(type, html_safe(content), options)
       end
-      
+
       protected
-      
+
       def self.rails_root
         gte_rails3? ? ::Rails.root : ::RAILS_ROOT
       end
-      
+
       def self.rails_env
         gte_rails3? ? ::Rails.env : ::RAILS_ENV
       end
-      
+
       def self.gte_rails3?
         ::Rails::VERSION::MAJOR >= 3
       end
-      
+
       def template_from(controller)
-        controller.respond_to?(:view_context) ? controller.view_context : controller.instance_variable_get(:@template)
+        if controller.respond_to?(:view_context)
+          controller.view_context
+        else
+          controller.instance_variable_get(:@template)
+        end
       end
-      
-      # Marks the specified input as html_safe (for Rails3). Does nothing if html_safe is not defined on input. 
+
+      # 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)
-        context.respond_to?(:controller) ?
-          context.controller || context :
+        if context.respond_to?(:controller)
+          context.controller || context
+        else
           context
+        end
       end
 
-      def link_title name
-        SimpleNavigation.config.consider_item_names_as_safe ? html_safe(name) : name
+      def link_title(name)
+        if SimpleNavigation.config.consider_item_names_as_safe
+          html_safe(name)
+        else
+          name
+        end
       end
-         
     end
   end
 end
 
 # Initializer for Rails3
 if defined?(Rails) && SimpleNavigation::Adapters::Rails.gte_rails3?
-  module SimpleNavigation                                                                                                
-    class Railtie < Rails::Railtie                                                                                       
-      initializer "simple_navigation.register" do |app|                                                             
+  module SimpleNavigation
+    class Railtie < Rails::Railtie
+      initializer 'simple_navigation.register' do |app|
         SimpleNavigation.register
-      end                                                                                                                
-    end                                                                                                                  
+      end
+    end
   end
 end

data/lib/simple_navigation/adapters/sinatra.rb

@@ -3,7 +3,6 @@ require 'cgi'
 module SimpleNavigation
   module Adapters
     class Sinatra < Base
-
       def self.register
         SimpleNavigation.set_env(sinatra_root, sinatra_environment)
         ::Sinatra::Application.send(:helpers, SimpleNavigation::Helpers)
@@ -15,8 +14,7 @@ module SimpleNavigation
       end
 
       def context_for_eval
-        raise 'no context set for evaluation the config file' unless context
-        context
+        context || fail('no context set for evaluation the config file')
       end
 
       def request_uri
@@ -29,24 +27,24 @@ module SimpleNavigation
 
       def current_page?(url)
         url_string = CGI.unescape(url)
-        if url_string.index("?")
-          uri = request_uri
-        else
-          uri = request_uri.split('?').first
-        end
-        uri = CGI.unescape(uri)
-        if url_string =~ /^\w+:\/\//
-          url_string == "#{request.scheme}://#{request.host_with_port}#{uri}"
-        else
-          url_string == uri
+        uri = if url_string.index('?')
+                request_uri
+              else
+                request_uri.split('?').first
+              end
+
+        if url_string =~ %r(^\w+://)
+          uri = "#{request.scheme}://#{request.host_with_port}#{uri}"
         end
+
+        url_string == CGI.unescape(uri)
       end
 
-      def link_to(name, url, options={})
+      def link_to(name, url, options = {})
         "<a href='#{url}'#{to_attributes(options)}>#{name}</a>"
       end
 
-      def content_tag(type, content, options={})
+      def content_tag(type, content, options = {})
         "<#{type}#{to_attributes(options)}>#{content}</#{type}>"
       end
 
@@ -61,9 +59,8 @@ module SimpleNavigation
       end
 
       def to_attributes(options)
-        options.map {|k, v| v.nil? ? '' : " #{k}='#{v}'"}.join
+        options.map { |k, v| v.nil? ? '' : " #{k}='#{v}'" }.join
       end
-
     end
   end
 end

data/lib/simple_navigation/core/configuration.rb

@@ -1,47 +1,65 @@
 require 'singleton'
 
 module SimpleNavigation
-
   # Responsible for evaluating and handling the config/navigation.rb file.
   class Configuration
     include Singleton
 
-    attr_accessor :renderer, :selected_class, :active_leaf_class, :autogenerate_item_ids, :id_generator, :auto_highlight, :name_generator, :consider_item_names_as_safe
-    attr_reader :primary_navigation
+    attr_accessor :autogenerate_item_ids,
+                  :auto_highlight,
+                  :consider_item_names_as_safe
 
-    class << self
+    attr_reader :primary_navigation
 
-      # 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
+    attr_writer :active_leaf_class,
+                :id_generator,
+                :name_generator,
+                :renderer,
+                :selected_class
 
-      # Starts processing the configuration
-      def run(&block)
-        block.call Configuration.instance
-      end
+    # Evals the config_file for the given navigation_context
+    def self.eval_config(navigation_context = :default)
+      context = SimpleNavigation.config_files[navigation_context]
+      SimpleNavigation.context_for_eval.instance_eval(context)
+    end
 
-    end #class << self
+    # Starts processing the configuration
+    def self.run(&block)
+      block.call Configuration.instance
+    end
 
     # Sets the config's default-settings
     def initialize
-      @renderer = SimpleNavigation.default_renderer || SimpleNavigation::Renderer::List
-      @selected_class = 'selected'
-      @active_leaf_class = 'simple-navigation-active-leaf'
       @autogenerate_item_ids = true
-      @id_generator = Proc.new {|id| id.to_s }
-      @name_generator = Proc.new {|name| name}
       @auto_highlight = true
       @consider_item_names_as_safe = true
+
       if defined?(ActiveSupport::Deprecation)
-        ActiveSupport::Deprecation.warn "simple-navigation: consider_item_names_as_safe will be set to false by default in 3.13.0 release, hence item names will be considered unsafe by default. See https://github.com/codeplant/simple-navigation/wiki", caller
+        ActiveSupport::Deprecation.warn 'simple-navigation: ' \
+          'consider_item_names_as_safe will be set to false ' \
+          'by default in 3.13.0 release, hence item names '   \
+          'will be considered unsafe by default. '            \
+          'See https://github.com/codeplant/simple-navigation/wiki',
+          caller
       end
     end
 
-    # This is the main method for specifying the navigation items. It can be used in two ways:
+    def active_leaf_class
+      @active_leaf_class ||= 'simple-navigation-active-leaf'
+    end
+
+    def id_generator
+      @id_generator ||= :to_s.to_proc
+    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).
+    # 1. Declaratively specify your items in the config/navigation.rb file
+    #    using a block. It then yields an SimpleNavigation::ItemContainer
+    #    for adding navigation items.
+    # 2. Directly provide your items to the method (e.g. when loading your
+    #    items from the database).
     #
     # ==== Example for block style (configuration file)
     #   config.items do |primary|
@@ -51,26 +69,47 @@ module SimpleNavigation
     #
     # ==== To consider when directly providing items
     # items_provider should be:
-    # * a methodname (as symbol) that returns your items. The method needs to be available in the view (i.e. a helper method)
+    # * a methodname (as symbol) that returns your items. The method needs to
+    #   be available in the view (i.e. a helper method)
     # * an object that responds to :items
     # * an enumerable containing your items
-    # The items you specify have to fullfill certain requirements. See SimpleNavigation::ItemAdapter for more details.
+    # The items you specify have to fullfill certain requirements.
+    # See SimpleNavigation::ItemAdapter for more details.
     #
-    def items(items_provider=nil, &block)
-      raise 'please specify either items_provider or block, but not both' if (items_provider && block) || (items_provider.nil? && block.nil?)
-      @primary_navigation = ItemContainer.new
+    def items(items_provider = nil, &block)
+      if (items_provider && block) || (items_provider.nil? && block.nil?)
+        fail('please specify either items_provider or block, but not both')
+      end
+
+      self.primary_navigation = ItemContainer.new
+
       if block
-        block.call @primary_navigation
+        block.call primary_navigation
       else
-        @primary_navigation.items = SimpleNavigation::ItemsProvider.new(items_provider).items
+        primary_navigation.items = ItemsProvider.new(items_provider).items
       end
     end
 
     # Returns true if the config_file has already been evaluated.
     def loaded?
-      !@primary_navigation.nil?
-    end    
-        
-  end  
-  
+      !primary_navigation.nil?
+    end
+
+    def name_generator
+      @name_generator ||= proc { |name| name }
+    end
+
+    def renderer
+      @renderer ||= SimpleNavigation.default_renderer ||
+                    SimpleNavigation::Renderer::List
+    end
+
+    def selected_class
+      @selected_class ||= 'selected'
+    end
+
+    private
+
+    attr_writer :primary_navigation
+  end
 end

data/lib/simple_navigation/core/item.rb

@@ -1,35 +1,37 @@
 module SimpleNavigation
-
-  # Represents an item in your navigation. Gets generated by the item method in the config-file.
+  # Represents an item in your navigation.
+  # Gets generated by the item method in the config-file.
   class Item
-    attr_reader :key, :url, :sub_navigation, :method, :highlights_on
+    attr_reader :highlights_on,
+                :key,
+                :method,
+                :sub_navigation,
+                :url
+
     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>
-    def initialize(container, key, name, url_or_options = {}, options_or_nil={}, items=nil, &sub_nav_block)
-      @container = container
+    # The subnavigation (if any) is either provided by a block or
+    # passed in directly as <tt>items</tt>
+    def initialize(container, key, name, url_or_options = {}, options_or_nil = {}, items = nil, &sub_nav_block)
       options = setup_url_and_options(url_or_options, options_or_nil)
-      @container.dom_class = options.delete(:container_class) if options[:container_class]
-      @container.dom_id = options.delete(:container_id) if options[:container_id]
-      @container.dom_attributes = options[:container_attributes] ? options.delete(:container_attributes) : {}
-      @container.selected_class = options.delete(:selected_class) if options[:selected_class]
+
       @key = key
       @method = options.delete(:method)
       @name = name
-      if sub_nav_block || items
-        @sub_navigation = ItemContainer.new(@container.level + 1)
-        sub_nav_block.call @sub_navigation if sub_nav_block
-        @sub_navigation.items = items if items
-      end
+      @container = setup_container(container, options)
+
+      setup_sub_navigation(items, &sub_nav_block)
     end
 
-    # Returns the item's name. If option :apply_generator is set to true (default),
-    # the name will be passed to the name_generator specified in the configuration.
+    # Returns the item's name.
+    # If :apply_generator option is set to true (default),
+    # the name will be passed to the name_generator specified
+    # in the configuration.
     #
     def name(options = {})
-      options.reverse_merge!(:apply_generator => true)
+      options = { apply_generator: true }.merge(options)
       if (options[:apply_generator])
         SimpleNavigation.config.name_generator.call(@name, self)
       else
@@ -45,34 +47,45 @@ module SimpleNavigation
     # * its url matches the url of the current request (auto highlighting)
     #
     def selected?
-      @selected = @selected || selected_by_config? || selected_by_subnav? || selected_by_condition?
+      @selected ||= selected_by_config?    ||
+                    selected_by_subnav?    ||
+                    selected_by_condition?
     end
 
-    # Returns the html-options hash for the item, i.e. the options specified for this item in the config-file.
+    # 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
-      default_options = self.autogenerate_item_ids? ? {:id => autogenerated_item_id} : {}
-      options = default_options.merge(@html_options)
-      options[:class] = [@html_options[:class], self.selected_class, self.active_leaf_class].flatten.compact.join(' ')
-      options.delete(:class) if options[:class].nil? || options[:class] == ''
+      options = @html_options
+      options[:id] ||= autogenerated_item_id if autogenerate_item_ids?
+
+      classes = [@html_options[:class], selected_class, active_leaf_class]
+      classes = classes.flatten.compact.join(' ')
+      options[:class] = classes unless classes.nil? || classes.empty?
+
       options
     end
 
     # Returns the configured active_leaf_class if the item is the selected leaf,
     # nil otherwise
     def active_leaf_class
-      !selected_by_subnav? && selected_by_condition? ? SimpleNavigation.config.active_leaf_class : nil
+      if !selected_by_subnav? && selected_by_condition?
+        SimpleNavigation.config.active_leaf_class
+      end
     end
 
     # Returns the configured selected_class if the item is selected,
     # nil otherwise
     def selected_class
-      selected? ? (@container.selected_class || SimpleNavigation.config.selected_class) : nil
+      if selected?
+        container.selected_class || SimpleNavigation.config.selected_class
+      end
     end
 
     protected
 
-    # Returns true if item has a subnavigation and the sub_navigation is selected
+    # Returns true if item has a subnavigation and
+    # the sub_navigation is selected
     def selected_by_subnav?
       sub_navigation && sub_navigation.selected?
     end
@@ -83,22 +96,7 @@ module SimpleNavigation
 
     # Returns true if the item's url matches the request's current url.
     def selected_by_condition?
-      if highlights_on
-        case highlights_on
-        when Regexp
-          SimpleNavigation.request_uri =~ highlights_on
-        when Proc
-          highlights_on.call
-        when :subpath
-          !!(SimpleNavigation.request_uri =~ /^#{Regexp.escape url_without_anchor}(\/|$|\?)/i)
-        else
-          raise ArgumentError, ':highlights_on must be a Regexp, Proc or :subpath'
-        end
-      elsif auto_highlight?
-        !!(root_path_match? || (url_without_anchor && SimpleNavigation.current_page?(url_without_anchor)))
-      else
-        false
-      end
+      highlights_on ? selected_by_highlights_on? : selected_by_autohighlight?
     end
 
     # Returns true if both the item's url and the request's url are root_path
@@ -118,7 +116,7 @@ module SimpleNavigation
 
     # Return true if auto_highlight is on for this item.
     def auto_highlight?
-      SimpleNavigation.config.auto_highlight && @container.auto_highlight
+      SimpleNavigation.config.auto_highlight && container.auto_highlight
     end
 
     def url_without_anchor
@@ -126,20 +124,78 @@ module SimpleNavigation
     end
 
     private
+
+    attr_reader :container
+
+    attr_writer :highlights_on,
+                :sub_navigation,
+                :url
+
+    def selected_by_autohighlight?
+      auto_highlight? &&
+      (root_path_match? ||
+       (url_without_anchor &&
+        SimpleNavigation.current_page?(url_without_anchor)))
+    end
+
+    def selected_by_highlights_on?
+      return false unless highlights_on
+
+      case highlights_on
+      when Regexp then SimpleNavigation.request_uri =~ highlights_on
+      when Proc then highlights_on.call
+      when :subpath
+        escaped_url = Regexp.escape(url_without_anchor)
+        !!(SimpleNavigation.request_uri =~ /^#{escaped_url}(\/|$|\?)/i)
+      else
+        fail ArgumentError, ':highlights_on must be a Regexp, Proc or :subpath'
+      end
+    end
+
+    def setup_container(container, options = {})
+      if options[:container_class]
+        container.dom_class = options.delete(:container_class)
+      end
+
+      if options[:container_id]
+        container.dom_id = options.delete(:container_id)
+      end
+
+      container.dom_attributes = if options[:container_attributes]
+                                   options.delete(:container_attributes)
+                                 else
+                                   {}
+                                 end
+
+      if options[:selected_class]
+        container.selected_class = options.delete(:selected_class)
+      end
+
+      container
+    end
+
     def setup_url_and_options(url_or_options, options_or_nil)
-      options = options_or_nil
-      url = url_or_options
       case url_or_options
-      when Hash
-        # url_or_options is options (there is no url)
-        options = url_or_options
-      when Proc
-        @url = url.call
+      when Hash then options = url_or_options # there is no url
+      when Proc then self.url = url_or_options.call
+      else self.url = url_or_options
+      end
+
+      options ||= options_or_nil
+      self.highlights_on = options.delete(:highlights_on)
+      self.html_options = options
+    end
+
+    def setup_sub_navigation(items = nil, &sub_nav_block)
+      return unless sub_nav_block || items
+
+      self.sub_navigation = ItemContainer.new(container.level + 1)
+
+      if sub_nav_block
+        sub_nav_block.call sub_navigation
       else
-        @url = url
+        sub_navigation.items = items
       end
-      @highlights_on = options.delete(:highlights_on)
-      @html_options = options
     end
   end
 end