breadcrumbs_on_rails 2.3.0 → 4.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d3c25bc4d93a1dfdc12e5799934b535c6d4744f147343ace66f097fdd47fad3
+  data.tar.gz: 88ab7e1a451f3d272964e463ad6bb5e30ecdf133f00fa50143f18db1876433ad
+SHA512:
+  metadata.gz: e5db1d12f40c3b2e737f99efb071dc96a1c07868f8f6e0116cac647102c142d7b21fc58a426e90198010843cb7b638bc7731a819f75d6b9a0ce5bd5fa22319a2
+  data.tar.gz: 10121bc98e524b146e1de35658fd0076f39f581919c475cb11916248a6c38dead2bbf8ab259e48ff65eb7f50484661bc5b4c97316857fe451437effe86424c6d

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: "rubygems/breadcrumbs_on_rails"
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.gitignore

@@ -1,8 +1,11 @@
 # Bundler
-.bundle
-pkg/*
-Gemfile.lock
+/.bundle
+/Gemfile.lock
+/gemfiles/*.gemfile.lock
+/pkg/*
 
 # YARD
-.yardoc
-yardoc/
+/.yardoc
+/yardoc/
+
+/.tool-versions

data/.travis.yml

@@ -1,12 +1,31 @@
+language: ruby
+
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - ree
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
+
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
+cache:
+  - bundler
+
 gemfile:
-  - gemfiles/3.0.gemfile
-  - gemfiles/3.1.gemfile
-  - gemfiles/3.2.gemfile
-notifications:
-  recipients:
-    - weppos@weppos.net
+  - gemfiles/5.0.gemfile
+  - gemfiles/5.1.gemfile
+  - gemfiles/5.2.gemfile
+  - gemfiles/6.0.gemfile
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  exclude:
+    - rvm: 2.4
+      gemfile: gemfiles/6.0.gemfile
+
+before_install:
+  - gem install bundler -v 1.17.3

data/Appraisals

@@ -1,11 +1,12 @@
-appraise "3.0" do
-  gem "activerecord", "~> 3.0"
+appraise "5.0" do
+  gem "rails", "~> 5.0.0"
 end
-
-appraise "3.1" do
-  gem "activerecord", "~> 3.1"
+appraise "5.1" do
+  gem "rails", "~> 5.1.0"
+end
+appraise "5.2" do
+  gem "rails", "~> 5.2.0"
+end
+appraise "6.0" do
+  gem "rails", "~> 6.0.0"
 end
-
-appraise "3.2" do
-  gem "activerecord", "~> 3.2"
-end

data/CHANGELOG.md

@@ -1,62 +1,100 @@
 # Changelog
 
+## Release 4.1.0
+
+### Changed
+
+- Swapped dependency on "rails" to "railties" (GH-135)
+
+## Release 4.0.0
+
+### Changed
+
+- Minimum requirements Rails >= 5
+
+### Enhancements
+
+- Prefixed shared helpers to reduce collision probability (GH-65, GH-129). [Thanks @justame, @ngelx]
+
+
+## Release 3.0.1
+
+### Fixed
+
+- Fixed compatibility with Rails 5.0 and ActionController::API (GH-99). [Thanks @jcoyne]
 
-## Release 2.3.0
 
-* FIXED: In some circumstances the BreadcrumbsOnRails::ActionController::HelperMethods is not mixed into the controller.
+## Release 3.0.0
 
-* FIXED: Breadcrumbs now accepts a polymorphic path (GH-15).
+### Fixed
 
-* CHANGED: Second argument on `add_breadcrumb` is now optional (GH-6, GH-32). [Thanks @mpartel]
+- Fixed compatibility with Rails 5.0 (GH-80). [Thanks @ochko]
+- Fixed initialization error (GH-75). [Thanks @soulcutter]
+- Escape user input by default to avoid XSS attacks (GH-63). [Thanks @rdunlop]
 
-* CHANGED: Breadcrumb path computation fallbacks to url_for in case of unknown arguments.
+### Changed
+
+- Minimum requirements Rails >= 4 and Ruby >= 2.
+
+
+## Release 2.3.1
+
+- FIXED: Using `add_breadcrumbs` did not properly pass `options` (GH-46). [Thanks @link664]
+
+
+## Release 2.3.0
+
+- FIXED: In some circumstances the BreadcrumbsOnRails::ActionController::HelperMethods is not mixed into the controller.
+- FIXED: Breadcrumbs now accepts a polymorphic path (GH-15).
+
+- CHANGED: Second argument on `add_breadcrumb` is now optional (GH-6, GH-32). [Thanks @mpartel]
+- CHANGED: Breadcrumb path computation fallbacks to url_for in case of unknown arguments.
 
 
 ## Release 2.2.0
 
-* NEW: Support for Rails 3.2.
+- NEW: Support for Rails 3.2.
 
-* FIXED: Fixed Rails 3.2 ActiveSupport::Concern deprecation warning (GH-17, GH-20).
+- FIXED: Fixed Rails 3.2 ActiveSupport::Concern deprecation warning (GH-17, GH-20).
 
 
 ## Release 2.1.0
 
-* NEW: Element now accepts a Hash of options. The options can be useful to customize the appearance of the element, for example to set a link title or class.
+- NEW: Element now accepts a Hash of options. The options can be useful to customize the appearance of the element, for example to set a link title or class.
 
 
 ## Release 2.0.0
 
-* FIXED: Invalid documentation for Element target in the controller class context (closes #2)
+- FIXED: Invalid documentation for Element target in the controller class context (closes #2)
 
-* CHANGED: Upgraded to Rails 3
+- CHANGED: Upgraded to Rails 3
 
 
 ## Release 1.0.1
 
-* FIXED: Since the removal of rails/init.rb in 7278376ab77651e540e39552384ad9677e32ff7e, Rails fails to load the helpers.
+- 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.
+- 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.
+- Releasing the library as open source project.
 
-## Release 0.1.1
 
+## Release 0.1.1
 
-* ADDED: documentation file.
 
-* CHANGED: run test against Rails ~> 2.3.0 but ensure compatibility with Rails 2.2.x.
+- NEW: documentation file.
 
-* CHANGED: Removed BUILD and STATUS constants. Added Version::ALPHA constant to be used when I need to package prereleases (see RubyGem --prerelease flag).
+- CHANGED: run test against Rails ~> 2.3.0 but ensure compatibility with Rails 2.2.x.
+- CHANGED: Removed BUILD and STATUS constants. Added Version::ALPHA constant to be used when I need to package prereleases (see RubyGem --prerelease flag).
 
 
 ## Release 0.1.0
 
-* Initial version
+- Initial version

data/Gemfile

@@ -1,3 +1,11 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
+
+gem "rake"
+gem "bundler"
+
+gem "appraisal"
+gem "rails", ">= 5.0"
+gem "mocha", ">= 1.0"
+gem "yard"

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2012 Simone Carletti <weppos@weppos.net>
+Copyright (c) 2009-2020 Simone Carletti <weppos@weppos.net>
 
 MIT License
 

data/README.md

@@ -1,99 +1,285 @@
 # 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.
+<tt>BreadcrumbsOnRails</tt> 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.
 
+[![Build Status](https://travis-ci.com/weppos/breadcrumbs_on_rails.svg?branch=master)](https://travis-ci.com/weppos/breadcrumbs_on_rails)
+[![Tidelift dependencies](https://tidelift.com/badges/package/rubygems/breadcrumbs_on_rails)](https://tidelift.com/subscription/pkg/rubygems-breadcrumbs.on.rails?utm_source=rubygems-breadcrumbs-on-rails&utm_medium=referral&utm_campaign=enterprise)
+
+
+## Links
+
+- [Homepage](https://simonecarletti.com/code/breadcrumbs-on-rails)
+- [Repository](https://github.com/weppos/breadcrumbs_on_rails)
+- [API Documentation](https://rubydoc.info/gems/breadcrumbs_on_rails)
 
-## Requirements
 
-* Rails 3
+## Requirements
 
-Please note 
+- Ruby >= 2.4
+- Rails >= 5
 
-* BreadcrumbsOnRails 2.x requires Rails 3. Use BreadcrumbsOnRails 1.x with Rails 2.
-* BreadcrumbsOnRails doesn't work with Rails 2.1 or lower.
+For older versions use a previous release.
 
 
 ## Installation
 
-[RubyGems](http://rubygems.org) is the preferred way to install *BreadcrumbsOnRails* and the best way if you want install a stable version.
+Add this line to your application's `Gemfile`:
 
-    $ gem install breadcrumbs_on_rails
+```
+gem "breadcrumbs_on_rails"
+```
 
-Specify the Gem dependency in the [Bundler](http://gembundler.com) `Gemfile`.
+And then execute `bundle` to install the dependencies:
 
-    gem "breadcrumbs_on_rails"
+```
+bundle
+```
 
-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.
+Use [Bundler](http://bundler.io/) and the `:git` option if you want to grab the latest version from the Git repository.
 
 
-## Basic Usage
+## Usage
 
-Creating a breadcrumb navigation menu in your Rails app using *BreadcrumbsOnRails* is really straightforward.
+Creating a breadcrumb navigation menu in your Rails app using <tt>BreadcrumbsOnRails</tt> is really straightforward.
 
 In your controller, call `add_breadcrumb` to push a new element on the breadcrumb stack. `add_breadcrumb` requires two arguments: the name of the breadcrumb and the target path.
 
-    class MyController
-    
-      add_breadcrumb "home", :root_path
-      add_breadcrumb "my", :my_path
-      
-      def index
-        # ...
-        
-        add_breadcrumb "index", index_path
-      end
-    
-    end
+```ruby
+class MyController
+
+  add_breadcrumb "home", :root_path
+  add_breadcrumb "my", :my_path
+
+  def index
+    # ...
+
+    add_breadcrumb "index", index_path
+  end
+
+end
+```
+
+See the section "Breadcrumb Element" for more details about name and target class types.
 
 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
+```ruby
+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 `render_breadcrumbs` 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>
+```html
+<!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>
+```
 
 `render_breadcrumbs` understands a limited set of options. For example, you can pass change the default separator with the `:separator` option.
 
-    <body>
-      <%= render_breadcrumbs :separator => ' / ' %>
-    </body>
+```html
+<body>
+  <%= render_breadcrumbs :separator => ' / ' %>
+</body>
+```
+
+Current possible options are:
+
+- `:separator`
+- `:tag`
+
+To use with Bootstrap you might use the following:
+
+```html
+<body>
+  <ol class="breadcrumb">
+    <%= render_breadcrumbs :tag => :li, :separator => "" %>
+  </ol>
+</body>
+```
+
+More complex customizations require a custom `Builder`.
+
+### HTML Escaping
+
+The text of the breadcrumb is html-escaped by default unless it is a SafeBuffer, to prevent XSS attacks.
+
+```ruby
+class MyController
+  add_breadcrumb "This is the <b>Main</b> page".html_safe
+
+  def profile
+    add_breadcrumb "#{@user_name} Profile", users_profile
+  end
+end
+```
+
+In this case, if `@user_name` is `<script>`, it will output:
+
+```
+This is the <b>Main</b> page > &lt;script&gt; Profile
+```
+
+
+### Breadcrumb Element
+
+A breadcrumbs menu is composed by a number of `Element` objects. Each object contains two attributes: the name of the breadcrumb and the target path.
+
+When you call `add_breadcrumb`, the method automatically creates a new `Element` object for you and append it to the breadcrumbs stack. `Element` 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 `Element` attribute to the returned value.
+
+```ruby
+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 `Element` 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.
+
+```ruby
+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 `Element` attribute to the string value.
+
+```ruby
+class MyController
+
+  # The Name is set to the value returned by
+  # the :root_name method.
+  add_breadcrumb "homepage", "/"
+
+end
+```
+
+### Restricting breadcrumb scope
+
+The `add_breadcrumb` method understands all options you are used to pass to a Rails controller filter. In fact, behind the scenes this method uses a `before_filter` to store the tab in the `@breadcrumbs` variable.
+
+Taking advantage of Rails filter options, you can restrict a tab to a selected group of actions in the same controller.
+
+```ruby
+class PostsController < ApplicationController
+  add_breadcrumb "admin", :admin_path
+  add_breadcrumb "posts", :posts_path, only: [: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
+```
 
-More complex customizations require a custom Builder.
+### Internationalization and Localization
 
-Read the [documentation](http://www.simonecarletti.com/code/breadcrumbs_on_rails/docs/) to learn more about advanced usage and builders.
+<tt>BreadcrumbsOnRails</tt> 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.
+
+```yaml
+# 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 `I18n.t` method.
+
+```ruby
+class PostsController < ApplicationController
+  add_breadcrumb I18n.t("breadcrumbs.first"),  :first_path
+  add_breadcrumb I18n.t("breadcrumbs.second"), :second_path, only: [:second]
+  add_breadcrumb I18n.t("breadcrumbs.third"),  :third_path,  only: [:third]
+end
+
+class ApplicationController < ActionController::Base
+  add_breadcrumb I18n.t("breadcrumbs.homepage"), :root_path
+end
+```
+
+
+## Support
+
+Library documentation is auto-generated from the [README](https://github.com/weppos/breadcrumbs_on_rails/blob/master/README.md) and the source code, and it's available at https://rubydoc.info/gems/breadcrumbs_on_rails.
+
+- The bug tracker is here: https://github.com/weppos/breadcrumbs_on_rails/issues
+- The code repository is here: https://github.com/weppos/breadcrumbs_on_rails. Contributions are welcome! Please include tests and/or feature coverage for every patch, and create a topic branch for every separate change you make.
+
+**Commercial support available as part of the Tidelift Subscription** - [Learn more](https://tidelift.com/subscription/pkg/rubygems-breadcrumbs.on.rails?utm_source=rubygems-breadcrumbs-on-rails&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
+
+The maintainers of breadcrumbs_on_rails and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Consider subscribing to Tidelift which provides Enterprise support for this project.](https://tidelift.com/subscription/pkg/rubygems-breadcrumbs.on.rails?utm_source=rubygems-breadcrumbs-on-rails&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
 
 
 ## Credits
 
-* [Simone Carletti](http://www.simonecarletti.com/) <weppos@weppos.net> - The Author
+<tt>BreadcrumbsOnRails</tt> was created and is maintained by [Simone Carletti](http://simonecarletti.com/). Many improvements and bugfixes were contributed by the [open source community](https://github.com/weppos/breadcrumbs_on_rails/graphs/contributors).
+
+
+## Security and Vulnerability Reporting
+
+Full information and description of our security policy please visit [SECURITY.md](SECURITY.md)
 
 
-## Resources
+## Changelog
 
-* [Homepage](http://www.simonecarletti.com/code/breadcrumbs_on_rails)
-* [Documentation](http://www.simonecarletti.com/code/breadcrumbs_on_rails/docs/)
-* [API](http://rubydoc.info/gems/breadcrumbs_on_rails)
-* [Repository](https://github.com/weppos/breadcrumbs_on_rails)
-* [Issue Tracker](http://github.com/weppos/breadcrumbs_on_rails/issues)
+See the [CHANGELOG.md](CHANGELOG.md) file for details.
 
 
 ## License
 
-*BreadcrumbsOnRails* is Copyright (c) 2009-2012 Simone Carletti. This is Free Software distributed under the MIT license.
+Copyright (c) 2009-2020 Simone Carletti. This is Free Software distributed under the MIT license.