SchemaDotOrg

Let's create 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:

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 %>

SchemaDotOrg will validate your code, and if correct, will generate Schema.org JSON-LD markup:

<script type="application/ld+json">
{
  "@context": "http://schema.org",
  "@type": "Organization",
  "name": "Public.Law",
  "email": "say_hi@public.law",
  "url": "https://www.public.law",
  "logo": "https://www.public.law/favicon-196x196.png",
  "foundingDate": "2009-03-06",
  "founder": {
    "@type": "Person",
    "name": "Robb Shecter"
  },
  "foundingLocation": {
    "@type": "Place",
    "address": "Portland, OR"
  }
</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 which adds the proper @type attribute.

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:

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.

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. Propose new types and attributes by opening an Issue.

Installation

Add this line to your application's Gemfile:

gem 'schema_dot_org'

And then execute:

$ bundle

Or install it yourself as:

$ gem install schema_dot_org

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dogweather/schema_dot_org.

License

The gem is available as open source under the terms of the MIT License.