Release 0.1.0

Author: gkellogg

.gitignore

@@ -5,6 +5,7 @@
 /InstalledFiles
 /pkg/
 /spec/reports/
+/spec/testsuite
 /test/tmp/
 /test/version_tmp/
 /tmp/
@@ -33,3 +34,4 @@ build/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+/Gemfile.lock

.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+bundler_args: --without debug
+script: "bundle exec rspec spec"
+env:
+  - CI=true
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - jruby
+  - rbx-2
+cache: bundler
+sudo: false

.yardopts

@@ -0,0 +1,14 @@
+--title "W3C Linked Data Patch Format for RDF.rb."
+--output-dir doc/yard
+--protected
+--no-private
+--hide-void-return
+--markup markdown
+--readme README.md
+-
+AUTHORS
+VERSION
+LICENSE
+etc/ld-patch.html
+etc/earl.ttl
+etc/earl.html

AUTHORS

@@ -0,0 +1 @@
+* Gregg Kellogg <gregg@greggkellogg.net>

Gemfile

@@ -0,0 +1,23 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'rdf', git: "git://github.com/ruby-rdf/rdf.git", branch: "develop"
+gem 'ebnf', git: "git://github.com/gkellogg/ebnf.git", branch: "develop"
+
+group :development do
+  gem "wirble"
+  gem "byebug", platforms: :mri_21
+end
+
+group :development, :test do
+  gem 'simplecov',  require: false
+  gem 'coveralls',  require: false
+  gem 'psych',      platforms: [:mri, :rbx]
+end
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius', '~> 2.0'
+  gem 'json'
+end

README.md

@@ -0,0 +1,81 @@
+# LD Patch for RDF.rb
+
+This is a [Ruby][] implementation of [LD Patch][] for [RDF.rb][].
+
+[![Gem Version](https://badge.fury.io/rb/ld-patch.png)](http://badge.fury.io/rb/ld-patch)
+[![Build Status](https://travis-ci.org/ruby-rdf/ld-patch.png?branch=master)](http://travis-ci.org/ruby-rdf/ld-patch)
+[![Coverage Status](https://coveralls.io/repos/ruby-rdf/ld-patch/badge.svg)](https://coveralls.io/r/ruby-rdf/ld-patch)
+
+## Description
+
+This gem implements the [LD Patch][] specification with a couple of changes and/or limitations:
+
+* The `INDEX` terminal was replaced by `INTEGER`. Having two terminals matching the same token strings causes a conflict. As a result, a _slice_ may contain positive integers, as well as unsigned and negative-integers.
+* The _graph_ rule is changed to the following:
+
+      [18]    graph           ::=     triples  ('.' triples?)*
+
+  This is necessary as the specified production is not context-free. As a result, it is possible for a graph to contain multiple trailing "`.`".
+
+[LD Patch][] is useful inside a Rack container where it can respond to `POST` messages to affect the modification of a _target graph_ identified using the URL of the `POST`.
+
+## Features
+
+* 100% free and unencumbered [public domain](http://unlicense.org/) software.
+* Complete [Linked Data Patch Format][LD Patch] parsing and execution
+* Implementation Report: {file:etc/earl.html EARL}
+* Compatible with Ruby >= 2.0.0.
+
+## Documentation
+Full documentation available on [Rubydoc.info][LD-Patch doc]
+
+## Implementation Notes
+The reader uses the [EBNF][] gem to generate first, follow and branch tables, and uses the `Parser` and `Lexer` modules to implement the LD Patch parser.
+
+The parser takes branch and follow tables generated from the [LD Patch Grammar](file.ld-patch.html) described in the [specification][LD Patch]. Branch and Follow tables are specified in the generated {LD::Patch::Meta}.
+
+## Dependencies
+
+* [Ruby](http://ruby-lang.org/) (>= 2.0.0)
+* [RDF.rb](http://rubygems.org/gems/rdf) (>= 1.1.15)
+* [EBNF][] (>= 0.3.0)
+* [SPARQL][] (>= 1.1.7)
+* [SXP][] (>= 0.1.5)
+* [RDF::XSD][] (>= 1.1.4)
+
+## Mailing List
+* <http://lists.w3.org/Archives/Public/public-rdf-ruby/>
+
+## Author
+* [Gregg Kellogg](http://github.com/gkellogg) - <http://greggkellogg.net/>
+
+## Contributing
+This repository uses [Git Flow](https://github.com/nvie/gitflow) to mange development and release activity. All submissions _must_ be on a feature branch based on the _develop_ branch to ease staging and integration.
+
+* Do your best to adhere to the existing coding conventions and idioms.
+* Don't use hard tabs, and don't leave trailing whitespace on any line.
+* Do document every method you add using [YARD][] annotations. Read the [tutorial][YARD-GS] or just look at the existing code for examples.
+* Don't touch the `.gemspec`, `VERSION` or `AUTHORS` files. If you need to change them, do so on your private branch only.
+* Do feel free to add yourself to the `CREDITS` file and the corresponding list in the the `README`. Alphabetical order applies.
+* Do note that in order for us to merge any non-trivial changes (as a rule of thumb, additions larger than about 15 lines of code), we need an explicit [public domain dedication][PDD] on record from you.
+
+## License
+This is free and unencumbered public domain software. For more information,
+see <http://unlicense.org/> or the accompanying {file:LICENSE} file.
+
+A copy of the [LD Patch EBNF](file:etc/ld-patch.ebnf) and derived parser files are included in the repository, which are not covered under the UNLICENSE. These files are covered via the [W3C Document License](http://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231).
+
+[Ruby]:           http://ruby-lang.org/
+[RDF]:            http://www.w3.org/RDF/
+[YARD]:           http://yardoc.org/
+[YARD-GS]:        http://rubydoc.info/docs/yard/file/docs/GettingStarted.md
+[PDD]:             http://lists.w3.org/Archives/Public/public-rdf-ruby/2010May/0013.html
+[RDF.rb]:         http://rubygems.org/gems/rdf
+[RDF::XSD]:       http://rubygems.org/gems/rdf-xsd
+[EBNF]:           http://rubygems.org/gems/ebnf
+[SPARQL]:         http://rubygems.org/gems/sparql
+[Linked Data]:    http://rubygems.org/gems/linkeddata
+[SSE]:            http://openjena.org/wiki/SSE
+[SXP]:            http://rubygems.org/gems/sxp-ruby
+[LD Patch]:       http://www.w3.org/TR/ldpatch/
+[LD-Patch doc]:   http://rubydoc.info/github/ruby-rdf/ld-patch

Rakefile

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), 'lib')))
+require 'rubygems'
+require 'yard'
+require 'rspec/core/rake_task'
+
+task default: :spec
+task specs: :spec
+
+namespace :gem do
+  desc "Build the ld-patch-#{File.read('VERSION').chomp}.gem file"
+  task :build do
+    sh "gem build ld-patch.gemspec && mv ld-patch-#{File.read('VERSION').chomp}.gem pkg/"
+  end
+
+  desc "Release the ld-patch-#{File.read('VERSION').chomp}.gem file"
+  task :release do
+    sh "gem push pkg/ld-patch-#{File.read('VERSION').chomp}.gem"
+  end
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Run specs through RCov"
+RSpec::Core::RakeTask.new("spec:rcov") do |spec|
+  spec.rcov = true
+  spec.rcov_opts =  %q[--exclude "spec"]
+end
+
+namespace :doc do
+  YARD::Rake::YardocTask.new
+end
+
+desc 'Create versions of ebnf files in etc'
+task etc: %w{etc/ld-patch.sxp etc/ld-patch.html etc/ld-patch.ll1.sxp}
+
+desc 'Build first, follow and branch tables'
+task meta: "lib/ld/patch/meta.rb"
+
+file "lib/ld/patch/meta.rb" => "etc/ld-patch.ebnf" do |t|
+  sh %{
+    ebnf --ll1 ldpatch --format rb \
+      --mod-name LD::Patch::Meta \
+      --output lib/ld/patch/meta.rb \
+      etc/ld-patch.ebnf
+  }
+end
+
+file "etc/ld-patch.ll1.sxp" => "etc/ld-patch.ebnf" do |t|
+  sh %{
+    ebnf --ll1 ldpatch --format sxp \
+      --output etc/ld-patch.ll1.sxp \
+      etc/ld-patch.ebnf
+  }
+end
+
+file "etc/ld-patch.sxp" => "etc/ld-patch.ebnf" do |t|
+  sh %{
+    ebnf --bnf --format sxp \
+      --output etc/ld-patch.sxp \
+      etc/ld-patch.ebnf
+  }
+end
+
+file "etc/ld-patch.html" => "etc/ld-patch.ebnf" do |t|
+  sh %{
+    ebnf --format html \
+      --output etc/ld-patch.html \
+      etc/ld-patch.ebnf
+  }
+end

VERSION

@@ -0,0 +1 @@
+0.1.0

bin/ldpatch

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", 'lib')))
+require 'ld/patch'
+begin
+  require 'linkeddata'
+rescue LoadError
+  require 'rdf/ntriples'
+  require 'rdf/turtle'
+end
+require 'getoptlong'
+
+def run(input, options = {})
+  if options[:debug]
+    puts "input graph:\n#{options[:graph].dump(:ttl, standard_prefixes: true)}\n" if options[:graph]
+    puts "query:\n#{input}\n"
+  end
+  options[:graph] ||= RDF::Graph.new
+
+  if options[:verbose]
+    puts ("\nPATCH:\n" + input) 
+  end
+
+  patch = if options[:sse]
+    SPARQL::Algebra.parse(input, options)
+  else
+    # Only do grammar debugging if we're generating SSE
+    LD::Patch.parse(input, options)
+  end
+
+  puts ("\nSSE:\n" + patch.to_sse) if options[:debug] || options[:to_sse]
+
+  unless options[:to_sse]
+    res = patch.execute(options[:graph], debug: options[:debug])
+    puts res.inspect if options[:verbose]
+    puts res.dump(:ttl, base_uri: patch.base_uri, prefixes: patch.prefixes, standard_prefixes: true)
+  end
+end
+
+opts = GetoptLong.new(
+  ["--debug", GetoptLong::NO_ARGUMENT],
+  ["--dump", GetoptLong::NO_ARGUMENT],
+  ["--execute", "-e", GetoptLong::REQUIRED_ARGUMENT],
+  ["--progress", GetoptLong::NO_ARGUMENT],
+  ["--sse", GetoptLong::NO_ARGUMENT],
+  ["--to-sse", GetoptLong::NO_ARGUMENT],
+  ["--validate", GetoptLong::NO_ARGUMENT],
+  ["--verbose", GetoptLong::NO_ARGUMENT],
+  ["--help", "-?", GetoptLong::NO_ARGUMENT]
+)
+
+options = {
+  graph: RDF::Repository.new,
+}
+
+input = nil
+
+opts.each do |opt, arg|
+  case opt
+  when '--debug'         then options[:debug] = true
+  when '--dump'          then $dump = true
+  when '--execute'       then input = arg
+  when '--progress'      then options[:debug] ||= 2
+  when '--sse'           then options[:sse] = true
+  when '--to-sse'        then options[:to_sse] = true
+  when '--validate'      then options[:validate] = true
+  when '--verbose'       then options[:verbose] = true
+  when "--help"
+    puts "Usage: #{$0} [options] file-or-uri ..."
+    puts "Options:"
+    puts "      --execute,-e:         Use option argument as the SPARQL input if no files are given"
+    puts "      --dump:               Dump raw output, otherwise serialize to SSE"
+    puts "      --debug:              Display detailed debug output"
+    puts "      --sse:                Input is in SSE format"
+    puts "      --to-sse:             Generate SSE instead of running query"
+    puts "      --verbose:            Display details of processing"
+    puts "      --help,-?:            This message"
+    exit(0)
+  end
+end
+
+if ARGV.empty?
+  s = input ? input : $stdin.read
+  run(s, options)
+else
+  ARGV.each do |test_file|
+    puts "parse #{test_file}"
+    run(RDF::Util::File.open_file(test_file).read, options.merge(base_uri: RDF::URI(test_file)))
+  end
+end
+puts

etc/.earl

@@ -0,0 +1,8 @@
+---
+:format: :json
+:manifest:
+- https://raw.githubusercontent.com/pchampin/ld-patch-testsuite/master/manifest.ttl
+- https://raw.githubusercontent.com/pchampin/ld-patch-testsuite/master/manifest-syntax.ttl
+- https://raw.githubusercontent.com/pchampin/ld-patch-testsuite/master/turtle/manifest-ldpatch.ttl
+:bibRef: ! '[[LDPATCH]]'
+:name: Linked Data Patch Format