schema_dot_org 2.3.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 736ca556e9da839382ce55910f9729313cbd37bee13df252fdff1606af240650
-  data.tar.gz: '08fa546126f7f829e1ee6af9358566e69fef5181afeaacb83c781741353f08af'
+  metadata.gz: ab85a88b3210a47d564f4f6cc3fd61db14a79bad76f61e4ae529534bef14a315
+  data.tar.gz: '090f666086836b9e1d57f8168443e667d72412623c33e3fef5cecf0257718240'
 SHA512:
-  metadata.gz: 91dda5511231e77bddf3a15eb5c73c41cbf36a4eef69cf20be03b6b803c156555aeac751bc9d0d0112316a4dec0b8faf472479b0325f69253afb6c868860ec6e
-  data.tar.gz: cc529cd3d76bf23fb01b8273b6675c063c98b082122fcec9327fd26f428d98e35f158499fcbb20b0513fc67f2c962ccd07483e54040bf44f37f63bd2b6a6779e
+  metadata.gz: 50f6a8b6b500b45eb7f999ec09ea92453be82afdd79b709a879f547c40768fc547dceca8d6f5cbd86b6196ec1f0973682e35679dfe201140901dfd0d91de5ac5
+  data.tar.gz: 494fb2b2e97e9f93597de163461f498f7c90ca364094484fda60613bb047128b31b3d78b6e3635498dd9f6a2cb27f563470f63daef919a360da103b644ff142e

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    schema_dot_org (2.3.3)
+    schema_dot_org (2.4.0)
       validated_object (~> 2.3)
 
 GEM

data/README.md

@@ -24,7 +24,9 @@ Good structured data [helps enhance a website's search result appearance](https:
 
 ## Usage
 
-Let's say you have a Rails app. First write plain-ruby code in a helper or controller. Just instantiate
+Let's say you have a Rails app. First write plain-ruby code in a helper or controller. 
+
+Here's what that'd look like in a controller. Instantiate
 the structured data object you want in your web page:
 
 ```ruby
@@ -117,7 +119,7 @@ In my experience, I never get errors from the lib. I code it once, it works, and
 I move on to other things.
 
 > [!NOTE]
-> This automatic validation comes from my [ValidatedObject gem](https://github.com/dogweather/validated_object), which in turn,
+> This automatic validation comes from my [ValidatedObject gem](https://github.com/public-law/validated_object), which in turn,
 > is a thin wrapper around ActiveRecord::Validations. So there's nothing magical going on here.
 
 ## Supported Schema.org Types
@@ -127,6 +129,7 @@ See each type's RSpec for an example of how to use it.
 | Name                   | Schema.org Page                                         | RSpec Spec                                                                                                             | Source Code                                                                                                       |
 | ---------------------- | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
 | AggregateOffer         | [Schema.org](https://schema.org/AggregateOffer)         |                                                                                                                        | [Source](https://github.com/public-law/schema-dot-org/blob/master/lib/schema_dot_org/aggregate_offer.rb)          |
+| BreadcrumbList         | [Schema.org](https://schema.org/BreadcrumbList)         | [RSpec](https://github.com/public-law/schema-dot-org/blob/master/spec/schema_dot_org/breadcrumb_list_spec.rb)          | [Source](https://github.com/public-law/schema-dot-org/blob/master/lib/schema_dot_org/breadcrumb_list.rb)          |
 | CollegeOrUniversity    | [Schema.org](https://schema.org/CollegeOrUniversity)    | [RSpec](https://github.com/public-law/schema-dot-org/blob/master/spec/schema_dot_org/college_or_university_spec.rb)    | [Source](https://github.com/public-law/schema-dot-org/blob/master/lib/schema_dot_org/college_or_university.rb)    |
 | Comment                | [Schema.org](https://schema.org/Comment)                | [RSpec](https://github.com/public-law/schema-dot-org/blob/master/spec/schema_dot_org/comment_spec.rb)                  | [Source](https://github.com/public-law/schema-dot-org/blob/master/lib/schema_dot_org/comment.rb)                  |
 | ContactPoint           | [Schema.org](https://schema.org/ContactPoint)           |                                                                                                                        | [Source](https://github.com/public-law/schema-dot-org/blob/master/lib/schema_dot_org/contact_point.rb)            |

data/lib/schema_dot_org/breadcrumb_list.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+
+#
+# Model the Google / Schema.org `BreadcrumbList`.
+#
+# The intent is to primarily support Google's BreadcrumbList. Properties
+# from Schema.org are welcome if desired.
+#
+# See https://developers.google.com/search/docs/appearance/structured-data/breadcrumb
+# and https://schema.org/BreadcrumbList
+#
+module SchemaDotOrg
+  class BreadcrumbList < SchemaType
+    validated_attr :itemListElement, type: Array, presence: true
+  end
+end

data/lib/schema_dot_org/list_item.rb

@@ -9,9 +9,22 @@ require_relative 'product'
 module SchemaDotOrg
   class ListItem < SchemaType
     validated_attr :image,     type: String,                allow_nil: true
-    validated_attr :item,      type: SchemaDotOrg::Product, allow_nil: true
+    validated_attr :item,      type: Object,                allow_nil: true  # Allow String or SchemaType
     validated_attr :name,      type: String,                allow_nil: true
     validated_attr :position,  type: Integer,               presence:  true
     validated_attr :url,       type: String,                allow_nil: true
+
+    validate :item_must_be_valid_type
+
+
+    private
+
+    def item_must_be_valid_type
+      return if item.nil?
+      return if item.is_a?(String)  # URL
+      return if item.is_a?(SchemaDotOrg::SchemaType)  # Any Schema.org type
+
+      errors.add(:item, 'must be a URL string or Schema.org object, but was: ' + item.class.name + ' (' + item.inspect + ')')
+    end
   end
 end

data/lib/schema_dot_org.rb

@@ -116,6 +116,7 @@ end
 
 
 require 'schema_dot_org/aggregate_offer'
+require 'schema_dot_org/breadcrumb_list'
 require 'schema_dot_org/college_or_university'
 require 'schema_dot_org/comment'
 require 'schema_dot_org/contact_point'

data/schema_dot_org.gemspec

@@ -7,9 +7,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 3.0'
   spec.name          = 'schema_dot_org'
-  spec.version       = '2.3.3'
-  spec.authors       = ['Robb Shecter']
-  spec.email         = ['robb@public.law']
+  spec.version       = '2.4.0'
+  spec.authors       = ['Robert Shecter']
+  spec.email         = ['robert@public.law']
 
   spec.summary       = 'JSON-LD generator for Schema.org vocabulary'
   spec.description   = 'Creates well-formed website metadata with ' \

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: schema_dot_org
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.4.0
 platform: ruby
 authors:
-- Robb Shecter
+- Robert Shecter
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -67,7 +67,7 @@ dependencies:
         version: '3.12'
 description: Creates well-formed website metadata with strongly typed Ruby.
 email:
-- robb@public.law
+- robert@public.law
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -85,6 +85,7 @@ files:
 - bin/tapioca
 - lib/schema_dot_org.rb
 - lib/schema_dot_org/aggregate_offer.rb
+- lib/schema_dot_org/breadcrumb_list.rb
 - lib/schema_dot_org/college_or_university.rb
 - lib/schema_dot_org/comment.rb
 - lib/schema_dot_org/contact_point.rb