active-triples 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fe9b5e7c31b1ebd51f2c529d354c27ff5a50461
-  data.tar.gz: 96039e8d7e41040748705955d064101fce40f236
+  metadata.gz: 9e39f588d57dbf6bf017fd8d89be33cc2614cd11
+  data.tar.gz: 0cc21f34df785724b9551c5365b8c31e5de7cd12
 SHA512:
-  metadata.gz: 6c2474afde1a6b48790bed08a67caf0e413f8339cfa5993f0ef6bcb277cf642c21bc5d0f2e1ce830f735766d704ca35cd6bacc3076a1645d52f96f28ba44cd7a
-  data.tar.gz: abbe7fd8978112727f975413aa4cb5bb9a20cfc443c4e2f128d4469010391f20bc79e3466575e68153413b1db7763c7be1aa7f633ed6c75796e3213ac460af37
+  metadata.gz: ad58904cf28803ef6f977792cce6bc8127de400a7b68121e109011e1bb4bde504fe0d56c971fd26ea1bccc444d23894333a24e44ce06a9f3d8c05da0e05ed347
+  data.tar.gz: 3078779a4860330222361efb8e9857f33d71ed76dca1c8934287d13537aa316f71f1bbf060e1a69848d123ea0e0d2b96c4ad84606f358062c9ea5ddcb1fe719c

data/lib/active_triples.rb

@@ -16,6 +16,7 @@ module ActiveTriples
     autoload :Repositories
     autoload :NodeConfig
     autoload :NestedAttributes
+    autoload :Identifiable
   end
 
   def self.class_from_string(class_name, container_class=Kernel)

data/lib/active_triples/identifiable.rb

@@ -0,0 +1,60 @@
+require 'active_support'
+require 'active_support/core_ext/module/delegation'
+
+module ActiveTriples::Identifiable
+  extend ActiveSupport::Concern
+
+  delegate :rdf_subject, :type, to: :resource
+
+  ##
+  # @return [ActiveTriples::Resource] a resource that contains this object's 
+  # graph.
+  def resource
+   @resource ||= resource_class.new(to_uri)
+  end
+  
+  def parent
+    @parent ||= resource.parent
+  end
+
+  def parent=(val)
+    @parent = val
+  end
+
+  ## 
+  # @return [String] a uri or slug
+  def to_uri
+    return id if respond_to? :id and !resource_class.base_uri.nil?
+    raise NotImplementedError
+  end
+
+  private
+    def resource_class
+      self.class.resource_class
+    end
+
+    def update_resource(&block)
+      resource_class.properties.each do |name, property|
+        if block_given?
+          yield name, property
+        else
+          resource.set_value(property.predicate, self.send(property.term))
+        end
+      end
+    end
+
+  public
+
+    module ClassMethods
+
+      delegate :configure, :property, :properties, to: :resource_class
+
+      def resource_class
+        @resource_class ||= Class.new(ActiveTriples::Resource)
+      end
+
+      def from_uri(uri, *args)
+        raise NotImplementedError
+      end
+    end
+end

data/lib/active_triples/node_config.rb

@@ -1,12 +1,13 @@
 module ActiveTriples
   class NodeConfig
-    attr_accessor :predicate, :term, :class_name, :type, :behaviors, :multivalue
+    attr_accessor :predicate, :term, :class_name, :type, :behaviors, :multivalue, :cast
 
     def initialize(term, predicate, args={})
       self.term = term
       self.predicate = predicate
       self.class_name = args.delete(:class_name)
       self.multivalue = args.delete(:multivalue) { true }
+      self.cast = args.delete(:cast) { true }
       raise ArgumentError, "Invalid arguments for Rdf Node configuration: #{args} on #{predicate}" unless args.empty?
       yield(self) if block_given?
     end

data/lib/active_triples/properties.rb

@@ -17,6 +17,18 @@ module ActiveTriples
       initialize_generated_modules
     end
 
+    ##
+    # Registers properties for Resource-like classes
+    # @param [Symbol]  name of the property (and its accessor methods)
+    # @param [Hash]  opts for this property, must include a :predicate
+    # @yield [index] index sets solr behaviors for the property
+    def property(name, opts={}, &block)
+      self.config[name] = NodeConfig.new(name, opts[:predicate], opts.except(:predicate)).tap do |config|
+        config.with_index(&block) if block_given?
+      end
+      register_property(name)
+    end
+
     module ClassMethods
       def inherited(child_class) #:nodoc:
         child_class.initialize_generated_modules
@@ -53,8 +65,8 @@ module ActiveTriples
       #
       # @return [ActiveTriples::NodeConfig]
       def config_for_term_or_uri(term)
-        return config[term.to_sym] unless term.kind_of? RDF::Resource
-        config.each_value { |v| return v if v.predicate == term.to_uri }
+        return properties[term.to_s] unless term.kind_of? RDF::Resource
+        properties.each_value { |v| return v if v.predicate == term.to_uri }
       end
 
       ##

data/lib/active_triples/resource.rb

@@ -181,7 +181,7 @@ module ActiveTriples
     end
 
     def type
-      self.get_values(:type).to_a.map{|x| x.rdf_subject}
+      self.get_values(:type).to_a
     end
 
     def type=(type)
@@ -316,8 +316,8 @@ module ActiveTriples
     def get_term(args)
       @term_cache ||= {}
       term = Term.new(self, args)
-      @term_cache["#{term.rdf_subject}/#{term.property}"] ||= term
-      @term_cache["#{term.rdf_subject}/#{term.property}"]
+      @term_cache["#{term.send(:rdf_subject)}/#{term.property}"] ||= term
+      @term_cache["#{term.send(:rdf_subject)}/#{term.property}"]
     end
 
     ##

data/lib/active_triples/term.rb

@@ -30,6 +30,7 @@ module ActiveTriples
 
     def set(values)
       values = [values].compact unless values.kind_of?(Array)
+      values = values.to_a if values.class == Term
       empty_property
       values.each do |val|
         set_value(val)
@@ -76,13 +77,20 @@ module ActiveTriples
 
     alias_method :push, :<<
 
+    def []=(index, value)
+      values = Array.wrap(result)
+      raise IndexError, "Index #{index} out of bounds." if values[index].nil?
+      values[index] = value
+      self.set(values)
+    end
+
     def property_config
       return type_property if (property == RDF.type || property.to_s == "type") && (!reflections.kind_of?(Resource) || !reflections.reflect_on_property(property))
       reflections.reflect_on_property(property)
     end
 
     def type_property
-      { :multivalue => true, :predicate => RDF.type }
+      { :multivalue => true, :predicate => RDF.type, :cast => false }
     end
 
     def reset!
@@ -92,15 +100,6 @@ module ActiveTriples
       value_arguments.last
     end
 
-    def rdf_subject
-      raise ArgumentError, "wrong number of arguments (#{value_arguments.length} for 1-2)" if value_arguments.length < 1 || value_arguments.length > 2
-      if value_arguments.length > 1
-        value_arguments.first
-      else
-        parent.rdf_subject
-      end
-    end
-
     protected
 
       def node_cache
@@ -162,6 +161,7 @@ module ActiveTriples
       # Builds the resource from the class_name specified for the
       # property.
       def make_node(value)
+        return value unless cast?
         klass = class_for_value(value)
         value = RDF::Node.new if value.nil?
         node = node_cache[value] if node_cache[value]
@@ -171,6 +171,11 @@ module ActiveTriples
         node
       end
 
+      def cast?
+        return true unless property_config
+        !!property_config[:cast]
+      end
+
       def final_parent
         @final_parent ||= begin
           parent = self.parent
@@ -199,5 +204,14 @@ module ActiveTriples
         klass
       end
 
+      def rdf_subject
+        raise ArgumentError, "wrong number of arguments (#{value_arguments.length} for 1-2)" if value_arguments.length < 1 || value_arguments.length > 2
+        if value_arguments.length > 1
+          value_arguments.first
+        else
+          parent.rdf_subject
+        end
+      end
+
   end
 end

data/lib/active_triples/version.rb

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

data/spec/active_triples/identifiable_spec.rb

@@ -0,0 +1,179 @@
+require 'spec_helper'
+require 'active_model'
+
+describe ActiveTriples::Identifiable do
+  before do
+    class ActiveExample
+      include ActiveTriples::Identifiable
+      
+      def self.property(*args)
+        prop = args.first
+
+        define_method prop.to_s do 
+          resource.get_values(prop)
+        end
+
+        define_method "#{prop.to_s}=" do |*args|
+          resource.set_value(prop, *args)
+        end
+
+        resource_class.property(*args)
+      end
+
+    end
+  end
+
+  after do
+    Object.send(:remove_const, 'ActiveExample')
+  end
+
+  subject { ActiveExample.new }
+  let(:klass) { ActiveExample }
+
+  shared_context 'with data' do
+    let(:parent) { MyResource.new }
+
+    before do
+      class MyResource < ActiveTriples::Resource
+        property :relation, predicate: RDF::DC.relation, class_name: 'ActiveExample'
+      end
+
+      klass.property :title, predicate: RDF::DC.title
+      klass.property :identifier, predicate: RDF::DC.identifier
+      klass.property :description, predicate: RDF::DC.description
+
+      subject.resource.title = 'Moomin Valley in November'
+      subject.resource.identifier = 'moomvember'
+      subject.resource.description = 'The ninth and final book in the Moomin series by Finnish author Tove Jansson'
+      parent.relation = subject
+    end
+
+    after do
+      Object.send(:remove_const, 'MyResource')
+    end
+  end
+
+  context 'without implementation' do
+    describe '::from_uri' do
+      it 'raises a NotImplementedError' do
+       expect{ klass.from_uri(RDF::URI('http://example.org/blah')) }.to raise_error NotImplementedError 
+      end
+    end
+
+    describe '#to_uri' do
+      it 'raises a NotImplementedError' do
+       expect{ subject.to_uri }.to raise_error NotImplementedError
+      end
+    end
+  end
+    
+  context 'with implementation' do
+    before do
+      class ActiveExample
+        attr_accessor :id
+        configure base_uri: 'http://example.org/ns/'
+
+        def self.from_uri(uri, *args)
+          item = self.new
+          item.parent = args.first unless args.empty? or args.first.is_a?(Hash)
+          item
+        end
+
+        def self.property(*args)
+          prop = args.first
+
+          define_method prop.to_s do 
+            resource.get_values(prop)
+          end
+
+          define_method "#{prop.to_s}=" do |*args|
+            resource.set_value(prop, *args)
+          end
+
+          resource_class.property(*args)
+        end
+
+      end
+
+      subject.id = '123'
+    end
+    
+    describe '::properties' do
+      before do
+        klass.property :title, :predicate => RDF::DC.title
+      end
+      it 'can be set' do
+        expect(klass.properties).to include 'title'
+      end
+
+      it 'sets property values' do
+        subject.title = 'Finn Family Moomintroll'
+        expect(subject.resource.title).to eq ['Finn Family Moomintroll']
+      end
+
+      it 'appends property values' do
+        subject.title << 'Finn Family Moomintroll'
+        expect(subject.resource.title).to eq ['Finn Family Moomintroll']
+      end
+      
+      it 'returns correct values in property getters' do
+        subject.resource.title = 'Finn Family Moomintroll'
+        expect(subject.title).to eq subject.resource.title
+      end
+
+      context 'with other identifiable classes' do
+        before do
+          class ActiveExampleTwo
+            include ActiveTriples::Identifiable
+          end
+        end
+        after do
+          Object.send(:remove_const, 'ActiveExampleTwo')
+        end
+
+        it 'does not effect other classes' do
+          klass.property :identifier, :predicate => RDF::DC.identifier
+          expect(ActiveExampleTwo.properties).to be_empty
+        end
+      end
+    end
+
+    describe '::configure' do
+      it 'allows configuration' do
+        klass.configure type: RDF::OWL.Thing
+        expect(subject.resource.type).to eq [RDF::OWL.Thing]
+      end
+    end
+
+    describe '#parent' do
+      it 'is nil' do
+        expect(subject.parent).to be_nil
+      end
+
+      context 'with relationships' do
+        include_context 'with data'
+        
+        it 'has a parent' do
+          expect(parent.relation.first.parent).to eq parent
+        end
+        
+        it 'has a parent after reload' do
+          parent.relation.node_cache = {}
+          expect(parent.relation.first.parent).to eq parent
+        end
+      end
+    end
+    
+    describe '#rdf_subject' do
+      it 'has a subject' do
+        expect(subject.rdf_subject).to eq 'http://example.org/ns/123'
+      end
+    end
+
+    describe '#to_uri' do
+      it 'has a subject' do
+        expect(subject.rdf_subject).to eq 'http://example.org/ns/123'
+      end
+    end
+  end
+end

data/spec/active_triples/properties_spec.rb

@@ -40,6 +40,35 @@ describe ActiveTriples::Properties do
     end
   end
 
+  describe '#config_for_term_or_uri' do
+    before do
+      DummyProperties.property :title, :predicate => RDF::DC.title
+    end
+
+    it 'finds property configuration by term symbol' do
+      expect(DummyProperties.config_for_term_or_uri(:title)).to eq DummyProperties.properties['title']
+    end
+
+    it 'finds property configuration by term string' do
+      expect(DummyProperties.config_for_term_or_uri('title')).to eq DummyProperties.properties['title']
+    end
+
+    it 'finds property configuration by term URI' do
+      expect(DummyProperties.config_for_term_or_uri(RDF::DC.title)).to eq DummyProperties.properties['title']
+    end
+  end
+
+  describe '#fields' do
+    before do
+      DummyProperties.property :title, :predicate => RDF::DC.title
+      DummyProperties.property :name, :predicate => RDF::FOAF.name
+    end
+
+    it 'lists its terms' do
+      expect(DummyProperties.fields).to eq [:title, :name]
+    end
+  end
+
   context "when using a subclass" do
     before do
       DummyProperties.property :title, :predicate => RDF::DC.title

data/spec/active_triples/resource_spec.rb

@@ -300,6 +300,61 @@ describe ActiveTriples::Resource do
     end
   end
 
+  describe 'array setters' do
+    before do 
+      DummyResource.property :aggregates, :predicate => RDF::DC.relation
+    end
+ 
+    it "should be empty array if we haven't set it" do
+      expect(subject.aggregates).to match_array([])
+    end
+    
+    it "should be set to a URI producing an ActiveTriple::Resource" do
+      subject.aggregates = RDF::URI("http://example.org/b1")
+      expect(subject.aggregates.first).to be_a ActiveTriples::Resource
+    end
+    
+    it "should be settable" do
+      subject.aggregates = RDF::URI("http://example.org/b1")
+      expect(subject.aggregates.first.rdf_subject).to eq RDF::URI("http://example.org/b1")
+      ['id']
+    end
+
+    context 'with values' do
+      let(:bib1) { RDF::URI("http://example.org/b1") }
+      let(:bib2) { RDF::URI("http://example.org/b2") }
+      let(:bib3) { RDF::URI("http://example.org/b3") }
+      
+      before do
+        subject.aggregates = bib1
+        subject.aggregates << bib2
+        subject.aggregates << bib3
+      end
+        
+      it 'raises error when trying to set nil value' do
+        expect { subject.aggregates[1] = nil }.to raise_error /value must be an RDF URI, Node, Literal, or a valid datatype/
+      end
+
+      it "should be changeable for multiple values" do
+        new_bib1 = RDF::URI("http://example.org/b1_NEW")
+        new_bib3 = RDF::URI("http://example.org/b3_NEW")
+        
+        aggregates = subject.aggregates.dup
+        aggregates[0] = new_bib1
+        aggregates[2] = new_bib3
+        subject.aggregates = aggregates
+        
+        expect(subject.aggregates[0].rdf_subject).to eq new_bib1
+        expect(subject.aggregates[1].rdf_subject).to eq bib2
+        expect(subject.aggregates[2].rdf_subject).to eq new_bib3
+      end
+
+      it "raises an error for out of bounds index" do
+        expect { subject.aggregates[4] = 'blah' }.to raise_error IndexError
+      end
+    end
+  end
+  
   describe 'child nodes' do
     it 'should return an object of the correct class when the value is a URI' do
       subject.license = DummyLicense.new('http://example.org/license')
@@ -325,6 +380,38 @@ describe ActiveTriples::Resource do
       end
     end
 
+    context "when given a URI" do
+      before do
+        subject.set_value(RDF::DC.title, RDF::URI("http://opaquenamespace.org/jokes/1"))
+      end
+      it "should return a resource" do
+        expect(subject.title.first).to be_kind_of(ActiveTriples::Resource)
+      end
+      context "and it's configured to not cast" do
+        before do
+          subject.class.property :title, predicate: RDF::DC.title, cast: false
+        end
+        it "should return a URI" do
+          expect(subject.title.first).to be_kind_of(RDF::URI)
+        end
+      end
+    end
+
+    it "safely handles terms passed in" do
+      vals = subject.get_values('license')
+      vals << "foo"
+      subject.set_value('license',vals)
+      expect(subject.get_values('license')).to eq ["foo"]
+    end
+ 
+    it "safely handles terms passed in with pre-existing values" do
+      subject.license = "foo"
+      vals = subject.get_values('license')
+      vals << "bar"
+      subject.set_value('license',vals)
+      expect(subject.get_values('license')).to eq ["foo","bar"]
+    end
+
     it 'should set a value in the when given a registered property symbol' do
       subject.set_value(:title, 'Comet in Moominland')
       expect(subject.title).to eq ['Comet in Moominland']
@@ -339,6 +426,7 @@ describe ActiveTriples::Resource do
       expect(subject.query(:subject => RDF::URI("http://opaquenamespace.org/jokes"), :predicate => RDF::DC.title).statements.to_a.length).to eq 1
     end
   end
+
   describe '#[]=' do
     it 'should set a value in the graph' do
       subject[RDF::DC.title] = 'Comet in Moominland'

data/spec/active_triples/term_spec.rb

@@ -11,7 +11,7 @@ describe ActiveTriples::Term do
     context "when term has 0 value arguments" do
       before { subject.value_arguments = double(length: 0) }
       it "should raise an error" do
-        expect { subject.rdf_subject }.to raise_error
+        expect { subject.send(:rdf_subject) }.to raise_error
       end
     end
     context "when term has 1 value argument" do
@@ -20,19 +20,22 @@ describe ActiveTriples::Term do
         subject.value_arguments = double(length: 1)
       end
       it "should call `rdf_subject' on the parent" do
-        expect(subject.rdf_subject).to eq "parent subject"
+        expect(subject.send(:rdf_subject) ).to eq "parent subject"
+      end
+      it " is a private method" do
+        expect { subject.rdf_subject }.to raise_error NoMethodError
       end
     end
     context "when term has 2 value arguments" do
       before { subject.value_arguments = double(length: 2, first: "first") }
       it "should return the first value argument" do
-        expect(subject.rdf_subject).to eq "first"
+        expect(subject.send(:rdf_subject) ).to eq "first"
       end
     end
     context "when term has 3 value arguments" do
       before { subject.value_arguments = double(length: 3) }
       it "should raise an error" do
-        expect { subject.rdf_subject }.to raise_error
+        expect { subject.send(:rdf_subject)  }.to raise_error
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active-triples
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Tom Johnson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-02 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdf
@@ -184,6 +184,7 @@ files:
 - lib/active/triples.rb
 - lib/active_triples.rb
 - lib/active_triples/configurable.rb
+- lib/active_triples/identifiable.rb
 - lib/active_triples/indexing.rb
 - lib/active_triples/list.rb
 - lib/active_triples/nested_attributes.rb
@@ -196,6 +197,7 @@ files:
 - lib/active_triples/term.rb
 - lib/active_triples/version.rb
 - spec/active_triples/configurable_spec.rb
+- spec/active_triples/identifiable_spec.rb
 - spec/active_triples/list_spec.rb
 - spec/active_triples/nested_attributes_spec.rb
 - spec/active_triples/properties_spec.rb