sparql 0.0.1

data/lib/sparql.rb

@@ -0,0 +1,28 @@
+# This file is part of Sparql.rb.
+# 
+# Sparql.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Sparql.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Sparql.rb.  If not, see <http://www.gnu.org/licenses/>.
+
+
+require 'rubygems'
+require 'pathname'
+
+class Pathname
+  def /(path)
+    (self + path).expand_path
+  end
+end # class Pathname
+
+dir = Pathname(__FILE__).dirname.expand_path / 'sparql'
+
+require dir / 'execute_sparql'

data/lib/sparql/execute_sparql.rb

@@ -0,0 +1,27 @@
+# This file is part of Sparql.rb.
+# 
+# Sparql.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Sparql.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Sparql.rb.  If not, see <http://www.gnu.org/licenses/>.
+
+
+require 'rubygems'
+require 'treetop'
+
+Treetop.load "lib/sparql/primitives"
+Treetop.load "lib/sparql/prefixed_names"
+Treetop.load "lib/sparql/variables"
+Treetop.load "lib/sparql/iri"
+Treetop.load "lib/sparql/logical_expressions"
+Treetop.load "lib/sparql/graph"
+Treetop.load "lib/sparql/series"
+Treetop.load "lib/sparql/sparql"

data/lib/sparql/sparql.treetop

@@ -0,0 +1,159 @@
+#!/usr/bin/env tt
+# Author::    Pius Uzamere, The Uyiosa Corporation (http://uyiosa.com/)
+# Copyright:: 2008 Pius Uzamere
+
+# This file is part of Sparql.rb.
+# 
+# Sparql.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Sparql.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Sparql.rb.  If not, see <http://www.gnu.org/licenses/>.
+
+grammar Sparql
+	include Primitives
+	include Variables
+	include LogicalExpressions
+	include Graph
+	include Series
+	
+	# 	'SELECT ?v WHERE { ?v ?p "cat"@en }'
+
+	rule query
+	   prologue space query_part:( select_query / construct_query / describe_query / ask_query ) {
+		def well_formed?
+			true #=> if a node has been identified as a query, it's well-formed by definition.
+		end
+	}
+	end
+	
+	rule prologue
+		base_decl? prefix_decl*
+	end
+	
+	rule base_decl
+		'BASE' space iri_ref
+	end
+	
+	rule prefix_decl
+		'PREFIX' space pname_ns space iri_ref
+	end
+	
+	rule select_query
+	   'SELECT' space (( 'DISTINCT' / 'REDUCED' ) space)? ( series_of_variables / '*' ) space (series_of_dataset_clauses space)? where space solution_modifier 
+	{
+		def query_type
+			"SELECT"
+		end
+	}
+	end
+	
+	rule ask_query
+		'ASK' space (series_of_dataset_clauses space)? where {
+			def query_type
+				"ASK"
+			end
+		}
+	end
+	
+	rule describe_query
+		'DESCRIBE' space ( series_of_var_or_irirefs / '*' ) space (series_of_dataset_clauses space)? (where space)? solution_modifier {
+			def query_type
+				"DESCRIBE"
+			end
+		}
+	end
+	
+	rule construct_query
+		'CONSTRUCT' space construct_template space (dataset_clause space)* (where space) solution_modifier {
+			def query_type
+				"CONSTRUCT"
+			end
+		}
+	end
+	
+	rule where
+		('WHERE' space)? group_graph_pattern
+	end
+	
+	rule construct_template
+		'{' space construct_triples? space '}'
+	end
+	
+	rule construct_triples
+		triples_same_subject space ( '.' construct_triples? )?
+	end
+
+	rule solution_modifier
+		(order_clause space limit_offset_clauses)? / order_clause? / limit_offset_clauses?
+	end
+	
+	rule order_clause
+		'ORDER BY' space series_of_order_conditions
+	end
+	
+	rule offset_clause
+		'OFFSET' space integer
+	end
+
+	rule limit_clause
+		'LIMIT' space integer
+	end
+	
+	rule limit_offset_clauses
+		( limit_clause space (offset_clause? / offset_clause space limit_clause?) )
+	end
+	
+	rule order_condition
+		( ( 'ASC' / 'DESC' ) space bracketted_expression ) / ( constraint / var )
+	end
+	
+	rule constraint
+		bracketted_expression / built_in_call / function_call
+	end
+	
+	rule built_in_call
+		 'STR' space '(' expression ')' 
+		/ 'LANG' space '(' expression ')' 
+		/ 'LANGMATCHES' space '(' expression ',' expression ')' 
+		/ 'DATATYPE' space '(' expression ')' / 'BOUND' space '(' var ')'
+		/ 'sameTerm' '(' expression ',' expression ')'
+		/ 'isIRI' space '(' expression ')'
+		/ 'isURI' space '(' expression ')'
+		/ 'isBLANK' space '(' expression ')'
+		/ 'isLITERAL' space '(' expression ')'
+		/ regex_expression
+	end
+	
+	rule regex_expression
+		'REGEX' space '(' expression ',' expression ( ',' expression )? ')'
+	end
+	
+	rule function_call
+		iriref arg_list
+	end
+	
+	rule dataset_clause
+		'FROM' space ( default_graph_clause / named_graph_clause )
+	end
+	
+	rule default_graph_clause
+		source_selector
+	end
+	
+	rule source_selector
+		iriref
+	end
+	
+	rule named_graph_clause
+	 	'NAMED' space SourceSelector
+	end
+	
+end

data/sparql.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = "sparql"
+  s.version = "0.0.1"
+  s.date = "2008-07-15"
+  s.summary = "SPARQL library for Ruby."
+  s.email = "pius+github@uyiosa.com"
+  s.homepage = "http://github.com/pius/sparql"
+  s.description = "sparql is a Ruby library for parsing SPARQL queries.  Implements the formal grammar of SPARQL as a parsing expression grammar."
+  s.has_rdoc = true
+  s.authors = ['Pius Uzamere']
+  s.files = ["README.markdown", "Rakefile", "sparql.gemspec", "lib/sparql.rb", "lib/sparql/execute_sparql.rb", "lib/sparql/sparql.treetop", "coverage/index.html", "coverage/lib-sparql-execute_sparql_rb.html", "coverage/lib-sparql_rb.html"]
+  s.test_files = ["spec/spec.opts", "spec/spec_helper.rb", "spec/unit/graph_parsing_spec.rb", "spec/unit/graph_parsing_spec.rb", "spec/unit/iri_parsing_spec.rb", "spec/unit/sparql_parsing_spec.rb", "spec/unit/variables_parsing_spec.rb", "spec/unit/primitives_parsing_spec.rb", "spec/unit/prefixed_names_parsing_spec.rb"]
+  #s.rdoc_options = ["--main", "README.txt"]
+  #s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.add_dependency("treetop", [">= 1.2.4"])
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'pathname'
+require 'treetop'
+
+# rule triples_same_subject
+#   var_or_term space property_list_not_empty / triples_node space property_list
+# end
+
+
+class Pathname
+  def /(path)
+    (self + path).expand_path
+  end
+end # class Pathname
+
+spec_dir_path = Pathname(__FILE__).dirname.expand_path
+require spec_dir_path.parent + 'lib/sparql'
+
+
+
+# require fixture resources
+Dir[spec_dir_path + "fixtures/*.rb"].each do |fixture_file|
+  require fixture_file
+end

data/spec/unit/graph_parsing_spec.rb

@@ -0,0 +1,76 @@
+# This file is part of Sparql.rb.
+# 
+# Sparql.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Sparql.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Sparql.rb.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'pathname'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe "GraphParser", '#parse' do
+  
+  before(:all) do
+    @parser = GraphParser.new
+  end
+  
+  it "should recognize a triple block where the predicate is a prefixed name" do
+    some_triple_block = '?x foaf:knows ?y'
+    @parser.parse(some_triple_block).should_not == nil
+    @parser.parse(some_triple_block).triples_same_subject.text_value.should == '?x foaf:knows ?y'
+  end
+  
+  it "should recognize a triple block where the predicate is a variable" do
+    some_triple_block = '?x ?theta ?y'
+    @parser.parse(some_triple_block).should_not == nil
+    @parser.parse(some_triple_block).triples_same_subject.text_value.should == '?x ?theta ?y'
+  end
+  
+  it "should recognize 'triples_same_subject'" do
+    some_triple_block = '?x foaf:knows ?y'
+    triples_same_subject = @parser.parse(some_triple_block).triples_same_subject
+    triples_same_subject.property_list_not_empty.text_value.should == "foaf:knows ?y"
+  end
+  
+  it "should recognize 'triples_same_subject' when the predicate is a variable" do
+    some_triple_block = '?x ?theta ?y'
+    triples_same_subject = @parser.parse(some_triple_block).triples_same_subject
+    triples_same_subject.property_list_not_empty.text_value.should == '?theta ?y'
+  end
+  
+  it "should recognize 'triples_same_subject' when the object is a literal" # do
+  #     some_triple_block = '?x ?theta "foo"'
+  #     triples_same_subject = @parser.parse(some_triple_block).triples_same_subject
+  #     triples_same_subject.property_list_not_empty.text_value.should == '?theta ?y "foo"'
+  #   end
+  
+  it "should recognize a 'group_graph_pattern'" # do
+  #         some_group_graph_pattern = '?v ?p "cat"'
+  #         parsed = @parser.parse(some_group_graph_pattern)
+  #         parsed.should_not == nil
+  #       end
+  
+  it "should recognize a 'graph_pattern_not_triples'" # do
+  #     some_graph_pattern_not_triples = '{ ?v ?p "cat" }'
+  #     parsed = @parser.parse(some_graph_pattern_not_triples)
+  #     parsed.should_not == nil
+  #   end
+  
+  # it "should recognize a basic SELECT query with one variable and one triple pattern" do
+  #   basic_valid_select_query = 'SELECT ?foo WHERE { ?x foaf:knows ?y . }'
+  #   parser = SparqlParser.new
+  #   parser.parse(basic_valid_select_query).well_formed?.should == true
+  #   parser.parse(basic_valid_select_query).prologue.text_value.should == ""
+  #   parser.parse(basic_valid_select_query).query_part.text_value.should == "SELECT ?foo WHERE { ?x foaf:knows ?y . }"
+  #   parser.parse('SELECT ?foo ?bar WHERE { ?x foaf:knows ?y . ?z foaf:name ?y . }').should_not == nil
+  # end
+end

data/spec/unit/iri_parsing_spec.rb

@@ -0,0 +1,46 @@
+# This file is part of Sparql.rb.
+# 
+# Sparql.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Sparql.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Sparql.rb.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'pathname'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe "IriParser", '#parse' do
+  
+  before(:all) do
+    @parser = IriParser.new
+  end
+  
+  it "should be able to recognize an iriref in brackets" do
+    the_iriref = "<http://purl.org/dc/elements/1.1/title>"
+    @parser.parse(the_iriref).should_not == nil
+  end
+  
+  it "should be able to recognize an 'iri_ref'" do
+    the_iri_ref = "<http://xmlns.com/foaf/0.1/>"
+    @parser.parse(the_iri_ref).should_not == nil
+  end
+  
+  # it "should be able to recognize an 'irirefchars'" do
+  #   the_iriref = "<http://xmlns.com/foaf/0.1/>"
+  #   @parser.parse(the_iriref).should_not == nil
+  # end
+  # 
+  # it "should be able to recognize a 'prefixed_name'" do
+  #   the_iriref = "<http://xmlns.com/foaf/0.1/>"
+  #   @parser.parse(the_iriref).should_not == nil
+  # end
+
+end

data/spec/unit/prefixed_names_parsing_spec.rb

@@ -0,0 +1,40 @@
+# This file is part of Sparql.rb.
+# 
+# Sparql.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Sparql.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Sparql.rb.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe "PrefixedNamesParser", '#parse' do
+  
+  before(:all) do
+    @parser = PrefixedNamesParser.new
+  end
+  
+  it "should be able to recognize a common prefixed_name" do
+    the_pn = "foaf:knows"
+    tree = @parser.parse(the_pn)
+    tree.should_not == nil
+    tree.pname_ns.text_value.should == "foaf:"
+    tree.pn_local.text_value.should == "knows"
+  end
+  
+  it "should be able to recognize a prefixed_name whose local name has a leading digit (SPARQL idiosyncrasy)" do
+    the_pn = "foaf:1knows"
+    tree = @parser.parse(the_pn)
+    tree.should_not == nil
+    tree.pname_ns.text_value.should == "foaf:"
+    tree.pn_local.text_value.should == "1knows"
+  end
+end

data/spec/unit/primitives_parsing_spec.rb

@@ -0,0 +1,26 @@
+# This file is part of Sparql.rb.
+# 
+# Sparql.rb is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Sparql.rb is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Sparql.rb.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'pathname'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+describe "PrimitivesParser", '#parse' do
+  
+  before(:all) do
+    @parser = PrimitivesParser.new
+  end
+
+end