dbd 0.0.11 → 0.0.12

data/lib/dbd/fact/collection.rb

@@ -9,7 +9,7 @@ module Dbd
       def initialize
         super
         @hash_by_subject = Hash.new { |h, k| h[k] = [] }
-        @used_provenance_subjects = {}
+        @used_context_subjects = {}
       end
 
       def newest_time_stamp
@@ -33,20 +33,20 @@ module Dbd
       #
       # Validates that added fact is newer.
       #
-      # Validates that subject was never used as provenance_subject [A].
+      # Validates that subject was never used as context_subject [A].
       #
       # Adds the fact and return the index in the collection.
       #
       # Store this index in the hash_by_subject.
       #
-      # Mark the fact in the list of used provenance_subjects (for [A]).
+      # Mark the fact in the list of used context_subjects (for [A]).
       def <<(fact)
         raise FactError, "#{fact.errors.join(', ')}." unless fact.errors.empty?
         raise OutOfOrderError if (self.newest_time_stamp && fact.time_stamp <= self.newest_time_stamp)
-        raise OutOfOrderError if (@used_provenance_subjects[fact.subject])
+        raise OutOfOrderError if (@used_context_subjects[fact.subject])
         index = Helpers::OrderedSetCollection.add_and_return_index(fact, @internal_collection)
         @hash_by_subject[fact.subject] << index
-        fact.update_used_provenance_subjects(@used_provenance_subjects)
+        fact.update_used_context_subjects(@used_context_subjects)
         self
       end
 

data/lib/dbd/fact/factory.rb

@@ -23,11 +23,11 @@ module Dbd
         end
 
         ##
-        # Constructs a Fact or ProvenanceFact from a string values array
+        # Constructs a Fact or ContextFact from a string values array
         # (e.g. pulled from a CSV row).
         #
         # @param [Array] string_values Required : the array with values, organized as in attributes
-        # @return [Fact, ProvenanceFact] the constructed fact
+        # @return [Fact, Context] the constructed fact
         def from_string_values(string_values, options={})
           string_hash = string_hash_from_values(string_values)
           validate_string_hash(string_hash) if options[:validate]
@@ -39,7 +39,7 @@ module Dbd
           {
             id: [true, Fact::ID.valid_regexp],
             time_stamp: [true, TimeStamp.valid_regexp],
-            provenance_subject: [false, Fact::Subject.valid_regexp],
+            context_subject: [false, Fact::Subject.valid_regexp],
             subject: [true, Fact::Subject.valid_regexp],
             predicate: [true, /./],
             object: [true, /./]
@@ -50,7 +50,7 @@ module Dbd
 
         def string_hash_from_values(string_values)
           attributes_strings_array = [top_class.attributes, string_values].transpose
-          # Remove empty values (e.g. the provenance_subject for a ProvenanceFact).
+          # Remove empty values (e.g. the context_subject for a ContextFact).
           attributes_strings_array.delete_if{|a,v| v.nil? || v == ''}
           Hash[attributes_strings_array]
         end
@@ -62,10 +62,10 @@ module Dbd
         end
 
         def fact_from_values_hash(values_hash)
-          if values_hash[:provenance_subject]
+          if values_hash[:context_subject]
             Fact.new(values_hash)
           else
-            ProvenanceFact.new(values_hash)
+            ContextFact.new(values_hash)
           end
         end
 

data/lib/dbd/graph.rb

@@ -3,7 +3,7 @@ require 'csv'
 module Dbd
 
   ##
-  # The Graph stores the Facts and ProvenanceFacts in an in-memory
+  # The Graph stores the Facts and Contexts in an in-memory
   # collection structure.
   #
   # On the other hand, it acts as an "interface" that can be
@@ -40,7 +40,7 @@ module Dbd
     ##
     # Export the graph to a CSV file
     #
-    # @param [String] :filename the filename to stream the CSV to
+    # @param [String] filename the filename to stream the CSV to
     def to_CSV_file(filename)
       CSV.open(filename, 'w', csv_defaults) do |csv|
         push_facts(csv)

data/lib/dbd/resource.rb

@@ -13,19 +13,19 @@ module Dbd
   # a subject is a random uuid (like a oid), not a meaningful URI
   # as it is in RDF.
   #
-  # A provenance_subject is a required field in the options hash.
-  # Practically, first a ProvenanceResource will be created and the
-  # subject of that will be used as provenance_subject for the
+  # A context_subject is a required field in the options hash.
+  # Practically, first a Context will be created and the
+  # subject of that will be used as context_subject for the
   # Resources that are associated with it.
   #
-  # During build-up of a Fact, the subject and the provenance_subject
+  # During build-up of a Fact, the subject and the context_subject
   # can be nil. These will then be set when the Fact is added
   # (with '<<') to a resource.
   class Resource
 
     include Helpers::OrderedSetCollection
 
-    attr_reader :subject, :provenance_subject
+    attr_reader :subject, :context_subject
 
     ##
     # @return [Fact::Subject] a new (random) Resource subject
@@ -41,32 +41,33 @@ module Dbd
     # (this is best created with the new_subject class method for forward
     # compatibility).
     #
-    # The provenance_subject argument is required. This will typically be
-    # taken from an earlier created ProvenanceResource.
+    # The context_subject argument is required. This will typically be
+    # taken from an earlier created Context.
     #
     # @param [Hash{Symbol => Object}] options
-    # @option options [Fact::Subject] :provenance_subject (required) the subject of the provenance resource for this resource
+    # @option options [Fact::Subject] :context_subject (required) the subject of the context for this resource
     # @option options [Fact::Subject] :subject (new_subject) Optional: the subject for the resource
     def initialize(options)
       set_subject(options)
-      set_provenance_subject(options)
+      set_context_subject(options)
       super()
     end
 
     ##
-    # Add a Fact (strictly not a ProvenanceFact)
+    # Add a Fact (strictly not a ContextFact)
     #
-    # Side effects on subject and provenance_subject:
+    # Side effects on subject and context_subject:
     # * if it has no subject, the subject is set (this modifies the fact !)
     # * if is has the same subject as the resource, added unchanged.
     # * if it has a different subject, a SubjectError is raised.
-    # * if it has no provenance_subject, the provenance_subject is set (this modifies the fact !)
-    # * if is has the same provenance_subject as the resource, added unchanged.
-    # * if it has a different provenance_subject, a ProvenanceError is raised.
+    #
+    # * if it has no context_subject, the context_subject is set (this modifies the fact !)
+    # * if is has the same context_subject as the resource, added unchanged.
+    # * if it has a different context_subject, a ContextError is raised.
     def <<(fact)
-      assert_fact_provenance_fact(fact)
+      assert_fact_or_context_fact(fact)
       set_fact_subject!(fact)
-      set_fact_provenance!(fact)
+      set_fact_context_subject!(fact)
       super(fact)
     end
 
@@ -76,22 +77,22 @@ module Dbd
       @subject = options[:subject] || self.class.new_subject
     end
 
-    def set_provenance_subject(options)
-      @provenance_subject = options[:provenance_subject]
-      raise ProvenanceError, "provenance_subject cannot be nil" if @provenance_subject.nil?
+    def set_context_subject(options)
+      @context_subject = options[:context_subject]
+      raise ContextError, "context_subject cannot be nil" if @context_subject.nil?
     end
 
     def set_fact_subject!(fact)
       fact.subject = subject
     end
 
-    def set_fact_provenance!(fact)
-      fact.provenance_subject = provenance_subject
+    def set_fact_context_subject!(fact)
+      fact.context_subject = context_subject
     end
 
-    # Assert _no_ ProvenanceFacts here
-    def assert_fact_provenance_fact(fact)
-      raise ArgumentError, "Trying to add a ProvenanceFact to a Resource." if fact.provenance_fact?
+    # Assert _no_ Contexts here
+    def assert_fact_or_context_fact(fact)
+      raise ArgumentError, "Trying to add a ContextFact to a Resource." if fact.context_fact?
     end
 
   end

data/lib/dbd/version.rb

@@ -1,3 +1,3 @@
 module Dbd
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

data/spec/lib/dbd/context/context_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+module Dbd
+  describe Context do
+
+    let(:context) { described_class.new }
+    let(:context_subject) { context.subject }
+
+    describe '.new' do
+      describe 'without a subject argument' do
+        it 'has created a new subject' do
+          context.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: context_subject).subject.
+            should == context_subject
+        end
+      end
+
+      describe 'with a context_subject argument' do
+        it 'raises an ContextError' do
+          lambda{ described_class.new(context_subject: context_subject) }.
+            should raise_error(ArgumentError)
+        end
+      end
+    end
+
+    describe 'context_subject' do
+      it 'raises NoMethodError when called' do
+        lambda{ context.context_subject }.should raise_error(NoMethodError)
+      end
+    end
+
+    describe 'TestFactories::Context' do
+      it '.context works' do
+        TestFactories::Context.context
+      end
+    end
+
+    describe 'the collection' do
+
+      let(:context_fact_visibility) { TestFactories::ContextFact.visibility } # nil subject
+      let(:context_visibility_with_incorrect_subject) { TestFactories::ContextFact.visibility(TestFactories::ContextFact.new_subject) }
+      let(:context_visibility_with_correct_subject) { TestFactories::ContextFact.visibility(context_subject) }
+
+      describe 'adding context_facts with << ' do
+        it 'with correct subject it works' do
+          context << context_visibility_with_correct_subject
+          context.first.subject.should == context_subject
+        end
+
+        it 'with incorrect subject it raises SetOnceError' do
+          lambda{ context << context_visibility_with_incorrect_subject }.
+            should raise_error(RubyPeterV::SetOnceError),
+              "Value of subject was #{context_visibility_with_incorrect_subject.subject}, " \
+              "trying to set it to #{context.subject}"
+        end
+
+        it 'with nil subject it sets the subject' do
+          context << context_fact_visibility
+          context.first.subject.should == context_subject
+        end
+
+        it 'with nil (=correct) context_subject it is a noop' do
+          context << context_fact_visibility
+          context.first.context_subject.should be_nil
+        end
+      end
+    end
+  end
+end

data/spec/lib/dbd/context_fact/methods_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+
+module Dbd
+  describe ContextFact do
+
+    let(:subject) { described_class.factory.new_subject }
+
+    let(:context_fact_1) do
+      TestFactories::ContextFact.visibility(subject)
+    end
+
+    let(:context_fact_created) do
+      TestFactories::ContextFact.created(subject)
+    end
+
+    describe 'short' do
+      it 'for a context_fact fact shows [ cont ], subj, predicate, object' do
+        context_fact_1.short.should match(/^\[ cont \] : [0-9a-f]{8} : context:visibility       : public$/)
+      end
+
+      it 'for a context_fact fact with non string object also works' do
+        context_fact_created.short.should match(/^\[ cont \] : [0-9a-f]{8} : dcterms:created          : \d{4}/)
+      end
+    end
+
+    describe 'errors' do
+      it 'the factory has no errors' do
+        context_fact_1.errors.should be_empty
+      end
+
+      describe 'with a context_subject' do
+
+        before(:each) do
+          context_fact_1.stub(:context_subject).and_return(subject)
+        end
+
+        it 'errors returns an array with 1 error message' do
+          context_fact_1.errors.single.should match(/ContextFact subject should not be present in ContextFact/)
+        end
+      end
+
+      describe 'without subject' do
+
+        before(:each) do
+          context_fact_1.stub(:subject).and_return(nil)
+        end
+
+        it 'errors returns an array with an error message' do
+          context_fact_1.errors.single.should match(/Subject is missing/)
+        end
+      end
+    end
+
+    describe 'update_used_context_subjects' do
+      it 'does nothing for a context_fact' do
+        h = {}
+        context_fact_1.update_used_context_subjects(h)
+        h.should be_empty
+      end
+    end
+
+    describe 'attributes and values' do
+      it 'there are 6 attributes' do
+        described_class.attributes.size.should == 6
+      end
+
+      it 'there are 6 values' do
+        context_fact_1.values.size.should == 6
+      end
+    end
+
+    describe 'context_fact?' do
+      it 'is true for ContextFact or derived from it' do
+        context_fact_1.context_fact?.should be_true
+      end
+    end
+  end
+end

data/spec/lib/dbd/context_fact/new_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Dbd
+  describe ContextFact do
+
+    let(:subject) { described_class.factory.new_subject }
+    let(:id_class) { described_class.factory.new_id.class }
+
+    let(:context_fact_1) do
+      TestFactories::ContextFact.visibility(subject)
+    end
+
+    let(:context_fact_2) do
+      TestFactories::ContextFact.created_by(subject)
+    end
+
+    describe '#new' do
+      it 'has a unique id (new_id.class)' do
+        context_fact_1.id.should be_a(id_class)
+      end
+
+      it 'two context_facts have different id' do
+        context_fact_1.id.should_not == context_fact_2.id
+      end
+
+      it 'has nil context_subject' do
+        context_fact_1.context_subject.should be_nil
+      end
+
+      it 'has correct subject' do
+        context_fact_1.subject.should == subject
+      end
+
+      it 'has correct predicate' do
+        context_fact_1.predicate.should == 'context:visibility'
+      end
+
+      it 'has correct object' do
+        context_fact_1.object.should == 'public'
+      end
+
+      it 'raises a ContextError when context_subject is present in options hash' do
+        lambda { described_class.new(
+          context_subject: subject,
+          predicate: 'test',
+          object: 'test') } .
+            should raise_error ContextError
+      end
+    end
+  end
+end

data/spec/lib/dbd/context_fact/test_factories_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module TestFactories
+  describe ContextFact do
+
+    describe 'TestFactories do not fail' do
+      it 'TestFactories::ContextFact.visibility is OK' do
+        described_class.visibility.should_not be_nil
+      end
+
+      it 'TestFactories::ContextFact.created_by is OK' do
+        described_class.created_by.should_not be_nil
+      end
+
+      it 'TestFactories::ContextFact.original_source is OK' do
+        described_class.original_source.should_not be_nil
+      end
+
+      it 'TestFactories::ContextFact.new_subject is OK' do
+        described_class.new_subject.should be_a(ContextFact.new_subject.class)
+      end
+    end
+  end
+end

data/spec/lib/dbd/errors/errors_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module Dbd
+  # TODO move this to dedicated Errors module
+  describe "Errors" do
+    it "OutOfOrderError" do
+      OutOfOrderError
+    end
+
+    it "FactError" do
+      FactError
+    end
+
+    it "ContextError" do
+      ContextError
+    end
+
+    it "SubjectError" do
+      SubjectError
+    end
+
+    it "PredicateError" do
+      PredicateError
+    end
+
+    it "ObjectError" do
+      ObjectError
+    end
+  end
+end