gretel 3.0.9 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0080b505b59c5b36fb677893d4eb7eb423653392
-  data.tar.gz: 6cab21d17741ad215d56a26f7d12c20c833bcc9d
+SHA256:
+  metadata.gz: b80e71f865388974401274f84159318e012a5e9e40800888549453e301881bec
+  data.tar.gz: 06d1a078802e9b8d175f17376c7534ba8004c15327e2fc75b0e01e9386653cb8
 SHA512:
-  metadata.gz: a39a87e3267b845a254a72a1d7478d987cff71d6484de22326aa28c7eb8476d22d6500df7c376fa5407ba9d65ad82d6f975fa2d70916e2169954c9bbbd7b7938
-  data.tar.gz: d02a3bc7312ab98ad6b0b6adc68c38454e655c5bb29db4fbf140871cec41c8eb59dabc09170b9d94b8f9c9b24c64a4db659e27f32ac3d04411f9ad136df2cdd5
+  metadata.gz: 3b8c092e5e04c48099f0fcad18230b89a6f4c11e760d59f89f629792cb4225eb5db1cf4648c8a6145c6be99bcf104b0d08ee0b74b82d39d1e7b9e366fda6ea37
+  data.tar.gz: 582e6471d0fa5fb59d490bee9a41b1cdd7b0f419b107c9acb56914832ad5b3a5dfc5c4590918dcb38ea46495a0df2578ceeb5e6384e57c0ed7e37ab8e39ea3e7

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,16 +1,17 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.2.0
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
-gemfile:
-  - gemfiles/Gemfile-rails.3.1.x
-  - 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_VERSION="~> 5.1.0"
+  - RAILS_VERSION="~> 5.2.0"
+  - RAILS_VERSION="~> 6.0.0"
+  - RAILS_VERSION="master"
 before_script:
-  - "cd test/dummy; rake db:migrate; rake db:test:prepare; cd ../.."
+  - "cd spec/dummy; rake db:migrate; rake db:test:prepare; cd ../.."
+after_script:
+  - "cat coverage/coverage.txt"
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## Version 4.2.0
+* Support generating JSON-LD structured data. See the readme for more info (via #26, thanks @dkniffin)
+
+## Version 4.1.0
+* Depends only `railties` and `actionview`, not `rails` (via #7)
+* Include `Gretel::ViewHelpers` module in `ActiveSupport.on_load(:action_view)` block
+* Fix ruby 2.7 keywords warning (via #24, thanks @aki77)
+* Fix multithreaded environment issue (via #13)
+  * `breadcrumbs.rb` is now evaluated in a instance of `Gretel::Crumbs::Builder`. If you want to call methods from `breadcrumbs.rb` other than `crumb`, `crumbs` and `crumb_defined?`, you need to call it via full reference like `Gretel::Crumbs.xxxx`
+
+## 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)

data/Gemfile

@@ -1,23 +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
 
-# 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'
-
-group :development do
-  # jquery-rails is used by the dummy application
-  gem "jquery-rails"
-end
-
-group :test do
-  gem 'test-unit', '~> 3.0' if RUBY_VERSION >= "2.2"
-end
+rails_version = ENV['RAILS_VERSION'] || '>= 0'
+gem 'rails', rails_version == 'master' ? { github: 'rails/rails' } : rails_version

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2016 Lasse Bunk
+Copyright (c) 2010-2020 Lasse Bunk
 
 MIT License
 

data/README.md

@@ -1,12 +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).
+Have fun!
 
 ## Installation
 
@@ -88,9 +89,10 @@ Option                   | Description
 :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
 :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](http://support.google.com/webmasters/bin/answer.py?hl=en&answer=185417). | False
+: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"`
@@ -103,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
 
@@ -203,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| %>
@@ -216,6 +219,23 @@ If you supply a block to the `breadcrumbs` method, it will yield an array with t
 <% end %>
 ```
 
+If you use this approach, you lose the built-in semantic breadcrumb functionality. One way to
+add them back is to use JSON-LD structured data:
+
+```erb
+<script type="application/ld+json">
+  <%= breadcrumbs.structured_data(url_base: "https://example.com")) %>
+</script>
+```
+
+Or, you can infer `url_base` from `request`:
+
+```erb
+<script type="application/ld+json">
+  <%= breadcrumbs.structured_data(url_base: "#{request.protocol}#{request.host_with_port}")) %>
+</script>
+```
+
 ## Getting the parent breadcrumb
 
 If you want to add a link to the parent breadcrumb, you can use the `parent_breadcrumb` view helper.
@@ -289,56 +309,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)
-* [Tutorial on using Gretel](http://www.sitepoint.com/breadcrumbs-rails-gretel/) (Sitepoint)
+* [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
 
@@ -350,19 +329,21 @@ To contribute:
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Make your changes
 4. Add/Fix tests
-5. Prepare database for testing: `cd test/dummy; rake db:migrate; rake db:test:prepare; cd ../..`
+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. Commit your changes (`git commit -am 'Add new feature'`)
-8. Push to the branch (`git push origin my-new-feature`)
-9. Create new pull request
+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
 
-Gretel was created by [@lassebunk](https://github.com/lassebunk) and is maintained by [@WilHall](https://github.com/WilHall).
+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/lassebunk/gretel/graphs/contributors)
+[See the list of contributors](https://github.com/kzkn/gretel/graphs/contributors)
 
 ## And then
 
@@ -370,4 +351,4 @@ Gretel was created by [@lassebunk](https://github.com/lassebunk) and is maintain
 
 Have fun!
 
-Copyright (c) 2010-2016 [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,24 @@
-# -*- 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.1.0"
+  gem.add_dependency "railties", [">= 5.1", "< 7.0"]
+  gem.add_dependency "actionview", [">= 5.1", "< 7.0"]
   gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "rspec-rails"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "simplecov-erb"
 end

data/lib/gretel.rb

@@ -1,11 +1,6 @@
 require 'gretel/version'
 require 'gretel/resettable'
-require 'gretel/crumbs'
-require 'gretel/crumb'
-require 'gretel/link'
-require 'gretel/renderer'
-require 'gretel/view_helpers'
-require 'gretel/deprecated'
+require 'gretel/railtie'
 
 module Gretel
   class << self
@@ -16,9 +11,7 @@ module Gretel
     # breadcrumbs set in engines.
     def breadcrumb_paths
       @breadcrumb_paths ||= begin
-        engines = Rails::Engine::Railties.respond_to?(:engines) ?
-          Rails::Engine::Railties.engines :
-          Rails::Engine.subclasses.map(&:instance)
+        engines = Rails::Engine.subclasses.map(&:instance)
 
         engine_roots = engines.map { |e| e.config.root }
         
@@ -35,24 +28,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"]
@@ -78,5 +53,3 @@ module Gretel
     end
   end
 end
-
-ActionView::Base.send :include, Gretel::ViewHelpers

data/lib/gretel/crumb.rb

@@ -1,3 +1,5 @@
+require 'gretel/link'
+
 module Gretel
   class Crumb
     # Initializes a new crumb from the given +key+.
@@ -13,7 +15,7 @@ module Gretel
       raise ArgumentError, "Breadcrumb :#{key} not found." unless block
       @key = key
       @context = context
-      instance_exec *args, &block
+      instance_exec(*args, &block)
     end
 
     # Sets link of the breadcrumb.
@@ -29,7 +31,7 @@ module Gretel
 
       # Transform objects to real paths.
       url = url_for(url) if url
-      
+
       links << Gretel::Link.new(key, text, url, options)
     end
 
@@ -64,5 +66,6 @@ module Gretel
     def method_missing(method, *args, &block)
       context.send(method, *args, &block)
     end
+    ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
   end
 end