RubyGems - breadcrumbs_on_rails - Versions diffs - 0.2.0 → 1.0.1 - Mend

breadcrumbs_on_rails 0.2.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

data/CHANGELOG.rdoc +12 -0
data/LICENSE.rdoc +1 -1
data/Manifest +5 -8
data/README.rdoc +53 -34
data/breadcrumbs_on_rails.gemspec +5 -5
data/lib/breadcrumbs_on_rails.rb +3 -3
data/lib/breadcrumbs_on_rails/controller_mixin.rb +1 -1
data/lib/breadcrumbs_on_rails/version.rb +5 -5
metadata +37 -25
data/install.rb +0 -1
data/tasks/tabs_on_rails_tasks.rake +0 -4
data/uninstall.rb +0 -1

data/CHANGELOG.rdoc CHANGED Viewed

@@ -1,6 +1,18 @@
 = Changelog
+== Release 1.0.1
+* FIXED: Since the removal of rails/init.rb in 7278376ab77651e540e39552384ad9677e32ff7e, Rails fails to load the helpers.
+== Release 1.0.0
+* CHANGED: Removed empty install/uninstall hooks and tasks folder.
+* CHANGED: Removed rails/init hook because deprecated in Rails 3.
 == Release 0.2.0
 * Releasing the library as open source project.

data/LICENSE.rdoc CHANGED Viewed

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Simone Carletti
+Copyright (c) 2009-2010 Simone Carletti
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest CHANGED Viewed

@@ -1,19 +1,16 @@
 CHANGELOG.rdoc
+LICENSE.rdoc
+Manifest
+README.rdoc
+Rakefile
 init.rb
-install.rb
+lib/breadcrumbs_on_rails.rb
 lib/breadcrumbs_on_rails/breadcrumbs.rb
 lib/breadcrumbs_on_rails/controller_mixin.rb
 lib/breadcrumbs_on_rails/version.rb
-lib/breadcrumbs_on_rails.rb
-LICENSE.rdoc
-Manifest
 rails/init.rb
-Rakefile
-README.rdoc
-tasks/tabs_on_rails_tasks.rake
 test/breadcrumbs_on_rails_test.rb
 test/builder_test.rb
 test/element_test.rb
 test/simple_builder_test.rb
 test/test_helper.rb
-uninstall.rb

data/README.rdoc CHANGED Viewed

@@ -7,7 +7,7 @@ It provides helpers for creating navigation elements with a flexible interface.
 == Requirements
 * Ruby >= 1.8.6
-* Rails >= 2.2
+* Rails 2.2.x, 2.3.x or 3.0 (see section Rails 3 below)
 == Rails Installation
@@ -15,21 +15,30 @@ It provides helpers for creating navigation elements with a flexible interface.
 === As a Gem
 This is the preferred way to install BreadcrumbsOnRails and the best way if you want install a stable version.
-The GEM is hosted on {Gemcutter}[http://gemcutter.org/gems/tabs_on_rails].
+The GEM is hosted on {RubyGems}[http://rubygems.org/gems/breadcrumbs_on_rails].
-  $ gem install breadcrumbs_on_rails --source http://gemcutter.org
+  $ gem install breadcrumbs_on_rails
-With Rails >= 2.2, you can specify the GEM dependency in your environment.rb file so that Rails will automatically check the requirement on startup.
+==== Rails 2.2.x and 2.3.x
+With Rails 2.2.x and 2.3.x, you need to specify the GEM dependency in your <tt>environment.rb</tt> file so that Rails will automatically include the library on startup.
   Rails::Initializer.run do |config|
     # other configurations
     # ...
-    config.gem "breadcrumbs_on_rails", :source => "http://gemcutter.org"
+    config.gem "breadcrumbs_on_rails"
   end
+==== Rails 3
+With Rails 3, you need to specify the GEM dependency in your <tt>Gemfile</tt> file so that Bundler can resolve, download and install the library.
+  gem "breadcrumbs_on_rails"
 === As a Plugin
 This is the preferred way if you want to live on the edge and install a development version.
@@ -39,7 +48,7 @@ This is the preferred way if you want to live on the edge and install a developm
 == Usage
-Having a breadcrumb navigation menu in your Rails app using BreadcrumbsOnRails is really straightforward.
+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.
@@ -65,7 +74,7 @@ In your view, you can render the breadcrumb menu with the <tt>render_breadcrumbs
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
     <title>untitled</title>
   </head>
   <body>
     <%= render_breadcrumbs %>
   </body>
@@ -85,18 +94,17 @@ A breadcrumbs menu is composed by a number of <tt>Element</tt> objects. Each obj
 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:
-<ul>
-  <li>Symbol</li>
-  <li>Proc</li>
-  <li>String</li>
-</ul>
+* 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, root_path
@@ -113,29 +121,29 @@ If the value is a Symbol, the library calls the corresponding method defined in
 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
+  class MyController
-  # The Name is set to the value returned by
-  # the :root_name method.
-  add_breadcrumb Proc.new { |c| c.my_helper_method },
-                 root_path
+    # The Name is set to the value returned by
+    # the :root_name method.
+    add_breadcrumb Proc.new { |c| c.my_helper_method },
+                   root_path
-end
+  end
 ==== String
 If the value is a Proc, 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", "http://example.com/"
   end
-=== Restricting set_tab scope
+=== 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.
@@ -146,10 +154,10 @@ Taking advantage of Rails filter options, you can restrict a tab to a selected g
     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
@@ -168,7 +176,7 @@ For example, if you want to localize your menu, define a new breadcrumbs node in
       first: First
       second: Second
       third: Third
   # config/locales/it.yml
   it:
     breadcrumbs:
@@ -184,30 +192,41 @@ In your controller, use the <tt>I18n.t</tt> method.
     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
+=== Rails 3
+This plugin is "partially" compatible with Rails 3.
+The first attempt to create an unique release compatible with both Rails 2.x and Rails 3 failed
+due to some Rails 3 internal changes
+(see http://github.com/weppos/breadcrumbs_on_rails/commit/b25885ceb293193b6b264177769f003985df3bff).
-== Documentation
+This version is specifically packaged and tested against Rails 2.3.x,
+but you can use it in a Rails 3 application by manually including the
+<tt>BreadcrumbsOnRails::ControllerMixin</tt> mixin in your <tt>ApplicationController</tt>.
+  class ApplicationController < ActionController::Base
+    include BreadcrumbsOnRails::ControllerMixin
+  end
-The library is still under development and this README file might not be contain the latest changes.
-For the full documentation, development roadmap and more information please visit the {project page}[http://code.simonecarletti.com/wiki/breadonrails].
+A Rails 3 version will be available very soon.
-== Credits
+== Author
-Author:: {Simone Carletti}[http://www.simonecarletti.com] <weppos@weppos.net>
+* {Simone Carletti}[http://www.simonecarletti.com] <weppos@weppos.net>
 == Resources
-* {Homepage}[http://code.simonecarletti.com/breadonrails]
-* {GitHub}[http://github.com/weppos/breadcrumbs_on_rails]
+* {Homepage}[http://github.com/weppos/breadcrumbs_on_rails]
+* {Bugs & Features}[http://github.com/weppos/breadcrumbs_on_rails/issues]
 == License
-Copyright (c) 2009 Simone Carletti, BreadcrumbsOnRails is released under the MIT license.
+Copyright (c) 2009-2010 Simone Carletti, BreadcrumbsOnRails is released under the MIT license.

data/breadcrumbs_on_rails.gemspec CHANGED Viewed

@@ -2,20 +2,20 @@
 Gem::Specification.new do |s|
   s.name = %q{breadcrumbs_on_rails}
-  s.version = "0.2.0"
+  s.version = "1.0.1"
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Simone Carletti"]
-  s.date = %q{2009-11-27}
+  s.date = %q{2010-05-09}
   s.description = %q{    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.
 }
   s.email = %q{weppos@weppos.net}
-  s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/breadcrumbs_on_rails/breadcrumbs.rb", "lib/breadcrumbs_on_rails/controller_mixin.rb", "lib/breadcrumbs_on_rails/version.rb", "lib/breadcrumbs_on_rails.rb", "LICENSE.rdoc", "README.rdoc", "tasks/tabs_on_rails_tasks.rake"]
-  s.files = ["CHANGELOG.rdoc", "init.rb", "install.rb", "lib/breadcrumbs_on_rails/breadcrumbs.rb", "lib/breadcrumbs_on_rails/controller_mixin.rb", "lib/breadcrumbs_on_rails/version.rb", "lib/breadcrumbs_on_rails.rb", "LICENSE.rdoc", "Manifest", "rails/init.rb", "Rakefile", "README.rdoc", "tasks/tabs_on_rails_tasks.rake", "test/breadcrumbs_on_rails_test.rb", "test/builder_test.rb", "test/element_test.rb", "test/simple_builder_test.rb", "test/test_helper.rb", "uninstall.rb", "breadcrumbs_on_rails.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "LICENSE.rdoc", "README.rdoc", "lib/breadcrumbs_on_rails.rb", "lib/breadcrumbs_on_rails/breadcrumbs.rb", "lib/breadcrumbs_on_rails/controller_mixin.rb", "lib/breadcrumbs_on_rails/version.rb"]
+  s.files = ["CHANGELOG.rdoc", "LICENSE.rdoc", "Manifest", "README.rdoc", "Rakefile", "init.rb", "lib/breadcrumbs_on_rails.rb", "lib/breadcrumbs_on_rails/breadcrumbs.rb", "lib/breadcrumbs_on_rails/controller_mixin.rb", "lib/breadcrumbs_on_rails/version.rb", "rails/init.rb", "test/breadcrumbs_on_rails_test.rb", "test/builder_test.rb", "test/element_test.rb", "test/simple_builder_test.rb", "test/test_helper.rb", "breadcrumbs_on_rails.gemspec"]
   s.homepage = %q{http://code.simonecarletti.com/breadonrails}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Breadcrumbs_on_rails", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{A simple Ruby on Rails plugin for creating and managing a breadcrumb navigation.}
   s.test_files = ["test/breadcrumbs_on_rails_test.rb", "test/builder_test.rb", "test/element_test.rb", "test/simple_builder_test.rb", "test/test_helper.rb"]

data/lib/breadcrumbs_on_rails.rb CHANGED Viewed

@@ -20,9 +20,9 @@ require 'breadcrumbs_on_rails/version'
 module BreadcrumbsOnRails
   NAME            = 'Breadcrumbs on Rails'
   GEM             = 'breadcrumbs_on_rails'
   AUTHORS         = ['Simone Carletti <weppos@weppos.net>']
-end
+end

data/lib/breadcrumbs_on_rails/controller_mixin.rb CHANGED Viewed

@@ -104,4 +104,4 @@ module BreadcrumbsOnRails
   end
-end
+end

data/lib/breadcrumbs_on_rails/version.rb CHANGED Viewed

@@ -17,12 +17,12 @@
 module BreadcrumbsOnRails
   module Version
-    MAJOR = 0
-    MINOR = 2
-    PATCH = 0
-    ALPHA = nil
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 1
+    BUILD = nil
-    STRING = [MAJOR, MINOR, PATCH, ALPHA].compact.join('.')
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
   end
   VERSION = Version::STRING

metadata CHANGED Viewed

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: breadcrumbs_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  prerelease: false
+  segments:
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors:
 - Simone Carletti
@@ -9,29 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-11-27 00:00:00 +01:00
+date: 2010-05-09 00:00:00 +02:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  type: :development
-  version_requirement:
-  version_requirements: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
+        segments:
+        - 0
+        - 8
+        - 7
         version: 0.8.7
-    version:
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency
   name: echoe
-  type: :development
-  version_requirement:
-  version_requirements: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
+        segments:
+        - 3
+        - 2
+        - 0
         version: 3.2.0
-    version:
+  type: :development
+  version_requirements: *id002
 description: "    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.\n"
 email: weppos@weppos.net
 executables: []
@@ -40,33 +53,29 @@ extensions: []
 extra_rdoc_files:
 - CHANGELOG.rdoc
+- LICENSE.rdoc
+- README.rdoc
+- lib/breadcrumbs_on_rails.rb
 - lib/breadcrumbs_on_rails/breadcrumbs.rb
 - lib/breadcrumbs_on_rails/controller_mixin.rb
 - lib/breadcrumbs_on_rails/version.rb
-- lib/breadcrumbs_on_rails.rb
-- LICENSE.rdoc
-- README.rdoc
-- tasks/tabs_on_rails_tasks.rake
 files:
 - CHANGELOG.rdoc
+- LICENSE.rdoc
+- Manifest
+- README.rdoc
+- Rakefile
 - init.rb
-- install.rb
+- lib/breadcrumbs_on_rails.rb
 - lib/breadcrumbs_on_rails/breadcrumbs.rb
 - lib/breadcrumbs_on_rails/controller_mixin.rb
 - lib/breadcrumbs_on_rails/version.rb
-- lib/breadcrumbs_on_rails.rb
-- LICENSE.rdoc
-- Manifest
 - rails/init.rb
-- Rakefile
-- README.rdoc
-- tasks/tabs_on_rails_tasks.rake
 - test/breadcrumbs_on_rails_test.rb
 - test/builder_test.rb
 - test/element_test.rb
 - test/simple_builder_test.rb
 - test/test_helper.rb
-- uninstall.rb
 - breadcrumbs_on_rails.gemspec
 has_rdoc: true
 homepage: http://code.simonecarletti.com/breadonrails
@@ -86,18 +95,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
+      segments:
+      - 0
       version: "0"
-  version:
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
+      segments:
+      - 1
+      - 2
       version: "1.2"
-  version:
 requirements: []
 rubyforge_project:
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key:
 specification_version: 3
 summary: A simple Ruby on Rails plugin for creating and managing a breadcrumb navigation.

data/install.rb DELETED Viewed

	@@ -1 +0,0 @@
1	- # Install hook code here

data/tasks/tabs_on_rails_tasks.rake DELETED Viewed

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :breadcrumbs_on_rails do
-#   # Task goes here
-# end

data/uninstall.rb DELETED Viewed

	@@ -1 +0,0 @@
1	- # Uninstall hook code here