tripod 0.3.0 → 0.3.1

data/README.md

@@ -73,7 +73,7 @@ Note: Tripod doesn't supply a database. You need to install one. I recommend [Fu
         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
+        asa = ric.get_related_resource('http://asa', Person) # returns a fully hydrated Person object for asa, without an extra lookup
 
 ## Defining a graph at instantiation-time
 
@@ -88,32 +88,39 @@ Note: Tripod doesn't supply a database. You need to install one. I recommend [Fu
         r.label = "example"
         r.save
 
-        # Note: if you don't supply a graph at any point (i.e. class or instance level), you will get an error when you try to persist the resource.
+        # Note: Tripod assumes you want to store all resources in named graphs.
+        # So if you don't supply a graph at any point (i.e. class or instance level),
+        # 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")
+        r.read_predicate(RDF.type) #=> [RDF::URI.new("http://myresource/type")]
 
 ## Finders and criteria
 
-        Person.all #=> returns a Tripod::Criteria which selets all resources of rdf_type http://person
+        # A Tripod::Criteria object defines a set of constraints for a SPARQL query.
+        # It doesn't actually do anything against the DB until you run resources, first, or count on it.
+        # (from Tripod::CriteriaExecution)
 
-        Resource.all #=> returns all resources in the database (as no rdf_type specified at class level)
+        Person.all #=> returns a Tripod::Criteria object which selects all resources of rdf_type http://person
 
-        Person.all.resources #=> returns all the actual resources for the criteria, as an array
+        Resource.all #=> returns a criteria object to return resources in the database (as no rdf_type specified at class level)
 
-        Person.first #=> returns the first person
+        Person.all.resources #=> returns all the actual resources for the criteria object, as an array
 
-        Person.count  #=> returns the count of all people
+        Person.first #=> returns the first person (by crafting a sparql query under the covers that only returns 1 result)
+
+        Person.count  #=> returns the count of all people (by crafting a count query under the covers that only returns a count)
 
         # note that you need to use ?uri as the variable for the subject.
-        Person.where("?uri <http://name> 'Joe'") #=> returns a Tripod::Criteria
+        Person.where("?uri <http://name> 'Joe'") #=> returns a Tripod::Criteria object
 
 ## Chainable criteria
 
         Person.all.where("?uri <http://name> 'Ric'").where("?uri <http://knows> <http://asa>).first
 
+        Person.where("?uri <http://name> ?name").limit(1).offset(0).order("DESC(?name)")
 
 
 [Full Documentation](http://rubydoc.info/gems/tripod/frames)

data/lib/tripod/criteria.rb

@@ -11,12 +11,13 @@ module Tripod
     # the resource class that this criteria is for.
     attr_accessor :resource_class
 
-    # array of all the where clauses in this criteria
     attr_accessor :where_clauses
-
-    # array of all the extra clauses in this criteria
     attr_accessor :extra_clauses
 
+    attr_accessor :limit_clause
+    attr_accessor :order_clause
+    attr_accessor :offset_clause
+
     def initialize(resource_class)
       self.resource_class = resource_class
       self.where_clauses = []
@@ -46,11 +47,31 @@ module Tripod
     end
 
     # takes a string and adds an extra clause to this criteria.
+    # e.g. my_criteria.extras("LIMIT 10 OFFSET 20").extrass
+    #
     # TODO: make it also take a hash?
     def extras(sparql_snippet)
       extra_clauses << sparql_snippet
       self
     end
 
+    # replaces this criteria's limit clause
+    def limit(the_limit)
+      self.limit_clause = "LIMIT #{the_limit.to_s}"
+      self
+    end
+
+    # replaces this criteria's offset clause
+    def offset(the_offset)
+      self.offset_clause = "OFFSET #{the_offset.to_s}"
+      self
+    end
+
+    # replaces this criteria's order clause
+    def order(param)
+      self.order_clause = "ORDER BY #{param}"
+      self
+    end
+
   end
 end

data/lib/tripod/criteria/execution.rb

@@ -38,10 +38,18 @@ module Tripod
       end
 
       def build_select_query
+
+        # convert the order, limit and offset to extras in the right order
+        extras(order_clause)
+        extras(limit_clause)
+        extras(offset_clause)
+
+        # build the query.
         select_query = "SELECT ?uri ?graph WHERE { GRAPH ?graph { "
         select_query += self.where_clauses.join(" . ")
-        # TODO: Deal with extras.
-        select_query += " } }"
+        select_query += " } } "
+        select_query += self.extra_clauses.join(" ")
+        select_query.strip
       end
 
       # create and hydrate the resources identified in uris_and_graphs.

data/lib/tripod/version.rb

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

data/spec/tripod/criteria_execution_spec.rb

@@ -51,6 +51,15 @@ describe Tripod::Criteria do
         end
       end
     end
+
+    context "with extras" do
+
+      before { resource_criteria.where("[pattern]").extras("LIMIT 10").extras("OFFSET 20") }
+
+      it "should add the extras on the end" do
+        resource_criteria.send(:build_select_query).should == "SELECT ?uri ?graph WHERE { GRAPH ?graph { ?uri ?p ?o . [pattern] } } LIMIT 10 OFFSET 20"
+      end
+    end
   end
 
   describe "#resources" do
@@ -115,4 +124,28 @@ describe Tripod::Criteria do
 
   end
 
+  describe "exeuting a chained criteria" do
+
+    before do
+      john.save!
+      barry.save!
+    end
+
+    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"
+      Tripod::SparqlClient::Query.should_receive(:select).with(sparql).and_call_original
+      chained_criteria.resources
+    end
+
+    it "should return the right resources" do
+      chained_criteria.resources.should == [john]
+    end
+
+    it "should return the right number of resources" do
+      chained_criteria.count.should == 1
+    end
+  end
+
 end

data/spec/tripod/criteria_spec.rb

@@ -62,4 +62,49 @@ describe Tripod::Criteria do
     end
   end
 
+  describe "#limit" do
+    it "calls extras with the right limit clause" do
+      resource_criteria.limit(10)
+      resource_criteria.limit_clause.should == "LIMIT 10"
+    end
+
+    context 'calling it twice' do
+      it 'should overwrite the previous version' do
+         resource_criteria.limit(10)
+         resource_criteria.limit(20)
+         resource_criteria.limit_clause.should == "LIMIT 20"
+      end
+    end
+  end
+
+  describe "#offset" do
+    it "calls extras with the right limit clause" do
+      resource_criteria.offset(10)
+      resource_criteria.offset_clause.should == "OFFSET 10"
+    end
+
+    context 'calling it twice' do
+      it 'should overwrite the previous version' do
+         resource_criteria.offset(10)
+         resource_criteria.offset(30)
+         resource_criteria.offset_clause.should == "OFFSET 30"
+      end
+    end
+  end
+
+  describe "#order" do
+    it "calls extras with the right limit clause" do
+      resource_criteria.order("DESC(?label)")
+      resource_criteria.order_clause.should == "ORDER BY DESC(?label)"
+    end
+
+    context 'calling it twice' do
+      it 'should overwrite the previous version' do
+         resource_criteria.order("DESC(?label)")
+         resource_criteria.order("ASC(?label)")
+         resource_criteria.order_clause.should == "ORDER BY ASC(?label)"
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tripod
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   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: &70158128550280 !ruby/object:Gem::Requirement
+  requirement: &70281327925380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158128550280
+  version_requirements: *70281327925380
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70158128549680 !ruby/object:Gem::Requirement
+  requirement: &70281327924780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70158128549680
+  version_requirements: *70281327924780
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
-  requirement: &70158128549220 !ruby/object:Gem::Requirement
+  requirement: &70281327924320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158128549220
+  version_requirements: *70281327924320
 - !ruby/object:Gem::Dependency
   name: rdf
-  requirement: &70158128548580 !ruby/object:Gem::Requirement
+  requirement: &70281327923680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158128548580
+  version_requirements: *70281327923680
 - !ruby/object:Gem::Dependency
   name: rdf-rdfxml
-  requirement: &70158128548020 !ruby/object:Gem::Requirement
+  requirement: &70281327923100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158128548020
+  version_requirements: *70281327923100
 - !ruby/object:Gem::Dependency
   name: rdf-n3
-  requirement: &70158128547360 !ruby/object:Gem::Requirement
+  requirement: &70281327922480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158128547360
+  version_requirements: *70281327922480
 - !ruby/object:Gem::Dependency
   name: rdf-json
-  requirement: &70158128546600 !ruby/object:Gem::Requirement
+  requirement: &70281327921720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158128546600
+  version_requirements: *70281327921720
 - !ruby/object:Gem::Dependency
   name: json-ld
-  requirement: &70158128545840 !ruby/object:Gem::Requirement
+  requirement: &70281327920960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158128545840
+  version_requirements: *70281327920960
 - !ruby/object:Gem::Dependency
   name: guid
-  requirement: &70158128545340 !ruby/object:Gem::Requirement
+  requirement: &70281327920460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,7 +111,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158128545340
+  version_requirements: *70281327920460
 description: RDF ruby ORM
 email:
 - ric@swirrl.com