Release 0.1.0

Author: gkellogg

.gitignore

@@ -12,3 +12,4 @@ Gemfile.lock
 benchmark/
 /.byebug_history
 /coverage/
+/doc/

.travis.yml

@@ -1,11 +1,18 @@
 language: ruby
 bundler_args: --without debug
 script: "bundle exec rspec spec"
+# Handle git submodules yourself
+git:
+    submodules: false
+# Use sed to replace the SSH URL with the public URL, then initialize submodules
+before_install:
+    - sed -i 's/[email protected]:/https:\/\/github.com\//' .gitmodules
+    - git submodule update --init --recursive
 env:
   - CI=true
 rvm:
-  - 2.2.5
-  - 2.3.1
+  - 2.2.6
+  - 2.3.3
   - jruby
   - rbx
 cache: bundler

.yardopts

@@ -0,0 +1,14 @@
+--title "ShEx: Shape Expression language for Ruby"
+--output-dir doc/yard
+--protected
+--no-private
+--hide-void-return
+--markup markdown
+--readme README.md
+-
+AUTHORS
+VERSION
+LICENSE
+etc/shex.html
+etc/earl.ttl
+etc/earl.html

Gemfile

@@ -2,15 +2,14 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rdf',      github: "ruby-rdf/rdf",       branch: "develop"
+gem 'rdf',          github: "ruby-rdf/rdf",         branch: "develop"
 
 group :development, :test do
-  gem 'ebnf',               github: "gkellogg/ebnf",                branch: "develop"
-  gem 'linkeddata',         github: "ruby-rdf/linkeddata",          branch: "develop"
-  gem 'rdf-isomorphic',     github: "ruby-rdf/rdf-isomorphic",      branch: "develop"
-  gem 'rdf-turtle',         github: "ruby-rdf/rdf-turtle",          branch: "develop"
-  gem 'rdf-xsd',            github: "ruby-rdf/rdf-xsd",             branch: "develop"
-  gem 'sxp',                github: "dryruby/sxp.rb",               branch: "develop"
+  gem 'ebnf',       github: "gkellogg/ebnf",        branch: "develop"
+  gem 'linkeddata', github: "ruby-rdf/linkeddata",  branch: "develop"
+  gem 'sxp',        github: "dryruby/sxp.rb",       branch: "develop"
+  gem 'simplecov',  require: false
+  gem 'coveralls',  require: false
 end
 
 group :debug do

README.md

@@ -1,8 +1,8 @@
 # ShEx: Shape Expression language for Ruby
 
-This is a pure-Ruby library for working with the [Shape Expressions Language][ShEx] to validate the shape of [RDF][] graphs.
+This is a pure-Ruby library for working with the [Shape Expressions Language][ShExSpec] to validate the shape of [RDF][] graphs.
 
-* <http://ruby-rdf.github.com/shex>
+<http://ruby-rdf.github.com/shex>
 
 [![Gem Version](https://badge.fury.io/rb/shex.png)](http://badge.fury.io/rb/shex)
 [![Build Status](https://travis-ci.org/ruby-rdf/shex.png?branch=master)](http://travis-ci.org/ruby-rdf/shex)
@@ -12,14 +12,51 @@ This is a pure-Ruby library for working with the [Shape Expressions Language][Sh
 ## Features
 
 * 100% pure Ruby with minimal dependencies and no bloat.
-* Fully compatible with [RDF 1.1][] specifications.
+* Fully compatible with [ShEx][ShExSpec] specifications.
 * 100% free and unencumbered [public domain](http://unlicense.org/) software.
 
+## Description
+
+The ShEx gem implements a [ShEx][ShExSpec] Shape Expression engine.
+
+* `ShEx::Parser` parses ShExC formatted documents generating executable operators which can be serialized as [S-Expressions](http://en.wikipedia.org/wiki/S-expression).
+* `ShEx::Algebra` executes operators against Any `RDF::Graph`, including compliant [RDF.rb][].
+
+## Example
+
+    require 'rubygems'
+    require 'rdf/turtle'
+    require 'shex'
+
+    shexc: %(
+      PREFIX doap:  <http://usefulinc.com/ns/doap#>
+      PREFIX dc:    <http://purl.org/dc/terms/>
+      <TestShape> EXTRA a {
+        a doap:Project;
+        (doap:name;doap:description|dc:title;dc:description)+;
+        doap:category*;
+        doap:developer IRI;
+        doap:implements    [<https://shexspec.github.io/spec/>]
+      }
+    )
+    graph = RDF::Graph.load("etc/doap.ttl")
+    schema = ShEx.parse(shexc)
+    map = {
+      "http://rubygems.org/gems/shex" => "TestShape"
+    }
+    schema.satisfies?("http://rubygems.org/gems/shex", graph, map)
+    # => true
+
 ## Documentation
 
 <http://rubydoc.info/github/ruby-rdf/shex>
 
 
+## Implementation Notes
+The ShExC parser uses the [EBNF][] gem to generate first, follow and branch tables, and uses the `Parser` and `Lexer` modules to implement the ShExC parser.
+
+The parser takes branch and follow tables generated from the [ShEx Grammar](file.shex.html) described in the [specification][ShExSpec]. Branch and Follow tables are specified in the generated {ShEx::Meta}.
+
 ## Dependencies
 
 * [Ruby](http://ruby-lang.org/) (>= 2.0)
@@ -30,7 +67,7 @@ This is a pure-Ruby library for working with the [Shape Expressions Language][Sh
 The recommended installation method is via [RubyGems](http://rubygems.org/).
 To install the latest official release of RDF.rb, do:
 
-    % [sudo] gem install shex             # Ruby 2+
+    % [sudo] gem install shex
 
 ## Download
 
@@ -81,5 +118,7 @@ This repository uses [Git Flow](https://github.com/nvie/gitflow) to mange develo
 This is free and unencumbered public domain software. For more information,
 see <http://unlicense.org/> or the accompanying {file:LICENSE} file.
 
-[ShEx]:             https://shexspec.github.io/spec/
-[RDF]:              http://www.w3.org/RDF/
+[ShExSpec]:     https://shexspec.github.io/spec/
+[RDF]:          http://www.w3.org/RDF/
+[RDF.rb]:       http://rubydoc.info/github/ruby-rdf/rdf
+[EBNF]:         http://rubygems.org/gems/ebnf

VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

etc/doap.shex

@@ -0,0 +1,20 @@
+PREFIX doap:  <http://usefulinc.com/ns/doap#>
+PREFIX dc:    <http://purl.org/dc/terms/>
+<TestShape> EXTRA a {
+  a [doap:Project];
+
+  # May have either or both of doap:name/doap:description or dc:title/dc:description
+  ( doap:name Literal;
+    doap:description Literal
+  | dc:title Literal;
+    dc:description Literal)+;
+
+  # Good idea to use a category for what the project relates to
+  doap:category IRI*;
+
+  # There must be at least one developer
+  doap:developer  IRI+;
+
+  # For our purposes, it MUST implement the ShEx specification.
+  doap:implements [<https://shexspec.github.io/spec/>]
+}

etc/doap.ttl

@@ -7,27 +7,27 @@
 @prefix ex:   <http://example.org/> .
 @prefix xsd:  <http://www.w3.org/2001/XMLSchema#> .
 
-<http://rubygems.org/gems/rdf-turtle> a doap:Project, earl:TestSubject, earl:Software ;
-  doap:name          "RDF::Turtle" ;
-  doap:homepage      <http://ruby-rdf.github.com/rdf-turtle> ;
+<http://rubygems.org/gems/shex> a doap:Project, earl:TestSubject, earl:Software ;
+  doap:name          "ShEx" ;
+  doap:homepage      <http://ruby-rdf.github.com/shex> ;
   doap:license       <http://creativecommons.org/licenses/publicdomain/> ;
-  doap:shortdesc     "Turtle reader/writer for Ruby."@en ;
-  doap:description   "RDF::Turtle is an Turtle reader/writer for the RDF.rb library suite."@en ;
-  doap:created       "2011-08-29"^^xsd:date ;
+  doap:shortdesc     "ShEx is a Shape Expression engine for Ruby."@en ;
+  doap:description   "ShEx is an Shape Expression engine for the RDF.rb library suite."@en ;
+  doap:created       "2016-12-09"^^xsd:date ;
   doap:programming-language "Ruby" ;
-  doap:implements    <http://www.w3.org/TR/turtle/> ;
+  doap:implements    <https://shexspec.github.io/spec/> ;
   doap:category      <http://dbpedia.org/resource/Resource_Description_Framework>,
                      <http://dbpedia.org/resource/Ruby_(programming_language)> ;
-  doap:download-page <http://rubygems.org/gems/rdf-turtle> ;
+  doap:download-page <http://rubygems.org/gems/shex> ;
   doap:mailing-list  <http://lists.w3.org/Archives/Public/public-rdf-ruby/> ;
-  doap:bug-database  <http://github.com/ruby-rdf/rdf-turtle/issues> ;
+  doap:bug-database  <http://github.com/ruby-rdf/shex/issues> ;
   doap:blog          <http://greggkellogg.net/> ;
   doap:developer     <http://greggkellogg.net/foaf#me> ;
   doap:maintainer    <http://greggkellogg.net/foaf#me> ;
   doap:documenter    <http://greggkellogg.net/foaf#me> ;
   foaf:maker         <http://greggkellogg.net/foaf#me> ;
-  dc:title           "RDF::Turtle" ;
-  dc:description     "RDF::Turtle is an Turtle reader/writer for the RDF.rb library suite."@en ;
-  dc:date            "2011-08-29"^^xsd:date ;
+  dc:title           "ShEx" ;
+  dc:description     "ShEx is an Shape Expression engine for the RDF.rb library suite."@en ;
+  dc:date            "2016-12-09"^^xsd:date ;
   dc:creator         <http://greggkellogg.net/foaf#me> ;
   dc:isPartOf        <http://rubygems.org/gems/rdf> .