dbd 0.0.1

data/spec/factories/provenance_resource.rb

@@ -0,0 +1,16 @@
+module Factories
+  module ProvenanceResource
+
+    def self.factory_for
+      ::Dbd::ProvenanceResource
+    end
+
+    def self.provenance_resource
+      factory_for.new.tap do |resource|
+        resource << Factories::ProvenanceFact.context
+        resource << Factories::ProvenanceFact.created_by
+      end
+    end
+
+  end
+end

data/spec/factories/resource.rb

@@ -0,0 +1,17 @@
+module Factories
+  module Resource
+
+    def self.factory_for
+      ::Dbd::Resource
+    end
+
+    def self.facts_resource(provenance_subject)
+      subject = Fact.new_subject
+      factory_for.new(subject: subject, provenance_subject: provenance_subject).tap do |resource|
+        resource << Factories::Fact.data_fact(provenance_subject, subject)
+        resource << Factories::Fact.data_fact_EU(provenance_subject, subject)
+      end
+    end
+
+  end
+end

data/spec/lib/dbd/fact/collection_spec.rb

@@ -0,0 +1,236 @@
+require 'spec_helper'
+
+module Dbd
+  class Fact
+    describe Collection do
+
+      let(:provenance_subject_1) { ProvenanceFact.new_subject }
+      let(:provenance_subject_2) { ProvenanceFact.new_subject }
+
+      let(:provenance_fact_context) { Factories::ProvenanceFact.context(provenance_subject_1) }
+      let(:provenance_fact_created_by) { Factories::ProvenanceFact.created_by(provenance_subject_1) }
+      let(:provenance_fact_original_source) { Factories::ProvenanceFact.original_source(provenance_subject_2) }
+
+      let(:fact_1) { Factories::Fact.fact_1(provenance_subject_1) }
+      let(:fact_2_with_subject) { Factories::Fact.fact_2_with_subject(provenance_subject_1) }
+      let(:fact_3_with_subject) { Factories::Fact.fact_3_with_subject(provenance_subject_1) }
+
+      let(:fact_2_3) { Factories::Fact::Collection.fact_2_3(provenance_subject_1) }
+      let(:provenance_facts) { Factories::Fact::Collection.provenance_facts(provenance_subject_1) }
+
+      let(:subject) do
+        Object.new.tap do |object_with_Fact_Collection|
+          object_with_Fact_Collection.extend(described_class)
+          object_with_Fact_Collection.send(:initialize)
+        end
+      end
+
+      describe ".new : " do
+        it "the collection is not an array" do
+          subject.should_not be_a(Array)
+        end
+
+        it "the collection has Enumerable methods" do
+          subject.map #should_not raise_exception
+        end
+      end
+
+      describe ".methods : " do
+
+        describe "#<< : " do
+          it "adding a fact works" do
+            subject << fact_2_with_subject
+            subject.size.should == 1
+          end
+
+          it "adding a provenance_fact works" do
+            subject << provenance_fact_context
+            subject.size.should == 1
+          end
+
+          it "returns self to allow chaining" do
+            (subject << provenance_fact_context).should == subject
+          end
+        end
+
+        it "#first should be a Fact" do
+          subject << fact_2_with_subject
+          subject.first.should be_a(Fact)
+        end
+
+        it "other functions (e.g. []) do not work" do
+          subject << fact_2_with_subject
+          lambda { subject[0] } . should raise_exception NoMethodError
+        end
+
+        it "#<< returns self, so chaining is possible" do
+          (subject << fact_2_with_subject).should == subject
+        end
+      end
+
+      describe "adding a fact with a ref to a provenance_fact" do
+
+        it "fact_2_with_subject has a provenance_subject that refers to context and created_by" do
+          subject << provenance_fact_context
+          subject << provenance_fact_created_by
+          subject << fact_2_with_subject
+          ps = fact_1.provenance_subject
+          subject.by_subject(ps).should == [provenance_fact_context, provenance_fact_created_by]
+        end
+      end
+
+      describe "newest_time_stamp" do
+        it "returns nil for empty collection" do
+          subject.newest_time_stamp.should be_nil
+        end
+
+        it "returns a time_stamp" do
+          subject << fact_2_with_subject
+          subject.newest_time_stamp.should be_a(fact_2_with_subject.time_stamp.class)
+        end
+
+        it "returns the newest time_stamp" do
+          subject << fact_2_with_subject
+          subject << fact_3_with_subject
+          subject.newest_time_stamp.should == fact_3_with_subject.time_stamp
+        end
+      end
+
+      describe "validate that only 'newer' elements are added" do
+        before(:each) do
+          fact_2_with_subject.stub(:time_stamp).and_return(Time.new(2013,05,9,12,0,0))
+          fact_3_with_subject.stub(:time_stamp).and_return(Time.new(2013,05,9,12,0,1))
+        end
+
+        it "adding an element with a newer time_stamp succeeds" do
+          subject << fact_2_with_subject
+          subject << fact_3_with_subject
+        end
+
+        it "adding an element with an older time_stamp fails" do
+          fact_2_with_subject # will be older then fact_3_with_subject
+          subject << fact_3_with_subject
+          lambda { subject << fact_2_with_subject } . should raise_error OutOfOrderError
+        end
+
+        it "adding an element with an equal time_stamp fails" do
+          subject << fact_2_with_subject
+          lambda { subject << fact_2_with_subject } . should raise_error OutOfOrderError
+        end
+      end
+
+      describe "oldest_time_stamp" do
+        it "returns nil for empty collection" do
+          subject.oldest_time_stamp.should be_nil
+        end
+
+        it "returns a time_stamp" do
+          subject << fact_2_with_subject
+          subject.oldest_time_stamp.should be_a(fact_2_with_subject.time_stamp.class)
+        end
+
+        it "returns the oldest time_stamp" do
+          subject << fact_2_with_subject
+          subject << fact_3_with_subject
+          subject.oldest_time_stamp.should == fact_2_with_subject.time_stamp
+        end
+      end
+
+      describe "provenance_facts must all come before first use by a fact" do
+        it "adding a provenance_fact, depending fact, another provenance_fact with same subject fail" do
+          subject << provenance_fact_context
+          subject << fact_2_with_subject
+          lambda { subject << provenance_fact_created_by } . should raise_error OutOfOrderError
+        end
+
+        # testing private functionality (kept temporarily as documentation)
+        # A hash with all the provenance_subjects that are used by at least one fact.
+        # Needed for the validation that no provenance_fact may be added that is
+        # referred from a fact that is already in the fact stream.
+        describe "used_provenance_subjects" do
+          # testing an internal variable ...
+
+          let(:used_provenance_subjects) do
+            subject.instance_variable_get(:@used_provenance_subjects)
+          end
+
+          it "is empty initially" do
+            used_provenance_subjects.should be_empty
+          end
+
+          it "adding a provenance_fact alone does not create an entry" do
+            subject << provenance_fact_context
+            used_provenance_subjects.should be_empty
+          end
+
+          it "adding a provenance_fact and a depending fact create an entry" do
+            subject << provenance_fact_context
+            subject << fact_2_with_subject
+            used_provenance_subjects[provenance_subject_1].should == true
+          end
+        end
+      end
+
+      describe "validate that facts are valid? when loading in the Fact::Collection" do
+        it "succeeds with a fact from factory" do
+           subject << fact_2_with_subject # should_not raise_error
+        end
+
+        it "raises FactError when fact.valid? is false" do
+           provenance_fact_context.stub(:valid?).and_return(false)
+           lambda { subject << provenance_fact_context } . should raise_error FactError
+        end
+      end
+
+      describe "by_subject : " do
+        it "finds entries for a given subject" do
+          subject << provenance_fact_context
+          subject << provenance_fact_created_by
+          subject << provenance_fact_original_source
+          provenance_fact_context.subject.should == provenance_subject_1 # assert test set-up
+          provenance_fact_created_by.subject.should == provenance_subject_1 # assert test set-up
+          provenance_fact_original_source.subject.should == provenance_subject_2 # assert test set-up
+          subject.by_subject(provenance_subject_1).first.should == provenance_fact_context
+          subject.by_subject(provenance_subject_1).last.should == provenance_fact_created_by
+          subject.by_subject(provenance_subject_2).single.should == provenance_fact_original_source
+        end
+      end
+
+      describe "Factories::Fact::Collection" do
+        describe ".fact_2_3" do
+          it "has the given provenance_subject with explicit subject arg" do
+            fact_2_3.each do |fact|
+              fact.provenance_subject.should == provenance_subject_1
+            end
+          end
+        end
+
+        describe ".provenance_facts" do
+          it "has a context" do
+            provenance_facts.select do |provenance_fact|
+              provenance_fact.predicate == "https://data.vandenabeele.com/ontologies/provenance#context"
+            end.size.should == 1
+          end
+
+          it "has a created_by" do
+            provenance_facts.select do |provenance_fact|
+              provenance_fact.predicate == "https://data.vandenabeele.com/ontologies/provenance#created_by"
+            end.size.should == 1
+          end
+
+          it "has an original_source" do
+            provenance_facts.select do |provenance_fact|
+              provenance_fact.predicate == "https://data.vandenabeele.com/ontologies/provenance#original_source"
+            end.size.should == 1
+          end
+
+          it "has the given subjects with explicit subject arg" do
+            provenance_facts.each do |provenance_fact|
+              provenance_fact.subject.should == provenance_subject_1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/dbd/fact/id_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module Dbd
+  class Fact
+    describe ID do
+      it ".new creates an ID" do
+        subject.should be_a(described_class)
+      end
+
+      it "#to_s is a UUID string" do
+        subject.to_s.should match(Helpers::UUID.regexp)
+      end
+
+      it ".regexp has a regexp for the to_s" do
+        described_class.regexp.should == Helpers::UUID.regexp
+      end
+    end
+  end
+end

data/spec/lib/dbd/fact/subject_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module Dbd
+  class Fact
+    describe Subject do
+      it ".new creates a Subject" do
+        subject.should be_a(described_class)
+      end
+
+      it "#to_s is a UUID string" do
+        subject.to_s.should match(Helpers::UUID.regexp)
+      end
+
+      it ".regexp has a regexp for the to_s" do
+        described_class.regexp.should == Helpers::UUID.regexp
+      end
+    end
+  end
+end

data/spec/lib/dbd/fact_spec.rb

@@ -0,0 +1,217 @@
+require 'spec_helper'
+
+module Dbd
+  describe Fact do
+    let(:provenance_subject) { ProvenanceFact.new_subject }
+    let(:subject) { described_class.new_subject }
+    let(:data_predicate)  { "http://example.org/test/name" }
+    let(:string_object_1)  { "Gandhi" }
+    let(:string_object_2)  { "Mandela" }
+    let(:id_class) { Fact::ID }
+    let(:subject_class) { Fact::Subject }
+    let(:fact_1) { Factories::Fact.fact_1(provenance_subject) }
+    let(:fact_2_with_subject) { Factories::Fact.fact_2_with_subject(provenance_subject) }
+
+    describe ".new_subject" do
+      it "creates a new (random) subject" do
+        described_class.new_subject.should be_a(subject_class)
+      end
+
+      it "creating a second one is different" do
+        subject_1 = described_class.new_subject
+        subject_2 = described_class.new_subject
+        subject_1.should_not == subject_2
+      end
+    end
+
+    describe "create a fact" do
+      it "has a unique id (id_class)" do
+        fact_1.id.should be_a(id_class)
+      end
+
+      it "two facts have different id" do
+        fact_1.id.should_not == fact_2_with_subject.id
+      end
+
+      it "new sets the provenance_subject" do
+        fact_1.provenance_subject.should == provenance_subject
+      end
+
+      it "new sets the subject" do
+        fact_2_with_subject.subject.should be_a(subject_class)
+      end
+
+      it "a nil predicate raises PredicateError" do
+        lambda do
+          described_class.new(
+            predicate: nil,
+            object: string_object_1)
+        end . should raise_error PredicateError
+      end
+
+      it "a nil object raises ObjectError" do
+        lambda do
+          described_class.new(
+            predicate: data_predicate,
+            object: nil)
+        end . should raise_error ObjectError
+      end
+    end
+
+    describe "time_stamp" do
+      it "can be set after creation" do
+        fact_1.time_stamp = Time.now
+      end
+
+      it "can be read back" do
+        time_now = Time.now
+        fact_1.time_stamp = time_now
+        fact_1.time_stamp.should == time_now
+      end
+
+      it "sees a difference of 2 nanoseconds" do
+        time_now = Time.now
+        fact_1.time_stamp = time_now + 0.000_000_002
+        fact_1.time_stamp.should > time_now
+      end
+
+      it "raise a RuntimeError if trying to write it 2 times" do
+        time_now = Time.now
+        fact_1.time_stamp = time_now
+        lambda { fact_1.time_stamp = time_now } . should raise_error RuntimeError
+      end
+    end
+
+    describe "valid?" do
+      it "the factory is valid?" do
+        fact_2_with_subject.should be_valid
+      end
+
+      it "without provenance_subject is not valid?" do
+        fact_2_with_subject.stub(:provenance_subject).and_return(nil)
+        fact_2_with_subject.should_not be_valid
+      end
+
+      it "without subject is not valid?" do
+        fact_2_with_subject.stub(:subject).and_return(nil)
+        fact_2_with_subject.should_not be_valid
+      end
+    end
+
+    describe "create fact_1" do
+      describe "with a string object type" do
+        it "new sets the predicate" do
+          fact_1.predicate.should == data_predicate
+        end
+
+        it "new sets the object" do
+          fact_1.object.should == string_object_1
+        end
+      end
+    end
+
+    describe "attributes and values" do
+      it "there are 6 attributes" do
+        described_class.attributes.size.should == 6
+      end
+
+      it "first attribute is :id" do
+        described_class.attributes.first.should == :id
+      end
+
+      it "there are 6 values" do
+        fact_1.values.size.should == 6
+      end
+    end
+
+    describe "#dup_with_subject" do
+
+      let (:new_fact) do
+        fact_1.dup_with_subject(subject)
+      end
+
+      it "is a different instance" do
+        new_fact.should_not be_equal(fact_1)
+      end
+
+      it "is from the same class" do
+        new_fact.should be_a(fact_1.class)
+      end
+
+      it "has copied over the other attributes except :id, :time_stamp" do
+        (fact_1.class.attributes - [:id, :time_stamp, :subject]).each do |attr|
+           new_fact.send(attr).should == fact_1.send(attr)
+         end
+      end
+
+      it "has set the subject to the Resource subject" do
+        fact_1.subject.should_not == new_fact.subject # double check
+        new_fact.subject.should == subject
+      end
+    end
+
+    describe "update_used_provenance_subjects" do
+      it "sets the value for provenance_subject to true for a fact" do
+        h = {}
+        fact_1.update_used_provenance_subjects(h)
+        h[fact_1.provenance_subject].should == true
+      end
+    end
+
+    describe "factory works" do
+      it "with explicit provenance_subject" do
+        fact_2_with_subject.provenance_subject.should be_a(provenance_subject.class)
+        fact_2_with_subject.subject.should be_a(subject.class)
+        fact_2_with_subject.predicate.should be_a(data_predicate.class)
+        fact_2_with_subject.object.should be_a(string_object_1.class)
+      end
+
+      it "without explicit provenance_subject" do
+        Factories::Fact.fact_1.provenance_subject.should be_nil
+      end
+
+      it "fact_2_with_subject should not raise_error" do
+        Factories::Fact.fact_2_with_subject
+      end
+
+      it "fact_3_with_subject should not raise_error" do
+        Factories::Fact.fact_3_with_subject
+      end
+
+      describe "data_fact" do
+        describe "without arguments" do
+          it "has empty provenance_subject" do
+            Factories::Fact.data_fact.provenance_subject.should be_nil
+          end
+
+          it "has empty subject" do
+            Factories::Fact.data_fact.subject.should be_nil
+          end
+        end
+
+        describe "with provenance_subject" do
+          it "has provenance_subject" do
+            Factories::Fact.data_fact(provenance_subject).
+              provenance_subject.should == provenance_subject
+          end
+
+          it "has empty subject" do
+            Factories::Fact.data_fact(provenance_subject).subject.should be_nil
+          end
+        end
+
+        describe "with provenance_subject and subject" do
+          it "has provenance_subject" do
+            Factories::Fact.data_fact(provenance_subject, subject).
+              provenance_subject.should == provenance_subject
+          end
+
+          it "has subject" do
+            Factories::Fact.data_fact(provenance_subject, subject).
+              subject.should == subject
+          end
+        end
+      end
+    end
+  end
+end