schema_dot_org 1.3.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06093d53aa2d45e3ccb4220a1fb8537f6e0f6aae306d14d23e609b6939413aa5'
-  data.tar.gz: a4f5f7a98ef6753142f80c15eb82b37358e0c227d210962b98793cb0e10c3b0d
+  metadata.gz: 94b2d07e8efd22d98a9ad76181915fcd2bb91d6b3cf56028c125ff12854d3056
+  data.tar.gz: b7625ad03b3dc4911b1f5b75db53e2187df6bfd8e74f184537dd9a1b3b631097
 SHA512:
-  metadata.gz: 5e336d118cff1aa7afb2b73d825314993f7ee67d55a9c4c58ce3c05d0db05d9ca8d078d48903bc76d5f41fdd2931d39136b4f4fbd81c8099ef7158790d34cbc5
-  data.tar.gz: 6bcdfe9ab05c06aafe5b762c84b98a64687d2dfbd9623dc3c2d1e15dde6d1aeae78994ddf4900b21d5428d628214bd12158cf1809a748418515392b03ff47f8c
+  metadata.gz: 62860dcaa9d40e17ba4b495cb7e63e64cc46765166c1c5ba9a6d2777fcf93a76492ee3a1279cc95b1fe7e720422992e78f978b05a2b8a60f4258cd9d79396a16
+  data.tar.gz: 4c0c209701314df1e8a07bf359da709d0285b76eb8e909dfa87c404a0c2efaeee27929c7ef766fc8af99e6ff993f86725d17a13bf09e753518485f113150fb8d

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.7.1

data/.travis.yml

@@ -1,5 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.2
+  - 2.4.0
+  - 2.5.1
 before_install: gem install bundler -v 1.16.1

data/Gemfile.lock

@@ -1,52 +1,54 @@
 PATH
   remote: .
   specs:
-    schema_dot_org (1.3.0)
-      validated_object (~> 2.0.0)
+    schema_dot_org (1.6.1)
+      validated_object (~> 2.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.1.5)
-      activesupport (= 5.1.5)
-    activesupport (5.1.5)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    concurrent-ruby (1.0.5)
-    diff-lcs (1.3)
-    i18n (0.9.5)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    minitest (5.14.1)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    validated_object (2.0.0)
+    validated_object (2.0.3)
       activemodel (>= 3.2.21)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
-  rake (~> 10.0)
+  bundler (~> 2)
+  rake (>= 12.3.3)
   rspec (~> 3.0)
   schema_dot_org!
 
 BUNDLED WITH
-   1.16.1
+   2.1.4

data/README.md

@@ -1,9 +1,9 @@
-[![CircleCI](https://circleci.com/gh/dogweather/schema-dot-org.svg?style=svg)](https://circleci.com/gh/dogweather/schema-dot-org) [![Gem Version](https://badge.fury.io/rb/schema_dot_org.svg)](https://badge.fury.io/rb/schema_dot_org) [![Maintainability](https://api.codeclimate.com/v1/badges/e0c60b4cbc998563a484/maintainability)](https://codeclimate.com/github/dogweather/schema-dot-org/maintainability)
+[![Gem Version](https://badge.fury.io/rb/schema_dot_org.svg)](https://badge.fury.io/rb/schema_dot_org) [![Maintainability](https://api.codeclimate.com/v1/badges/e0c60b4cbc998563a484/maintainability)](https://codeclimate.com/github/dogweather/schema-dot-org/maintainability)
 
 # SchemaDotOrg
 
-Let's create [Structured Data](https://developers.google.com/search/docs/guides/intro-structured-data) that's correct,
-every single time.
+Let's 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 . . .
 
@@ -19,7 +19,11 @@ Let's say you have a Rails app. If you put this in a controller:
   founding_location: Place.new(address: 'Portland, OR'),
   email:            'say_hi@public.law',
   url:              'https://www.public.law',
-  logo:             'https://www.public.law/favicon-196x196.png'
+  logo:             'https://www.public.law/favicon-196x196.png',
+  same_as: [
+    'https://twitter.com/law_is_code',
+    'https://www.facebook.com/PublicDotLaw'
+    ]
   )
 ```
 
@@ -29,7 +33,7 @@ Let's say you have a Rails app. If you put this in a controller:
 <%= @public_law %>
 ```
 
-...you'll get this HTML:
+...you'll get this in the HTML:
 
 ```html
 <script type="application/ld+json">
@@ -48,18 +52,24 @@ Let's say you have a Rails app. If you put this in a controller:
   "foundingLocation": {
     "@type": "Place",
     "address": "Portland, OR"
-  }
+  },
+  "sameAs": [
+    "https://twitter.com/law_is_code",
+    "https://www.facebook.com/PublicDotLaw"
+  ]
+}
 </script>
 ```
 
-Strong typing is at work here. SchemaDotOrg will validate your code, and if correct, will generate Schema.org JSON-LD markup.
+Strong typing is at work here. `SchemaDotOrg` will validate your code, and if correct, will generate Schema.org JSON-LD markup. If not, you'll get a descriptive error message.
+
  Notice how the `foundingDate` is in the required ISO-8601 format. [The founding date must be a Ruby
 Date object](https://github.com/dogweather/schema-dot-org/blob/master/lib/schema_dot_org/organization.rb#L11) and so we can ensure correct formatting. In the same way, the `foundingLocation` is a `Place`
 which adds the proper `@type` attribute.
 
-### You cannot create invalid markup
+### You are prevented from creating invalid markup
 
-E.g., If you use the wrong type or try to set an unknown attribute, SchemaDotOrg will
+If you use the wrong type or try to set an unknown attribute, SchemaDotOrg will
 refuse to create the incorrect JSON-LD. Instead, you'll get a message explaining
 the problem:
 
@@ -71,16 +81,60 @@ Place.new(
   address: '12345 Happy Street',
   author:  'Hemmingway'
 )
-# => NoMethodError: undefined method `author='
+# => NoMethodError: undefined method `author'
 ```
 
 This type safety comes from the [ValidatedObject gem](https://github.com/dogweather/validated_object).
 
-## The Goal: Rich enough vocabulary for Google Schema.org parsing
+## Supported Schema.org Types
+
+### WebSite
+
+Example with only the required attributes:
+
+```ruby
+WebSite.new(
+  name: 'Texas Public Law',
+  url:  'https://texas.public.law',
+)
+```
+
+With the optional `SearchAction` to enable a [Sitelinks Searchbox](https://developers.google.com/search/docs/data-types/sitelinks-searchbox):
+
+```ruby
+WebSite.new(
+  name: 'Texas Public Law',
+  url:  'https://texas.public.law',
+  potential_action: SearchAction.new(
+    target: 'https://texas.public.law/?search={search_term_string}',
+    query_input: 'required name=search_term_string'
+  )
+)
+```
+
+### Organization
+
+Example:
+
+```ruby
+Organization.new(
+  name:             'Public.Law',
+  founder:           Person.new(name: 'Robb Shecter'),
+  founding_date:     Date.new(2009, 3, 6),
+  founding_location: Place.new(address: 'Portland, OR'),
+  email:            'say_hi@public.law',
+  url:              'https://www.public.law',
+  logo:             'https://www.public.law/favicon-196x196.png',
+  same_as: [
+    'https://twitter.com/law_is_code',
+    'https://www.facebook.com/PublicDotLaw'
+  ]
+)
+```
+
+### Person, Place, and SearchAction
 
-The plan is to implement a subset of types and attributes relevant to the Google web crawler.
-See `test-script.rb` for the supported types. Currently, all the attributes are required.
-Propose new types and attributes by opening an Issue.
+These three aren't too useful on their own in web apps. They're used when creating a `WebSite` and `Organization`, as shown above.
 
 ## Installation
 
@@ -106,8 +160,8 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/dogweather/schema_dot_org.
+Bug reports and pull requests are welcome on GitHub.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+[The](The) gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/schema_dot_org.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'validated_object'
-require 'schema_dot_org/version'
 
 module SchemaDotOrg
   #
   # Base class for schema types. Refactors out common code.
   #
   class SchemaType < ValidatedObject::Base
-    ROOT_ATTR = {"@context" => "http://schema.org"}
+    ROOT_ATTR = { "@context" => "http://schema.org" }.freeze
+    UNQUALIFIED_CLASS_NAME_REGEX = /([^:]+)$/
+
 
-     
     def to_s
-      json_string = to_json_ld(pretty: true)
+      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)
@@ -26,7 +28,7 @@ module SchemaDotOrg
       "<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
 
@@ -41,7 +43,7 @@ module SchemaDotOrg
     # 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 )
+      { "@type" => un_namespaced_classname }.merge(_to_json_struct.compact)
     end
 
 
@@ -52,8 +54,15 @@ module SchemaDotOrg
 
     # @return the classname without the module namespace.
     def un_namespaced_classname
-      self.class.name =~ /([^:]+)$/
-      $1
+      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/lib/schema_dot_org/organization.rb

@@ -1,18 +1,30 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'schema_dot_org'
+require 'schema_dot_org/person'
+require 'schema_dot_org/place'
 
 
 module SchemaDotOrg
   class Organization < SchemaType
-    attr_accessor :email, :founder, :founding_date, :founding_location, :logo, :name, :url
+    attr_accessor :email,
+                  :founder,
+                  :founding_date,
+                  :founding_location,
+                  :logo,
+                  :name,
+                  :url,
+                  :same_as
 
     validates :email,             type: String
-    validates :founder,           type: Person
+    validates :founder,           type: SchemaDotOrg::Person
     validates :founding_date,     type: Date
-    validates :founding_location, type: Place
+    validates :founding_location, type: SchemaDotOrg::Place
     validates :logo,              type: String
     validates :name,              type: String
     validates :url,               type: String
+    validates :same_as,           type: Array, allow_nil: true
 
     def _to_json_struct
       {
@@ -22,8 +34,9 @@ module SchemaDotOrg
         "logo" => logo,
         "founder" => founder.to_json_struct,
         "foundingDate" => founding_date.to_s,
-        "foundingLocation" => founding_location.to_json_struct
+        "foundingLocation" => founding_location.to_json_struct,
+        "sameAs" => same_as
       }
     end
   end
-end
+end

data/lib/schema_dot_org/person.rb

@@ -1,18 +1,19 @@
+# frozen_string_literal: true
+
 require 'schema_dot_org'
 
 
 module SchemaDotOrg
   # Model the Schema.org `Person`.  See http://schema.org/Person
   class Person < SchemaType
-
     attr_accessor :name
     validates :name, type: String, presence: true
 
 
     def _to_json_struct
       {
-        name: self.name
+        'name' => self.name
       }
     end
   end
-end
+end

data/lib/schema_dot_org/place.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'schema_dot_org'
 
 
@@ -9,8 +11,8 @@ module SchemaDotOrg
 
     def _to_json_struct
       {
-        address: self.address
+        'address' => self.address
       }
     end
   end
-end
+end

data/lib/schema_dot_org/search_action.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'schema_dot_org'
+
+
+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' => self.target,
+        'query_input' => self.query_input
+      }
+    end
+  end
+end

data/lib/schema_dot_org/web_site.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 require 'schema_dot_org'
+require 'schema_dot_org/search_action'
 
 
 module SchemaDotOrg
-  # Model the Schema.org `Thing > CreativeWork > WebSite`.  
+  # Model the Schema.org `Thing > CreativeWork > WebSite`.
   # @See http://schema.org/WebSite
   class WebSite < SchemaType
-    attr_accessor :name
-    validates :name, type: String, presence: true
-
-    attr_accessor :url
-    validates :url, type: String, presence: true
+    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
+        'name' => self.name,
+        'url' =>  self.url,
+        'potentialAction' => self.potential_action&.to_json_struct
       }
     end
   end
 end
-

data/run-script

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

data/schema_dot_org.gemspec

@@ -1,29 +1,27 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "schema_dot_org/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "schema_dot_org"
-  spec.version       = SchemaDotOrg::VERSION
-  spec.authors       = ["Robb Shecter"]
-  spec.email         = ["robb@public.law"]
+  spec.name          = 'schema_dot_org'
+  spec.version       = '1.6.1'
+  spec.authors       = ['Robb Shecter']
+  spec.email         = ['robb@public.law']
 
-  spec.summary       = %q{JSON-LD generator for Schema.org vocabulary}
-  spec.description   = %q{Creates well-formed website metadata with strongly typed Ruby.}
-  spec.homepage      = "https://github.com/dogweather/schema-dot-org"
-  spec.license       = "MIT"
+  spec.summary       = 'JSON-LD generator for Schema.org vocabulary'
+  spec.description   = 'Creates well-formed website metadata with strongly typed Ruby.'
+  spec.homepage      = 'https://github.com/public-law/schema-dot-org'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "validated_object", "~> 2.0.0"
+  spec.add_dependency 'validated_object', '~> 2.0.2'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/test-script.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 
 require 'schema_dot_org/person'
@@ -15,12 +17,23 @@ public_law = Organization.new(
   email:            'say_hi@public.law',
   url:              'https://www.public.law',
   logo:             'https://www.public.law/favicon-196x196.png',
-  )
+  same_as: [
+    'https://twitter.com/law_is_code',
+    'https://www.facebook.com/PublicDotLaw'
+    ]
+)
+
+puts public_law
+
 
 site_info = WebSite.new(
   name: 'Texas Public Law',
-  url:  'https://texas.public.law'
+  url:  'https://texas.public.law',
+  potential_action: SearchAction.new(
+    target: 'https://texas.public.law/?search={search_term_string}',
+    query_input: 'required name=search_term_string'
+  )
 )
 
+
 puts site_info
-puts public_law

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_dot_org
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Robb Shecter
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-02-24 00:00:00.000000000 Z
+date: 2020-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: validated_object
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -88,15 +88,16 @@ files:
 - lib/schema_dot_org/organization.rb
 - lib/schema_dot_org/person.rb
 - lib/schema_dot_org/place.rb
-- lib/schema_dot_org/version.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/dogweather/schema-dot-org
+homepage: https://github.com/public-law/schema-dot-org
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,9 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: JSON-LD generator for Schema.org vocabulary
 test_files: []

data/lib/schema_dot_org/version.rb

@@ -1,3 +0,0 @@
-module SchemaDotOrg
-  VERSION = "1.3.0"
-end