simple-navigation 4.4.1 → 4.5.0

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

@@ -1,49 +1,53 @@
-# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 # Configures your navigation
 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 = 'selected'
+  # 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 = 'simple-navigation-active-leaf'
+  # navigation.active_leaf_class = 'simple-navigation-active-leaf'
 
   # Specify if item keys are added to navigation items as id. Defaults to true
-  #navigation.autogenerate_item_ids = 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| tag.span(name) }
+  # navigation.name_generator = Proc.new {|name, item| tag.span(name) }
 
   # 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.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
 
   # Define the primary navigation
   navigation.items do |primary|
     # Add an item to the primary navigation. The following params apply:
     # key - a symbol which uniquely defines your navigation item in the scope of the primary_navigation
     # name - will be displayed in the rendered navigation. This can also be a call to your I18n-framework.
-    # url - the address that the generated item links to. You can also use url_helpers (named routes, restful routes helper, url_for etc.)
-    # options - can be used to specify attributes that will be included in the rendered navigation item (e.g. id, class etc.)
+    # url - the address that the generated item links to. You can also use url_helpers
+    #       (named routes, restful routes helper, url_for etc.)
+    # options - can be used to specify attributes that will be included in the rendered
+    #           navigation item (e.g. id, class etc.)
     #           some special options that can be set:
     #           :html - Specifies html attributes that will be included in the rendered navigation item
     #           :if - Specifies a proc to call to determine if the item should
@@ -57,25 +61,25 @@ SimpleNavigation::Configuration.run do |navigation|
     #                            when the item should be highlighted, you can set a regexp which is matched
     #                            against the current URI.  You may also use a proc, or the symbol <tt>:subpath</tt>.
     #
-    primary.item :key_1, 'name', url, options
+    primary.item :key1, 'name', url, options
 
     # Add an item which has a sub navigation (same params, but with block)
-    primary.item :key_2, 'name', url, options do |sub_nav|
+    primary.item :key2, 'name', url, options do |sub_nav|
       # Add an item to the sub navigation (same params again)
-      sub_nav.item :key_2_1, 'name', url, options
+      sub_nav.item :key21, 'name', url, options
     end
 
     # You can also specify a condition-proc that needs to be fullfilled to display an item.
     # Conditions are part of the options. They are evaluated in the context of the views,
     # thus you can use all the methods and vars you have available in the views.
-    primary.item :key_3, 'Admin', url, html: { class: 'special' }, if: -> { current_user.admin? }
-    primary.item :key_4, 'Account', url, unless: -> { logged_in? }
+    primary.item :key3, 'Admin', url, html: { class: 'special' }, if: -> { current_user.admin? }
+    primary.item :key4, 'Account', url, unless: -> { logged_in? }
 
     # 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/generators/navigation_config/navigation_config_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class NavigationConfigGenerator < Rails::Generators::Base
   def self.source_root
     @source_root ||= begin

data/lib/simple-navigation.rb

@@ -1 +1,3 @@
-require 'simple_navigation'
+# frozen_string_literal: true
+
+require_relative 'simple_navigation'

data/lib/simple_navigation/adapters/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   module Adapters
     # This is the base class for all adapters.

data/lib/simple_navigation/adapters/nanoc.rb

@@ -1,14 +1,19 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   module Adapters
+    # @deprecated This adapter is for Nanoc3 (circa 2011-2012) and is no longer actively maintained.
+    #   Nanoc3 is obsolete and has been replaced by Nanoc 4+. This adapter is kept for
+    #   backward compatibility but should not be used for new projects.
     class Nanoc < Base
       class << self
         def register(root)
           SimpleNavigation.set_env(root, 'development')
-          Nanoc3::Context.send(:include, SimpleNavigation::Helpers)
+          Nanoc3::Context.include SimpleNavigation::Helpers
         end
       end
 
-      def initialize(ctx)
+      def initialize(ctx) # rubocop:disable Lint/MissingSuper
         @context = ctx
       end
 
@@ -39,7 +44,7 @@ module SimpleNavigation
       private
 
       def to_attributes(options)
-        options.map { |k, v| v.nil? ? nil : "#{k}='#{v}'" }.compact.join(' ')
+        options.filter_map { |k, v| v.nil? ? nil : "#{k}='#{v}'" }.join(' ')
       end
     end
   end

data/lib/simple_navigation/adapters/padrino.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   module Adapters
     class Padrino < Sinatra
-      def self.register(app)
+      def self.register(_app)
         SimpleNavigation.set_env(::Padrino.root, ::Padrino.env)
         ::Padrino::Application.send(:helpers, SimpleNavigation::Helpers)
       end

data/lib/simple_navigation/adapters/rails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   module Adapters
     class Rails < Base
@@ -10,23 +12,19 @@ module SimpleNavigation
         # This delays the hook initialization using the on_load
         # hooks, but does not change behaviour for existing
         # rails versions.
-        if ::Rails::VERSION::MAJOR >= 6
-          ActiveSupport.on_load(:action_controller_base) do
-            SimpleNavigation::Adapters::Rails.register_controller_helpers
-          end
-        else
-          register_controller_helpers
+        ActiveSupport.on_load(:action_controller_base) do
+          SimpleNavigation::Adapters::Rails.register_controller_helpers
         end
       end
 
       def self.register_controller_helpers
-        ActionController::Base.send(:include, SimpleNavigation::Helpers)
+        ActionController::Base.include SimpleNavigation::Helpers
         SimpleNavigation::Helpers.instance_methods.each do |m|
           ActionController::Base.send(:helper_method, m.to_sym)
         end
       end
 
-      def initialize(context)
+      def initialize(context) # rubocop:disable Lint/MissingSuper
         @controller = extract_controller_from context
         @template = template_from @controller
         @request = @template.request if @template
@@ -47,21 +45,21 @@ module SimpleNavigation
       end
 
       def context_for_eval
-        template   ||
-        controller ||
-        fail('no context set for evaluation the config file')
+        template ||
+          controller ||
+          raise('no context set for evaluation the config file')
       end
 
       def current_page?(url)
-        template && template.current_page?(url)
+        template&.current_page?(url)
       end
 
       def link_to(name, url, options = {})
-        template && template.link_to(link_title(name), url, options)
+        template&.link_to(link_title(name), url, options)
       end
 
       def content_tag(type, content, options = {})
-        template && template.content_tag(type, html_safe(content), options)
+        template&.content_tag(type, html_safe(content), options)
       end
 
       protected

data/lib/simple_navigation/adapters/sinatra.rb

@@ -1,4 +1,4 @@
-require 'cgi'
+# frozen_string_literal: true
 
 module SimpleNavigation
   module Adapters
@@ -7,13 +7,13 @@ module SimpleNavigation
         SimpleNavigation.set_env(app.root, app.environment)
       end
 
-      def initialize(context)
+      def initialize(context) # rubocop:disable Lint/MissingSuper
         @context = context
         @request = context.request
       end
 
       def context_for_eval
-        context || fail('no context set for evaluation the config file')
+        context || raise('no context set for evaluation the config file')
       end
 
       def request_uri
@@ -32,9 +32,7 @@ module SimpleNavigation
                 request_uri.split('?').first
               end
 
-        if url_string =~ %r(^\w+://)
-          uri = "#{request.scheme}://#{request.host_with_port}#{uri}"
-        end
+        uri = "#{request.scheme}://#{request.host_with_port}#{uri}" if %r{^\w+://}.match?(url_string)
 
         url_string == CGI.unescape(uri)
       end

data/lib/simple_navigation/config_file.rb

@@ -1,4 +1,4 @@
-require 'active_support/core_ext/string'
+# frozen_string_literal: true
 
 module SimpleNavigation
   # Internal: Encapsulates the config file naming knowledge.

data/lib/simple_navigation/config_file_finder.rb

@@ -1,4 +1,4 @@
-require 'simple_navigation/config_file'
+# frozen_string_literal: true
 
 module SimpleNavigation
   # Internal: Encapsulates the configuration file finding logic.
@@ -22,8 +22,8 @@ module SimpleNavigation
       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(', ')}!")
+        raise("Config file '#{config_file_name}' not found in " \
+              "path(s) #{paths.join(', ')}!")
     end
 
     private

data/lib/simple_navigation/configuration.rb

@@ -1,4 +1,4 @@
-require 'singleton'
+# frozen_string_literal: true
 
 module SimpleNavigation
   # Responsible for evaluating and handling the config/navigation.rb file.
@@ -27,8 +27,8 @@ module SimpleNavigation
     end
 
     # Starts processing the configuration
-    def self.run(&block)
-      block.call Configuration.instance
+    def self.run
+      yield Configuration.instance
     end
 
     # Sets the config's default-settings
@@ -75,13 +75,13 @@ module SimpleNavigation
     #
     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')
+        raise('please specify either items_provider or block, but not both')
       end
 
       self.primary_navigation = ItemContainer.new
 
       if block
-        block.call primary_navigation
+        yield primary_navigation
       else
         primary_navigation.items = ItemsProvider.new(items_provider).items
       end

data/lib/simple_navigation/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   # View helpers to render the navigation.
   #
@@ -30,14 +32,12 @@ module SimpleNavigation
       SimpleNavigation.load_config context
       SimpleNavigation::Configuration.eval_config context
 
-      if block_given? || options[:items]
-        SimpleNavigation.config.items(options[:items], &block)
-      end
+      SimpleNavigation.config.items(options[:items], &block) if block_given? || options[:items]
 
-      unless SimpleNavigation.primary_navigation
-        fail 'no primary navigation defined, either use a navigation config ' \
-             'file or pass items directly to render_navigation'
-      end
+      return if SimpleNavigation.primary_navigation
+
+      raise 'no primary navigation defined, either use a navigation config ' \
+            'file or pass items directly to render_navigation'
     end
 
     def self.apply_defaults(options)
@@ -85,7 +85,7 @@ module SimpleNavigation
     #
     def render_navigation(options = {}, &block)
       container = active_navigation_item_container(options, &block)
-      container && container.render(options)
+      container&.render(options)
     end
 
     # Returns the name of the currently active navigation item belonging to the
@@ -138,9 +138,7 @@ module SimpleNavigation
     # by default) if no active item can be found for the specified
     # options
     def active_navigation_item(options = {}, value_for_nil = nil)
-      if options[:level].nil? || options[:level] == :all
-        options[:level] = :leaves
-      end
+      options[:level] = :leaves if options[:level].nil? || options[:level] == :all
       container = active_navigation_item_container(options)
       if container && (item = container.selected_item)
         block_given? ? yield(item) : item

data/lib/simple_navigation/item.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   # Represents an item in your navigation.
   # Gets generated by the item method in the config-file.
-  class Item
+  class Item # rubocop:disable Metrics/ClassLength
     attr_reader :key,
                 :name,
                 :sub_navigation,
@@ -27,7 +29,7 @@ module SimpleNavigation
     # the name will be passed to the name_generator specified
     # in the configuration.
     #
-    def name(options = {})
+    def name(options = {}) # rubocop:disable Lint/DuplicateMethods
       options = { apply_generator: true }.merge(options)
       if options[:apply_generator]
         config.name_generator.call(@name, self)
@@ -50,7 +52,7 @@ module SimpleNavigation
     # for this item in the config-file.
     # It also adds the 'selected' class to the list of classes if necessary.
     def html_options
-      html_opts = options.fetch(:html) { Hash.new }
+      html_opts = options.fetch(:html) { {} }
       html_opts[:id] ||= autogenerated_item_id
 
       classes = [html_opts[:class], selected_class, active_leaf_class]
@@ -63,17 +65,17 @@ module SimpleNavigation
     # 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?
-        config.active_leaf_class
-      end
+      return unless !selected_by_subnav? && selected_by_condition?
+
+      config.active_leaf_class
     end
 
     # Returns the configured selected_class if the item is selected,
     # nil otherwise
     def selected_class
-      if selected?
-        container.selected_class || config.selected_class
-      end
+      return unless selected?
+
+      container.selected_class || config.selected_class
     end
 
     # Returns the :highlights_on option as set at initialization
@@ -89,7 +91,11 @@ module SimpleNavigation
     # 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]
+      @link_html_options ||= begin
+        link_options = options[:link_html] || {}
+        link_options[:'aria-current'] = 'page' if !selected_by_subnav? && selected_by_condition?
+        link_options
+      end
     end
 
     protected
@@ -97,7 +103,7 @@ module SimpleNavigation
     # Returns true if item has a subnavigation and
     # the sub_navigation is selected
     def selected_by_subnav?
-      sub_navigation && sub_navigation.selected?
+      sub_navigation&.selected?
     end
 
     # Returns true if the item's url matches the request's current url.
@@ -139,26 +145,26 @@ module SimpleNavigation
     end
 
     def remove_anchors(url_with_anchors)
-      url_with_anchors && url_with_anchors.split('#').first
+      url_with_anchors&.split('#')&.first
     end
 
     def remove_query_params(url_with_params)
-      url_with_params && url_with_params.split('?').first
+      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_anchors(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?
       return false unless auto_highlight?
-      return false unless self.url
+      return false unless url
 
       root_path_match? ||
-      (url_for_autohighlight && SimpleNavigation.current_page?(url_for_autohighlight)) ||
-      autohighlight_by_subpath?
+        (url_for_autohighlight && SimpleNavigation.current_page?(url_for_autohighlight)) ||
+        autohighlight_by_subpath?
     end
 
     def autohighlight_by_subpath?
@@ -171,13 +177,13 @@ module SimpleNavigation
       when Proc then highlights_on.call
       when :subpath then selected_by_subpath?
       else
-        fail ArgumentError, ':highlights_on must be a Regexp, Proc or :subpath'
+        raise ArgumentError, ':highlights_on must be a Regexp, Proc or :subpath'
       end
     end
 
     def selected_by_subpath?
       escaped_url = Regexp.escape(url_for_autohighlight)
-      !!(request_uri =~ /^#{escaped_url}(\/|$||\?)/i)
+      !!(request_uri =~ %r{^#{escaped_url}(/|$||\?)}i)
     end
 
     def setup_sub_navigation(items = nil, &sub_nav_block)
@@ -186,7 +192,7 @@ module SimpleNavigation
       self.sub_navigation = ItemContainer.new(container.level + 1)
 
       if sub_nav_block
-        sub_nav_block.call sub_navigation
+        yield sub_navigation
       else
         sub_navigation.items = items
       end

data/lib/simple_navigation/item_adapter.rb

@@ -1,5 +1,4 @@
-require 'forwardable'
-require 'ostruct'
+# frozen_string_literal: true
 
 module SimpleNavigation
   # This class acts as an adapter to items that are not defined using the DSL
@@ -30,20 +29,32 @@ module SimpleNavigation
 
     attr_reader :item
 
+    class Item
+      attr_reader :key, :name, :url, :options, :items
+
+      def initialize(item)
+        @key     = item[:key]
+        @name    = item[:name]
+        @url     = item[:url]
+        @options = item[:options] || {}
+        @items   = item[:items] || []
+      end
+    end
+
     def initialize(item)
-      @item = item.is_a?(Hash) ? OpenStruct.new(item) : item
+      @item = item.is_a?(Hash) ? Item.new(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 : {}
+      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.items if item.respond_to?(:items) && item.items && item.items.any?
+      item.items if item.items&.any?
     end
 
     # Converts this Item into a SimpleNavigation::Item

data/lib/simple_navigation/item_container.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   # Holds the Items for a navigation 'level'.
-  class ItemContainer
+  class ItemContainer # rubocop:disable Metrics/ClassLength
     attr_accessor :auto_highlight,
                   :dom_class,
                   :dom_id,
@@ -11,7 +13,7 @@ module SimpleNavigation
 
     attr_writer :dom_attributes
 
-    def initialize(level = 1) #:nodoc:
+    def initialize(level = 1) # :nodoc:
       @level = level
       @items ||= []
       @renderer = SimpleNavigation.config.renderer
@@ -24,7 +26,7 @@ module SimpleNavigation
       dom_id_and_class = {
         id: dom_id,
         class: dom_class
-      }.reject { |_, v| v.nil? }
+      }.compact
 
       @dom_attributes.merge(dom_id_and_class)
     end
@@ -63,6 +65,7 @@ module SimpleNavigation
     # The <tt>block</tt> - if specified - will hold the item's sub_navigation.
     def item(key, name, url = nil, options = {}, &block)
       return unless should_add_item?(options)
+
       item = Item.new(self, key, name, url, options, &block)
       add_item item, options
     end
@@ -71,6 +74,7 @@ module SimpleNavigation
       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
@@ -91,10 +95,11 @@ module SimpleNavigation
 
       items.each do |item|
         next unless item.sub_navigation
+
         level = item.sub_navigation.level_for_item(navi_key)
         return level if level
       end
-      return nil
+      nil
     end
 
     # Renders the items in this ItemContainer using the configured renderer.
@@ -152,7 +157,8 @@ module SimpleNavigation
     end
 
     def modify_dom_attributes(options)
-      return unless container_options = options[:container]
+      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 }
@@ -178,13 +184,13 @@ module SimpleNavigation
 
     def should_add_item?(options)
       [options[:if]].flatten.compact.all? { |m| evaluate_method(m) } &&
-      [options[:unless]].flatten.compact.none? { |m| evaluate_method(m) }
+        [options[:unless]].flatten.compact.none? { |m| evaluate_method(m) }
     end
 
     def evaluate_method(method)
       case method
       when Proc, Method then method.call
-      else fail(ArgumentError, ':if or :unless must be procs or lambdas')
+      else raise(ArgumentError, ':if or :unless must be procs or lambdas')
       end
     end
   end

data/lib/simple_navigation/items_provider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   # Acts as a proxy to navigation items that are passed into the
   # SimpleNavigation::Configuration#items method.
@@ -20,7 +22,7 @@ module SimpleNavigation
     end
 
     # Returns the navigation items
-    def items
+    def items # rubocop:disable Metrics/MethodLength
       if provider.is_a?(Symbol)
         SimpleNavigation.context_for_eval.send(provider)
       elsif provider.respond_to?(:items)
@@ -28,9 +30,9 @@ module SimpleNavigation
       elsif provider.respond_to?(:each)
         provider
       else
-        fail('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')
+        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

data/lib/simple_navigation/railtie.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module SimpleNavigation
   class Railtie < ::Rails::Railtie
-    initializer 'simple_navigation.register' do |app|
+    initializer 'simple_navigation.register' do |_app|
       SimpleNavigation.register
     end
   end