gretel 4.0.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6b2a5d8a3fd0fbb357c690e1d0189c54ab90ad1619c6ea5910b59f9cf718e89
-  data.tar.gz: d5c633b783445c773bb031dbd2377ca8af9265ced45f9aaafeabebc853c754d6
+  metadata.gz: c1fe62ed99bb8f03e6a00a782f55adc5f6b6fcf84a444d77aa1c771b41d148a9
+  data.tar.gz: 1660db0b73ddbf77dac315c8d1466fb66958b9ebab59629c96f999536f17b824
 SHA512:
-  metadata.gz: 5816c2df05e992e54868150d8f6689af7c2d2cb0af33b588c9ef552d54771efcf81b29a9b9f2bca223e784644288caf24987f8b38f546ea0b3a4be1944a73b1e
-  data.tar.gz: 80497833712a92ac207f663ab544761ebf65b7a93d8d5fd7712e3bb8b3c8785b72ee85020ead35cd2e118a03f09e81a3d844c7dbbd629a3cf6cfb1b3d78669ba
+  metadata.gz: 4bddd221544196836669a1309c97d536ad2d2b11ef10c74a265e034d0a1463ba5b4955651235ad395b9c37249a9d5eff2ef9ec9b659ab896a8fbca959b199924
+  data.tar.gz: ebd6e183dc3597f83c9ac8b22399d0ad52e345da6586b9de59c2386c8b5116d40199fcf494c44cd8d094a25ed543d5ee21397506d1979ebf851a973e23da3ced

data/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 0 * * 0'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        rails_version: [5.1.0, 5.2.0, 6.0.0, 6.1.0, master]
+        ruby_version: [3.0, 2.7, 2.6, 2.5]
+        exclude:
+          - ruby_version: 2.5
+            rails_version: master
+          - ruby_version: 2.6
+            rails_version: master
+          - ruby_version: 3.0
+            rails_version: 5.1.0
+          - ruby_version: 3.0
+            rails_version: 5.2.0
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+
+    - name: Run test
+      env:
+        RAILS_VERSION: ${{ matrix.rails_version }}
+      run: |
+        bundle update
+        cd spec/dummy; rake db:migrate db:test:prepare; cd ../..
+        bundle exec rake
+
+    - name: Upload coverage
+      uses: actions/upload-artifact@v2
+      if: always()
+      with:
+        name: coverage-ruby-${{ matrix.ruby_version }}-rails-${{ matrix.rails_version }}
+        path: coverage
+
+    - name: Show coverage
+      if: always()
+      run: |
+        cat coverage/coverage.txt

data/.gitignore

@@ -12,17 +12,18 @@ 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
+/.ruby-version

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## Version 4.3.0
+* Support generating `aria-current` attribute. It's disabled by default. See the readme for more info
+
+## 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

data/Gemfile

@@ -3,4 +3,6 @@ source "http://rubygems.org"
 gemspec
 
 rails_version = ENV['RAILS_VERSION'] || '>= 0'
-gem 'rails', rails_version
+rails_version = "~> #{rails_version}" if rails_version =~ /^\d/
+
+gem 'rails', rails_version == 'master' ? { github: 'rails/rails' } : rails_version

data/README.md

@@ -1,10 +1,11 @@
-<a href="http://travis-ci.org/kzkn/gretel"><img src="https://secure.travis-ci.org/kzkn/gretel.png" alt="Build Status" /></a>
+[![Gem Version](https://badge.fury.io/rb/gretel.svg)](http://badge.fury.io/rb/gretel)
+![](https://github.com/kzkn/gretel/workflows/CI/badge.svg)
 
 <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!
 
@@ -88,7 +89,7 @@ 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
@@ -97,6 +98,7 @@ Option                   | Description
 :posttext_class          | CSS class for the posttext, if given. Can be set to `nil` for no class.                                                    | `"posttext"`
 :container_tag           | Tag type that contains the breadcrumbs.                                                                                    | `:div`
 :fragment_tag            | Tag type to contain each breadcrumb fragment/link.                                                                         | None
+:aria_current            | Value of `aria-current` attribute.                                                                                         | None
 
 ### Styles
 
@@ -104,12 +106,12 @@ 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/).
+`: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](http://foundation.zurb.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.
 
@@ -201,6 +203,11 @@ end
 crumb :user do |user|
   link user_name_for(user), user
 end
+
+# I18n
+crumb :home do
+  link t("breadcrumbs.home"), root_path
+end
 ```
 
 ## Building the breadcrumbs manually
@@ -218,6 +225,23 @@ You can use the `breadcrumbs` method directly as an array. It will return an arr
 <% 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.
@@ -291,56 +315,34 @@ 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.
+### ARIA support
 
-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.
+You can improve the accessibility of your page with the markup that specified in [ARIA](https://www.w3.org/TR/wai-aria-practices/examples/breadcrumb/index.html). Gretel supports generating `aria-current` attribute:
 
-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
+```erb
+<% breadcrumb :issue, @issue %>
+<%= breadcrumbs aria_current: "page" %>
 ```
 
-in the initializer, you write:
+This will generate the following HTML (indented for readability):
 
-```ruby
-crumb :root do
-  link "Home", root_path
-end
+```html
+<div class="breadcrumbs">
+  <a href="/">Home</a> &rsaquo;
+  <a href="/issues">All issues</a> &rsaquo;
+  <span class="current" aria-current="page">My Issue</span>
+</div>
 ```
 
-in `config/breadcrumbs.rb`.
-
 ## Documentation
 
-* [Full documentation](http://rubydoc.info/gems/gretel)
+* [Full documentation](https://rubydoc.info/gems/gretel)
 * [Changelog](https://github.com/kzkn/gretel/blob/master/CHANGELOG.md)
-* [Tutorial on using Gretel](http://www.sitepoint.com/breadcrumbs-rails-gretel/) (Sitepoint)
+* [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
 
@@ -352,7 +354,7 @@ 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. Be sure to check in the changes to `coverage/coverage.txt`
 8. Commit your changes (`git commit -am 'Add new feature'`)

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

@@ -2,5 +2,4 @@
 Incomplete test coverage
 --------------------------------------------------------------------------------
 
-/lib/gretel/renderer.rb: 99.12% (missed: 45)
-/test/helper_methods_test.rb: 99.24% (missed: 17,196)
+100% test coverage. You're all set, friend!

data/gretel.gemspec

@@ -1,7 +1,4 @@
-# -*- 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"
@@ -13,14 +10,15 @@ Gem::Specification.new do |gem|
   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", ">= 5.1"
+  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 "jquery-rails"
-  gem.add_development_dependency "test-unit", "~> 3.0"
-  gem.add_development_dependency "simplecov", "~> 0.18.0"
-  gem.add_development_dependency "simplecov-erb", "~> 0.1"
+  gem.add_development_dependency "rspec-rails"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "simplecov-erb"
 end

data/lib/gretel.rb

@@ -1,10 +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/railtie'
 
 module Gretel
   class << self
@@ -57,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

data/lib/gretel/crumbs.rb

@@ -3,11 +3,6 @@ module Gretel
     class << self
       include Resettable
 
-      # Stores the supplied block for later use.
-      def crumb(key, &block)
-        crumbs[key] = block
-      end
-
       # Returns a hash of all stored crumb blocks.
       def crumbs
         @crumbs ||= {}
@@ -20,14 +15,15 @@ module Gretel
 
       # Loads the breadcrumb configuration files.
       def load_breadcrumbs
-        @crumbs = {}
+        builder = Builder.new
 
         loaded_file_mtimes.clear
         breadcrumb_files.each do |file|
-          instance_eval open(file).read, file
+          builder.instance_eval open(file).read, file
           loaded_file_mtimes << File.mtime(file)
         end
 
+        @crumbs = builder.crumbs
         @loaded = true
       end
 
@@ -59,6 +55,29 @@ module Gretel
       def loaded_file_mtimes
         @loaded_file_mtimes ||= []
       end
+
+      class Builder
+        attr_reader :crumbs
+
+        def initialize
+          @crumbs = {}
+        end
+
+        # Stores the supplied block for later use.
+        def crumb(key, &block)
+          crumbs[key] = block
+        end
+
+        # Returns a hash of all stored crumb blocks.
+        def crumbs
+          @crumbs ||= {}
+        end
+
+        # Returns true if a crumb with the given key has been set.
+        def crumb_defined?(key)
+          crumbs.has_key?(key)
+        end
+      end
     end
   end
 end