schema_dot_org 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51ce5547733a21842002c07e64f087879b748fc0aca5f38be3b1719050b44eb8
-  data.tar.gz: 847aa9795b17a6903e6a8380ad24e11ae74f14db46225c6bf78965ec585c67a6
+  metadata.gz: acd0a2dabb408489cf628e16e4eaee549a84e62cd44493ee9e052707036ed059
+  data.tar.gz: a39970f8606e31d91d3a0dc9bba358964d8b8ea368855a347d9466227bb4c0d2
 SHA512:
-  metadata.gz: e5b6d909e5edd6999ee5051f1df5b0b8c5f5274172b1f602be3c17e2a5c0fcad9c0499e930e9a757c5c42d62597af4b2e8c89898c534008f63172567113cb53f
-  data.tar.gz: 04e8ef548d8dcf6dfb2e077fc759a472d29fe0da8a28a28b69b23e79b900daeebaa192d1e55c645dee169381252c20bba14930f2d6f4ecd8a42b93bb127e3aab
+  metadata.gz: 394de4b9c3cee09e40c831ee6654c14cf3b73d262c50927e2fb13b1c7e121c7b97f2f740895786ab00ab4ff1d7c01bfd132234bf48149420f81ac365c4749a79
+  data.tar.gz: 0aa3cb2bc48156361491d51419659b4504ad8b1016440763ffb8756b4936ca2375fb3f68255c389424ff1534afd39e8336397a894bbb91aff612eb7184330336

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.5.2
+
+* Improved code comments
+
 ## 2.5.1
 
 * New Type: PostalAddress

data/lib/schema_dot_org/aggregate_offer.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-#
-# Model the Schema.org `Thing > Intangible > Offer > AggregateOffer`.  See https://schema.org/Offer
-#
+
 module SchemaDotOrg
+  ##
+  # Model the Schema.org `Thing > Intangible > Offer > AggregateOffer`.  See https://schema.org/Offer
+  #
   class AggregateOffer < SchemaType
     attr_reader :priceCurrency
 

data/lib/schema_dot_org/breadcrumb_list.rb

@@ -1,16 +1,16 @@
 # 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
+  ##
+  # 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
+  #
   class BreadcrumbList < SchemaType
     validated_attr :itemListElement, type: Array, presence: true
   end

data/lib/schema_dot_org/college_or_university.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 
-#
-# https://schema.org/CollegeOrUniversity
-#
 module SchemaDotOrg
+  ##
+  # https://schema.org/CollegeOrUniversity
+  #
   class CollegeOrUniversity < SchemaType
     validated_attr :name, type: String, presence: true
     validated_attr :url,  type: String, allow_nil: true

data/lib/schema_dot_org/comment.rb

@@ -1,14 +1,13 @@
-
 # frozen_string_literal: true
 
 require 'date'
 require_relative 'person'
 
-#
-# Model the Schema.org `Thing > CreativeWork > Comment`.
-# See https://schema.org/Comment
-#
 module SchemaDotOrg
+  ##
+  # Model the Schema.org `Thing > CreativeWork > Comment`.
+  # See https://schema.org/Comment
+  #
   class Comment < SchemaType
     validated_attr :author,        type: Person, presence: true
     validated_attr :datePublished, type: Date,   presence: true

data/lib/schema_dot_org/contact_point.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 
-#
-# 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 :area_served,         type: Array,   allow_nil: true
     validated_attr :available_language,  type: Array,   allow_nil: true

data/lib/schema_dot_org/discussion_forum_posting.rb

@@ -4,11 +4,11 @@ require 'date'
 require_relative 'person'
 require_relative 'organization'
 
-#
-# Model the Schema.org `Thing > CreativeWork > Article > SocialMediaPosting > DiscussionForumPosting`.
-# See https://schema.org/DiscussionForumPosting
-#
 module SchemaDotOrg
+  ##
+  # Model the Schema.org `Thing > CreativeWork > Article > SocialMediaPosting > DiscussionForumPosting`.
+  # See https://schema.org/DiscussionForumPosting
+  #
   class DiscussionForumPosting < SchemaType
     validated_attr :author,        type: union(Person, Organization), presence: true
     validated_attr :datePublished, type: union(Date, Time),           presence: true

data/lib/schema_dot_org/interaction_counter.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-#
-# Model the Schema.org `Thing > Intangible > StructuredValue > InteractionCounter`.
-# See https://schema.org/InteractionCounter
-#
+
 module SchemaDotOrg
+  ##
+  # Model the Schema.org `Thing > Intangible > StructuredValue > InteractionCounter`.
+  # See https://schema.org/InteractionCounter
+  #
   class InteractionCounter < SchemaType
     validated_attr :userInteractionCount, type: Integer, presence: true
     validated_attr :interactionType,      type: String,  presence: true

data/lib/schema_dot_org/item_list.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 
-#
-# 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

data/lib/schema_dot_org/language.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-#
-# Model the Schema.org `Thing > Intangible > Language`.
-# See https://schema.org/Language
-#
+
 module SchemaDotOrg
+  ##
+  # Model the Schema.org `Thing > Intangible > Language`.
+  # See https://schema.org/Language
+  #
   class Language < SchemaType
     validated_attr :alternateName, type: String, allow_nil: true
     validated_attr :name,          type: String, presence: true

data/lib/schema_dot_org/list_item.rb

@@ -3,10 +3,10 @@
 
 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: Object,                allow_nil: true  # Allow String or SchemaType

data/lib/schema_dot_org/offer.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 
-#
-# Model the Schema.org `Thing > Intangible > Offer`.  See https://schema.org/Offer
-#
 module SchemaDotOrg
+  ##
+  # Model the Schema.org `Thing > Intangible > Offer`.  See https://schema.org/Offer
+  #
   class Offer < SchemaType
     validated_attr :priceCurrency, type: String
     validated_attr :price,         type: Numeric

data/lib/schema_dot_org/organization.rb

@@ -6,10 +6,11 @@ require_relative 'person'
 require_relative 'place'
 require_relative 'postal_address'
 
-# Google allows `url` to be a string:
-# https://developers.google.com/search/docs/appearance/structured-data/logo
 
 module SchemaDotOrg
+  ##
+  # See https://schema.org/Organization
+  #
   class Organization < SchemaType
     validated_attr :address,           type: SchemaDotOrg::PostalAddress, allow_nil: true
     validated_attr :contact_points,    type: Array, allow_nil: true
@@ -23,6 +24,9 @@ module SchemaDotOrg
     validated_attr :same_as,           type: Array, allow_nil: true
     validated_attr :slogan,            type: String, allow_nil: true
     validated_attr :telephone,         type: String, allow_nil: true
+
+    # Google allows `url` to be a string:
+    # https://developers.google.com/search/docs/appearance/structured-data/logo
     validated_attr :url,               type: String
   end
 end

data/lib/schema_dot_org/person.rb

@@ -1,10 +1,10 @@
 # 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 :award,            type: String, allow_nil: true
     validated_attr :alumni_of,        type: SchemaDotOrg::CollegeOrUniversity, allow_nil: true

data/lib/schema_dot_org/place.rb

@@ -3,10 +3,10 @@
 require_relative 'postal_address'
 
 
-#
-# 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: union(String, SchemaDotOrg::PostalAddress), presence: true
   end

data/lib/schema_dot_org/postal_address.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-#
-# Model the Schema.org `Thing > Intangible > StructuredValue > ContactPoint > PostalAddress`.
-# See https://schema.org/PostalAddress
-#
+
 module SchemaDotOrg
+  ##
+  # Model the Schema.org `Thing > Intangible > StructuredValue > ContactPoint > PostalAddress`.
+  # See https://schema.org/PostalAddress
+  #
   class PostalAddress < SchemaType
 
     # AddressCountry: The country. Recommended to be in 2-letter ISO 3166-1 alpha-2

data/lib/schema_dot_org/product.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 
-#
-# Model the Schema.org `Thing > Product`.  See https://schema.org/Product
-#
 module SchemaDotOrg
+  ##
+  # Model the Schema.org `Thing > Product`.  See https://schema.org/Product
+  #
   class Product < SchemaType
     validated_attr :description,  type: String, allow_nil: true
     validated_attr :image,        type: Array,  allow_nil: true

data/lib/schema_dot_org/search_action.rb

@@ -1,10 +1,10 @@
 # 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 < SchemaDotOrg::SchemaType
     validated_attr :query_input, type: String, presence: true
     validated_attr :target,      type: String, presence: true

data/lib/schema_dot_org/web_site.rb

@@ -1,11 +1,11 @@
 # 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 :potential_action, type: SchemaDotOrg::SearchAction, allow_nil: true

data/lib/schema_dot_org.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
+
 require 'json'
 require 'validated_object'
 
 
+##
+# The main module for the schema-dot-org gem.
+#
 module SchemaDotOrg
   ##
   # Make a BreadcrumbList from an array of links. This is a convenience

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 = '>= 3.1'
   spec.name          = 'schema_dot_org'
-  spec.version       = '2.5.1'
+  spec.version       = '2.5.2'
   spec.authors       = ['Robert Shecter']
   spec.email         = ['robert@public.law']
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_dot_org
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - Robert Shecter