schema_dot_org 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db371250ff6b29c349d658e85503ab19412d35e491a9800827f129f9d93413d0
-  data.tar.gz: e429bee64238b2f43697cd2f7bb95984eda07389573b9148008bfe2f0c84079b
+  metadata.gz: '06093d53aa2d45e3ccb4220a1fb8537f6e0f6aae306d14d23e609b6939413aa5'
+  data.tar.gz: a4f5f7a98ef6753142f80c15eb82b37358e0c227d210962b98793cb0e10c3b0d
 SHA512:
-  metadata.gz: e55d94f56727c50903971dfe8b88ecbb1193e7132e62b4f30d5a65bd2eb34f00ac3c6dd35f2857190bd86982c0dbc2c1f2d0ffb0131b85913e060df93901643f
-  data.tar.gz: 98c43a569614deccbacfbadc7e587b309f8a78975aa03e06c60f47a4fb653cdb3087ac3b4fb2b129e27691a673a5e955102261b206af99d941ae645e46087993
+  metadata.gz: 5e336d118cff1aa7afb2b73d825314993f7ee67d55a9c4c58ce3c05d0db05d9ca8d078d48903bc76d5f41fdd2931d39136b4f4fbd81c8099ef7158790d34cbc5
+  data.tar.gz: 6bcdfe9ab05c06aafe5b762c84b98a64687d2dfbd9623dc3c2d1e15dde6d1aeae78994ddf4900b21d5428d628214bd12158cf1809a748418515392b03ff47f8c

data/Gemfile.lock

@@ -1,22 +1,22 @@
 PATH
   remote: .
   specs:
-    schema_dot_org (1.2.0)
-      validated_object
+    schema_dot_org (1.3.0)
+      validated_object (~> 2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.1.4)
-      activesupport (= 5.1.4)
-    activesupport (5.1.4)
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activesupport (5.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
-    i18n (0.9.4)
+    i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
     rake (10.5.0)
@@ -36,7 +36,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    validated_object (1.1.0)
+    validated_object (2.0.0)
       activemodel (>= 3.2.21)
 
 PLATFORMS

data/README.md

@@ -9,35 +9,27 @@ every single time.
 
 ## Usage
 
-Create the tree of objects, and then call `#to_s` in e.g., a Rails template:
+Let's say you have a Rails app. If you put this in a controller:
 
 ```ruby
-require 'schema_dot_org/person'
-require 'schema_dot_org/place'
-require 'schema_dot_org/organization'
-include SchemaDotOrg
-
-
-@public_law = Organization.new do |org|
-  org.name    = 'Public.Law'
-  org.email   = 'say_hi@public.law'
-  org.url     = 'https://www.public.law'
-  org.logo    = 'https://www.public.law/favicon-196x196.png'
-  org.founding_date = Date.new(2009, 3, 6)
-  org.founder = Person.new do |person|
-    person.name = 'Robb Shecter'
-  end
-  org.founding_location = Place.new do |place|
-    place.address = 'Portland, OR'
-  end
-end
+@public_law = 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'
+  )
 ```
 
+...and this in a template:
+
 ```html
 <%= @public_law %>
 ```
 
-SchemaDotOrg will validate your code, and if correct, will generate Schema.org JSON-LD markup:
+...you'll get this HTML:
 
 ```html
 <script type="application/ld+json">
@@ -60,8 +52,9 @@ SchemaDotOrg will validate your code, and if correct, will generate Schema.org J
 </script>
 ```
 
-Notice how the `foundingDate` is in the required ISO-8601 format. The attribute requires a Ruby
-`Date` and so can ensure correct formatting. In the same way, the `foundingLocation` is a `Place`
+Strong typing is at work here. SchemaDotOrg will validate your code, and if correct, will generate Schema.org JSON-LD markup.
+ 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
@@ -71,13 +64,13 @@ refuse to create the incorrect JSON-LD. Instead, you'll get a message explaining
 the problem:
 
 ```ruby
-Place.new { |p| p.address = 12345 }
+Place.new(address: 12345)
 # => ArgumentError: Address is class Integer, not String
 
-Place.new do |p|
-  p.address = '12345 Happy Street'
-  p.author  = 'Hemmingway'
-end
+Place.new(
+  address: '12345 Happy Street',
+  author:  'Hemmingway'
+)
 # => NoMethodError: undefined method `author='
 ```
 
@@ -86,6 +79,7 @@ This type safety comes from the [ValidatedObject gem](https://github.com/dogweat
 ## The Goal: Rich enough vocabulary for Google Schema.org parsing
 
 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.
 
 ## Installation

data/lib/schema_dot_org/version.rb

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

data/schema_dot_org.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "validated_object"
+  spec.add_dependency "validated_object", "~> 2.0.0"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

data/test-script.rb

@@ -7,24 +7,20 @@ require 'schema_dot_org/web_site'
 include SchemaDotOrg
 
 
-public_law = Organization.new do |org|
-  org.name = 'Public.Law'
-  org.founding_date = Date.new(2009, 3, 6)
-  org.email = 'say_hi@public.law'
-  org.url = 'https://www.public.law'
-  org.logo = 'https://www.public.law/favicon-196x196.png'
-  org.founder = Person.new do |person|
-    person.name = 'Robb Shecter'
-  end
-  org.founding_location = Place.new do |place| 
-    place.address = 'Portland, OR'
-  end
-end
+public_law = 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',
+  )
 
-site_info = WebSite.new do |website|
-  website.name = 'Texas Public Law'
-  website.url  = 'https://texas.public.law'
-end
+site_info = WebSite.new(
+  name: 'Texas Public Law',
+  url:  'https://texas.public.law'
+)
 
 puts site_info
 puts public_law

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: schema_dot_org
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Robb Shecter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2018-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: validated_object
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: JSON-LD generator for Schema.org vocabulary