page_structured_data 1.0.8 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de6dfe0bcc4ddffd85f8b77498c1f4a34fcbdcd839cb362118033531ec1e7d48
-  data.tar.gz: 9152005a24c5e16562c3d38e285c9dc4a56803563c0387cad15beca54f646fda
+  metadata.gz: 58a57c3e6e31ccb80b40dcdc78ccc467b18bb6f377982f70eadd2d84a20f8308
+  data.tar.gz: e7b26474f2cdcfc6238c67c39ea87072965b7a07857692068267c4542a4a997a
 SHA512:
-  metadata.gz: 41ca7bfed324d9e746c2e60cf092af955f11b1136ba4db2a4ef965babcd22870b4bfb5c1808d4fde1b2e53cfefe6dd664adfe2a41cc4ae44e6ecf809bf42b4dc
-  data.tar.gz: d53a5eb7986394deeaff433d74022b1d830bca59b9b9aaa2161e773e6010a6f7ba9802bd1662417c3be8729dfb0139239047766cca15bef39bf8569e8edf468a
+  metadata.gz: eb867392c1857beb772a52294d82ef8229551429b9655c93a79fec3a1193cfba6ce14eeec5bb42741734f938f611a05ce9029120ec9b9936c31bb0060d4b4b47
+  data.tar.gz: 18dcb10a552cf8cec3dd2ca3ec9300a40024c808f491f03a04ab5fe7090350516b46b347fc182ab930ac4ec6c91667f8061f1de3d95f793b0c3cf35f06c63aba

data/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project are documented here.
 
 ## Unreleased
 
+## 1.0.10 - 2026-05-06
+
+- Add JSON-LD escaping coverage for organization page types.
+- Add `PageStructuredData::PageTypes::WebSite` for schema.org WebSite JSON-LD.
+- Add `page_types:` support for rendering multiple page type JSON-LD scripts.
+- Add `canonical_url` and `fallback_image` options to `Page`.
+
+## 1.0.9 - 2026-05-06
+
+- Add release preparation script and release checklist documentation.
+- Add `to_h` schema hash API for organization page types.
+
 ## 1.0.8 - 2026-05-06
 
 - Add `PageStructuredData::PageTypes::Organization` for schema.org Organization JSON-LD.

data/README.md

@@ -14,7 +14,7 @@ It helps Rails applications render:
 - Google-compatible JSON-LD structured data
 - Breadcrumb structured data
 - Article structured data for `BlogPosting` and `NewsArticle`
-- Organization structured data
+- Organization and WebSite structured data
 
 ## Requirements
 
@@ -93,7 +93,9 @@ Set `@page_meta` in the controller or view before the layout renders:
   title: "Home",
   extra_title: "Official Page",
   description: "Welcome to my page",
-  image: image_url("social/home.png")
+  image: image_url("social/home.png"),
+  canonical_url: home_url,
+  fallback_image: image_url("social/default.png")
 )
 ```
 
@@ -133,13 +135,14 @@ This renders `BreadcrumbList` JSON-LD similar to Google's breadcrumb structured
 
 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
+## Structured Page Types
 
 PageStructuredData includes page types for:
 
 - [`BlogPosting`](https://schema.org/BlogPosting)
 - [`NewsArticle`](https://schema.org/NewsArticle)
 - [`Organization`](https://schema.org/Organization)
+- [`WebSite`](https://schema.org/WebSite)
 
 Use a page type when the current page represents an article:
 
@@ -191,6 +194,30 @@ organization_page_type = PageStructuredData::PageTypes::Organization.new(
 )
 ```
 
+Use `WebSite` with `Organization` when the current page represents a site or homepage:
+
+```ruby
+organization_page_type = PageStructuredData::PageTypes::Organization.new(
+  name: "RocketApex",
+  url: "https://rocketapex.com",
+  logo: "https://rocketapex.com/logo.png"
+)
+
+website_page_type = PageStructuredData::PageTypes::WebSite.new(
+  name: "RocketApex",
+  url: "https://rocketapex.com",
+  description: "Open source projects from RocketApex",
+  publisher: organization_page_type
+)
+
+@page_meta = PageStructuredData::Page.new(
+  title: "RocketApex",
+  description: "Open source projects from RocketApex",
+  canonical_url: "https://rocketapex.com",
+  page_types: [organization_page_type, website_page_type]
+)
+```
+
 ## API Reference
 
 ### `PageStructuredData::Page`
@@ -202,7 +229,10 @@ PageStructuredData::Page.new(
   image: nil,
   extra_title: "",
   breadcrumb: nil,
-  page_type: nil
+  page_type: nil,
+  page_types: nil,
+  canonical_url: nil,
+  fallback_image: nil
 )
 ```
 
@@ -210,6 +240,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`.
 
 ### `PageStructuredData::Breadcrumbs`
 
@@ -272,8 +303,28 @@ PageStructuredData::PageTypes::Organization.new(
 
 Important methods:
 
+- `to_h`: returns a structured hash for organization JSON-LD.
 - `json_ld`: returns an organization JSON-LD script tag.
 
+### WebSite Page Type
+
+```ruby
+PageStructuredData::PageTypes::WebSite.new(
+  name:,
+  url:,
+  description: nil,
+  publisher: nil,
+  potential_action: nil
+)
+```
+
+`publisher` can be a hash or another page type that responds to `to_h`, such as `PageStructuredData::PageTypes::Organization`.
+
+Important methods:
+
+- `to_h`: returns a structured hash for WebSite JSON-LD.
+- `json_ld`: returns a WebSite JSON-LD script tag.
+
 ## Development
 
 Run the test suite:
@@ -288,6 +339,8 @@ Verify the gem can be required:
 ruby -Ilib -e 'require "page_structured_data"; puts PageStructuredData::VERSION'
 ```
 
+Release instructions are documented in [docs/release.md](docs/release.md).
+
 ## Compatibility Policy
 
 This gem is used in production applications. Changes should preserve existing public APIs and rendered output unless a breaking change is intentionally released in a major version.

data/app/src/page_structured_data/page.rb

@@ -3,16 +3,21 @@
 module PageStructuredData
   # Basic page metadata for any page
   class Page
-    attr_reader :title, :description, :image, :extra_title, :breadcrumb, :page_type
+    attr_reader :title, :description, :image, :extra_title, :breadcrumb, :page_type, :page_types, :canonical_url,
+                :fallback_image
 
     def initialize(title:, description: nil, image: nil, # rubocop:disable Metrics/ParameterLists
-                   extra_title: '', breadcrumb: nil, page_type: nil)
+                   extra_title: '', breadcrumb: nil, page_type: nil, page_types: nil, canonical_url: nil,
+                   fallback_image: nil)
       @title = title
       @description = description
       @image = image
       @extra_title = extra_title
       @breadcrumb = breadcrumb
       @page_type = page_type
+      @page_types = page_types
+      @canonical_url = canonical_url
+      @fallback_image = fallback_image
     end
 
     def title_with_hierarchies
@@ -32,12 +37,20 @@ module PageStructuredData
     def json_lds
       output = []
       output << breadcrumb_json_ld if (breadcrumb_json_ld = self.breadcrumb_json_ld).present?
-      output << page_type.json_ld if page_type.present?
+      resolved_page_types.each { |resolved_page_type| output << resolved_page_type.json_ld }
       output.join
     end
 
+    def resolved_image
+      image || fallback_image
+    end
+
     private
 
+    def resolved_page_types
+      Array.wrap(page_types.presence || page_type).compact
+    end
+
     def breadcrumb_json_ld
       return breadcrumb.json_ld(current_page_title: title) if breadcrumb.present?
       return unless PageStructuredData.render_default_breadcrumb_json_ld

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

@@ -14,7 +14,7 @@ module PageStructuredData
         @parent_organization = parent_organization
       end
 
-      def json_ld # rubocop:disable Metrics/MethodLength
+      def to_h # rubocop:disable Metrics/MethodLength
         node = {
           '@context': 'https://schema.org',
           '@type': 'Organization',
@@ -33,9 +33,13 @@ module PageStructuredData
           }
         end
 
+        node
+      end
+
+      def json_ld
         %(
         <script type="application/ld+json">
-          #{node.to_json}
+          #{to_h.to_json}
           </script>
         )
       end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module PageStructuredData
+  module PageTypes
+    # WebSite structured data for a page
+    class WebSite
+      attr_reader :name, :url, :description, :publisher, :potential_action
+
+      def initialize(name:, url:, description: nil, publisher: nil, potential_action: nil)
+        @name = name
+        @url = url
+        @description = description
+        @publisher = publisher
+        @potential_action = potential_action
+      end
+
+      def to_h
+        node = {
+          '@context': 'https://schema.org',
+          '@type': 'WebSite',
+          name: name,
+          url: url,
+        }
+
+        node[:description] = description if description.present?
+        node[:publisher] = publisher_to_h if publisher.present?
+        node[:potentialAction] = potential_action if potential_action.present?
+
+        node
+      end
+
+      def json_ld
+        %(
+        <script type="application/ld+json">
+          #{to_h.to_json}
+          </script>
+        )
+      end
+
+      private
+
+      def publisher_to_h
+        return publisher.to_h if publisher.respond_to?(:to_h)
+
+        publisher
+      end
+    end
+  end
+end

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

@@ -2,9 +2,13 @@
 
 <% title = page&.page_title %>
 <% description = page&.description %>
-<% image = page&.image || default_image_url || nil %>
+<% image = page&.resolved_image || default_image_url || nil %>
+<% canonical_url = page&.canonical_url %>
 
 <title><%= title %></title>
+<% if canonical_url.present? %>
+<link rel="canonical" href="<%= canonical_url %>">
+<% end %>
 
 <meta name="title" content="<%= title %>">
 <meta name="description" content="<%= description %>">

data/lib/page_structured_data/version.rb

@@ -1,3 +1,3 @@
 module PageStructuredData
-  VERSION = "1.0.8"
+  VERSION = "1.0.10"
 end

data/lib/page_structured_data.rb

@@ -6,6 +6,7 @@ require_relative "../app/src/page_structured_data/page_types/article"
 require_relative "../app/src/page_structured_data/page_types/blog_posting"
 require_relative "../app/src/page_structured_data/page_types/news_article"
 require_relative "../app/src/page_structured_data/page_types/organization"
+require_relative "../app/src/page_structured_data/page_types/web_site"
 require_relative "../app/src/page_structured_data/page"
 
 module PageStructuredData

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: page_structured_data
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.10
 platform: ruby
 authors:
 - Jey Geethan
@@ -50,6 +50,7 @@ files:
 - app/src/page_structured_data/page_types/blog_posting.rb
 - app/src/page_structured_data/page_types/news_article.rb
 - app/src/page_structured_data/page_types/organization.rb
+- app/src/page_structured_data/page_types/web_site.rb
 - app/views/page_structured_data/_meta_tags.html.erb
 - config/routes.rb
 - lib/page_structured_data.rb