schema_dot_org 1.8 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06cd16270256965fffed468bd43d1d8ce63495a914963ef98513057f4396adb5
-  data.tar.gz: 311628c167b40934f5605494dab52be36b920b7c5d5d3c238a8657700b2ce3f2
+  metadata.gz: 643f2d209ee7cac02447c46cc8f5c14682163dd171db5d3c1b5fdf84382a3eab
+  data.tar.gz: cab0857ac26be75638701893e328db0a93840a368b46df5e5e6a106ccb98f3be
 SHA512:
-  metadata.gz: 01a6cb68d63637825dd2cb3747a50afa9aa241cba449b2db93febd982733a8dba566711e1b0e5c3b6fa23226d0f3809c29f94ba65bae26c3000155a65251acda
-  data.tar.gz: 54b97418cb8a71ae40636778d8823e7dc0c91260b3cab7135323471fe36710b40b6eb6a072b5232e658e89cd91be1491c450cf2f32ea7706df558eaa43c67c78
+  metadata.gz: 69e7822b9097e10d3a4d51053f32982fddde76ffcccd3f611474d08c6ef890dc31a16cd3bcf14d6420b592ff80fff756b8737f733a0e57c1ffcc0be925772025
+  data.tar.gz: 65e88820be2cdedb39aee20ca85bc14e1866b64a2737323076bba3d18d39184cc37b192edfbc65ba5ba1b194de0f9339fece13fb1e7fdd7d72e755bf3442e800

data/Gemfile.lock

@@ -1,39 +1,51 @@
 PATH
   remote: .
   specs:
-    schema_dot_org (1.8)
+    schema_dot_org (2.0)
       validated_object (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4.2)
-      activesupport (= 7.0.4.2)
-    activesupport (7.0.4.2)
+    activemodel (7.1.1)
+      activesupport (= 7.1.1)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-    concurrent-ruby (1.2.0)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     diff-lcs (1.5.0)
-    i18n (1.12.0)
+    drb (2.1.1)
+      ruby2_keywords
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    minitest (5.17.0)
+    minitest (5.20.0)
+    mutex_m (0.1.2)
     rake (13.0.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    sorbet-runtime (0.5.10647)
+    rspec-support (3.12.1)
+    ruby2_keywords (0.0.5)
+    sorbet-runtime (0.5.10993)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     validated_object (2.2.0)
@@ -41,13 +53,13 @@ GEM
       sorbet-runtime (>= 0.5.5890)
 
 PLATFORMS
-  ruby
+  arm64-darwin-22
 
 DEPENDENCIES
-  bundler (~> 2)
-  rake (>= 12.3.3)
-  rspec (~> 3.0)
+  bundler (~> 2.4)
+  rake (~> 13.0)
+  rspec (~> 3.12)
   schema_dot_org!
 
 BUNDLED WITH
-   2.2.15
+   2.4.20

data/README.md

@@ -2,7 +2,7 @@
 
 # SchemaDotOrg
 
-Let's create [Structured Data](https://developers.google.com/search/docs/guides/intro-structured-data) with correct **syntax** and **semantics**,
+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).
 
 > 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 . . .

data/lib/schema_dot_org/aggregate_offer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'schema_dot_org'
+require 'schema_dot_org/offer'
+
+# Model the Schema.org `Thing > Place`.  See https://schema.org/Offer
+#
+module SchemaDotOrg
+  class AggregateOffer < SchemaType
+    attr_accessor :priceCurrency,
+                  :highPrice,
+                  :lowPrice,
+                  :offerCount,
+                  :offers
+
+    validates :lowPrice,       type: Numeric
+    validates :highPrice,      type: Numeric, allow_nil: true
+    validates :offerCount,     type: String, allow_nil: true
+    validates :offers,         type: Array, allow_nil: true
+
+    def _to_json_struct
+      {
+        "priceCurrency" => priceCurrency,
+        "lowPrice" => lowPrice,
+        "highPrice" => highPrice,
+        "offerCount" => offerCount,
+        "offers" => offers.map(&:to_json_struct)
+      }
+    end
+
+    def offers
+      @offers || []
+    end
+  end
+end

data/lib/schema_dot_org/contact_point.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'schema_dot_org'
+
+
+module SchemaDotOrg
+  # Model the Schema.org `ContactPoint`.  See http://schema.org/ContactPoint
+  class ContactPoint < SchemaType
+    attr_accessor :telephone,
+                  :contact_type,
+                  :contact_option,
+                  :area_served,
+                  :available_language
+
+    validates :telephone,           type: String, presence: true
+    validates :contact_type,        type: String, presence: true
+    validates :contact_option,      type: String, allow_nil: true
+    validates :area_served,         type: Array, allow_nil: true
+    validates :available_language,  type: Array, allow_nil: true
+
+    def _to_json_struct
+      {
+        'telephone' => telephone,
+        'contactType' => contact_type,
+        'contactOption' => contact_option,
+        'areaServed' => area_served,
+        'availableLanguage' => available_language
+      }
+    end
+  end
+end

data/lib/schema_dot_org/item_list.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'schema_dot_org'
+
+module SchemaDotOrg
+  # Model the Schema.org `ItemList`.  See https://schema.org/ItemList
+  class ItemList < SchemaType
+    attr_accessor :itemListOrder,
+                  :numberOfItems,
+                  :url,
+                  :image,
+                  :itemListElement
+
+    
+    validates :itemListElement,   type: Array,    presence: true
+    validates :itemListOrder,     type: String,   allow_nil: true
+    validates :numberOfItems,     type: Integer,  allow_nil: true
+
+    validates :url,               type: String,   allow_nil: true
+    validates :image,             type: String,   allow_nil: true
+
+
+    def _to_json_struct
+      {
+        'itemListOrder' => itemListOrder,
+        'numberOfItems' => numberOfItems,
+        'url' => url,
+        'image' => image,
+        'itemListElement' => itemListElement.map(&:to_json_struct)
+      }
+    end
+
+    def itemListElement
+      @itemListElement || []
+    end
+  end
+end

data/lib/schema_dot_org/list_item.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'schema_dot_org'
+require 'schema_dot_org/product'
+
+
+module SchemaDotOrg
+  # Model the Schema.org `ItemListElement`.  See https://schema.org/ItemListElement
+  class ListItem < SchemaType
+    attr_accessor :position, :item,
+                  :url, :name, :image
+
+    validates :position,      type: Integer, presence: true
+    validates :url,           type: String, allow_nil: true
+    validates :name,          type: String, allow_nil: true
+    validates :image,         type: String, allow_nil: true
+
+    validates :item,         type: Product, allow_nil: true
+
+    def _to_json_struct
+      {
+        'position' => position,
+        'url' => url,
+        'name' => name,
+        'image' => image,
+        'item' => object_to_json_struct(item)
+      }
+    end
+  end
+end

data/lib/schema_dot_org/offer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'schema_dot_org'
+
+# Model the Schema.org `Thing > Place`.  See https://schema.org/Offer
+#
+module SchemaDotOrg
+  class Offer < SchemaType
+    attr_accessor :priceCurrency,
+                  :price,
+                  :availability,
+                  :url
+
+    validates :priceCurrency,       type: String
+    validates :price,               type: Numeric
+    validates :availability,        type: String, allow_nil: true
+    validates :url,                 type: String, allow_nil: true
+
+    def _to_json_struct
+      {
+        "price" => price,
+        "priceCurrency" => priceCurrency,
+        "availability" => availability,
+        "url" => url
+      }
+    end
+  end
+end

data/lib/schema_dot_org/organization.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 require 'date'
+require 'schema_dot_org'
+require 'schema_dot_org/person'
+require 'schema_dot_org/place'
+require 'schema_dot_org/contact_point'
+
 
 module SchemaDotOrg
   class Organization < SchemaType
@@ -11,28 +16,35 @@ module SchemaDotOrg
                   :logo,
                   :name,
                   :url,
-                  :same_as
+                  :same_as,
+                  :contact_points
 
-    validates :email,             type: String
-    validates :founder,           type: SchemaDotOrg::Person
-    validates :founding_date,     type: Date
-    validates :founding_location, type: SchemaDotOrg::Place
+    validates :email,             type: String, allow_nil: true
+    validates :founder,           type: SchemaDotOrg::Person, allow_nil: true
+    validates :founding_date,     type: Date, allow_nil: true
+    validates :founding_location, type: SchemaDotOrg::Place, allow_nil: true
     validates :logo,              type: String
     validates :name,              type: String
     validates :url,               type: String
     validates :same_as,           type: Array, allow_nil: true
+    validates :contact_points,    type: Array, allow_nil: true
 
     def _to_json_struct
       {
-        'name' => name,
-        'email' => email,
-        'url' => url,
-        'logo' => logo,
-        'founder' => founder.to_json_struct,
-        'foundingDate' => founding_date.to_s,
-        'foundingLocation' => founding_location.to_json_struct,
-        'sameAs' => same_as
+        "name" => name,
+        "email" => email,
+        "url" => url,
+        "logo" => logo,
+        "founder" => object_to_json_struct(founder),
+        "foundingDate" => founding_date.to_s,
+        "foundingLocation" => object_to_json_struct(founding_location),
+        "sameAs" => same_as,
+        "contactPoint" => contact_points.map(&:to_json_struct)
       }
     end
+
+    def contact_points
+      @contact_points || []
+    end
   end
 end

data/lib/schema_dot_org/person.rb

@@ -4,12 +4,19 @@
 module SchemaDotOrg
   # Model the Schema.org `Person`.  See http://schema.org/Person
   class Person < SchemaType
-    attr_accessor :name
-    validates :name, type: String, presence: true
+    attr_accessor :name,
+                  :url,
+                  :same_as
+
+    validates :name,    type: String, presence: true
+    validates :url,     type: String, allow_nil: true
+    validates :same_as, type: Array, allow_nil: true
 
     def _to_json_struct
       {
-        'name' => name
+        'name' => name,
+        'url' => url,
+        'same_as' => same_as
       }
     end
   end

data/lib/schema_dot_org/product.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'schema_dot_org'
+require 'schema_dot_org/aggregate_offer'
+
+# Model the Schema.org `Thing > Place`.  See https://schema.org/Product
+#
+module SchemaDotOrg
+  class Product < SchemaType
+    attr_accessor :name,
+                  :url,
+                  :description,
+                  :image,
+                  :offers
+
+    validates :name,              type: String
+    validates :url,               type: String
+    validates :description,       type: String, allow_nil: true
+    validates :image,             type: Array, allow_nil: true
+    validates :offers,            type: SchemaDotOrg::AggregateOffer
+
+    def _to_json_struct
+      {
+        "name" => name,
+        "url" => url,
+        "description" => description,
+        "image" => image,
+        "offers" => offers.to_json_struct
+      }
+    end
+
+    def image
+      @image || []
+    end
+  end
+end

data/lib/schema_dot_org/schema_type.rb

@@ -0,0 +1,67 @@
+require 'json'
+require 'validated_object'
+
+module SchemaDotOrg
+  class SchemaType < ValidatedObject::Base
+    ROOT_ATTR = { "@context" => "http://schema.org" }.freeze
+    UNQUALIFIED_CLASS_NAME_REGEX = /([^:]+)$/
+
+
+    def to_s
+      json_string = to_json_ld(pretty: (!rails_production? && !ENV['SCHEMA_DOT_ORG_MINIFIED_JSON']))
+
+      # Mark as safe if we're in Rails
+      if json_string.respond_to?(:html_safe)
+        json_string.html_safe
+      else
+        json_string
+      end
+    end
+
+
+    def to_json_ld(pretty: false)
+      "<script type=\"application/ld+json\">\n" + to_json(pretty: pretty, as_root: true) + "\n</script>"
+    end
+
+
+    def to_json(pretty: false, as_root: false)
+      structure = as_root ? ROOT_ATTR.merge(to_json_struct) : to_json_struct
+
+      if pretty
+        JSON.pretty_generate(structure)
+      else
+        structure.to_json
+      end
+    end
+
+
+    # Use the class name to create the "@type" attribute.
+    # @return a hash structure representing json.
+    def to_json_struct
+      { "@type" => un_namespaced_classname }.merge(_to_json_struct.reject { |_, v| v.blank? })
+    end
+
+
+    def _to_json_struct
+      raise "For subclasses to implement"
+    end
+
+
+    # @return the classname without the module namespace.
+    def un_namespaced_classname
+      self.class.name =~ UNQUALIFIED_CLASS_NAME_REGEX
+      Regexp.last_match(1)
+    end
+
+    def object_to_json_struct(object)
+      return nil unless object
+      object.to_json_struct
+    end
+
+    private
+
+    def rails_production?
+      defined?(Rails) && Rails.env.production?
+    end
+  end
+end

data/lib/schema_dot_org/web_site.rb

@@ -12,9 +12,9 @@ module SchemaDotOrg
 
     def _to_json_struct
       {
-        'name' => name,
-        'url' => url,
-        'potentialAction' => potential_action&.to_json_struct
+        'name' => self.name,
+        'url' =>  self.url,
+        'potentialAction' => object_to_json_struct(potential_action)
       }
     end
   end

data/lib/schema_dot_org.rb

@@ -1,63 +1,18 @@
 # frozen_string_literal: true
-
-require 'json'
-require 'validated_object'
+require 'schema_dot_org/schema_type'
+require 'schema_dot_org/search_action'
+require 'schema_dot_org/web_site'
+require 'schema_dot_org/organization'
+require 'schema_dot_org/product'
+require 'schema_dot_org/item_list'
+require 'schema_dot_org/list_item'
+require 'schema_dot_org/person'
+require 'schema_dot_org/place'
+require 'schema_dot_org/aggregate_offer'
+require 'schema_dot_org/offer'
+require 'schema_dot_org/contact_point'
 
 module SchemaDotOrg
-  #
-  # Base class for schema types. Refactors out common code.
-  #
-  class SchemaType < ValidatedObject::Base
-    ROOT_ATTR = { '@context' => 'http://schema.org' }.freeze
-    UNQUALIFIED_CLASS_NAME_REGEX = /([^:]+)$/.freeze
-
-    def to_s
-      json_string = to_json_ld(pretty: (!rails_production? && !ENV['SCHEMA_DOT_ORG_MINIFIED_JSON']))
-
-      # Mark as safe if we're in Rails
-      if json_string.respond_to?(:html_safe)
-        json_string.html_safe
-      else
-        json_string
-      end
-    end
-
-    def to_json_ld(pretty: false)
-      "<script type=\"application/ld+json\">\n" + to_json(pretty: pretty, as_root: true) + "\n</script>"
-    end
-
-    def to_json(pretty: false, as_root: false)
-      structure = as_root ? ROOT_ATTR.merge(to_json_struct) : to_json_struct
-
-      if pretty
-        JSON.pretty_generate(structure)
-      else
-        structure.to_json
-      end
-    end
-
-    # Use the class name to create the "@type" attribute.
-    # @return a hash structure representing json.
-    def to_json_struct
-      { '@type' => un_namespaced_classname }.merge(_to_json_struct.compact)
-    end
-
-    def _to_json_struct
-      raise 'For subclasses to implement'
-    end
-
-    # @return the classname without the module namespace.
-    def un_namespaced_classname
-      self.class.name =~ UNQUALIFIED_CLASS_NAME_REGEX
-      Regexp.last_match(1)
-    end
-
-    private
-
-    def rails_production?
-      defined?(Rails) && Rails.env.production?
-    end
-  end
 end
 
 

data/schema_dot_org.gemspec

@@ -7,7 +7,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.6'
   spec.name          = 'schema_dot_org'
-  spec.version       = '1.8'
+  spec.version       = '2.0'
   spec.authors       = ['Robb Shecter']
   spec.email         = ['robb@public.law']
 
@@ -20,14 +20,14 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
+
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_dependency 'validated_object', '~> 2.2'
 
-
-  spec.add_development_dependency 'bundler', '~> 2'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency "bundler", "~> 2.4"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
 end

data/test-script.rb

@@ -2,11 +2,8 @@
 # frozen_string_literal: true
 
 require 'date'
+require 'schema_dot_org'
 
-require 'schema_dot_org/person'
-require 'schema_dot_org/place'
-require 'schema_dot_org/organization'
-require 'schema_dot_org/web_site'
 include SchemaDotOrg
 
 public_law = Organization.new(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_dot_org
 version: !ruby/object:Gem::Version
-  version: '1.8'
+  version: '2.0'
 platform: ruby
 authors:
 - Robb Shecter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: validated_object
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
 description: Creates well-formed website metadata with strongly typed Ruby.
 email:
 - robb@public.law
@@ -86,12 +86,18 @@ files:
 - bin/setup
 - bin/tapioca
 - lib/schema_dot_org.rb
+- lib/schema_dot_org/aggregate_offer.rb
+- lib/schema_dot_org/contact_point.rb
+- lib/schema_dot_org/item_list.rb
+- lib/schema_dot_org/list_item.rb
+- lib/schema_dot_org/offer.rb
 - lib/schema_dot_org/organization.rb
 - lib/schema_dot_org/person.rb
 - lib/schema_dot_org/place.rb
+- lib/schema_dot_org/product.rb
+- lib/schema_dot_org/schema_type.rb
 - lib/schema_dot_org/search_action.rb
 - lib/schema_dot_org/web_site.rb
-- run-script
 - schema_dot_org.gemspec
 - test-script.rb
 homepage: https://github.com/public-law/schema-dot-org
@@ -113,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: JSON-LD generator for Schema.org vocabulary

data/run-script

@@ -1,2 +0,0 @@
-#!/bin/bash
-ruby -I lib ./test-script.rb