tripod 0.2.1 → 0.2.2

data/lib/tripod.rb

@@ -68,10 +68,11 @@ require "tripod/sparql_client"
 require "tripod/predicates"
 require "tripod/attributes"
 require "tripod/errors"
+require "tripod/repository"
 require "tripod/fields"
 require "tripod/finders"
 require "tripod/persistence"
-require "tripod/repository"
+require "tripod/eager_loading"
 require "tripod/serialization"
 require "tripod/state"
 require "tripod/version"

data/lib/tripod/components.rb

@@ -19,6 +19,7 @@ module Tripod::Components
   include Tripod::Fields
   include Tripod::Finders
   include Tripod::Repository
+  include Tripod::EagerLoading
   include Tripod::Serialization
   include Tripod::State
 

data/lib/tripod/eager_loading.rb

@@ -0,0 +1,54 @@
+module Tripod::EagerLoading
+
+  extend ActiveSupport::Concern
+
+  # array of resources that represent the predicates of the triples of this resource
+  attr_reader :predicate_resources
+
+  # array of resources that represent the objects of the triples of this resource
+  attr_reader :object_resources
+
+  # get all the triples in the db where the predicate uri is their subject
+  # stick the results in this resource's repo
+  def eager_load_predicate_triples!
+    graph_of_triples = self.class.describe_uris(predicates)
+    self.class.add_data_to_repository(graph_of_triples, self.repository)
+  end
+
+  # get all the triples in the db where the object uri is their subject
+  # stick the results in this resource's repo
+  def eager_load_object_triples!
+    object_uris = []
+
+    self.repository.query( [RDF::URI.new(self.uri), :predicate, :object] ) do |statement|
+      object_uris << statement.object if statement.object.uri?
+    end
+
+    object_uris = object_uris.uniq # in case an object appears > once.
+    graph_of_triples = self.class.describe_uris(object_uris)
+    self.class.add_data_to_repository(graph_of_triples, self.repository)
+  end
+
+  # get the resource that represents a particular uri. If there's triples in our repo where that uri
+  # is the subject, use that to hydrate a resource, otherwise justdo a find against the db.
+  def get_related_resource(resource_uri, class_of_resource_to_create)
+    data_graph = RDF::Graph.new
+
+    self.repository.query( [ RDF::URI.new(resource_uri.to_s), :predicate, :object] ) do |stmt|
+      data_graph << stmt
+    end
+
+    if data_graph.empty?
+      # this means that we've not already looked it up
+      r = class_of_resource_to_create.find(resource_uri)
+    else
+      # it's in our eager loaded repo
+      r = class_of_resource_to_create.new(resource_uri)
+      r.hydrate!(:graph => data_graph)
+      r.new_record = false
+      r
+    end
+    r
+  end
+
+end

data/lib/tripod/errors.rb

@@ -2,4 +2,5 @@
 require 'tripod/errors/field_not_present'
 require 'tripod/errors/resource_not_found'
 require 'tripod/errors/uri_not_set'
+require 'tripod/errors/graph_uri_not_set'
 require 'tripod/errors/validations'

data/lib/tripod/errors/graph_uri_not_set.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+module Tripod::Errors
+
+  # Action attempted on a resource which requires the graph uri to be set.
+  class GraphUriNotSet < StandardError
+
+  end
+
+end

data/lib/tripod/finders.rb

@@ -4,81 +4,6 @@
 module Tripod::Finders
   extend ActiveSupport::Concern
 
-  # FOLLOWING METHODS NOT PART OF THE PUBLIC API:
-  ## private methods
-  def self.included(base)
-
-    class << base
-
-      private
-
-      def select_uris_and_graphs(criteria, opts)
-        select_results = Tripod::SparqlClient::Query.select(criteria)
-
-        # data will contain a map of uris against graphs.
-        data = {}
-
-        select_results.each do |r|
-          uri_variable = opts[:uri_variable] || 'uri'
-          graph_variable = opts[:graph_variable] || 'graph'
-          data[ r[uri_variable]["value"] ] = r[graph_variable]["value"]
-        end
-
-        data
-      end
-
-      def create_and_hydrate_resources(uris_and_graphs, opts={})
-
-        triples_repository = create_resources(uris_and_graphs)
-        resources = hydrate_resources(uris_and_graphs, triples_repository, opts)
-
-      end
-
-      def create_resources(uris_and_graphs)
-
-        triples_repository = RDF::Repository.new()
-
-        if uris_and_graphs.keys.length > 0
-          uris_sparql_str = uris_and_graphs.keys.map{ |u| "<#{u}>" }.join(" ")
-
-          # Do a big describe statement, and read the results into an in-memory repo
-          triples = Tripod::SparqlClient::Query::describe("DESCRIBE #{uris_sparql_str}")
-          RDF::Reader.for(:ntriples).new(triples) do |reader|
-            reader.each_statement do |statement|
-              triples_repository << statement
-            end
-          end
-        end
-
-        triples_repository
-      end
-
-      def hydrate_resources(uris_and_graphs, triples_repository, opts={})
-
-        resources =[]
-
-        uris_and_graphs.each_pair do |u,g|
-          r = self.new(u,g)
-          data_graph = RDF::Graph.new
-          triples_repository.query( [RDF::URI.new(u), :predicate, :object] ) do |statement|
-            data_graph << statement
-          end
-
-          hydrate_opts = {:graph => data_graph}
-          hydrate_opts[:only] = opts[:only_hydrate]
-
-          r.hydrate!(:graph => data_graph)
-          r.new_record = false
-          resources << r
-        end
-
-        resources
-      end
-
-    end
-
-  end
-
   module ClassMethods
 
     # Find a +Resource+ by its uri (and, optionally, by its graph if there are more than one).
@@ -139,7 +64,86 @@ module Tripod::Finders
     # @return [ Array ] An array of hydrated resources of this class's type.
     def where(criteria, opts={})
       uris_and_graphs = select_uris_and_graphs(criteria, opts)
-      create_and_hydrate_resources(uris_and_graphs, opts)
+      create_and_hydrate_resources(uris_and_graphs)
+    end
+
+    # returns a graph of triples which describe the uris passed in.
+    def describe_uris(uris)
+      graph = RDF::Graph.new
+
+      if uris.length > 0
+        uris_sparql_str = uris.map{ |u| "<#{u.to_s}>" }.join(" ")
+
+        # Do a big describe statement, and read the results into an in-memory repo
+        triples_string = Tripod::SparqlClient::Query::describe("DESCRIBE #{uris_sparql_str}")
+
+        RDF::Reader.for(:ntriples).new(triples_string) do |reader|
+          reader.each_statement do |statement|
+            graph << statement
+          end
+        end
+
+      end
+
+      graph
+    end
+
+
+  end
+
+  # FOLLOWING METHODS NOT PART OF THE PUBLIC API:
+  def self.included(base)
+
+    class << base
+
+      private
+
+      # 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)
+        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
+      def select_uris_and_graphs(criteria, opts)
+        select_results = Tripod::SparqlClient::Query.select(criteria)
+
+        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/persistence.rb

@@ -68,6 +68,8 @@ module Tripod::Persistence
   # @return [ true, false ] True is success, false if not.
   def save(opts={})
 
+    raise Tripod::Errors::GraphUriNotSet.new() unless @graph_uri
+
     transaction = Tripod::Persistence::Transaction.get_transcation(opts[:transaction])
 
     if self.valid?

data/lib/tripod/repository.rb

@@ -15,16 +15,11 @@ module Tripod::Repository
   # @example Hydrate the resource from a passed in graph
   #   person.hydrate!(:graph => my_graph)
   #
-  # @example Only hydrate certain predicates (ignored if a graph is passde in)
-  #   person.hydrate!(:only => ["http://foo", "http://bar"])
-  #   person.hydrate!(:only => "http://foo")
-  #
   #
   # @return [ RDF::Repository ] A reference to the repository for this instance.
   def hydrate!(opts = {})
 
     graph = opts[:graph]
-    only_hydrate_predicates = [opts[:only]].flatten # allow
 
     # we require that the uri is set.
     raise Tripod::Errors::UriNotSet.new() unless @uri
@@ -40,15 +35,7 @@ module Tripod::Repository
       end
     else
 
-      unless only_hydrate_predicates && only_hydrate_predicates.any?
-        triples = Tripod::SparqlClient::Query::describe("DESCRIBE <#{uri}>")
-      else
-        query = "CONSTRUCT { <#{uri}> ?p ?o } WHERE { <#{uri}> ?p ?o . FILTER ("
-        query += only_hydrate_predicates.map { |p| "?p = <#{p.to_s}>" }.join(" || ")
-        query += ")}"
-        triples = Tripod::SparqlClient::Query::construct(query)
-      end
-
+    triples = Tripod::SparqlClient::Query::describe("DESCRIBE <#{uri}>")
       @repository = RDF::Repository.new
       RDF::Reader.for(:ntriples).new(triples) do |reader|
         reader.each_statement do |statement|
@@ -59,4 +46,21 @@ module Tripod::Repository
 
   end
 
+  module ClassMethods
+
+    # for triples in the graph passed in, add them to the passed in repository obj, and return the repository objects
+    # if no repository passed, make a new one.
+    def add_data_to_repository(graph, repo=nil)
+
+      repo ||= RDF::Repository.new()
+
+      graph.each_statement do |statement|
+        repo << statement
+      end
+
+      repo
+    end
+
+  end
+
 end

data/lib/tripod/resource.rb

@@ -27,6 +27,7 @@ module Tripod::Resource
   #   Person.new('http://swirrl.com/ric.rdf#me')
   #
   # @param [ String, RDF::URI ] uri The uri of the resource.
+  # @param [ String, RDF::URI ] graph_uri The graph_uri where this resource will be saved to. If ommitted, this resource cannot be persisted.
   #
   # @return [ Resource ] A new +Resource+
   def initialize(uri, graph_uri=nil)
@@ -34,9 +35,7 @@ module Tripod::Resource
     @uri = RDF::URI(uri.to_s)
 
     graph_uri ||= self.class._GRAPH_URI if self.class._GRAPH_URI
-    raise Tripod::Errors::UriNotSet.new('graph_uri missing') unless graph_uri
-    @graph_uri = RDF::URI(graph_uri)
-
+    @graph_uri = RDF::URI(graph_uri) if graph_uri
     @repository = RDF::Repository.new
     @new_record = true
     self.rdf_type = self.class._RDF_TYPE if respond_to?(:rdf_type=)

data/lib/tripod/version.rb

@@ -1,3 +1,3 @@
 module Tripod
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/app/models/resource.rb

@@ -0,0 +1,7 @@
+class Resource
+
+  include Tripod::Resource
+
+  field :label, RDF::RDFS.label
+
+end

data/spec/tripod/eager_loading_spec.rb

@@ -0,0 +1,103 @@
+require "spec_helper"
+
+describe Tripod::EagerLoading do
+
+   before do
+
+    @name = Resource.new('http://name', 'http://names')
+    @name.label = "Name"
+    @name.save!
+
+    @peter = Person.new('http://peter')
+    @peter.name = "Peter"
+    @peter.save!
+
+    @john = Person.new('http://john')
+    @john.name = "john"
+    @john.knows = @peter.uri
+    @john.save!
+  end
+
+  describe "#eager_load_predicate_triples!" do
+
+    before do
+      @peter.eager_load_predicate_triples!
+    end
+
+    it "should add triples to the repository for the predicates" do
+      triples = @peter.repository.query([ RDF::URI.new('http://name'), :predicate, :object] )
+      triples.to_a.length.should_not == 0
+      triples.first.predicate.should == RDF::RDFS.label
+      triples.first.object.to_s.should == "Name"
+    end
+
+  end
+
+  describe "#eager_load_object_triples!" do
+
+    before do
+      @john.eager_load_object_triples!
+    end
+
+    it "should add triples to the repository for the objects" do
+      triples = @john.repository.query([ @peter.uri, :predicate, :object] )
+      triples.to_a.length.should_not == 0
+
+      triples.first.predicate.should == RDF.type
+      triples.first.object.to_s.should == RDF::URI('http://person')
+
+      triples.to_a[1].predicate.should == RDF::URI('http://name')
+      triples.to_a[1].object.to_s.should == "Peter"
+    end
+
+  end
+
+  describe "#get_related_resource" do
+
+    context "when eager load not called" do
+      it "should do a find on the right class to get the right instance of the resource class passed in" do
+        Person.should_receive(:find).with( @peter.uri ).and_call_original
+        res = @john.get_related_resource(@peter.uri, Person)
+        res.should == @peter
+      end
+    end
+
+    context "when eager_load_object_triples has been called" do
+      before do
+        @john.eager_load_object_triples!
+      end
+
+      it "should not call find" do
+        Person.should_not_receive(:find)
+        @john.get_related_resource(@peter.uri, Person)
+      end
+
+      it "should get the right instance of the resource class passed in" do
+        res = @john.get_related_resource(@peter.uri, Person)
+        res.should == @peter
+      end
+    end
+
+    context "when eager_load_predicate_triples has been called" do
+      before do
+        @john.eager_load_predicate_triples!
+      end
+
+      it "should not call find" do
+        Person.should_not_receive(:find)
+        @john.get_related_resource(RDF::URI.new('http://name'), Resource)
+      end
+
+      it "should get the right instance of the resource class passed in" do
+        res = @john.get_related_resource(RDF::URI.new('http://name'), Resource)
+        res.should == @name
+      end
+
+      it "should be possible to call methods on the returned object" do
+        @john.get_related_resource(RDF::URI.new('http://name'), Resource).label.should == @name.label
+      end
+    end
+
+  end
+
+end

data/spec/tripod/persistence_spec.rb

@@ -32,6 +32,14 @@ describe Tripod::Persistence do
 
 
   describe ".save" do
+
+    context "with no graph_uri set" do
+      it 'should raise a GraphUriNotSet error' do
+        p = Resource.new('http://arbitrary/resource')
+        lambda { p.save }.should raise_error(Tripod::Errors::GraphUriNotSet)
+      end
+    end
+
     it 'saves the contents to the db' do
       unsaved_person.save.should be_true
 
@@ -45,6 +53,7 @@ describe Tripod::Persistence do
       repo_statements.first.object.should == RDF::URI.new('http://obj')
     end
 
+
     it 'should leave other people untouched' do
       # save the unsaved person
       unsaved_person.save.should be_true

data/spec/tripod/repository_spec.rb

@@ -33,32 +33,6 @@ describe Tripod::Repository do
           end
 
         end
-
-        context 'single predicate restriction passed' do
-          it 'calls the right CONSTRUCT query' do
-            Tripod::SparqlClient::Query.should_receive(:construct).with("CONSTRUCT { <http://foobar> ?p ?o } WHERE { <http://foobar> ?p ?o . FILTER (?p = <http://pred>)}").and_call_original
-            person.hydrate!(:only => 'http://pred')
-          end
-
-          it 'only populates the right predicates' do
-            person.hydrate!(:only => 'http://pred')
-            person.predicates.length.should ==1
-            person.predicates.should == [RDF::URI('http://pred')]
-          end
-        end
-
-        context 'multiple predicate restrictions passed' do
-          it 'calls the right CONSTRUCT query' do
-            Tripod::SparqlClient::Query.should_receive(:construct).with("CONSTRUCT { <http://foobar> ?p ?o } WHERE { <http://foobar> ?p ?o . FILTER (?p = <http://pred> || ?p = <http://anotherpred>)}").and_call_original
-            person.hydrate!(:only => ['http://pred', 'http://anotherpred'])
-          end
-
-          it 'only populates the right predicates' do
-            person.hydrate!(:only => ['http://pred2', 'http://pred'])
-            person.predicates.length.should == 2
-            person.predicates.should == [RDF::URI('http://pred'), RDF::URI('http://pred2')]
-          end
-        end
       end
 
       context 'graph passed' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tripod
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70338965901200 !ruby/object:Gem::Requirement
+  requirement: &70274473451860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338965901200
+  version_requirements: *70274473451860
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70338965900320 !ruby/object:Gem::Requirement
+  requirement: &70274473450860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70338965900320
+  version_requirements: *70274473450860
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
-  requirement: &70338965915940 !ruby/object:Gem::Requirement
+  requirement: &70274473466560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338965915940
+  version_requirements: *70274473466560
 - !ruby/object:Gem::Dependency
   name: rdf
-  requirement: &70338965914940 !ruby/object:Gem::Requirement
+  requirement: &70274473465400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338965914940
+  version_requirements: *70274473465400
 - !ruby/object:Gem::Dependency
   name: rdf-rdfxml
-  requirement: &70338965913560 !ruby/object:Gem::Requirement
+  requirement: &70274473464180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338965913560
+  version_requirements: *70274473464180
 - !ruby/object:Gem::Dependency
   name: rdf-n3
-  requirement: &70338965912940 !ruby/object:Gem::Requirement
+  requirement: &70274473463580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338965912940
+  version_requirements: *70274473463580
 - !ruby/object:Gem::Dependency
   name: rdf-json
-  requirement: &70338965912360 !ruby/object:Gem::Requirement
+  requirement: &70274473462900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338965912360
+  version_requirements: *70274473462900
 - !ruby/object:Gem::Dependency
   name: json-ld
-  requirement: &70338965911540 !ruby/object:Gem::Requirement
+  requirement: &70274473462160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338965911540
+  version_requirements: *70274473462160
 - !ruby/object:Gem::Dependency
   name: guid
-  requirement: &70338965910800 !ruby/object:Gem::Requirement
+  requirement: &70274473461300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,7 +111,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338965910800
+  version_requirements: *70274473461300
 description: RDF ruby ORM
 email:
 - ric@swirrl.com
@@ -127,8 +127,10 @@ files:
 - lib/tripod.rb
 - lib/tripod/attributes.rb
 - lib/tripod/components.rb
+- lib/tripod/eager_loading.rb
 - lib/tripod/errors.rb
 - lib/tripod/errors/field_not_present.rb
+- lib/tripod/errors/graph_uri_not_set.rb
 - lib/tripod/errors/resource_not_found.rb
 - lib/tripod/errors/uri_not_set.rb
 - lib/tripod/errors/validations.rb
@@ -146,8 +148,10 @@ files:
 - lib/tripod/state.rb
 - lib/tripod/version.rb
 - spec/app/models/person.rb
+- spec/app/models/resource.rb
 - spec/spec_helper.rb
 - spec/tripod/attributes_spec.rb
+- spec/tripod/eager_loading_spec.rb
 - spec/tripod/fields_spec.rb
 - spec/tripod/finders_spec.rb
 - spec/tripod/persistence_spec.rb
@@ -183,8 +187,10 @@ specification_version: 3
 summary: Active Model style RDF ORM
 test_files:
 - spec/app/models/person.rb
+- spec/app/models/resource.rb
 - spec/spec_helper.rb
 - spec/tripod/attributes_spec.rb
+- spec/tripod/eager_loading_spec.rb
 - spec/tripod/fields_spec.rb
 - spec/tripod/finders_spec.rb
 - spec/tripod/persistence_spec.rb