gretel 4.0.0 → 4.3.0

data/lib/gretel/railtie.rb

@@ -0,0 +1,11 @@
+require 'gretel/view_helpers'
+
+module Gretel
+  class Railtie < ::Rails::Railtie
+    initializer 'gretel.view_helpers' do
+      ActiveSupport.on_load(:action_view) do
+        include ViewHelpers
+      end
+    end
+  end
+end

data/lib/gretel/renderer.rb

@@ -1,3 +1,6 @@
+require 'gretel/crumbs'
+require 'gretel/crumb'
+
 module Gretel
   class Renderer
     DEFAULT_OPTIONS = {
@@ -14,7 +17,8 @@ module Gretel
       current_class: "current",
       pretext_class: "pretext",
       posttext_class: "posttext",
-      id: nil
+      id: nil,
+      aria_current: nil
     }
 
     DEFAULT_STYLES = {
@@ -40,11 +44,6 @@ module Gretel
       LinkCollection.new(context, links, options)
     end
 
-    # Yields links with applied options.
-    def yield_links(options = {})
-      yield render(options)
-    end
-
     # Returns the parent breadcrumb.
     def parent_breadcrumb(options = {})
       render(options)[-2]
@@ -161,6 +160,27 @@ module Gretel
         concat links
       end
 
+      # Returns a hash matching the JSON-LD Structured Data schema
+      # https://developers.google.com/search/docs/data-types/breadcrumb#json-ld
+      def structured_data(url_base:)
+        url_base = url_base.chomp("/") # Remove trailing `/`, if present
+
+        items = @links.each_with_index.map do |link, i|
+          {
+            "@type": "ListItem",
+            "position": i + 1,
+            "name": link.text,
+            "item": "#{url_base}#{link.url}"
+          }
+        end
+
+        {
+          "@context": "https://schema.org",
+          "@type": "BreadcrumbList",
+          "itemListElement": items
+        }
+      end
+
       # Helper for returning all link keys to allow for simple testing.
       def keys
         map(&:key)
@@ -171,13 +191,14 @@ module Gretel
         return "" if links.empty?
 
         # Loop through all but the last (current) link and build HTML of the fragments
-        fragments = links[0..-2].map do |link|
-          render_fragment(options[:fragment_tag], link.text, link.url, options[:semantic], fragment_class: options[:fragment_class])
+        fragments = links[0..-2].map.with_index do |link, index|
+          render_fragment(options[:fragment_tag], link.text, link.url, options[:semantic], index + 1, fragment_class: options[:fragment_class])
         end
 
         # The current link is handled a little differently, and is only linked if specified in the options
         current_link = links.last
-        fragments << render_fragment(options[:fragment_tag], current_link.text, (options[:link_current] ? current_link.url : nil), options[:semantic], fragment_class: options[:fragment_class], class: options[:current_class], current_link: current_link.url)
+        position = links.size
+        fragments << render_fragment(options[:fragment_tag], current_link.text, (options[:link_current] ? current_link.url : nil), options[:semantic], position, fragment_class: options[:fragment_class], class: options[:current_class], current_link: current_link.url, aria_current: options[:aria_current])
 
         # Build the final HTML
         html_fragments = []
@@ -193,41 +214,43 @@ module Gretel
         end
 
         html = html_fragments.join(" ").html_safe
-        content_tag(options[:container_tag], html, id: options[:id], class: options[:class])
+
+        if options[:semantic]
+          content_tag(options[:container_tag], html, id: options[:id], class: options[:class], itemscope: "", itemtype: "https://schema.org/BreadcrumbList")
+        else
+          content_tag(options[:container_tag], html, id: options[:id], class: options[:class])
+        end
       end
 
       alias :to_s :render
 
       # Renders HTML for a breadcrumb fragment, i.e. a breadcrumb link.
-      def render_fragment(fragment_tag, text, url, semantic, options = {})
+      def render_fragment(fragment_tag, text, url, semantic, position, options = {})
         if semantic
-          render_semantic_fragment(fragment_tag, text, url, options)
+          render_semantic_fragment(fragment_tag, text, url, position, options)
         else
           render_nonsemantic_fragment(fragment_tag, text, url, options)
         end
       end
 
       # Renders semantic fragment HTML.
-      def render_semantic_fragment(fragment_tag, text, url, options = {})
+      def render_semantic_fragment(fragment_tag, text, url, position, options = {})
         fragment_class = [options[:fragment_class], options[:class]].join(' ').strip
         fragment_class = nil if fragment_class.blank?
-
-        if fragment_tag
-          text = content_tag(:span, text, itemprop: "title")
-
-          if url.present?
-            text = breadcrumb_link_to(text, url, itemprop: "url")
-          elsif options[:current_link].present?
-            current_url = "#{root_url}#{options[:current_link].gsub(/^\//, '')}"
-            text = text + tag(:meta, itemprop: "url", content: current_url)
-          end
-
-          content_tag(fragment_tag, text, class: fragment_class, itemscope: "", itemtype: "http://data-vocabulary.org/Breadcrumb")
-        elsif url.present?
-          content_tag(:span, breadcrumb_link_to(content_tag(:span, text, itemprop: "title"), url, class: fragment_class, itemprop: "url"), itemscope: "", itemtype: "http://data-vocabulary.org/Breadcrumb")
-        else
-          content_tag(:span, content_tag(:span, text, class: fragment_class, itemprop: "title"), itemscope: "", itemtype: "http://data-vocabulary.org/Breadcrumb")
+        fragment_tag = fragment_tag || 'span'
+        text = content_tag(:span, text, itemprop: "name")
+
+        aria_current = options[:aria_current]
+        if url.present?
+          text = breadcrumb_link_to(text, url, itemprop: "item", "aria-current": aria_current)
+          aria_current = nil
+        elsif options[:current_link].present?
+          current_url = "#{root_url}#{options[:current_link].gsub(/^\//, '')}"
+          text = text + tag(:meta, itemprop: "item", content: current_url)
         end
+
+        text = text + tag(:meta, itemprop:"position", content: "#{position}")
+        content_tag(fragment_tag.to_sym, text, class: fragment_class, itemprop: "itemListElement", itemscope: "", itemtype: "https://schema.org/ListItem", "aria-current": aria_current)
       end
 
       # Renders regular, non-semantic fragment HTML.
@@ -236,12 +259,16 @@ module Gretel
         fragment_class = nil if fragment_class.blank?
 
         if fragment_tag
-          text = breadcrumb_link_to(text, url) if url.present?
-          content_tag(fragment_tag, text, class: fragment_class)
+          if url.present?
+            text = breadcrumb_link_to(text, url, "aria-current": options[:aria_current])
+            content_tag(fragment_tag, text, class: fragment_class)
+          else
+            content_tag(fragment_tag, text, class: fragment_class, "aria-current": options[:aria_current])
+          end
         elsif url.present?
-          breadcrumb_link_to(text, url, class: fragment_class)
+          breadcrumb_link_to(text, url, class: fragment_class, "aria-current": options[:aria_current])
         elsif options[:class].present?
-          content_tag(:span, text, class: fragment_class)
+          content_tag(:span, text, class: fragment_class, "aria-current": options[:aria_current])
         else
           text
         end
@@ -256,6 +283,11 @@ module Gretel
       def method_missing(method, *args, &block)
         context.send(method, *args, &block)
       end
+
+      # Avoid unnecessary html escaping by template engines.
+      def html_safe?
+        true
+      end
     end
   end
 end

data/lib/gretel/version.rb

@@ -1,3 +1,3 @@
 module Gretel
-  VERSION = "4.0.0"
+  VERSION = "4.3.0"
 end

data/lib/gretel/view_helpers.rb

@@ -1,3 +1,5 @@
+require 'gretel/renderer'
+
 module Gretel
   module ViewHelpers
     # Sets the current breadcrumb to be rendered elsewhere. Put it somewhere in the view, preferably in the top, before you render any breadcrumbs HTML:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Lasse Bunk
@@ -9,15 +9,18 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -25,22 +28,31 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: jquery-rails
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,47 +66,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov-erb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 description: Gretel is a Ruby on Rails plugin that makes it easy yet flexible to create
   breadcrumbs.
 email:
@@ -103,8 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -119,54 +131,11 @@ files:
 - lib/gretel/crumb.rb
 - lib/gretel/crumbs.rb
 - lib/gretel/link.rb
+- lib/gretel/railtie.rb
 - lib/gretel/renderer.rb
 - lib/gretel/resettable.rb
 - lib/gretel/version.rb
 - lib/gretel/view_helpers.rb
-- test/dummy/Rakefile
-- test/dummy/app/assets/config/manifest.js
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/mailers/.gitkeep
-- test/dummy/app/models/.gitkeep
-- test/dummy/app/models/issue.rb
-- test/dummy/app/models/project.rb
-- test/dummy/app/views/breadcrumbs/site.rb
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/breadcrumbs.rb
-- test/dummy/config/breadcrumbs/test_crumbs.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/db/migrate/20130122163007_create_projects.rb
-- test/dummy/db/migrate/20130122163051_create_issues.rb
-- test/dummy/db/schema.rb
-- test/dummy/lib/assets/.gitkeep
-- test/dummy/log/.gitkeep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/script/rails
-- test/fixtures/issues.yml
-- test/fixtures/projects.yml
-- test/gretel_test.rb
-- test/helper_methods_test.rb
-- test/test_helper.rb
 homepage: http://github.com/kzkn/gretel
 licenses:
 - MIT
@@ -186,52 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Flexible Ruby on Rails breadcrumbs plugin.
-test_files:
-- test/dummy/Rakefile
-- test/dummy/app/assets/config/manifest.js
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/mailers/.gitkeep
-- test/dummy/app/models/.gitkeep
-- test/dummy/app/models/issue.rb
-- test/dummy/app/models/project.rb
-- test/dummy/app/views/breadcrumbs/site.rb
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/breadcrumbs.rb
-- test/dummy/config/breadcrumbs/test_crumbs.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/db/migrate/20130122163007_create_projects.rb
-- test/dummy/db/migrate/20130122163051_create_issues.rb
-- test/dummy/db/schema.rb
-- test/dummy/lib/assets/.gitkeep
-- test/dummy/log/.gitkeep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/script/rails
-- test/fixtures/issues.yml
-- test/fixtures/projects.yml
-- test/gretel_test.rb
-- test/helper_methods_test.rb
-- test/test_helper.rb
+test_files: []

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 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 ../.."
-notifications:
-  email: false