Finish 3.3.2

Author: gkellogg

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.0', 3.1, 3.2, 3.3, ruby-head, jruby]
+        ruby: ['3.0', 3.1, 3.2, 3.3, 3.4, ruby-head, jruby]
     steps:
       - name: Clone repository
         uses: actions/checkout@v3

.github/workflows/generate-docs.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.1"
+          ruby-version: "3.4"
       - name: Install required gem dependencies
         run: gem install yard --no-document
       - name: Build YARD Ruby Documentation

Gemfile

@@ -14,13 +14,13 @@ group :development do
   gem 'json-ld-preloaded',github: 'ruby-rdf/json-ld-preloaded',   branch: 'develop'
   gem 'ld-patch',         github: 'ruby-rdf/ld-patch',            branch: 'develop'
   gem 'linkeddata',       github: 'ruby-rdf/linkeddata',          branch: 'develop'
-  gem 'rdf-hamster-repo',   github: 'ruby-rdf/rdf-hamster-repo',    branch: 'develop'
+  gem 'rdf-hamster-repo', github: 'ruby-rdf/rdf-hamster-repo',    branch: 'develop'
   gem 'rdf-isomorphic',   github: 'ruby-rdf/rdf-isomorphic',      branch: 'develop'
   gem 'rdf-json',         github: 'ruby-rdf/rdf-json',            branch: 'develop'
   gem 'rdf-microdata',    github: 'ruby-rdf/rdf-microdata',       branch: 'develop'
   gem 'rdf-n3',           github: 'ruby-rdf/rdf-n3',              branch: 'develop'
   gem 'rdf-normalize',    github: 'ruby-rdf/rdf-normalize',       branch: 'develop'
-  gem 'rdf-ordered-repo',   github: 'ruby-rdf/rdf-ordered-repo',    branch: 'develop'
+  gem 'rdf-ordered-repo', github: 'ruby-rdf/rdf-ordered-repo',    branch: 'develop'
   gem 'rdf-rdfa',         github: 'ruby-rdf/rdf-rdfa',            branch: 'develop'
   gem 'rdf-rdfxml',       github: 'ruby-rdf/rdf-rdfxml',          branch: 'develop'
   gem 'rdf-reasoner',     github: 'ruby-rdf/rdf-reasoner',        branch: 'develop'
@@ -41,8 +41,8 @@ group :debug do
   gem 'shotgun'  unless ENV['CI']
   gem 'pry'
   gem 'pry-byebug', platforms: :mri
-  gem 'redcarpet', platforms: :ruby
-  gem 'ruby-prof', platforms: :mri
+  gem 'redcarpet',  platforms: :ruby
+  gem 'ruby-prof',  platforms: :mri
 end
 
 group :test do

README.md

@@ -27,7 +27,7 @@ An implementation of [SPARQL][] for [RDF.rb][].
 * Implementation Report: {file:etc/earl.html EARL}
 * Compatible with Ruby >= 3.0.
 * Supports Unicode query strings both on all versions of Ruby.
-* Provisional support for [SPARQL-star][].
+* Provisional support for [SPARQL 1.2][].
 
 ## Description
 
@@ -68,17 +68,20 @@ Not supported:
 * [Entailment Regimes][SPARQL 1.1 Entailment Regimes], and
 * [Graph Store HTTP Protocol][SPARQL 1.1 Graph Store HTTP Protocol] but the closely related [Linked Data Platform][] implemented in [rdf-ldp](https://github.com/ruby-rdf/rdf-ldp) supports these use cases.
 
+### Optimizations
+Generally, optimizing a query can lead to improved performance, sometimes dramatically (e.g., `?s rdf:rest*/rdf:first ?o`). Optimization can be done when parsing a query using the `:optimize` option, or the `optimize` method on a parsed query.
+
 ### Updates for RDF 1.1
 Starting with version 1.1.2, the SPARQL gem uses the 1.1 version of the [RDF.rb][], which adheres to [RDF 1.1 Concepts](https://www.w3.org/TR/rdf11-concepts/) rather than [RDF 1.0](https://www.w3.org/TR/rdf-concepts/). The main difference is that there is now no difference between a _Simple Literal_ (a literal with no datatype or language) and a Literal with datatype _xsd:string_; this causes some minor differences in the way in which queries are understood, and when expecting different results.
 
 Additionally, queries now take a block, or return an `Enumerator`; this is in keeping with much of the behavior of [RDF.rb][] methods, including `Queryable#query`, and with version 1.1 or [RDF.rb][], Query#execute. As a consequence, all queries which used to be of the form `query.execute(repository)` may equally be called as `repository.query(query)`. Previously, results were returned as a concrete class implementing `RDF::Queryable` or `RDF::Query::Solutions`, these are now `Enumerators`.
 
-### SPARQL 1.2
-The gem supports some of the extensions proposed by the [SPARQL 1.2 Community Group](https://github.com/w3c/sparql-12). In particular, the following extensions are now implemented:
+### SPARQL Dev
+The gem supports some of the extensions proposed by the [SPARQL Dev Community Group](https://github.com/w3c/sparql-dev). In particular, the following extensions are now implemented:
 
-* [SEP-0002: better support for Durations, Dates, and Times](https://github.com/w3c/sparql-12/blob/main/SEP/SEP-0002/sep-0002.md)
+* [SEP-0002: better support for Durations, Dates, and Times](https://github.com/w3c/sparql-dev/blob/main/SEP/SEP-0002/sep-0002.md)
   * This includes full support for `xsd:date`, `xsd:time`, `xsd:duration`, `xsd:dayTimeDuration`, and `xsd:yearMonthDuration` along with associated XPath/XQuery functions including a new `ADJUST` builtin. (**Note: This feature is subject to change or elimination as the standards process progresses.**)
-* [SEP-0003: Property paths with a min/max hop](https://github.com/w3c/sparql-12/blob/main/SEP/SEP-0003/sep-0003.md)
+* [SEP-0003: Property paths with a min/max hop](https://github.com/w3c/sparql-dev/blob/main/SEP/SEP-0003/sep-0003.md)
   * This includes support for non-counting path forms such as `rdf:rest{1,3}` to match the union of paths `rdf:rest`, `rdf:rest/rdf:rest`, and `rdf:rest/rdf:rest/rdf:rest`.  (**Note: This feature is subject to change or elimination as the standards process progresses.**)
 
 ### SPARQL Extension Functions
@@ -107,9 +110,9 @@ See {SPARQL::Algebra::Expression.register_extension} for details.
 
 A call to execute a parsed query can include pre-bound variables, which cause queries to be executed with matching variables bound as defined. Variable pre-binding can be done using a Hash structure, or a Query Solution.  See [Query with Binding example](#query-with-binding) and {SPARQL::Algebra::Query#execute}.
 
-### SPARQLStar (SPARQL-star)
+### SPARQL 1.2
 
-The gem supports [SPARQL-star][] where patterns may include sub-patterns recursively, for a kind of Reification.
+The gem supports [SPARQL 1.2][] where patterns may include sub-patterns recursively, for a kind of Reification.
 
 For example, the following Turtle* file uses a statement as the subject of another statement:
 
@@ -170,7 +173,7 @@ As well as a `CONSTRUCT`:
       <<?bob foaf:age ?age>> ?b ?c .
     }
 
-Note that results can be serialized only when the format supports [RDF-star][].
+Note that results can be serialized only when the format supports [SPARQL 1,2][].
 
 #### SPARQL results
 
@@ -462,8 +465,6 @@ see <https://unlicense.org/> or the accompanying {file:UNLICENSE}.
 
 A copy of the [SPARQL 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](https://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231).
 
-A copy of the [SPARQL 1.0 tests][] and [SPARQL 1.1 tests][] are also included in the repository, which are not covered under the UNLICENSE; see the references for test copyright information.
-
 [Ruby]:             https://ruby-lang.org/
 [RDF]:              https://www.w3.org/RDF/
 [RDF::DO]:          https://rubygems.org/gems/rdf-do
@@ -474,20 +475,17 @@ A copy of the [SPARQL 1.0 tests][] and [SPARQL 1.1 tests][] are also included in
 [PDD]:              https://unlicense.org/#unlicensing-contributions
 [SPARQL]:           https://en.wikipedia.org/wiki/SPARQL
 [SPARQL 1.0]:       https://www.w3.org/TR/sparql11-query/
-[SPARQL 1.0 tests]:https://www.w3.org/2001/sw/DataAccess/tests/
-[SPARQL 1.1 tests]: https://www.w3.org/2009/sparql/docs/tests/
 [SSE]:              https://jena.apache.org/documentation/notes/sse.html
 [SXP]:              https://dryruby.github.io/sxp
 [grammar]:          https://www.w3.org/TR/sparql11-query/#grammar
 [RDF 1.1]:          https://www.w3.org/TR/rdf11-concepts
 [RDF.rb]:           https://ruby-rdf.github.io/rdf
-[RDF-star]:             https://w3c.github.io/rdf-star/rdf-star-cg-spec.html
-[SPARQL-star]:          https://w3c.github.io/rdf-star/rdf-star-cg-spec.html#sparql-query-language
+[SPARQL 1.2]:          https://www.w3.org/TR/sparql12-query
 [Linked Data]:      https://rubygems.org/gems/linkeddata
 [SPARQL doc]:       https://ruby-rdf.github.io/sparql/frames
 [SPARQL XML]:       https://www.w3.org/TR/rdf-sparql-XMLres/
 [SPARQL JSON]:      https://www.w3.org/TR/rdf-sparql-json-res/
-[SPARQL EBNF]:      https://www.w3.org/TR/sparql11-query/#sparqlGrammar
+[SPARQL EBNF]:      https://www.w3.org/TR/sparql12-query/#sparqlGrammar
 
 [SSD]:              https://www.w3.org/TR/sparql11-service-description/
 [Rack]:             https://rack.github.io

Rakefile

@@ -34,11 +34,11 @@ namespace :spec do
     require 'suite_helper'
 
     puts "load 1.0 tests"
-    SPARQL::Spec.sparql1_0_tests(true)
+    SPARQL::Spec.sparql_11_tests(true)
     puts "load 1.0 syntax tests"
-    SPARQL::Spec.sparql1_0_syntax_tests(true)
+    SPARQL::Spec.sparql_11_syntax_tests(true)
     puts "load 1.1 tests"
-    SPARQL::Spec.sparql1_1_tests(true)
+    SPARQL::Spec.sparql_11_tests(true)
   end
 end
 
@@ -59,8 +59,7 @@ file "etc/manifest-cache.nt" do
   graph = RDF::Graph.new do |g|
     {
       "http://w3c.github.io/rdf-tests/sparql/" => "../w3c-rdf-tests/sparql/",
-      "https://w3c.github.io/rdf-star/tests/sparql/" => "../w3c-rdf-star/tests/sparql/",
-      "https://w3c.github.io/sparql-12/tests/" => "spec/w3c-sparql-12/tests/"
+      "https://w3c.github.io/sparql-dev/tests/" => "../w3c-sparql-dev/tests/"
     }.each do |base, path|
       Dir.glob("#{path}**/manifest.ttl").each do |man|
         puts "load #{man}"
@@ -73,41 +72,42 @@ file "etc/manifest-cache.nt" do
 end
 
 desc 'Create versions of ebnf files in etc'
-task etc: %w{etc/sparql11.sxp etc/sparql11.html etc/sparql11.ll1.sxp}
+task etc: %w{etc/sparql12.sxp etc/sparql12.html etc/sparql12.peg.sxp}
 
 desc 'Build first, follow and branch tables'
 task meta: "lib/sparql/grammar/meta.rb"
 
-file "lib/sparql/grammar/meta.rb" => "etc/sparql11.bnf" do |t|
+file "lib/sparql/grammar/meta.rb" => "etc/sparql12.bnf" do |t|
   sh %{
-    ebnf --ll1 QueryUnit --ll1 UpdateUnit --format rb \
+    ebnf --peg --format rb \
       --mod-name SPARQL::Grammar::Meta \
       --output lib/sparql/grammar/meta.rb \
-      etc/sparql11.bnf
+      etc/sparql12.bnf
   }
 end
 
-file "etc/sparql11.ll1.sxp" => "etc/sparql11.bnf" do |t|
+file "etc/sparql12.sxp" => "etc/sparql12.bnf" do |t|
   sh %{
-    ebnf --ll1 QueryUnit --ll1 UpdateUnit --format sxp \
-      --output etc/sparql11.ll1.sxp \
-      etc/sparql11.bnf
+    ebnf --bnf --format sxp \
+      --output etc/sparql12.sxp \
+      etc/sparql12.bnf
   }
 end
 
-file "etc/sparql11.sxp" => "etc/sparql11.bnf" do |t|
+file "etc/sparql12.peg.sxp" => "etc/sparql12.bnf" do |t|
   sh %{
-    ebnf --bnf --format sxp \
-      --output etc/sparql11.sxp \
-      etc/sparql11.bnf
+    ebnf --peg --format sxp \
+      --output etc/sparql12.peg.sxp \
+      etc/sparql12.bnf
   }
 end
 
-file "etc/sparql11.html" => "etc/sparql11.bnf" do |t|
+file "etc/sparql12.html" => "etc/sparql12.bnf" do |t|
   sh %{
     ebnf --format html \
-      --output etc/sparql11.html \
-      etc/sparql11.bnf
+      --output etc/sparql12.html \
+      --renumber \
+      etc/sparql12.bnf
   }
 end
 

VERSION

@@ -1 +1 @@
-3.3.1
+3.3.2

bin/sparql

@@ -3,6 +3,8 @@ require 'rubygems'
 $:.unshift("../../lib", __FILE__)
 require 'logger'
 require 'sparql'
+require 'rack'
+require 'rackup'
 begin
   require 'linkeddata'
 rescue LoadError
@@ -45,6 +47,8 @@ def run(input, **options)
     SPARQL::Grammar.parse(input, **options)
   end
 
+  query = query.optimize if options[:optimize]
+
   puts ("\nSSE:\n" + query.to_sse) if options[:debug]
 
   if options[:parse_only]
@@ -64,42 +68,46 @@ end
 
 def server(options)
   app = SPARQL::Server.application(**options)
-  Rack::Server.start(app: app, Port: options.fetch(:port, 9292))
+  Rackup::Server.start(app: app, Port: options.fetch(:port, 9292))
 rescue LoadError
-  $stderr.puts "Running SPARQL server requires Rack and Sinatra to be in environment: #{$!.message}"
+  $stderr.puts "Running SPARQL server requires Rack, Rackup, and Sinatra to be in environment: #{$!.message}"
 end
 
+cmd, input = ARGV.shift, nil
+
+OPT_ARGS = [
+  ["--dataset", GetoptLong::REQUIRED_ARGUMENT, "File containing RDF graph or dataset"],
+  ["--debug", GetoptLong::NO_ARGUMENT, "Debugging output"],
+  ["--execute", "-e", GetoptLong::REQUIRED_ARGUMENT, "Run against source in argument"],
+  ["--format", GetoptLong::REQUIRED_ARGUMENT, "Output format for results (json, xml, csv, tsv, html, sparql, sse, or another RDF format)"],
+  ["--help", "-?", GetoptLong::NO_ARGUMENT, "print this message"],
+  ["--optimize", GetoptLong::NO_ARGUMENT, "Perform query optimizations"],
+  ["--port", "-p", GetoptLong::REQUIRED_ARGUMENT, "Port on which to run server; defaults to 9292"],
+  ["--sse", GetoptLong::NO_ARGUMENT, "Query input is in SSE format"],
+  ["--update", GetoptLong::NO_ARGUMENT, "Process query as a SPARQL Update"],
+  ["--verbose", GetoptLong::NO_ARGUMENT, "Verbose output"],
+]
+
 def usage
   puts "Usage: #{File.basename($0)} execute [options] query-file         Execute a query against the specified dataset"
   puts "       #{File.basename($0)} parse [options] query-file           Parse a query into SPARQL S-Expressions (SSE)"
   puts "       #{File.basename($0)} query [options] end-point query-file Run the query against a remote end-point"
   puts "       #{File.basename($0)} server [options] dataset-file        Start a server initialized from the specified dataset"
   puts "Options:"
-  puts "      --dataset:            File containing RDF graph or dataset"
-  puts "      --debug:              Display detailed debug output"
-  puts "      --execute,-e:         Use option argument as the SPARQL input if no query-file given"
-  puts "      --format:             Output format for results (json, xml, csv, tsv, html, sparql, sse, or another RDF format)"
-  puts "      --port,-p             Port on which to run server; defaults to 9292"
-  puts "      --sse:                Query input is in SSE format"
-  puts "      --update:             Process query as a SPARQL Update"
-  puts "      --verbose:            Display details of processing"
-  puts "      --help,-?:            This message"
+  width = OPT_ARGS.map do |o|
+    l = o.first.length
+    l += o[1].length + 2 if o[1].is_a?(String)
+    l
+  end.max
+  OPT_ARGS.each do |o|
+    s = "  %-*s  " % [width, (o[1].is_a?(String) ? "#{o[0,2].join(', ')}" : o[0])]
+    s += o.last
+    puts s
+  end
   exit(0)
 end
 
-cmd, input = ARGV.shift, nil
-
-opts = GetoptLong.new(
-  ["--dataset", GetoptLong::REQUIRED_ARGUMENT],
-  ["--debug", GetoptLong::NO_ARGUMENT],
-  ["--execute", "-e", GetoptLong::REQUIRED_ARGUMENT],
-  ["--format", GetoptLong::REQUIRED_ARGUMENT],
-  ["--port", "-p", GetoptLong::REQUIRED_ARGUMENT],
-  ["--sse", GetoptLong::NO_ARGUMENT],
-  ["--update", GetoptLong::NO_ARGUMENT],
-  ["--verbose", GetoptLong::NO_ARGUMENT],
-  ["--help", "-?", GetoptLong::NO_ARGUMENT]
-)
+opts = GetoptLong.new(*OPT_ARGS.map {|o| o[0..-2]})
 
 logger = Logger.new(STDERR)
 logger.level = Logger::WARN
@@ -116,6 +124,7 @@ opts.each do |opt, arg|
   when '--debug'         then options[:debug] = true ; logger.level = Logger::DEBUG
   when '--execute'       then input = arg
   when '--format'        then options[:format] = arg.to_sym
+  when '--optimize'      then options[:optimize] = true
   when '--port'          then options[:port] = arg.to_i
   when '--sse'           then options[:sse] = true
   when '--update'        then options[:update] = true