simple-navigation 3.14.0 → 4.0.0

data/README.md

@@ -5,7 +5,7 @@
 [![Code Climate](https://codeclimate.com/github/codeplant/simple-navigation.png)](https://codeclimate.com/github/codeplant/simple-navigation)
 [![Coverage Status](https://coveralls.io/repos/codeplant/simple-navigation/badge.png)](https://coveralls.io/r/codeplant/simple-navigation)
 
-Simple Navigation is a ruby library for creating navigations (with multiple levels) for your Rails 2, Rails 3, Rails 4, Sinatra or Padrino applications. It runs with all ruby versions (including ruby 2.0).
+Simple Navigation is a ruby library for creating navigations (with multiple levels) for your Rails 2, Rails 3, Rails 4, Sinatra or Padrino applications. It runs with all ruby versions (including ruby 2.x).
 
 ## Documentation
 

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_JOBS: 4

data/gemfiles/rails-3-2-stable.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'railties', '~> 3.2.0'
+gem 'rspec-rails', '~> 3.2.1'
+
+if RUBY_VERSION >= '2.2.0'
+  gem 'test-unit', '~> 3.0'
+end
+
+gemspec path: '../'

data/gemfiles/rails-4-1-stable.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'railties', '~> 4.1.0'
+gem 'rspec-rails', '~> 3.2.1'
+
+gemspec path: '../'

data/gemfiles/rails-4-2-stable.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'launchy'
+gem 'railties', '~> 4.2.0'
+gem 'rspec-rails', '~> 3.2.1'
+
+gemspec path: '../'

data/generators/navigation_config/navigation_config_generator.rb

@@ -2,7 +2,6 @@ class NavigationConfigGenerator < Rails::Generator::Base
   def manifest
     record do |m|
       m.file 'config/navigation.rb', 'config/navigation.rb'
-      m.readme '../../../README.md'
     end
   end
 end

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

@@ -4,35 +4,38 @@ SimpleNavigation::Configuration.run do |navigation|
   # Specify a custom renderer if needed.
   # The default renderer is SimpleNavigation::Renderer::List which renders HTML lists.
   # The renderer can also be specified as option in the render_navigation call.
-  # navigation.renderer = Your::Custom::Renderer
+  #navigation.renderer = Your::Custom::Renderer
 
-  # Specify the class that will be applied to active navigation items.
-  # Defaults to 'selected' navigation.selected_class = 'your_selected_class'
+  # Specify the class that will be applied to active navigation items. Defaults to 'selected' 
+  #navigation.selected_class = 'selected'
 
   # Specify the class that will be applied to the current leaf of
   # active navigation items. Defaults to 'simple-navigation-active-leaf'
-  # navigation.active_leaf_class = 'your_active_leaf_class'
+  #navigation.active_leaf_class = 'simple-navigation-active-leaf'
 
-  # Item keys are normally added to list items as id.
-  # This setting turns that off
-  # navigation.autogenerate_item_ids = false
+  # Specify if item keys are added to navigation items as id. Defaults to true
+  #navigation.autogenerate_item_ids = true
 
   # You can override the default logic that is used to autogenerate the item ids.
   # To do this, define a Proc which takes the key of the current item as argument.
   # The example below would add a prefix to each key.
-  # navigation.id_generator = Proc.new {|key| "my-prefix-#{key}"}
+  #navigation.id_generator = Proc.new {|key| "my-prefix-#{key}"}
 
   # If you need to add custom html around item names, you can define a proc that
   # will be called with the name you pass in to the navigation.
   # The example below shows how to wrap items spans.
-  # navigation.name_generator = Proc.new {|name, item| "<span>#{name}</span>"}
+  #navigation.name_generator = Proc.new {|name, item| "<span>#{name}</span>"}
 
-  # The auto highlight feature is turned on by default.
-  # This turns it off globally (for the whole plugin)
-  # navigation.auto_highlight = false
+  # Specify if the auto highlight feature is turned on (globally, for the whole navigation). Defaults to true
+  #navigation.auto_highlight = true
+  
+  # Specifies whether auto highlight should ignore query params and/or anchors when 
+  # comparing the navigation items with the current URL. Defaults to true 
+  #navigation.ignore_query_params_on_auto_highlight = true
+  #navigation.ignore_anchors_on_auto_highlight = true
   
   # If this option is set to true, all item names will be considered as safe (passed through html_safe). Defaults to false.
-  # navigation.consider_item_names_as_safe = false
+  #navigation.consider_item_names_as_safe = false
 
   # Define the primary navigation
   navigation.items do |primary|
@@ -69,9 +72,9 @@ SimpleNavigation::Configuration.run do |navigation|
 
     # you can also specify html attributes to attach to this particular level
     # works for all levels of the menu
-    # primary.dom_attributes = {id: 'menu-id', class: 'menu-class'}
+    #primary.dom_attributes = {id: 'menu-id', class: 'menu-class'}
 
     # You can turn off auto highlighting for a specific level
-    # primary.auto_highlight = false
+    #primary.auto_highlight = false
   end
 end

data/lib/simple_navigation.rb

@@ -4,9 +4,15 @@ require 'active_support/core_ext/hash'
 require 'active_support/core_ext/module/attribute_accessors'
 
 require 'simple_navigation/version'
-require 'simple_navigation/core'
-require 'simple_navigation/rendering'
+require 'simple_navigation/configuration'
+require 'simple_navigation/item_adapter'
+require 'simple_navigation/item'
+require 'simple_navigation/item_container'
+require 'simple_navigation/items_provider'
+require 'simple_navigation/renderer'
 require 'simple_navigation/adapters'
+require 'simple_navigation/config_file_finder'
+require 'simple_navigation/railtie' if defined?(::Rails)
 
 require 'forwardable'
 
@@ -55,7 +61,7 @@ module SimpleNavigation
     def set_env(root, environment)
       self.root = root
       self.environment = environment
-      config_file_paths << SimpleNavigation.default_config_file_path
+      config_file_paths << default_config_file_path
     end
 
     # Returns the current framework in which the plugin is running.
@@ -89,30 +95,6 @@ module SimpleNavigation
       File.join(root, 'config')
     end
 
-    # Returns true if the config_file for specified context does exist.
-    def config_file?(navigation_context = :default)
-      !!config_file(navigation_context)
-    end
-
-    # Returns the path to the config file for the given navigation context or
-    # nil if no matching config file can be found.
-    # If multiple config_paths are set, it returns the first matching path.
-    def config_file(navigation_context = :default)
-      config_file_paths
-        .map { |path| File.join(path, config_file_name(navigation_context)) }
-        .find { |full_path| File.exist?(full_path) }
-    end
-
-    # Returns the name of the config file for the given navigation_context
-    def config_file_name(navigation_context = :default)
-      prefix = if navigation_context == :default
-                 ''
-               else
-                 "#{navigation_context.to_s.underscore}_"
-               end
-      "#{prefix}navigation.rb"
-    end
-
     # Resets the list of config_file_paths to the specified path
     def config_file_path=(path)
       self.config_file_paths = [path]
@@ -121,20 +103,10 @@ module SimpleNavigation
     # Reads the config_file for the specified navigation_context and stores it
     # for later evaluation.
     def load_config(navigation_context = :default)
-      unless config_file?(navigation_context)
-        fail "Config file '#{config_file_name(navigation_context)}' not " \
-             "found in path(s) #{config_file_paths.join(', ')}!"
-      end
-
-      # FIXME: what about update_config and update_config! methods ?
       if environment == 'production'
-        config_files[navigation_context] ||= begin
-          IO.read(config_file(navigation_context))
-        end
+        update_config(navigation_context)
       else
-        config_files[navigation_context] = begin
-          IO.read(config_file(navigation_context))
-        end
+        update_config!(navigation_context)
       end
     end
 
@@ -186,9 +158,20 @@ module SimpleNavigation
 
     private
 
-    def apply_defaults(options)
-      options[:level] = options.delete(:levels) if options[:levels]
-      { context: :default, level: :all }.merge(options)
+    def config_file(navigation_context)
+      ConfigFileFinder.new(config_file_paths).find(navigation_context)
+    end
+
+    def read_config(navigation_context)
+      File.read config_file(navigation_context)
+    end
+
+    def update_config(navigation_context)
+      config_files[navigation_context] ||= read_config(navigation_context)
+    end
+
+    def update_config!(navigation_context)
+      config_files[navigation_context] = read_config(navigation_context)
     end
   end
 end

data/lib/simple_navigation/adapters/rails.rb

@@ -4,7 +4,7 @@ module SimpleNavigation
       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)
@@ -51,18 +51,6 @@ module SimpleNavigation
 
       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)
         if controller.respond_to?(:view_context)
           controller.view_context
@@ -97,14 +85,3 @@ module SimpleNavigation
     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|
-        SimpleNavigation.register
-      end
-    end
-  end
-end

data/lib/simple_navigation/adapters/sinatra.rb

@@ -3,9 +3,8 @@ 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)
+      def self.register(app)
+        SimpleNavigation.set_env(app.root, app.environment)
       end
 
       def initialize(context)
@@ -50,14 +49,6 @@ module SimpleNavigation
 
       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| v.nil? ? '' : " #{k}='#{v}'" }.join
       end

data/lib/simple_navigation/config_file.rb

@@ -0,0 +1,36 @@
+require 'active_support/core_ext/string'
+
+module SimpleNavigation
+  # Internal: Encapsulates the config file naming knowledge.
+  class ConfigFile
+    # Internal: Initializes a ConfigFile.
+    #
+    # context - The navigation context for this ConfigFile.
+    def initialize(context)
+      @prefix = prefix_for_context(context)
+    end
+
+    # Internal: Returns the name of the configuration file on disk.
+    #
+    # Based on the the initialization context the outcome may differ.
+    #
+    # Examples
+    #
+    #   ConfigFile.new.name           # => "navigation.rb"
+    #   ConfigFile.new(:default).name # => "navigation.rb"
+    #   ConfigFile.new(:other).name   # => "other_navigation.rb"
+    #
+    # Returns a String representing the name of the configuration file on disk.
+    def name
+      @name ||= "#{prefix}navigation.rb"
+    end
+
+    private
+
+    attr_reader :prefix
+
+    def prefix_for_context(context)
+      context == :default ? '' : "#{context.to_s.underscore}_"
+    end
+  end
+end

data/lib/simple_navigation/config_file_finder.rb

@@ -0,0 +1,42 @@
+require 'simple_navigation/config_file'
+
+module SimpleNavigation
+  # Internal: Encapsulates the configuration file finding logic.
+  class ConfigFileFinder
+    # Internal: Initializes a ConfigFileFinder.
+    #
+    # paths - an enumerable list of paths in which to look for configuration
+    #         files.
+    def initialize(paths)
+      @paths = paths
+    end
+
+    # Internal: Searches a configuration file for the given context in the
+    # initialization paths.
+    #
+    # context - The navigation context for which to look the configuration file.
+    #
+    # Returns a String representing the full path of the configuation file.
+    # Raises StandardError if no file is found.
+    def find(context)
+      config_file_name = config_file_name_for_context(context)
+
+      find_config_file(config_file_name) ||
+      fail("Config file '#{config_file_name}' not found in " \
+           "path(s) #{paths.join(', ')}!")
+    end
+
+    private
+
+    attr_reader :paths
+
+    def config_file_name_for_context(context)
+      ConfigFile.new(context).name
+    end
+
+    def find_config_file(config_file_name)
+      paths.map { |path| File.join(path, config_file_name) }
+           .find { |full_path| File.exist?(full_path) }
+    end
+  end
+end

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

@@ -7,7 +7,10 @@ module SimpleNavigation
 
     attr_accessor :autogenerate_item_ids,
                   :auto_highlight,
-                  :consider_item_names_as_safe
+                  :consider_item_names_as_safe,
+                  :highlight_on_subpath,
+                  :ignore_query_params_on_auto_highlight,
+                  :ignore_anchors_on_auto_highlight
 
     attr_reader :primary_navigation
 
@@ -33,6 +36,9 @@ module SimpleNavigation
       @autogenerate_item_ids = true
       @auto_highlight = true
       @consider_item_names_as_safe = false
+      @highlight_on_subpath = false
+      @ignore_anchors_on_auto_highlight = true
+      @ignore_query_params_on_auto_highlight = true
     end
 
     def active_leaf_class

data/lib/simple_navigation/{rendering/helpers.rb → helpers.rb}

@@ -34,10 +34,6 @@ module SimpleNavigation
         SimpleNavigation.config.items(options[:items], &block)
       end
 
-      if SimpleNavigation.respond_to?(:handle_explicit_navigation)
-        SimpleNavigation.handle_explicit_navigation
-      end
-
       unless SimpleNavigation.primary_navigation
         fail 'no primary navigation defined, either use a navigation config ' \
              'file or pass items directly to render_navigation'

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

@@ -2,27 +2,23 @@ module SimpleNavigation
   # Represents an item in your navigation.
   # Gets generated by the item method in the config-file.
   class Item
-    attr_reader :highlights_on,
-                :key,
-                :method,
+    attr_reader :key,
+                :name,
                 :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)
-      options = setup_url_and_options(url_or_options, options_or_nil)
-
-      @key = key
-      @method = options.delete(:method)
-      @name = name
-      @container = setup_container(container, options)
+    def initialize(container, key, name, url = nil, opts = {}, &sub_nav_block)
+      self.container = container
+      self.key = key
+      self.name = name.respond_to?(:call) ? name.call : name
+      self.url =  url.respond_to?(:call) ? url.call : url
+      self.options = opts
 
-      setup_sub_navigation(items, &sub_nav_block)
+      setup_sub_navigation(options[:items], &sub_nav_block)
     end
 
     # Returns the item's name.
@@ -32,8 +28,8 @@ module SimpleNavigation
     #
     def name(options = {})
       options = { apply_generator: true }.merge(options)
-      if (options[:apply_generator])
-        SimpleNavigation.config.name_generator.call(@name, self)
+      if options[:apply_generator]
+        config.name_generator.call(@name, self)
       else
         @name
       end
@@ -42,35 +38,32 @@ module SimpleNavigation
     # 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_by_config?    ||
-                    selected_by_subnav?    ||
-                    selected_by_condition?
+      @selected ||= 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.
     # It also adds the 'selected' class to the list of classes if necessary.
     def html_options
-      options = @html_options
-      options[:id] ||= autogenerated_item_id if autogenerate_item_ids?
+      html_opts = options.fetch(:html) { Hash.new }
+      html_opts[:id] ||= autogenerated_item_id
 
-      classes = [@html_options[:class], selected_class, active_leaf_class]
+      classes = [html_opts[:class], selected_class, active_leaf_class]
       classes = classes.flatten.compact.join(' ')
-      options[:class] = classes unless classes.nil? || classes.empty?
+      html_opts[:class] = classes if classes && !classes.empty?
 
-      options
+      html_opts
     end
 
     # Returns the configured active_leaf_class if the item is the selected leaf,
     # nil otherwise
     def active_leaf_class
       if !selected_by_subnav? && selected_by_condition?
-        SimpleNavigation.config.active_leaf_class
+        config.active_leaf_class
       end
     end
 
@@ -78,10 +71,26 @@ module SimpleNavigation
     # nil otherwise
     def selected_class
       if selected?
-        container.selected_class || SimpleNavigation.config.selected_class
+        container.selected_class || config.selected_class
       end
     end
 
+    # Returns the :highlights_on option as set at initialization
+    def highlights_on
+      @highlights_on ||= options[:highlights_on]
+    end
+
+    # Returns the :method option as set at initialization
+    def method
+      @method ||= options[:method]
+    end
+
+    # Returns the html attributes for the link as set with the :link_html option
+    # at initialization
+    def link_html_options
+      @link_html_options ||= options[:link_html]
+    end
+
     protected
 
     # Returns true if item has a subnavigation and
@@ -90,10 +99,6 @@ module SimpleNavigation
       sub_navigation && sub_navigation.selected?
     end
 
-    def selected_by_config?
-      false
-    end
-
     # Returns true if the item's url matches the request's current url.
     def selected_by_condition?
       highlights_on ? selected_by_highlights_on? : selected_by_autohighlight?
@@ -104,86 +109,72 @@ module SimpleNavigation
       url == '/' && SimpleNavigation.request_path == '/'
     end
 
-    # Returns true if the item's id should be added to the rendered output.
-    def autogenerate_item_ids?
-      SimpleNavigation.config.autogenerate_item_ids
-    end
-
     # Returns the item's id which is added to the rendered output.
     def autogenerated_item_id
-      SimpleNavigation.config.id_generator.call(key)
+      config.id_generator.call(key) if config.autogenerate_item_ids
     end
 
     # Return true if auto_highlight is on for this item.
     def auto_highlight?
-      SimpleNavigation.config.auto_highlight && container.auto_highlight
-    end
-
-    def url_without_anchor
-      url && url.split('#').first
+      config.auto_highlight && container.auto_highlight
     end
 
     private
 
-    attr_reader :container
+    attr_accessor :container,
+                  :options
 
-    attr_writer :highlights_on,
+    attr_writer :key,
+                :name,
                 :sub_navigation,
                 :url
 
+    def config
+      SimpleNavigation.config
+    end
+
+    def request_uri
+      SimpleNavigation.request_uri
+    end
+
+    def remove_anchors(url_with_anchors)
+      url_with_anchors && url_with_anchors.split('#').first
+    end
+    
+    def remove_query_params(url_with_params)
+      url_with_params && url_with_params.split('?').first
+    end
+    
+    def url_for_autohighlight
+      relevant_url = remove_anchors(self.url) if config.ignore_anchors_on_auto_highlight
+      relevant_url = remove_query_params(relevant_url) if config.ignore_query_params_on_auto_highlight
+      relevant_url
+    end
+
     def selected_by_autohighlight?
-      auto_highlight? &&
-      (root_path_match? ||
-       (url_without_anchor &&
-        SimpleNavigation.current_page?(url_without_anchor)))
+      return false unless auto_highlight?
+      root_path_match? ||
+      SimpleNavigation.current_page?(url_for_autohighlight) ||
+      autohighlight_by_subpath?
     end
 
-    def selected_by_highlights_on?
-      return false unless highlights_on
+    def autohighlight_by_subpath?
+      config.highlight_on_subpath && selected_by_subpath?
+    end
 
+    def selected_by_highlights_on?
       case highlights_on
-      when Regexp then SimpleNavigation.request_uri =~ highlights_on
+      when Regexp then !!(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)
+      when :subpath then selected_by_subpath?
       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)
-      case url_or_options
-      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
+    def selected_by_subpath?
+      escaped_url = Regexp.escape(url_for_autohighlight)
+      !!(request_uri =~ /^#{escaped_url}(\/|$||\?)/i)
     end
 
     def setup_sub_navigation(items = nil, &sub_nav_block)