tripod 0.3.5 → 0.3.6

data/README.md

@@ -8,17 +8,13 @@ ActiveModel-style Ruby ORM for RDF Linked Data. Works with SPARQL 1.1 HTTP endpo
 
 ## 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.
-
-1. Install the gem:
-
-        gem install tripod
-
-2. Add it to your Gemfile
+1. Add it to your Gemfile and bundle
 
         gem tripod
 
-3. Configure it (in application.rb, or development.rb/production.rb/test.rb)
+        $ bundle
+
+2. Configure it (in application.rb, or development.rb/production.rb/test.rb)
 
         # (values shown are the defaults)
         Tripod.configure do |config|
@@ -27,7 +23,7 @@ Note: Tripod doesn't supply a database. You need to install one. I recommend [Fu
           config.timeout_seconds = 30
         end
 
-4. Include it in your model classes.
+3. Include it in your model classes.
 
         class Person
           include Tripod::Resource
@@ -45,7 +41,7 @@ Note: Tripod doesn't supply a database. You need to install one. I recommend [Fu
 
         # Note: Active Model validations are supported
 
-5. Use it
+4. Use it
 
         uri = 'http://ric'
         p = Person.new(uri)
@@ -59,6 +55,10 @@ 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.
 
+## 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.
+
 
 ## Some Other interesting features
 

data/lib/tripod/attributes.rb

@@ -18,22 +18,20 @@ module Tripod::Attributes
   # @param [ String ] name The name of the field for which to get the value.
   # @param [ Field ] field An optional Field object
   #
-  # @return Either a string or an Array of strings, depending on whether the field is multivalued or not
+  # @return RDF:Term or array of them, depending on whether the field is multivalued or not
   def read_attribute(name, field=nil)
     field ||= self.fields[name]
     raise Tripod::Errors::FieldNotPresent.new unless field
 
     attr_values = read_predicate(field.predicate)
-    # We always return strings on way out.
+
     # If the field is multivalued, return an array of the results
     # If it's not multivalued, return the first (should be only) result.
+
     if field.multivalued
-      attr_values.map do |v|
-        v.nil? ? nil : v.to_s
-      end
+      attr_values
     else
-      first_val = attr_values.first
-      first_val.nil? ? nil : first_val.to_s
+      attr_values.first
     end
   end
   alias :[] :read_attribute

data/lib/tripod/cache_stores/memcached_cache_store.rb

@@ -0,0 +1,35 @@
+require 'dalli'
+
+module Tripod
+  module CacheStores
+
+    # A Tripod::CacheStore that uses Memcached.
+    # Note: Make sure you set the memcached -I (slab size) to big enough to store each result,
+    # and set the -m (total size) to something quite big (or the cache will recycle too often).
+    class MemcachedCacheStore
+
+      # initialize a memcached cache store at the specified port (default 'localhost:11211')
+      def initialize(location)
+        @dalli = Dalli::Client.new(location)
+      end
+
+      # takes a block
+      def fetch(key)
+        raise ArgumentError.new("expected a block") unless block_given?
+
+        @dalli.fetch(key) do
+          yield
+        end
+      end
+
+      def write(key, data)
+        @dalli.set(key, data)
+      end
+
+      def read(key)
+        @dalli.get(key)
+      end
+
+    end
+  end
+end

data/lib/tripod/criteria/execution.rb

@@ -9,10 +9,13 @@ module Tripod
     # Execute the query and return a +ResourceCollection+ of all hydrated resources
     # +ResourceCollection+ is an +Enumerable+, Array-like object.
     def resources
-      Tripod::ResourceCollection.new(resources_from_sparql(build_select_query))
+      Tripod::ResourceCollection.new(
+        resources_from_sparql(build_select_query)
+      )
     end
 
     # Execute the query and return the first result as a hydrated resource
+
     def first
       sq = Tripod::SparqlQuery.new(build_select_query)
       first_sparql = sq.as_first_query_str

data/lib/tripod/criteria.rb

@@ -26,8 +26,6 @@ module Tripod
 
       if resource_class._RDF_TYPE
         self.where("?uri a <#{resource_class._RDF_TYPE.to_s}>")
-      else
-        self.where("?uri ?p ?o")
       end
 
       self.graph_uri = resource_class._GRAPH_URI.to_s if resource_class._GRAPH_URI
@@ -86,6 +84,7 @@ module Tripod
     # @return [ Tripod::Criteria ] A criteria object
     def graph(graph_uri)
       self.graph_uri = graph_uri.to_s
+      self
     end
   end
 end

data/lib/tripod/finders.rb

@@ -76,8 +76,7 @@ module Tripod::Finders
     # execute a query to return all objects (restricted by this class's rdf_type if specified)
     # returns a criteria object
     def all
-      criteria = Tripod::Criteria.new(self)
-      criteria
+      where('?uri ?p ?o')
     end
 
     def count

data/lib/tripod/resource.rb

@@ -38,7 +38,7 @@ module Tripod::Resource
     @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.rdf_type = self.class._RDF_TYPE if respond_to?(:rdf_type=) && self.class._RDF_TYPE
   end
 
   # default comparison is via the uri
@@ -95,8 +95,8 @@ module Tripod::Resource
     # makes a "field" on this model called rdf_type
     # and sets a class level _RDF_TYPE variable with the rdf_type passed in.
     def rdf_type(new_rdf_type)
-      field :rdf_type, 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
     end
 
     def graph_uri(new_graph_uri)

data/lib/tripod/resource_collection.rb

@@ -31,6 +31,10 @@ module Tripod
       resources[*args]
     end
 
+    def ==(other)
+      self.to_nt == other.to_nt
+    end
+
     # for n-triples we can just concatenate them
     def to_nt
       nt = ""

data/lib/tripod/sparql_client.rb

@@ -16,12 +16,24 @@ module Tripod::SparqlClient
       begin
         params = { :params => {:query => sparql, :output => format } }
         hdrs = headers.merge(params)
-        RestClient::Request.execute(
-          :method => :get,
-          :url => Tripod.query_endpoint,
-          :headers => hdrs,
-          :timeout => Tripod.timeout_seconds,
-        )
+
+        make_the_call =
+          -> { RestClient::Request.execute(
+            :method => :get,
+            :url => Tripod.query_endpoint,
+            :headers => hdrs,
+            :timeout => Tripod.timeout_seconds
+          ) }
+
+        if Tripod.cache_store # if a cache store is configured
+          # SHA-2 the key to keep the it within the small limit for many cache stores (e.g. Memcached is 250bytes)
+          # Note: SHA2's are pretty certain to be unique http://en.wikipedia.org/wiki/SHA-2.
+          key = 'SPARQL-QUERY-' + Digest::SHA2.hexdigest([format, headers, sparql].join(" "))
+          Tripod.cache_store.fetch(key, &make_the_call)
+        else
+          make_the_call.call()
+        end
+
       rescue RestClient::BadRequest => e
         # just re-raise as a BadSparqlRequest Exception
         raise Tripod::Errors::BadSparqlRequest.new(e.http_body, e)

data/lib/tripod/version.rb

@@ -1,3 +1,3 @@
 module Tripod
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/lib/tripod.rb

@@ -51,12 +51,17 @@ module Tripod
   mattr_accessor :timeout_seconds
   @@timeout_seconds = 30
 
-  # Use +configure+ to override configuration in an app, e.g.:
+  mattr_accessor :cache_store
+
+  # Use +configure+ to override configuration in an app, (defaults shown)
   #
   #   Tripod.configure do |config|
   #     config.update_endpoint = 'http://127.0.0.1:3030/tripod/update'
   #     config.query_endpoint = 'http://127.0.0.1:3030/tripod/sparql'
-  #     config.timeout_seconds = 30
+  #     config.timeout_seconds = 30#
+  #     config.cache_store = nil #e.g Tripod::CacheStores::MemcachedCacheStore.new('localhost:11211')
+  #       # note: if using memcached, make sure you set the -I (slab size) to big enough to store each result
+  #       # and set the -m (total size) to something quite big (or the cache will recycle too often).
   #   end
   #
   def self.configure
@@ -65,6 +70,8 @@ module Tripod
 
 end
 
+require 'tripod/cache_stores/memcached_cache_store'
+
 require "tripod/extensions"
 require "tripod/sparql_client"
 require "tripod/sparql_query"

data/spec/app/models/person.rb

@@ -6,6 +6,7 @@ class Person
   graph_uri 'http://graph'
 
   field :name, 'http://name'
+  field :father, 'http://father'
   field :knows, 'http://knows', :multivalued => true
   field :aliases, 'http://alias', :multivalued => true
   field :age, 'http://age', :datatype => RDF::XSD.integer

data/spec/tripod/attributes_spec.rb

@@ -2,14 +2,40 @@ require "spec_helper"
 
 describe Tripod::Attributes do
   describe ".read_attribute" do
+
+    let!(:other_person) do
+      p = Person.new('http://garry')
+      p.save!
+      p
+    end
+
     let(:person) do
       p = Person.new('http://barry')
       p.name = 'Barry'
+      p.father = other_person.uri
       p
     end
 
-    it "should read the given attribute" do
-      person[:name].should == 'Barry'
+    context "for a literal" do
+      it "should return an RDF::Literal" do
+        person[:name].class.should == RDF::Literal
+      end
+      it "should read the given attribute" do
+        person[:name].should == 'Barry'
+      end
+    end
+
+    context "for a uri" do
+
+      it "should return an RDF::URI" do
+        puts person[:father]
+
+        person[:father].class.should == RDF::URI
+      end
+
+      it "should read the given attribute" do
+        person[:father].should == other_person.uri
+      end
     end
 
     context "where the attribute is multi-valued" do

data/spec/tripod/criteria_execution_spec.rb

@@ -3,11 +3,11 @@ require "spec_helper"
 describe Tripod::Criteria do
 
   let(:person_criteria) do
-    c = Tripod::Criteria.new(Person)
+    c = Person.all #Tripod::Criteria.new(Person)
   end
 
   let(:resource_criteria) do
-    c = Tripod::Criteria.new(Resource)
+    c = Resource.all #Tripod::Criteria.new(Resource)
   end
 
   let!(:john) do
@@ -28,14 +28,14 @@ describe Tripod::Criteria do
 
     context "for a class with an rdf_type and graph" do
       it "should return a SELECT query based with an rdf type restriction" do
-        person_criteria.send(:build_select_query).should == "SELECT DISTINCT ?uri (<http://graph> as ?graph) WHERE { GRAPH <http://graph> { ?uri a <http://person> } }"
+        person_criteria.send(:build_select_query).should == "SELECT DISTINCT ?uri (<http://graph> as ?graph) WHERE { GRAPH <http://graph> { ?uri a <http://person> . ?uri ?p ?o } }"
       end
 
       context "and extra restrictions" do
         before { person_criteria.where("[pattern]") }
 
         it "should return a SELECT query with the extra restriction" do
-          person_criteria.send(:build_select_query).should == "SELECT DISTINCT ?uri (<http://graph> as ?graph) WHERE { GRAPH <http://graph> { ?uri a <http://person> . [pattern] } }"
+          person_criteria.send(:build_select_query).should == "SELECT DISTINCT ?uri (<http://graph> as ?graph) WHERE { GRAPH <http://graph> { ?uri a <http://person> . ?uri ?p ?o . [pattern] } }"
         end
       end
 
@@ -43,7 +43,7 @@ describe Tripod::Criteria do
         before { person_criteria.graph("http://anothergraph") }
 
          it "should override the graph in the query" do
-          person_criteria.send(:build_select_query).should == "SELECT DISTINCT ?uri (<http://anothergraph> as ?graph) WHERE { GRAPH <http://anothergraph> { ?uri a <http://person> } }"
+          person_criteria.send(:build_select_query).should == "SELECT DISTINCT ?uri (<http://anothergraph> as ?graph) WHERE { GRAPH <http://anothergraph> { ?uri a <http://person> . ?uri ?p ?o } }"
         end
       end
     end
@@ -116,7 +116,6 @@ describe Tripod::Criteria do
 
   describe "#count" do
 
-
     it "should return a set of hydrated objects for the criteria" do
       person_criteria.count.should == 2
       person_criteria.where("?uri <http://name> 'John'").count.should ==1
@@ -129,7 +128,7 @@ describe Tripod::Criteria do
     end
 
     it "should execute the right Sparql" do
-      sparql = "SELECT COUNT(*) { SELECT DISTINCT ?uri (<http://graph> as ?graph) WHERE { GRAPH <http://graph> { ?uri a <http://person> } }  LIMIT 10 OFFSET 20 }"
+      sparql = "SELECT COUNT(*) { SELECT DISTINCT ?uri (<http://graph> as ?graph) WHERE { GRAPH <http://graph> { ?uri a <http://person> . ?uri ?p ?o } }  LIMIT 10 OFFSET 20 }"
       Tripod::SparqlClient::Query.should_receive(:select).with(sparql).and_call_original
       Person.all.limit(10).offset(20).count
     end

data/spec/tripod/criteria_spec.rb

@@ -2,9 +2,9 @@ require "spec_helper"
 
 describe Tripod::Criteria do
 
-  let(:person_criteria) { Tripod::Criteria.new(Person) }
+  let(:person_criteria) { Person.all }
 
-  let(:resource_criteria) { Tripod::Criteria.new(Resource) }
+  let(:resource_criteria) { Resource.all }
 
   describe "#initialize" do
 
@@ -18,7 +18,7 @@ describe Tripod::Criteria do
 
     context "with rdf_type set on the class" do
       it "should initialize the where clauses to include a type restriction" do
-        person_criteria.where_clauses.should == ["?uri a <http://person>"]
+        person_criteria.where_clauses.should == ["?uri a <http://person>", "?uri ?p ?o"]
       end
     end
 

data/spec/tripod/finders_spec.rb

@@ -65,8 +65,8 @@ describe Tripod::Finders do
   end
 
   describe ".all" do
-    it "should make and return a new criteria for the current class" do
-      Person.all.should == Tripod::Criteria.new(Person)
+    it "should make and return a new criteria for the current class, with a where clause of ?uri ?p ?o already started" do
+      Person.all.should == Tripod::Criteria.new(Person).where("?uri ?p ?o")
     end
   end
 

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.to_s.should == 'http://person'
+          person.rdf_type.should == ['http://person']
         end
       end
 

data/tripod.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency "rdf-json"
   gem.add_dependency "json-ld"
   gem.add_dependency "guid"
+  gem.add_dependency "dalli", "~> 2.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tripod
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
+date: 2013-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70333194336060 !ruby/object:Gem::Requirement
+  requirement: &70167526722900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70333194336060
+  version_requirements: *70167526722900
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70333194335020 !ruby/object:Gem::Requirement
+  requirement: &70167526720820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70333194335020
+  version_requirements: *70167526720820
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
-  requirement: &70333194334540 !ruby/object:Gem::Requirement
+  requirement: &70167518449700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70333194334540
+  version_requirements: *70167518449700
 - !ruby/object:Gem::Dependency
   name: rdf
-  requirement: &70333194333460 !ruby/object:Gem::Requirement
+  requirement: &70167518447940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70333194333460
+  version_requirements: *70167518447940
 - !ruby/object:Gem::Dependency
   name: rdf-rdfxml
-  requirement: &70333194332500 !ruby/object:Gem::Requirement
+  requirement: &70167518446320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70333194332500
+  version_requirements: *70167518446320
 - !ruby/object:Gem::Dependency
   name: rdf-n3
-  requirement: &70333194331640 !ruby/object:Gem::Requirement
+  requirement: &70167518445720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70333194331640
+  version_requirements: *70167518445720
 - !ruby/object:Gem::Dependency
   name: rdf-json
-  requirement: &70333194331040 !ruby/object:Gem::Requirement
+  requirement: &70167518444840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70333194331040
+  version_requirements: *70167518444840
 - !ruby/object:Gem::Dependency
   name: json-ld
-  requirement: &70333194330380 !ruby/object:Gem::Requirement
+  requirement: &70167518444020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70333194330380
+  version_requirements: *70167518444020
 - !ruby/object:Gem::Dependency
   name: guid
-  requirement: &70333194329820 !ruby/object:Gem::Requirement
+  requirement: &70167518443180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,7 +111,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70333194329820
+  version_requirements: *70167518443180
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: &70167518442440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167518442440
 description: RDF ruby ORM
 email:
 - ric@swirrl.com
@@ -128,6 +139,7 @@ files:
 - Rakefile
 - lib/tripod.rb
 - lib/tripod/attributes.rb
+- lib/tripod/cache_stores/memcached_cache_store.rb
 - lib/tripod/components.rb
 - lib/tripod/criteria.rb
 - lib/tripod/criteria/execution.rb