loaf 0.6.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ff7903e3c4af9741df52746a183ab5ce64be0390
-  data.tar.gz: 2b2361cb571bc40e83dbaf37a58982a0fdcb8903
+SHA256:
+  metadata.gz: 194d167e400d76180e87b1d93637c9c3cf59048dbe03ea32c416d48236778e15
+  data.tar.gz: 7f5c9f0d0c5f92e541b282a281327ccd327f057b844d9970e8a086ee05b735d6
 SHA512:
-  metadata.gz: 6649ee9688af545490a3697cf277423b9f9db9b2fb35ebfde2655970fc8ea41fbfe027ee0925a8fa75b3e41b636e3f1f02a4e4f688478793657bb110f3033c0d
-  data.tar.gz: 4cdc8efd1ff9f7eac3adfbbdaadd6e5ac1ef9496680d55de424ab3b73f06080b84b1b2329b5bebf8bb736d5f65578c74fd3f54ce23009982437526aa23875283
+  metadata.gz: 30f9a6c9eb2e4ca2513d1ec3c95dff3038a10d4fd55f12391a9dac5568ad34eef28c23f3ef22a2fe8f810e954674a759e1537255929e18fe117dba550a644b0c
+  data.tar.gz: 47ea3af5b670ae2d02ecddae7a71d70a96206487f93ef415853d18a222dc2b63729d485743bd0d2249965fd6918150facfe80b4626c0c662f45f1d302af0004c

data/CHANGELOG.md

@@ -1,5 +1,55 @@
 # Change log
 
+## [v0.10.0] - 2020-11-21
+
+### Changed
+* Reduce gem dependencies to `railties` by Christian Sutter (@csutter)
+* Use `URI::DEFAULT_PARSER` instead of deprecated `URI.parser` by (@dsazup)
+* Support Rails 6.1 in tests
+
+### Fixed
+* Fix #breadcrumb_trail to allow overriding the match option
+* Fix #breadcrumb_trail to return enumerator that includes passed in match option
+
+## [v0.9.0] - 2020-01-19
+
+### Changed
+* Change gemspec to include metadata, license info and remove test artifacts
+* Change to update testing to include Ruby 2.7
+* Change to limit Ruby to 1.9.3 or greater
+
+### Fixed
+* Fix Ruby 2.7 warnings
+
+## [v0.8.1] - 2019-02-04
+
+### Added
+* Add console binary
+
+### Changed
+* Remove rake & appraisal binaries
+* Change setup binary to load correct env
+* Change gemspec to load files directly in without using git
+
+## [v0.8.0] - 2018-08-07
+
+### Changed
+* Change Translation to skip translating nil and empty string
+* Change view extension to only lookup breadcrumb name translation
+* Remove Configuration #crumb_length and #capitalize options
+* Remove CrumbFormatter to skip truncating and formatting crumb names
+
+## Fix
+* Fix issue with breadcrumb names being modified
+
+## [v0.7.0] - 2018-06-20
+
+### Added
+* Add test setup for Rails 5.2 by Brendon Muir(@brendon)
+
+### Changed
+* Change controller level #breadcrumb helper to accept Proc as name without controller parameter by Brendon Muir(@brendon)
+
 ## [v0.6.2] - 2018-03-30
 
 ### Added
@@ -59,7 +109,7 @@
 ### Fixed
 * Fix bug with url parameter to allow for regular rails path variables
 
-## [0.3.0] - 2012-02-25
+## [v0.3.0] - 2012-02-25
 
 ### Added
 * Add loaf gem errors
@@ -70,13 +120,13 @@
 * Renamed main gem helpers for adding breadcrumbs from `add_breadcrumb` to
   `breadcrumb`, both inside controllers and views.
 
-## [0.2.1] - 2012-02-22
+## [v0.2.1] - 2012-02-22
 
 ### Added
 * Add more integration tests and fixed bug with adding breadcrumbs inside view
 * Add specs for controller extensions
 
-## [0.2.0] - 2012-02-18
+## [v0.2.0] - 2012-02-18
 
 ### Added
 * Add integration tests for breadcrumbs view rendering
@@ -92,12 +142,17 @@
 
 * Initial implementation and release
 
-[v0.6.2]: https://github.com/piotrmurach/tty-spinner/compare/v0.6.1...v0.6.2
-[v0.6.1]: https://github.com/piotrmurach/tty-spinner/compare/v0.6.0...v0.6.1
-[v0.6.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.5.0...v0.6.0
-[v0.5.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.4.0...v0.5.0
-[v0.4.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.3.0...v0.4.0
-[v0.3.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.2.1...v0.3.0
-[v0.2.1]: https://github.com/piotrmurach/tty-spinner/compare/v0.2.0...v0.2.1
-[v0.2.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.1.0...v0.2.0
-[v0.1.0]: https://github.com/piotrmurach/tty-spinner/compare/v0.1.0...HEAD
+[v0.10.0]: https://github.com/piotrmurach/loaf/compare/v0.9.0...v0.10.0
+[v0.9.0]: https://github.com/piotrmurach/loaf/compare/v0.8.1...v0.9.0
+[v0.8.1]: https://github.com/piotrmurach/loaf/compare/v0.8.0...v0.8.1
+[v0.8.0]: https://github.com/piotrmurach/loaf/compare/v0.7.0...v0.8.0
+[v0.7.0]: https://github.com/piotrmurach/loaf/compare/v0.6.2...v0.7.0
+[v0.6.2]: https://github.com/piotrmurach/loaf/compare/v0.6.1...v0.6.2
+[v0.6.1]: https://github.com/piotrmurach/loaf/compare/v0.6.0...v0.6.1
+[v0.6.0]: https://github.com/piotrmurach/loaf/compare/v0.5.0...v0.6.0
+[v0.5.0]: https://github.com/piotrmurach/loaf/compare/v0.4.0...v0.5.0
+[v0.4.0]: https://github.com/piotrmurach/loaf/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://github.com/piotrmurach/loaf/compare/v0.2.1...v0.3.0
+[v0.2.1]: https://github.com/piotrmurach/loaf/compare/v0.2.0...v0.2.1
+[v0.2.0]: https://github.com/piotrmurach/loaf/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/piotrmurach/loaf/compare/v0.1.0...HEAD

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Piotr Murach
+Copyright (c) 2011 Piotr Murach (https://piotrmurach.com)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,20 +1,18 @@
 <div align="center">
-  <img width="237" src="https://cdn.rawgit.com/piotrmurach/loaf/master/assets/loaf_logo.png" alt="loaf logo" />
+  <img width="237" src="https://github.com/piotrmurach/loaf/blob/master/assets/loaf_logo.png" alt="Loaf gem logo" />
 </div>
 
 # Loaf
 
 [![Gem Version](https://badge.fury.io/rb/loaf.svg)][gem]
-[![Build Status](https://secure.travis-ci.org/piotrmurach/loaf.svg?branch=master)][travis]
+[![Actions CI](https://github.com/piotrmurach/loaf/workflows/CI/badge.svg?branch=master)][gh_actions_ci]
 [![Maintainability](https://api.codeclimate.com/v1/badges/966193dafa3895766977/maintainability)][codeclimate]
-[![Dependency Status](https://gemnasium.com/piotrmurach/loaf.svg?travis)][gemnasium]
 [![Coverage Status](https://coveralls.io/repos/github/piotrmurach/loaf/badge.svg?branch=master)][coveralls]
 [![Inline docs](http://inch-ci.org/github/piotrmurach/loaf.svg?branch=master)][inchpages]
 
 [gem]: http://badge.fury.io/rb/loaf
-[travis]: http://travis-ci.org/piotrmurach/loaf
+[gh_actions_ci]: https://github.com/piotrmurach/loaf/actions?query=workflow%3ACI
 [codeclimate]: https://codeclimate.com/github/piotrmurach/loaf/maintainability
-[gemnasium]: https://gemnasium.com/piotrmurach/loaf
 [coveralls]: https://coveralls.io/github/piotrmurach/loaf
 [inchpages]: http://inch-ci.org/github/piotrmurach/loaf
 
@@ -33,7 +31,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'loaf'
+gem "loaf"
 ```
 
 And then execute:
@@ -75,7 +73,7 @@ In order to add breadcrumbs in controller use `breadcrumb` method ([see 2.1](#21
 ```ruby
 class Blog::CategoriesController < ApplicationController
 
-  breadcrumb 'Article Categories', :blog_categories_path, only: [:show]
+  breadcrumb "Article Categories", :blog_categories_path, only: [:show]
 
   def show
     breadcrumb @category.title, blog_category_path(@category)
@@ -96,7 +94,7 @@ The `breadcrumb` method takes at minimum two arguments: the first is a name for
 When using path variable `blog_categories_path`:
 
 ```ruby
-breadcrumb 'Categories', blog_categories_path
+breadcrumb "Categories", blog_categories_path
 ```
 
 When using an instance `@category`:
@@ -114,7 +112,7 @@ breadcrumb @category.title, [:blog, @category]
 You can specify segments of the url:
 
 ```ruby
-breadcrumb @category.title, {controller: 'categories', action: 'show', id: @category.id}
+breadcrumb @category.title, {controller: "categories", action: "show", id: @category.id}
 ```
 
 #### 2.1.1 controller
@@ -123,7 +121,7 @@ Breadcrumbs are inherited, so if you set a breadcrumb in `ApplicationController`
 
 ```ruby
 class ApplicationController < ActionController::Base
-  breadcrumb 'Home', :root_path
+  breadcrumb "Home", :root_path
 end
 ```
 
@@ -131,7 +129,7 @@ Outside of controller actions the `breadcrumb` helper behaviour is similar to fi
 
 ```ruby
 class ArticlesController < ApplicationController
-  breadcrumb 'All Articles', :articles_path, only: [:new, :create]
+  breadcrumb "All Articles", :articles_path, only: [:new, :create]
 end
 ```
 
@@ -139,12 +137,12 @@ Each time you call the `breadcrumb` helper, a new element is added to a breadcru
 
 ```ruby
 class ArticlesController < ApplicationController
-  breadcrumb 'Home', :root_path
-  breadcrumb 'All Articles', :articles_path
+  breadcrumb "Home", :root_path
+  breadcrumb "All Articles", :articles_path
 
   def show
-    breadcrumb 'Article One', article_path(:one)
-    breadcrumb 'Article Two', article_path(:two)
+    breadcrumb "Article One", article_path(:one)
+    breadcrumb "Article Two", article_path(:two)
   end
 end
 ```
@@ -153,18 +151,30 @@ end
 
 ```ruby
 class CommentsController < ApplicationController
-  breadcrumb ->(c) { c.find_article(c.params[:post_id]).title }, :articles_path
+  breadcrumb -> { find_article(params[:post_id]).title }, :articles_path
 end
 ```
 
-Also, to dynamically evalute parameters inside the url argument do:
+Also, to dynamically evaluate parameters inside the url argument do:
 
 ```ruby
 class CommentsController < ApplicationController
-  breadcrumb 'All Comments', ->(c) { c.post_comments_path(c.params[:post_id]) }
+  breadcrumb "All Comments", -> { post_comments_path(params[:post_id]) }
 end
 ```
 
+You may wish to define breadcrumbs over a collection. This is easy within views, and controller actions (just loop your collection), but if you want to do this in the controller class you can use the `before_action` approach:
+
+```ruby
+before_action do
+  ancestors.each do |ancestor|
+    breadcrumb ancestor.name, [:admin, ancestor]
+  end
+end
+```
+
+Assume `ancestors` method is defined inside the controller.
+
 #### 2.1.2 view
 
 **Loaf** adds `breadcrumb` helper also to the views. Together with controller breadcrumbs, the view breadcrumbs are appended as the last in breadcrumb trail. For instance, to specify view breadcrumb do:
@@ -181,25 +191,27 @@ The `:match` key accepts the following values:
 
 * `:inclusive` - the default value, which matches nested paths
 * `:exact` - matches only the exact same path
-* `:exclusive` - matches only direct path and its query params if present
+* `:exclusive` - matches only direct path and its query parameters if present
 * `/regex/` - matches based on regular expression
-* `{foo: bar}` - match based on query params
+* `{foo: bar}` - match based on query parameters
 
 For example, to force a breadcrumb to be the current regardless do:
 
 ```ruby
-breadcrumb 'New Post', new_post_path, match: :exact
+breadcrumb "New Post", new_post_path, match: :exact
 ```
 
-To make a breadcrumb current based on the query params do:
+To make a breadcrumb current based on the query parameters do:
 
 ```ruby
-breadcrumb 'Posts', posts_path(order: :desc), match: {order: :desc}
+breadcrumb "Posts", posts_path(order: :desc), match: {order: :desc}
 ```
 
 ### 2.2 breadcrumb_trail
 
-In order to display breadcrumbs use the `breadcrumb_trail` view helper which as an argument accepts options and yields all breadcrumbs to a block:
+In order to display breadcrumbs use the `breadcrumb_trail` view helper. It accepts optional argument of configuration options and can be used in two ways.
+
+One way, given a block it will yield all the breadcrumbs in order of definition:
 
 ```ruby
 breadcrumb_trail do |crumb|
@@ -207,7 +219,7 @@ breadcrumb_trail do |crumb|
 end
 ```
 
-The yielded pararmeter is a `Loaf::Crumb` object that provides the following methods:
+The yielded parameter is an instance of `Loaf::Crumb` object with the following methods:
 
 ```ruby
 crumb.name     # => the name as string
@@ -220,10 +232,10 @@ For example, you can add the following semantic markup to show breadcrumbs using
 
 ```erb
 <nav aria-label="breadcrumb">
-  <ol class='breadcrumbs'>
+  <ol class="breadcrumbs">
     <% breadcrumb_trail do |crumb| %>
-      <li class="<%= crumb.current? ? 'current' : '' %>">
-        <%= link_to crumb.name, crumb.url, (crumb.current? ? {'aria-current' => 'page'} : {}) %>
+      <li class="<%= crumb.current? ? "current" : "" %>">
+        <%= link_to crumb.name, crumb.url, (crumb.current? ? {"aria-current" => "page"} : {}) %>
         <% unless crumb.current? %><span>::</span><% end %>
       </li>
     <% end %>
@@ -231,36 +243,59 @@ For example, you can add the following semantic markup to show breadcrumbs using
 </nav>
 ```
 
-For bootstrap,
+For Bootstrap 4:
+
 ```erb
+<% #erb %>
 <nav aria-label="breadcrumb">
-  <ol class='breadcrumbs'>
+  <ol class="breadcrumb">
     <% breadcrumb_trail do |crumb| %>
-      <li class="breadcrumb-item <%= crumb.current? ? 'active' : '' %>">
-        <%= link_to_unless crumb.current?, crumb.name, crumb.url, (crumb.current? ? {'aria-current' => 'page'} : {}) %>
+      <li class="breadcrumb-item <%= crumb.current? ? "active" : "" %>">
+        <%= link_to_unless crumb.current?, crumb.name, crumb.url, (crumb.current? ? {"aria-current" => "page"} : {}) %>
       </li>
     <% end %>
   </ol>
 </nav>
 ```
 
+And, if you are using `HAML` do:
+
+```haml
+  - # haml
+  %ol.breadcrumb
+    - breadcrumb_trail do |crumb|
+      %li.breadcrumb-item{class: crumb.current? ? "active" : "" }
+        = link_to_unless crumb.current?, crumb.name, crumb.url, (crumb.current? ? {"aria-current" => "page"} : {})
+```
+
+Usually best practice is to put such snippet inside its own `_breadcrumbs.html.erb` partial.
 
-Usually best practice is to put such snippet inside its own partial.
+The second way is to use the `breadcrumb_trail` without passing a block. In this case, the helper will return an enumerator that you can use to, for example, access an array of names pushed into the breadcrumb trail in order of addition. This can be handy for generating page titles from breadcrumb data.
+
+For example, you can define a `breadcrumbs_to_title` method in `ApplicationHelper` like so:
+
+```ruby
+module ApplicationHelper
+  def breadcrumbs_to_title
+    breadcrumb_trail.map(&:name).join(">")
+  end
+end
+```
+
+Use whichever of the two ways is more convenient given your application structure and needs.
 
 ## 3. Configuration
 
 There is a small set of custom opinionated defaults. The following options are valid parameters:
 
 ```ruby
-:capitalize    # set breadcrumbs to have initial letter uppercase, default false
-:crumb_length  # breadcrumb length in integer, default length is 30 characters
-:match         # set match type, default :inclusive
+:match # set match type, default :inclusive (see [:match](#213-match) for more details)
 ```
 
 You can override them in your views by passing them to the view `breadcrumb` helper
 
 ```erb
-<% breadcrumb_trail crumb_length: 20 do |name, url, styles| %>
+<% breadcrumb_trail(match: :exclusive) do |name, url, styles| %>
   ..
 <% end %>
 ```
@@ -269,7 +304,7 @@ or by configuring an option in `config/initializers/loaf.rb`:
 
 ```ruby
 Loaf.configure do |config|
-  config.crumb_length = 20
+  config.match = :exclusive
 end
 ```
 
@@ -306,6 +341,14 @@ en:
 
 Questions or problems? Please post them on the [issue tracker](https://github.com/piotrmurach/loaf/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests are passing by running `bundle` and `rake`.
 
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Loaf project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/loaf/blob/master/CODE_OF_CONDUCT.md).
+
 ## Copyright
 
-Copyright (c) 2011-2018 Piotr Murach. See LICENSE.txt for further details.
+Copyright (c) 2011 Piotr Murach. See LICENSE.txt for further details.

data/lib/loaf.rb

@@ -1,5 +1,6 @@
 require_relative 'loaf/configuration'
 require_relative 'loaf/railtie'
+require_relative 'loaf/version'
 
 module Loaf
   # Set global configuration

data/lib/loaf/configuration.rb

@@ -4,8 +4,6 @@ module Loaf
   class Configuration
     VALID_ATTRIBUTES = [
       :locales_path,
-      :crumb_length,
-      :capitalize,
       :match
     ].freeze
 
@@ -13,18 +11,8 @@ module Loaf
 
     DEFAULT_LOCALES_PATH = '/'
 
-    DEFAULT_STYLE_CLASSES = 'selected'
-
-    DEFAULT_CRUMB_LENGTH = 30
-
-    DEFAULT_LAST_CRUMB_LINKED = false
-
-    DEFAULT_CAPITALIZE = false
-
     DEFAULT_MATCH = :inclusive
 
-    DEFAULT_ROOT = true
-
     # Setup this configuration
     #
     # @api public

data/lib/loaf/controller_extensions.rb

@@ -38,12 +38,20 @@ module Loaf
         respond_to?(:before_action) ? :before_action : :before_filter
       end
 
+      # Convert breadcrumb name to string
+      #
+      # @return [String]
+      #
       # @api private
       def _normalize_name(name, instance)
         case name
         when NilClass
         when Proc
-          name.call(instance)
+          if name.arity == 1
+            instance.instance_exec(instance, &name)
+          else
+            instance.instance_exec(&name)
+          end
         else
           name
         end