dbd 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4738e212a553b87a79d494de3a1825690de3af64
-  data.tar.gz: f511eb469bd7d3705bb921bab74fa107e9852de5
+  metadata.gz: 49a3db0e5342a8c507f107cad3afd4ae3e21964c
+  data.tar.gz: 0118bb6bddcdc103577080f5deddc42ff3d2d5d8
 SHA512:
-  metadata.gz: 8b25ea06edaed016cb0826836b8dbc3555df29ffece9f2ad534d00fb02bc6564c407ddbd5a01761fd843d516a0e29a3f6d2e0ea91f7e4529925bded33684494a
-  data.tar.gz: 11c13f6dcde106d7d67018b6f07791b42165d62a605c9f3aee08c8483ead0f9b4ff6090252c19390629380e1fbdd159d95861e28ec4da6401992351aa9e10d4a
+  metadata.gz: 04d8a0525f3acf92a9203d63a846c829922f4363a65f7b1cfe900794f2a2ba0725de11a8a6cf330c3b6308a30e031c37d37052180c61adf99c8ab74d7b0a92f2
+  data.tar.gz: 03087f0151bbbe1d1b8c7f7e6a9dd090122136d597453459a8ee96e082f741c9bf4d86970255bc40f93bdd317ab9a1a113d2b2f940b9358ebec5bff11bffae9b

data/Guardfile

@@ -2,7 +2,6 @@ guard 'rspec', :all_after_pass => true, :all_on_start => true do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^spec/test_factories})    { "spec" }
   watch(%r{^lib/dbd/helpers})   { "spec" }
-#  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}/" }
   watch('spec/spec_helper.rb')  { "spec" }
   watch('lib/dbd.rb')           { "spec" }

data/HISTORY.txt

@@ -67,3 +67,12 @@
 
 * object in Fact#short now truncated to 80 bytes
 * using a utf-8 safe truncation (from ruby_peter_v)
+
+0.0.12 (10 July 2013)
+======
+
+* major renaming
+  * ProvenanceFact => ContextFact
+  * ProvenanceResource => Context
+* because the context of a fact is much more than the provenance
+  (also visibility, encryption, license, ...)

data/README.md

@@ -9,6 +9,7 @@ This is facts based data store, inspired by [RDF] concepts, but adding a log bas
 
 [![Gem Version](https://badge.fury.io/rb/dbd.png)](http://badge.fury.io/rb/dbd)
 [![Build Status](https://travis-ci.org/petervandenabeele/dbd.png?branch=master)](http://travis-ci.org/petervandenabeele/dbd)
+[![Code Climate](https://codeclimate.com/github/petervandenabeele/dbd.png)](https://codeclimate.com/github/petervandenabeele/dbd)
 
 ## Features
 
@@ -23,13 +24,14 @@ This is facts based data store, inspired by [RDF] concepts, but adding a log bas
     must remove this fact and replace the back-up
   * since one single back-up file suffices, replacing the *single* back-up  
     file will actually remove the hard deleted fact(s) for good
-* Fine grained Provenance
-  * Each base Fact points to a ProvenanceResource, so separate provenance  
-    possible for different facts about 1 resource
+* Fine grained context (including provenance)
+  * Each base Fact points to a Context, so separate context and  
+    provenance is possible per fact (e.g. different properties about the same  
+    resource can come from different sources, different visibility etc.)
   * can keep the original_source reference, creator, date, …
   * can have a context that allows filtering data (e.g. private, professional, …)
   * separate encryption schemes per context are possible
-  * ProvenanceResource is flexible, since built itself from Facts
+  * Context is flexible, since built itself from Facts
 * Schemaless
   * uses the [RDF] (subject, predicate, object) concepts
   * predicates, types can be defined in an ontology for declaring meaning
@@ -50,18 +52,24 @@ Open Source [MIT]
 
 Running `ruby docs/test.rb` will execute the script below.
 
+* Facts are logically grouped (by subject) in a Resource
+* ContextFacts are logically grouped (by subject) in a Context
+* each Fact refers to a Context with its context_subject
+* all Facts and ContextFacts are stored sequentially and immutably
+  in a Graph
+
 ```
 require 'dbd'
 
-provenance = Dbd::ProvenanceResource.new
+context = Dbd::Context.new
 
-provenance << Dbd::ProvenanceFact.new(predicate: "prov:context", object: "public")
-provenance << Dbd::ProvenanceFact.new(predicate: "prov:source",  object: "http://github.com/petervandenabeele/dbd")
-provenance << Dbd::ProvenanceFact.new(predicate: "dcterms:creator", object: "@peter_v")
-provenance << Dbd::ProvenanceFact.new(predicate: "dcterms:created", object: Time.now.utc)
-provenance << Dbd::ProvenanceFact.new(predicate: "prov:license", object: "MIT")
+context << Dbd::ContextFact.new(predicate: "prov:context_fact", object: "public")
+context << Dbd::ContextFact.new(predicate: "prov:source",  object: "http://github.com/petervandenabeele/dbd")
+context << Dbd::ContextFact.new(predicate: "dcterms:creator", object: "@peter_v")
+context << Dbd::ContextFact.new(predicate: "dcterms:created", object: Time.now.utc)
+context << Dbd::ContextFact.new(predicate: "prov:license", object: "MIT")
 
-nobel_peace_2012 = Dbd::Resource.new(provenance_subject: provenance.subject)
+nobel_peace_2012 = Dbd::Resource.new(context_subject: context.subject)
 
 nobel_peace_2012 << Dbd::Fact.new(predicate: "todo:nobelPeacePriceWinner", object: "2012")
 nobel_peace_2012 << Dbd::Fact.new(predicate: "rdfs:label", object: "EU") #  this will use some RDF predicates in future
@@ -70,21 +78,21 @@ nobel_peace_2012 << Dbd::Fact.new(predicate: "todo:story", object: "A long perio
 
 graph = Dbd::Graph.new
 
-graph << provenance << nobel_peace_2012
+graph << context << nobel_peace_2012
 
 puts "facts in short representation:"
 puts graph.map(&:short)
 
 # facts in short representation:
-# [ prov ] : 5eb1ea27 : prov:context             : public
-# [ prov ] : 5eb1ea27 : prov:source              : http://github.com/petervandenabeele/dbd
-# [ prov ] : 5eb1ea27 : dcterms:creator          : @peter_v
-# [ prov ] : 5eb1ea27 : dcterms:created          : 2013-06-19 22:02:20 UTC
-# [ prov ] : 5eb1ea27 : prov:license             : MIT
-# 5eb1ea27 : 3767c493 : todo:nobelPeacePriceWinn : 2012
-# 5eb1ea27 : 3767c493 : rdfs:label               : EU
-# 5eb1ea27 : 3767c493 : rdfs:comment             : European Union
-# 5eb1ea27 : 3767c493 : todo:story               : A long period of peace,_ that is a "bliss".
+# [ cont ] : 7d0ccaa8 : prov:context_fact        : public
+# [ cont ] : 7d0ccaa8 : prov:source              : http://github.com/petervandenabeele/dbd
+# [ cont ] : 7d0ccaa8 : dcterms:creator          : @peter_v
+# [ cont ] : 7d0ccaa8 : dcterms:created          : 2013-07-10 21:34:32 UTC
+# [ cont ] : 7d0ccaa8 : prov:license             : MIT
+# 7d0ccaa8 : 47acd35d : todo:nobelPeacePriceWinn : 2012
+# 7d0ccaa8 : 47acd35d : rdfs:label               : EU
+# 7d0ccaa8 : 47acd35d : rdfs:comment             : European Union
+# 7d0ccaa8 : 47acd35d : todo:story               : A long period of peace,_ that is a "bliss".
 
 csv = graph.to_CSV
 
@@ -92,30 +100,30 @@ puts "facts in full detail in CSV:"
 puts csv
 
 # facts in full detail in CSV:
-# "4720034a-01ea-4b6b-b9aa-45cb8c7c5e64","2013-06-19 22:02:20.489834224 UTC","","5eb1ea27-6691-4a57-ab13-8a59021968e1","prov:context","public"
-# "d05a0a6c-a003-4320-b52b-a6e49e854437","2013-06-19 22:02:20.489889896 UTC","","5eb1ea27-6691-4a57-ab13-8a59021968e1","prov:source","http://github.com/petervandenabeele/dbd"
-# "fc47abbd-da2d-4562-bb6b-ed8b84005734","2013-06-19 22:02:20.489913758 UTC","","5eb1ea27-6691-4a57-ab13-8a59021968e1","dcterms:creator","@peter_v"
-# "f240e975-5d39-41eb-bb5a-cc59ede4c1a6","2013-06-19 22:02:20.489932320 UTC","","5eb1ea27-6691-4a57-ab13-8a59021968e1","dcterms:created","2013-06-19 22:02:20 UTC"
-# "d592b1e8-2910-4329-b502-7d960cebb399","2013-06-19 22:02:20.489950713 UTC","","5eb1ea27-6691-4a57-ab13-8a59021968e1","prov:license","MIT"
-# "a2d55e46-03f2-470e-8347-c36b31e7facc","2013-06-19 22:02:20.489973271 UTC","5eb1ea27-6691-4a57-ab13-8a59021968e1","3767c493-79d3-4a97-a832-79e6361ddc4c","todo:nobelPeacePriceWinner","2012"
-# "0766dd24-70e5-487d-a018-d58da75dcdad","2013-06-19 22:02:20.489996422 UTC","5eb1ea27-6691-4a57-ab13-8a59021968e1","3767c493-79d3-4a97-a832-79e6361ddc4c","rdfs:label","EU"
-# "eda61baa-b331-462e-b7b5-5d6eb2e9a053","2013-06-19 22:02:20.490014676 UTC","5eb1ea27-6691-4a57-ab13-8a59021968e1","3767c493-79d3-4a97-a832-79e6361ddc4c","rdfs:comment","European Union"
-# "a3da9295-b43a-4c3a-8e8c-97c3f04c1fa3","2013-06-19 22:02:20.490036790 UTC","5eb1ea27-6691-4a57-ab13-8a59021968e1","3767c493-79d3-4a97-a832-79e6361ddc4c","todo:story","A long period of peace,
+# "be44bc07-0c0e-450b-8bbc-4cc1f472be33","2013-07-10 21:34:32.759424573 UTC","","7d0ccaa8-b641-4f1b-82ad-f36ba3757aa0","prov:context_fact","public"
+# "dae577a3-f210-4aab-9079-d87a4a362bd5","2013-07-10 21:34:32.759475097 UTC","","7d0ccaa8-b641-4f1b-82ad-f36ba3757aa0","prov:source","http://github.com/petervandenabeele/dbd"
+# "750904f8-c052-46af-8b0a-266a701a6e06","2013-07-10 21:34:32.759497534 UTC","","7d0ccaa8-b641-4f1b-82ad-f36ba3757aa0","dcterms:creator","@peter_v"
+# "a62ff09f-76a5-42ab-be9a-fc66c727ba41","2013-07-10 21:34:32.759513249 UTC","","7d0ccaa8-b641-4f1b-82ad-f36ba3757aa0","dcterms:created","2013-07-10 21:34:32 UTC"
+# "427f9dc3-0544-4f33-9b30-ffa32930f5a8","2013-07-10 21:34:32.759528346 UTC","","7d0ccaa8-b641-4f1b-82ad-f36ba3757aa0","prov:license","MIT"
+# "a8dbdfe6-6ead-4a35-bb6e-ec3f233aed5b","2013-07-10 21:34:32.759546366 UTC","7d0ccaa8-b641-4f1b-82ad-f36ba3757aa0","47acd35d-f2b1-4b36-8a37-90b0f08217d5","todo:nobelPeacePriceWinner","2012"
+# "186571ac-1eca-4621-8b7e-9f263550e27b","2013-07-10 21:34:32.759564395 UTC","7d0ccaa8-b641-4f1b-82ad-f36ba3757aa0","47acd35d-f2b1-4b36-8a37-90b0f08217d5","rdfs:label","EU"
+# "5a58d782-59bc-4ac0-b410-7ac637572f74","2013-07-10 21:34:32.759579688 UTC","7d0ccaa8-b641-4f1b-82ad-f36ba3757aa0","47acd35d-f2b1-4b36-8a37-90b0f08217d5","rdfs:comment","European Union"
+# "2c3e9e63-fd94-4c0f-ac39-7a85b4dbb20d","2013-07-10 21:34:32.759594496 UTC","7d0ccaa8-b641-4f1b-82ad-f36ba3757aa0","47acd35d-f2b1-4b36-8a37-90b0f08217d5","todo:story","A long period of peace,
 #  that is a ""bliss""."
 
 imported_graph = Dbd::Graph.new.from_CSV(csv)
 
 puts imported_graph.map(&:short)
 
-# [ prov ] : 5eb1ea27 : prov:context             : public
-# [ prov ] : 5eb1ea27 : prov:source              : http://github.com/petervandenabeele/dbd
-# [ prov ] : 5eb1ea27 : dcterms:creator          : @peter_v
-# [ prov ] : 5eb1ea27 : dcterms:created          : 2013-06-19 22:02:20 UTC
-# [ prov ] : 5eb1ea27 : prov:license             : MIT
-# 5eb1ea27 : 3767c493 : todo:nobelPeacePriceWinn : 2012
-# 5eb1ea27 : 3767c493 : rdfs:label               : EU
-# 5eb1ea27 : 3767c493 : rdfs:comment             : European Union
-# 5eb1ea27 : 3767c493 : todo:story               : A long period of peace,_ that is a "bliss".
+# [ cont ] : 7d0ccaa8 : prov:context_fact        : public
+# [ cont ] : 7d0ccaa8 : prov:source              : http://github.com/petervandenabeele/dbd
+# [ cont ] : 7d0ccaa8 : dcterms:creator          : @peter_v
+# [ cont ] : 7d0ccaa8 : dcterms:created          : 2013-07-10 21:34:32 UTC
+# [ cont ] : 7d0ccaa8 : prov:license             : MIT
+# 7d0ccaa8 : 47acd35d : todo:nobelPeacePriceWinn : 2012
+# 7d0ccaa8 : 47acd35d : rdfs:label               : EU
+# 7d0ccaa8 : 47acd35d : rdfs:comment             : European Union
+# 7d0ccaa8 : 47acd35d : todo:story               : A long period of peace,_ that is a "bliss".
 ```
 
 ## Performance tests on 10 M facts

data/bin/test_1.rb

@@ -18,16 +18,16 @@ unless filename
 end
 
 require 'dbd'
-provenance_resource = Dbd::ProvenanceResource.new
-provenance_resource << Dbd::ProvenanceFact.new(predicate: "prov:test" , object: "A" * 10)
+context = Dbd::Context.new
+context << Dbd::ContextFact.new(predicate: "prov:test" , object: "A" * 10)
 
-resource = Dbd::Resource.new(provenance_subject: provenance_resource.subject)
+resource = Dbd::Resource.new(context_subject: context.subject)
 (0...count).each do |i|
   resource << Dbd::Fact.new(predicate: "test", object: "#{'B' * 80} #{i}")
 end
 
 graph = Dbd::Graph.new
-graph << provenance_resource << resource
+graph << context << resource
 
 File.open(filename, 'w') do |f|
   f << graph.to_CSV

data/bin/test_5.rb

@@ -23,15 +23,15 @@ start = Time.now
 graph = Dbd::Graph.new
 
 (0...count).each do |i|
-  provenance_resource = Dbd::ProvenanceResource.new
-  provenance_resource << Dbd::ProvenanceFact.new(predicate: "prov:test" , object: "A" * 10)
+  context = Dbd::Context.new
+  context << Dbd::ContextFact.new(predicate: "prov:test" , object: "A" * 10)
 
-  resource = Dbd::Resource.new(provenance_subject: provenance_resource.subject)
+  resource = Dbd::Resource.new(context_subject: context.subject)
   (0...FACTS_PER_RESOURCE).each do |j|
     resource << Dbd::Fact.new(predicate: "test", object: "#{'B' * 80} #{i * FACTS_PER_RESOURCE + j}")
   end
 
-  graph << provenance_resource << resource
+  graph << context << resource
   puts ("added resource #{i} to the graph")
 end
 

data/docs/test.rb

@@ -1,14 +1,14 @@
 require 'dbd'
 
-provenance = Dbd::ProvenanceResource.new
+context = Dbd::Context.new
 
-provenance << Dbd::ProvenanceFact.new(predicate: "prov:context", object: "public")
-provenance << Dbd::ProvenanceFact.new(predicate: "prov:source",  object: "http://github.com/petervandenabeele/dbd")
-provenance << Dbd::ProvenanceFact.new(predicate: "dcterms:creator", object: "@peter_v")
-provenance << Dbd::ProvenanceFact.new(predicate: "dcterms:created", object: Time.now.utc)
-provenance << Dbd::ProvenanceFact.new(predicate: "prov:license", object: "MIT")
+context << Dbd::ContextFact.new(predicate: "prov:context_fact", object: "public")
+context << Dbd::ContextFact.new(predicate: "prov:source",  object: "http://github.com/petervandenabeele/dbd")
+context << Dbd::ContextFact.new(predicate: "dcterms:creator", object: "@peter_v")
+context << Dbd::ContextFact.new(predicate: "dcterms:created", object: Time.now.utc)
+context << Dbd::ContextFact.new(predicate: "prov:license", object: "MIT")
 
-nobel_peace_2012 = Dbd::Resource.new(provenance_subject: provenance.subject)
+nobel_peace_2012 = Dbd::Resource.new(context_subject: context.subject)
 
 nobel_peace_2012 << Dbd::Fact.new(predicate: "todo:nobelPeacePriceWinner", object: "2012")
 nobel_peace_2012 << Dbd::Fact.new(predicate: "rdfs:label", object: "EU") #  this will use some RDF predicates in future
@@ -17,13 +17,13 @@ nobel_peace_2012 << Dbd::Fact.new(predicate: "todo:story", object: "A long perio
 
 graph = Dbd::Graph.new
 
-graph << provenance << nobel_peace_2012
+graph << context << nobel_peace_2012
 
 puts "facts in short representation:"
 puts graph.map(&:short)
 
 # facts in short representation:
-# [ prov ] : 5eb1ea27 : prov:context             : public
+# [ prov ] : 5eb1ea27 : prov:context_fact             : public
 # [ prov ] : 5eb1ea27 : prov:source              : http://github.com/petervandenabeele/dbd
 # [ prov ] : 5eb1ea27 : dcterms:creator          : @peter_v
 # [ prov ] : 5eb1ea27 : dcterms:created          : 2013-06-19 22:02:20 UTC
@@ -39,7 +39,7 @@ puts "facts in full detail in CSV:"
 puts csv
 
 # facts in full detail in CSV:
-# "4720034a-01ea-4b6b-b9aa-45cb8c7c5e64","2013-06-19 22:02:20.489834224 UTC","","5eb1ea27-6691-4a57-ab13-8a59021968e1","prov:context","public"
+# "4720034a-01ea-4b6b-b9aa-45cb8c7c5e64","2013-06-19 22:02:20.489834224 UTC","","5eb1ea27-6691-4a57-ab13-8a59021968e1","prov:context_fact","public"
 # "d05a0a6c-a003-4320-b52b-a6e49e854437","2013-06-19 22:02:20.489889896 UTC","","5eb1ea27-6691-4a57-ab13-8a59021968e1","prov:source","http://github.com/petervandenabeele/dbd"
 # "fc47abbd-da2d-4562-bb6b-ed8b84005734","2013-06-19 22:02:20.489913758 UTC","","5eb1ea27-6691-4a57-ab13-8a59021968e1","dcterms:creator","@peter_v"
 # "f240e975-5d39-41eb-bb5a-cc59ede4c1a6","2013-06-19 22:02:20.489932320 UTC","","5eb1ea27-6691-4a57-ab13-8a59021968e1","dcterms:created","2013-06-19 22:02:20 UTC"
@@ -54,7 +54,7 @@ imported_graph = Dbd::Graph.new.from_CSV(csv)
 
 puts imported_graph.map(&:short)
 
-# [ prov ] : 5eb1ea27 : prov:context             : public
+# [ prov ] : 5eb1ea27 : prov:context_fact             : public
 # [ prov ] : 5eb1ea27 : prov:source              : http://github.com/petervandenabeele/dbd
 # [ prov ] : 5eb1ea27 : dcterms:creator          : @peter_v
 # [ prov ] : 5eb1ea27 : dcterms:created          : 2013-06-19 22:02:20 UTC

data/lib/dbd.rb

@@ -5,9 +5,9 @@ require 'dbd/version'
 require 'dbd/errors'
 require 'dbd/time_stamp'
 require 'dbd/fact'
-require 'dbd/provenance_fact'
+require 'dbd/context_fact'
 require 'dbd/resource'
-require 'dbd/provenance_resource'
+require 'dbd/context'
 require 'dbd/graph'
 
 require 'dbd/rdf_base'

data/lib/dbd/context.rb

@@ -0,0 +1,65 @@
+module Dbd
+  ##
+  # A Context is derived from a Resource, and is the
+  # set of all Contexts that share the same subject.
+  #
+  # It is pointed to by a context_subject of a Fact and has
+  # no context_subject itself (the context_subject
+  # relationship from Fact to ContextFact is not recursive).
+  class Context < Resource
+
+    ##
+    # Build a new Context.
+    #
+    # The subject can be either given as an argument or a new (random)
+    # subject is automatically set (see Resource for details).
+    #
+    # A context_subject may not be given here.
+    # @option options [Fact::Subject] :subject (new_subject) Optional: the subject for the resource
+    def initialize(options = {})
+      super
+    end
+
+    ##
+    # Add a ContextFact (strictly only a ContextFact).
+    #
+    # Side effect on the context_fact argument:
+    # * if it has no subject, the subject is set in the context_fact
+    # * if is has the same subject as the resource, added unchanged.
+    # * if it has a different subject, a SubjectError is raised.
+    def <<(context_fact)
+      super
+    end
+
+  private
+
+    # Should not be called in Context subclass.
+    def context_subject
+      raise NoMethodError, "context_subject should not be called in Context."
+    end
+
+    def set_context_subject(options)
+      raise ArgumentError, "context_subject must not be in the options" if options[:context_subject]
+    end
+
+    # Validate that context_subject is not present here.
+    # This should never raise as the setter was blocked above.
+    def validate_context_subject
+      raise ContextError if @context_subject
+    end
+
+    ##
+    # Assert _only_ Contexts here
+    def assert_fact_or_context_fact(context_fact)
+      raise ArgumentError, "Trying to add a non-ContextFact to a Context." unless context_fact.context_fact?
+    end
+
+    ##
+    # A noop for Context.
+    # @param [ContextFact] context_fact
+    def set_fact_context_subject!(context_fact)
+      # Do nothing
+    end
+
+  end
+end

data/lib/dbd/context_fact.rb

@@ -0,0 +1,76 @@
+module Dbd
+
+  ##
+  # ContextFact
+  #
+  # ContextFact is derived from Fact and behaves very similar.
+  #
+  # The ContextFacts with same subject form a Context and
+  # this is used as the target for the context_subject of a Fact.
+  #
+  # The context_subject of a ContextFact itself is empty, so the
+  # usage of context_subject is not recursive on this level (this
+  # allows efficient single pass loading in an underlying database).
+  #
+  # In the serialisation of a fact stream, the presence or absence of a
+  # context_subject marks the difference between a Fact and a ContextFact.
+  #
+  # The predicates of the ContextFacts in a Context would
+  # typically come from a defined context ontology (including provenance).
+  # Experimental examples of ontologies are built in the dbd_onto project.
+  class ContextFact < Fact
+
+    ##
+    # Builds a new ContextFact.
+    #
+    # @param [Hash{Symbol => Object}] options
+    # @option options [Fact::Subject] :subject (new_subject) Optional: the subject for the ContextFact
+    # @option options [String] :predicate Required: the subject for the ContextFact
+    # @option options [String] :object Required: the object for the ContextFact
+    def initialize(options)
+      validate_context_subject(options)
+      super
+    end
+
+    ##
+    # Executes the required update in used_context_subjects.
+    #
+    # For a ContextFact, there is no context_subject, so
+    # pointless to mark it in used_context_subjects hash.
+    def update_used_context_subjects(h)
+      # Do nothing (override the behaviour from super).
+    end
+
+    ##
+    # Validates the presence or absence of context_subject.
+    #
+    # Here, in the derived ContextFact, it must not be present.
+    # @param [#nil?] context_subject
+    # Return [nil, String] nil if valid, an error message if not
+    def context_subject_error(context_subject)
+      "ContextFact subject should not be present in ContextFact" if context_subject
+    end
+
+    ##
+    # Confirms this is a ContextFact
+    #
+    # Needed for validations that depend on different behavior for
+    # a context_fact (mainly, no context_subject).
+    def context_fact?
+      true
+    end
+
+  private
+
+    ##
+    # Validate that context_subject is not set here.
+    def validate_context_subject(options)
+      raise ContextError if options[:context_subject]
+    end
+
+    def context_subject_short
+      "[ cont ]"
+    end
+
+  end
+end

data/lib/dbd/errors.rb

@@ -3,7 +3,7 @@ module Dbd
   class OutOfOrderError < StandardError ; end
   class FactError < StandardError ; end
 
-  class ProvenanceError < StandardError ; end
+  class ContextError < StandardError ; end
   class SubjectError < StandardError ; end
   class PredicateError < StandardError ; end
   class ObjectError < StandardError ; end

data/lib/dbd/fact.rb

@@ -26,11 +26,11 @@ module Dbd
   #   creation of the fact, but it has to increase in strictly monotic
   #   order in a fact stream.
   #
-  # * a *provenance_subject* (a uuid)
+  # * a *context_subject* (a uuid)
   #
-  #   The subject of the ProvenanceResource (a set of ProvenanceFacts with
+  #   The subject of the Context (a set of Contexts with
   #   the same subject) about this fact. Each Fact, points *back* to a
-  #   ProvenanceResource (the ProvenanceResource must have been fully
+  #   Context (the Context must have been fully
   #   defined, earlier in a fact stream).
   #
   # * a *subject* (a uuid)
@@ -69,7 +69,7 @@ module Dbd
     def self.attributes
       [:id,
        :time_stamp,
-       :provenance_subject,
+       :context_subject,
        :subject,
        :predicate,
        :object]
@@ -88,24 +88,24 @@ module Dbd
     #
     # The input class is validated (easy confusion with String or Time).
     #
-    # @param [TimeStamp] :time_stamp a time_stamp (not a Time or a String)
+    # @param [TimeStamp] time_stamp a time_stamp (not a Time or a String)
     def time_stamp=(time_stamp)
       validate_time_stamp_class(time_stamp)
       set_once(:time_stamp, time_stamp)
     end
 
     ##
-    # A set_once setter for provenance_subject.
+    # A set_once setter for context_subject.
     #
-    # @param [String] :provenance_subject a string representation of the uuid
-    def provenance_subject=(provenance_subject)
-      set_once(:provenance_subject, provenance_subject)
+    # @param [String] context_subject a string representation of the uuid
+    def context_subject=(context_subject)
+      set_once(:context_subject, context_subject)
     end
 
     ##
     # A set_once setter for subject.
     #
-    # @param [String] :subject a string representation of the uuid
+    # @param [String] subject a string representation of the uuid
     def subject=(subject)
       set_once(:subject, subject)
     end
@@ -113,17 +113,17 @@ module Dbd
     ##
     # Builds a new Fact.
     #
-    # @param [Hash{Symbol => Object}] :options
+    # @param [Hash{Symbol => Object}] options
     # @option options [#to_s] :predicate Required : the predicate for this Fact
     # @option options [#to_s] :object Required :  the object for this Fact (required)
-    # @option options [String (uuid)] :provenance_subject (nil) Optional: the subject of the provenance(resource|fact)
+    # @option options [String (uuid)] :context_subject (nil) Optional: the subject of the Context
     # @option options [String (uuid)] :subject (nil) Optional: the subject for this Fact
     # @option options [TimeStamp] :time_stamp (nil) Optional: the time_stamp for this Fact
     # @option options [String (uuid)] :id Optional : set the id
     def initialize(options)
       @id = options[:id] || self.class.factory.new_id
       @time_stamp = options[:time_stamp]
-      @provenance_subject = options[:provenance_subject]
+      @context_subject = options[:context_subject]
       @subject = options[:subject]
       @predicate = options[:predicate]
       @object = options[:object]
@@ -157,7 +157,7 @@ module Dbd
     # of a few nanoseconds will be required to resolve collisions
     # on merge).
     #
-    # @param [Fact] :other the other fact to compare with
+    # @param [Fact] other the other fact to compare with
     # @return [trueish]
     def equivalent?(other)
       (self.class.attributes - [:time_stamp]).
@@ -168,26 +168,26 @@ module Dbd
     ##
     # @return [String] a short string representation of a Fact
     def short
-      "#{provenance_subject_short} : " \
+      "#{context_subject_short} : " \
       "#{subject.to_s[0...8]} : " \
       "#{predicate.to_s.ljust(24, ' ').truncate_utf8(24)} : " \
       "#{object.to_s.truncate_utf8(80).gsub(/\n/, '_')}"
     end
 
     ##
-    # Executes the required update in used_provenance_subjects.
+    # Executes the required update in used_context_subjects.
     #
-    # For a Fact, pointing to a ProvenanceResource in it's provenance_subject,
-    # marks this provenance_subject in the "used_provenance_subjects" hash that
+    # For a Fact, pointing to a Context in it's context_subject,
+    # marks this context_subject in the "used_context_subjects" hash that
     # is passed in as an argument (DCI). This will avoid further changes to the
-    # ProvenanceResource with this provenance_subject.
+    # Context with this context_subject.
     #
-    # This is overridden in the ProvenanceFact, since only relevant for a Fact.
+    # This is overridden in the ContextFact, since only relevant for a Fact.
     #
-    # @param[Hash] :h the hash that contains the provenance_subject index
-    def update_used_provenance_subjects(h)
-      # using a provenance_subject sets the key
-      h[provenance_subject] = true
+    # @param[Hash] :h the hash that contains the context_subject index
+    def update_used_context_subjects(h)
+      # using a context_subject sets the key
+      h[context_subject] = true
     end
 
     ##
@@ -199,40 +199,40 @@ module Dbd
       # * time_stamp not validated, is set automatically later
       # * predicate not validated, is validated upon creation
       # * object not validated, is validated upon creation
-      [provenance_subject_error(provenance_subject),
+      [context_subject_error(context_subject),
        subject ? nil : "Subject is missing"].compact
     end
 
     ##
-    # Validates the presence or absence of provenance_subject.
+    # Validates the presence or absence of context_subject.
     #
-    # Here, in (base) Fact, provenance_subject must be present.
+    # Here, in (base) Fact, context_subject must be present.
     #
-    # In the derived ProvenanceFact it must NOT be present.
+    # In the derived ContextFact it must NOT be present.
     # This is how the difference is encoded between Fact and
-    # ProvenanceFact in the fact stream.
+    # ContextFact in the fact stream.
     #
-    # @param [Object] provenance_subject
+    # @param [Object] context_subject
     # Return [nil, String] nil or an error message
-    def provenance_subject_error(provenance_subject)
-      "Provenance subject is missing" unless provenance_subject
+    def context_subject_error(context_subject)
+      "ContextFact subject is missing" unless context_subject
     end
 
     ##
-    # Confirms this is not a ProvenanceFact.
+    # Confirms this is not a ContextFact.
     #
     # Needed for validations that depend on different behavior for
-    # a provenance_fact (mainly, no provenance_subject).
+    # a context_fact (mainly, no context_subject).
     #
     # @return [trueish] false in the Fact implementation
-    def provenance_fact?
+    def context_fact?
       false
     end
 
   private
 
-    def provenance_subject_short
-      "#{provenance_subject.to_s[0...8]}"
+    def context_subject_short
+      "#{context_subject.to_s[0...8]}"
     end
 
     def validate_time_stamp_class(time_stamp)