gretel 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d28cb34acf4eef47659c295f4dfd63b442fa7181552de3716015eb4f2d070c8f
-  data.tar.gz: e8cb450b18ea1f00dffc6e580655931109ddd1389cafce109b1ab597e832761a
+  metadata.gz: b80e71f865388974401274f84159318e012a5e9e40800888549453e301881bec
+  data.tar.gz: 06d1a078802e9b8d175f17376c7534ba8004c15327e2fc75b0e01e9386653cb8
 SHA512:
-  metadata.gz: a7b13ae376b35bfc5508472752bfac4cd98022a19d7e00e0c8535ba1aa7c44e07a5f5068d98c2ca364ad6d1f25adc8671090ef9ac7f2879328273c94a8ac4e1b
-  data.tar.gz: 0e1451f51c1c2742c339a0b08489b2b503c3c751402eb432d0498b1b9ad2b44a1be2abf568c5f7387fed67aca07d959eb5bf9a41eb90d25f7b50beea3b6e09b4
+  metadata.gz: 3b8c092e5e04c48099f0fcad18230b89a6f4c11e760d59f89f629792cb4225eb5db1cf4648c8a6145c6be99bcf104b0d08ee0b74b82d39d1e7b9e366fda6ea37
+  data.tar.gz: 582e6471d0fa5fb59d490bee9a41b1cdd7b0f419b107c9acb56914832ad5b3a5dfc5c4590918dcb38ea46495a0df2578ceeb5e6384e57c0ed7e37ab8e39ea3e7

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # 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

data/README.md

@@ -219,6 +219,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.

data/lib/gretel/renderer.rb

@@ -159,6 +159,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)
@@ -192,7 +213,7 @@ module Gretel
         end
 
         html = html_fragments.join(" ").html_safe
-        
+
         if options[:semantic]
           content_tag(options[:container_tag], html, id: options[:id], class: options[:class], itemscope: "", itemtype: "https://schema.org/BreadcrumbList")
         else

data/lib/gretel/version.rb

@@ -1,3 +1,3 @@
 module Gretel
-  VERSION = "4.1.0"
+  VERSION = "4.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Lasse Bunk
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-20 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties