page_structured_data 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ffd04020a9a4ba900bb7d4bbdac9dd827d48535073a30c657865469df9e1988
-  data.tar.gz: 4b560fee8a434599acd2ae619fdc7e4a0973f29aa77f8b95191a270047767931
+  metadata.gz: 885b125f1d2fed94a1e0bba7d2c70877f0dba9c5f4ebde59c52f970f2fc4fce4
+  data.tar.gz: 513764c63a8dae5e609d2e92ea1e99dee3fe0555a3727afa24c3d2afdcc64ffd
 SHA512:
-  metadata.gz: '08329eddfdf9f7e3682a6016ca84d25b1867e4ce8ebca4c4e7654536b4dff59b8d825351b4489b69342c42d2cc52ab41d96bba1f3cc8adf5a1f8180330d660ba'
-  data.tar.gz: 270c98e7c0071b9e09e75482a5d766ec685f8a7da103c3ddb15f4df03e895b98fcc52d57e50b93cbfddd992de7d0fbdf6d5de9542b07fec52d0eab977da2903f
+  metadata.gz: 1e4530a70cf06b4d81cab2322759500bdb29acb31ef8c33846f40d9095cb981c2272feb0fe6c57b6b5c363915e59ab7300071d618799459d2e34317bfc1434e8
+  data.tar.gz: 6a900ab594f816e1b2edd833a350a15c0837503af68f3efa0a475ac723e05b21bdc66cbad39384c680a2dfab4dfd173137dd9a05f245f236df450e757f162f98

data/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project are documented here.
 
 ## Unreleased
 
+## 1.0.12 - 2026-05-06
+
+- Add reusable interaction statistics for article-like page types.
+- Add `PageStructuredData::PageTypes::DiscussionForumPosting` for forum-style posts.
+- Render Twitter Card meta tags with `name` attributes.
+- Update gem metadata to mention Organization and WebSite JSON-LD support.
+
 ## 1.0.11 - 2026-05-06
 
 - Add optional `description` and `founder` support to organization page types.

data/README.md

@@ -14,6 +14,8 @@ It helps Rails applications render:
 - Google-compatible JSON-LD structured data
 - Breadcrumb structured data
 - Article structured data for `BlogPosting` and `NewsArticle`
+- Discussion forum post structured data
+- Interaction statistics for public engagement counts
 - Organization and WebSite structured data
 
 ## Requirements
@@ -141,6 +143,7 @@ PageStructuredData includes page types for:
 
 - [`BlogPosting`](https://schema.org/BlogPosting)
 - [`NewsArticle`](https://schema.org/NewsArticle)
+- [`DiscussionForumPosting`](https://schema.org/DiscussionForumPosting)
 - [`Organization`](https://schema.org/Organization)
 - [`WebSite`](https://schema.org/WebSite)
 
@@ -173,6 +176,42 @@ article_page_type = PageStructuredData::PageTypes::BlogPosting.new(
 
 For news pages, use `PageStructuredData::PageTypes::NewsArticle` with the same arguments.
 
+Article-like page types can include public engagement counts as interaction statistics:
+
+```ruby
+article_page_type = PageStructuredData::PageTypes::BlogPosting.new(
+  headline: @article.title,
+  published_at: @article.published_at,
+  updated_at: @article.updated_at,
+  likes_count: @article.likes_count,
+  comments_count: @article.comments_count,
+  shares_count: @article.shares_count
+)
+```
+
+Only include engagement counts that are public and visible on the rendered page.
+
+Use `DiscussionForumPosting` when the current page represents a public user-authored forum or community post:
+
+```ruby
+forum_post_page_type = PageStructuredData::PageTypes::DiscussionForumPosting.new(
+  headline: @post.title,
+  text: @post.content_plaintext,
+  url: post_url(@post),
+  published_at: @post.created_at,
+  updated_at: @post.updated_at,
+  authors: [
+    {
+      name: @post.user.name,
+      url: user_url(@post.user)
+    }
+  ],
+  interaction_statistics: [
+    PageStructuredData::PageTypes::InteractionStatistic.comment(@post.comments_count)
+  ]
+)
+```
+
 Use `Organization` when the current page represents an organization:
 
 ```ruby
@@ -272,7 +311,15 @@ PageStructuredData::PageTypes::BlogPosting.new(
   published_at:,
   updated_at:,
   images: [],
-  authors: []
+  authors: [],
+  image: nil,
+  article_body: nil,
+  text: nil,
+  url: nil,
+  interaction_statistics: [],
+  likes_count: nil,
+  comments_count: nil,
+  shares_count: nil
 )
 ```
 
@@ -282,17 +329,70 @@ PageStructuredData::PageTypes::NewsArticle.new(
   published_at:,
   updated_at:,
   images: [],
-  authors: []
+  authors: [],
+  image: nil,
+  article_body: nil,
+  text: nil,
+  url: nil,
+  interaction_statistics: [],
+  likes_count: nil,
+  comments_count: nil,
+  shares_count: nil
 )
 ```
 
 `authors` should be an array of hashes with `:name` and `:url` keys.
+`image` is a convenience option for one image URL. Use `images` when passing multiple image URLs.
+`text` is an alias for `article_body`.
+`interaction_statistics` should be an array of `PageStructuredData::PageTypes::InteractionStatistic` objects or schema-compatible hashes.
 
 Important methods:
 
 - `to_h`: returns a structured hash for article JSON-LD.
 - `json_ld`: returns an article JSON-LD script tag.
 
+```ruby
+PageStructuredData::PageTypes::DiscussionForumPosting.new(
+  headline:,
+  published_at:,
+  updated_at:,
+  images: [],
+  authors: [],
+  image: nil,
+  article_body: nil,
+  text: nil,
+  url: nil,
+  interaction_statistics: [],
+  likes_count: nil,
+  comments_count: nil,
+  shares_count: nil
+)
+```
+
+### Interaction Statistics
+
+```ruby
+PageStructuredData::PageTypes::InteractionStatistic.new(
+  interaction_type: :like,
+  user_interaction_count: 42,
+  interaction_service: nil
+)
+```
+
+Convenience constructors are also available:
+
+```ruby
+PageStructuredData::PageTypes::InteractionStatistic.like(42)
+PageStructuredData::PageTypes::InteractionStatistic.comment(12)
+PageStructuredData::PageTypes::InteractionStatistic.share(7)
+```
+
+Supported shorthand interaction types are `:like`, `:comment`, and `:share`. Custom schema.org action types can be passed as strings or hashes.
+
+Important methods:
+
+- `to_h`: returns a structured hash for `InteractionCounter` JSON-LD.
+
 ### Organization Page Type
 
 ```ruby

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

@@ -4,18 +4,26 @@ 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
+      attr_reader :headline, :images, :published_at, :updated_at, :authors, :article_body, :url,
+                  :interaction_statistics, :likes_count, :comments_count, :shares_count
 
-      def initialize(headline:, published_at:, updated_at:, images: [], authors: [])
+      def initialize(headline:, published_at:, updated_at:, images: [], authors: [], image: nil, article_body: nil, text: nil,
+                     url: nil, interaction_statistics: [], likes_count: nil, comments_count: nil, shares_count: nil)
         @headline = headline
-        @images = images
+        @images = image.present? ? Array(image) : Array(images)
         @published_at = published_at
         @updated_at = updated_at
-        @authors = authors
+        @authors = Array(authors)
+        @article_body = article_body || text
+        @url = url
+        @interaction_statistics = Array(interaction_statistics)
+        @likes_count = likes_count
+        @comments_count = comments_count
+        @shares_count = shares_count
       end
 
       def to_h
-        {
+        node = {
           '@context': 'https://schema.org',
           '@type': schema_type,
           headline: headline,
@@ -30,6 +38,12 @@ module PageStructuredData
             }
           end,
         }
+
+        node[:articleBody] = article_body if article_body.present?
+        node[:url] = url if url.present?
+        node[:interactionStatistic] = interaction_statistics_to_h if interaction_statistics_to_h.any?
+
+        node
       end
 
       def json_ld
@@ -45,6 +59,34 @@ module PageStructuredData
       def schema_type
         raise NotImplementedError, "#{self.class.name} must define #schema_type"
       end
+
+      def interaction_statistics_to_h
+        @interaction_statistics_to_h ||= all_interaction_statistics.map do |interaction_statistic|
+          if interaction_statistic.respond_to?(:to_h)
+            interaction_statistic.to_h
+          else
+            interaction_statistic
+          end
+        end
+      end
+
+      def all_interaction_statistics
+        interaction_statistics + count_interaction_statistics
+      end
+
+      def count_interaction_statistics
+        [
+          count_interaction_statistic(:like, likes_count),
+          count_interaction_statistic(:comment, comments_count),
+          count_interaction_statistic(:share, shares_count),
+        ].compact
+      end
+
+      def count_interaction_statistic(interaction_type, count)
+        return if count.nil?
+
+        InteractionStatistic.new(interaction_type: interaction_type, user_interaction_count: count)
+      end
     end
   end
 end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PageStructuredData
+  module PageTypes
+    # schema.org structured data for discussion forum posts.
+    class DiscussionForumPosting < Article
+      private
+
+      def schema_type
+        'DiscussionForumPosting'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module PageStructuredData
+  module PageTypes
+    # schema.org InteractionCounter structured data.
+    class InteractionStatistic
+      ACTION_TYPES = {
+        like: 'LikeAction',
+        likes: 'LikeAction',
+        comment: 'CommentAction',
+        comments: 'CommentAction',
+        share: 'ShareAction',
+        shares: 'ShareAction',
+      }.freeze
+
+      attr_reader :interaction_type, :user_interaction_count, :interaction_service
+
+      def self.like(user_interaction_count)
+        new(interaction_type: :like, user_interaction_count: user_interaction_count)
+      end
+
+      def self.comment(user_interaction_count)
+        new(interaction_type: :comment, user_interaction_count: user_interaction_count)
+      end
+
+      def self.share(user_interaction_count)
+        new(interaction_type: :share, user_interaction_count: user_interaction_count)
+      end
+
+      def initialize(interaction_type:, user_interaction_count:, interaction_service: nil)
+        @interaction_type = interaction_type
+        @user_interaction_count = user_interaction_count
+        @interaction_service = interaction_service
+      end
+
+      def to_h
+        node = {
+          '@type': 'InteractionCounter',
+          interactionType: interaction_type_to_h,
+          userInteractionCount: user_interaction_count,
+        }
+
+        node[:interactionService] = object_to_h(interaction_service) if interaction_service.present?
+
+        node
+      end
+
+      private
+
+      def interaction_type_to_h
+        return object_to_h(interaction_type) if interaction_type.respond_to?(:to_h)
+
+        type = ACTION_TYPES.fetch(interaction_type.to_s.to_sym, interaction_type.to_s)
+
+        { '@type': type }
+      end
+
+      def object_to_h(object)
+        return object.to_h if object.respond_to?(:to_h)
+
+        object
+      end
+    end
+  end
+end

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

@@ -18,9 +18,9 @@
 <meta property="og:description" content="<%= description %>">
 <meta property="og:image" content="<%= image %>">
 
-<meta property="twitter:card" content="summary_large_image">
-<meta property="twitter:title" content="<%= title %>">
-<meta property="twitter:description" content="<%= description %>">
-<meta property="twitter:image" content="<%= image %>">
+<meta name="twitter:card" content="summary_large_image">
+<meta name="twitter:title" content="<%= title %>">
+<meta name="twitter:description" content="<%= description %>">
+<meta name="twitter:image" content="<%= image %>">
 
 <%= page&.json_lds&.html_safe %>

data/lib/page_structured_data/version.rb

@@ -1,3 +1,3 @@
 module PageStructuredData
-  VERSION = "1.0.11"
+  VERSION = "1.0.12"
 end

data/lib/page_structured_data.rb

@@ -2,9 +2,11 @@ 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/breadcrumbs"
+require_relative "../app/src/page_structured_data/page_types/interaction_statistic"
 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/discussion_forum_posting"
 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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: page_structured_data
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - Jey Geethan
@@ -32,7 +32,8 @@ dependencies:
         version: '9.0'
 description: PageStructuredData gives Rails applications a small page object and view
   partial for rendering page titles, basic meta tags, Open Graph tags, Twitter card
-  tags, breadcrumb JSON-LD, and article JSON-LD.
+  tags, breadcrumb JSON-LD, article and forum post JSON-LD, Organization JSON-LD,
+  WebSite JSON-LD, and public interaction statistics.
 email:
 - opensource@rocketapex.com
 executables: []
@@ -48,6 +49,8 @@ files:
 - 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/discussion_forum_posting.rb
+- app/src/page_structured_data/page_types/interaction_statistic.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