sparql 0.0.1 → 0.0.2

data/lib/sparql/results.rb

@@ -0,0 +1,220 @@
+module SPARQL
+  # Generate SPARQL Results as Boolean, XML or JSON
+  #
+  # This module is a mixin for RDF::Query::Solutions
+  module Results
+    MIME_TYPES = {
+      :json => 'application/sparql-results+json',
+      :html => 'text/html',
+      :xml  => 'application/sparql-results+xml',
+    }
+    
+    ##
+    # Generate Solutions as JSON
+    # @return [String]
+    # @see http://www.w3.org/TR/rdf-sparql-json-res/
+    def to_json
+      require 'json' unless defined?(::JSON)
+      
+      bindings = self.map do |solution|
+        variable_names.map do |n|
+          case s = solution[n]
+          when RDF::URI
+            {n => {:type => "uri", :value => s.to_s }}
+          when RDF::Node
+            {n => {:type => "bnode", :value => s.id }}
+          when RDF::Literal
+            if s.datatype?
+              {n => {:type => "literal", :datatype => s.datatype.to_s, :value => s.to_s }}
+            elsif s.language
+              {n => {:type => "literal", "xml:lang" => s.language.to_s, :value => s.to_s }}
+            else
+              {n => {:type => "literal", :value => s.to_s }}
+            end
+          end
+        end.compact
+      end.flatten
+
+      {
+        :head     => { :vars => variable_names },
+        :results  => { :bindings => bindings}
+      }.to_json
+    end
+    
+    ##
+    # Generate Solutions as XML
+    # @return [String]
+    # @see http://www.w3.org/TR/rdf-sparql-XMLres/
+    def to_xml
+      require 'builder' unless defined?(::Builder)
+      
+      xml = ::Builder::XmlMarkup.new(:indent => 2)
+      xml.instruct!
+      xml.sparql(:xmlns => "http://www.w3.org/2005/sparql-results#") do
+        xml.head do
+          variable_names.each do |n|
+            xml.variable(:name => n)
+          end
+        end
+        xml.results do
+          self.each do |solution|
+            xml.result do
+              variable_names.each do |n|
+                s = solution[n]
+                next unless s
+                xml.binding(:name => n) do
+                  case s
+                  when RDF::URI
+                    xml.uri(s.to_s)
+                  when RDF::Node
+                    xml.bnode(s.id)
+                  when RDF::Literal
+                    if s.datatype?
+                      xml.literal(s.to_s, "datatype" => s.datatype.to_s)
+                    elsif s.language
+                      xml.literal(s.to_s, "xml:lang" => s.language.to_s)
+                    else
+                      xml.literal(s.to_s)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+    
+    ##
+    # Generate Solutions as HTML
+    # @return [String]
+    # @see http://www.w3.org/TR/rdf-sparql-XMLres/
+    def to_html
+      require 'builder' unless defined?(::Builder)
+      
+      xml = ::Builder::XmlMarkup.new(:indent => 2)
+      xml.table(:class => "sparql") do
+        xml.tbody do
+          xml.tr do
+            variable_names.each do |n|
+              xml.th(n.to_s)
+            end
+          end
+          self.each do |solution|
+            xml.tr do
+              variable_names.each do |n|
+                xml.td(RDF::NTriples.serialize(solution[n]))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+  
+  ##
+  # Serialize solutions using the determined format
+  #
+  # @param [RDF::Query::Solutions, RDF::Queryable, Boolean] solutions
+  #   Solutions as either a solution set, a Queryable object (such as a graph) or a Boolean value
+  # @param [Hash{Symbol => Object}] options
+  # @option options [:format]
+  #   Format of results, one of :html, :json or :xml.
+  #   May also be an RDF::Writer format to serialize DESCRIBE or CONSTRUCT results
+  # @option options [:content_type]
+  #   Format of results, one of 'application/sparql-results+json' or 'application/sparql-results+xml'
+  #   May also be an RDF::Writer content_type to serialize DESCRIBE or CONSTRUCT results
+  # @return [String]
+  #   String with serialized results and #content_type
+  def serialize_results(solutions, options = {})
+    format = options[:format]
+    content_type = options[:content_type]
+    format ||= RDF::Query::Solutions::MIME_TYPES.invert[content_type] if content_type
+
+    serialization = case solutions
+    when TrueClass, FalseClass
+      case format ||= :xml
+      when :json
+        require 'json' unless defined?(::JSON)
+        {:boolean => solutions}.to_json
+      when :xml
+        require 'builder' unless defined?(::Builder)
+        xml = ::Builder::XmlMarkup.new(:indent => 2)
+        xml.instruct!
+        xml.sparql(:xmlns => "http://www.w3.org/2005/sparql-results#") do
+          xml.boolean(solutions.to_s)
+        end
+      when :html
+        require 'builder' unless defined?(::Builder)
+        content_type = "text/html"
+        xml = ::Builder::XmlMarkup.new(:indent => 2)
+        xml.div(solutions.to_s, :class => "sparql")
+      end
+    when RDF::Queryable
+      fmt = RDF::Format.for(format ? format.to_sym : {:content_type => content_type})
+      fmt ||= RDF::NTriples::Format
+      format ||= fmt.to_sym
+      content_type ||= fmt.content_types.first
+      fmt.writer.buffer << solutions
+    when RDF::Query::Solutions
+      case format ||= :xml
+      when :json  then solutions.to_json
+      when :xml   then solutions.to_xml
+      when :html  then solutions.to_html
+      end
+    end
+
+    content_type ||= RDF::Query::Solutions::MIME_TYPES[format] if format
+    
+    serialization.instance_variable_set(:"@content_type", content_type)
+    def serialization.content_type; @content_type; end
+    
+    serialization
+  end
+  module_function :serialize_results
+
+  ERROR_MESSAGE = %q(<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <title>SPARQL Processing Service: %s</title>
+  </head>
+  <body>
+    <p>%s: %s</p>
+  </body>
+</html>
+).freeze
+  
+  ##
+  # Serialize error results
+  #
+  # Returns appropriate content based upon an execution exception
+  # @param [Exception] exception
+  # @param [Hash{Symbol => Object}] options
+  # @option options [:format]
+  #   Format of results, one of :html, :json or :xml.
+  #   May also be an RDF::Writer format to serialize DESCRIBE or CONSTRUCT results
+  # @option options [:content_type]
+  #   Format of results, one of 'application/sparql-results+json' or 'application/sparql-results+xml'
+  #   May also be an RDF::Writer content_type to serialize DESCRIBE or CONSTRUCT results
+  # @return [String]
+  #   String with serialized results and #content_type
+  def serialize_exception(exception, options = {})
+    format = options[:format]
+    content_type = options[:content_type]
+    content_type ||= RDF::Query::Solutions::MIME_TYPES[format]
+    serialization = case content_type
+    when 'text/html'
+      title = exception.respond_to?(:title) ? exception.title : exception.class.to_s
+      ERROR_MESSAGE % [title, title, exception.message]
+    else
+      content_type = "text/plain"
+      exception.message
+    end
+    
+    serialization.instance_variable_set(:"@content_type", content_type)
+    def serialization.content_type; @content_type; end
+
+    serialization
+  end
+  module_function :serialize_exception
+end

data/lib/sparql/version.rb

@@ -0,0 +1,20 @@
+module SPARQL
+  module VERSION
+    VERSION_FILE = File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "VERSION")
+    MAJOR, MINOR, TINY, EXTRA = File.read(VERSION_FILE).chop.split(".")
+
+    STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.')
+
+    ##
+    # @return [String]
+    def self.to_s() STRING end
+
+    ##
+    # @return [String]
+    def self.to_str() STRING end
+
+    ##
+    # @return [Array(Integer, Integer, Integer)]
+    def self.to_a() [MAJOR, MINOR, TINY] end
+  end
+end

metadata

@@ -1,80 +1,250 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sparql
-version: !ruby/object:Gem::Version 
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
+- Gregg Kellogg
+- Arto Bendiken
+- Ben Levendar
 - Pius Uzamere
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2008-07-15 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: treetop
+date: 2011-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdf
+  requirement: &2156022280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.4
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.4
-    version: 
-description: sparql is a Ruby library for parsing SPARQL queries.  Implements the formal grammar of SPARQL as a parsing expression grammar.
-email: pius+github@uyiosa.com
-executables: []
-
+  prerelease: false
+  version_requirements: *2156022280
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &2156020980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156020980
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2156018920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156018920
+- !ruby/object:Gem::Dependency
+  name: sxp
+  requirement: &2156017400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.14
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156017400
+- !ruby/object:Gem::Dependency
+  name: sparql-client
+  requirement: &2156015680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156015680
+- !ruby/object:Gem::Dependency
+  name: rdf-xsd
+  requirement: &2156014600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156014600
+- !ruby/object:Gem::Dependency
+  name: linkeddata
+  requirement: &2156013760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :development
+  prerelease: false
+  version_requirements: *2156013760
+- !ruby/object:Gem::Dependency
+  name: open-uri-cached
+  requirement: &2156011940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :development
+  prerelease: false
+  version_requirements: *2156011940
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2156010340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :development
+  prerelease: false
+  version_requirements: *2156010340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156009140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156009140
+- !ruby/object:Gem::Dependency
+  name: spira
+  requirement: &2156007540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.12
+  type: :development
+  prerelease: false
+  version_requirements: *2156007540
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2156005820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156005820
+description: ! "\n    Implements SPARQL grammar parsing to SPARQL Algebra, SPARQL
+  Algebra processing\n    and includes SPARQL Client for accessing remote repositories."
+email: public-rdf-ruby@w3.org
+executables:
+- sparql
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- AUTHORS
+- CREDITS
 - README.markdown
-- Rakefile
-- sparql.gemspec
+- UNLICENSE
+- VERSION
+- bin/sparql
+- lib/sparql/algebra/evaluatable.rb
+- lib/sparql/algebra/expression.rb
+- lib/sparql/algebra/extensions.rb
+- lib/sparql/algebra/operator/add.rb
+- lib/sparql/algebra/operator/and.rb
+- lib/sparql/algebra/operator/asc.rb
+- lib/sparql/algebra/operator/ask.rb
+- lib/sparql/algebra/operator/base.rb
+- lib/sparql/algebra/operator/bgp.rb
+- lib/sparql/algebra/operator/bound.rb
+- lib/sparql/algebra/operator/compare.rb
+- lib/sparql/algebra/operator/construct.rb
+- lib/sparql/algebra/operator/dataset.rb
+- lib/sparql/algebra/operator/datatype.rb
+- lib/sparql/algebra/operator/desc.rb
+- lib/sparql/algebra/operator/describe.rb
+- lib/sparql/algebra/operator/distinct.rb
+- lib/sparql/algebra/operator/divide.rb
+- lib/sparql/algebra/operator/equal.rb
+- lib/sparql/algebra/operator/exprlist.rb
+- lib/sparql/algebra/operator/filter.rb
+- lib/sparql/algebra/operator/graph.rb
+- lib/sparql/algebra/operator/greater_than.rb
+- lib/sparql/algebra/operator/greater_than_or_equal.rb
+- lib/sparql/algebra/operator/is_blank.rb
+- lib/sparql/algebra/operator/is_iri.rb
+- lib/sparql/algebra/operator/is_literal.rb
+- lib/sparql/algebra/operator/join.rb
+- lib/sparql/algebra/operator/lang.rb
+- lib/sparql/algebra/operator/lang_matches.rb
+- lib/sparql/algebra/operator/left_join.rb
+- lib/sparql/algebra/operator/less_than.rb
+- lib/sparql/algebra/operator/less_than_or_equal.rb
+- lib/sparql/algebra/operator/minus.rb
+- lib/sparql/algebra/operator/multiply.rb
+- lib/sparql/algebra/operator/not.rb
+- lib/sparql/algebra/operator/not_equal.rb
+- lib/sparql/algebra/operator/or.rb
+- lib/sparql/algebra/operator/order.rb
+- lib/sparql/algebra/operator/plus.rb
+- lib/sparql/algebra/operator/prefix.rb
+- lib/sparql/algebra/operator/project.rb
+- lib/sparql/algebra/operator/reduced.rb
+- lib/sparql/algebra/operator/regex.rb
+- lib/sparql/algebra/operator/same_term.rb
+- lib/sparql/algebra/operator/slice.rb
+- lib/sparql/algebra/operator/str.rb
+- lib/sparql/algebra/operator/subtract.rb
+- lib/sparql/algebra/operator/union.rb
+- lib/sparql/algebra/operator.rb
+- lib/sparql/algebra/query.rb
+- lib/sparql/algebra/sxp_extensions.rb
+- lib/sparql/algebra/version.rb
+- lib/sparql/algebra.rb
+- lib/sparql/extensions.rb
+- lib/sparql/grammar/lexer.rb
+- lib/sparql/grammar/parser/meta.rb
+- lib/sparql/grammar/parser.rb
+- lib/sparql/grammar.rb
+- lib/sparql/results.rb
+- lib/sparql/version.rb
 - 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
-has_rdoc: true
-homepage: http://github.com/pius/sparql
-licenses: []
-
+homepage: http://sparql.rubyforge.org/
+licenses:
+- Public Domain
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.5
+rubyforge_project: sparql
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: SPARQL library for Ruby.
-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
+test_files: []