simple-navigation 3.12.0 → 3.12.1

data/CHANGELOG

@@ -1,3 +1,7 @@
+*3.12.1
+
+* bugfix (error in generator)
+
 *3.12.0
 
 * Relax hash constraint on item_adapter. Thanks to Ramon Tayag.

data/generators/navigation_config/navigation_config_generator.rb

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

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

@@ -6,8 +6,8 @@ SimpleNavigation::Configuration.run do |navigation|
   # The renderer can also be specified as option in the render_navigation call.
   # 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 = 'your_selected_class'
 
   # Specify the class that will be applied to the current leaf of
   # active navigation items. Defaults to 'simple-navigation-active-leaf'
@@ -22,7 +22,8 @@ SimpleNavigation::Configuration.run do |navigation|
   # The example below would add a prefix to each 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.
+  # 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>"}
 
@@ -42,15 +43,15 @@ SimpleNavigation::Configuration.run do |navigation|
     # 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:
     #           :if - Specifies a proc to call to determine if the item should
-    #                 be rendered (e.g. <tt>:if => Proc.new { current_user.admin? }</tt>). The
+    #                 be rendered (e.g. <tt>if: -> { current_user.admin? }</tt>). The
     #                 proc should evaluate to a true or false value and is evaluated in the context of the view.
     #           :unless - Specifies a proc to call to determine if the item should not
-    #                     be rendered (e.g. <tt>:unless => Proc.new { current_user.admin? }</tt>). The
+    #                     be rendered (e.g. <tt>unless: -> { current_user.admin? }</tt>). The
     #                     proc should evaluate to a true or false value and is evaluated in the context of the view.
     #           :method - Specifies the http-method for the generated link - default is :get.
     #           :highlights_on - if autohighlighting is turned off and/or you want to explicitly specify
     #                            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>. 
+    #                            against the current URI.  You may also use a proc, or the symbol <tt>:subpath</tt>.
     #
     primary.item :key_1, 'name', url, options
 
@@ -63,8 +64,8 @@ SimpleNavigation::Configuration.run do |navigation|
     # 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, :class => 'special', :if => Proc.new { current_user.admin? }
-    primary.item :key_4, 'Account', url, :unless => Proc.new { logged_in? }
+    primary.item :key_3, 'Admin', url, class: 'special', if: -> { current_user.admin? }
+    primary.item :key_4, 'Account', url, unless: -> { logged_in? }
 
     # you can also specify html attributes to attach to this particular level
     # works for all levels of the menu
@@ -72,7 +73,5 @@ SimpleNavigation::Configuration.run do |navigation|
 
     # You can turn off auto highlighting for a specific level
     # primary.auto_highlight = false
-
   end
-
 end

data/init.rb

@@ -1 +1 @@
-require File.dirname(__FILE__) + "/rails/init"
+require File.dirname(__FILE__) + '/rails/init'

data/lib/generators/navigation_config/navigation_config_generator.rb

@@ -1,12 +1,17 @@
 class NavigationConfigGenerator < Rails::Generators::Base
   def self.source_root
-    @source_root ||= File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','generators','navigation_config', 'templates'))
+    @source_root ||= begin
+      tpl_dir = %w[.. .. .. .. generators navigation_config templates]
+      tpl_dir_path = File.join(tpl_dir)
+      File.expand_path(tpl_dir_path, __FILE__)
+    end
   end
 
-  desc 'Creates a template config file for the simple-navigation plugin. You will find the generated file in config/navigation.rb.'
+  desc 'Creates a template config file for the simple-navigation plugin. ' \
+       'You will find the generated file in config/navigation.rb.'
   def navigation_config
-    copy_file('config/navigation.rb', 'config/navigation.rb')    
-    say File.read(File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','README')))
+    copy_file('config/navigation.rb', 'config/navigation.rb')
+    readme_path = File.join(%w[.. .. .. .. README.md])
+    say File.read(File.expand_path(readme_path, __FILE__))
   end
-  
-end
+end

data/lib/simple-navigation.rb

@@ -1 +1 @@
-require 'simple_navigation'
+require 'simple_navigation'

data/lib/simple_navigation.rb

@@ -10,37 +10,52 @@ require 'simple_navigation/adapters'
 
 require 'forwardable'
 
-# A plugin for generating a simple navigation. See README for resources on usage instructions.
+# A plugin for generating a simple navigation. See README for resources on
+# usage instructions.
 module SimpleNavigation
-  
-  mattr_accessor :adapter_class, :adapter, :config_files, :config_file_paths, :default_renderer, :registered_renderers, :root, :environment
+  mattr_accessor :adapter,
+                 :adapter_class,
+                 :config_files,
+                 :config_file_paths,
+                 :default_renderer,
+                 :environment,
+                 :registered_renderers,
+                 :root
 
   # Cache for loaded config files
   self.config_files = {}
 
-  # Allows for multiple config_file_paths. Needed if a plugin itself uses simple-navigation and therefore has its own config file
+  # Allows for multiple config_file_paths. Needed if a plugin itself uses
+  # simple-navigation and therefore has its own config file
   self.config_file_paths = []
-  
-  # Maps renderer keys to classes. The keys serve as shortcut in the render_navigation calls (:renderer => :list)
+
+  # Maps renderer keys to classes. The keys serve as shortcut in the
+  # render_navigation calls (renderer: :list)
   self.registered_renderers = {
-    :list         => SimpleNavigation::Renderer::List,
-    :links        => SimpleNavigation::Renderer::Links,
-    :breadcrumbs  => SimpleNavigation::Renderer::Breadcrumbs,
-    :text         => SimpleNavigation::Renderer::Text,
-    :json         => SimpleNavigation::Renderer::Json
+    list:        SimpleNavigation::Renderer::List,
+    links:       SimpleNavigation::Renderer::Links,
+    breadcrumbs: SimpleNavigation::Renderer::Breadcrumbs,
+    text:        SimpleNavigation::Renderer::Text,
+    json:        SimpleNavigation::Renderer::Json
   }
-  
+
   class << self
     extend Forwardable
-    
-    def_delegators :adapter, :request, :request_uri, :request_path, :context_for_eval, :current_page?
+
+    def_delegators :adapter, :context_for_eval,
+                             :current_page?,
+                             :request,
+                             :request_path,
+                             :request_uri
+
     def_delegators :adapter_class, :register
 
-    # Sets the root path and current environment as specified. Also sets the default config_file_path.
+    # Sets the root path and current environment as specified. Also sets the
+    # default config_file_path.
     def set_env(root, environment)
       self.root = root
       self.environment = environment
-      self.config_file_paths << SimpleNavigation.default_config_file_path
+      config_file_paths << SimpleNavigation.default_config_file_path
     end
 
     # Returns the current framework in which the plugin is running.
@@ -49,30 +64,29 @@ module SimpleNavigation
       return :padrino if defined?(Padrino)
       return :sinatra if defined?(Sinatra)
       return :nanoc if defined?(Nanoc3)
-      raise 'simple_navigation currently only works for Rails, Sinatra and Padrino apps'
+      fail 'simple_navigation currently only works for Rails, Sinatra and ' \
+           'Padrino apps'
     end
-    
+
     # Loads the adapter for the current framework
     def load_adapter
-      self.adapter_class = case framework
-      when :rails
-        SimpleNavigation::Adapters::Rails
-      when :sinatra
-        SimpleNavigation::Adapters::Sinatra
-      when :padrino
-        SimpleNavigation::Adapters::Padrino
-      when :nanoc
-        SimpleNavigation::Adapters::Nanoc
-      end
+      self.adapter_class =
+        case framework
+        when :rails then SimpleNavigation::Adapters::Rails
+        when :sinatra then SimpleNavigation::Adapters::Sinatra
+        when :padrino then SimpleNavigation::Adapters::Padrino
+        when :nanoc then SimpleNavigation::Adapters::Nanoc
+        end
     end
 
-    # Creates a new adapter instance based on the context in which render_navigation has been called.
+    # Creates a new adapter instance based on the context in which
+    # render_navigation has been called.
     def init_adapter_from(context)
-      self.adapter = self.adapter_class.new(context)
+      self.adapter = adapter_class.new(context)
     end
-  
+
     def default_config_file_path
-      File.join(SimpleNavigation.root, 'config')
+      File.join(root, 'config')
     end
 
     # Returns true if the config_file for specified context does exist.
@@ -80,30 +94,47 @@ module SimpleNavigation
       !!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.
+    # 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.collect { |path| File.join(path, config_file_name(navigation_context)) }.detect {|full_path| File.exists?(full_path)}
+      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 = navigation_context == :default ? '' : "#{navigation_context.to_s.underscore}_"
-      "#{prefix}navigation.rb"      
+      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]
     end
 
-    # Reads the config_file for the specified navigation_context and stores it for later evaluation.
+    # Reads the config_file for the specified navigation_context and stores it
+    # for later evaluation.
     def load_config(navigation_context = :default)
-      raise "Config file '#{config_file_name(navigation_context)}' not found in path(s) #{config_file_paths.join(', ')}!" unless config_file?(navigation_context)      
-      if self.environment == 'production'
-        self.config_files[navigation_context] ||= IO.read(config_file(navigation_context))
+      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
       else
-        self.config_files[navigation_context] = IO.read(config_file(navigation_context))
+        config_files[navigation_context] = begin
+          IO.read(config_file(navigation_context))
+        end
       end
     end
 
@@ -112,57 +143,54 @@ module SimpleNavigation
       SimpleNavigation::Configuration.instance
     end
 
-    # Returns the ItemContainer that contains the items for the primary navigation
+    # Returns the ItemContainer that contains the items for the
+    # primary navigation
     def primary_navigation
       config.primary_navigation
     end
 
-    # Returns the active item container for the specified level. Valid levels are
+    # Returns the active item container for the specified level.
+    # Valid levels are
     # * :all - in this case the primary_navigation is returned.
     # * :leaves - the 'deepest' active item_container will be returned
-    # * a specific level - the active item_container for the specified level will be returned
-    # * a range of levels - the active item_container for the range's minimum will be returned
+    # * a specific level - the active item_container for the specified level
+    #   will be returned
+    # * a range of levels - the active item_container for the range's minimum
+    #   will be returned
     #
     # Returns nil if there is no active item_container for the specified level.
     def active_item_container_for(level)
       case level
-      when :all
-        self.primary_navigation
-      when :leaves
-        self.primary_navigation.active_leaf_container
-      when Integer
-        self.primary_navigation.active_item_container_for(level)
-      when Range
-        self.primary_navigation.active_item_container_for(level.min)
+      when :all then primary_navigation
+      when :leaves then primary_navigation.active_leaf_container
+      when Integer then primary_navigation.active_item_container_for(level)
+      when Range then primary_navigation.active_item_container_for(level.min)
       else
-        raise ArgumentError, "Invalid navigation level: #{level}"
+        fail ArgumentError, "Invalid navigation level: #{level}"
       end
     end
-        
+
     # Registers a renderer.
     #
     # === Example
     # To register your own renderer:
     #
-    #   SimpleNavigation.register_renderer :my_renderer => My::RendererClass
+    #   SimpleNavigation.register_renderer my_renderer: My::RendererClass
     #
     # Then in the view you can call:
     #
-    #   render_navigation(:renderer => :my_renderer)
+    #   render_navigation(renderer: :my_renderer)
     def register_renderer(renderer_hash)
-      self.registered_renderers.merge!(renderer_hash)
+      registered_renderers.merge!(renderer_hash)
     end
-    
+
     private
-    
+
     def apply_defaults(options)
       options[:level] = options.delete(:levels) if options[:levels]
-      {:context => :default, :level => :all}.merge(options)
+      { context: :default, level: :all }.merge(options)
     end
-    
-
   end
-
 end
 
 SimpleNavigation.load_adapter

data/lib/simple_navigation/adapters/base.rb

@@ -1,37 +1,37 @@
 module SimpleNavigation
   module Adapters
-    
-    # This is the base class for all adapters. This class mainly exists for documenting reasons.
+    # This is the base class for all adapters.
+    # This class mainly exists for documenting reasons.
     # It lists all the methods that an adapter should implement.
     #
     class Base
       attr_reader :context, :request
-      
-      # This method is usually called when the framework is initialized. 
-      # It should call SimpleNavigation.set_env and install SimpleNavigation::Helpers where appropriate.
+
+      # This method is usually called when the framework is initialized.
+      # It should call SimpleNavigation.set_env and install
+      # SimpleNavigation::Helpers where appropriate.
       def self.register; end
-      
+
       # Returns the full path incl. query params
       def request_uri; end
-      
+
       # Returns the path without query params
       def request_path; end
-      
+
       # Returns the context in which the config files will be evaluated
       def context_for_eval; end
-      
-      # Returns true if the current request's url matches the specified url. 
+
+      # Returns true if the current request's url matches the specified url.
       # Used to determine if an item should be autohighlighted.
       def current_page?(url); end
-      
+
       # Returns a link with the specified name, url and options.
       # Used for rendering.
-      def link_to(name, url, options={}); end
-      
+      def link_to(name, url, options = {}); end
+
       # Returns a tag of the specified type, content and options.
       # Used for rendering.
-      def content_tag(type, content, options={}); end
-      
+      def content_tag(type, content, options = {}); end
     end
   end
-end
+end

data/lib/simple_navigation/adapters/nanoc.rb

@@ -16,29 +16,30 @@ module SimpleNavigation
       def context_for_eval
         context
       end
-      
-      # Returns true if the current request's url matches the specified url. 
+
+      # Returns true if the current request's url matches the specified url.
       # Used to determine if an item should be autohighlighted.
       def current_page?(url)
         path = context.item.path
         path && path.chop == url
       end
-      
+
       # Returns a link with the specified name, url and options.
       # Used for rendering.
-      def link_to(name, url, options={})
+      def link_to(name, url, options = {})
         "<a href='#{url}' #{to_attributes(options)}>#{name}</a>"
       end
 
       # Returns a tag of the specified type, content and options.
       # Used for rendering.
-      def content_tag(type, content, options={})
+      def content_tag(type, content, options = {})
         "<#{type} #{to_attributes(options)}>#{content}</#{type}>"
       end
 
       private
+
       def to_attributes(options)
-        options.map {|k, v| v.nil? ? nil : "#{k}='#{v}'"}.compact.join(' ')
+        options.map { |k, v| v.nil? ? nil : "#{k}='#{v}'" }.compact.join(' ')
       end
     end
   end