simple-navigation 3.13.0 → 4.0.5

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,74 @@ 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 selected_by_autohighlight?
-      auto_highlight? &&
-      (root_path_match? ||
-       (url_without_anchor &&
-        SimpleNavigation.current_page?(url_without_anchor)))
+    def config
+      SimpleNavigation.config
     end
 
-    def selected_by_highlights_on?
-      return false unless highlights_on
+    def request_uri
+      SimpleNavigation.request_uri
+    end
 
-      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
+    def remove_anchors(url_with_anchors)
+      url_with_anchors && url_with_anchors.split('#').first
     end
 
-    def setup_container(container, options = {})
-      if options[:container_class]
-        container.dom_class = options.delete(:container_class)
-      end
+    def remove_query_params(url_with_params)
+      url_with_params && url_with_params.split('?').first
+    end
 
-      if options[:container_id]
-        container.dom_id = options.delete(:container_id)
-      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
 
-      container.dom_attributes = if options[:container_attributes]
-                                   options.delete(:container_attributes)
-                                 else
-                                   {}
-                                 end
+    def selected_by_autohighlight?
+      return false unless auto_highlight?
+      return false unless self.url
 
-      if options[:selected_class]
-        container.selected_class = options.delete(:selected_class)
-      end
+      root_path_match? ||
+      (url_for_autohighlight && SimpleNavigation.current_page?(url_for_autohighlight)) ||
+      autohighlight_by_subpath?
+    end
 
-      container
+    def autohighlight_by_subpath?
+      config.highlight_on_subpath && selected_by_subpath?
     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
+    def selected_by_highlights_on?
+      case highlights_on
+      when Regexp then !!(request_uri =~ highlights_on)
+      when Proc then highlights_on.call
+      when :subpath then selected_by_subpath?
+      else
+        fail ArgumentError, ':highlights_on must be a Regexp, Proc or :subpath'
       end
+    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)

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

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'ostruct'
 
 module SimpleNavigation
   # This class acts as an adapter to items that are not defined using the DSL
@@ -30,7 +31,7 @@ module SimpleNavigation
     attr_reader :item
 
     def initialize(item)
-      @item = item.is_a?(Hash) ? to_object(item) : item
+      @item = item.is_a?(Hash) ? OpenStruct.new(item) : item
     end
 
     # Returns the options for this item. If the wrapped item does not implement
@@ -47,22 +48,7 @@ module SimpleNavigation
 
     # 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
-
-    protected
-
-    # Converts the specified hash into an object. Each key will be added
-    # as method.
-    def to_object(hash)
-      mod = Module.new do
-        hash.each_pair do |key, value|
-          define_method key do
-            value
-          end
-        end
-      end
-      Object.new.extend(mod)
+      SimpleNavigation::Item.new(item_container, key, name, url, options)
     end
   end
 end

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

@@ -59,22 +59,18 @@ module SimpleNavigation
     #   set a regexp which is matched againstthe current URI.
     #
     # The <tt>block</tt> - if specified - will hold the item's sub_navigation.
-    def item(key, name, url_or_options = {}, options_or_nil = {}, &block)
-      options = url_or_options.is_a?(Hash) ? url_or_options : options_or_nil
+    def item(key, name, url = nil, options = {}, &block)
       return unless should_add_item?(options)
-      items << SimpleNavigation::Item.new(self,
-                                          key,
-                                          name,
-                                          url_or_options,
-                                          options_or_nil,
-                                          nil,
-                                          &block)
+      item = Item.new(self, key, name, url, options, &block)
+      add_item item, options
     end
 
     def items=(new_items)
-      @items += new_items.map { |item| ItemAdapter.new(item) }
-                         .keep_if { |item| should_add_item?(item.options) }
-                         .map { |item| item.to_simple_navigation_item(self) }
+      new_items.each do |item|
+        item_adapter = ItemAdapter.new(item)
+        next unless should_add_item?(item_adapter.options)
+        add_item item_adapter.to_simple_navigation_item(self), item_adapter.options
+      end
     end
 
     # Returns the Item with the specified key, nil otherwise.
@@ -148,6 +144,19 @@ module SimpleNavigation
 
     private
 
+    def add_item(item, options)
+      items << item
+      modify_dom_attributes(options)
+    end
+
+    def modify_dom_attributes(options)
+      return unless container_options = options[:container]
+      self.dom_attributes = container_options.fetch(:attributes) { dom_attributes }
+      self.dom_class = container_options.fetch(:class) { dom_class }
+      self.dom_id = container_options.fetch(:id) { dom_id }
+      self.selected_class = container_options.fetch(:selected_class) { selected_class }
+    end
+
     # FIXME: raise an exception if :rederer is a symbol and it is not registred
     #        in SimpleNavigation.registered_renderers
     def renderer_instance(options)
@@ -166,8 +175,8 @@ module SimpleNavigation
     end
 
     def should_add_item?(options)
-      [options.delete(:if)].flatten.compact.all? { |m| evaluate_method(m) } &&
-      [options.delete(:unless)].flatten.compact.none? { |m| evaluate_method(m) }
+      [options[:if]].flatten.compact.all? { |m| evaluate_method(m) } &&
+      [options[:unless]].flatten.compact.none? { |m| evaluate_method(m) }
     end
 
     def evaluate_method(method)

data/lib/simple_navigation/railtie.rb

@@ -0,0 +1,7 @@
+module SimpleNavigation
+  class Railtie < ::Rails::Railtie
+    initializer 'simple_navigation.register' do |app|
+      SimpleNavigation.register
+    end
+  end
+end

data/lib/simple_navigation/renderer.rb

@@ -0,0 +1,12 @@
+require 'simple_navigation/helpers'
+require 'simple_navigation/renderer/base'
+
+module SimpleNavigation
+  module Renderer
+    autoload :List, 'simple_navigation/renderer/list'
+    autoload :Links, 'simple_navigation/renderer/links'
+    autoload :Breadcrumbs, 'simple_navigation/renderer/breadcrumbs'
+    autoload :Text, 'simple_navigation/renderer/text'
+    autoload :Json, 'simple_navigation/renderer/json'
+  end
+end

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

@@ -95,7 +95,7 @@ module SimpleNavigation
           class: item.selected_class
         }.reject { |_, v| v.nil? }
 
-        link_options = item.html_options[:link]
+        link_options = item.link_html_options
 
         return special_options unless link_options
 

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

@@ -1,3 +1,5 @@
+require 'json'
+
 module SimpleNavigation
   module Renderer
     # Renders the navigation items as a object tree serialized as a json string,

data/lib/simple_navigation/version.rb

@@ -1,3 +1,3 @@
 module SimpleNavigation
-  VERSION = '3.13.0'
+  VERSION = '4.0.5'
 end