schema_dot_org 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 146e2c23c546ada2f45452f78d5e609e0730256b24b72811c834306ef69b5409
-  data.tar.gz: c1dbd6ee1c3af15b07b3188eea8decf036e3bc52c97379d78bea1f7ca16a25ea
+  metadata.gz: 6b0120204cb5305a8efc64697f917b6e3ada14584f172f61cf16537f71a7a7d9
+  data.tar.gz: 496bde815fba8a32a86f9c1c6bf6ff810bd49b8c6f6d05a73682d2fb49ce68c8
 SHA512:
-  metadata.gz: ea5016b6e3075a5aa21d82faf8a7e00b42f920637b6e8dd97c7a54998eae6fcfb8ae4f98a15a6e45cd471b1614598d0f007f54f67545043b63af89ff1ec85fff
-  data.tar.gz: ae7aaf1fbcea2b10918d224c89c26fa71725cf6dac52d27f5960a7096726ca7d3b9c1866477651084d20e71fe118049de3fa4b646fbc26c0da671db2d064b168
+  metadata.gz: 914246c1e12f48142d896d357f22607e383402e3ee5dc3bcf4087ecdbe9db93b8dbd37ce95d0b3622719de8990934aec37b4b05dd35deb916d6089b12dda28c4
+  data.tar.gz: 4d9a8f13cbbe2a9519f47e2bb2dd09ffb69874dc403512a3f0cf3269efff6c9904fe05a19b571d039fbb6cdbdd12425c3c56c1ed8b1a4a76e430416ffa903e5b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    schema_dot_org (2.2.2)
+    schema_dot_org (2.3.0)
       validated_object (~> 2.3)
 
 GEM
@@ -53,7 +53,7 @@ GEM
       sorbet-runtime (>= 0.5.5890)
 
 PLATFORMS
-  arm64-darwin-22
+  arm64-darwin-24
 
 DEPENDENCIES
   bundler (~> 2.4)

data/README.md

@@ -2,22 +2,23 @@
 
 # SchemaDotOrg
 
-Create [Structured Data](https://developers.google.com/search/docs/guides/intro-structured-data) with correct **syntax** and **semantics**,
-every single time. Good structured data [helps enhance a website's search result appearance](https://developers.google.com/search/docs/guides/enhance-site).
+Easily create [Structured Data](https://developers.google.com/search/docs/guides/intro-structured-data) with **correct syntax and semantics**.
+Good structured data [helps enhance a website's search result appearance](https://developers.google.com/search/docs/guides/enhance-site):
 
-> Google Search works hard to understand the content of a page. You can help us by providing explicit clues about the meaning of a page . . .
+> Google Search works hard to understand the content of a page. You can help us by providing explicit clues about the meaning of a page…
 
 ## Usage
 
-Let's say you have a Rails app. If you put this in a controller:
+Let's say you have a Rails app. First write plain-ruby code in a controller. Just instantiate
+the structured data object you want in your web page:
 
 ```ruby
-@public_law = Organization.new(
+@my_org = Organization.new(
   name:             'Public.Law',
   founder:           Person.new(name: 'Robb Shecter'),
   founding_date:     Date.new(2009, 3, 6),
   founding_location: Place.new(address: 'Portland, OR'),
-  email:            'say_hi@public.law',
+  email:            'support@public.law',
   telephone:        '+1 123 456 7890',
   url:              'https://www.public.law',
   logo:             'https://www.public.law/favicon-196x196.png',
@@ -28,13 +29,13 @@ Let's say you have a Rails app. If you put this in a controller:
   )
 ```
 
-...and this in a template:
+...and then output it in a template:
 
 ```html
-<%= @public_law %>
+<%= @my_org %>
 ```
 
-...you'll get this in the HTML:
+...you'll get this perfectly formatted structured data in your HTML:
 
 ```html
 <script type="application/ld+json">
@@ -42,7 +43,7 @@ Let's say you have a Rails app. If you put this in a controller:
   "@context": "http://schema.org",
   "@type": "Organization",
   "name": "Public.Law",
-  "email": "say_hi@public.law",
+  "email": "support@public.law",
   "telephone": "+1 123 456 7890",
   "url": "https://www.public.law",
   "logo": "https://www.public.law/favicon-196x196.png",
@@ -63,14 +64,25 @@ Let's say you have a Rails app. If you put this in a controller:
 </script>
 ```
 
-Strong typing is at work here. `SchemaDotOrg` will validate your code, and if correct, will generate Schema.org JSON-LD markup. If not, you'll get a descriptive error message.
+### Principle: No silent failures
+
+We coded the library this way because the data is embedded in the HTML - and it's a
+pain in the butt to manually check for errors. In my case, I manage 500,000 unique
+pages in my Rails app. There's _no way_ I could place error-free structured data in
+them without automatic validation.
+
+`SchemaDotOrg` will validate your Ruby code, and if it's correct, will generate Schema.org JSON-LD markup when `#to_s`
+is called. If you, e.g., didn't add the correct attributes, you'll get a descriptive error message pointing
+you to the problem.
 
- Notice how the `foundingDate` is in the required ISO-8601 format. [The founding date must be a Ruby
-Date object](https://github.com/dogweather/schema-dot-org/blob/master/lib/schema_dot_org/organization.rb#L11) and so we can ensure correct formatting. In the same way, the `foundingLocation` is a `Place`
-which adds the proper `@type` attribute.
+Notice how the `foundingDate` is in the required ISO-8601 format. In the same way, the `foundingLocation` is a `Place`
+which adds the proper `@type` attribute. All Ruby snake-case names have been converted to the Schema.org standard camel-case.
+Etc., etc.
 
 ### You are prevented from creating invalid markup
 
+If your page loads, you know your markup is good.
+
 If you use the wrong type or try to set an unknown attribute, SchemaDotOrg will
 refuse to create the incorrect JSON-LD. Instead, you'll get a message explaining
 the problem:
@@ -86,15 +98,18 @@ Place.new(
 # => NoMethodError: undefined method `author'
 ```
 
-This type safety comes from the [ValidatedObject gem](https://github.com/dogweather/validated_object).
+In my experience, I never get errors from the lib. I code it once, it works, and then
+I move on to other things.
+
+> This automatic validation comes from my [ValidatedObject gem](https://github.com/dogweather/validated_object), which in turn,
+> is a thin wrapper around ActiveRecord::Validations. So there's nothing magical going on here.
 
 ## Supported Schema.org Types
 
 AggregateOffer, ContactPoint, ItemList, ListItem, Offer, Organization, Person, Place,
 Product, SearchAction, and WebSite.
 
-Here are a few examples. The [source code](https://github.com/dogweather/schema-dot-org/tree/master/lib/schema_dot_org) for these is **extremely easy** to read. Check them out to see
-all the available attributes.
+Here are a few examples. [The source code for these is extremely easy to read.](https://github.com/dogweather/schema-dot-org/tree/master/lib/schema_dot_org)  Check them out to see all the available attributes.
 
 ### WebSite
 
@@ -140,9 +155,6 @@ Organization.new(
 )
 ```
 
-### Person, Place, and SearchAction
-
-These three aren't too useful on their own in web apps. They're used when creating a `WebSite` and `Organization`, as shown above.
 
 ## Installation
 
@@ -154,8 +166,8 @@ gem 'schema_dot_org'
 
 ## Development
 
-The Schema.org classes are as DRY as I could possibly make them. They're really
-easy to create and add to. For example, `Product`:
+The coding is as DRY as I could possibly make it. I think it's really
+easy to create and add to. For example, here's `Product`:
 
 ```ruby
 class Product < SchemaType
@@ -179,4 +191,4 @@ Bug reports and pull requests are welcome on GitHub.
 
 ## License
 
-[The](The) gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/schema_dot_org/aggregate_offer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Model the Schema.org `Thing > Place`.  See https://schema.org/Offer
+# Model the Schema.org `Thing > Intangible > Offer > AggregateOffer`.  See https://schema.org/Offer
 #
 module SchemaDotOrg
   class AggregateOffer < SchemaType

data/lib/schema_dot_org/college_or_university.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+
+#
+# https://schema.org/CollegeOrUniversity
+#
+module SchemaDotOrg
+  class CollegeOrUniversity < SchemaType
+    validated_attr :name, type: String, presence: true
+    validated_attr :url,  type: String, allow_nil: true
+  end
+end

data/lib/schema_dot_org/comment.rb

@@ -0,0 +1,24 @@
+
+# frozen_string_literal: true
+
+require 'date'
+require_relative 'person'
+
+#
+# Model the Schema.org `Thing > CreativeWork > Comment`.
+# See https://schema.org/Comment
+#
+module SchemaDotOrg
+  class Comment < SchemaType
+    validated_attr :author,        type: Person, presence: true
+    validated_attr :datePublished, type: Date,   presence: true
+
+    validated_attr :comment,              type: Array,  allow_nil: true
+    validated_attr :creativeWorkStatus,   type: String, allow_nil: true
+    validated_attr :image,                type: Array,  allow_nil: true
+    validated_attr :inLanguage,           type: Array,  allow_nil: true
+    validated_attr :interactionStatistic, type: Array,  allow_nil: true
+    validated_attr :text,                 type: String, allow_nil: true
+    validated_attr :url,                  type: String, allow_nil: true
+  end
+end

data/lib/schema_dot_org/discussion_forum_posting.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'date'
+require_relative 'person'
+
+#
+# Model the Schema.org `Thing > CreativeWork > Article > SocialMediaPosting > DiscussionForumPosting`.
+# See https://schema.org/DiscussionForumPosting
+#
+module SchemaDotOrg
+  class DiscussionForumPosting < SchemaType
+    # TODO: Allow for type Person or Organization
+    validated_attr :author,        type: Person, presence: true
+    # TODO: Allow for type Date or DateTime
+    validated_attr :datePublished, type: Date,   presence: true
+
+    validated_attr :comment,              type: Array,   allow_nil: true
+    validated_attr :commentCount,         type: Integer, allow_nil: true
+    validated_attr :headline,             type: String,  allow_nil: true
+    validated_attr :image,                type: Array,   allow_nil: true
+    validated_attr :inLanguage,           type: Array,   allow_nil: true
+    validated_attr :interactionStatistic, type: Array,   allow_nil: true
+    validated_attr :mainEntityOfPage,     type: String,  allow_nil: true
+    validated_attr :text,                 type: String,  allow_nil: true
+    validated_attr :url,                  type: String,  allow_nil: true
+  end
+end

data/lib/schema_dot_org/interaction_counter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+#
+# Model the Schema.org `Thing > Intangible > StructuredValue > InteractionCounter`.
+# See https://schema.org/InteractionCounter
+#
+module SchemaDotOrg
+  class InteractionCounter < SchemaType
+    validated_attr :userInteractionCount, type: Integer, presence: true
+    validated_attr :interactionType,      type: String,  presence: true
+  end
+end

data/lib/schema_dot_org/language.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+#
+# Model the Schema.org `Thing > Intangible > Language`.
+# See https://schema.org/Language
+#
+module SchemaDotOrg
+  class Language < SchemaType
+    validated_attr :alternateName, type: String, allow_nil: true
+    validated_attr :name,          type: String, presence: true
+  end
+end

data/lib/schema_dot_org/offer.rb

@@ -2,7 +2,7 @@
 
 
 #
-# Model the Schema.org `Thing > Place`.  See https://schema.org/Offer
+# Model the Schema.org `Thing > Intangible > Offer`.  See https://schema.org/Offer
 #
 module SchemaDotOrg
   class Offer < SchemaType

data/lib/schema_dot_org/organization.rb

@@ -5,6 +5,9 @@ require 'date'
 require_relative 'person'
 require_relative 'place'
 
+# Google allows `url` to be a string:
+# https://developers.google.com/search/docs/appearance/structured-data/logo
+
 module SchemaDotOrg
   class Organization < SchemaType
     validated_attr :contact_points,    type: Array, allow_nil: true
@@ -12,9 +15,11 @@ module SchemaDotOrg
     validated_attr :founder,           type: SchemaDotOrg::Person, allow_nil: true
     validated_attr :founding_date,     type: Date, allow_nil: true
     validated_attr :founding_location, type: SchemaDotOrg::Place, allow_nil: true
+    validated_attr :legal_name,        type: String, allow_nil: true
     validated_attr :logo,              type: String
     validated_attr :name,              type: String
     validated_attr :same_as,           type: Array, allow_nil: true
+    validated_attr :slogan,            type: String, allow_nil: true
     validated_attr :telephone,         type: String, allow_nil: true
     validated_attr :url,               type: String
   end

data/lib/schema_dot_org/person.rb

@@ -6,8 +6,11 @@
 #
 module SchemaDotOrg
   class Person < SchemaType
-    validated_attr :name,    type: String, presence: true
-    validated_attr :same_as, type: Array,  allow_nil: true
-    validated_attr :url,     type: String, allow_nil: true
+    validated_attr :award,            type: String, allow_nil: true
+    validated_attr :alumni_of,        type: SchemaDotOrg::CollegeOrUniversity, allow_nil: true
+    validated_attr :honorific_suffix, type: String, allow_nil: true
+    validated_attr :name,             type: String, presence: true
+    validated_attr :same_as,          type: Array,  allow_nil: true
+    validated_attr :url,              type: String, allow_nil: true
   end
 end

data/lib/schema_dot_org/product.rb

@@ -2,7 +2,7 @@
 
 
 #
-# Model the Schema.org `Thing > Place`.  See https://schema.org/Product
+# Model the Schema.org `Thing > Product`.  See https://schema.org/Product
 #
 module SchemaDotOrg
   class Product < SchemaType

data/lib/schema_dot_org.rb

@@ -115,8 +115,13 @@ end
 
 
 require 'schema_dot_org/aggregate_offer'
+require 'schema_dot_org/college_or_university'
+require 'schema_dot_org/comment'
 require 'schema_dot_org/contact_point'
+require 'schema_dot_org/discussion_forum_posting'
+require 'schema_dot_org/interaction_counter'
 require 'schema_dot_org/item_list'
+require 'schema_dot_org/language'
 require 'schema_dot_org/list_item'
 require 'schema_dot_org/organization'
 require 'schema_dot_org/person'

data/schema_dot_org.gemspec

@@ -5,9 +5,9 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 3.0'
   spec.name          = 'schema_dot_org'
-  spec.version       = '2.2.2'
+  spec.version       = '2.3.0'
   spec.authors       = ['Robb Shecter']
   spec.email         = ['robb@public.law']
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: schema_dot_org
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Robb Shecter
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: validated_object
@@ -75,7 +74,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -87,8 +85,13 @@ files:
 - bin/tapioca
 - lib/schema_dot_org.rb
 - lib/schema_dot_org/aggregate_offer.rb
+- lib/schema_dot_org/college_or_university.rb
+- lib/schema_dot_org/comment.rb
 - lib/schema_dot_org/contact_point.rb
+- lib/schema_dot_org/discussion_forum_posting.rb
+- lib/schema_dot_org/interaction_counter.rb
 - lib/schema_dot_org/item_list.rb
+- lib/schema_dot_org/language.rb
 - lib/schema_dot_org/list_item.rb
 - lib/schema_dot_org/offer.rb
 - lib/schema_dot_org/organization.rb
@@ -103,7 +106,6 @@ homepage: https://github.com/public-law/schema-dot-org
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,15 +113,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: JSON-LD generator for Schema.org vocabulary
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.6.6