breadcrumbs_on_rails 2.1.0 → 2.2.0

data/test/unit/simple_builder_test.rb

@@ -2,15 +2,11 @@ require 'test_helper'
 
 class SimpleBuilderTest < ActionView::TestCase
 
-  Template = Class.new do
-    include ActionView::Helpers::TagHelper
-    include ActionView::Helpers::UrlHelper
-  end
-
   def setup
-    @template = Template.new
+    @template = self
   end
 
+
   def test_render_should_be_implemented
     assert_nothing_raised { simplebuilder(@template, []).render }
   end
@@ -59,14 +55,14 @@ class SimpleBuilderTest < ActionView::TestCase
 
   protected
 
-    def simplebuilder(*args)
-      BreadcrumbsOnRails::Breadcrumbs::SimpleBuilder.new(*args)
-    end
+  def simplebuilder(*args)
+    BreadcrumbsOnRails::Breadcrumbs::SimpleBuilder.new(*args)
+  end
 
-    def generate_elements(number)
-      (1..number).collect do |index|
-        BreadcrumbsOnRails::Breadcrumbs::Element.new("Element #{index}", "/element/#{index}")
-      end
+  def generate_elements(number)
+    (1..number).collect do |index|
+      BreadcrumbsOnRails::Breadcrumbs::Element.new("Element #{index}", "/element/#{index}")
     end
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: breadcrumbs_on_rails
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-20 00:00:00.000000000Z
+date: 2012-02-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70277284828980 !ruby/object:Gem::Requirement
+  name: rails
+  requirement: &70311920950420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *70277284828980
+  version_requirements: *70311920950420
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &70277284828540 !ruby/object:Gem::Requirement
+  name: appraisal
+  requirement: &70311920948980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,29 +32,29 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277284828540
+  version_requirements: *70311920948980
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &70277284827980 !ruby/object:Gem::Requirement
+  name: mocha
+  requirement: &70311920940920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 0.9.10
   type: :development
   prerelease: false
-  version_requirements: *70277284827980
+  version_requirements: *70311920940920
 - !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: &70277284827500 !ruby/object:Gem::Requirement
+  name: yard
+  requirement: &70311920940160 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.10
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277284827500
+  version_requirements: *70311920940160
 description: BreadcrumbsOnRails is a simple Ruby on Rails plugin for creating and
   managing a breadcrumb navigation for a Rails project.
 email: weppos@weppos.net
@@ -63,17 +63,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- CHANGELOG.rdoc
+- .travis.yml
+- Appraisals
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - breadcrumbs_on_rails.gemspec
+- gemfiles/3.0.gemfile
+- gemfiles/3.0.gemfile.lock
+- gemfiles/3.1.gemfile
+- gemfiles/3.1.gemfile.lock
+- gemfiles/3.2.gemfile
+- gemfiles/3.2.gemfile.lock
 - init.rb
 - lib/breadcrumbs_on_rails.rb
+- lib/breadcrumbs_on_rails/action_controller.rb
 - lib/breadcrumbs_on_rails/breadcrumbs.rb
-- lib/breadcrumbs_on_rails/controller_mixin.rb
 - lib/breadcrumbs_on_rails/railtie.rb
 - lib/breadcrumbs_on_rails/version.rb
 - test/test_helper.rb
@@ -100,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A simple Ruby on Rails plugin for creating and managing a breadcrumb navigation.

data/README.rdoc

@@ -1,205 +0,0 @@
-= Breadcrumbs On Rails
-
-*BreadcrumbsOnRails* is a simple Ruby on Rails plugin for creating and managing a breadcrumb navigation for a Rails project.
-It provides helpers for creating navigation elements with a flexible interface.
-
-
-== Requirements
-
-* Rails 3
-
-Please note 
-
-* BreadcrumbsOnRails 2.x requires Rails 3. Use BreadcrumbsOnRails 1.x with Rails 2.
-* BreadcrumbsOnRails doesn't work with Rails 2.1 or lower.
-
-
-== Installation
-
-"RubyGems":http://rubygems.org is the preferred way to install *BreadcrumbsOnRails* and the best way if you want install a stable version.
-
-  $ gem install breadcrumbs_on_rails
-
-Specify the Gem dependency in the "Bundler":http://gembundler.com Gemfile.
-
-  gem "breadcrumbs_on_rails"
-
-Use "Bundler":http://gembundler.com and the ":git option":http://gembundler.com/v1.0/git.html if you want to grab the latest version from the Git repository.
-
-
-== Usage
-
-Creating a breadcrumb navigation menu in your Rails app using BreadcrumbsOnRails is really straightforward.
-
-In your controller, call <tt>add_breadcrumb</tt> to push a new element on the breadcrumb stack. <tt>add_breadcrumb</tt> requires two arguments: the name of the breadcrumb and the target path. See the section "Breadcrumb Element" for more details about name and target class types.
-
-  class MyController
-  
-    add_breadcrumb "home", :root_path
-    add_breadcrumb "my", :my_path
-    
-    def index
-      # ...
-      
-      add_breadcrumb "index", index_path
-    end
-  
-  end
-
-The third, optional argument is a Hash of options to customize the breadcrumb link.
-
-  class MyController
-    def index
-      add_breadcrumb "index", index_path, :title => "Back to the Index"
-    end
-  end
-
-In your view, you can render the breadcrumb menu with the <tt>render_breadcrumbs</tt> helper.
-
-  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
-    <title>untitled</title>
-  </head>
-  
-  <body>
-    <%= render_breadcrumbs %>
-  </body>
-  </html>
-
-<tt>render_breadcrumbs</tt> understands a limited set of options. For example, you can pass change the default separator with the <tt>:separator</tt> option.
-
-  <body>
-    <%= render_breadcrumbs :separator => ' / ' %>
-  </body>
-
-More complex customizations require a custom Builder (documentation yet to come).
-
-=== Breadcrumb Element
-
-A breadcrumbs menu is composed by a number of <tt>Element</tt> objects. Each object contains two attributes: the name of the breadcrumb and the target path.
-
-When you call <tt>add_breadcrumb</tt>, the method automatically creates a new <tt>Element</tt> object for you and append it to the breadcrumbs stack. <tt>Element</tt> name and path can be one of the following Ruby types:
-
-* Symbol
-* Proc
-* String
-
-==== Symbol
-
-If the value is a Symbol, the library calls the corresponding method defined in the same context the and sets the <tt>Element</tt> attribute to the returned value.
-
-  class MyController
-    
-    # The Name is set to the value returned by
-    # the :root_name method.
-    add_breadcrumb :root_name, "/"
-    
-    protected
-    
-      def root_name
-        "the name"
-      end
-    
-  end
-
-==== Proc
-
-If the value is a Proc, the library calls the proc passing the current view context as argument and sets the <tt>Element</tt> attribute to the returned value. This is useful if you want to postpone the execution to get access to some special methods/variables created in your controller action.
-
-  class MyController
-
-    # The Name is set to the value returned by
-    # the :root_name method.
-    add_breadcrumb Proc.new { |c| c.my_helper_method },
-                   "/"
-  
-  end
-
-==== String
-
-If the value is a String, the library sets the <tt>Element</tt> attribute to the string value.
-
-  class MyController
-    
-    # The Name is set to the value returned by
-    # the :root_name method.
-    add_breadcrumb "homepage", "/"
-    
-  end
-
-
-=== Restricting breadcrumb scope
-
-The <tt>add_breadcrumb</tt> method understands all options you are used to pass to a Rails controller filter.
-In fact, behind the scenes this method uses a <tt>before_filter</tt> to store the tab in the <tt>@breadcrumbs</tt> variable.
-
-Taking advantage of Rails filter options, you can restrict a tab to a selected group of actions in the same controller.
-
-  class PostsController < ApplicationController
-    add_breadcrumb "admin", :admin_path
-    add_breadcrumb "posts", :posts_path, :only => %w(index show)
-  end
-  
-  class ApplicationController < ActionController::Base
-    add_breadcrumb "admin", :admin_path, :if => :admin_controller?
-    
-    def admin_controller?
-      self.class.name =~ /^Admin(::|Controller)/
-    end
-  end
-
-=== Internationalization and Localization
-
-BreadcrumbsOnRails is compatible with the standard Rails internationalization framework. 
-
-For example, if you want to localize your menu, define a new breadcrumbs node in your .yml file with all the keys for your elements.
-
-  # config/locales/en.yml
-  en:
-    breadcrumbs:
-      homepage: Homepage
-      first: First
-      second: Second
-      third: Third
-  
-  # config/locales/it.yml
-  it:
-    breadcrumbs:
-      homepage: Homepage
-      first: Primo
-      second: Secondo
-      third: Terzo
-
-In your controller, use the <tt>I18n.t</tt> method.
-
-  class PostsController < ApplicationController
-    add_breadcrumb I18n.t("breadcrumbs.first"),  :first_path
-    add_breadcrumb I18n.t("breadcrumbs.second"), :second_path, :only => %w(second)
-    add_breadcrumb I18n.t("breadcrumbs.third"),  :third_path,  :only => %w(third)
-  end
-  
-  class ApplicationController < ActionController::Base
-    add_breadcrumb I18n.t("breadcrumbs.homepage"), :root_path
-  end
-
-
-== Author
-
-* {Simone Carletti}[http://www.simonecarletti.com] <weppos@weppos.net>
-
-
-== Resources
-
-* {Homepage}[http://www.simonecarletti.com/code/breadcrumbs_on_rails]
-* {Source}[http://github.com/weppos/breadcrumbs_on_rails]
-* {API Documentation}[http://rubydoc.info/gems/breadcrumbs_on_rails]
-* {Bugs & Features}[http://github.com/weppos/breadcrumbs_on_rails/issues]
-
-
-== License
-
-BreadCrumbsOnRails is Copyright (c) 2009-2011 Simone Carletti.
-This is Free Software distributed under the MIT license.