gretel-jsonld 0.3.0 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e7bf55860ae8f21a3d5a931806e9c550cf4e1d31af9546703d86d125d14c00e
-  data.tar.gz: 3286dab9d4dbcc9b9e61a7e4528359ada4e3cb63e59af75a40c765497d2e3c68
+  metadata.gz: b8ed941958ee879b901c34cc71df02879f48d39da255bf3adb6d41597792833e
+  data.tar.gz: bd4529a8789dbc6bffcc1deced291dd59e01a7cd5524a93cfa9a48f87e303e72
 SHA512:
-  metadata.gz: 79b86b733f968da7bca93b29a9ca65486783bb814ebf396d3906ae7ca9646d3b952c36f65a26c99ba191d4edc954ce7af855999b51a320f46ce9d50d7472564c
-  data.tar.gz: 16b507af8635110bece74b61f433cc401ae4bf2140414f0ab0ac3c73abb07c9eedc7cb7191b4988660c5d94b760f67c3f648c74cfcbe90530704ec1bafdae804
+  metadata.gz: 237c2f713dc99b29a7ff3986ef6a34ab9d78eb738020d2325e01f583eab1e8115c7d28160e894249cd06119ffab794fcc7aa4621c77d542618e8b5f61b202c37
+  data.tar.gz: 4f85e13c1f0606c0b841309e7591af2b82033e081e5ca8edda74cfab2a6b84aa7f8331aecd35b9365b0ba0458065d30317786c0a96e8c421f062288190013018

data/CHANGELOG.md

@@ -1,15 +1,28 @@
 # CHANGELOG
+
+## [1.0.0.rc1](https://github.com/yasaichi/gretel-jsonld/releases/tag/v1.0.0.rc1) (July 23, 2026)
+
+* [Generate valid breadcrumb item URLs](https://github.com/yasaichi/gretel-jsonld/pull/28)
+* [Document effective Gretel options](https://github.com/yasaichi/gretel-jsonld/pull/27)
+* [Load Railtie only when available](https://github.com/yasaichi/gretel-jsonld/pull/24)
+* [Specify minimum Rails dependencies](https://github.com/yasaichi/gretel-jsonld/pull/21)
+* [Support Gretel 4 and 5](https://github.com/yasaichi/gretel-jsonld/pull/19)
+
 ## [0.3.0](https://github.com/yasaichi/gretel-jsonld/releases/tag/v0.3.0) (July 22, 2026)
+
 * [Test against Rails 6 through 8](https://github.com/yasaichi/gretel-jsonld/pull/18)
 * [Drop support for Ruby 2.4 and earlier](https://github.com/yasaichi/gretel-jsonld/pull/16)
 
 ## [0.2.0](https://github.com/yasaichi/gretel-jsonld/releases/tag/v0.2.0) (November 25, 2017)
+
 * [Write README](https://github.com/yasaichi/gretel-jsonld/pull/7)
 * [Use `JSONLD` as module name instead of `Jsonld`](https://github.com/yasaichi/gretel-jsonld/pull/6)
 * [Specify the required Ruby version](https://github.com/yasaichi/gretel-jsonld/pull/5)
 
 ## [0.1.1](https://github.com/yasaichi/gretel-jsonld/releases/tag/v0.1.1) (November 25, 2017)
+
 * [Cope with Rails 4.0 or former](https://github.com/yasaichi/gretel-jsonld/pull/4)
 
 ## [0.1.0](https://github.com/yasaichi/gretel-jsonld/releases/tag/v0.1.0) (November 23, 2017)
+
 * The initial release to reserve the gem name

data/README.md

@@ -2,46 +2,44 @@
 
 [![Gem Version](https://badge.fury.io/rb/gretel-jsonld.svg)](http://badge.fury.io/rb/gretel-jsonld)
 [![CI](https://github.com/yasaichi/gretel-jsonld/actions/workflows/ci.yml/badge.svg)](https://github.com/yasaichi/gretel-jsonld/actions/workflows/ci.yml)
-[![Maintainability](https://qlty.sh/gh/yasaichi/projects/gretel-jsonld/maintainability.svg)](https://qlty.sh/gh/yasaichi/projects/gretel-jsonld)
 [![Code Coverage](https://qlty.sh/gh/yasaichi/projects/gretel-jsonld/coverage.svg)](https://qlty.sh/gh/yasaichi/projects/gretel-jsonld)
 
-gretel-jsonld enables gretel gem to handle JSON-LD based breadcrumbs.
+gretel-jsonld enables [gretel](https://github.com/kzkn/gretel) to generate
+breadcrumbs using JSON-LD structured data.
 
 ## Installation
 
-Add this line to your application's `Gemfile`:
+In your `Gemfile`:
 
 ```ruby
-gem 'gretel-jsonld'
+gem "gretel-jsonld"
 ```
 
-And then execute:
+And run:
 
 ```bash
-$ bundle
+$ bundle install
 ```
 
-## Usage
+## Example
 
-First, run the installation generator with:
+Start by generating the breadcrumbs configuration file:
 
 ```sh
 $ rails generate gretel:install
 ```
 
-Next, define "crumbs" in `config/breadcrumbs.rb`:
+Then, in `config/breadcrumbs.rb`:
 
 ```ruby
-# See also: https://github.com/lassebunk/gretel#more-examples
-
 # Root crumb
 crumb :root do
-  link 'Home', root_path
+  link "Home", root_path
 end
 
 # Issue list
 crumb :issues do
-  link 'All issues', issues_path
+  link "All issues", issues_path
 end
 
 # Issue
@@ -51,19 +49,21 @@ crumb :issue do |issue|
 end
 ```
 
-Then, add this line to your application's layout:
+At the top of `app/views/issues/show.html.erb`, set the current breadcrumb
+(assuming you have loaded `@issue` with an issue):
 
 ```erb
-<%= jsonld_breadcrumbs %>
+<% breadcrumb :issue, @issue %>
 ```
 
-Finally, specify a current breadcrumb in each view:
+Then, in `app/views/layouts/application.html.erb`:
 
 ```erb
-<% breadcrumb :issue, @issue %>
+<%= jsonld_breadcrumbs %>
 ```
 
-This will generate the following breadcrumbs, marked up with JSON-LD (indented for readability):
+For a request to `https://example.com/issues/46`, this will generate the
+following JSON-LD (indented for readability):
 
 ```html
 <script type="application/ld+json">
@@ -75,7 +75,7 @@ This will generate the following breadcrumbs, marked up with JSON-LD (indented f
         "@type": "ListItem",
         "position": 1,
         "item": {
-          "@id": "/",
+          "@id": "https://example.com/",
           "name": "Home"
         }
       },
@@ -83,7 +83,7 @@ This will generate the following breadcrumbs, marked up with JSON-LD (indented f
         "@type": "ListItem",
         "position": 2,
         "item": {
-          "@id": "/issues",
+          "@id": "https://example.com/issues",
           "name": "All issues"
         }
       },
@@ -91,7 +91,7 @@ This will generate the following breadcrumbs, marked up with JSON-LD (indented f
         "@type": "ListItem",
         "position": 3,
         "item": {
-          "@id": "/issues/46",
+          "@id": "https://example.com/issues/46",
           "name": "My Issue"
         }
       }
@@ -102,25 +102,56 @@ This will generate the following breadcrumbs, marked up with JSON-LD (indented f
 
 ## Options
 
-You can pass `jsonld_breadcrumbs` the same options as `breadcrumbs`:
+You can pass options to `<%= jsonld_breadcrumbs %>`, e.g.:
 
 ```erb
-<%= jsonld_breadcrumbs link_current_to_request_path: false %>
+<%= jsonld_breadcrumbs autoroot: false, link_current_to_request_path: false %>
 ```
 
-For further information, please see [gretel's documentation](https://github.com/WilHall/gretel/blob/develop/README.md#options).
+Options that change the breadcrumb collection also affect the JSON-LD output:
+
+Option                   | Description                                                                                                                 | Default
+------------------------ | --------------------------------------------------------------------------------------------------------------------------- | -------
+:autoroot                | Whether it should automatically add the `:root` crumb to the `BreadcrumbList` if no parent is given.                       | True
+:display_single_fragment | Whether it should output the `BreadcrumbList` if it includes only one item.                                                  | False
+:link_current_to_request_path | Whether the current crumb's `item.@id` in the `BreadcrumbList` should always use the current request path.                    | True
+
+Options concerned only with HTML presentation do not change the JSON-LD
+output. For example, `link_current` controls whether the current crumb is
+rendered as an HTML link, but the current crumb always includes `item.@id` in
+JSON-LD.
+
+For further information, please see
+[Gretel's documentation](https://github.com/kzkn/gretel#options).
+
+## Nice to know
+
+### Breadcrumb URLs
+
+Relative breadcrumb paths are resolved against the current request's base URL.
+Absolute breadcrumb URLs are used as-is.
+
+Breadcrumbs without link URLs are omitted from the JSON-LD output because each
+breadcrumb item is identified by `@id`, whose value must be an IRI reference
+under the
+[JSON-LD specification](https://www.w3.org/TR/json-ld11/#node-objects).
 
 ## Supported versions
 
-Note that gretel-jsonld doesn't support all versions of gretel, Ruby and Rails:
+gretel-jsonld supports gretel 3.0 or later without an upper version bound.
+The supported version ranges are:
+
+| gretel | Rails | Ruby |
+| --- | --- | --- |
+| 3.x | 5.x | 2.5 or later |
+| 4.x | 5.1 through 7.1 | 2.5 or later |
+| 5.x | 6.1 or later | 3.0 or later |
 
-- gretel: gretel-jsonld supports **only 3.x** for now
-- Ruby: gretel 3.x supports **1.9.3 or later**, but gretel-jsonld does **only 2.5 or later**
-- Rails: gretel 3.x supports **3.1 or later**, but gretel-jsonld does **only 5 or later**
+CI covers the lowest and highest supported Rails majors for each gretel major.
 
 ## Contributing
 
-You should follow the steps below:
+To contribute:
 
 1. [Fork the repository](https://help.github.com/articles/fork-a-repo/)
 2. Create a feature branch: `git checkout -b add-new-feature`

data/lib/gretel/jsonld/breadcrumb/list.rb

@@ -1,41 +1,21 @@
 # frozen_string_literal: true
 
 require "json"
-require "active_support"
-require "active_support/json/encoding"
-require "gretel/jsonld/breadcrumb/list_item"
 
 module Gretel
   module JSONLD
     module Breadcrumb
       class List
-        def initialize(link_collection)
-          @link_collection = link_collection
+        def initialize(items)
+          @items = items
         end
 
-        # NOTE: Override #as_json to cope with Rails 4.0 or former
-        def as_json(options = nil)
+        def to_json(*args)
           {
             "@context": "http://schema.org",
             "@type": "BreadcrumbList",
-            itemListElement: item_list_element,
-          }.as_json(options)
-        end
-
-        def to_json(*args)
-          as_json.to_json(*args)
-        end
-
-        private
-
-        def item_list_element
-          @link_collection.map.with_index(1) do |link, index|
-            ::Gretel::JSONLD::Breadcrumb::ListItem.new(
-              id: link.url,
-              name: link.text,
-              position: index,
-            )
-          end
+            itemListElement: @items
+          }.to_json(*args)
         end
       end
     end

data/lib/gretel/jsonld/breadcrumb/list_item.rb

@@ -1,33 +1,26 @@
 # frozen_string_literal: true
 
 require "json"
-require "active_support"
-require "active_support/json/encoding"
 
 module Gretel
   module JSONLD
     module Breadcrumb
       class ListItem
-        def initialize(id:, name:, position:)
-          @id = id
-          @name = name
+        def initialize(position:, title:, url:)
           @position = position
+          @title = title
+          @url = url
         end
 
-        # NOTE: Override #as_json to cope with Rails 4.0 or former
-        def as_json(options = nil)
+        def to_json(*args)
           {
             "@type": "ListItem",
             position: @position,
             item: {
-              "@id": @id,
-              name: @name,
+              "@id": @url,
+              name: @title
             }
-          }.as_json(options)
-        end
-
-        def to_json(*args)
-          as_json.to_json(*args)
+          }.to_json(*args)
         end
       end
     end

data/lib/gretel/jsonld/railtie.rb

@@ -1,15 +1,14 @@
 # frozen_string_literal: true
 
-require "active_support"
 require "active_support/lazy_load_hooks"
-require "rails/railtie"
+require "gretel/jsonld/view_helpers"
 
 module Gretel
   module JSONLD
     class Railtie < ::Rails::Railtie
-      initializer "gretel.jsonld" do
+      initializer "gretel.jsonld", after: "gretel.view_helpers" do
         ::ActiveSupport.on_load(:action_view) do
-          require "gretel/jsonld/view_helpers"
+          include ::Gretel::JSONLD::ViewHelpers
         end
       end
     end

data/lib/gretel/jsonld/renderer.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-require "json"
 require "active_support"
 require "active_support/core_ext/string/output_safety"
+require "json"
 require "gretel/jsonld/breadcrumb/list"
+require "gretel/jsonld/breadcrumb/list_item"
+require "uri"
 
 module Gretel
   module JSONLD
@@ -17,10 +19,28 @@ module Gretel
 
         @view_context.content_tag(
           :script,
-          JSON.generate(::Gretel::JSONLD::Breadcrumb::List.new(link_collection)).html_safe,
+          JSON.generate(to_breadcrumb_list(link_collection)).html_safe,
           type: "application/ld+json",
         )
       end
+
+      private
+
+      def resolve_uri(uri_reference)
+        ::URI.join(@view_context.request.base_url, uri_reference)
+      end
+
+      def to_breadcrumb_list(link_collection)
+        link_collection
+          .select { |link, _| link.url }
+          .map.with_index(1) { |link, position|
+            ::Gretel::JSONLD::Breadcrumb::ListItem.new(
+              position: position,
+              title: link.text,
+              url: resolve_uri(link.url),
+            )
+          }.yield_self { |items| ::Gretel::JSONLD::Breadcrumb::List.new(items) }
+      end
     end
   end
 end

data/lib/gretel/jsonld/version.rb

@@ -2,6 +2,6 @@
 
 module Gretel
   module JSONLD
-    VERSION = "0.3.0".freeze
+    VERSION = "1.0.0.rc1".freeze
   end
 end

data/lib/gretel/jsonld/view_helpers.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "action_view"
 require "gretel"
 require "gretel/jsonld/renderer"
 
@@ -19,5 +18,3 @@ module Gretel
     end
   end
 end
-
-ActionView::Base.include(Gretel::JSONLD::ViewHelpers)

data/lib/gretel/jsonld.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require "action_view"
 require "gretel/jsonld/version"
 
-if defined?(Rails)
+if defined?(Rails::Railtie)
   require "gretel/jsonld/railtie"
 else
   require "gretel/jsonld/view_helpers"
+  ActionView::Base.include(Gretel::JSONLD::ViewHelpers)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gretel-jsonld
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - yasaichi
@@ -9,20 +9,48 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: gretel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -51,6 +79,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +122,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rails-omakase
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,7 +136,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,7 +150,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="