simple-navigation 3.12.0 → 3.12.1

data/lib/simple_navigation/rendering/helpers.rb

@@ -1,81 +1,150 @@
 module SimpleNavigation
-
   # View helpers to render the navigation.
   #
   # Use render_navigation as following to render your navigation:
-  # * call <tt>render_navigation</tt> without :level option to render your complete navigation as nested tree.
-  # * call <tt>render_navigation(:level => x)</tt> to render a specific navigation level (e.g. :level => 1 to render your primary navigation, :level => 2 to render the sub navigation and so forth)
-  # * call <tt>render_navigation(:level => 2..3)</tt> to render navigation levels 2 and 3).
-  #   For example, you could use render_navigation(:level => 1) to render your primary navigation as tabs and render_navigation(:level => 2..3) to render the rest of the navigation as a tree in a sidebar.
+  # * call <tt>render_navigation</tt> without :level option to render your
+  #   complete navigation as nested tree.
+  # * call <tt>render_navigation(level: x)</tt> to render a specific
+  #   navigation level (e.g. level: 1 to render your primary navigation,
+  #   level: 2 to render the sub navigation and so forth)
+  # * call <tt>render_navigation(:level => 2..3)</tt> to render navigation
+  #   levels 2 and 3).
+  #
+  # For example, you could use render_navigation(level: 1) to render your
+  # primary navigation as tabs and render_navigation(level: 2..3) to render
+  # the rest of the navigation as a tree in a sidebar.
   #
   # ==== Examples (using Haml)
-  #   #primary_navigation= render_navigation(:level => 1)
+  #   #primary_navigation= render_navigation(level: 1)
   #
-  #   #sub_navigation= render_navigation(:level => 2)
+  #   #sub_navigation= render_navigation(level: 2)
   #
   #   #nested_navigation= render_navigation
   #
-  #   #top_navigation= render_navigation(:level => 1..2)
-  #   #sidebar_navigation= render_navigation(:level => 3)
+  #   #top_navigation= render_navigation(level: 1..2)
+  #   #sidebar_navigation= render_navigation(level: 3)
   module Helpers
+    def self.load_config(options, includer, &block)
+      context = options.delete(:context)
+      SimpleNavigation.init_adapter_from includer
+      SimpleNavigation.load_config context
+      SimpleNavigation::Configuration.eval_config context
+
+      if block_given? || options[:items]
+        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'
+      end
+    end
+
+    def self.apply_defaults(options)
+      options[:level] = options.delete(:levels) if options[:levels]
+      { context: :default, level: :all }.merge(options)
+    end
 
     # Renders the navigation according to the specified options-hash.
     #
     # The following options are supported:
-    # * <tt>:level</tt> - defaults to :all which renders the the sub_navigation for an active primary_navigation inside that active primary_navigation item.
-    #   Specify a specific level to only render that level of navigation (e.g. :level => 1 for primary_navigation etc...).
-    #   Specifiy a Range of levels to render only those specific levels (e.g. :level => 1..2 to render both your first and second levels, maybe you want to render your third level somewhere else on the page)
-    # * <tt>:expand_all</tt> - defaults to false. If set to true the all specified levels will be rendered as a fully expanded tree (always open). This is useful for javascript menus like Superfish.
-    # * <tt>:context</tt> - specifies the context for which you would render the navigation. Defaults to :default which loads the default navigation.rb (i.e. config/navigation.rb).
-    #   If you specify a context then the plugin tries to load the configuration file for that context, e.g. if you call <tt>render_navigation(:context => :admin)</tt> the file config/admin_navigation.rb
-    #   will be loaded and used for rendering the navigation.
-    # * <tt>:items</tt> - you can specify the items directly (e.g. if items are dynamically generated from database). See SimpleNavigation::ItemsProvider for documentation on what to provide as items.
-    # * <tt>:renderer</tt> - specify the renderer to be used for rendering the navigation. Either provide the Class or a symbol matching a registered renderer. Defaults to :list (html list renderer).
+    # * <tt>:level</tt> - defaults to :all which renders the the sub_navigation
+    #   for an active primary_navigation inside that active
+    #   primary_navigation item.
+    #   Specify a specific level to only render that level of navigation
+    #   (e.g. level: 1 for primary_navigation, etc).
+    #   Specifiy a Range of levels to render only those specific levels
+    #   (e.g. level: 1..2 to render both your first and second levels, maybe
+    #   you want to render your third level somewhere else on the page)
+    # * <tt>:expand_all</tt> - defaults to false. If set to true the all
+    #   specified levels will be rendered as a fully expanded
+    #   tree (always open). This is useful for javascript menus like Superfish.
+    # * <tt>:context</tt> - specifies the context for which you would render
+    #   the navigation. Defaults to :default which loads the default
+    #   navigation.rb (i.e. config/navigation.rb).
+    #   If you specify a context then the plugin tries to load the configuration
+    #   file for that context, e.g. if you call
+    #   <tt>render_navigation(context: :admin)</tt> the file
+    #   config/admin_navigation.rb will be loaded and used for rendering
+    #   the navigation.
+    # * <tt>:items</tt> - you can specify the items directly (e.g. if items are
+    #   dynamically generated from database).
+    #   See SimpleNavigation::ItemsProvider for documentation on what to
+    #   provide as items.
+    # * <tt>:renderer</tt> - specify the renderer to be used for rendering the
+    #   navigation. Either provide the Class or a symbol matching a registered
+    #   renderer. Defaults to :list (html list renderer).
     #
-    # Instead of using the <tt>:items</tt> option, a block can be passed to specify the items dynamically
+    # Instead of using the <tt>:items</tt> option, a block can be passed to
+    # specify the items dynamically
     #
+    # ==== Examples
     #   render_navigation do |menu|
     #     menu.item :posts, "Posts", posts_path
     #   end
     #
-    def render_navigation(options={},&block)
-      container = active_navigation_item_container(options,&block)
+    def render_navigation(options = {}, &block)
+      container = active_navigation_item_container(options, &block)
       container && container.render(options)
     end
 
-    # Returns the name of the currently active navigation item belonging to the specified level.
+    # Returns the name of the currently active navigation item belonging to the
+    # specified level.
     #
     # See Helpers#active_navigation_item for supported options.
     #
-    # Returns an empty string if no active item can be found for the specified options
-    def active_navigation_item_name(options={})
-      active_navigation_item(options,'') { |item| item.name(:apply_generator => false) }
+    # Returns an empty string if no active item can be found for the specified
+    # options
+    def active_navigation_item_name(options = {})
+      active_navigation_item(options, '') do |item|
+        item.name(apply_generator: false)
+      end
     end
 
-    # Returns the key of the currently active navigation item belonging to the specified level.
+    # Returns the key of the currently active navigation item belonging to the
+    # specified level.
     #
     # See Helpers#active_navigation_item for supported options.
     #
-    # Returns <tt>nil</tt> if no active item can be found for the specified options
-    def active_navigation_item_key(options={})
-      active_navigation_item(options) { |item| item.key }
+    # Returns <tt>nil</tt> if no active item can be found for the specified
+    # options
+    def active_navigation_item_key(options = {})
+      active_navigation_item(options, &:key)
     end
 
-    # Returns the currently active navigation item belonging to the specified level.
+    # Returns the currently active navigation item belonging to the specified
+    # level.
     #
     # The following options are supported:
-    # * <tt>:level</tt> - defaults to :all which returns the most specific/deepest selected item (the leaf).
-    #   Specify a specific level to only look for the selected item in the specified level of navigation (e.g. :level => 1 for primary_navigation etc...).
-    # * <tt>:context</tt> - specifies the context for which you would like to find the active navigation item. Defaults to :default which loads the default navigation.rb (i.e. config/navigation.rb).
-    #   If you specify a context then the plugin tries to load the configuration file for that context, e.g. if you call <tt>active_navigation_item_name(:context => :admin)</tt> the file config/admin_navigation.rb
-    #   will be loaded and used for searching the active item.
-    # * <tt>:items</tt> - you can specify the items directly (e.g. if items are dynamically generated from database). See SimpleNavigation::ItemsProvider for documentation on what to provide as items.
+    # * <tt>:level</tt> - defaults to :all which returns the
+    #   most specific/deepest selected item (the leaf).
+    #   Specify a specific level to only look for the selected item in the
+    #   specified level of navigation
+    #   (e.g. level: 1 for primary_navigation, etc).
+    # * <tt>:context</tt> - specifies the context for which you would like to
+    #   find the active navigation item. Defaults to :default which loads the
+    #   default navigation.rb (i.e. config/navigation.rb).
+    #   If you specify a context then the plugin tries to load the configuration
+    #   file for that context, e.g. if you call
+    #   <tt>active_navigation_item_name(context: :admin)</tt> the file
+    #   config/admin_navigation.rb will be loaded and used for searching the
+    #   active item.
+    # * <tt>:items</tt> - you can specify the items directly (e.g. if items are
+    #   dynamically generated from database).
+    #   See SimpleNavigation::ItemsProvider for documentation on what to provide
+    #   as items.
     #
     # Returns the supplied <tt>value_for_nil</tt> object (<tt>nil</tt>
     # by default) if no active item can be found for the specified
     # options
-    def active_navigation_item(options={},value_for_nil = nil)
-      options[:level] = :leaves if options[:level].nil? || options[:level] == :all
+    def active_navigation_item(options = {}, value_for_nil = nil)
+      if options[:level].nil? || options[:level] == :all
+        options[:level] = :leaves
+      end
       container = active_navigation_item_container(options)
       if container && (item = container.selected_item)
         block_given? ? yield(item) : item
@@ -84,40 +153,33 @@ module SimpleNavigation
       end
     end
 
-    # Returns the currently active item container belonging to the specified level.
+    # Returns the currently active item container belonging to the specified
+    # level.
     #
     # The following options are supported:
-    # * <tt>:level</tt> - defaults to :all which returns the least specific/shallowest selected item.
-    #   Specify a specific level to only look for the selected item in the specified level of navigation (e.g. :level => 1 for primary_navigation etc...).
-    # * <tt>:context</tt> - specifies the context for which you would like to find the active navigation item. Defaults to :default which loads the default navigation.rb (i.e. config/navigation.rb).
-    #   If you specify a context then the plugin tries to load the configuration file for that context, e.g. if you call <tt>active_navigation_item_name(:context => :admin)</tt> the file config/admin_navigation.rb
-    #   will be loaded and used for searching the active item.
-    # * <tt>:items</tt> - you can specify the items directly (e.g. if items are dynamically generated from database). See SimpleNavigation::ItemsProvider for documentation on what to provide as items.
+    # * <tt>:level</tt> - defaults to :all which returns the
+    #   least specific/shallowest selected item.
+    #   Specify a specific level to only look for the selected item in the
+    #   specified level of navigation
+    #   (e.g. level: 1 for primary_navigation, etc).
+    # * <tt>:context</tt> - specifies the context for which you would like to
+    #   find the active navigation item. Defaults to :default which loads the
+    #   default navigation.rb (i.e. config/navigation.rb).
+    #   If you specify a context then the plugin tries to load the configuration
+    #   file for that context, e.g. if you call
+    #   <tt>active_navigation_item_name(context: :admin)</tt> the file
+    #   config/admin_navigation.rb will be loaded and used for searching the
+    #   active item.
+    # * <tt>:items</tt> - you can specify the items directly (e.g. if items are
+    #   dynamically generated from database).
+    #   See SimpleNavigation::ItemsProvider for documentation on what to provide
+    #   as items.
     #
     # Returns <tt>nil</tt> if no active item container can be found
-    def active_navigation_item_container(options={},&block)
-      options = SimpleNavigation::Helpers::apply_defaults(options)
-      SimpleNavigation::Helpers::load_config(options,self,&block)
-      container = SimpleNavigation.active_item_container_for(options[:level])
-    end
-
-    class << self
-      def load_config(options,includer,&block)
-        ctx = options.delete(:context)
-        SimpleNavigation.init_adapter_from includer
-        SimpleNavigation.load_config(ctx)
-        SimpleNavigation::Configuration.eval_config(ctx)
-        if block_given? || options[:items]
-          SimpleNavigation.config.items(options[:items],&block)
-        end
-        SimpleNavigation.handle_explicit_navigation if SimpleNavigation.respond_to?(:handle_explicit_navigation)
-        raise "no primary navigation defined, either use a navigation config file or pass items directly to render_navigation" unless SimpleNavigation.primary_navigation
-      end
-
-      def apply_defaults(options)
-        options[:level] = options.delete(:levels) if options[:levels]
-        {:context => :default, :level => :all}.merge(options)
-      end
+    def active_navigation_item_container(options = {}, &block)
+      options = SimpleNavigation::Helpers.apply_defaults(options)
+      SimpleNavigation::Helpers.load_config(options, self, &block)
+      SimpleNavigation.active_item_container_for(options[:level])
     end
   end
 end

data/lib/simple_navigation/rendering/renderer/base.rb

@@ -2,17 +2,17 @@ require 'forwardable'
 
 module SimpleNavigation
   module Renderer
-
     # This is the base class for all renderers.
     #
-    # A renderer is responsible for rendering an ItemContainer and its containing items to HTML.
+    # A renderer is responsible for rendering an ItemContainer and its
+    # containing items to HTML.
     class Base
       extend Forwardable
-            
-      attr_reader :options, :adapter
-      
+
+      attr_reader :adapter, :options
+
       def_delegators :adapter, :link_to, :content_tag
-            
+
       def initialize(options) #:nodoc:
         @options = options
         @adapter = SimpleNavigation.adapter
@@ -35,31 +35,28 @@ module SimpleNavigation
       end
 
       def render_sub_navigation_for(item)
-        item.sub_navigation.render(self.options)
+        item.sub_navigation.render(options)
       end
-                  
+
       # Renders the specified ItemContainer to HTML.
       #
-      # When implementing a renderer, please consider to call include_sub_navigation? to determin
-      # whether an item's sub_navigation should be rendered or not.
-      #
+      # When implementing a renderer, please consider to call
+      # include_sub_navigation? to determine whether an item's sub_navigation
+      # should be rendered or not.
       def render(item_container)
-        raise 'subclass responsibility'
+        fail NotImplementedError, 'subclass responsibility'
       end
 
       protected
 
       def consider_sub_navigation?(item)
-        return false if item.sub_navigation.nil?
+        return false unless item.sub_navigation
+
         case level
-        when :all
-          return true
-        when Integer
-          return false
-        when Range
-          return item.sub_navigation.level <= level.max
+        when :all then true
+        when Range then item.sub_navigation.level <= level.max
+        else false
         end
-        false
       end
 
       def expand_sub_navigation?(item)
@@ -92,16 +89,24 @@ module SimpleNavigation
       end
 
       # Extracts the options relevant for the generated link
-      #
       def link_options_for(item)
-        special_options = {:method => item.method, :class => item.selected_class}.reject {|k, v| v.nil? }
+        special_options = {
+          method: item.method,
+          class: item.selected_class
+        }.reject { |_, v| v.nil? }
+
         link_options = item.html_options[:link]
+
         return special_options unless link_options
+
         opts = special_options.merge(link_options)
-        opts[:class] = [link_options[:class], item.selected_class].flatten.compact.join(' ')
-        opts.delete(:class) if opts[:class].nil? || opts[:class] == ''
+
+        classes = [link_options[:class], item.selected_class]
+        classes = classes.flatten.compact.join(' ')
+        opts[:class] = classes unless classes.empty?
+
         opts
-      end            
+      end
     end
   end
 end

data/lib/simple_navigation/rendering/renderer/breadcrumbs.rb

@@ -1,38 +1,40 @@
 module SimpleNavigation
   module Renderer
-
-    # Renders an ItemContainer as a <div> element and its containing items as <a> elements.
+    # Renders an ItemContainer as a <div> element and its containing items as
+    # <a> elements.
     # It only renders 'selected' elements.
     #
-    # By default, the renderer sets the item's key as dom_id for the rendered <a> element unless the config option <tt>autogenerate_item_ids</tt> is set to false.
-    # The id can also be explicitely specified by setting the id in the html-options of the 'item' method in the config/navigation.rb file.
-    # The ItemContainer's dom_attributes are applied to the surrounding <div> element.
+    # By default, the renderer sets the item's key as dom_id for the rendered
+    # <a> element unless the config option <tt>autogenerate_item_ids</tt> is
+    # set to false.
     #
+    # The id can also be explicitely specified by setting the id in the
+    # html-options of the 'item' method in the config/navigation.rb file.
+    # The ItemContainer's dom_attributes are applied to the surrounding <div>
+    # element.
     class Breadcrumbs < SimpleNavigation::Renderer::Base
-
       def render(item_container)
         content = a_tags(item_container).join(join_with)
         content_tag(:div,
-          prefix_for(content) + content,
-          item_container.dom_attributes)
+                    prefix_for(content) + content,
+                    item_container.dom_attributes)
       end
 
       protected
 
       def a_tags(item_container)
-        item_container.items.inject([]) do |list, item|
-          if item.selected?
-            list << tag_for(item)
-            if include_sub_navigation?(item)
-              list.concat a_tags(item.sub_navigation)
-            end
+        item_container.items.each_with_object([]) do |item, list|
+          next unless item.selected?
+          list << tag_for(item)
+
+          if include_sub_navigation?(item)
+            list.concat a_tags(item.sub_navigation)
           end
-          list
         end
       end
 
       def join_with
-        @join_with ||= options[:join_with] || " "
+        @join_with ||= options[:join_with] || ' '
       end
 
       def suppress_link?(item)
@@ -40,7 +42,11 @@ module SimpleNavigation
       end
 
       def prefix_for(content)
-        content.empty? ? '' : options[:prefix] || ''
+        if !content.empty? && options[:prefix]
+          options[:prefix]
+        else
+          ''
+        end
       end
 
       # Extracts the options relevant for the generated link
@@ -48,10 +54,11 @@ module SimpleNavigation
       def link_options_for(item)
         if options[:allow_classes_and_ids]
           opts = super
-          opts[:id] = "breadcrumb_#{opts[:id]}" if opts[:id]
+          opts[:id] &&= "breadcrumb_#{opts[:id]}"
           opts
         else
-          {:method => item.method}.merge(item.html_options.except(:class,:id))
+          html_options = item.html_options.except(:class, :id)
+          { method: item.method }.merge(html_options)
         end
       end
     end

data/lib/simple_navigation/rendering/renderer/json.rb

@@ -1,29 +1,27 @@
 module SimpleNavigation
   module Renderer
-    
-    # Renders the navigation items as a object tree serialized as a json string, can also output raw ruby Hashes
+    # Renders the navigation items as a object tree serialized as a json string,
+    # can also output raw ruby Hashes
     class Json < SimpleNavigation::Renderer::Base
-      
       def render(item_container)
         results = hash_render(item_container)
-        results = results.to_json unless options[:as_hash]
-        results
+        options[:as_hash] ? results : results.to_json
       end
 
       private
 
       def hash_render(item_container)
-        return nil if item_container.nil?
+        return nil unless item_container
+
         item_container.items.map do |item|
-          item_hash = { 
-            :name => item.name, 
-            :url => item.url, 
-            :selected => item.selected?,
-            :items => hash_render(item.sub_navigation)
+          {
+            items: hash_render(item.sub_navigation),
+            name: item.name,
+            selected: item.selected?,
+            url: item.url
           }
-        end        
+        end
       end
-
     end
   end
 end