schema_dot_org 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2425c10be6b0c15d1c45619a3017328151d12771132124e5be89b15c23d25315
-  data.tar.gz: 79da125831d1ffec3edcb29861dc08ff756b69bc91ec987098a25fee3545c9f5
+  metadata.gz: c235d549a6a316ac26bf5e055b310c947e18382f89294808f8ebc8e5ce35a4cf
+  data.tar.gz: 2751fa4daf7f808cfb51bf384cf6aed926cf0c6565fb5f7457a36f5fed02335a
 SHA512:
-  metadata.gz: 94f2c6d0b1402064f8056d9eb564f8f96d6f66cce3a91a97c795bea57e16b16246fc2baa206e109273f3a2793a41fb8ef73b3c07182cf3477ddf50899000c43a
-  data.tar.gz: d86042a5d40df05d2e4a530bd7948f57f2350f5b7a882ae335fb697212b631daa0df7001c093fd8c8608663262081a7898a22cef8f55c5ec01e936f3fc759599
+  metadata.gz: 1986324b423f381779fbb2d0696853aa875ff86eb9252c7127cab49236f50100c2d60ba94f1730c4cb1e4e6811b5614d3cb991f2f6e2da87cd355981d9b2d89e
+  data.tar.gz: c5484937988f31451abac9e3e7b5b73a3843fad82b0a3240d1ba845e40b1abb7512dffd99964d99cf170e2254f134b51190eab2557827a34fb098661374a6716

data/Gemfile.lock

@@ -2,11 +2,23 @@ PATH
   remote: .
   specs:
     schema_dot_org (0.1.0)
+      validated_object
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activesupport (5.1.4)
+      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)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -21,6 +33,11 @@ GEM
       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 (1.1.0)
+      activemodel (>= 3.2.21)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,8 +1,96 @@
 # SchemaDotOrg
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/schema_dot_org`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+## Usage
+
+Create the tree of objects, and then call `#to_s` in (e.g.) a Rails template:
+
+```ruby
+require 'schema_dot_org/place'
+include SchemaDotOrg
+
+@founding_location = Place.new { |p| p.address = "Las Vegas, NV" }
+```
+
+```html
+<%= @founding_location %>
+```
+
+This results in the generated webpage containing absolutely correct Schema.org JSON-LD markup:
+
+```html
+<script type="application/ld+json">
+{
+  "@type": "Place",
+  "address": "Las Vegas, NV"
+}
+</script>
+```
+
+You cannot create invalid markup: E.g., 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:
+
+```ruby
+Place.new { |p| p.address = 12345 }
+# => ArgumentError: Address is class Integer, not String
+
+Place.new do |p|
+  p.address = '12345 Happy Street'
+  p.author  = 'Hemmingway'
+end
+# => 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
+
+The end result is to output website metadata like this (taken from my site [public.law](https://www.public.law)):
+
+```html
+<script type="application/ld+json">
+  {
+  "@context": "http://schema.org",
+  "@type": "Organization",
+  "email": "sayhi@public.law",
+  "founder": {
+    "@type": "Person",
+    "name": "Robb Shecter"
+    },
+  "foundingDate": "2009-03-06",
+  "foundingLocation": {
+    "@type": "Place",
+    "address": "Portland, Oregon"
+  },
+  "logo": "https://www.public.law/favicon-196x196.png",
+  "name": "Public.Law",
+  "sameAs": [
+    "https://twitter.com/law_is_code",
+    "https://www.facebook.com/PublicDotLaw",
+    "https://www.linkedin.com/company/9170633/"
+  ],
+  "url": "https://www.public.law"
+  }
+</script>
+```
+
+And it should do it in a **typesafe** way. That is, not merely syntactically correct,
+but also _semantically_ correct. It should, e.g.,  ensure that only allowed
+attributes are used.
+
+## Schema Development Status
+
+| Type | Planned | Completed |
+| ---- |:-------:|:---------:|
+| Place | X | X |
+| Person | X |
+| Organization | X |
+| Date | X |
+| URL | X |
+
+The plan is to implement a small subset of types and attributes relevant to the Google web crawler.
+Add an Issue to propose a new relevant type.
 
 ## Installation
 
@@ -20,19 +108,15 @@ Or install it yourself as:
 
     $ gem install schema_dot_org
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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/[USERNAME]/schema_dot_org.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dogweather/schema_dot_org.
 
 ## License
 

data/lib/schema_dot_org/place.rb

@@ -0,0 +1,20 @@
+require 'json'
+require 'schema_dot_org'
+
+
+module SchemaDotOrg
+  # Model the Schema.org `Thing > Place`.  See http://schema.org/Place
+  class Place < SchemaType
+    attr_accessor :address
+
+    validates :address, presence: true
+    validates :address, type: String
+
+    def to_json_struct
+      {
+        "@type" => "Place",
+        address: self.address
+      }
+    end
+  end
+end

data/lib/schema_dot_org/version.rb

@@ -1,3 +1,3 @@
 module SchemaDotOrg
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/schema_dot_org.rb

@@ -1,5 +1,29 @@
-require "schema_dot_org/version"
+require 'validated_object'
+require 'schema_dot_org/version'
 
 module SchemaDotOrg
-  # Your code goes here...
+  #
+  # Base class for schema types. Refactors out common code.
+  #
+  class SchemaType < ValidatedObject::Base
+     
+    def to_s
+      to_json_ld(pretty: true)
+    end
+
+
+    def to_json_ld(pretty: false)
+      "<script type=\"application/ld+json\">\n" + to_json(pretty: pretty) + "\n</script>"
+    end
+
+    
+    def to_json(pretty: false)
+      if pretty
+        JSON.pretty_generate(to_json_struct)
+      else
+        to_json_struct.to_json
+      end
+    end
+
+  end
 end

data/schema_dot_org.gemspec

@@ -21,6 +21,8 @@ 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_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_dot_org
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robb Shecter
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2018-02-13 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +85,7 @@ files:
 - bin/console
 - bin/setup
 - lib/schema_dot_org.rb
+- lib/schema_dot_org/place.rb
 - lib/schema_dot_org/version.rb
 - schema_dot_org.gemspec
 homepage: https://github.com/dogweather/schema-dot-org