tripod 0.9.7 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0d0bb81441871fbdb4115e399bca413f309c7c4
-  data.tar.gz: 3b72bae40446b70dd252383f82193c4764a2b669
+  metadata.gz: 9c4f4a91c3753acb50660407e1862de999314cf6
+  data.tar.gz: 097ab255b4abf50836e5e13844dd96ccfd74e036
 SHA512:
-  metadata.gz: 614d0632c00fd4b5c99347f035fad525a2e9a9cf9240cd9376bf1c6fa1585ccda99a28ff0c8f74c988f7c8480723845195b6ffc74d05b5a7c1321ba849436062
-  data.tar.gz: 515dafcdb449015ef2b8728b00c65687f3d777e232022e34e9d96311a77229a7c9b2eea7332ea6dae7c19c34ba34a52e2b6117bc038fa81314cbba64b819b795
+  metadata.gz: cd7b93b8990be65d54c964f347420d74c2c1d2327d9356e4d32e6d831cd751fb96916788e27be8b212d25400f2e7fe0f1ee68857ff28e0601473bd89805a20ec
+  data.tar.gz: bda4ed335ee7b00600ffaf219805b7f725a4f59d292a7f7a9ce428df017e8bacbf554dfdc8da8a63a2e281e5aad510ecb8eba1fdface9587682887c5526863b7

data/lib/tripod/components.rb

@@ -19,6 +19,7 @@ module Tripod::Components
   include Tripod::Validations
   include Tripod::Persistence
   include Tripod::Fields
+  include Tripod::Links
   include Tripod::Finders
   include Tripod::Repository
   include Tripod::EagerLoading

data/lib/tripod/fields/standard.rb

@@ -6,6 +6,7 @@ module Tripod::Fields
     # Set readers for the instance variables.
     attr_accessor :name, :predicate, :options, :datatype, :is_uri, :multivalued
     alias_method :is_uri?, :is_uri
+    alias_method :multivalued?, :multivalued
 
     # Create the new field with a name and optional additional options.
     #

data/lib/tripod/fields.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require "tripod/fields/standard"
 
- # This module defines behaviour for fields.
+# This module defines behaviour for fields.
 module Tripod::Fields
   extend ActiveSupport::Concern
 

data/lib/tripod/links/linked_from.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Tripod::Links
+  # Defines the behaviour for defined links in the resource.
+  class LinkedFrom
+
+    # Set readers for the instance variables.
+    attr_accessor :name, :incoming_field, :options, :incoming_field_name, :class_name
+
+    # Create the new link with a name and optional additional options.
+    def initialize(name, incoming_field_name, options = {})
+      @name = name
+      @options = options
+      @incoming_field_name = incoming_field_name
+      # if class name not supplied, guess from the field name
+      @class_name = options[:class_name] || name.to_s.singularize.classify
+
+    end
+  end
+end

data/lib/tripod/links/linked_to.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Tripod::Links
+  # Defines the behaviour for defined links in the resource.
+  class LinkedTo
+
+    # Set readers for the instance variables.
+    attr_accessor :name, :predicate, :options, :multivalued, :field_name, :class_name
+    alias_method :multivalued?, :multivalued
+
+    # Create the new link with a name and optional additional options.
+    def initialize(name, predicate, options = {})
+      @name = name
+      @options = options
+      @predicate = RDF::URI.new(predicate.to_s)
+      @multivalued = options[:multivalued] || false
+      @class_name = options[:class_name] || @name.to_s.classify
+      @field_name = options[:field_name] || (@name.to_s + ( @multivalued ? "_uris" : "_uri" )).to_sym
+
+    end
+  end
+end

data/lib/tripod/links.rb

@@ -0,0 +1,172 @@
+# encoding: utf-8
+require "tripod/links/linked_to"
+require "tripod/links/linked_from"
+
+# This module defines behaviour for fields.
+module Tripod::Links
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :linked_tos
+    class_attribute :linked_froms
+    self.linked_tos = {}
+    self.linked_froms = {}
+  end
+
+  module ClassMethods
+
+    # Define a link to another resource. Creates relevant fields and getter/setter methods. Note that the getter only retrives saved resources from the db.
+    #
+    # @example Define a link away from resources of this class to resources of class Organisation
+    #   linked_to :organisation, 'http://example.com/name'
+    #
+    # @example Define a multivalued link away from resources of this class (can be combined with other options)
+    #   linked_to :organisations, 'http://example.com/modified_at',  multivalued: true
+    #
+    # @example Define a link away from resources of this class, specifying the class and the field name that will be generated
+    #   linked_to :org, 'http://example.com/modified_at', class_name: 'Organisation', field: my_field
+    #
+    # @param [ Symbol ] name The name of the link.
+    # @param [ String, RDF::URI ] predicate The predicate for the field.
+    # @param [ Hash ] options The options to pass to the field.
+    #
+    # @option options [ Boolean ] multivalued Is this a multi-valued field? Default is false.
+    # @option options [ String ] class_name The name of the class of resource which we're linking to (normally will derive this from the link name)
+    # @option options [ Symbol ] field_name the symbol of the field that will be generated (normally will just add _uri or _uris to the link name)
+    #
+    # @return [ LinkedTo ] The generated link
+    def linked_to(name, predicate, options = {})
+      add_linked_to(name, predicate, options)
+    end
+
+
+    # Define that another resource links to this one. Creates a getter with the name you specify.
+    # For this to work, the incoming class needs to define a linked_to relationship.
+    # Just creates the relevant getter which always return an array of objects.
+    #
+    # @example make a method called people which returns Dog objects, via the linked_to :owner field on Dog. We guess the class name based on the linked_from name.
+    #   linked_from :dogs, :owner
+    #
+    # @example make a method called doggies which returns Dog objects, via the linked_to :person field on Dog.
+    #   linked_from :doggies, :person, class_name: 'Dog'
+    #
+    # @param [ Symbol ] name The name of the link.
+    # @param [ Symbol ] incoming_field_name The name of the linked_to relationship on the other class
+    # @param [ Hash ] options The options to pass to the field.
+    #
+    # @option options [ String ] class_name The name of the class that links to this resource, if we can't guess it from the link name
+    #
+    # @return [ LinkedTo ] The generated link
+    def linked_from(name, incoming_field_name, options = {})
+      add_linked_from(name, incoming_field_name, options)
+    end
+
+    protected
+
+    def add_linked_to(name, predicate, options={})
+      link = linked_to_for(name, predicate, options)
+      linked_tos[name] = link
+
+      # create the field (always is_uri)
+      add_field(link.field_name, predicate, options.merge(is_uri: true))
+
+      create_linked_to_accessors(name, name)
+    end
+
+    def add_linked_from(name, incoming_field_name, options={})
+      link = linked_from_for(name, incoming_field_name, options)
+      linked_froms[name] = link
+
+      create_linked_from_getter(name, name, link)
+    end
+
+    def create_linked_to_accessors(name, meth)
+      link = linked_tos[name]
+
+      create_linked_to_getter(name, meth, link)
+      create_linked_to_setter(name, meth, link)
+    end
+
+    def create_linked_from_getter(name, meth, link)
+
+      generated_methods.module_eval do
+        re_define_method(meth) do
+          klass = Kernel.const_get(link.class_name)
+
+          incoming_link = klass.linked_tos[link.incoming_field_name.to_sym]
+          incoming_predicate = klass.fields[incoming_link.field_name].predicate
+
+          # note - this will only find saved ones.
+          klass
+            .where("?uri <#{incoming_predicate.to_s}> <#{self.uri.to_s}>")
+            .resources
+        end
+      end
+    end
+
+    def create_linked_to_getter(name, meth, link)
+
+      generated_methods.module_eval do
+        re_define_method(meth) do
+
+          klass = Kernel.eval(link.class_name)
+
+          if link.multivalued?
+
+            # # TODO: is there a more efficient way of doing this?
+
+            # note that we can't just do a query like this:
+            #   `klass.where('<#{self.uri.to_s}> <#{predicate.to_s}> ?uri').resources`
+            # ... because this will only find saved ones and we want to find resources
+            # whose uris have been set on the resource but not saved to db yet.
+
+            criteria = klass.where('?uri ?p ?o')
+
+            uris = read_attribute(link.field_name)
+
+            filter_str = "FILTER("
+            if uris.any?
+              filter_str += uris.map {|u| "?uri = <#{u.to_s}>" }.join(" || ")
+            else
+              filter_str += "1 = 0"
+            end
+            filter_str += ")"
+
+            criteria.where(filter_str).resources
+          else
+            klass.find(read_attribute(link.field_name)) rescue nil #look it up by it's uri
+          end
+
+        end
+      end
+    end
+
+    def create_linked_to_setter(name, meth, link)
+
+      generated_methods.module_eval do
+        re_define_method("#{meth}=") do |value|
+
+          if link.multivalued?
+            val = value.to_a.map{ |v| v.uri }
+            write_attribute( link.field_name, val)
+          else
+            # set the uri from the passed in resource
+            write_attribute( link.field_name, value.uri )
+          end
+        end
+      end
+    end
+
+    # instantiates and returns a new LinkedFrom
+    def linked_from_for(name, incoming_field_name, options)
+      Tripod::Links::LinkedFrom.new(name, incoming_field_name, options)
+    end
+
+     # instantiates and returns a new LinkTo
+    def linked_to_for(name, predicate, options)
+      Tripod::Links::LinkedTo.new(name, predicate, options)
+    end
+
+  end
+
+end

data/lib/tripod/version.rb

@@ -1,3 +1,3 @@
 module Tripod
-  VERSION = "0.9.7"
+  VERSION = "0.9.8"
 end

data/lib/tripod.rb

@@ -96,6 +96,7 @@ require "tripod/errors"
 require "tripod/repository"
 require "tripod/fields"
 require "tripod/criteria"
+require "tripod/links"
 require "tripod/finders"
 require "tripod/persistence"
 require "tripod/eager_loading"

data/spec/app/models/dog.rb

@@ -0,0 +1,17 @@
+class Dog
+
+  include Tripod::Resource
+
+  rdf_type 'http://example.com/dog'
+  graph_uri 'http://example.com/graph'
+
+  field :name, 'http://example.com/name'
+
+  linked_to :owner, 'http://example.com/owner', class_name: 'Person'
+  linked_to :person, 'http://example.com/person'
+  linked_to :friends, 'http://example.com/friend', multivalued: true, class_name: 'Dog'
+  linked_to :previous_owner, 'http://example.com/prevowner', class_name: 'Person', field_name: :prev_owner_uri
+
+  linked_to :arch_enemy, 'http://example.com/archenemy', class_name: 'Dog'
+  linked_to :enemies, 'http://example.com/enemy', class_name: 'Dog'
+end

data/spec/app/models/person.rb

@@ -12,6 +12,9 @@ class Person
   field :age, 'http://example.com/age', :datatype => RDF::XSD.integer
   field :important_dates, 'http://example.com/importantdates', :datatype => RDF::XSD.date, :multivalued => true
 
+  linked_from :owns_dogs, :owner, class_name: 'Dog'
+  linked_from :dogs, :person
+
   before_save :pre_save
   before_destroy :pre_destroy
 

data/spec/tripod/links_spec.rb

@@ -0,0 +1,134 @@
+require "spec_helper"
+
+describe Tripod::Links do
+
+  let(:barry) do
+    b = Person.new('http://example.com/id/barry')
+    b.name = 'Barry'
+    b.save!
+    b
+  end
+
+  let(:gary) do
+    g = Person.new('http://example.com/id/gary')
+    g.name = 'Gary'
+    g.save!
+    g
+  end
+
+  let(:jonno) do
+    j = Person.new('http://example.com/id/jonno')
+    j.name = 'Jonno'
+    j.save!
+    j
+  end
+
+  let(:fido) do
+    d = Dog.new('http://example.com/id/fido')
+    d.name = "fido"
+    d.save!
+    d
+  end
+
+  let!(:spot) do
+    d = Dog.new('http://example.com/id/spot')
+    d.name = "spot"
+    d.owner = barry
+    d.save!
+    d
+  end
+
+  let!(:rover) do
+    d = Dog.new('http://example.com/id/rover')
+    d.name = 'Rover'
+    d.owner = barry
+    d.person = gary
+    d.previous_owner = jonno
+    d.save!
+    d
+  end
+
+
+  describe ".linked_from" do
+
+    context "class name is specified" do
+      it "creates a getter which returns the resources" do
+        barry.owns_dogs.to_a == [rover, spot]
+      end
+    end
+
+    context "class name is not specified" do
+      it "creates a getter which returns the resources of the right class, based on the link name" do
+        gary.dogs.to_a.should == [rover]
+      end
+    end
+
+  end
+
+  describe ".linked_to" do
+
+    it "creates a getter for the field, with a default name, which returns the uri" do
+      rover.owner_uri.should == barry.uri
+    end
+
+    it "creates a setter for the link" do
+      rover.owner = gary
+      rover.owner_uri.should == gary.uri
+    end
+
+    context 'the class name is specified' do
+      it "creates a getter for the link, which returns a resource of the right type" do
+        rover.owner.class.should == Person
+        rover.owner.should == barry
+      end
+    end
+
+    context 'the class name is not specified' do
+      it "creates a getter for the link, which automatically returns a resource of the right type (from link name)" do
+        rover.person.class.should == Person
+        rover.person.should == gary
+      end
+    end
+
+    context 'when the field name is set to an alternative field name' do
+      it "uses that for the field name" do
+        rover.prev_owner_uri.should == jonno.uri
+      end
+    end
+
+    context 'its a multivalued field' do
+      it "creates a getter and setter for multiple values, instantiating the right types of resource" do
+        rover.friends = [fido, spot]
+
+        rover.friends.each do |f|
+          f.class.should == Dog
+        end
+
+        rover.friends.length.should == 2
+
+        rover.friends.to_a.first.uri.should == fido.uri
+        rover.friends.to_a.last.uri.should == spot.uri
+      end
+
+      it "creates field getters and setters with the _uris suffix" do
+        rover.friends_uris = [fido.uri, spot.uri]
+        rover.friends_uris.should == [fido.uri, spot.uri]
+      end
+
+    end
+
+    context "when the value is not set for a link" do
+      context "single valued" do
+        it "should be nil" do
+          rover.arch_enemy.should be_nil
+        end
+      end
+
+      context "multivalued" do
+        it "should be nil" do
+          rover.enemies.should be_nil
+        end
+      end
+    end
+  end
+end

data/tripod.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |gem|
   gem.rubyforge_project         = "tripod"
 
   gem.add_dependency "rest-client"
-  gem.add_dependency "activemodel", "> 3.2"
+  gem.add_dependency "activemodel", "~> 3.2"
+  gem.add_dependency "activesupport", "~> 3.2"
   gem.add_dependency "equivalent-xml"
   gem.add_dependency "rdf", "~> 1.1"
   gem.add_dependency "rdf-rdfxml"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tripod
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors:
 - Ric Roberts
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2014-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -30,14 +30,28 @@ dependencies:
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
@@ -207,6 +221,9 @@ files:
 - lib/tripod/fields/standard.rb
 - lib/tripod/finders.rb
 - lib/tripod/graphs.rb
+- lib/tripod/links.rb
+- lib/tripod/links/linked_from.rb
+- lib/tripod/links/linked_to.rb
 - lib/tripod/locale/en.yml
 - lib/tripod/persistence.rb
 - lib/tripod/predicates.rb
@@ -220,6 +237,7 @@ files:
 - lib/tripod/streaming.rb
 - lib/tripod/validations/is_url.rb
 - lib/tripod/version.rb
+- spec/app/models/dog.rb
 - spec/app/models/person.rb
 - spec/app/models/resource.rb
 - spec/spec_helper.rb
@@ -230,6 +248,7 @@ files:
 - spec/tripod/fields_spec.rb
 - spec/tripod/finders_spec.rb
 - spec/tripod/graphs_spec.rb
+- spec/tripod/links_spec.rb
 - spec/tripod/memcached_cache_store_spec.rb
 - spec/tripod/persistence_spec.rb
 - spec/tripod/predicates_spec.rb
@@ -266,6 +285,7 @@ signing_key:
 specification_version: 4
 summary: Active Model style RDF ORM
 test_files:
+- spec/app/models/dog.rb
 - spec/app/models/person.rb
 - spec/app/models/resource.rb
 - spec/spec_helper.rb
@@ -276,6 +296,7 @@ test_files:
 - spec/tripod/fields_spec.rb
 - spec/tripod/finders_spec.rb
 - spec/tripod/graphs_spec.rb
+- spec/tripod/links_spec.rb
 - spec/tripod/memcached_cache_store_spec.rb
 - spec/tripod/persistence_spec.rb
 - spec/tripod/predicates_spec.rb