schema_dot_org 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e51372213bf0a5e8a9330e21695ef2da7953777627d38df1e5fc3381ea01c446
-  data.tar.gz: 9d8faef75d7ef9461d40af04900cbeed15f9afb3f1eab7278e70b49e775d2228
+  metadata.gz: 146e2c23c546ada2f45452f78d5e609e0730256b24b72811c834306ef69b5409
+  data.tar.gz: c1dbd6ee1c3af15b07b3188eea8decf036e3bc52c97379d78bea1f7ca16a25ea
 SHA512:
-  metadata.gz: df934ac4daf68337bed44ff56b99763ea350f0d9a09f476f2bae1a9d7231b7b1583696fe0dd1c6c74786e59d55d39ccec9a51807a89f77ad69e6c70208ad6a72
-  data.tar.gz: 68a81e34cb06baccf9743fe25ac20f674cf9e2c3972b252f4a80b212fb12b232555288c7dd2e3833d4505cefaefde5e2097ce4ba8a4e46cfaf7d3e301dbf69d5
+  metadata.gz: ea5016b6e3075a5aa21d82faf8a7e00b42f920637b6e8dd97c7a54998eae6fcfb8ae4f98a15a6e45cd471b1614598d0f007f54f67545043b63af89ff1ec85fff
+  data.tar.gz: ae7aaf1fbcea2b10918d224c89c26fa71725cf6dac52d27f5960a7096726ca7d3b9c1866477651084d20e71fe118049de3fa4b646fbc26c0da671db2d064b168

data/Gemfile.lock

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

data/README.md

@@ -93,7 +93,7 @@ This type safety comes from the [ValidatedObject gem](https://github.com/dogweat
 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
+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

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

data/lib/schema_dot_org/contact_point.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'schema_dot_org'
-
 
 #
 # Model the Schema.org `ContactPoint`.  See http://schema.org/ContactPoint

data/lib/schema_dot_org/item_list.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'schema_dot_org'
 
 #
 # Model the Schema.org `ItemList`.  See https://schema.org/ItemList

data/lib/schema_dot_org/list_item.rb

@@ -1,16 +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 :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
+    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,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'date'
-require 'schema_dot_org'
 
 #
 # Model the Schema.org `Thing > Place`.  See https://schema.org/Offer

data/lib/schema_dot_org/organization.rb

@@ -1,11 +1,9 @@
 # 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

data/lib/schema_dot_org/person.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+
 #
 # Model the Schema.org **Person**.  See http://schema.org/Person
 #

data/lib/schema_dot_org/place.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+
 #
 # Model the Schema.org `Thing > Place`.  See http://schema.org/Place
 #

data/lib/schema_dot_org/product.rb

@@ -1,8 +1,5 @@
 # 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

data/lib/schema_dot_org/search_action.rb

@@ -5,7 +5,7 @@
 # Model the Schema.org `Thing > SearchAction`.  See http://schema.org/SearchAction
 #
 module SchemaDotOrg
-  class SearchAction < SchemaType
+  class SearchAction < SchemaDotOrg::SchemaType
     validated_attr :query_input, type: String, presence: true
     validated_attr :target,      type: String, presence: true
   end

data/lib/schema_dot_org/web_site.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+
 #
 # Model the Schema.org `Thing > CreativeWork > WebSite`.
 # @See http://schema.org/WebSite

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.1'
+  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.1
+  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,110 +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
-      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