schema_dot_org 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce2b289fea268f2a78df900f63d7d36736bcd0b08446eb7c18a21997cfb6ec8c
-  data.tar.gz: e0a512dcf0d386376a5d227312e8fea47f95a014ed34b2b4ac9be8777f5ef1fe
+  metadata.gz: ce7c69a80d31a953b0ee6b786fa61fdf28b639293471e14bf0b75d5b17ab1149
+  data.tar.gz: 502d77fdee47db37eb1de21fd27c432df94b787c21714fdbef0c0cfaab2a47d5
 SHA512:
-  metadata.gz: 05ca9ceb7a3c95478f86c31d11df20f6661f6caee962170615ac35c178e4e2747f031a2675e97ea31881c50931775304caf9e684335633e8fcb5fdb527935243
-  data.tar.gz: 31b3407922f8757746424c39d9571050dc063d24610a98762ee67d424af498314b97dbaf13a5c2f57ea9a23411c8f2509587bbf596fb6d956abce5c31e28b942
+  metadata.gz: df9fef20688ef16fcdcc2131c094d05755b59c913f92a537079a80f8a5d5830b31f49643f6c42304ea9f2dd6dc07f4ad3079f70cd0abff36b531e4a66de76e01
+  data.tar.gz: '03698279a36e56a0c114d8e6fa04b090876d076bce1a1d4e47fcb11ba366803e1fbf065a9879d1413a201096e7dcf71a25485c761cdd402c63333c0e949b5c5f'

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.6.6

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in schema_dot_org.gemspec
 gemspec

data/Gemfile.lock

@@ -1,52 +1,61 @@
 PATH
   remote: .
   specs:
-    schema_dot_org (1.5.0)
-      validated_object (~> 2.0.2)
+    schema_dot_org (1.7.0)
+      sorbet-runtime (>= 0.5.5890)
+      validated_object (~> 2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.1.6)
-      activesupport (= 5.1.6)
-    activesupport (5.1.6)
+    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, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    concurrent-ruby (1.0.5)
-    diff-lcs (1.3)
-    i18n (1.0.0)
+      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.2)
+    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)
+    sorbet (0.5.5890)
+      sorbet-static (= 0.5.5890)
+    sorbet-runtime (0.5.5890)
+    sorbet-static (0.5.5890-universal-darwin-14)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    validated_object (2.0.2)
+    validated_object (2.1.0)
       activemodel (>= 3.2.21)
+      sorbet-runtime (>= 0.5.5890)
+    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!
+  sorbet (>= 0.5.5890)
 
 BUNDLED WITH
-   1.16.1
+   2.1.4

data/README.md

@@ -1,8 +1,8 @@
-[![Build Status](https://travis-ci.org/dogweather/schema-dot-org.svg?branch=master)](https://travis-ci.org/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,
+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 . . .
@@ -33,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">
@@ -56,18 +56,20 @@ Let's say you have a Rails app. If you put this in a controller:
   "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:
 
@@ -158,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/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "schema_dot_org"
+require 'bundler/setup'
+require 'schema_dot_org'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "schema_dot_org"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/schema_dot_org.rb

@@ -1,3 +1,4 @@
+# typed: ignore
 # frozen_string_literal: true
 
 require 'json'
@@ -8,12 +9,11 @@ module SchemaDotOrg
   # Base class for schema types. Refactors out common code.
   #
   class SchemaType < ValidatedObject::Base
-    ROOT_ATTR = { "@context" => "http://schema.org" }.freeze
-    UNQUALIFIED_CLASS_NAME_REGEX = /([^:]+)$/
-
+    ROOT_ATTR = { '@context' => 'http://schema.org' }.freeze
+    UNQUALIFIED_CLASS_NAME_REGEX = /([^:]+)$/.freeze
 
     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)
@@ -23,12 +23,10 @@ module SchemaDotOrg
       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
 
@@ -39,23 +37,26 @@ module SchemaDotOrg
       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.compact)
+      { '@type' => un_namespaced_classname }.merge(_to_json_struct.compact)
     end
 
-
     def _to_json_struct
-      raise "For subclasses to implement"
+      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
+
+    private
+
+    def rails_production?
+      defined?(Rails) && Rails.env.production?
+    end
   end
 end

data/lib/schema_dot_org/organization.rb

@@ -1,3 +1,4 @@
+# typed: ignore
 # frozen_string_literal: true
 
 require 'date'
@@ -5,7 +6,6 @@ require 'schema_dot_org'
 require 'schema_dot_org/person'
 require 'schema_dot_org/place'
 
-
 module SchemaDotOrg
   class Organization < SchemaType
     attr_accessor :email,
@@ -28,14 +28,14 @@ module SchemaDotOrg
 
     def _to_json_struct
       {
-        "name" => name,
-        "email" => email,
-        "url" => url,
-        "logo" => logo,
-        "founder" => founder.to_json_struct,
-        "foundingDate" => founding_date.to_s,
-        "foundingLocation" => founding_location.to_json_struct,
-        "sameAs" => same_as
+        'name' => name,
+        'email' => email,
+        'url' => url,
+        'logo' => logo,
+        'founder' => founder.to_json_struct,
+        'foundingDate' => founding_date.to_s,
+        'foundingLocation' => founding_location.to_json_struct,
+        'sameAs' => same_as
       }
     end
   end

data/lib/schema_dot_org/person.rb

@@ -1,18 +1,17 @@
+# typed: ignore
 # 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' => name
       }
     end
   end

data/lib/schema_dot_org/place.rb

@@ -1,8 +1,8 @@
+# typed: ignore
 # frozen_string_literal: true
 
 require 'schema_dot_org'
 
-
 module SchemaDotOrg
   # Model the Schema.org `Thing > Place`.  See http://schema.org/Place
   class Place < SchemaType
@@ -11,7 +11,7 @@ module SchemaDotOrg
 
     def _to_json_struct
       {
-        'address' => self.address
+        'address' => address
       }
     end
   end

data/lib/schema_dot_org/search_action.rb

@@ -1,8 +1,8 @@
+# typed: ignore
 # frozen_string_literal: true
 
 require 'schema_dot_org'
 
-
 module SchemaDotOrg
   # Model the Schema.org `Thing > SearchAction`.  See http://schema.org/SearchAction
   class SearchAction < SchemaType
@@ -12,8 +12,8 @@ module SchemaDotOrg
 
     def _to_json_struct
       {
-        'target' => self.target,
-        'query_input' => self.query_input
+        'target' => target,
+        'query_input' => query_input
       }
     end
   end

data/lib/schema_dot_org/web_site.rb

@@ -1,7 +1,8 @@
+# typed: ignore
 # frozen_string_literal: true
 
 require 'schema_dot_org'
-
+require 'schema_dot_org/search_action'
 
 module SchemaDotOrg
   # Model the Schema.org `Thing > CreativeWork > WebSite`.
@@ -10,13 +11,13 @@ module SchemaDotOrg
     attr_accessor :name, :url, :potential_action
     validates :name,             type: String, presence: true
     validates :url,              type: String, presence: true
-    validates :potential_action, type: SearchAction, allow_nil: true
+    validates :potential_action, type: SchemaDotOrg::SearchAction, allow_nil: true
 
     def _to_json_struct
       {
-        'name' => self.name,
-        'url' =>  self.url,
-        'potentialAction' => self.potential_action&.to_json_struct
+        'name' => name,
+        'url' => url,
+        'potentialAction' => potential_action&.to_json_struct
       }
     end
   end

data/run-script

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

data/schema_dot_org.gemspec

@@ -1,28 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 
-lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = "schema_dot_org"
-  spec.version       = '1.5.0'
-  spec.authors       = ["Robb Shecter"]
-  spec.email         = ["robb@public.law"]
+  spec.required_ruby_version = '>= 2.6'
+  spec.name          = 'schema_dot_org'
+  spec.version       = '1.7.0'
+  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.1'
 
-  spec.add_dependency "validated_object", "~> 2.0.2"
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'sorbet', '>= 0.5.5890'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency 'sorbet-runtime', '>= 0.5.5890'
 end

data/sorbet/config

@@ -0,0 +1,2 @@
+--dir
+.