tripod 0.7.8 → 0.7.9

data/lib/tripod/criteria/execution.rb

@@ -10,11 +10,13 @@ module Tripod
     # +ResourceCollection+ is an +Enumerable+, Array-like object.
     #
     # @option options [ String ] return_graph Indicates whether to return the graph as one of the variables.
+    # @option options [ Boolean ] only_set_fields Indicates whether to set only the declared fields on the resources. (default false).
     def resources(opts={})
       Tripod::ResourceCollection.new(
-        self.resource_class._resources_from_sparql(build_select_query(opts)),
+        self.resource_class._resources_from_sparql(build_select_query(opts), :only_set_fields => opts[:only_set_fields]),
          # pass in the criteria that was used to generate this collection, as well as whether the user specified return graph
         :return_graph => (opts.has_key?(:return_graph) ? opts[:return_graph] : true),
+        :only_set_fields => opts[:only_set_fields],
         :criteria => self
       )
     end
@@ -31,6 +33,7 @@ module Tripod
     # Execute the query and return the first result as a hydrated resource
     #
     # @option options [ String ] return_graph Indicates whether to return the graph as one of the variables.
+    # @option options [ Boolean ] only_set_fields Indicates whether to set only the declared fields on the resources. (default false).
     def first(opts={})
       sq = Tripod::SparqlQuery.new(build_select_query(opts))
       first_sparql = sq.as_first_query_str

data/lib/tripod/finders.rb

@@ -59,6 +59,7 @@ module Tripod::Finders
     #
     # @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'
+    # @option options [ Boolean ] only_set_fields Indicates whether to set only the declared fields on the resources. (default false).
     #
     # @return [ Array ] An array of hydrated resources of this class's type.
     def find_by_sparql(sparql_query, opts={})
@@ -115,7 +116,8 @@ module Tripod::Finders
     # given a sparql select query, create and hydrate some resources
     #
     # @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'
+    # @option options [ String ] graph_variable The name of the uri variable in the query, if not 'graph'
+    # @option options [ Boolean ] only_set_fields Indicates whether to set only the declared fields on the resources. (default false).
     def _resources_from_sparql(select_sparql, opts={})
       _create_and_hydrate_resources_from_sparql(select_sparql, opts)
     end
@@ -143,12 +145,13 @@ module Tripod::Finders
     #
     # @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 the query, if not 'graph'
+    # @option options [ Boolean ] only_set_fields Indicates whether to set only the declared fields on the resources. (default false).
     def _create_and_hydrate_resources_from_sparql(select_sparql, opts={})
       # TODO: Optimization?: if return_graph option is false, then don't do this next line?
       uris_and_graphs = _select_uris_and_graphs(select_sparql, :uri_variable => opts[:uri_variable], :graph_variable => opts[:graph_variable])
       ntriples_string = _raw_describe_select_results(select_sparql, :uri_variable => opts[:uri_variable]) # this defaults to ntriples
       graph = _rdf_graph_from_ntriples_string(ntriples_string, graph=nil)
-      _resources_from_graph(graph, uris_and_graphs)
+      _resources_from_graph(graph, uris_and_graphs, :only_set_fields => opts[:only_set_fields])
     end
 
     # For a select query, generate a query which DESCRIBES all the results
@@ -169,10 +172,12 @@ module Tripod::Finders
       Tripod::SparqlClient::Query.query(query, accept_header)
     end
 
-    # given a graph of data, and a hash of uris=>graphs, create and hydrate some resources.
+    # Given a graph of data, and a hash of uris=>graphs, create and hydrate some resources.
     # Note: if any of the graphs are not set in the hash,
     # those resources can still be constructed, but not persisted back to DB.
-    def _resources_from_graph(graph, uris_and_graphs)
+    #
+    # @option options [ Boolean ] only_set_fields Indicates whether to set only the declared fields on the resources. (default false).
+    def _resources_from_graph(graph, uris_and_graphs, opts={})
       repo = add_data_to_repository(graph)
       resources = []
 
@@ -187,8 +192,11 @@ module Tripod::Finders
 
         # 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
+          if !opts[:only_set_fields] || self.fields.values.map{ |v| v.predicate.to_s }.include?(statement.predicate.to_s)
+            data_graph << statement
+          end
         end
 
         # use it to hydrate this resource

data/lib/tripod/version.rb

@@ -1,3 +1,3 @@
 module Tripod
-  VERSION = "0.7.8"
+  VERSION = "0.7.9"
 end

data/spec/tripod/criteria_execution_spec.rb

@@ -12,6 +12,7 @@ describe Tripod::Criteria do
 
   let!(:john) do
     p = Person.new('http://example.com/id/john')
+    p.write_predicate('http://example.com/this-is-not-declared-as-a-field', 'blah')
     p.name = "John"
     p.save!
     p
@@ -96,8 +97,8 @@ describe Tripod::Criteria 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)
+        person_criteria.should_receive(:build_select_query).with(:return_graph => false, :only_set_fields => true).and_call_original
+        person_criteria.resources(:return_graph => false, :only_set_fields => true)
       end
     end
 
@@ -131,6 +132,18 @@ describe Tripod::Criteria do
 
     end
 
+    context "with the only_set_fields option set to true" do
+      it "should only populate predicates for fields that have been declared at class level" do
+        person_criteria.resources(:only_set_fields => true).first.read_predicate('http://example.com/this-is-not-declared-as-a-field').should be_empty
+      end
+    end
+
+    context "without setting the only_set_fields option (i.e. false)" do
+      it "should only populate all preciates that have been declared at class level" do
+        person_criteria.resources.first.read_predicate('http://example.com/this-is-not-declared-as-a-field').should_not be_empty
+      end
+    end
+
   end
 
   describe "#first" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tripod
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.9
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-24 00:00:00.000000000 Z
+date: 2013-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70109553817240 !ruby/object:Gem::Requirement
+  requirement: &70100686885260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109553817240
+  version_requirements: *70100686885260
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70109553816700 !ruby/object:Gem::Requirement
+  requirement: &70100686884720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70109553816700
+  version_requirements: *70100686884720
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
-  requirement: &70109553816280 !ruby/object:Gem::Requirement
+  requirement: &70100686884300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109553816280
+  version_requirements: *70100686884300
 - !ruby/object:Gem::Dependency
   name: rdf
-  requirement: &70109553815740 !ruby/object:Gem::Requirement
+  requirement: &70100686883760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109553815740
+  version_requirements: *70100686883760
 - !ruby/object:Gem::Dependency
   name: rdf-rdfxml
-  requirement: &70109553815320 !ruby/object:Gem::Requirement
+  requirement: &70100686883340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109553815320
+  version_requirements: *70100686883340
 - !ruby/object:Gem::Dependency
   name: rdf-n3
-  requirement: &70109553814860 !ruby/object:Gem::Requirement
+  requirement: &70100686882880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109553814860
+  version_requirements: *70100686882880
 - !ruby/object:Gem::Dependency
   name: rdf-json
-  requirement: &70109553814440 !ruby/object:Gem::Requirement
+  requirement: &70100686882460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109553814440
+  version_requirements: *70100686882460
 - !ruby/object:Gem::Dependency
   name: json-ld
-  requirement: &70109553814020 !ruby/object:Gem::Requirement
+  requirement: &70100686882040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109553814020
+  version_requirements: *70100686882040
 - !ruby/object:Gem::Dependency
   name: guid
-  requirement: &70109553813600 !ruby/object:Gem::Requirement
+  requirement: &70100686881620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109553813600
+  version_requirements: *70100686881620
 - !ruby/object:Gem::Dependency
   name: dalli
-  requirement: &70109553829460 !ruby/object:Gem::Requirement
+  requirement: &70100686881120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -122,7 +122,7 @@ dependencies:
         version: '2.6'
   type: :runtime
   prerelease: false
-  version_requirements: *70109553829460
+  version_requirements: *70100686881120
 description: RDF ruby ORM
 email:
 - ric@swirrl.com