schema_dot_org 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c235d549a6a316ac26bf5e055b310c947e18382f89294808f8ebc8e5ce35a4cf
-  data.tar.gz: 2751fa4daf7f808cfb51bf384cf6aed926cf0c6565fb5f7457a36f5fed02335a
+  metadata.gz: 4bd245f102143fc57e4bf985a21e2ae949b84fb167cd8c4f7493a1b7a51a60a9
+  data.tar.gz: 56f992158f40aa238b21db445f271c2003d2951487dcbf7ae877b7d960bbe234
 SHA512:
-  metadata.gz: 1986324b423f381779fbb2d0696853aa875ff86eb9252c7127cab49236f50100c2d60ba94f1730c4cb1e4e6811b5614d3cb991f2f6e2da87cd355981d9b2d89e
-  data.tar.gz: c5484937988f31451abac9e3e7b5b73a3843fad82b0a3240d1ba845e40b1abb7512dffd99964d99cf170e2254f134b51190eab2557827a34fb098661374a6716
+  metadata.gz: bdf3de02430450ea2d6485f70db9d596f7d106bd8a026976381a5807f61209f947e0c5d451acde42fd0bcbbb2852fbad676b8aa7f2a0d9c4f5a5671b59bc8619
+  data.tar.gz: f63ed74bab57639271bcf92f73bd391ba7660a3a59a6d0c55332a72ccbb2b79e406c04d4012a7b547ee3e1a3887bfa9424a44f916360d89d47b88a9219193657

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    schema_dot_org (0.1.0)
+    schema_dot_org (0.2.0)
       validated_object
 
 GEM

data/README.md

@@ -1,33 +1,55 @@
+[![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)
+
 # SchemaDotOrg
 
+Let's create [Structured Data](https://developers.google.com/search/docs/guides/intro-structured-data) that's correct,
+every single time.
+
+> 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 . . .
 
 ## Usage
 
-Create the tree of objects, and then call `#to_s` in (e.g.) a Rails template:
+Create the tree of objects, and then call `#to_s` in e.g., a Rails template:
 
 ```ruby
 require 'schema_dot_org/place'
+require 'schema_dot_org/organization'
 include SchemaDotOrg
 
-@founding_location = Place.new { |p| p.address = "Las Vegas, NV" }
+
+@public_law = Organization.new do |org|
+  org.name  = "Public.Law"
+  org.email = "say_hi@public.law"
+  org.url   = "https://www.public.law"
+  org.founding_location = Place.new do |place|
+    place.address = "Portland, OR"
+  end
+end
 ```
 
 ```html
-<%= @founding_location %>
+<%= @public_law %>
 ```
 
-This results in the generated webpage containing absolutely correct Schema.org JSON-LD markup:
+The generated webpage will contain correct Schema.org JSON-LD markup:
 
 ```html
 <script type="application/ld+json">
 {
-  "@type": "Place",
-  "address": "Las Vegas, NV"
-}
-</script>
+  "@context": "http://schema.org",
+  "@type": "Organization",
+  "name": "Public.Law",
+  "email": "say_hi@public.law",
+  "url": "https://www.public.law",
+  "foundingLocation": {
+    "@type": "Place",
+    "address": "Portland, OR"
+  }
 ```
 
-You cannot create invalid markup: E.g., If you use the wrong type or try to set an unknown attribute, SchemaDotOrg will
+### 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:
 
@@ -79,7 +101,7 @@ And it should do it in a **typesafe** way. That is, not merely syntactically cor
 but also _semantically_ correct. It should, e.g.,  ensure that only allowed
 attributes are used.
 
-## Schema Development Status
+## Schema Development Roadmap
 
 | Type | Planned | Completed |
 | ---- |:-------:|:---------:|
@@ -90,7 +112,7 @@ attributes are used.
 | 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.
+Propose new types and attributes by opening an Issue.
 
 ## Installation
 

data/lib/schema_dot_org/organization.rb

@@ -0,0 +1,23 @@
+require 'schema_dot_org'
+
+
+module SchemaDotOrg
+  class Organization < SchemaType
+    attr_accessor :founding_location, :email, :name, :url
+
+    validates :email,             type: String
+    validates :founding_location, type: Place
+    validates :name,              type: String
+    validates :url,               type: String
+
+    def to_json_struct
+      {
+        "@type" => "Organization",
+        "name" => name,
+        "email" => email,
+        "url" => url,
+        "foundingLocation" => founding_location.to_json_struct
+      }
+    end
+  end
+end

data/lib/schema_dot_org/place.rb

@@ -1,4 +1,3 @@
-require 'json'
 require 'schema_dot_org'
 
 

data/lib/schema_dot_org/version.rb

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

data/lib/schema_dot_org.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'validated_object'
 require 'schema_dot_org/version'
 
@@ -6,6 +7,8 @@ module SchemaDotOrg
   # Base class for schema types. Refactors out common code.
   #
   class SchemaType < ValidatedObject::Base
+    ROOT_ATTR = {"@context" => "http://schema.org"}
+
      
     def to_s
       to_json_ld(pretty: true)
@@ -13,15 +16,17 @@ module SchemaDotOrg
 
 
     def to_json_ld(pretty: false)
-      "<script type=\"application/ld+json\">\n" + to_json(pretty: pretty) + "\n</script>"
+      "<script type=\"application/ld+json\">\n" + to_json(pretty: pretty, as_root: true) + "\n</script>"
     end
 
     
-    def to_json(pretty: false)
+    def to_json(pretty: false, as_root: false)
+      structure = as_root ? ROOT_ATTR.merge(to_json_struct) : to_json_struct
+
       if pretty
-        JSON.pretty_generate(to_json_struct)
+        JSON.pretty_generate(structure)
       else
-        to_json_struct.to_json
+        structure.to_json
       end
     end
 

data/test-script.rb

@@ -0,0 +1,15 @@
+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.founding_location = Place.new do |place| 
+    place.address = "Portland, OR"
+  end
+end
+
+puts public_law

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_dot_org
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Robb Shecter
@@ -85,9 +85,11 @@ files:
 - bin/console
 - bin/setup
 - lib/schema_dot_org.rb
+- lib/schema_dot_org/organization.rb
 - lib/schema_dot_org/place.rb
 - lib/schema_dot_org/version.rb
 - schema_dot_org.gemspec
+- test-script.rb
 homepage: https://github.com/dogweather/schema-dot-org
 licenses:
 - MIT