page_structured_data 1.0.14 → 1.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e36ab494ebd4db8743deb6d8415e826c2186f7c28a7e2927c8a08df4decabd6
-  data.tar.gz: b48c8723a6ad4a3ee5aa44be5e6b36d6764abbd433a3daedb1e3278f32cf7b2b
+  metadata.gz: f455392a943824c8c84fbeb1a95e0250d9f959f98c8e5361c5d57d1f38140d91
+  data.tar.gz: 306f4a1246e196db8a7e58bb89aa1a73454c3fc873c3431818a1c0b2cdb5bc93
 SHA512:
-  metadata.gz: 1c9dd473ced4959c0acc17940b212d0c71b760efe3a0cfe119d74845ab10b76e081363b26d4138f6b5d66a5e62d0f7c36623c5603ac78ec8565350e2cd53dbcf
-  data.tar.gz: eefd736852c02d3ec1f02a58e7911f931d8882ce09854364c9b028cd1a11aa1872c3fe1a79beb4c379b8468e1b3db7871a00331dc47522573da9abc64bfa6dce
+  metadata.gz: 6a0261a5b6a280806f36fccea7676b6f0656e0fab4f0ab3f13087984923f904b0895a88921527783bdbecaa30c3f653ee16ee8e1fd4dfdc88a294047203fa093
+  data.tar.gz: f8cc5db7758b6170705eb55fa53208d1b38f5cf69343e734c6e62ded077916cc7d74ff7d8a54cbff7ecbed287cbe2f8fc5aaab77c0f425abcf97610837075872

data/CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to this project are documented here.
 
 ## Unreleased
 
+## 1.0.15 - 2026-08-01
+
+- Add optional page-level `social_description` support for distinct Open Graph
+  and X/Twitter descriptions with fallback to the standard SEO description.
+- Escape JSON-LD independently of host-app Active Support configuration before
+  rendering script tags as HTML-safe.
+- Stop rendering invalid current-page-only breadcrumb JSON-LD while preserving
+  explicit breadcrumb hierarchies.
+- Render Google-compatible `text` for discussion forum posts while retaining
+  `articleBody` for backward compatibility, and warn when author or post
+  content is missing.
+- Ensure the documented `rake test` command executes the complete Rails test
+  suite and constrain test dependencies to compatible Minitest and Rails 7.0
+  SQLite lines.
+
 ## 1.0.14 - 2026-07-05
 
 - Add page-level `robots` meta tag support.

data/README.md

@@ -51,15 +51,12 @@ 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
@@ -98,6 +95,7 @@ Set `@page_meta` in the controller or view before the layout renders:
   title: "Home",
   extra_title: "Official Page",
   description: "Welcome to my page",
+  social_description: "See what is new on my page",
   image: image_url("social/home.png"),
   canonical_url: home_url,
   fallback_image: image_url("social/default.png"),
@@ -105,6 +103,12 @@ Set `@page_meta` in the controller or view before the layout renders:
 )
 ```
 
+`description` renders the standard SEO description. `social_description` is
+optional and renders the Open Graph and X/Twitter descriptions when it is
+nonblank. When `social_description` is nil or blank, those social tags fall
+back to `description`. This allows intentional social copy without changing the
+standard SEO description.
+
 The generated title is built from:
 
 1. `title`
@@ -139,7 +143,11 @@ 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` renders current-page-only breadcrumb JSON-LD by default. To opt out, set `config.render_default_breadcrumb_json_ld = false`.
+Breadcrumb JSON-LD renders only when the resulting list contains at least two
+items. Pages without a breadcrumb hierarchy do not emit a current-page-only
+list because Google does not accept one-item breadcrumb data. The existing
+`render_default_breadcrumb_json_ld` configuration remains accepted for
+compatibility, but it cannot make an invalid one-item list render.
 
 ## Structured Page Types
 
@@ -378,6 +386,8 @@ post_page_type = PageStructuredData::PageTypes::DiscussionForumPosting.new(
 ```
 
 Only pass engagement counts that are public and visible on the rendered page.
+`DiscussionForumPosting` renders the supplied `text` as both `text` and the
+backward-compatible `articleBody` property.
 
 ### Page-Local Site Name
 
@@ -401,7 +411,7 @@ PageStructuredData::Page.new(
 
 ### Breadcrumb JSON-LD Control
 
-Control generated breadcrumb JSON-LD per page:
+Suppress an explicit breadcrumb hierarchy for one page:
 
 ```ruby
 PageStructuredData::Page.new(
@@ -410,16 +420,9 @@ PageStructuredData::Page.new(
 )
 ```
 
-When the global default is disabled, a page can still opt in:
-
-```ruby
-PageStructuredData.render_default_breadcrumb_json_ld = false
-
-PageStructuredData::Page.new(
-  title: "Standalone Page",
-  render_breadcrumb_json_ld: true
-)
-```
+Pages need at least one hierarchy item plus the current page before breadcrumb
+JSON-LD renders. Setting `render_breadcrumb_json_ld: true` does not synthesize
+missing hierarchy data.
 
 ### Paginated Archive
 
@@ -452,6 +455,7 @@ PageStructuredData::Page.new(
 PageStructuredData::Page.new(
   title:,
   description: nil,
+  social_description: nil,
   image: nil,
   extra_title: "",
   breadcrumb: nil,
@@ -465,8 +469,11 @@ PageStructuredData::Page.new(
 )
 ```
 
+`social_description` overrides `description` for Open Graph and X/Twitter
+description tags when nonblank. It does not change the standard SEO description
+tag.
 `base_app_name` overrides `PageStructuredData.base_app_name` for one page. Pass an empty string to suppress the global app name for a specific page.
-`render_breadcrumb_json_ld` can be set to `true` or `false` for one page. Leave it as `nil` to use the global `PageStructuredData.render_default_breadcrumb_json_ld` behavior for generated default breadcrumbs. Explicit breadcrumb objects still render when the global default is disabled unless the page sets `render_breadcrumb_json_ld: false`.
+`render_breadcrumb_json_ld` can be set to `false` to suppress an explicit breadcrumb object. A true value never renders a breadcrumb list with fewer than two items.
 `robots` can be a string or array and renders a `<meta name="robots">` tag when present.
 
 Important methods:
@@ -474,6 +481,7 @@ Important methods:
 - `page_title`: returns the composed page title.
 - `json_lds`: returns the JSON-LD script tags for breadcrumbs and page type data.
 - `resolved_image`: returns `image` or `fallback_image`.
+- `resolved_social_description`: returns a nonblank `social_description` or falls back to `description`.
 - `robots_content`: returns the rendered robots directives.
 - `warnings`: returns soft validation warnings for the page and page types.
 - `valid?`: returns `true` when `warnings` is empty.

data/Rakefile

@@ -6,3 +6,8 @@ load "rails/tasks/engine.rake"
 load "rails/tasks/statistics.rake"
 
 require "bundler/gem_tasks"
+
+desc "Run the complete test suite"
+task :test do
+  ruby File.expand_path("bin/rails", __dir__), "test"
+end

data/app/src/page_structured_data/breadcrumbs.rb

@@ -22,11 +22,10 @@ module PageStructuredData
     end
 
     def json_ld(current_page_title:)
-      %(
-      <script type="application/ld+json">
-        #{to_h(current_page_title: current_page_title).to_json}
-        </script>
-      )
+      node = to_h(current_page_title: current_page_title)
+      return if node[:itemListElement].size < 2
+
+      JsonLd.script_tag(node)
     end
 
     private

data/app/src/page_structured_data/json_ld.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/output_safety'
+
+module PageStructuredData
+  # Builds JSON-LD script tags with escaping that does not depend on host-app
+  # Active Support configuration.
+  module JsonLd
+    module_function
+
+    def script_tag(node)
+      json = ActiveSupport::JSON.encode(node)
+      escaped_json = ERB::Util.json_escape(json)
+
+      %(
+      <script type="application/ld+json">
+        #{escaped_json}
+        </script>
+      )
+    end
+  end
+end

data/app/src/page_structured_data/page.rb

@@ -3,14 +3,15 @@
 module PageStructuredData
   # Basic page metadata for any page
   class Page
-    attr_reader :title, :description, :image, :extra_title, :breadcrumb, :page_type, :page_types, :canonical_url,
-                :fallback_image, :base_app_name, :render_breadcrumb_json_ld, :robots
+    attr_reader :title, :description, :social_description, :image, :extra_title, :breadcrumb, :page_type, :page_types,
+                :canonical_url, :fallback_image, :base_app_name, :render_breadcrumb_json_ld, :robots
 
-    def initialize(title:, description: nil, image: nil, # rubocop:disable Metrics/ParameterLists
+    def initialize(title:, description: nil, social_description: nil, image: nil, # rubocop:disable Metrics/ParameterLists
                    extra_title: '', breadcrumb: nil, page_type: nil, page_types: nil, canonical_url: nil,
                    fallback_image: nil, base_app_name: nil, render_breadcrumb_json_ld: nil, robots: nil)
       @title = title
       @description = description
+      @social_description = social_description
       @image = image
       @extra_title = extra_title
       @breadcrumb = breadcrumb
@@ -48,6 +49,10 @@ module PageStructuredData
       image || fallback_image
     end
 
+    def resolved_social_description
+      social_description.presence || description
+    end
+
     def robots_content
       Array(robots).compact.join(',')
     end

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

@@ -60,11 +60,7 @@ module PageStructuredData
       end
 
       def json_ld
-        %(
-        <script type="application/ld+json">
-          #{to_h.to_json}
-          </script>
-        )
+        JsonLd.script_tag(to_h)
       end
 
       def warnings

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

@@ -4,11 +4,28 @@ module PageStructuredData
   module PageTypes
     # schema.org structured data for discussion forum posts.
     class DiscussionForumPosting < Article
+      def to_h
+        super.tap do |node|
+          node[:text] = article_body if article_body.present?
+        end
+      end
+
+      def warnings
+        super + discussion_forum_warnings
+      end
+
       private
 
       def schema_type
         'DiscussionForumPosting'
       end
+
+      def discussion_forum_warnings
+        warnings = []
+        warnings << 'author is required' if authors.empty?
+        warnings << 'text or image is required' unless article_body.present? || images.any?(&:present?)
+        warnings
+      end
     end
   end
 end

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

@@ -33,11 +33,7 @@ module PageStructuredData
       end
 
       def json_ld
-        %(
-        <script type="application/ld+json">
-          #{to_h.to_json}
-          </script>
-        )
+        JsonLd.script_tag(to_h)
       end
 
       def warnings

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

@@ -29,11 +29,7 @@ module PageStructuredData
       end
 
       def json_ld
-        %(
-        <script type="application/ld+json">
-          #{to_h.to_json}
-          </script>
-        )
+        JsonLd.script_tag(to_h)
       end
 
       def warnings

data/app/views/page_structured_data/_meta_tags.html.erb

@@ -2,6 +2,7 @@
 
 <% title = page&.page_title %>
 <% description = page&.description %>
+<% social_description = page&.resolved_social_description %>
 <% image = page&.resolved_image || default_image_url || nil %>
 <% canonical_url = page&.canonical_url %>
 <% robots_content = page&.robots_content %>
@@ -23,8 +24,8 @@
 <% end %>
 
 <meta property="og:title" content="<%= title %>">
-<% if description.present? %>
-<meta property="og:description" content="<%= description %>">
+<% if social_description.present? %>
+<meta property="og:description" content="<%= social_description %>">
 <% end %>
 <% if image.present? %>
 <meta property="og:image" content="<%= image %>">
@@ -32,8 +33,8 @@
 
 <meta name="twitter:card" content="summary_large_image">
 <meta name="twitter:title" content="<%= title %>">
-<% if description.present? %>
-<meta name="twitter:description" content="<%= description %>">
+<% if social_description.present? %>
+<meta name="twitter:description" content="<%= social_description %>">
 <% end %>
 <% if image.present? %>
 <meta name="twitter:image" content="<%= image %>">

data/lib/page_structured_data/version.rb

@@ -1,3 +1,3 @@
 module PageStructuredData
-  VERSION = "1.0.14"
+  VERSION = "1.0.15"
 end

data/lib/page_structured_data.rb

@@ -1,6 +1,7 @@
 require "page_structured_data/version"
 require "page_structured_data/engine"
 require_relative "../app/src/page_structured_data/anchors"
+require_relative "../app/src/page_structured_data/json_ld"
 require_relative "../app/src/page_structured_data/breadcrumbs"
 require_relative "../app/src/page_structured_data/page_types/schema_node"
 require_relative "../app/src/page_structured_data/page_types/person"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page_structured_data
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 1.0.15
 platform: ruby
 authors:
 - Jey Geethan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-05 00:00:00.000000000 Z
+date: 2026-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -47,6 +47,7 @@ files:
 - Rakefile
 - app/src/page_structured_data/anchors.rb
 - app/src/page_structured_data/breadcrumbs.rb
+- app/src/page_structured_data/json_ld.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