schema_dot_org 1.5.1 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9039661fa215dd59b1b15d4bb22bee6ae739ac5c030f5fe9a27942e1dd635ee2
-  data.tar.gz: dda30e0482e5b6433ac6f44a526a0f0d0e6105864542b415c44ecbc0a9bca22b
+  metadata.gz: 125273e4c13ee100e668d7aad12d40379c51773968c50013fe21845fc2d60cb6
+  data.tar.gz: e27714ef970a5320827c7250e504050c97d58a5d8a2acea7aa589a81797a4729
 SHA512:
-  metadata.gz: 7180f16b57736871d59b252ab724016638ac0c2bf9f760aa13781a20cf2d46f11913c6ae5ba9ea4b976049876c8be5cc583aae7b974e88ba4ff70e4ad0671cca
-  data.tar.gz: 2d000cf439ddfdd7635249ee75a7a9dc7b6c812f51ae901a75853ef90a6e659907de93e6a9b0320718ff7c9ca06c93a949ad52b9660d1c7c695f555f9690df8e
+  metadata.gz: 7bb7ef8ca7d109793ebec2c79de1931855f7cff07f5751c5d7d6b7bc1a09ac4d431aa254c834f356e968ea4aae3f259765cf33e734701b836f69240cb7da6cb8
+  data.tar.gz: 6894a06c5bad02000c1de3e2d4aa4171c18f76d417d82ce52b783bcb7ee90d315742d1b879b88a3f728515877b704b980b87e25b962bf85b706ee7f958e6344e

data/.ruby-version

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

data/.travis.yml

@@ -3,4 +3,5 @@ language: ruby
 rvm:
   - 2.4.0
   - 2.5.1
+  - 2.6.6
 before_install: gem install bundler -v 1.16.1

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,67 @@
 PATH
   remote: .
   specs:
-    schema_dot_org (1.5.1)
-      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.2.0)
-      activesupport (= 5.2.0)
-    activesupport (5.2.0)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activesupport (6.1.4)
       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.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
       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.4)
+    rake (13.0.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    validated_object (2.0.2)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sorbet (0.5.6485)
+      sorbet-static (= 0.5.6485)
+    sorbet-runtime (0.5.6485)
+    sorbet-static (0.5.6485-universal-darwin-14)
+    sorbet-static (0.5.6485-universal-darwin-15)
+    sorbet-static (0.5.6485-universal-darwin-16)
+    sorbet-static (0.5.6485-universal-darwin-17)
+    sorbet-static (0.5.6485-universal-darwin-18)
+    sorbet-static (0.5.6485-universal-darwin-19)
+    sorbet-static (0.5.6485-universal-darwin-20)
+    sorbet-static (0.5.6485-x86_64-linux)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    validated_object (2.1.0)
       activemodel (>= 3.2.21)
+      sorbet-runtime (>= 0.5.5890)
+    zeitwerk (2.4.2)
 
 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.2.15

data/README.md

@@ -56,7 +56,8 @@ 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>
 ```
 
@@ -159,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 ## ! Note the hyphen.
       }
     end
   end

data/lib/schema_dot_org/web_site.rb

@@ -1,9 +1,9 @@
+# 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`.
   # @See http://schema.org/WebSite
@@ -15,9 +15,9 @@ module SchemaDotOrg
 
     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

@@ -1 +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.1'
-  spec.authors       = ["Robb Shecter"]
-  spec.email         = ["robb@public.law"]
+  spec.required_ruby_version = '>= 2.6'
+  spec.name          = 'schema_dot_org'
+  spec.version       = '1.7.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.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
+.

data/sorbet/rbi/gems/activemodel.rbi

@@ -0,0 +1,262 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: ignore
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/activemodel/all/activemodel.rbi
+#
+# activemodel-6.0.3.2
+
+module ActiveModel
+  def self.eager_load!; end
+  def self.gem_version; end
+  def self.version; end
+  extend ActiveSupport::Autoload
+end
+module ActiveModel::VERSION
+end
+module ActiveModel::Serializers
+  extend ActiveSupport::Autoload
+end
+module ActiveModel::Validations
+  def errors; end
+  def initialize_dup(other); end
+  def invalid?(context = nil); end
+  def raise_validation_error; end
+  def read_attribute_for_validation(*arg0); end
+  def run_validations!; end
+  def valid?(context = nil); end
+  def validate!(context = nil); end
+  def validate(context = nil); end
+  def validates_with(*args, &block); end
+  extend ActiveSupport::Concern
+end
+module ActiveModel::Validations::ClassMethods
+  def _parse_validates_options(options); end
+  def _validates_default_keys; end
+  def attribute_method?(attribute); end
+  def clear_validators!; end
+  def inherited(base); end
+  def validate(*args, &block); end
+  def validates!(*attributes); end
+  def validates(*attributes); end
+  def validates_each(*attr_names, &block); end
+  def validates_with(*args, &block); end
+  def validators; end
+  def validators_on(*attributes); end
+end
+module ActiveModel::Validations::Clusivity
+  def check_validity!; end
+  def delimiter; end
+  def include?(record, value); end
+  def inclusion_method(enumerable); end
+end
+class ActiveModel::Validator
+  def initialize(options = nil); end
+  def kind; end
+  def options; end
+  def self.kind; end
+  def validate(record); end
+end
+class ActiveModel::EachValidator < ActiveModel::Validator
+  def attributes; end
+  def check_validity!; end
+  def initialize(options); end
+  def validate(record); end
+  def validate_each(record, attribute, value); end
+end
+class ActiveModel::BlockValidator < ActiveModel::EachValidator
+  def initialize(options, &block); end
+  def validate_each(record, attribute, value); end
+end
+class ActiveModel::Validations::InclusionValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value); end
+  include ActiveModel::Validations::Clusivity
+end
+module ActiveModel::Validations::HelperMethods
+  def _merge_attributes(attr_names); end
+  def validates_absence_of(*attr_names); end
+  def validates_acceptance_of(*attr_names); end
+  def validates_confirmation_of(*attr_names); end
+  def validates_exclusion_of(*attr_names); end
+  def validates_format_of(*attr_names); end
+  def validates_inclusion_of(*attr_names); end
+  def validates_length_of(*attr_names); end
+  def validates_numericality_of(*attr_names); end
+  def validates_presence_of(*attr_names); end
+  def validates_size_of(*attr_names); end
+end
+class ActiveModel::Validations::AbsenceValidator < ActiveModel::EachValidator
+  def validate_each(record, attr_name, value); end
+end
+class ActiveModel::Validations::NumericalityValidator < ActiveModel::EachValidator
+  def allow_only_integer?(record); end
+  def check_validity!; end
+  def filtered_options(value); end
+  def is_hexadecimal_literal?(raw_value); end
+  def is_integer?(raw_value); end
+  def is_number?(raw_value); end
+  def parse_as_number(raw_value); end
+  def record_attribute_changed_in_place?(record, attr_name); end
+  def validate_each(record, attr_name, value); end
+end
+module ActiveModel::Validations::Callbacks
+  def run_validations!; end
+  extend ActiveSupport::Concern
+end
+module ActiveModel::Validations::Callbacks::ClassMethods
+  def after_validation(*args, &block); end
+  def before_validation(*args, &block); end
+end
+class ActiveModel::Validations::ExclusionValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value); end
+  include ActiveModel::Validations::Clusivity
+end
+class ActiveModel::Validations::ConfirmationValidator < ActiveModel::EachValidator
+  def confirmation_value_equal?(record, attribute, value, confirmed); end
+  def initialize(options); end
+  def setup!(klass); end
+  def validate_each(record, attribute, value); end
+end
+class ActiveModel::Validations::FormatValidator < ActiveModel::EachValidator
+  def check_options_validity(name); end
+  def check_validity!; end
+  def option_call(record, name); end
+  def record_error(record, attribute, name, value); end
+  def regexp_using_multiline_anchors?(regexp); end
+  def validate_each(record, attribute, value); end
+end
+class ActiveModel::Validations::PresenceValidator < ActiveModel::EachValidator
+  def validate_each(record, attr_name, value); end
+end
+class ActiveModel::Validations::LengthValidator < ActiveModel::EachValidator
+  def check_validity!; end
+  def initialize(options); end
+  def skip_nil_check?(key); end
+  def validate_each(record, attribute, value); end
+end
+class ActiveModel::Validations::AcceptanceValidator < ActiveModel::EachValidator
+  def acceptable_option?(value); end
+  def initialize(options); end
+  def setup!(klass); end
+  def validate_each(record, attribute, value); end
+end
+class ActiveModel::Validations::AcceptanceValidator::LazilyDefineAttributes < Module
+  def ==(other); end
+  def attributes; end
+  def define_on(klass); end
+  def included(klass); end
+  def initialize(attributes); end
+  def matches?(method_name); end
+end
+class ActiveModel::Validations::WithValidator < ActiveModel::EachValidator
+  def validate_each(record, attr, val); end
+end
+class ActiveModel::ValidationError < StandardError
+  def initialize(model); end
+  def model; end
+end
+class ActiveModel::Name
+  def !~(**, &&); end
+  def <=>(**, &&); end
+  def ==(arg); end
+  def ===(arg); end
+  def =~(**, &&); end
+  def _singularize(string); end
+  def as_json(**, &&); end
+  def cache_key; end
+  def collection; end
+  def element; end
+  def eql?(**, &&); end
+  def human(options = nil); end
+  def i18n_key; end
+  def initialize(klass, namespace = nil, name = nil); end
+  def match?(**, &&); end
+  def name; end
+  def param_key; end
+  def plural; end
+  def route_key; end
+  def singular; end
+  def singular_route_key; end
+  def to_s(**, &&); end
+  def to_str(**, &&); end
+  include Comparable
+end
+module ActiveModel::Naming
+  def model_name; end
+  def self.extended(base); end
+  def self.model_name_from_record_or_class(record_or_class); end
+  def self.param_key(record_or_class); end
+  def self.plural(record_or_class); end
+  def self.route_key(record_or_class); end
+  def self.singular(record_or_class); end
+  def self.singular_route_key(record_or_class); end
+  def self.uncountable?(record_or_class); end
+end
+module ActiveModel::Callbacks
+  def _define_after_model_callback(klass, callback); end
+  def _define_around_model_callback(klass, callback); end
+  def _define_before_model_callback(klass, callback); end
+  def define_model_callbacks(*callbacks); end
+  def self.extended(base); end
+end
+module ActiveModel::Translation
+  def human_attribute_name(attribute, options = nil); end
+  def i18n_scope; end
+  def lookup_ancestors; end
+  include ActiveModel::Naming
+end
+class ActiveModel::Errors
+  def [](attribute); end
+  def add(attribute, message = nil, options = nil); end
+  def added?(attribute, message = nil, options = nil); end
+  def apply_default_array(hash); end
+  def as_json(options = nil); end
+  def blank?; end
+  def clear; end
+  def copy!(other); end
+  def count; end
+  def delete(key); end
+  def details; end
+  def each; end
+  def empty?; end
+  def full_message(attribute, message); end
+  def full_messages; end
+  def full_messages_for(attribute); end
+  def generate_message(attribute, type = nil, options = nil); end
+  def has_key?(attribute); end
+  def include?(attribute); end
+  def init_with(coder); end
+  def initialize(base); end
+  def initialize_dup(other); end
+  def key?(attribute); end
+  def keys; end
+  def marshal_dump; end
+  def marshal_load(array); end
+  def merge!(other); end
+  def messages; end
+  def normalize_detail(message, options); end
+  def normalize_message(attribute, message, options); end
+  def of_kind?(attribute, message = nil); end
+  def self.i18n_customize_full_message; end
+  def self.i18n_customize_full_message=(arg0); end
+  def size; end
+  def slice!(*keys); end
+  def to_a; end
+  def to_hash(full_messages = nil); end
+  def to_xml(options = nil); end
+  def values; end
+  def without_default_proc(hash); end
+  include Enumerable
+end
+class ActiveModel::StrictValidationFailed < StandardError
+end
+class ActiveModel::RangeError < RangeError
+end
+class ActiveModel::UnknownAttributeError < NoMethodError
+  def attribute; end
+  def initialize(record, attribute); end
+  def record; end
+end