tripod 0.3.1 → 0.3.2

data/README.md

@@ -103,9 +103,9 @@ Note: Tripod doesn't supply a database. You need to install one. I recommend [Fu
         # It doesn't actually do anything against the DB until you run resources, first, or count on it.
         # (from Tripod::CriteriaExecution)
 
-        Person.all #=> returns a Tripod::Criteria object which selects all resources of rdf_type http://person
+        Person.all #=> returns a Tripod::Criteria object which selects all resources of rdf_type http://person, in the http://people graph
 
-        Resource.all #=> returns a criteria object to return resources in the database (as no rdf_type specified at class level)
+        Resource.all #=> returns a criteria object to return resources in the database (as no rdf_type or graph_uri specified at class level)
 
         Person.all.resources #=> returns all the actual resources for the criteria object, as an array
 
@@ -116,6 +116,8 @@ Note: Tripod doesn't supply a database. You need to install one. I recommend [Fu
         # note that you need to use ?uri as the variable for the subject.
         Person.where("?uri <http://name> 'Joe'") #=> returns a Tripod::Criteria object
 
+        Resource.graph("http://mygraph") #=> Retruns a criteria object with a graph restriction (note: if graph_uri set on the class, it will default to using this)
+
 ## Chainable criteria
 
         Person.all.where("?uri <http://name> 'Ric'").where("?uri <http://knows> <http://asa>).first

data/lib/tripod/criteria.rb

@@ -17,6 +17,7 @@ module Tripod
     attr_accessor :limit_clause
     attr_accessor :order_clause
     attr_accessor :offset_clause
+    attr_accessor :graph_uri
 
     def initialize(resource_class)
       self.resource_class = resource_class
@@ -28,6 +29,8 @@ module Tripod
       else
         self.where("?uri ?p ?o")
       end
+
+      self.graph_uri = resource_class._GRAPH_URI.to_s if resource_class._GRAPH_URI
     end
 
     # they're equal if they return the same query
@@ -73,5 +76,16 @@ module Tripod
       self
     end
 
+    # Restrict htis query to the graph uri passed in
+    #
+    # @example .graph(RDF::URI.new('http://graphoid')
+    # @example .graph('http://graphoid')
+    #
+    # @param [ Stirng, RDF::URI ] The graph uri
+    #
+    # @return [ Tripod::Criteria ] A criteria object
+    def graph(graph_uri)
+      self.graph_uri = graph_uri.to_s
+    end
   end
 end

data/lib/tripod/criteria/execution.rb

@@ -33,8 +33,8 @@ module Tripod
       private
 
       def resources_from_sparql(sparql)
-        uris_and_graphs = select_uris_and_graphs(sparql)
-        create_and_hydrate_resources(uris_and_graphs)
+        uris_and_graphs = self.resource_class._select_uris_and_graphs(sparql)
+        self.resource_class._create_and_hydrate_resources(uris_and_graphs)
       end
 
       def build_select_query
@@ -44,64 +44,19 @@ module Tripod
         extras(limit_clause)
         extras(offset_clause)
 
-        # build the query.
-        select_query = "SELECT ?uri ?graph WHERE { GRAPH ?graph { "
+        if graph_uri
+          select_query = "SELECT ?uri (<#{graph_uri}> as ?graph) WHERE { GRAPH <#{graph_uri}> "
+        else
+          select_query = "SELECT ?uri ?graph WHERE { GRAPH ?graph "
+        end
+
+        select_query += "{ "
         select_query += self.where_clauses.join(" . ")
         select_query += " } } "
         select_query += self.extra_clauses.join(" ")
         select_query.strip
       end
 
-      # create and hydrate the resources identified in uris_and_graphs.
-      # Note: if any of the graphs are not set, those resources can still be constructed, but not persisted back to DB.
-      def create_and_hydrate_resources(uris_and_graphs)
-
-        graph = self.resource_class.describe_uris(uris_and_graphs.keys) #uses the resource_class on the criteria object
-        repo = self.resource_class.add_data_to_repository(graph)
-
-        resources = []
-
-        uris_and_graphs.each_pair do |u,g|
-
-          # instantiate a new resource
-          r = self.resource_class.new(u,g)
-
-          # make a graph of data for this resource's uri
-          data_graph = RDF::Graph.new
-          repo.query( [RDF::URI.new(u), :predicate, :object] ) do |statement|
-            data_graph << statement
-          end
-
-          # use it to hydrate this resource
-          r.hydrate!(:graph => data_graph)
-          r.new_record = false
-          resources << r
-        end
-
-        resources
-      end
-
-
-      # based on the query passed in, build a hash of uris->graphs
-      # @param [ String] sparql. The sparql query
-      # @param [ Hash ] opts. A hash of options.
-      #
-      # @option options [ String ] uri_variable The name of the uri variable in the query, if not 'uri'
-      # @option options [ String ] graph_variable The name of the uri variable in thh query, if not 'graph'
-      def select_uris_and_graphs(sparql, opts={})
-        select_results = Tripod::SparqlClient::Query.select(sparql)
-
-        uris_and_graphs = {}
-
-        select_results.each do |r|
-          uri_variable = opts[:uri_variable] || 'uri'
-          graph_variable = opts[:graph_variable] || 'graph'
-          uris_and_graphs[ r[uri_variable]["value"] ] = r[graph_variable]["value"]
-        end
-
-        uris_and_graphs
-      end
-
     end
 
   end

data/lib/tripod/finders.rb

@@ -48,6 +48,24 @@ module Tripod::Finders
       resource
     end
 
+    # Find a collection of +Resource+s by a SPARQL select statement which returns their uris.
+    # Under the hood, this only executes two queries: a select, then a describe.
+    #
+    # @example
+    #   Person.find_by_sparql('SELECT ?uri ?graph WHERE { GRAPH ?graph { ?uri ?p ?o } } LIMIT 3')
+    #
+    # @param [ String ] sparql_query. A sparql query which returns a list of uris of the objects.
+    # @param [ Hash ] opts. A hash of options.
+    #
+    # @option options [ String ] uri_variable The name of the uri variable in thh query, if not 'uri'
+    # @option options [ String ] graph_variable The name of the uri variable in thh query, if not 'graph'
+    #
+    # @return [ Array ] An array of hydrated resources of this class's type.
+    def find_by_sparql(sparql_query, opts={})
+      uris_and_graphs = _select_uris_and_graphs(criteria, opts)
+      _create_and_hydrate_resources(uris_and_graphs)
+    end
+
     # execute a where clause on this resource.
     # returns a criteria object
     def where(sparql_snippet)
@@ -91,5 +109,57 @@ module Tripod::Finders
       graph
     end
 
+    # THESE AREN'T INTENDED TO BE PART OF THE PUBLIC API:
+
+    # create and hydrate the resources identified in uris_and_graphs.
+    # Note: if any of the graphs are not set, those resources can still be constructed, but not persisted back to DB.
+    def _create_and_hydrate_resources(uris_and_graphs)
+
+      graph = describe_uris(uris_and_graphs.keys) #uses the resource_class on the criteria object
+      repo = add_data_to_repository(graph)
+
+      resources = []
+
+      uris_and_graphs.each_pair do |u,g|
+
+        # instantiate a new resource
+        r = self.new(u,g)
+
+        # make a graph of data for this resource's uri
+        data_graph = RDF::Graph.new
+        repo.query( [RDF::URI.new(u), :predicate, :object] ) do |statement|
+          data_graph << statement
+        end
+
+        # use it to hydrate this resource
+        r.hydrate!(:graph => data_graph)
+        r.new_record = false
+        resources << r
+      end
+
+      resources
+    end
+
+
+    # based on the query passed in, build a hash of uris->graphs
+    # @param [ String] sparql. The sparql query
+    # @param [ Hash ] opts. A hash of options.
+    #
+    # @option options [ String ] uri_variable The name of the uri variable in the query, if not 'uri'
+    # @option options [ String ] graph_variable The name of the uri variable in thh query, if not 'graph'
+    def _select_uris_and_graphs(sparql, opts={})
+      select_results = Tripod::SparqlClient::Query.select(sparql)
+
+      uris_and_graphs = {}
+
+      select_results.each do |r|
+        uri_variable = opts[:uri_variable] || 'uri'
+        graph_variable = opts[:graph_variable] || 'graph'
+        uris_and_graphs[ r[uri_variable]["value"] ] = r[graph_variable]["value"]
+      end
+
+      uris_and_graphs
+    end
+
   end
 end

data/lib/tripod/sparql_query.rb

@@ -15,9 +15,8 @@ module Tripod
     cattr_accessor :KEYWORDS
     @@KEYWORDS = %w(CONSTRUCT ASK DESCRIBE SELECT)
 
-    def initialize(query_string, parent_query=nil)
+    def initialize(query_string)
       @query = query_string
-      @parent_query = parent_query
 
       if self.has_prefixes?
         @prefixes, @body = self.extract_prefixes
@@ -42,9 +41,14 @@ module Tripod
       return p.strip, b.strip
     end
 
-    def as_count_query_str
+    def check_subqueryable!
       # only allow for selects
       raise SparqlQueryError.new("Can't turn this into a subquery") unless self.query_type == :select
+    end
+
+    def as_count_query_str
+
+      check_subqueryable!
 
       count_query = "SELECT COUNT(*) { #{self.body} }"
       count_query = "#{self.prefixes} #{count_query}" if self.prefixes

data/lib/tripod/version.rb

@@ -1,3 +1,3 @@
 module Tripod
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/spec/tripod/criteria_execution_spec.rb

@@ -11,34 +11,42 @@ describe Tripod::Criteria do
   end
 
   let(:john) do
-    p = Person.new('http://john', 'http://people')
+    p = Person.new('http://john')
     p.name = "John"
     p
   end
 
   let(:barry) do
-    p = Person.new('http://barry', 'http://people')
+    p = Person.new('http://barry')
     p.name = "Barry"
     p
   end
 
   describe "#build_select_query" do
 
-    context "for a class with an rdf_type" do
+    context "for a class with an rdf_type and graph" do
       it "should return a SELECT query based with an rdf type restriction" do
-        person_criteria.send(:build_select_query).should == "SELECT ?uri ?graph WHERE { GRAPH ?graph { ?uri a <http://person> } }"
+        person_criteria.send(:build_select_query).should == "SELECT ?uri (<http://graph> as ?graph) WHERE { GRAPH <http://graph> { ?uri a <http://person> } }"
       end
 
       context "and extra restrictions" do
         before { person_criteria.where("[pattern]") }
 
-        it "should return a SELECT query with the extra restriction and rdf type restriction" do
-          person_criteria.send(:build_select_query).should == "SELECT ?uri ?graph WHERE { GRAPH ?graph { ?uri a <http://person> . [pattern] } }"
+        it "should return a SELECT query with the extra restriction" do
+          person_criteria.send(:build_select_query).should == "SELECT ?uri (<http://graph> as ?graph) WHERE { GRAPH <http://graph> { ?uri a <http://person> . [pattern] } }"
+        end
+      end
+
+      context "with an overriden graph" do
+        before { person_criteria.graph("http://anothergraph") }
+
+         it "should override the graph in the query" do
+          person_criteria.send(:build_select_query).should == "SELECT ?uri (<http://anothergraph> as ?graph) WHERE { GRAPH <http://anothergraph> { ?uri a <http://person> } }"
         end
       end
     end
 
-    context "for a class without an rdf_type" do
+    context "for a class without an rdf_type and graph" do
       it "should return a SELECT query without an rdf_type restriction" do
         resource_criteria.send(:build_select_query).should == "SELECT ?uri ?graph WHERE { GRAPH ?graph { ?uri ?p ?o } }"
       end
@@ -50,6 +58,14 @@ describe Tripod::Criteria do
           resource_criteria.send(:build_select_query).should == "SELECT ?uri ?graph WHERE { GRAPH ?graph { ?uri ?p ?o . [pattern] } }"
         end
       end
+
+      context "with a graph set" do
+        before { resource_criteria.graph("http://graphy") }
+
+         it "should override the graph in the query" do
+          resource_criteria.send(:build_select_query).should == "SELECT ?uri (<http://graphy> as ?graph) WHERE { GRAPH <http://graphy> { ?uri ?p ?o } }"
+        end
+      end
     end
 
     context "with extras" do
@@ -134,7 +150,7 @@ describe Tripod::Criteria do
     let(:chained_criteria) { Person.where("?uri <http://name> ?name").limit(1).offset(0).order("DESC(?name)") }
 
     it "should run the right Sparql" do
-      sparql = "SELECT ?uri ?graph WHERE { GRAPH ?graph { ?uri a <http://person> . ?uri <http://name> ?name } } ORDER BY DESC(?name) LIMIT 1 OFFSET 0"
+      sparql = "SELECT ?uri (<http://graph> as ?graph) WHERE { GRAPH <http://graph> { ?uri a <http://person> . ?uri <http://name> ?name } } ORDER BY DESC(?name) LIMIT 1 OFFSET 0"
       Tripod::SparqlClient::Query.should_receive(:select).with(sparql).and_call_original
       chained_criteria.resources
     end

data/spec/tripod/criteria_spec.rb

@@ -107,4 +107,11 @@ describe Tripod::Criteria do
     end
   end
 
+  describe "#graph" do
+    it "sets the graph_uri for this criteria, as a string" do
+      resource_criteria.graph(RDF::URI("http://foobar"))
+      resource_criteria.graph_uri.should == "http://foobar"
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tripod
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2013-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70281327925380 !ruby/object:Gem::Requirement
+  requirement: &70205083592080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70281327925380
+  version_requirements: *70205083592080
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70281327924780 !ruby/object:Gem::Requirement
+  requirement: &70205083591380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70281327924780
+  version_requirements: *70205083591380
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
-  requirement: &70281327924320 !ruby/object:Gem::Requirement
+  requirement: &70205083590920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70281327924320
+  version_requirements: *70205083590920
 - !ruby/object:Gem::Dependency
   name: rdf
-  requirement: &70281327923680 !ruby/object:Gem::Requirement
+  requirement: &70205083589940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70281327923680
+  version_requirements: *70205083589940
 - !ruby/object:Gem::Dependency
   name: rdf-rdfxml
-  requirement: &70281327923100 !ruby/object:Gem::Requirement
+  requirement: &70205083589120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70281327923100
+  version_requirements: *70205083589120
 - !ruby/object:Gem::Dependency
   name: rdf-n3
-  requirement: &70281327922480 !ruby/object:Gem::Requirement
+  requirement: &70205083588320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70281327922480
+  version_requirements: *70205083588320
 - !ruby/object:Gem::Dependency
   name: rdf-json
-  requirement: &70281327921720 !ruby/object:Gem::Requirement
+  requirement: &70205083587160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70281327921720
+  version_requirements: *70205083587160
 - !ruby/object:Gem::Dependency
   name: json-ld
-  requirement: &70281327920960 !ruby/object:Gem::Requirement
+  requirement: &70205083586480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70281327920960
+  version_requirements: *70205083586480
 - !ruby/object:Gem::Dependency
   name: guid
-  requirement: &70281327920460 !ruby/object:Gem::Requirement
+  requirement: &70205083584700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,7 +111,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70281327920460
+  version_requirements: *70205083584700
 description: RDF ruby ORM
 email:
 - ric@swirrl.com