schema_dot_org 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39339b796fe48d129c05873ab0a10b6d4ebd683b982723049e25e1bb98b1b893
-  data.tar.gz: 8e3c46e25e0e00849db2e0817c141f563209fb2ebbf9ec67a10fe8bc8241b9c2
+  metadata.gz: 146e2c23c546ada2f45452f78d5e609e0730256b24b72811c834306ef69b5409
+  data.tar.gz: c1dbd6ee1c3af15b07b3188eea8decf036e3bc52c97379d78bea1f7ca16a25ea
 SHA512:
-  metadata.gz: 243792759980ee75f52dbc022aa59bb211b7a250a1af1078e5d167cd1700ae858d1588aafc9fd9a5ab92a7c89166fc437442ab176e9502744fbd6e7ff1bb2cd8
-  data.tar.gz: 17abef45bb90add2f3cb699720950a2402cc6c84fad5e37672710caf26ddf9b4556204481e418726322642245172b18b8d634e58088a083296a119f168c25799
+  metadata.gz: ea5016b6e3075a5aa21d82faf8a7e00b42f920637b6e8dd97c7a54998eae6fcfb8ae4f98a15a6e45cd471b1614598d0f007f54f67545043b63af89ff1ec85fff
+  data.tar.gz: ae7aaf1fbcea2b10918d224c89c26fa71725cf6dac52d27f5960a7096726ca7d3b9c1866477651084d20e71fe118049de3fa4b646fbc26c0da671db2d064b168

data/Gemfile.lock

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

data/README.md

@@ -90,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 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.
+
 ### WebSite
 
 Example with only the required attributes:
@@ -146,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

@@ -1,9 +1,6 @@
 # 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
@@ -14,19 +11,5 @@ module SchemaDotOrg
     validated_attr :highPrice,  type: Numeric, allow_nil: true
     validated_attr :offerCount, type: String, allow_nil: true
     validated_attr :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

@@ -1,25 +1,15 @@
 # frozen_string_literal: true
 
-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
-    validated_attr :telephone,           type: String,  presence:  true
-    validated_attr :contact_type,        type: String,  presence:  true
-    validated_attr :contact_option,      type: String,  allow_nil: true
     validated_attr :area_served,         type: Array,   allow_nil: true
     validated_attr :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 :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

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-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
     validated_attr :itemListElement,   type: Array,    presence: true
     validated_attr :itemListOrder,     type: String,   allow_nil: true
@@ -11,20 +12,5 @@ module SchemaDotOrg
 
     validated_attr :url,               type: String,   allow_nil: true
     validated_attr :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

@@ -1,27 +1,17 @@
 # frozen_string_literal: true
 
-require 'schema_dot_org'
-require 'schema_dot_org/product'
 
+require_relative 'product'
 
+#
+# Model the Schema.org `ItemListElement`.  See https://schema.org/ItemListElement
+#
 module SchemaDotOrg
-  # Model the Schema.org `ItemListElement`.  See https://schema.org/ItemListElement
   class ListItem < SchemaType
-    validated_attr :position,      type: Integer, presence: true
-    validated_attr :url,           type: String, allow_nil: true
-    validated_attr :name,          type: String, allow_nil: true
-    validated_attr :image,         type: String, allow_nil: true
-
-    validated_attr :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: SchemaDotOrg::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

@@ -1,24 +1,14 @@
 # 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
-    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
-
-    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

@@ -1,42 +1,21 @@
 # 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'
 
+require_relative 'person'
+require_relative 'place'
 
 module SchemaDotOrg
   class Organization < SchemaType
+    validated_attr :contact_points,    type: Array, allow_nil: true
     validated_attr :email,             type: String, allow_nil: true
-    validated_attr :telephone,         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 :url,               type: String
     validated_attr :same_as,           type: Array, allow_nil: true
-    validated_attr :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 :telephone,         type: String, allow_nil: true
+    validated_attr :url,               type: String
   end
 end

data/lib/schema_dot_org/person.rb

@@ -1,20 +1,13 @@
 # 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
     validated_attr :name,    type: String, presence: true
     validated_attr :same_as, type: Array,  allow_nil: true
     validated_attr :url,     type: String, allow_nil: true
-
-
-    def _to_json_struct
-      {
-        'name'    => name,
-        'url'     => url,
-        'same_as' => same_as
-      }
-    end
   end
 end

data/lib/schema_dot_org/place.rb

@@ -1,15 +1,11 @@
 # 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
     validated_attr :address, type: String, presence: true
-
-    def _to_json_struct
-      {
-        'address' => address
-      }
-    end
   end
 end

data/lib/schema_dot_org/product.rb

@@ -1,31 +1,15 @@
 # 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
-    validated_attr :name,         type: String
-    validated_attr :url,          type: String
     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
-
-    def _to_json_struct
-      {
-        "name" => name,
-        "url" => url,
-        "description" => description,
-        "image" => image,
-        "offers" => offers.to_json_struct
-      }
-    end
-
-    def image
-      @image || []
-    end
+    validated_attr :url,          type: String
   end
 end

data/lib/schema_dot_org/search_action.rb

@@ -1,17 +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
-    validated_attr :target,      type: String, presence: true
+  class SearchAction < SchemaDotOrg::SchemaType
     validated_attr :query_input, type: String, presence: true
-
-    def _to_json_struct
-      {
-        'target' => target,
-        'query-input' => query_input ## ! Note the hyphen.
-      }
-    end
+    validated_attr :target,      type: String, presence: true
   end
 end

data/lib/schema_dot_org/web_site.rb

@@ -1,21 +1,14 @@
 # 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
     validated_attr :name,             type: String, presence: true
-    validated_attr :url,              type: String, presence: true
     validated_attr :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 :url,              type: String, presence: true
   end
 end

data/lib/schema_dot_org.rb

@@ -1,16 +1,127 @@
 # frozen_string_literal: true
-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 'json'
+require 'validated_object'
+
+#
+# Abstract base class for all the Schema.org types.
+#
+module SchemaDotOrg
+  class SchemaType < ValidatedObject::Base
+    ROOT_ATTR = { "@context" => "https://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
+      attrs_and_values
+    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
+
+
+    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?
+    end
+  end
+end
+
+
+require 'schema_dot_org/aggregate_offer'
+require 'schema_dot_org/contact_point'
 require 'schema_dot_org/item_list'
 require 'schema_dot_org/list_item'
+require 'schema_dot_org/organization'
 require 'schema_dot_org/person'
 require 'schema_dot_org/place'
-require 'schema_dot_org/aggregate_offer'
+require 'schema_dot_org/product'
 require 'schema_dot_org/offer'
-require 'schema_dot_org/contact_point'
-
-module SchemaDotOrg
-end
+require 'schema_dot_org/search_action'
+require 'schema_dot_org/web_site'

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.2.0'
+  spec.version       = '2.2.2'
   spec.authors       = ['Robb Shecter']
   spec.email         = ['robb@public.law']
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_dot_org
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Robb Shecter
@@ -95,7 +95,6 @@ files:
 - 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
 - schema_dot_org.gemspec

data/lib/schema_dot_org/schema_type.rb

@@ -1,67 +0,0 @@
-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