simple-navigation 3.11.0 → 3.12.0

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+rdoc
+pkg
+coverage
+Gemfile.lock
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1

data/CHANGELOG

@@ -1,3 +1,14 @@
+*3.12.0
+
+* Relax hash constraint on item_adapter. Thanks to Ramon Tayag.
+* Fixed hidden special character in navigation template. Credits to Stef Lewandowski
+* Added full MIT license text. Thanks to Ben Armstrong.
+* Added license to gemspec. Thanks to Troy Thompson.
+* Allow defining other html attributes than :id and :class on menu container. Credits to Jacek Tomaszewski.
+* Added new config option "consider_item_names_as_safe". Thanks to Alexey Naumov.
+* Big cleanup of specs, removed jeweler in favor of the "bundler" way. Huge thank you to Simon Courtois.
+* Added more powerful name generator which yields the item itself in addition to the item's name. Credits to Simon Curtois.
+
 *3.11.0
 
 * Added Json renderer. Thanks to Alberto Avila.

data/Gemfile

@@ -1,17 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem 'activesupport', '>= 2.3.2'
-
-# install the rails group if you want to ensure rails compatibility -
-# but you've already got rails installed anyway, right? :-)
-group :rails do
-  gem 'actionpack', '>= 2.3.2'
-end
-
-group :development do
-  gem 'rspec', '>= 2.0.1'
-  gem 'json_spec', '~> 1.1.1'
-  gem 'rake'
-  gem 'rdoc'
-  gem 'jeweler'
-end
+gemspec

data/Guardfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 codeplant GmbH
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Simple Navigation
+
+[![Gem Version](https://badge.fury.io/rb/simple-navigation.png)](http://badge.fury.io/rb/simple-navigation)
+[![Build Status](https://secure.travis-ci.org/codeplant/simple-navigation.png?branch=master)](http://travis-ci.org/codeplant/simple-navigation)
+[![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).
+
+## Documentation
+
+For the complete documentation, take a look at the [project's wiki](http://wiki.github.com/codeplant/simple-navigation).
+
+## RDoc
+
+You can consult the project's RDoc on [RubyDoc.info](http://rubydoc.info/github/codeplant/simple-navigation/frames).
+
+If you need to generate the RDoc files locally, check out the repository and simply call the `rake rdoc` in the project's folder.
+
+## Online Demo
+
+You can try simple-navigation with the [online demo](http://simple-navigation-demo.codeplant.ch).
+
+The source code of this online demo is [available on Github](http://github.com/codeplant/simple-navigation-demo).
+
+## Feedback and Questions
+
+Don't hesitate to come talk on the [project's group](http://groups.google.com/group/simple-navigation).
+
+## 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
+
+## License
+
+Copyright (c) 2014 codeplant GmbH, released under the MIT license

data/Rakefile

@@ -1,47 +1,14 @@
-require 'rake'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rdoc/task'
 
-desc 'Default: run specs.'
-task :default => :spec
+RSpec::Core::RakeTask.new(:spec)
 
-desc 'Run the specs'
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = ['--colour --format progress']
-end
-
-namespace :spec do
-  desc "Run all specs with RCov"
-  RSpec::Core::RakeTask.new(:rcov) do |t|
-    t.rspec_opts = ['--colour --format progress']
-    t.rcov = true
-    t.rcov_opts = ['--exclude', 'spec,/Users/']
-  end
-end
+task default: :spec
 
-desc 'Generate documentation for the simple_navigation plugin.'
-RDoc::Task.new(:rdoc) do |rdoc|
+RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'SimpleNavigation'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "simple-navigation"
-    gemspec.summary = "simple-navigation is a ruby library for creating navigations (with multiple levels) for your Rails2, Rails3, Sinatra or Padrino application."
-    gemspec.email = "andreas.schacke@gmail.com"
-    gemspec.homepage = "http://github.com/andi/simple-navigation"
-    gemspec.description = "With the simple-navigation gem installed you can easily create multilevel navigations for your Rails, Sinatra or Padrino applications. The navigation is defined in a single configuration file. It supports automatic as well as explicit highlighting of the currently active navigation through regular expressions."
-    gemspec.authors = ["Andi Schacke", "Mark J. Titorenko"]
-    gemspec.rdoc_options = ["--inline-source", "--charset=UTF-8"]
-    gemspec.files = FileList["[A-Z]*", "{lib,spec,rails,generators}/**/*"] - FileList["**/*.log", "Gemfile.lock"]
-    gemspec.rubyforge_project = 'andi'
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError => e
-  puts "Jeweler not available (#{e}). Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  rdoc.options << '--inline-source'
+  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
 end

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

@@ -24,11 +24,14 @@ SimpleNavigation::Configuration.run do |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| "<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
+  
+  # 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|
@@ -60,13 +63,12 @@ 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_3, 'Admin', url, :class => 'special', :if => Proc.new { current_user.admin? }
     primary.item :key_4, 'Account', url, :unless => Proc.new { logged_in? }
 
-    # you can also specify a css id or class to attach to this particular level
+    # you can also specify html attributes to attach to this particular level
     # works for all levels of the menu
-    # primary.dom_id = 'menu-id'
-    # primary.dom_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

data/init.rb

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

data/install.rb

@@ -0,0 +1,5 @@
+begin
+  puts IO.read(File.join(File.dirname(__FILE__), 'README'))
+rescue Exception => e
+  puts "The following error ocurred while installing the plugin: #{e.message}"
+end

data/lib/simple_navigation/adapters/rails.rb

@@ -39,7 +39,7 @@ module SimpleNavigation
       end
       
       def link_to(name, url, options={})
-        template.link_to(html_safe(name), url, options) if template
+        template.link_to(link_title(name), url, options) if template
       end
       
       def content_tag(type, content, options={})
@@ -76,6 +76,10 @@ module SimpleNavigation
           context.controller || context :
           context
       end
+
+      def link_title name
+        SimpleNavigation.config.consider_item_names_as_safe ? html_safe(name) : name
+      end
          
     end
   end

data/lib/simple_navigation/core/configuration.rb

@@ -6,7 +6,7 @@ module SimpleNavigation
   class Configuration
     include Singleton
 
-    attr_accessor :renderer, :selected_class, :active_leaf_class, :autogenerate_item_ids, :id_generator, :auto_highlight, :name_generator
+    attr_accessor :renderer, :selected_class, :active_leaf_class, :autogenerate_item_ids, :id_generator, :auto_highlight, :name_generator, :consider_item_names_as_safe
     attr_reader :primary_navigation
 
     class << self
@@ -32,6 +32,10 @@ module SimpleNavigation
       @id_generator = Proc.new {|id| id.to_s }
       @name_generator = Proc.new {|name| name}
       @auto_highlight = true
+      @consider_item_names_as_safe = true
+      if defined?(ActiveSupport::Deprecation)
+        ActiveSupport::Deprecation.warn "simple-navigation: consider_item_names_as_safe will be set to false by default in 3.13.0 release, hence item names will be considered unsafe by default. See https://github.com/codeplant/simple-navigation/wiki", caller
+      end
     end
 
     # This is the main method for specifying the navigation items. It can be used in two ways:

data/lib/simple_navigation/core/item.rb

@@ -13,6 +13,7 @@ module SimpleNavigation
       options = setup_url_and_options(url_or_options, options_or_nil)
       @container.dom_class = options.delete(:container_class) if options[:container_class]
       @container.dom_id = options.delete(:container_id) if options[:container_id]
+      @container.dom_attributes = options[:container_attributes] ? options.delete(:container_attributes) : {}
       @container.selected_class = options.delete(:selected_class) if options[:selected_class]
       @key = key
       @method = options.delete(:method)
@@ -30,7 +31,7 @@ module SimpleNavigation
     def name(options = {})
       options.reverse_merge!(:apply_generator => true)
       if (options[:apply_generator])
-        SimpleNavigation.config.name_generator.call(@name)
+        SimpleNavigation.config.name_generator.call(@name, self)
       else
         @name
       end

data/lib/simple_navigation/core/item_adapter.rb

@@ -20,13 +20,13 @@ module SimpleNavigation
   # See SimpleNavigation::ItemContainer#item for the purpose of these methods.
   class ItemAdapter
     extend Forwardable
-    
+
     def_delegators :item, :key, :name, :url
 
     attr_reader :item
 
     def initialize(item)
-      @item = item.instance_of?(Hash) ? to_object(item) : item
+      @item = item.is_a?(Hash) ? to_object(item) : item
     end
 
     # Returns the options for this item. If the wrapped item does not implement an options method, an empty hash is returned.
@@ -45,7 +45,7 @@ module SimpleNavigation
     end
 
     protected
-    
+
     # Converts the specified hash into an object. Each key will be added as method.
     #
     def to_object(hash)
@@ -60,4 +60,4 @@ module SimpleNavigation
     end
 
   end
-end
+end

data/lib/simple_navigation/core/item_container.rb

@@ -4,7 +4,7 @@ module SimpleNavigation
   class ItemContainer
 
     attr_reader :items, :level
-    attr_accessor :renderer, :dom_id, :dom_class, :auto_highlight, :selected_class
+    attr_accessor :renderer, :dom_id, :dom_class, :dom_attributes, :auto_highlight, :selected_class
 
     def initialize(level=1) #:nodoc:
       @level = level
@@ -13,6 +13,11 @@ module SimpleNavigation
       @auto_highlight = true
     end
 
+    def dom_attributes
+      # backward compability for #dom_id and #dom_class
+      (@dom_attributes || {}).merge({id: dom_id, class: dom_class}.reject{|k, v| v.nil?})
+    end
+
     # Creates a new navigation item.
     #
     # The <tt>key</tt> is a symbol which uniquely defines your navigation item in the scope of the primary_navigation or the sub_navigation.

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

@@ -6,7 +6,7 @@ module SimpleNavigation
     #
     # 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_class and dom_id are applied to the surrounding <div> element.
+    # The ItemContainer's dom_attributes are applied to the surrounding <div> element.
     #
     class Breadcrumbs < SimpleNavigation::Renderer::Base
 
@@ -14,7 +14,7 @@ module SimpleNavigation
         content = a_tags(item_container).join(join_with)
         content_tag(:div,
           prefix_for(content) + content,
-          {:id => item_container.dom_id, :class => item_container.dom_class})
+          item_container.dom_attributes)
       end
 
       protected

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

@@ -8,14 +8,14 @@ module SimpleNavigation
     #
     # 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_class and dom_id are applied to the surrounding <div> element.
+    # The ItemContainer's dom_attributes are applied to the surrounding <div> element.
     #
     class Links < SimpleNavigation::Renderer::Base
       def render(item_container)
         div_content = item_container.items.inject([]) do |list, item|
           list << tag_for(item)
         end.join(join_with)
-        content_tag(:div, div_content, {:id => item_container.dom_id, :class => item_container.dom_class})
+        content_tag(:div, div_content, item_container.dom_attributes)
       end
 
       protected

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

@@ -21,7 +21,7 @@ module SimpleNavigation
         if skip_if_empty? && item_container.empty?
           ''
         else  
-          content_tag((options[:ordered] ? :ol : :ul), list_content, {:id => item_container.dom_id, :class => item_container.dom_class}) 
+          content_tag((options[:ordered] ? :ol : :ul), list_content, item_container.dom_attributes) 
         end
       end
     end

data/lib/simple_navigation/version.rb

@@ -0,0 +1,3 @@
+module SimpleNavigation
+  VERSION = '3.12.0'
+end

data/lib/simple_navigation.rb

@@ -3,6 +3,7 @@ require 'active_support/core_ext/array'
 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/adapters'

data/simple-navigation.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_navigation/version'
+
+Gem::Specification.new do |spec|
+  spec.name             = 'simple-navigation'
+  spec.version          = SimpleNavigation::VERSION
+  spec.authors          = ['Andi Schacke', 'Mark J. Titorenko']
+  spec.email            = ['andi@codeplant.ch']
+  spec.description      = "With the simple-navigation gem installed you can easily " \
+                          "create multilevel navigations for your Rails, Sinatra or "\
+                          "Padrino applications. The navigation is defined in a "    \
+                          "single configuration file. It supports automatic as well "\
+                          "as explicit highlighting of the currently active "        \
+                          "navigation through regular expressions."
+  spec.summary          = "simple-navigation is a ruby library for creating navigations "\
+                          "(with multiple levels) for your Rails2, Rails3, Rails4, Sinatra or "  \
+                          "Padrino application."
+  spec.homepage         = 'http://github.com/codeplant/simple-navigation'
+  spec.license          = 'MIT'
+
+  spec.files            = `git ls-files -z`.split("\x0")
+  spec.executables      = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files       = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths    = ['lib']
+
+  spec.rdoc_options     = ['--inline-source', '--charset=UTF-8']
+
+  spec.add_runtime_dependency 'activesupport', '>= 2.3.2'
+
+  spec.add_development_dependency 'actionpack', '>= 2.3.2'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'guard-rspec', '~> 4.2'
+  spec.add_development_dependency 'json_spec', '~> 1.1'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rdoc'
+  spec.add_development_dependency 'rspec', '~> 2.0'
+end

data/spec/initializers/have_css_matcher.rb

@@ -0,0 +1,13 @@
+RSpec::Matchers.define :have_css do |expected, times|
+  match do |actual|
+    HTML::Selector.new(expected).select(actual).should have_at_least(times || 1).entry
+  end
+
+  failure_message_for_should do |actual|
+    "expected #{actual.to_s} to have #{times || 1} elements matching '#{expected}'"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected #{actual.to_s} not to have #{times || 1} elements matching '#{expected}'"
+  end
+end

data/spec/lib/simple_navigation/adapters/padrino_spec.rb

@@ -1,31 +1,29 @@
 require 'spec_helper'
 
-describe SimpleNavigation::Adapters::Padrino do
+module SimpleNavigation
+  module Adapters
+    describe Padrino do
+      let(:adapter) { SimpleNavigation::Adapters::Padrino.new(context) }
+      let(:content) { double(:content) }
+      let(:context) { double(:context, request: request) }
+      let(:request) { double(:request) }
 
-  def create_adapter
-    SimpleNavigation::Adapters::Padrino.new(@context)
-  end
-  
-  before(:each) do
-    @request = stub(:request)
-    @content = stub(:content)
-    @context = stub(:context, :request => @request)
-    @adapter = create_adapter
-  end
-  
-  describe 'link_to' do
-    it "should delegate to context" do
-      @context.should_receive(:link_to).with('name', 'url', :my_option => true)
-      @adapter.link_to('name', 'url', :my_option => true)
-    end
-  end
-  
-  describe 'content_tag' do
-    it "should delegate to context" do
-      @content.should_receive(:html_safe).and_return('content')
-      @context.should_receive(:content_tag).with('type', 'content', :my_option => true)
-      @adapter.content_tag('type', @content, :my_option => true)
+      describe '#link_to' do
+        it 'delegates to context' do
+          expect(context).to receive(:link_to)
+                             .with('name', 'url', :my_option => true)
+          adapter.link_to('name', 'url', :my_option => true)
+        end
+      end
+
+      describe '#content_tag' do
+        it 'delegates to context' do
+          expect(content).to receive(:html_safe).and_return('content')
+          expect(context).to receive(:content_tag)
+                             .with('type', 'content', my_option: true)
+          adapter.content_tag('type', content, my_option: true)
+        end
+      end
     end
   end
-  
 end