dbd 0.0.1

data/spec/lib/dbd/graph_spec.rb

@@ -0,0 +1,214 @@
+require 'spec_helper'
+
+module Dbd
+  describe Graph do
+
+    def new_subject
+      Fact.new_subject
+    end
+
+    let(:data_fact) { Factories::Fact.data_fact(new_subject, new_subject) }
+    let(:fact_no_subject) { Factories::Fact.data_fact(new_subject, nil) }
+    let(:fact_no_provenance) { Factories::Fact.data_fact(nil, new_subject) }
+
+    let(:provenance_facts) { Factories::Fact::Collection.provenance_facts(new_subject) }
+    let(:provenance_fact_1) { provenance_facts.first }
+    let(:fact_2_3) { Factories::Fact::Collection.fact_2_3(provenance_fact_1.subject) }
+
+    let(:subject_regexp) { Fact::Subject.regexp }
+    let(:id_regexp) { Fact::ID.regexp }
+
+    describe "create a graph" do
+      it "does not fail" do
+        described_class.new # should_not raise_error
+      end
+    end
+
+    describe "<< " do
+      describe "a Fact" do
+        it "a data_fact does not fail" do
+          subject << data_fact
+        end
+
+        it "a provenance_fact does not fail" do
+          subject << provenance_fact_1
+        end
+
+        it "two facts does not fail" do
+          subject << provenance_fact_1
+          subject << data_fact
+        end
+
+        it "fact with missing subject raises FactError" do
+          lambda { subject << fact_no_subject } . should raise_error FactError
+        end
+
+        it "fact with missing provenance raises FactError" do
+          lambda { subject << fact_no_provenance } . should raise_error FactError
+        end
+      end
+
+      describe "sets the time_stamp and adds 2 nanoseconds if needed" do
+        it "sets the time_stamp" do
+          data_fact.time_stamp.should be_nil # assert pre condition
+          subject << data_fact
+          subject.first.time_stamp.should be_a(Time)
+        end
+
+        it "sets a slightly higher time_stamp if smaller or equal then newest_time_stamp" do
+          subject
+          subject.newest_time_stamp
+          far_future = Time.new(2200,1,1,12,0,0).utc
+          subject.stub(:newest_time_stamp).and_return(far_future)
+          subject << data_fact
+          subject.first.time_stamp.should > far_future
+          subject.first.time_stamp.should < far_future + 0.000_000_005
+        end
+      end
+    end
+
+    describe "#to_CSV with only provenance_facts" do
+      before do
+        provenance_facts.each_with_index do |provenance_fact, index|
+          subject << provenance_fact
+        end
+      end
+
+      it "returns a string" do
+        subject.to_CSV.should be_a(String)
+      end
+
+      it "returns a string in UTF-8 encoding" do
+        subject.to_CSV.encoding.should == Encoding::UTF_8
+      end
+
+      it "returns a string with comma's" do
+        subject.to_CSV.should match(/\A"[^",]+","[^",]+","[^",]*","[^",]+"/)
+      end
+
+      describe "with a single provenance_fact collection" do
+        it "has three logical lines (but one with embedded newline)" do
+          subject.to_CSV.lines.count.should == 4
+        end
+
+        it "ends with a newline" do
+          subject.to_CSV.lines.to_a.last[-1].should == "\n"
+        end
+      end
+
+      describe "has all attributes of the provenance_fact_collection" do
+
+        let(:first_line) do
+          subject.to_CSV.lines.to_a.first.chomp
+        end
+
+        it "has id (a Fact::ID) as first value" do
+          first_line.split(',')[0].gsub(/"/, '').should match(id_regexp)
+        end
+
+        it "has time_stamp as second value" do
+          first_line.split(',')[1].should match(/"\d{4}-\d\d-\d\d \d\d:\d\d:\d\d UTC"/)
+        end
+
+        it "has an empty third value (signature of a provenance_fact)" do
+          first_line.split(',')[2].should == "\"\""
+        end
+
+        it "has subject as 4th value" do
+          first_line.split(',')[3].gsub(/"/, '').should match(subject_regexp)
+        end
+
+        it "has data_predicate as 5th value" do
+          first_line.split(',')[4].should == '"https://data.vandenabeele.com/ontologies/provenance#context"'
+        end
+
+        it "has object as 6th value" do
+          first_line.split(',')[5].should == '"public"'
+        end
+      end
+
+      describe "handles comma, double quote and newline correctly" do
+        it "has original_source with special characters and double quote escaped" do
+          subject.to_CSV.should match(/"this has a comma , a newline \n and a double quote """/)
+        end
+      end
+    end
+
+    describe "#to_CSV with only facts" do
+      before do
+        fact_2_3.each_with_index do |fact, index|
+          subject << fact
+         end
+      end
+
+      it "returns a string" do
+        subject.to_CSV.should be_a(String)
+      end
+
+      it "returns a string in UTF-8 encoding" do
+        subject.to_CSV.encoding.should == Encoding::UTF_8
+      end
+
+      it "returns a string with comma's" do
+        subject.to_CSV.should match(/\A"[^",]+","[^",]+","[^",]+"/)
+      end
+
+      describe "with a single fact collection" do
+        it "has two lines" do
+          subject.to_CSV.lines.count.should == 2
+        end
+
+        it "ends with a newline" do
+          subject.to_CSV.lines.to_a.last[-1].should == "\n"
+        end
+      end
+
+      describe "has all attributes of the fact_collection" do
+
+        let(:first_line) do
+          subject.to_CSV.lines.to_a.first.chomp
+        end
+
+        it "has id (a Fact::ID) as first value" do
+          first_line.split(',')[0].gsub(/"/, '').should match(id_regexp)
+        end
+
+        it "has time_stamp as second value" do
+          first_line.split(',')[1].should match(/"\d{4}-\d\d-\d\d \d\d:\d\d:\d\d UTC"/)
+        end
+
+        it "has provenance_fact_1.subject as third value" do
+          first_line.split(',')[2].should == "\"#{provenance_fact_1.subject.to_s}\""
+        end
+
+        it "has subject as 4th value" do
+          first_line.split(',')[3].gsub(/"/, '').should match(subject_regexp)
+        end
+
+        it "has data_predicate as 5th value" do
+          first_line.split(',')[4].should == '"http://example.org/test/name"'
+        end
+
+        it "has object as 6th value" do
+          first_line.split(',')[5].should == '"Mandela"'
+        end
+      end
+    end
+
+    describe "#to_CSV with provenance_facts and facts" do
+
+      before do
+        provenance_facts.each do |provenance_fact|
+          subject << provenance_fact
+        end
+        fact_2_3.each do |fact|
+          subject << fact
+         end
+      end
+
+      it "has six lines" do
+        subject.to_CSV.lines.count.should == 6
+      end
+    end
+  end
+end

data/spec/lib/dbd/helpers/ordered_set_collection_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+module Dbd
+  module Helpers
+    describe OrderedSetCollection do
+
+      let(:element_1) {:element_1}
+      let(:element_2) {:element_2}
+      let(:subject) do
+        o = Object.new
+        o.extend(described_class)
+        o.send(:initialize)
+        o
+      end
+
+      describe "create an elements collection" do
+        it "the collection is not an array" do
+          # do not derive from Ruby standard classes
+          subject.should_not be_a(Array)
+        end
+      end
+
+      describe "accessor functions" do
+        it "the collection has Enumerable methods" do
+          subject.map #should_not raise_exception
+          subject.first #should_not raise_exception
+        end
+
+        it "<< adds the element" do
+          subject << element_1
+          subject.count.should == 1
+        end
+
+        it "returns self to allow chaining" do
+          (subject << element_1).should == subject
+        end
+
+        it "other functions (e.g. pop) do not work" do
+          lambda {subject.pop} . should raise_exception NoMethodError
+        end
+
+        describe "add_and_return_index returns the index of the inserted element" do
+
+          let(:internal_collection) do
+            subject.instance_variable_get("@internal_collection")
+          end
+
+          let(:index) do
+            described_class.add_and_return_index(element_1, internal_collection)
+          end
+
+          before(:each) { index }
+
+          it "works for 1 element" do
+            index.should == 0
+          end
+
+          it "works for 2 elements" do
+            index_2 = described_class.add_and_return_index(element_2, internal_collection)
+            index_2.should == 1
+          end
+        end
+
+        describe "last" do
+          it "returns the last element" do
+            subject << element_1
+            subject << element_2
+            subject.last.should == element_2
+          end
+        end
+
+        describe "size" do
+          it "returns the last element" do
+            subject << element_1
+            subject << element_2
+            subject.size.should == 2
+          end
+        end
+      end
+
+      describe "on empty collection" do
+        it "#last returns nil" do
+          subject.last.should be_nil
+        end
+      end
+    end
+  end
+end

data/spec/lib/dbd/helpers/uuid_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module Dbd
+  module Helpers
+    describe UUID do
+      it ".regex" do
+        '12345678-abcd-4567-89ab-0123456789ab'.should match(UUID.regexp)
+      end
+
+      it ".new creates a new random UUID" do
+        described_class.new.to_s.should match(UUID.regexp)
+      end
+    end
+  end
+end

data/spec/lib/dbd/provenance_fact_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+module Dbd
+    describe ProvenanceFact do
+
+      let(:subject) { described_class.new_subject }
+      let(:id_class) { described_class.new_id.class }
+
+      let(:provenance_fact_1) do
+        Factories::ProvenanceFact.context(subject)
+      end
+
+      let(:provenance_fact_2) do
+        Factories::ProvenanceFact.created_by(subject)
+      end
+
+      describe "#new" do
+        it "has a unique id (new_id.class)" do
+          provenance_fact_1.id.should be_a(id_class)
+        end
+
+        it "two provenance_facts have different id" do
+          provenance_fact_1.id.should_not == provenance_fact_2.id
+        end
+
+        it "has nil provenance_subject" do
+          provenance_fact_1.provenance_subject.should be_nil
+        end
+
+        it "has correct subject" do
+          provenance_fact_1.subject.should == subject
+        end
+
+        it "has correct predicate" do
+          provenance_fact_1.predicate.should == "https://data.vandenabeele.com/ontologies/provenance#context"
+        end
+
+        it "has correct object" do
+          provenance_fact_1.object.should == "public"
+        end
+
+        it "raises an ProvenanceError when provenance_subject is present in options hash" do
+          lambda { described_class.new(
+            provenance_subject: described_class.new_subject,
+            predicate: "test",
+            object: "test") } .
+              should raise_error ProvenanceError
+        end
+      end
+
+      describe "valid?" do
+        it "the factory isi valid?" do
+          provenance_fact_1.should be_valid
+        end
+
+        it "with ! provenance_subject is not valid?" do
+          provenance_fact_1.stub(:provenance_subject).and_return(subject)
+          provenance_fact_1.should_not be_valid
+        end
+
+        it "without subject is not valid?" do
+          provenance_fact_1.stub(:subject).and_return(nil)
+          provenance_fact_1.should_not be_valid
+        end
+      end
+
+      describe "#dup_with_subject" do
+
+        let (:new_fact) do
+          provenance_fact_1.dup_with_subject(subject)
+        end
+
+        it "is a different instance" do
+          new_fact.should_not be_equal(provenance_fact_1)
+        end
+
+        it "is from the same class" do
+          new_fact.should be_a(provenance_fact_1.class)
+        end
+      end
+
+      describe "update_used_provenance_subjects" do
+        it "does nothing for a provenance_fact" do
+          h = {}
+          provenance_fact_1.update_used_provenance_subjects(h)
+          h.should be_empty
+        end
+      end
+
+      describe "Factories do not fail" do
+        it "Factories::ProvenanceFact.context is OK" do
+          Factories::ProvenanceFact.context.should_not be_nil
+        end
+
+        it "Factories::ProvenanceFact.created_by is OK" do
+          Factories::ProvenanceFact.created_by.should_not be_nil
+        end
+
+        it "Factories::ProvenanceFact.original_source is OK" do
+          Factories::ProvenanceFact.original_source.should_not be_nil
+        end
+
+        it "Factories::ProvenanceFact.new_subject is OK" do
+          Factories::ProvenanceFact.new_subject.should be_a(ProvenanceFact.new_subject.class)
+        end
+      end
+    end
+end

data/spec/lib/dbd/provenance_resource_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+module Dbd
+  describe ProvenanceResource do
+
+    let(:provenance_resource) { described_class.new }
+    let(:provenance_resource_subject) { provenance_resource.subject }
+
+    describe ".new" do
+      describe "without a subject argument" do
+        it "has created a new subject" do
+          provenance_resource.subject.should be_a(described_class.new_subject.class)
+        end
+      end
+
+      describe "with a subject argument" do
+        it "has stored the resource_subject" do
+          described_class.new(subject: provenance_resource_subject).subject.should == provenance_resource_subject
+        end
+      end
+
+      describe "with a provenance_subject argument" do
+        it "raises an ProvenanceError" do
+          lambda { described_class.new(provenance_subject: provenance_resource_subject) } .
+            should raise_error ProvenanceError
+        end
+      end
+    end
+
+    describe "provenance_subject" do
+      it "raises NoMethodError when called" do
+        lambda { provenance_resource.provenance_subject } . should raise_error NoMethodError
+      end
+    end
+
+    describe "Factories::Resource" do
+      it ".provenance_resource works" do
+        Factories::ProvenanceResource.provenance_resource
+      end
+    end
+
+    describe "the collection" do
+
+      let(:provenance_fact_context) { Factories::ProvenanceFact.context }
+      let(:provenance_fact_context_with_incorrect_subject) { Factories::ProvenanceFact.context(Factories::ProvenanceFact.new_subject) }
+      let(:provenance_fact_context_with_correct_subject) { Factories::ProvenanceFact.context(provenance_resource_subject) }
+      let(:fact_1) { Factories::Fact.fact_1(provenance_resource_subject) }
+
+      describe "data facts" do
+        it "with correct subject" do
+          provenance_resource << provenance_fact_context_with_correct_subject
+          provenance_resource.first.subject.should == provenance_resource_subject
+        end
+
+        it "with incorrect subject it raise SubjectError" do
+          lambda { provenance_resource << provenance_fact_context_with_incorrect_subject } .
+            should raise_error SubjectError
+        end
+
+        it "with nil subject" do
+          provenance_resource << provenance_fact_context
+          provenance_resource.first.subject.should == provenance_resource_subject
+        end
+
+        it "with nil (=correct) provenance_subject" do
+          provenance_resource << provenance_fact_context
+          provenance_resource.first.provenance_subject.should be_nil
+        end
+
+        it "with incorrect provenance_subjecti ProvenanceError" do
+          lambda { provenance_resource << fact_1 } .
+            should raise_error ProvenanceError
+        end
+      end
+    end
+  end
+end