gretel 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6b2a5d8a3fd0fbb357c690e1d0189c54ab90ad1619c6ea5910b59f9cf718e89
-  data.tar.gz: d5c633b783445c773bb031dbd2377ca8af9265ced45f9aaafeabebc853c754d6
+  metadata.gz: 5738580a72561b3be8158c37561fa8f2b85b6438b127bc110d70aaac60ec16a8
+  data.tar.gz: 11cf40314f61f69ae51b1bb95c8c078ec3d35c325a3af34a75906d343163fb28
 SHA512:
-  metadata.gz: 5816c2df05e992e54868150d8f6689af7c2d2cb0af33b588c9ef552d54771efcf81b29a9b9f2bca223e784644288caf24987f8b38f546ea0b3a4be1944a73b1e
-  data.tar.gz: 80497833712a92ac207f663ab544761ebf65b7a93d8d5fd7712e3bb8b3c8785b72ee85020ead35cd2e118a03f09e81a3d844c7dbbd629a3cf6cfb1b3d78669ba
+  metadata.gz: a4c29b164147c61f5f5585782a0026af9f532ac45be4ad7822a7816ebbea8949c7e7b0448fc683df7e35d6a82a38817c592fd559560b43ac043e788b5585974f
+  data.tar.gz: c13b14cfa25d40d80e0cb615c01d90bd4d97ff68e8c08fc86245aa18818e3962abd3a111da36d6ee13908b8acd6489a45deeb11ec65406260f3114e2ba96290b

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 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/README.md

@@ -4,7 +4,7 @@
 
 ([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 +88,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

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/lib/gretel/renderer.rb

@@ -40,11 +40,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]
@@ -171,13 +166,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)
 
         # Build the final HTML
         html_fragments = []
@@ -193,41 +189,42 @@ module Gretel
         end
 
         html = html_fragments.join(" ").html_safe
-        content_tag(options[:container_tag], html, id: options[:id], class: options[:class])
-      end
+        
+        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")
+
+        if url.present?
+          text = breadcrumb_link_to(text, url, itemprop: "item")
+        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")
       end
 
       # Renders regular, non-semantic fragment HTML.

data/lib/gretel/version.rb

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

data/test/helper_methods_test.rb

@@ -12,11 +12,6 @@ class HelperMethodsTest < ActionView::TestCase
     Gretel.reset!
   end
 
-  def itemscope_value
-    ActionView::Helpers::TagHelper::BOOLEAN_ATTRIBUTES.include?("itemscope") ?
-      "itemscope" : ""
-  end
-
   # Breadcrumb generation
 
   test "basic breadcrumb" do
@@ -63,7 +58,7 @@ class HelperMethodsTest < ActionView::TestCase
 
   test "semantic breadcrumb" do
     breadcrumb :with_root
-    assert_dom_equal %Q{<div class="breadcrumbs"><span itemscope="#{itemscope_value}" itemtype="http://data-vocabulary.org/Breadcrumb"><a href="/" itemprop="url"><span itemprop="title">Home</span></a></span> &rsaquo; <span itemscope="#{itemscope_value}" itemtype="http://data-vocabulary.org/Breadcrumb"><span class="current" itemprop="title">About</span></span></div>},
+    assert_dom_equal %{<div class="breadcrumbs" itemscope="itemscope" itemtype="https://schema.org/BreadcrumbList"><span itemprop="itemListElement" itemscope="itemscope" itemtype="https://schema.org/ListItem"><a itemprop="item" href="/"><span itemprop="name">Home</span></a><meta itemprop="position" content="1" /></span> &rsaquo; <span class="current" itemprop="itemListElement" itemscope="itemscope" itemtype="https://schema.org/ListItem"><span itemprop="name">About</span><meta itemprop="item" content="http://test.host/about" /><meta itemprop="position" content="2" /></span></div>},
                  breadcrumbs(semantic: true).to_s
   end
 
@@ -193,7 +188,9 @@ class HelperMethodsTest < ActionView::TestCase
     breadcrumb :basic
 
     out = parent_breadcrumb(autoroot: false) do
+      # :nocov:
       "yielded"
+      # :nocov:
     end
 
     assert_nil out
@@ -373,7 +370,7 @@ class HelperMethodsTest < ActionView::TestCase
   test "foundation5 style" do
     breadcrumb :basic
     assert_dom_equal %{<ul class="breadcrumbs"><li><a href="/">Home</a></li><li class="current">About</li></ul>},
-	         breadcrumbs(style: :foundation5).to_s
+                 breadcrumbs(style: :foundation5).to_s
   end
 
   test "custom container and fragment tags" do
@@ -384,7 +381,7 @@ class HelperMethodsTest < ActionView::TestCase
 
   test "custom semantic container and fragment tags" do
     breadcrumb :basic
-    assert_dom_equal %Q{<c class="breadcrumbs"><f itemscope="#{itemscope_value}" itemtype="http://data-vocabulary.org/Breadcrumb"><a itemprop="url" href="/"><span itemprop="title">Home</span></a></f> &rsaquo; <f class="current" itemscope="#{itemscope_value}" itemtype="http://data-vocabulary.org/Breadcrumb"><span itemprop="title">About</span><meta itemprop="url" content="http://test.host/about" /></f></c>},
+    assert_dom_equal %{<c class="breadcrumbs" itemscope="itemscope" itemtype="https://schema.org/BreadcrumbList"><f itemprop="itemListElement" itemscope="itemscope" itemtype="https://schema.org/ListItem"><a itemprop="item" href="/"><span itemprop="name">Home</span></a><meta itemprop="position" content="1" /></f> &rsaquo; <f class="current" itemprop="itemListElement" itemscope="itemscope" itemtype="https://schema.org/ListItem"><span itemprop="name">About</span><meta itemprop="item" content="http://test.host/about" /><meta itemprop="position" content="2" /></f></c>},
                  breadcrumbs(container_tag: :c, fragment_tag: :f, semantic: true).to_s
   end
 

data/test/test_helper.rb

@@ -9,7 +9,7 @@ SimpleCov.start do
   ])
 end
 
-SimpleCov.minimum_coverage 99 # TODO: Get to 100!
+SimpleCov.minimum_coverage 100
 
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Lasse Bunk
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2020-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails