simple-navigation 3.13.0 → 4.0.5

data/Guardfile

@@ -1,5 +1,7 @@
-guard :rspec do
+guard :rspec, all_after_pass: true, failed_mode: :none do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/fake_app/.+\.rb$}) { 'spec/integration' }
+
   watch('spec/spec_helper.rb')  { 'spec' }
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 codeplant GmbH
+Copyright (c) 2017 codeplant GmbH
 
 MIT License
 

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, Sinatra or Padrino applications. It runs with all ruby versions (including ruby 2.x).
 
 ## Documentation
 
@@ -29,12 +29,35 @@ Don't hesitate to come talk on the [project's group](http://groups.google.com/gr
 
 ## Contributing
 
-1. Fork it (https://github.com/codeplant/simple-navigation/fork)
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Fork, fix, then send a Pull Request.
+
+To run the test suite locally against all supported frameworks:
+
+    % bundle install
+    % rake spec:all
+
+To target the test suite against one framework:
+
+    % rake spec:rails-4-2-stable
+
+You can find a list of supported spec tasks by running rake -T. You may also find it useful to run a specific test for a specific framework. To do so, you'll have to first make sure you have bundled everything for that configuration, then you can run the specific test:
+
+% BUNDLE_GEMFILE='gemfiles/rails-4-2-stable.gemfile' bundle install -j 4
+% BUNDLE_GEMFILE='gemfiles/rails-4-2-stable.gemfile' bundle exec rspec ./spec/requests/users_spec.rb
+
+### Rake and Bundler
+
+If you use a shell plugin (like oh-my-zsh:bundler) that auto-prefixes commands with `bundle exec` using the `rake` command will fail.
+
+Get the original command with `type -a rake`:
+
+    % type -a rake
+    rake is an alias for bundled_rake
+    rake is /Users/username/.rubies/ruby-2.2.3/bin/rake
+    rake is /usr/bin/rake
+
+In this situation `/Users/username/.rubies/ruby-2.2.3/bin/rake` is the command you should use.
 
 ## License
 
-Copyright (c) 2014 codeplant GmbH, released under the MIT license
+Copyright (c) 2017 codeplant GmbH, released under the MIT license

data/Rakefile

@@ -1,10 +1,33 @@
-require 'bundler/gem_tasks'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
 require 'rspec/core/rake_task'
+
 require 'rdoc/task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: 'spec'
+
+namespace :spec do
+  mappers = %w[
+    rails-3-2-stable
+    rails-4-1-stable
+    rails-4-2-stable
+  ]
+
+  mappers.each do |gemfile|
+    desc "Run Tests against #{gemfile}"
+    task gemfile do
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle -j 4 --quiet"
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake -t spec"
+    end
+  end
+
+  desc 'Run Tests against all ORMs'
+  task all: mappers
+end
 
 RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'

data/gemfiles/.bundle/config

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

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

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'rake', '< 11.0'
+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,7 @@
+source 'https://rubygems.org'
+
+gem 'rake', '< 11.0'
+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 'rake', '< 11.0'
+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::Railtie)
 
 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/padrino.rb

@@ -1,8 +1,8 @@
 module SimpleNavigation
   module Adapters
     class Padrino < Sinatra
-      def self.register
-        SimpleNavigation.set_env(PADRINO_ROOT, PADRINO_ENV)
+      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

@@ -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