schema_dot_org 2.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 663a21ded2eb0b843caa9f238b4fca6b46705355296b2e68f199e1288e5fe73e
-  data.tar.gz: 16ae086bf62fd2c3ff5c73bf24a16ec2654b7935e23a334a3b990a51d35d0a58
+  metadata.gz: e51372213bf0a5e8a9330e21695ef2da7953777627d38df1e5fc3381ea01c446
+  data.tar.gz: 9d8faef75d7ef9461d40af04900cbeed15f9afb3f1eab7278e70b49e775d2228
 SHA512:
-  metadata.gz: 8e76b02294c13dab79d20be1851b181c1147f40b24e7a84a1191b1e92e2d08956d977e6bac977e02838d04522bd6ab559d7a31693babe26296d5664dca16e2d5
-  data.tar.gz: '0748bf804827c3439e018a85b7f0b9741f7d238ab6ccbbeb364bc770ee09131a23cc421eeaa5a3ac5fe18e7ada157c119e5ccdbcbff86ef830471a308240bd5b'
+  metadata.gz: df934ac4daf68337bed44ff56b99763ea350f0d9a09f476f2bae1a9d7231b7b1583696fe0dd1c6c74786e59d55d39ccec9a51807a89f77ad69e6c70208ad6a72
+  data.tar.gz: 68a81e34cb06baccf9743fe25ac20f674cf9e2c3972b252f4a80b212fb12b232555288c7dd2e3833d4505cefaefde5e2097ce4ba8a4e46cfaf7d3e301dbf69d5

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    schema_dot_org (2.1)
-      validated_object (~> 2.2)
+    schema_dot_org (2.2.1)
+      validated_object (~> 2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -45,10 +45,10 @@ GEM
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
     ruby2_keywords (0.0.5)
-    sorbet-runtime (0.5.10993)
+    sorbet-runtime (0.5.11072)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    validated_object (2.2.0)
+    validated_object (2.3.0)
       activemodel (>= 3.2.21)
       sorbet-runtime (>= 0.5.5890)
 

data/README.md

@@ -18,6 +18,7 @@ Let's say you have a Rails app. If you put this in a controller:
   founding_date:     Date.new(2009, 3, 6),
   founding_location: Place.new(address: 'Portland, OR'),
   email:            'say_hi@public.law',
+  telephone:        '+1 123 456 7890',
   url:              'https://www.public.law',
   logo:             'https://www.public.law/favicon-196x196.png',
   same_as: [
@@ -42,6 +43,7 @@ Let's say you have a Rails app. If you put this in a controller:
   "@type": "Organization",
   "name": "Public.Law",
   "email": "say_hi@public.law",
+  "telephone": "+1 123 456 7890",
   "url": "https://www.public.law",
   "logo": "https://www.public.law/favicon-196x196.png",
   "foundingDate": "2009-03-06",
@@ -88,6 +90,12 @@ This type safety comes from the [ValidatedObject gem](https://github.com/dogweat
 
 ## Supported Schema.org Types
 
+AggregateOffer, ContactPoint, ItemList, ListItem, Offer, Organization, Person, Place,
+Product, SearchAction, and WebSite.
+
+Here are a few example. The source code for these is **extremely easy** to read. Check them out to see
+all the available attributes.
+
 ### WebSite
 
 Example with only the required attributes:
@@ -144,19 +152,26 @@ Add this line to your application's Gemfile:
 gem 'schema_dot_org'
 ```
 
-And then execute:
-
-    $ bundle
+## Development
 
-Or install it yourself as:
+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`:
 
-    $ gem install schema_dot_org
+```ruby
+class Product < SchemaType
+  validated_attr :description,  type: String, allow_nil: true
+  validated_attr :image,        type: Array,  allow_nil: true
+  validated_attr :name,         type: String
+  validated_attr :offers,       type: SchemaDotOrg::AggregateOffer
+  validated_attr :url,          type: String
+end
+```
 
-## Development
+The attributes are from the [Schema.org Product spec](https://schema.org/Product).
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+All Rails validations are available. These are just the attributes we've felt like
+adding. PR's are welcome if you want to add more. Also for more Schema.org types.
 
-To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/lib/schema_dot_org/aggregate_offer.rb

@@ -8,29 +8,11 @@ require 'schema_dot_org/offer'
 #
 module SchemaDotOrg
   class AggregateOffer < SchemaType
-    attr_accessor :priceCurrency,
-                  :highPrice,
-                  :lowPrice,
-                  :offerCount,
-                  :offers
+    attr_reader :priceCurrency
 
-    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
+    validated_attr :lowPrice,   type: Numeric
+    validated_attr :highPrice,  type: Numeric, allow_nil: true
+    validated_attr :offerCount, type: String, allow_nil: true
+    validated_attr :offers,     type: Array, allow_nil: true
   end
 end

data/lib/schema_dot_org/contact_point.rb

@@ -3,29 +3,15 @@
 require 'schema_dot_org'
 
 
+#
+# Model the Schema.org `ContactPoint`.  See http://schema.org/ContactPoint
+#
 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
+    validated_attr :area_served,         type: Array,   allow_nil: true
+    validated_attr :available_language,  type: Array,   allow_nil: true
+    validated_attr :contact_option,      type: String,  allow_nil: true
+    validated_attr :contact_type,        type: String,  presence:  true
+    validated_attr :telephone,           type: String,  presence:  true
   end
 end

data/lib/schema_dot_org/item_list.rb

@@ -2,36 +2,16 @@
 
 require 'schema_dot_org'
 
+#
+# Model the Schema.org `ItemList`.  See https://schema.org/ItemList
+#
 module SchemaDotOrg
-  # Model the Schema.org `ItemList`.  See https://schema.org/ItemList
   class ItemList < SchemaType
-    attr_accessor :itemListOrder,
-                  :numberOfItems,
-                  :url,
-                  :image,
-                  :itemListElement
+    validated_attr :itemListElement,   type: Array,    presence: true
+    validated_attr :itemListOrder,     type: String,   allow_nil: true
+    validated_attr :numberOfItems,     type: Integer,  allow_nil: true
 
-    
-    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
+    validated_attr :url,               type: String,   allow_nil: true
+    validated_attr :image,             type: String,   allow_nil: true
   end
 end

data/lib/schema_dot_org/list_item.rb

@@ -7,24 +7,10 @@ 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
+    validated_attr :image,     type: String,  allow_nil: true
+    validated_attr :item,      type: Product, allow_nil: true
+    validated_attr :name,      type: String,  allow_nil: true
+    validated_attr :position,  type: Integer, presence:  true
+    validated_attr :url,       type: String,  allow_nil: true
   end
 end

data/lib/schema_dot_org/offer.rb

@@ -3,27 +3,14 @@
 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
+    validated_attr :priceCurrency, type: String
+    validated_attr :price,         type: Numeric
+    validated_attr :availability,  type: String, allow_nil: true
+    validated_attr :url,           type: String, allow_nil: true
   end
 end

data/lib/schema_dot_org/organization.rb

@@ -9,45 +9,15 @@ require 'schema_dot_org/contact_point'
 
 module SchemaDotOrg
   class Organization < SchemaType
-    attr_accessor :email,
-                  :telephone,
-                  :founder,
-                  :founding_date,
-                  :founding_location,
-                  :logo,
-                  :name,
-                  :url,
-                  :same_as,
-                  :contact_points
-
-    validates :email,             type: String, allow_nil: true
-    validates :telephone,         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,
-        "telephone" => telephone,
-        "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
+    validated_attr :contact_points,    type: Array, allow_nil: true
+    validated_attr :email,             type: String, allow_nil: true
+    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 :logo,              type: String
+    validated_attr :name,              type: String
+    validated_attr :same_as,           type: Array, allow_nil: true
+    validated_attr :telephone,         type: String, allow_nil: true
+    validated_attr :url,               type: String
   end
 end

data/lib/schema_dot_org/person.rb

@@ -1,23 +1,12 @@
 # frozen_string_literal: true
 
-
+#
+# Model the Schema.org **Person**.  See http://schema.org/Person
+#
 module SchemaDotOrg
-  # Model the Schema.org `Person`.  See http://schema.org/Person
   class Person < SchemaType
-    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,
-        'url' => url,
-        'same_as' => same_as
-      }
-    end
+    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/place.rb

@@ -1,16 +1,10 @@
 # frozen_string_literal: true
 
-
+#
+# Model the Schema.org `Thing > Place`.  See http://schema.org/Place
+#
 module SchemaDotOrg
-  # Model the Schema.org `Thing > Place`.  See http://schema.org/Place
   class Place < SchemaType
-    attr_accessor :address
-    validates :address, type: String, presence: true
-
-    def _to_json_struct
-      {
-        'address' => address
-      }
-    end
+    validated_attr :address, type: String, presence: true
   end
 end

data/lib/schema_dot_org/product.rb

@@ -4,34 +4,15 @@ 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
+    validated_attr :description,  type: String, allow_nil: true
+    validated_attr :image,        type: Array,  allow_nil: true
+    validated_attr :name,         type: String
+    validated_attr :offers,       type: SchemaDotOrg::AggregateOffer
+    validated_attr :url,          type: String
   end
 end

data/lib/schema_dot_org/schema_type.rb

@@ -43,7 +43,7 @@ module SchemaDotOrg
 
 
     def _to_json_struct
-      raise "For subclasses to implement"
+      attrs_and_values
     end
 
 
@@ -53,12 +53,55 @@ module SchemaDotOrg
       Regexp.last_match(1)
     end
 
+
     def object_to_json_struct(object)
       return nil unless object
       object.to_json_struct
     end
 
-    private
+
+    def attrs_and_values
+      attrs.map do |attr|
+        # Clean up and andle the `query-input` attribute, which
+        # doesn't follow the normal camelCase convention.
+        attr_name   = snake_case_to_lower_camel_case(attr.to_s.delete_prefix('@')).sub('queryInput', 'query-input')
+        attr_value = instance_variable_get(attr)
+
+        [attr_name, resolve_value(attr_value)]
+      end.to_h
+    end
+
+
+    def resolve_value(value)
+      if value.is_a?(Array)
+        value.map { |v| resolve_value(v) }
+
+      elsif value.is_a?(Date)
+        value.to_s
+
+      elsif is_schema_type?(value)
+        value.to_json_struct
+        
+      else
+        value
+      end
+    end
+
+
+    def snake_case_to_lower_camel_case(snake_case)
+      snake_case.to_s.split('_').map.with_index { |s, i| i.zero? ? s : s.capitalize }.join
+    end
+
+
+    def attrs
+      instance_variables.reject{ |v| [:@validation_context, :@errors].include?(v) }
+    end
+
+
+    def is_schema_type?(object)
+      object.class.module_parent == SchemaDotOrg
+    end
+
 
     def rails_production?
       defined?(Rails) && Rails.env.production?

data/lib/schema_dot_org/search_action.rb

@@ -1,18 +1,12 @@
 # frozen_string_literal: true
 
 
+#
+# Model the Schema.org `Thing > SearchAction`.  See http://schema.org/SearchAction
+#
 module SchemaDotOrg
-  # Model the Schema.org `Thing > SearchAction`.  See http://schema.org/SearchAction
   class SearchAction < SchemaType
-    attr_accessor :target, :query_input
-    validates :target,      type: String, presence: true
-    validates :query_input, type: String, presence: true
-
-    def _to_json_struct
-      {
-        'target' => target,
-        'query-input' => query_input ## ! Note the hyphen.
-      }
-    end
+    validated_attr :query_input, type: String, presence: true
+    validated_attr :target,      type: String, presence: true
   end
 end

data/lib/schema_dot_org/web_site.rb

@@ -1,21 +1,13 @@
 # frozen_string_literal: true
 
-
+#
+# Model the Schema.org `Thing > CreativeWork > WebSite`.
+# @See http://schema.org/WebSite
+#
 module SchemaDotOrg
-  # Model the Schema.org `Thing > CreativeWork > WebSite`.
-  # @See http://schema.org/WebSite
   class WebSite < SchemaType
-    attr_accessor :name, :url, :potential_action
-    validates :name,             type: String, presence: true
-    validates :url,              type: String, presence: true
-    validates :potential_action, type: SchemaDotOrg::SearchAction, allow_nil: true
-
-    def _to_json_struct
-      {
-        'name' => self.name,
-        'url' =>  self.url,
-        'potentialAction' => object_to_json_struct(potential_action)
-      }
-    end
+    validated_attr :name,             type: String, presence: true
+    validated_attr :potential_action, type: SchemaDotOrg::SearchAction, allow_nil: true
+    validated_attr :url,              type: String, presence: true
   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       = '2.1'
+  spec.version       = '2.2.1'
   spec.authors       = ['Robb Shecter']
   spec.email         = ['robb@public.law']
 
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'validated_object', '~> 2.2'
+  spec.add_dependency 'validated_object', '~> 2.3'
 
   spec.add_development_dependency "bundler", "~> 2.4"
   spec.add_development_dependency "rake", "~> 13.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_dot_org
 version: !ruby/object:Gem::Version
-  version: '2.1'
+  version: 2.2.1
 platform: ruby
 authors:
 - Robb Shecter
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement