ld4l-open_annotation_rdf 0.0.4

data/spec/ld4l/open_annotation_rdf/semantic_tag_annotation_spec.rb

@@ -0,0 +1,619 @@
+require 'spec_helper'
+
+# TODO: Uses CommentBody as the annotation body, which is wrong.  Should be URI into controlled vocabulary.
+
+describe 'LD4L::OpenAnnotationRDF::SemanticTagAnnotation' do
+
+  subject { LD4L::OpenAnnotationRDF::SemanticTagAnnotation.new }
+
+  describe 'rdf_subject' do
+    it "should be a blank node if we haven't set it" do
+      expect(subject.rdf_subject.node?).to be true
+    end
+
+    it "should be settable when it has not been set yet" do
+      subject.set_subject! RDF::URI('http://example.org/moomin')
+      expect(subject.rdf_subject).to eq RDF::URI('http://example.org/moomin')
+    end
+
+    it "should append to base URI when setting to non-URI subject" do
+      subject.set_subject! '123'
+      expect(subject.rdf_subject).to eq RDF::URI("#{LD4L::OpenAnnotationRDF::SemanticTagAnnotation.base_uri}123")
+    end
+
+    describe 'when changing subject' do
+      before do
+        subject << RDF::Statement.new(subject.rdf_subject, RDF::DC.title, RDF::Literal('Comet in Moominland'))
+        subject << RDF::Statement.new(RDF::URI('http://example.org/moomin_comics'), RDF::DC.isPartOf, subject.rdf_subject)
+        subject << RDF::Statement.new(RDF::URI('http://example.org/moomin_comics'), RDF::DC.relation, 'http://example.org/moomin_land')
+        subject.set_subject! RDF::URI('http://example.org/moomin')
+      end
+
+      it 'should update graph subjects' do
+        expect(subject.has_statement?(RDF::Statement.new(subject.rdf_subject, RDF::DC.title, RDF::Literal('Comet in Moominland')))).to be true
+      end
+
+      it 'should update graph objects' do
+        expect(subject.has_statement?(RDF::Statement.new(RDF::URI('http://example.org/moomin_comics'), RDF::DC.isPartOf, subject.rdf_subject))).to be true
+      end
+
+      it 'should leave other uris alone' do
+        expect(subject.has_statement?(RDF::Statement.new(RDF::URI('http://example.org/moomin_comics'), RDF::DC.relation, 'http://example.org/moomin_land'))).to be true
+      end
+    end
+
+    describe 'created with URI subject' do
+      before do
+        subject.set_subject! RDF::URI('http://example.org/moomin')
+      end
+
+      it 'should not be settable' do
+        expect{ subject.set_subject! RDF::URI('http://example.org/moomin2') }.to raise_error
+      end
+    end
+  end
+
+
+  # -------------------------------------------------
+  #  START -- Test attributes specific to this model
+  # -------------------------------------------------
+
+  describe 'type' do
+    it "should be an RDFVocabularies::OA.Annotation" do
+      expect(subject.type.first.value).to eq RDFVocabularies::OA.Annotation.value
+    end
+  end
+
+  describe 'hasTarget' do
+    it "should be empty array if we haven't set it" do
+      expect(subject.hasTarget).to match_array([])
+    end
+
+    it "should be settable" do
+      subject.hasTarget = RDF::URI("http://example.org/b123")
+      expect(subject.hasTarget.first.rdf_subject.to_s).to eq "http://example.org/b123"
+    end
+
+    it "should be changeable" do
+      subject.hasTarget = RDF::URI("http://example.org/b123")
+      subject.hasTarget = RDF::URI("http://example.org/b123_NEW")
+      expect(subject.hasTarget.first.rdf_subject.to_s).to eq "http://example.org/b123_NEW"
+    end
+  end
+
+  describe 'hasBody' do
+    # NOTE: Preferred method to set body is to use setTerm method which will
+    #       create the appropriate annotation body object and triples.
+    it "should be empty array if we haven't set it" do
+      expect(subject.hasBody).to match_array([])
+    end
+
+    it "should be settable" do
+      subject.hasBody = RDF::URI("http://example.org/cv/term/t123")
+      expect(subject.hasBody.first.rdf_subject.to_s).to eq "http://example.org/cv/term/t123"
+    end
+
+    it "should be changeable" do
+      subject.hasBody = RDF::URI("http://example.org/cv/term/t123")
+      subject.hasBody = RDF::URI("http://example.org/cv/term/t123_NEW")
+      expect(subject.hasBody.first.rdf_subject.to_s).to eq "http://example.org/cv/term/t123_NEW"
+    end
+  end
+
+  describe '#setTerm' do
+    before do
+      @repo = RDF::Repository.new
+      allow(subject.class).to receive(:repository).and_return(nil)
+      allow(subject).to receive(:repository).and_return(@repo)
+    end
+
+    context "when new value is nil" do
+      it "should throw invalid arguement exception" do
+        expect{ subject.setTerm(nil) }.to raise_error
+      end
+    end
+
+    context "when new value is a string of 0 length" do
+      it "should throw invalid arguement exception" do
+        expect{ subject.setTerm("") }.to raise_error
+      end
+    end
+
+    context "when new value is not a string or uri" do
+      it "should throw invalid arguement exception" do
+        expect{ subject.setTerm(3) }.to raise_error
+      end
+    end
+
+    context "when new value is same as old value" do
+      it "should return the existing TagBody unchanged" do
+        tb1 = subject.setTerm('http://example.org/new_term')
+        tb2 = subject.setTerm('http://example.org/new_term')
+        expect(tb2).to eq tb1
+      end
+    end
+
+    context "when term doesn't already exist as a SemanticTagBody" do
+      before do
+        stb = LD4L::OpenAnnotationRDF::SemanticTagBody.new('http://example.org/new_term')
+        expect(stb).not_to be_persisted
+      end
+      it "should create an instance of LD4L::OpenAnnotationRDF::SemanticTagBody and set hasBody property to term URI" do
+        subject.setTerm('http://example.org/new_term')
+        expect(subject.hasBody.first.rdf_subject).to be_kind_of RDF::URI
+        expect(subject.hasBody.first.rdf_subject.to_s).to eq 'http://example.org/new_term'
+        stb = LD4L::OpenAnnotationRDF::SemanticTagBody.new('http://example.org/new_term')
+        expect(stb).not_to be_persisted
+        expect(subject.getBody).to be_kind_of LD4L::OpenAnnotationRDF::SemanticTagBody
+        expect(subject.getBody.rdf_subject.to_s).to eq 'http://example.org/new_term'
+        expect(subject.getBody).not_to be_persisted
+      end
+    end
+
+    context "when term already exists as a SemanticTagBody" do
+      before do
+        stb = LD4L::OpenAnnotationRDF::SemanticTagBody.new('http://example.org/existing_term')
+        stb.persist!
+        expect(stb).to be_persisted
+      end
+      it "should resume the existing LD4L::OpenAnnotationRDF::SemanticTagBody and set hasBody property to it" do
+        subject.setTerm('http://example.org/existing_term')
+        stb = LD4L::OpenAnnotationRDF::SemanticTagBody.new('http://example.org/existing_term')
+        expect(stb).to be_persisted
+        expect(subject.hasBody.first.rdf_subject).to be_kind_of RDF::URI
+        expect(subject.hasBody.first.rdf_subject.to_s).to eq 'http://example.org/existing_term'
+        expect(subject.getBody).to be_kind_of LD4L::OpenAnnotationRDF::SemanticTagBody
+        expect(subject.getBody.rdf_subject.to_s).to eq 'http://example.org/existing_term'
+        # NOTE: body is considered not persisted because it's parent, the annotation, is not persisted
+        expect(subject.getBody).not_to be_persisted
+      end
+    end
+  end
+
+  describe 'annotatedBy' do
+    it "should be empty array if we haven't set it" do
+      expect(subject.annotatedBy).to match_array([])
+    end
+
+    it "should be settable" do
+      a_person = LD4L::FoafRDF::Person.new('1')
+      subject.annotatedBy = a_person
+      expect(subject.annotatedBy.first).to eq a_person
+    end
+
+    it "should be changeable" do
+      orig_person = LD4L::FoafRDF::Person.new('1')
+      new_person = LD4L::FoafRDF::Person.new('2')
+      subject.annotatedBy = orig_person
+      subject.annotatedBy = new_person
+      expect(subject.annotatedBy.first).to eq new_person
+    end
+  end
+
+  describe 'annotatedAt' do
+    it "should be empty array if we haven't set it" do
+      expect(subject.annotatedAt).to match_array([])
+    end
+
+    it "should be settable" do
+      a_time = Time::now.strftime("%Y-%m-%dT%H:%M:%S.%L%z")
+      subject.annotatedAt = a_time
+      expect(subject.annotatedAt.first).to eq a_time
+    end
+
+    it "should be changeable" do
+      orig_time = Time.local(2014, 6, 1, 8, 30).strftime("%Y-%m-%dT%H:%M:%S.%L%z")
+      new_time = Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%z")
+      subject.annotatedAt = orig_time
+      subject.annotatedAt = new_time
+      expect(subject.annotatedAt.first).to eq new_time
+    end
+  end
+
+  describe 'motivatedBy' do
+    it "should be OA.tagging if we haven't set it" do
+      expect(subject.motivatedBy.first.rdf_subject.to_s).to eq RDFVocabularies::OA.tagging
+    end
+
+    it "should be settable" do
+      subject.motivatedBy = RDFVocabularies::OA.describing
+      expect(subject.motivatedBy.first.rdf_subject.to_s).to eq RDFVocabularies::OA.describing
+    end
+
+    it "should be changeable" do
+      subject.motivatedBy = RDFVocabularies::OA.describing
+      subject.motivatedBy = RDFVocabularies::OA.classifying
+      expect(subject.motivatedBy.first.rdf_subject.to_s).to eq RDFVocabularies::OA.classifying
+    end
+  end
+
+  describe '#localname_prefix' do
+    it "should return default prefix" do
+      prefix = LD4L::OpenAnnotationRDF::SemanticTagAnnotation.localname_prefix
+      expect(prefix).to eq "sta"
+    end
+  end
+
+  # -----------------------------------------------
+  #  END -- Test attributes specific to this model
+  # -----------------------------------------------
+
+
+  describe "#persisted?" do
+    context 'with a repository' do
+      before do
+        # Create inmemory repository
+        repository = RDF::Repository.new
+        allow(subject).to receive(:repository).and_return(repository)
+      end
+
+      context "when the object is new" do
+        it "should return false" do
+          expect(subject).not_to be_persisted
+        end
+      end
+
+      context "when it is saved" do
+        before do
+          subject.motivatedBy = RDFVocabularies::OA.commenting
+          subject.persist!
+        end
+
+        it "should return true" do
+          expect(subject).to be_persisted
+        end
+
+        context "and then modified" do
+          before do
+            subject.motivatedBy = RDFVocabularies::OA.tagging
+          end
+
+          it "should return true" do
+            expect(subject).to be_persisted
+          end
+        end
+        context "and then reloaded" do
+          before do
+            subject.reload
+          end
+
+          it "should reset the motivatedBy" do
+            expect(subject.motivatedBy.first.rdf_subject.to_s).to eq RDFVocabularies::OA.commenting.to_s
+          end
+
+          it "should be persisted" do
+            expect(subject).to be_persisted
+          end
+        end
+      end
+    end
+  end
+
+  describe "#persist!" do
+    context "when the repository is set" do
+      context "and the item is not a blank node" do
+
+        subject {LD4L::OpenAnnotationRDF::SemanticTagAnnotation.new("123")}
+
+        before do
+          # Create inmemory repository
+          @repo = RDF::Repository.new
+          allow(subject.class).to receive(:repository).and_return(nil)
+          allow(subject).to receive(:repository).and_return(@repo)
+          subject.motivatedBy = RDFVocabularies::OA.commenting
+          subject.persist!
+        end
+
+        it "should persist to the repository" do
+          expect(@repo.statements.first).to eq subject.statements.first
+        end
+
+        it "should delete from the repository" do
+          subject.reload
+          expect(subject.motivatedBy.first.rdf_subject.to_s).to eq RDFVocabularies::OA.commenting.to_s
+          subject.motivatedBy = []
+          expect(subject.motivatedBy).to eq []
+          subject.persist!
+          subject.reload
+          expect(subject.annotatedAt).to eq []
+          expect(@repo.statements.to_a.length).to eq 1 # Only the type statement
+        end
+
+        context "when body is set" do
+          before do
+            subject.setTerm('http://example.org/new_term2')
+            subject.persist!
+          end
+          it "should persist body to the repository" do
+            stb = LD4L::OpenAnnotationRDF::SemanticTagBody.new(subject.getBody.rdf_subject)
+            expect(stb).to be_persisted
+            stb = LD4L::OpenAnnotationRDF::SemanticTagBody.new('http://example.org/new_term2')
+            expect(stb).to be_persisted
+            expect(subject.getBody.rdf_subject.to_s).to eq 'http://example.org/new_term2'
+          end
+        end
+      end
+    end
+  end
+
+  describe '#destroy!' do
+    before do
+      subject << RDF::Statement(RDF::DC.LicenseDocument, RDF::DC.title, 'LICENSE')
+    end
+
+    subject { LD4L::OpenAnnotationRDF::SemanticTagAnnotation.new('123') }
+
+    it 'should return true' do
+      expect(subject.destroy!).to be true
+      expect(subject.destroy).to be true
+    end
+
+    it 'should delete the graph' do
+      subject.destroy
+      expect(subject).to be_empty
+    end
+
+    context 'with a parent' do
+      before do
+        subject.annotatedBy = child
+      end
+
+      let(:child) do
+        LD4L::FoafRDF::Person.new('456')
+      end
+
+      it 'should empty the graph and remove it from the parent' do
+        child.destroy
+        expect(subject.annotatedBy).to be_empty
+      end
+
+      it 'should remove its whole graph from the parent' do
+        child.destroy
+        child.each_statement do |s|
+          expect(subject.statements).not_to include s
+        end
+      end
+    end
+
+    context 'with annotation body' do
+      before do
+        subject.setTerm('http://example.org/new_term3')
+      end
+
+      context 'and body is set on the annotation' do
+        let(:child) do
+          subject.getBody
+        end
+
+        it 'should empty the graph and remove it from the parent' do
+          child.destroy
+          expect(subject.hasBody).to be_empty
+        end
+
+        it 'should remove its whole graph from the parent' do
+          child.destroy
+          child.each_statement do |s|
+            expect(subject.statements).not_to include s
+          end
+        end
+      end
+    end
+  end
+
+  describe 'attributes' do
+    before do
+      subject.annotatedBy = annotatedBy
+      subject.motivatedBy = 'commenting'
+    end
+
+    subject {LD4L::OpenAnnotationRDF::SemanticTagAnnotation.new("123")}
+
+    let(:annotatedBy) { LD4L::FoafRDF::Person.new('456') }
+
+    it 'should return an attributes hash' do
+      expect(subject.attributes).to be_a Hash
+    end
+
+    it 'should contain data' do
+      expect(subject.attributes['motivatedBy']).to eq ['commenting']
+    end
+
+    it 'should contain child objects' do
+      expect(subject.attributes['annotatedBy']).to eq [annotatedBy]
+    end
+
+    context 'with unmodeled data' do
+      before do
+        subject << RDF::Statement(subject.rdf_subject, RDF::DC.contributor, 'Tove Jansson')
+        subject << RDF::Statement(subject.rdf_subject, RDF::DC.relation, RDF::URI('http://example.org/moomi'))
+        node = RDF::Node.new
+        subject << RDF::Statement(RDF::URI('http://example.org/moomi'), RDF::DC.relation, node)
+        subject << RDF::Statement(node, RDF::DC.title, 'bnode')
+      end
+
+      it 'should include data with URIs as attribute names' do
+        expect(subject.attributes[RDF::DC.contributor.to_s]).to eq ['Tove Jansson']
+      end
+
+      it 'should return generic Resources' do
+        expect(subject.attributes[RDF::DC.relation.to_s].first).to be_a ActiveTriples::Resource
+      end
+
+      it 'should build deep data for Resources' do
+        expect(subject.attributes[RDF::DC.relation.to_s].first.get_values(RDF::DC.relation).
+                   first.get_values(RDF::DC.title)).to eq ['bnode']
+      end
+
+      it 'should include deep data in serializable_hash' do
+        expect(subject.serializable_hash[RDF::DC.relation.to_s].first.get_values(RDF::DC.relation).
+                   first.get_values(RDF::DC.title)).to eq ['bnode']
+      end
+    end
+
+    describe 'attribute_serialization' do
+      describe '#to_json' do
+        it 'should return a string with correct objects' do
+          json_hash = JSON.parse(subject.to_json)
+          expect(json_hash['annotatedBy'].first['id']).to eq annotatedBy.rdf_subject.to_s
+        end
+      end
+    end
+  end
+
+  describe 'property methods' do
+    it 'should set and get properties' do
+      subject.motivatedBy = 'commenting'
+      expect(subject.motivatedBy).to eq ['commenting']
+    end
+  end
+
+  describe 'child nodes' do
+    it 'should return an object of the correct class when the value is built from the base URI' do
+      subject.annotatedBy = LD4L::FoafRDF::Person.new('456')
+      expect(subject.annotatedBy.first).to be_kind_of LD4L::FoafRDF::Person
+    end
+
+    it 'should return an object with the correct URI when created with a URI' do
+      subject.annotatedBy = LD4L::FoafRDF::Person.new("http://vivo.cornell.edu/individual/JohnSmith")
+      expect(subject.annotatedBy.first.rdf_subject).to eq RDF::URI("http://vivo.cornell.edu/individual/JohnSmith")
+    end
+
+    it 'should return an object of the correct class when the value is a bnode' do
+      subject.annotatedBy = LD4L::FoafRDF::Person.new
+      expect(subject.annotatedBy.first).to be_kind_of LD4L::FoafRDF::Person
+    end
+  end
+
+  describe '#type' do
+    it 'should return the type configured on the parent class' do
+      expect(subject.type).to eq [LD4L::OpenAnnotationRDF::SemanticTagAnnotation.type]
+    end
+
+    it 'should set the type' do
+      subject.type = RDF::URI('http://example.org/AnotherClass')
+      expect(subject.type).to eq [RDF::URI('http://example.org/AnotherClass')]
+    end
+
+    it 'should be the type in the graph' do
+      subject.query(:subject => subject.rdf_subject, :predicate => RDF.type).statements do |s|
+        expect(s.object).to eq RDF::URI('http://example.org/AnotherClass')
+      end
+    end
+  end
+
+  describe '#rdf_label' do
+    subject {LD4L::OpenAnnotationRDF::SemanticTagAnnotation.new("123")}
+
+    it 'should return an array of label values' do
+      expect(subject.rdf_label).to be_kind_of Array
+    end
+
+    it 'should return the default label as URI when no title property exists' do
+      expect(subject.rdf_label).to eq [RDF::URI("#{LD4L::OpenAnnotationRDF::SemanticTagAnnotation.base_uri}123")]
+    end
+
+    it 'should prioritize configured label values' do
+      custom_label = RDF::URI('http://example.org/custom_label')
+      subject.class.configure :rdf_label => custom_label
+      subject << RDF::Statement(subject.rdf_subject, custom_label, RDF::Literal('New Label'))
+      expect(subject.rdf_label).to eq ['New Label']
+    end
+  end
+
+  describe '#solrize' do
+    it 'should return a label for bnodes' do
+      expect(subject.solrize).to eq subject.rdf_label
+    end
+
+    it 'should return a string of the resource uri' do
+      subject.set_subject! 'http://example.org/moomin'
+      expect(subject.solrize).to eq 'http://example.org/moomin'
+    end
+  end
+
+  describe 'editing the graph' do
+    it 'should write properties when statements are added' do
+      subject << RDF::Statement.new(subject.rdf_subject, RDFVocabularies::OA.motivatedBy, 'commenting')
+      expect(subject.motivatedBy).to include 'commenting'
+    end
+
+    it 'should delete properties when statements are removed' do
+      subject << RDF::Statement.new(subject.rdf_subject, RDFVocabularies::OA.annotatedBy, 'John Smith')
+      subject.delete RDF::Statement.new(subject.rdf_subject, RDFVocabularies::OA.annotatedBy, 'John Smith')
+      expect(subject.annotatedBy).to eq []
+    end
+  end
+
+  describe 'big complex graphs' do
+    before do
+      class DummyPerson < ActiveTriples::Resource
+        configure :type => RDF::URI('http://example.org/Person')
+        property :foafname, :predicate => RDF::FOAF.name
+        property :publications, :predicate => RDF::FOAF.publications, :class_name => 'DummyDocument'
+        property :knows, :predicate => RDF::FOAF.knows, :class_name => DummyPerson
+      end
+
+      class DummyDocument < ActiveTriples::Resource
+        configure :type => RDF::URI('http://example.org/Document')
+        property :title, :predicate => RDF::DC.title
+        property :creator, :predicate => RDF::DC.creator, :class_name => 'DummyPerson'
+      end
+
+      LD4L::OpenAnnotationRDF::SemanticTagAnnotation.property :item, :predicate => RDF::DC.relation, :class_name => DummyDocument
+    end
+
+    subject { LD4L::OpenAnnotationRDF::SemanticTagAnnotation.new }
+
+    let (:document1) do
+      d = DummyDocument.new
+      d.title = 'Document One'
+      d
+    end
+
+    let (:document2) do
+      d = DummyDocument.new
+      d.title = 'Document Two'
+      d
+    end
+
+    let (:person1) do
+      p = DummyPerson.new
+      p.foafname = 'Alice'
+      p
+    end
+
+    let (:person2) do
+      p = DummyPerson.new
+      p.foafname = 'Bob'
+      p
+    end
+
+    let (:data) { <<END
+_:1 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/SomeClass> .
+_:1 <http://purl.org/dc/terms/relation> _:2 .
+_:2 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/Document> .
+_:2 <http://purl.org/dc/terms/title> "Document One" .
+_:2 <http://purl.org/dc/terms/creator> _:3 .
+_:2 <http://purl.org/dc/terms/creator> _:4 .
+_:4 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/Person> .
+_:4 <http://xmlns.com/foaf/0.1/name> "Bob" .
+_:3 <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://example.org/Person> .
+_:3 <http://xmlns.com/foaf/0.1/name> "Alice" .
+_:3 <http://xmlns.com/foaf/0.1/knows> _:4 ."
+END
+    }
+
+    after do
+      Object.send(:remove_const, "DummyDocument")
+      Object.send(:remove_const, "DummyPerson")
+    end
+
+    it 'should allow access to deep nodes' do
+      document1.creator = [person1, person2]
+      document2.creator = person1
+      person1.knows = person2
+      subject.item = [document1]
+      expect(subject.item.first.creator.first.knows.first.foafname).to eq ['Bob']
+    end
+  end
+end