gretel 3.0.7 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c41db63d201de11de1dbc6d9b9c2a172418ffa20
-  data.tar.gz: 48db9abfdc31f7900b0f32afdc9536fd2839efdf
+SHA256:
+  metadata.gz: 7c9acb3e1bababfdec129ddf28041956e1d9cedab4168612403bc45e6f6be2ce
+  data.tar.gz: 5d8a64b3af412616443a6f2fae688b3cff882cd4e39aebeb071c551a573fc2ca
 SHA512:
-  metadata.gz: aa877e11f8c2037c68f9f01c9722101161163747e017e7be78606b56e7504d2a6bcbc253bb97144ab77c0d5ccd70a81a4323fe82ee2f0d4bc2b5d32ba79e21bb
-  data.tar.gz: 4e6d5c1f40b484fe1ac448fda62654756b17efbc1bb7a262a69229571de91a86512104e9aeec70a0f655259e2ba61e2971fcd0fb8f17f0672c10a04bfae08182
+  metadata.gz: dfd59117fcad2e1459647cbf42bb52fb063fc49b49070ae5a8f7372b58f4f95317036597ca474f7c00fb17dcbd1809f9d503066495cd8d52d510342db6ad95a0
+  data.tar.gz: 4466f946506b36678860eb17b922243fbcd4bc848f6c8fcd93ebb588dae02df4f9a78c934aa884d9a1dedf586fbc721128591696f887bafa9c88372859eb2877

data/.gitignore

@@ -7,18 +7,22 @@ Gemfile.lock
 gemfiles/*.lock
 InstalledFiles
 _yardoc
-coverage
 doc/
 lib/bundler/man
 pkg
 rdoc
 spec/reports
-test/tmp
-test/version_tmp
+spec/tmp
+spec/version_tmp
 tmp
 log/*.log
-test/dummy/db/*.sqlite3
-test/dummy/log/*.log
-test/dummy/tmp/
-test/dummy/.sass-cache
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
 .DS_Store
+
+/coverage/index.html
+/coverage/assets
+/coverage/*.json
+/coverage/*.json.lock

data/.travis.yml

@@ -1,12 +1,14 @@
 language: ruby
+sudo: false
 rvm:
-  - 2.0.0
-  - 1.9.3
-gemfile:
-  - gemfiles/Gemfile-rails.3.2.x
-  - gemfiles/Gemfile-rails.4.0.x
-  - gemfiles/Gemfile-rails.4.1.x
+  - 2.7
+  - 2.6
+  - 2.5
+env:
+  - RAILS="~> '5.1.0'"
+  - RAILS="~> '5.2.0'"
+  - RAILS="~> '6.0.0'"
 before_script:
-  - "cd test/dummy; rake db:migrate; rake db:test:prepare; cd ../.."
+  - "cd spec/dummy; rake db:migrate; rake db:test:prepare; cd ../.."
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## Version 4.0.2
+* The return value of `breadcrumbs` is `html_safe` now (via #22)
+  * For the slim template engine users: You don't need to use `==` instead of `=` for `breadcrumbs`
+
+## Version 4.0.1
+* Replaces data-vocabulary markup as google doesn't support it and now uses schema.org markup (via #17)
+
+## Version 4.0.0
+* Support Bootstrap 4. See the `:style` option in the readme for more info
+* CSS class for fragment link or span is now customizable. See the `:fragment_class` option in the readme for more info
+* Drop support Ruby < 2.5
+* Drop support Rails < 5.1
+* Deprecated codes have been removed:
+  * `breadcrumbs` is no longer accept block, use `tap` instead
+  * `breadcrumbs` is no longer accept `style: :default`, use `style: :inline` instead
+  * `breadcrumbs` is no longer accept `:show_root_alone` option, use `:display_single_fragment` option instead
+
+## Version 3.0.9
+* Adds breadcrumbs option `link_current_to_request_path` to link the current breadcrumb to the request path(#28 via #29)
+* Fixes semantic breadcrumbs when the last item has no link (via #55)
+* Downgrades Rails dependency to 3.1 (via #56)
+* Fixes jRuby issue with `Rails::Application` constant (via #50)
+* Fixes deprecation warnings for `alias_method_chain` (via #66)
+* Updated coprights (via #63)
+
+## Version 3.0.8
+* Parent breadcrumbs can now also be inferred from models responding to `model_name`.
+
 ## Version 3.0.7
 * Pretext and posttext classes are now customizable with `<%= breadcrumbs pretext_class: "some-class" %>` and `<%= breadcrumbs posttext_class: "some-other-class" %>`.
 
@@ -42,4 +70,4 @@
 * No longer supports procs for link text or URL as this is unnecessary when you can pass arguments to the block anyway.
 * It now accepts multiple arguments for `crumb` and `parent` (see the readme).
 * Breadcrumbs are now rendered with `<%= breadcrumbs %>`, although you can still use the old `<%= breadcrumb %>` (without *s*).
-* You can now access view helpers from inside `Gretel::Crumbs.layout do .. end`.
+* You can now access view helpers from inside `Gretel::Crumbs.layout do .. end`.

data/Gemfile

@@ -1,17 +1,6 @@
 source "http://rubygems.org"
 
-# Declare your gem's dependencies in gretel.gemspec.
-# Bundler will treat runtime dependencies like base dependencies, and
-# development dependencies will be added by default to the :development group.
 gemspec
 
-# jquery-rails is used by the dummy application
-gem "jquery-rails"
-
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.
-
-# To use debugger
-# gem 'debugger'
+rails_version = ENV['RAILS_VERSION'] || '>= 0'
+gem 'rails', rails_version

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2013 Lasse Bunk
+Copyright (c) 2010-2020 Lasse Bunk
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,29 +1,13 @@
-<a href="http://travis-ci.org/lassebunk/gretel"><img src="https://secure.travis-ci.org/lassebunk/gretel.png" alt="Build Status" /></a>
+[![Gem Version](https://badge.fury.io/rb/gretel.svg)](http://badge.fury.io/rb/gretel)
+[![Build Status](https://travis-ci.org/kzkn/gretel.svg?branch=master)](https://travis-ci.org/kzkn/gretel)
 
 <img src="http://i.imgur.com/CAKEaBM.png" alt="Handle breadcrumb trails... like a boss :)" />
 
 ([TL;DR](http://i.imgur.com/nH25yiH.png)) Gretel is a [Ruby on Rails](http://rubyonrails.org) plugin that makes it easy yet flexible to create breadcrumbs.
 It is based around the idea that breadcrumbs are a concern of the view, so you define a set of breadcrumbs in *config/breadcrumbs.rb* (or multiple files; see below) and specify in the view which breadcrumb to use.
-Gretel also supports [semantic breadcrumbs](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=185417) (those used in Google results).
+Gretel also supports [semantic breadcrumbs](https://developers.google.com/search/docs/data-types/breadcrumb) (those used in Google results).
 
-Have fun! And please do write, if you (dis)like it – [lassebunk@gmail.com](mailto:lassebunk@gmail.com).
-
-## New in version 3.0
-
-* Breadcrumbs can now be rendered in different styles like ul- and ol lists, and for use with the [Twitter Bootstrap](http://getbootstrap.com/) framework. See the `:style` option below for more info.
-* Defining breadcrumbs using `Gretel::Crumbs.layout do ... end` in an initializer has been removed. See below for details on how to upgrade.
-* The `:show_root_alone` option is now called `:display_single_fragment` and can be used to hide the breadcrumbs when there is only one link, also if it is not the root breadcrumb.
-  The old `:show_root_alone` option is still supported until Gretel version 4.0 and will show a deprecation warning when it's used.
-* Links yielded from `<%= breadcrumbs do |links| %>` now have a `current?` helper that returns true if the link is the last in the trail.
-* New view helper: `parent_breadcrumb` returns the parent breadcrumb link (with `#key`, `#text`, and `#url`). This can for example be used to create a dynamic back link.
-  You can supply options like `:autoroot` etc.
-  If you supply a block, it will yield the parent breadcrumb if it is present.
-* Breadcrumbs can now be inferred if you pass in an instance of an object that responds to `model_name` (like an ActiveRecord model instance). E.g. `breadcrumb @product` is short for `breadcrumb :product, @product`.
-
-
-I hope you find these changes as useful as I did – if you have more suggestions, please create an [Issue](https://github.com/lassebunk/gretel/issues) or [Pull Request](https://github.com/lassebunk/gretel/pulls).
-
-See below for more info or the [changelog](https://github.com/lassebunk/gretel/blob/master/CHANGELOG.md) for less significant changes.
+Have fun!
 
 ## Installation
 
@@ -84,7 +68,7 @@ This will generate the following HTML (indented for readability):
 
 ```html
 <div class="breadcrumbs">
-  You are here:
+  <span class="pretext">You are here:</span>
   <a href="/">Home</a> &rsaquo;
   <a href="/issues">All issues</a> &rsaquo;
   <span class="current">My Issue</span>
@@ -104,9 +88,11 @@ Option                   | Description
 :autoroot                | Whether it should automatically link to the `:root` crumb if no parent is given.                                           | True
 :display_single_fragment | Whether it should display the breadcrumb if it includes only one link.                                                     | False
 :link_current            | Whether the current crumb should be linked to.                                                                             | False
-:semantic                | Whether it should generate [semantic breadcrumbs](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=185417). | False
+:link_current_to_request_path            | Whether the current crumb should always link to the current request path. *Note:* This option will have no effect unless `:link_current` is set to `true`.                                                                             | True
+:semantic                | Whether it should generate [semantic breadcrumbs](https://developers.google.com/search/docs/data-types/breadcrumb). | False
 :id                      | ID for the breadcrumbs container.                                                                                          | None
 :class                   | CSS class for the breadcrumbs container. Can be set to `nil` for no class.                                                 | `"breadcrumbs"`
+:fragment_class          | CSS class for the fragment link or span. Can be set to `nil` for no class.                                                 | None
 :current_class           | CSS class for the current link or span. Can be set to `nil` for no class.                                                  | `"current"`
 :pretext_class           | CSS class for the pretext, if given. Can be set to `nil` for no class.                                                     | `"pretext"`
 :posttext_class          | CSS class for the posttext, if given. Can be set to `nil` for no class.                                                    | `"posttext"`
@@ -119,15 +105,16 @@ These are the styles you can use with `breadcrumbs style: :xx`.
 
 Style          | Description
 -------------- | -----------
-`:inline`      | Renders each link by itself with `&rsaquo;` as the seperator.
+`:inline`      | Default. Renders each link by itself with `&rsaquo;` as the seperator.
 `:ol`          | Renders the links in `<li>` elements contained in an outer `<ol>`.
 `:ul`          | Renders the links in `<li>` elements contained in an outer `<ul>`.
-`:bootstrap`   | Renders the links for use in [Twitter Bootstrap](http://getbootstrap.com/).
-`:foundation5` | Renders the links for use in [Foundation 5](http://foundation.zurb.com/).
+`:bootstrap`   | Renders the links for use in [Bootstrap v3](https://getbootstrap.com/docs/3.4/).
+`:bootstrap4`  | Renders the links for use in [Bootstrap v4](https://getbootstrap.com/).
+`:foundation5` | Renders the links for use in [Foundation 5](https://get.foundation/).
 
 Or you can build the breadcrumbs manually for full customization; see below.
 
-If you add other widely used styles, please submit a [Pull Request](https://github.com/lassebunk/gretel/pulls) so others can use them too.
+If you add other widely used styles, please submit a [Pull Request](https://github.com/kzkn/gretel/pulls) so others can use them too.
 
 ## More examples
 
@@ -147,10 +134,10 @@ end
 # Parent crumbs
 crumb :project_issues do |project|
   link "Issues", project_issues_path(project)
-  parent :project, project
+  parent project # inferred to :project
 end
 
-# Child 
+# Child
 crumb :issue do |issue|
   link issue.name, issue_path(issue)
   parent :project_issues, issue.project
@@ -160,7 +147,7 @@ end
 crumb :category do |category|
   link category.name, category
   if category.parent
-    parent :category, category.parent
+    parent category.parent # inferred to :category
   else
     parent :categories
   end
@@ -169,7 +156,7 @@ end
 # Product crumb with recursive parent categories (as defined above)
 crumb :product do |product|
   link product.name, product
-  parent :category, product.category
+  parent product.category # inferred to :category
 end
 
 # Crumb with multiple links
@@ -190,7 +177,7 @@ crumb :product do |product|
   if keyword = params[:q].presence
     parent :search, keyword
   else # default
-    parent :category, product.category
+    parent product.category # inferred to :category
   end
 end
 
@@ -219,10 +206,10 @@ end
 
 ## Building the breadcrumbs manually
 
-If you supply a block to the `breadcrumbs` method, it will yield an array with the breadcrumb links so you can build the breadcrumbs HTML manually:
+You can use the `breadcrumbs` method directly as an array. It will return an array with the breadcrumb links so you can build the breadcrumbs HTML manually:
 
 ```erb
-<% breadcrumbs do |links| %>
+<% breadcrumbs.tap do |links| %>
   <% if links.any? %>
     You are here:
     <% links.each do |link| %>
@@ -305,55 +292,15 @@ breadcrumbs do |links|
 end
 ```
 
-### Automatic reloading of breadcrumb configuration files
-
-Since Gretel version 2.1.0, the breadcrumb configuration files are now reloaded in the Rails development environment if they change. In other environments, like production, the files are loaded once, when first needed.
-
-### Setting breadcrumb trails
-
-The [gretel-trails](https://github.com/lassebunk/gretel-trails) gem can handle adding and hiding trails from the URL automatically. This makes it possible to link back to a different breadcrumb trail than the one specified in your breadcrumb, for example if you have a
-store with products that have a default parent to the category breadcrumb, but when visiting from the reviews section, you want to link back to the reviews instead.
-
-You can apply trails to select links by adding a simple JS selector (`js-append-trail` or another you choose), and after each page load it hides the trail from the URL, so the server sees it but the users don't.
-
-Check out the gem [here](https://github.com/lassebunk/gretel-trails).
-
-
-## Upgrading from version 2.0 or below
-
-Instead of using the initializer that in Gretel version 2.0 and below required restarting the application after breadcrumb configuration changes, the configuration of the breadcrumbs is now loaded from `config/breadcrumbs.rb` (and `config/breadcrumbs/*.rb` if you want to split your breadcrumbs configuration across multiple files).
-In the Rails development environment, these files are automatically reloaded when changed.
-
-Using the initializer (e.g. `config/initializers/breadcrumbs.rb`) was deprecated in Gretel version 2.1.0 and removed in version 3.0. It raises an error if you try to use it.
-
-To update to the latest version of Gretel, use `bundle update gretel`. Then remove the `Gretel::Crumbs.layout do ... end` block, so instead of:
-
-```ruby
-Gretel::Crumbs.layout do
-  crumb :root do
-    link "Home", root_path
-  end
-end
-```
-
-in the initializer, you write:
-
-```ruby
-crumb :root do
-  link "Home", root_path
-end
-```
-
-in `config/breadcrumbs.rb`.
-
 ## Documentation
 
-* [Full documentation](http://rubydoc.info/gems/gretel)
-* [Changelog](https://github.com/lassebunk/gretel/blob/master/CHANGELOG.md)
+* [Full documentation](https://rubydoc.info/gems/gretel)
+* [Changelog](https://github.com/kzkn/gretel/blob/master/CHANGELOG.md)
+* [Tutorial on using Gretel](https://www.sitepoint.com/breadcrumbs-rails-gretel/) (Sitepoint)
 
 ## Versioning
 
-Follows [semantic versioning](http://semver.org/).
+Follows [semantic versioning](https://semver.org/).
 
 ## Contributing
 
@@ -364,17 +311,22 @@ To contribute:
 1. Fork the project
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Make your changes
-4. Add tests
-5. Run `rake` to make sure all tests pass
-6. Commit your changes (`git commit -am 'Add new feature'`)
-7. Push to the branch (`git push origin my-new-feature`)
-8. Create new pull request
+4. Add/Fix tests
+5. Prepare database for testing: `cd spec/dummy; rake db:migrate; rake db:test:prepare; cd ../..`
+6. Run `rake` to make sure all tests pass
+7. Be sure to check in the changes to `coverage/coverage.txt`
+8. Commit your changes (`git commit -am 'Add new feature'`)
+9. Push to the branch (`git push origin my-new-feature`)
+10. Create new pull request
 
 Thanks.
 
 ## Contributors
 
-* [See the list of contributors](https://github.com/lassebunk/gretel/graphs/contributors)
+Gretel was created by [@lassebunk](https://github.com/lassebunk) and was maintained by [@WilHall](https://github.com/WilHall).
+And it is maintained by [@kzkn](https://github.com/kzkn).
+
+[See the list of contributors](https://github.com/kzkn/gretel/graphs/contributors)
 
 ## And then
 
@@ -382,4 +334,4 @@ Thanks.
 
 Have fun!
 
-Copyright (c) 2010-2013 [Lasse Bunk](http://lassebunk.dk), released under the MIT license
+Copyright (c) 2010-2020 [Lasse Bunk](http://lassebunk.dk), released under the MIT license

data/Rakefile

@@ -1,10 +1,6 @@
-require 'rake/testtask'
 require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
 
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
-end
+RSpec::Core::RakeTask.new(:spec)
 
-task default: :test
+task default: :spec

data/coverage/coverage.txt

@@ -0,0 +1,5 @@
+--------------------------------------------------------------------------------
+Incomplete test coverage
+--------------------------------------------------------------------------------
+
+100% test coverage. You're all set, friend!

data/gretel.gemspec

@@ -1,22 +1,23 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'gretel/version'
+require_relative 'lib/gretel/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "gretel"
   gem.version       = Gretel::VERSION
-  gem.authors       = ["Lasse Bunk"]
-  gem.email         = ["lassebunk@gmail.com"]
+  gem.authors       = ["Lasse Bunk", "Kazuki Nishikawa"]
+  gem.email         = ["kzkn@users.noreply.github.com"]
   gem.description   = %q{Gretel is a Ruby on Rails plugin that makes it easy yet flexible to create breadcrumbs.}
   gem.summary       = %q{Flexible Ruby on Rails breadcrumbs plugin.}
-  gem.homepage      = "http://github.com/lassebunk/gretel"
+  gem.homepage      = "http://github.com/kzkn/gretel"
   gem.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "rails", ">= 3.2.0"
+  gem.add_dependency "rails", ">= 5.1"
   gem.add_development_dependency "sqlite3"
-end
+  gem.add_development_dependency "rspec-rails"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "simplecov-erb"
+end

data/lib/gretel.rb

@@ -5,7 +5,6 @@ require 'gretel/crumb'
 require 'gretel/link'
 require 'gretel/renderer'
 require 'gretel/view_helpers'
-require 'gretel/deprecated'
 
 module Gretel
   class << self
@@ -16,9 +15,7 @@ module Gretel
     # breadcrumbs set in engines.
     def breadcrumb_paths
       @breadcrumb_paths ||= begin
-        engines = Rails::Application::Railties.respond_to?(:engines) ?
-          Rails::Application::Railties.engines :
-          Rails::Engine.subclasses.map(&:instance)
+        engines = Rails::Engine.subclasses.map(&:instance)
 
         engine_roots = engines.map { |e| e.config.root }
         
@@ -35,24 +32,6 @@ module Gretel
       @breadcrumb_paths = paths
     end
 
-    # Whether to suppress deprecation warnings.
-    def suppress_deprecation_warnings?
-      !!@suppress_deprecation_warnings
-    end
-
-    # Sets whether to suppress deprecation warnings.
-    def suppress_deprecation_warnings=(value)
-      @suppress_deprecation_warnings = value
-    end
-
-    # Shows a deprecation warning.
-    def show_deprecation_warning(message)
-      return if suppress_deprecation_warnings?
-      message = "[Gretel] #{message}"
-      puts message
-      Rails.logger.warn message
-    end
-
     # Array of Rails environment names with automatic configuration reload. Default is +["development"]+.
     def reload_environments
       @reload_environments ||= ["development"]
@@ -79,4 +58,4 @@ module Gretel
   end
 end
 
-ActionView::Base.send :include, Gretel::ViewHelpers
+ActionView::Base.send :include, Gretel::ViewHelpers