loaf 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f544810445fa9db426eb9d433df6bf0bd700d91a1f277f00ac22799805adced3
-  data.tar.gz: 0aa946e6a0f5ea4beb5eee018d9953ff2246d2da603b386627b4e36fe2d7f059
+  metadata.gz: 194d167e400d76180e87b1d93637c9c3cf59048dbe03ea32c416d48236778e15
+  data.tar.gz: 7f5c9f0d0c5f92e541b282a281327ccd327f057b844d9970e8a086ee05b735d6
 SHA512:
-  metadata.gz: db053ea3b9a1cb1681fad9370a2d2174fe249b5602367aab6d04ea3c7c04ebf9bb8b0bedef5a1326374c96c76c2c0d5593f62aba7273c00f981297f794934415
-  data.tar.gz: 4f3e32da25d4cd0b3abac19b82133769d7b25c61778ac476d0ae06ace6be2ee219526416ff398d917653d7762505eab1a467d1b1aeded3d3c1b90f362749f2e6
+  metadata.gz: 30f9a6c9eb2e4ca2513d1ec3c95dff3038a10d4fd55f12391a9dac5568ad34eef28c23f3ef22a2fe8f810e954674a759e1537255929e18fe117dba550a644b0c
+  data.tar.gz: 47ea3af5b670ae2d02ecddae7a71d70a96206487f93ef415853d18a222dc2b63729d485743bd0d2249965fd6918150facfe80b4626c0c662f45f1d302af0004c

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # 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
@@ -131,6 +142,7 @@
 
 * Initial implementation and release
 
+[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

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,17 +1,17 @@
 <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]
 [![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
 [coveralls]: https://coveralls.io/github/piotrmurach/loaf
 [inchpages]: http://inch-ci.org/github/piotrmurach/loaf
@@ -31,7 +31,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'loaf'
+gem "loaf"
 ```
 
 And then execute:
@@ -73,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)
@@ -94,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`:
@@ -112,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
@@ -121,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
 ```
 
@@ -129,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
 ```
 
@@ -137,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
 ```
@@ -155,11 +155,11 @@ class CommentsController < ApplicationController
 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', -> { post_comments_path(params[:post_id]) }
+  breadcrumb "All Comments", -> { post_comments_path(params[:post_id]) }
 end
 ```
 
@@ -191,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|
@@ -217,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
@@ -230,43 +232,58 @@ 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 %>
   </ol>
 </nav>
 ```
+
 For Bootstrap 4:
 
 ```erb
 <% #erb %>
 <nav aria-label="breadcrumb">
-  <ol class='breadcrumb'>
+  <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:
+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'} : {})
+      %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.
 
+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:

data/lib/loaf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Loaf
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end # Loaf

data/lib/loaf/view_extensions.rb

@@ -45,14 +45,14 @@ module Loaf
     #
     # @api public
     def breadcrumb_trail(options = {})
-      return enum_for(:breadcrumb_trail) unless block_given?
+      return enum_for(:breadcrumb_trail, options) unless block_given?
 
       valid?(options)
-      options = Loaf.configuration.to_hash.merge(options)
+
       _breadcrumbs.each do |crumb|
         name = title_for(crumb.name)
         path = url_for(_expand_url(crumb.url))
-        current = current_crumb?(path, crumb.match)
+        current = current_crumb?(path, options.fetch(:match) { crumb.match })
 
         yield(Loaf::Breadcrumb[name, path, current])
       end
@@ -68,10 +68,10 @@ module Loaf
     def current_crumb?(path, pattern = :inclusive)
       return false unless request.get? || request.head?
 
-      origin_path = URI.parser.unescape(path).force_encoding(Encoding::BINARY)
+      origin_path = URI::DEFAULT_PARSER.unescape(path).force_encoding(Encoding::BINARY)
 
       request_uri = request.fullpath
-      request_uri = URI.parser.unescape(request_uri)
+      request_uri = URI::DEFAULT_PARSER.unescape(request_uri)
       request_uri.force_encoding(Encoding::BINARY)
 
       # strip away trailing slash

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: loaf
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-19 00:00:00.000000000 Z
+date: 2020-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +47,8 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt