tripod 0.6.1 → 0.7.1

data/lib/tripod.rb

@@ -84,6 +84,7 @@ require "tripod/resource_collection"
 
 require "tripod/predicates"
 require "tripod/attributes"
+require "tripod/callbacks"
 require "tripod/errors"
 require "tripod/repository"
 require "tripod/fields"

data/lib/tripod/attributes.rb

@@ -24,6 +24,7 @@ module Tripod::Attributes
     raise Tripod::Errors::FieldNotPresent.new unless field
 
     attr_values = read_predicate(field.predicate)
+    attr_values.map! { |v| read_value_for_field(v, field) }
 
     # If the field is multivalued, return an array of the results
     # If it's not multivalued, return the first (should be only) result.
@@ -56,16 +57,38 @@ module Tripod::Attributes
       if field.multivalued
         new_val = []
         value.each do |v|
-          new_val << self.class.new_value_for_field(v, field)
+          new_val << write_value_for_field(v, field)
         end
       else
-        new_val = self.class.new_value_for_field(value.first, field)
+        new_val = write_value_for_field(value.first, field)
       end
     else
-      new_val = self.class.new_value_for_field(value, field)
+      new_val = write_value_for_field(value, field)
     end
 
     write_predicate(field.predicate, new_val)
   end
   alias :[]= :write_attribute
+
+  private
+
+  def read_value_for_field(value, field)
+    if field.is_uri?
+      value
+    else
+      value.object
+    end
+  end
+
+  def write_value_for_field(value, field)
+    return unless value
+
+    if field.is_uri?
+      RDF::URI.new(value.to_s)
+    elsif field.datatype
+      RDF::Literal.new(value, :datatype => field.datatype)
+    else
+      value
+    end
+  end
 end

data/lib/tripod/callbacks.rb

@@ -0,0 +1,8 @@
+module Tripod::Callbacks
+  extend ActiveSupport::Concern
+
+  included do
+    extend ActiveModel::Callbacks
+    define_model_callbacks :initialize, :save, :destroy
+  end
+end

data/lib/tripod/components.rb

@@ -15,6 +15,7 @@ module Tripod::Components
 
   include Tripod::Predicates
   include Tripod::Attributes
+  include Tripod::Callbacks
   include Tripod::Persistence
   include Tripod::Fields
   include Tripod::Finders

data/lib/tripod/criteria/execution.rb

@@ -8,23 +8,28 @@ module Tripod
 
     # Execute the query and return a +ResourceCollection+ of all hydrated resources
     # +ResourceCollection+ is an +Enumerable+, Array-like object.
-    def resources
+    # options:
+      #  :return_graph (default true) # indicates whether to return the graph as one of the variables.
+    def resources(opts={})
       Tripod::ResourceCollection.new(
-        resources_from_sparql(build_select_query)
+        resources_from_sparql(build_select_query(opts))
       )
     end
 
     # Execute the query and return the first result as a hydrated resource
-
-    def first
-      sq = Tripod::SparqlQuery.new(build_select_query)
+    # options:
+    #  :return_graph (default true) # indicates whether to return the graph as one of the variables.
+    def first(opts={})
+      sq = Tripod::SparqlQuery.new(build_select_query(opts))
       first_sparql = sq.as_first_query_str
       resources_from_sparql(first_sparql).first
     end
 
     # Return how many records the current criteria would return
-    def count
-      sq = Tripod::SparqlQuery.new(build_select_query)
+    # options:
+    #  :return_graph (default true) # indicates whether to return the graph as one of the variables.
+    def count(opts={})
+      sq = Tripod::SparqlQuery.new(build_select_query(opts))
       count_sparql = sq.as_count_query_str
       result = Tripod::SparqlClient::Query.select(count_sparql)
       result[0]["c"]["value"].to_i
@@ -41,17 +46,30 @@ module Tripod
         self.resource_class._create_and_hydrate_resources(uris_and_graphs)
       end
 
-      def build_select_query
+      # options:
+      #  :return_graph (default true) # indicates whether to return the graph as one of the variables.
+      def build_select_query(opts={})
+
+        return_graph = opts.has_key?(:return_graph) ? opts[:return_graph] : true
+
+        select_query = "SELECT DISTINCT ?uri "
 
-        if graph_uri
-          select_query = "SELECT DISTINCT ?uri (<#{graph_uri}> as ?graph) WHERE { GRAPH <#{graph_uri}> "
+        if return_graph
+          # if we are returing the graph, select it as a variable, and include either the <graph> or ?graph in the where clause
+          if graph_uri
+            select_query += "(<#{graph_uri}> as ?graph) WHERE { GRAPH <#{graph_uri}> { "
+          else
+            select_query += "?graph WHERE { GRAPH ?graph { "
+          end
         else
-          select_query = "SELECT DISTINCT ?uri ?graph WHERE { GRAPH ?graph "
+          select_query += "WHERE { "
+          # if we're not returning the graph, only restrict by the <graph> if there's one set at class level
+          select_query += "GRAPH <#{graph_uri}> { " if graph_uri
         end
 
-        select_query += "{ "
         select_query += self.where_clauses.join(" . ")
-        select_query += " } } "
+        select_query += " } "
+        select_query += "} " if return_graph || graph_uri # close the graph clause
         select_query += self.extra_clauses.join(" ")
 
         select_query += [order_clause, limit_clause, offset_clause].join(" ")

data/lib/tripod/fields.rb

@@ -32,18 +32,6 @@ module Tripod::Fields
       add_field(name, predicate, options)
     end
 
-
-    def new_value_for_field(value, field)
-      return unless value
-      if field.is_uri?
-        RDF::URI.new(value.to_s)
-      elsif field.datatype
-        RDF::Literal.new(value, :datatype => field.datatype)
-      else
-        value
-      end
-    end
-
     protected
 
     # Define a field attribute for the +Resource+.

data/lib/tripod/finders.rb

@@ -154,7 +154,8 @@ module Tripod::Finders
       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"]
+        graph_value = r[graph_variable]["value"] if r[graph_variable]
+        uris_and_graphs[ r[uri_variable]["value"] ] = graph_value || nil
       end
 
       uris_and_graphs

data/lib/tripod/persistence.rb

@@ -4,11 +4,6 @@
 module Tripod::Persistence
   extend ActiveSupport::Concern
 
-  included do
-    extend ActiveModel::Callbacks
-    define_model_callbacks :save, :destroy
-  end
-
   class Tripod::Persistence::Transaction
 
     def initialize

data/lib/tripod/resource.rb

@@ -33,12 +33,14 @@ module Tripod::Resource
   def initialize(uri, graph_uri=nil)
     raise Tripod::Errors::UriNotSet.new('uri missing') unless uri
     @uri = RDF::URI(uri.to_s)
-
-    graph_uri ||= self.class._GRAPH_URI if self.class._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=) && self.class._RDF_TYPE
+
+    run_callbacks :initialize do
+      graph_uri ||= self.class._GRAPH_URI if self.class._GRAPH_URI
+      @graph_uri = RDF::URI(graph_uri) if graph_uri
+      self.rdf_type = self.class._RDF_TYPE if respond_to?(:rdf_type=) && self.class._RDF_TYPE
+    end
   end
 
   # default comparison is via the uri
@@ -96,7 +98,7 @@ module Tripod::Resource
     # and sets a class level _RDF_TYPE variable with the rdf_type passed in.
     def rdf_type(new_rdf_type)
       self._RDF_TYPE = RDF::URI.new(new_rdf_type.to_s)
-      field :rdf_type, RDF.type, :multivalued => true # things can have more than 1 type and often do
+      field :rdf_type, RDF.type, :multivalued => true, :is_uri => true # things can have more than 1 type and often do
     end
 
     def graph_uri(new_graph_uri)

data/lib/tripod/sparql_client.rb

@@ -30,7 +30,7 @@ module Tripod::SparqlClient
         end
 
         response = Tripod::Streaming.get_data(request_url, streaming_opts)
-        Rails.logger.debug "TRIPOD: response: #{response}" if defined?(Rails)
+       # Rails.logger.debug "TRIPOD: response: #{response}" if defined?(Rails)
         response
       }
 

data/lib/tripod/version.rb

@@ -1,3 +1,3 @@
 module Tripod
-  VERSION = "0.6.1"
+  VERSION = "0.7.1"
 end

data/spec/app/models/person.rb

@@ -7,7 +7,7 @@ class Person
 
   field :name, 'http://example.com/name'
   field :father, 'http://example.com/father', :is_uri => true
-  field :knows, 'http://example.com/knows', :multivalued => true
+  field :knows, 'http://example.com/knows', :multivalued => true, :is_uri => true
   field :aliases, 'http://exmample.com/alias', :multivalued => true
   field :age, 'http://example.com/age', :datatype => RDF::XSD.integer
   field :important_dates, 'http://example.com/importantdates', :datatype => RDF::XSD.date, :multivalued => true

data/spec/tripod/attributes_spec.rb

@@ -17,8 +17,8 @@ describe Tripod::Attributes do
     end
 
     context "for a literal" do
-      it "should return an RDF::Literal" do
-        person[:name].class.should == RDF::Literal
+      it "should return the native type" do
+        person[:name].class.should == String
       end
       it "should read the given attribute" do
         person[:name].should == 'Barry'
@@ -48,32 +48,23 @@ describe Tripod::Attributes do
     context "where field is given and single-valued" do
       let(:field) { Person.send(:field_for, :hat_type, 'http://example.com/hat', {}) }
       before do
-        person.stub(:read_predicate).with('http://example.com/hat').and_return(['fez'])
+        person.stub(:read_predicate).with('http://example.com/hat').and_return([RDF::Literal.new('fez')])
       end
 
       it "should use the predicate name from the given field" do
-        person.should_receive(:read_predicate).with('http://example.com/hat').and_return(['fez'])
+        person.should_receive(:read_predicate).with('http://example.com/hat').and_return([RDF::Literal.new('fez')])
         person.read_attribute(:hat_type, field)
       end
 
       it "should return a single value" do
         person.read_attribute(:hat_type, field).should == 'fez'
       end
-
-      context "and the value is a URI" do
-        let(:field) { Person.send(:field_for, :hat_type, 'http://example.com/hat', {is_uri: true}) }
-        before do
-          person.stub(:read_predicate).with('http://example.com/hat').and_return(['fez'])
-        end
-
-
-      end
     end
 
     context "where field is given and is multi-valued" do
       let(:field) { Person.send(:field_for, :hat_types, 'http://example.com/hat', {multivalued: true}) }
       before do
-        person.stub(:read_predicate).with('http://example.com/hat').and_return(['fez', 'bowler'])
+        person.stub(:read_predicate).with('http://example.com/hat').and_return([RDF::Literal.new('fez'), RDF::Literal.new('bowler')])
       end
 
       it "should return an array of values" do

data/spec/tripod/criteria_execution_spec.rb

@@ -31,6 +31,12 @@ describe Tripod::Criteria do
         person_criteria.send(:build_select_query).should == "SELECT DISTINCT ?uri (<http://example.com/graph> as ?graph) WHERE { GRAPH <http://example.com/graph> { ?uri a <http://example.com/person> . ?uri ?p ?o } }"
       end
 
+      context "with include_graph option set to false" do
+        it "should not select graphs, but restrict to graph" do
+          person_criteria.send(:build_select_query, :return_graph => false).should == "SELECT DISTINCT ?uri WHERE { GRAPH <http://example.com/graph> { ?uri a <http://example.com/person> . ?uri ?p ?o } }"
+        end
+      end
+
       context "and extra restrictions" do
         before { person_criteria.where("[pattern]") }
 
@@ -53,6 +59,12 @@ describe Tripod::Criteria do
         resource_criteria.send(:build_select_query).should == "SELECT DISTINCT ?uri ?graph WHERE { GRAPH ?graph { ?uri ?p ?o } }"
       end
 
+      context "with include_graph option set to false" do
+        it "should not select graphs or restrict to graph" do
+          resource_criteria.send(:build_select_query, :return_graph => false).should ==  "SELECT DISTINCT ?uri WHERE { ?uri ?p ?o }"
+        end
+      end
+
       context "and extra restrictions" do
         before { resource_criteria.where("[pattern]") }
 
@@ -82,7 +94,12 @@ describe Tripod::Criteria do
 
   describe "#resources" do
 
-
+    context "with options passed" do
+      it "should pass the options to build_select_query" do
+        person_criteria.should_receive(:build_select_query).with(:return_graph => false).and_call_original
+        person_criteria.resources(:return_graph => false)
+      end
+    end
 
     context "with no extra restrictions" do
       it "should return a set of hydrated objects for the type" do
@@ -91,18 +108,40 @@ describe Tripod::Criteria do
     end
 
     context "with extra restrictions" do
-
       before { person_criteria.where("?uri <http://example.com/name> 'John'") }
 
       it "should return a set of hydrated objects for the type and restrictions" do
-         person_criteria.resources.to_a.should == [john]
+        person_criteria.resources.to_a.should == [john]
+      end
+    end
+
+    context "with return_graph option set to false" do
+
+      context "where the class has a graph_uri set" do
+        it "should set the graph_uri on the hydrated objects" do
+          person_criteria.resources(:return_graph => false).first.graph_uri.should_not be_nil
+        end
+      end
+
+      context "where the class does not have a graph_uri set" do
+        it "should not set the graph_uri on the hydrated objects" do
+          resource_criteria.resources(:return_graph => false).first.graph_uri.should be_nil
+        end
       end
+
     end
 
   end
 
   describe "#first" do
 
+    context "with options passed" do
+      it "should pass the options to build_select_query" do
+        person_criteria.should_receive(:build_select_query).with(:return_graph => false).and_call_original
+        person_criteria.first(:return_graph => false)
+      end
+    end
+
     it "should return the first resource for the criteria" do
       person_criteria.first.should == john
     end
@@ -112,10 +151,33 @@ describe Tripod::Criteria do
       Tripod::SparqlClient::Query.should_receive(:select).with(sparql).and_call_original
       person_criteria.first
     end
+
+    context "with return_graph option set to false" do
+
+      context "where the class has a graph_uri set" do
+        it "should set the graph_uri on the hydrated object" do
+          person_criteria.first(:return_graph => false).graph_uri.should_not be_nil
+        end
+      end
+
+      context "where the class does not have a graph_uri set" do
+        it "should not set the graph_uri on the hydrated object" do
+          resource_criteria.first(:return_graph => false).graph_uri.should be_nil
+        end
+      end
+
+    end
   end
 
   describe "#count" do
 
+    context "with options passed" do
+      it "should pass the options to build_select_query" do
+        person_criteria.should_receive(:build_select_query).with(:return_graph => false).and_call_original
+        person_criteria.count(:return_graph => false)
+      end
+    end
+
     it "should return a set of hydrated objects for the criteria" do
       person_criteria.count.should == 2
       person_criteria.where("?uri <http://example.com/name> 'John'").count.should ==1

data/spec/tripod/resource_spec.rb

@@ -23,7 +23,7 @@ describe Tripod::Resource do
 
       context "with rdf_type specified at class level" do
         it "sets the rdf type from the class" do
-          person.rdf_type.should == ['http://example.com/person']
+          person.rdf_type.should == [RDF::URI.new('http://example.com/person')]
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tripod
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70363921370680 !ruby/object:Gem::Requirement
+  requirement: &70200922668480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70363921370680
+  version_requirements: *70200922668480
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70363921385640 !ruby/object:Gem::Requirement
+  requirement: &70200922664960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70363921385640
+  version_requirements: *70200922664960
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
-  requirement: &70363921384140 !ruby/object:Gem::Requirement
+  requirement: &70200922663180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70363921384140
+  version_requirements: *70200922663180
 - !ruby/object:Gem::Dependency
   name: rdf
-  requirement: &70363921383140 !ruby/object:Gem::Requirement
+  requirement: &70200922662000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70363921383140
+  version_requirements: *70200922662000
 - !ruby/object:Gem::Dependency
   name: rdf-rdfxml
-  requirement: &70363921381980 !ruby/object:Gem::Requirement
+  requirement: &70200922660520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70363921381980
+  version_requirements: *70200922660520
 - !ruby/object:Gem::Dependency
   name: rdf-n3
-  requirement: &70363921380580 !ruby/object:Gem::Requirement
+  requirement: &70200922674900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70363921380580
+  version_requirements: *70200922674900
 - !ruby/object:Gem::Dependency
   name: rdf-json
-  requirement: &70363921379380 !ruby/object:Gem::Requirement
+  requirement: &70200922673580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70363921379380
+  version_requirements: *70200922673580
 - !ruby/object:Gem::Dependency
   name: json-ld
-  requirement: &70363921378320 !ruby/object:Gem::Requirement
+  requirement: &70200922670740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70363921378320
+  version_requirements: *70200922670740
 - !ruby/object:Gem::Dependency
   name: guid
-  requirement: &70363921393360 !ruby/object:Gem::Requirement
+  requirement: &70200922693900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70363921393360
+  version_requirements: *70200922693900
 - !ruby/object:Gem::Dependency
   name: dalli
-  requirement: &70363921391420 !ruby/object:Gem::Requirement
+  requirement: &70200922692800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -122,7 +122,7 @@ dependencies:
         version: '2.6'
   type: :runtime
   prerelease: false
-  version_requirements: *70363921391420
+  version_requirements: *70200922692800
 description: RDF ruby ORM
 email:
 - ric@swirrl.com
@@ -140,6 +140,7 @@ files:
 - lib/tripod.rb
 - lib/tripod/attributes.rb
 - lib/tripod/cache_stores/memcached_cache_store.rb
+- lib/tripod/callbacks.rb
 - lib/tripod/components.rb
 - lib/tripod/criteria.rb
 - lib/tripod/criteria/execution.rb