tripod 0.2.2 → 0.2.3

data/README.md

@@ -6,8 +6,6 @@ ActiveModel-style Ruby ORM for RDF Linked Data. Works with SPARQL 1.1 HTTP endpo
 * Inspired by [Durran Jordan's](https://github.com/durran) [Mongoid](http://mongoid.org/en/mongoid/) ORM for [MongoDB](http://www.mongodb.org/), and [Ben Lavender's](https://github.com/bhuga) RDF ORM, [Spira](https://github.com/ruby-rdf/spira).
 * Uses [Ruby-RDF](https://github.com/ruby-rdf/rdf) to manage the data internally.
 
-__Warning: Some features are still experimental.__
-
 ## Quick start, for using in a rails app.
 
 Note: Tripod doesn't supply a database. You need to install one. I recommend [Fuseki](http://jena.apache.org/documentation/serving_data/index.html), which runs on port 3030 by default.
@@ -34,6 +32,7 @@ Note: Tripod doesn't supply a database. You need to install one. I recommend [Fu
         class Person
           include Tripod::Resource
 
+          # these are the default rdf-type and graph for resources of this class
           rdf_type 'http://person'
           graph_uri 'http://people'
 
@@ -72,6 +71,40 @@ Note: Tripod doesn't supply a database. You need to install one. I recommend [Fu
         ric = Person.find('http://ric')
         # => returns a single Person object.
 
-[Full Documentation](http://rubydoc.info/github/Swirrl/tripod/master/frames)
+## Some Other interesting features
+
+## Eager Loading
+
+        asa = Person.find('http://asa')
+        ric = Person.find('http://ric')
+        ric.knows = asa.uri
+
+        ric.eager_load_predicate_triples! #does a big DESCRIBE statement behind the scenes
+        knows = ric.get_related_resource('http://knows', Resource)
+        knows.label # this won't cause another database lookup
+
+        ric.eager_load_object_triples! #does a big DESCRIBE statement behind the scenes
+        asa = ric.get_related_resource('http://knows', Person) # returns a fully hydrated Person object for asa, without an extra lookup
+
+## Defining a graph at instantiation-time
+
+        class Resource
+          field :label RDF::RDFS.label
+
+          # notice also that you don't need to supply an rdf type or graph here!
+        end
+
+        r = Resource.new('http://foo', 'http://mygraph')
+
+        # if you don't supply a graph at any point, you will get an error when you try to persist the resource.
+
+## Reading and writing arbitrary predicates
+
+        r.write_predicate(RDF.type, 'http://myresource/type')
+        r.read_predicate(RDF.type) # => RDF::URI.new("http://myresource/type")
+
+
+
+[Full Documentation](http://rubydoc.info/gems/tripod/frames)
 
 Copyright (c) 2012 [Swirrl IT Limited](http://swirrl.com). Released under MIT License

data/lib/tripod/eager_loading.rb

@@ -20,7 +20,7 @@ module Tripod::EagerLoading
   def eager_load_object_triples!
     object_uris = []
 
-    self.repository.query( [RDF::URI.new(self.uri), :predicate, :object] ) do |statement|
+    self.get_triples_for_this_resource.each_statement do |statement|
       object_uris << statement.object if statement.object.uri?
     end
 
@@ -39,8 +39,7 @@ module Tripod::EagerLoading
     end
 
     if data_graph.empty?
-      # this means that we've not already looked it up
-      r = class_of_resource_to_create.find(resource_uri)
+      r = nil
     else
       # it's in our eager loaded repo
       r = class_of_resource_to_create.new(resource_uri)

data/lib/tripod/predicates.rb

@@ -8,9 +8,11 @@ module Tripod::Predicates
   # returns a list of predicates (as RDF::URIs) for this resource
   def predicates
     pred_uris = []
-    @repository.statements.each do |s|
-      pred_uris << s.predicate unless pred_uris.include?(s.predicate)
+
+    @repository.query( [@uri, :predicate, :object] ) do |statement|
+      pred_uris << statement.predicate unless pred_uris.include?(statement.predicate)
     end
+
     pred_uris
   end
 
@@ -26,7 +28,7 @@ module Tripod::Predicates
   # @return [ Array ] An array of RDF::Terms.
   def read_predicate(predicate_uri)
     values = []
-    @repository.query( [:subject, RDF::URI.new(predicate_uri.to_s), :object] ) do |statement|
+    @repository.query( [@uri, RDF::URI.new(predicate_uri.to_s), :object] ) do |statement|
       values << statement.object
     end
     values

data/lib/tripod/repository.rb

@@ -28,7 +28,7 @@ module Tripod::Repository
 
     if graph
       graph.each_statement do |statement|
-        # only use statements about this resource!
+        # only use statements about this resource for hydrating
         if statement.subject.to_s == @uri.to_s
           @repository << statement
         end
@@ -46,6 +46,15 @@ module Tripod::Repository
 
   end
 
+  # returns a graph of triples from the underlying repository where this resource's uri is the subject.
+  def get_triples_for_this_resource
+    triples_graph = RDF::Graph.new
+    @repository.query([RDF::URI.new(self.uri), :predicate, :object]) do |stmt|
+      triples_graph << stmt
+    end
+    triples_graph
+  end
+
   module ClassMethods
 
     # for triples in the graph passed in, add them to the passed in repository obj, and return the repository objects

data/lib/tripod/serialization.rb

@@ -6,22 +6,22 @@ module Tripod::Serialization
 
   # Serialises this resource's triples to rdf/xml
   def to_rdf
-    @repository.dump(:rdfxml)
+    get_triples_for_this_resource.dump(:rdfxml)
   end
 
   # Serialises this resource's triples to turtle
   def to_ttl
-    @repository.dump(:n3)
+    get_triples_for_this_resource.dump(:n3)
   end
 
   # Serialises this resource's triples to n-triples
   def to_nt
-    @repository.dump(:ntriples)
+    get_triples_for_this_resource.dump(:ntriples)
   end
 
   # Serialises this resource's triples to JSON-LD
   def to_json(opts={})
-    @repository.dump(:jsonld)
+    get_triples_for_this_resource.dump(:jsonld)
   end
 
 end

data/lib/tripod/version.rb

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

data/spec/tripod/eager_loading_spec.rb

@@ -55,10 +55,20 @@ describe Tripod::EagerLoading do
   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
+
+      context "and related resource exists" do
+        it "should return nil" do
+          res = @john.get_related_resource(@peter.uri, Person)
+          res.should == nil
+        end
+      end
+
+      context "and related resource doesn't exist" do
+
+        it "should return nil" do
+          res = @john.get_related_resource(RDF::URI.new('http://nonexistent/person'), Person)
+          res.should be_nil
+        end
       end
     end
 
@@ -98,6 +108,7 @@ describe Tripod::EagerLoading do
       end
     end
 
+
   end
 
 end

data/spec/tripod/predicates_spec.rb

@@ -23,6 +23,13 @@ describe Tripod::Predicates do
     stmt3.predicate = RDF::URI.new('http://name')
     stmt3.object = "ric"
     @graph << stmt3
+
+    # throw a random other statement (about name) in the mix!
+    stmt4 = RDF::Statement.new
+    stmt4.subject = RDF::URI.new('http://name')
+    stmt4.predicate = RDF::RDFS.label
+    stmt4.object = "name"
+    @graph << stmt4
   end
 
   let(:person) do
@@ -77,6 +84,8 @@ describe Tripod::Predicates do
       person.predicates.length.should == 2
       person.predicates.should == [RDF::URI('http://blog'), RDF::URI('http://name')]
     end
+
+
   end
 
 end

data/spec/tripod/serialization_spec.rb

@@ -3,34 +3,79 @@ require "spec_helper"
 describe Tripod::Serialization do
 
   let(:person) do
+
+    p2 = Person.new('http://fred')
+    p2.name = "fred"
+    p2.save!
+
     p = Person.new('http://garry')
     p.name = 'Garry'
     p.age = 30
+    p.knows = p2.uri
     p
   end
 
-  describe "#to_rdf" do
-    it "should dump the contents of the repository as rdfxml" do
-      person.to_rdf.should == person.repository.dump(:rdfxml)
+  context "where no eager loading has happened" do
+
+    describe "#to_rdf" do
+      it "should dump the contents of the repository as rdfxml" do
+        person.to_rdf.should == person.repository.dump(:rdfxml)
+      end
     end
-  end
 
-  describe "#to_ttl" do
-    it "should dump the contents of the repository with the n3 serializer" do
-      person.to_ttl.should == person.repository.dump(:n3)
+    describe "#to_ttl" do
+      it "should dump the contents of the repository with the n3 serializer" do
+        person.to_ttl.should == person.repository.dump(:n3)
+      end
     end
-  end
 
-  describe "#to_nt" do
-    it "should dump the contents of the repository as ntriples" do
-      person.to_nt.should == person.repository.dump(:ntriples)
+    describe "#to_nt" do
+      it "should dump the contents of the repository as ntriples" do
+        person.to_nt.should == person.repository.dump(:ntriples)
+      end
     end
+
+     describe "#to_json" do
+      it "should dump the contents of the repository as ntriples" do
+        person.to_json.should == person.repository.dump(:jsonld)
+      end
+    end
+
   end
 
-   describe "#to_json" do
-    it "should dump the contents of the repository as ntriples" do
-      person.to_json.should == person.repository.dump(:jsonld)
+  context "where eager loading has happened" do
+
+    before do
+      person.eager_load_predicate_triples!
+      person.eager_load_object_triples!
+    end
+
+    describe "#to_rdf" do
+      it "should dump the triples for this resource only as rdfxml" do
+        person.to_rdf.should == person.get_triples_for_this_resource.dump(:rdfxml)
+      end
+    end
+
+    describe "#to_ttl" do
+      it "should dump the triples for this resource only with the n3 serializer" do
+        person.to_ttl.should == person.get_triples_for_this_resource.dump(:n3)
+      end
+    end
+
+    describe "#to_nt" do
+      it "should dump the triples for this resource only as ntriples" do
+        person.to_nt.should == person.get_triples_for_this_resource.dump(:ntriples)
+      end
     end
+
+     describe "#to_json" do
+      it "should dump the triples for this resource only as ntriples" do
+        person.to_json.should == person.get_triples_for_this_resource.dump(:jsonld)
+      end
+    end
+
+
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tripod
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70274473451860 !ruby/object:Gem::Requirement
+  requirement: &70191292757280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70274473451860
+  version_requirements: *70191292757280
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70274473450860 !ruby/object:Gem::Requirement
+  requirement: &70191292756400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70274473450860
+  version_requirements: *70191292756400
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
-  requirement: &70274473466560 !ruby/object:Gem::Requirement
+  requirement: &70191292771960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70274473466560
+  version_requirements: *70191292771960
 - !ruby/object:Gem::Dependency
   name: rdf
-  requirement: &70274473465400 !ruby/object:Gem::Requirement
+  requirement: &70191292770960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70274473465400
+  version_requirements: *70191292770960
 - !ruby/object:Gem::Dependency
   name: rdf-rdfxml
-  requirement: &70274473464180 !ruby/object:Gem::Requirement
+  requirement: &70191292769560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70274473464180
+  version_requirements: *70191292769560
 - !ruby/object:Gem::Dependency
   name: rdf-n3
-  requirement: &70274473463580 !ruby/object:Gem::Requirement
+  requirement: &70191292768980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70274473463580
+  version_requirements: *70191292768980
 - !ruby/object:Gem::Dependency
   name: rdf-json
-  requirement: &70274473462900 !ruby/object:Gem::Requirement
+  requirement: &70191292768400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70274473462900
+  version_requirements: *70191292768400
 - !ruby/object:Gem::Dependency
   name: json-ld
-  requirement: &70274473462160 !ruby/object:Gem::Requirement
+  requirement: &70191292767540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70274473462160
+  version_requirements: *70191292767540
 - !ruby/object:Gem::Dependency
   name: guid
-  requirement: &70274473461300 !ruby/object:Gem::Requirement
+  requirement: &70191292766780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,7 +111,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70274473461300
+  version_requirements: *70191292766780
 description: RDF ruby ORM
 email:
 - ric@swirrl.com