page_structured_data 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f54fe0fb4f902e3b2c795720a871f085b2ce05489f06f16239cb92549c4961aa
-  data.tar.gz: a41c5888a2bdcad023a91546ffd40d7756c4909a86edf567579960929d9c7d6f
+  metadata.gz: 5edbf7a0036c6b78d602900b3910cdeb8ee5a16920b47ac9ddaf2411a90f68c9
+  data.tar.gz: ae1930791919d1fecd18c525a5b01eb3bb782caf197604461bb17d882d508fd2
 SHA512:
-  metadata.gz: dbd5383be779c9c23302693f05685d606f40e82de5bc5bf75461a60d53ad0aa3db14f50446cbf6cbefe50c8c04925accdb4323f7734892093cbc2a1818083a97
-  data.tar.gz: 8103d194f775fea6308c8ce8defa7dfd6c8fe341c61dcfbd92dc873577c0a18be26292280ddfa5579ff10838826d73b7331081358cc1567e2960e41b9dff135f
+  metadata.gz: 5f116fb5b5a52658001b8a39fd5820885a8aa71bd0403d901c0f316b0f0541470d9274d55e67f1ee16d53400dcb31aba40364b60e6a1fed3574d7871679c78b0
+  data.tar.gz: 23d1d8e077b2b3780b7826a892b7a1636814941e0fbd339f8421a905d5b1d3d4bb6191da0cc529db428c8534da1f3818818da1048d11b7d876a26d32b8b85f45

data/CHANGELOG.md

@@ -4,6 +4,19 @@ All notable changes to this project are documented here.
 
 ## Unreleased
 
+## 1.0.5 - 2026-05-06
+
+- Add tests for HTML escaping in rendered meta tags.
+- Add tests for script-breaking content in JSON-LD output.
+- Add broader JSON-LD escaping coverage for breadcrumbs and article data.
+- Extract shared article JSON-LD behavior for `BlogPosting` and `NewsArticle`.
+- Add `to_h` schema hash APIs for breadcrumbs and article page types.
+- Add tests for pages that render both breadcrumb and page type JSON-LD.
+- Align the gemspec Ruby requirement with the Rails 7 baseline.
+- Add GitHub Actions CI for tests, require verification, and gem build verification.
+- Constrain the Rails dependency to Rails 7.x, matching the tested support baseline.
+- Add `render_default_breadcrumb_json_ld` config to opt out of current-page-only breadcrumb JSON-LD.
+
 ## 1.0.4 - 2026-05-06
 
 - Replace the bundled Slim meta tags partial with ERB so applications are not required to use Slim.

data/README.md

@@ -17,8 +17,10 @@ It helps Rails applications render:
 
 ## Requirements
 
-- Rails 7.0 or newer
-- A Ruby version supported by your Rails version
+- Rails 7.x
+- Ruby 2.7 or newer
+
+Rails 7.0 requires Ruby 2.7 or newer, so this gem follows that same baseline. Rails 8 is not declared as supported yet; add CI coverage before widening the Rails dependency.
 
 ## Installation
 
@@ -43,12 +45,15 @@ Configure application-wide defaults in an initializer:
 Rails.application.config.after_initialize do
   PageStructuredData.config do |config|
     config.base_app_name = "AwesomestApp"
+    config.render_default_breadcrumb_json_ld = true
   end
 end
 ```
 
 `base_app_name` is appended to generated page titles.
 
+`render_default_breadcrumb_json_ld` controls whether pages without an explicit breadcrumb render current-page-only breadcrumb JSON-LD. It defaults to `true` for backward compatibility. Set it to `false` if you only want breadcrumb JSON-LD when a `PageStructuredData::Breadcrumbs` object is passed to the page.
+
 For example:
 
 ```ruby
@@ -125,7 +130,7 @@ Pass the breadcrumbs into the page object:
 
 This renders `BreadcrumbList` JSON-LD similar to Google's breadcrumb structured data format.
 
-Current compatibility note: when no breadcrumb object is passed, `PageStructuredData::Page` still creates an empty breadcrumb trail for the current page. This is existing behavior and should be considered part of the current public API.
+Current compatibility note: when no breadcrumb object is passed, `PageStructuredData::Page` renders current-page-only breadcrumb JSON-LD by default. To opt out, set `config.render_default_breadcrumb_json_ld = false`.
 
 ## Article Page Types
 
@@ -196,6 +201,7 @@ PageStructuredData::Breadcrumbs.new(
 Important methods:
 
 - `titles`: returns breadcrumb titles.
+- `to_h(current_page_title:)`: returns a structured hash for `BreadcrumbList` JSON-LD.
 - `json_ld(current_page_title:)`: returns a `BreadcrumbList` JSON-LD script tag.
 
 ### Article Page Types
@@ -222,6 +228,11 @@ PageStructuredData::PageTypes::NewsArticle.new(
 
 `authors` should be an array of hashes with `:name` and `:url` keys.
 
+Important methods:
+
+- `to_h`: returns a structured hash for article JSON-LD.
+- `json_ld`: returns an article JSON-LD script tag.
+
 ## Development
 
 Run the test suite:

data/app/src/page_structured_data/breadcrumbs.rb

@@ -13,15 +13,28 @@ module PageStructuredData
       hierarchy.pluck(:title)
     end
 
-    def json_ld(current_page_title:) # rubocop:disable Metrics/MethodLength
-      node = {
+    def to_h(current_page_title:) # rubocop:disable Metrics/MethodLength
+      {
         '@context': 'https://schema.org',
         '@type': 'BreadcrumbList',
-        'itemListElement': [],
-      }.with_indifferent_access
+        'itemListElement': item_list_elements(current_page_title: current_page_title),
+      }
+    end
+
+    def json_ld(current_page_title:)
+      %(
+      <script type="application/ld+json">
+        #{to_h(current_page_title: current_page_title).to_json}
+        </script>
+      )
+    end
 
+    private
+
+    def item_list_elements(current_page_title:)
       items = []
       count = 0
+
       @hierarchy.each do |page|
         items << {
           '@type': 'ListItem',
@@ -36,14 +49,6 @@ module PageStructuredData
         position: (count += 1),
         name: current_page_title,
       }
-
-      node['itemListElement'] = items
-
-      %(
-      <script type="application/ld+json">
-        #{node.to_json}
-        </script>
-      )
     end
   end
 end

data/app/src/page_structured_data/page.rb

@@ -13,8 +13,6 @@ module PageStructuredData
       @extra_title = extra_title
       @breadcrumb = breadcrumb
       @page_type = page_type
-
-      @breadcrumb = Breadcrumbs.new if breadcrumb.blank?
     end
 
     def title_with_hierarchies
@@ -33,13 +31,20 @@ module PageStructuredData
 
     def json_lds
       output = []
-      output << breadcrumb.json_ld(current_page_title: title) if breadcrumb.present?
+      output << breadcrumb_json_ld if (breadcrumb_json_ld = self.breadcrumb_json_ld).present?
       output << page_type.json_ld if page_type.present?
       output.join
     end
 
     private
 
+    def breadcrumb_json_ld
+      return breadcrumb.json_ld(current_page_title: title) if breadcrumb.present?
+      return unless PageStructuredData.render_default_breadcrumb_json_ld
+
+      Breadcrumbs.new.json_ld(current_page_title: title)
+    end
+
     def base_app_name
       PageStructuredData.base_app_name
     end

data/app/src/page_structured_data/page_types/article.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module PageStructuredData
+  module PageTypes
+    # Shared structured data for schema.org article-like page types.
+    class Article
+      attr_reader :headline, :images, :published_at, :updated_at, :authors
+
+      def initialize(headline:, published_at:, updated_at:, images: [], authors: [])
+        @headline = headline
+        @images = images
+        @published_at = published_at
+        @updated_at = updated_at
+        @authors = authors
+      end
+
+      def to_h
+        {
+          '@context': 'https://schema.org',
+          '@type': schema_type,
+          headline: headline,
+          image: images,
+          datePublished: published_at,
+          dateModified: updated_at,
+          author: authors.map do |author|
+            {
+              '@type': 'Person',
+              name: author[:name],
+              url: author[:url],
+            }
+          end,
+        }
+      end
+
+      def json_ld
+        %(
+        <script type="application/ld+json">
+          #{to_h.to_json}
+          </script>
+        )
+      end
+
+      private
+
+      def schema_type
+        raise NotImplementedError, "#{self.class.name} must define #schema_type"
+      end
+    end
+  end
+end

data/app/src/page_structured_data/page_types/blog_posting.rb

@@ -3,43 +3,11 @@
 module PageStructuredData
   module PageTypes
     # Basic page metadata for any page
-    class BlogPosting
-      attr_reader :headline, :images, :published_at, :updated_at, :authors
+    class BlogPosting < Article
+      private
 
-      def initialize(headline:, published_at:, updated_at:, images: [], authors: [])
-        @headline = headline
-        @images = images
-        @published_at = published_at
-        @updated_at = updated_at
-        @authors = authors
-      end
-
-      def json_ld # rubocop:disable Metrics/MethodLength
-        node = {
-          '@context': 'https://schema.org',
-          '@type': 'BlogPosting',
-        }
-
-        node[:headline] = headline
-        node[:image] = images
-        node[:datePublished] = published_at
-        node[:dateModified] = updated_at
-
-        author_hash = authors.map do |author|
-          {
-            '@type': 'Person',
-            name: author[:name],
-            url: author[:url],
-          }
-        end
-
-        node[:author] = author_hash
-
-        %(
-        <script type="application/ld+json">
-          #{node.to_json}
-          </script>
-        )
+      def schema_type
+        'BlogPosting'
       end
     end
   end

data/app/src/page_structured_data/page_types/news_article.rb

@@ -3,43 +3,11 @@
 module PageStructuredData
   module PageTypes
     # Basic page metadata for any page
-    class NewsArticle
-      attr_reader :headline, :images, :published_at, :updated_at, :authors
+    class NewsArticle < Article
+      private
 
-      def initialize(headline:, published_at:, updated_at:, images: [], authors: [])
-        @headline = headline
-        @images = images
-        @published_at = published_at
-        @updated_at = updated_at
-        @authors = authors
-      end
-
-      def json_ld # rubocop:disable Metrics/MethodLength
-        node = {
-          '@context': 'https://schema.org',
-          '@type': 'NewsArticle',
-        }
-
-        node[:headline] = headline
-        node[:image] = images
-        node[:datePublished] = published_at
-        node[:dateModified] = updated_at
-
-        author_hash = authors.map do |author|
-          {
-            '@type': 'Person',
-            name: author[:name],
-            url: author[:url],
-          }
-        end
-
-        node[:author] = author_hash
-
-        %(
-        <script type="application/ld+json">
-          #{node.to_json}
-          </script>
-        )
+      def schema_type
+        'NewsArticle'
       end
     end
   end

data/lib/page_structured_data/version.rb

@@ -1,3 +1,3 @@
 module PageStructuredData
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/lib/page_structured_data.rb

@@ -4,9 +4,16 @@ require "page_structured_data/engine"
 module PageStructuredData
   class << self
     attr_accessor :base_app_name
+    attr_writer :render_default_breadcrumb_json_ld
 
     def config
       yield self
     end
+
+    def render_default_breadcrumb_json_ld
+      return true if @render_default_breadcrumb_json_ld.nil?
+
+      @render_default_breadcrumb_json_ld
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: page_structured_data
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Jey Geethan
@@ -14,6 +14,9 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0
@@ -21,6 +24,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0
@@ -47,6 +53,7 @@ files:
 - app/src/page_structured_data/anchors.rb
 - app/src/page_structured_data/breadcrumbs.rb
 - app/src/page_structured_data/page.rb
+- app/src/page_structured_data/page_types/article.rb
 - app/src/page_structured_data/page_types/blog_posting.rb
 - app/src/page_structured_data/page_types/news_article.rb
 - app/views/layouts/page_structured_data/application.html.erb
@@ -75,7 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="