dbd 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c1d692a3ce886178a32b2dd624c2a69b4f380ed
-  data.tar.gz: 2ec48ccfd39bb4bab04e626eabc002b0b7c18105
+  metadata.gz: 3ca38e9fee78b3e02ca2a44da8dbef3e97a85df7
+  data.tar.gz: c55cee49db550fd26638ed9663e5e5efd3375351
 SHA512:
-  metadata.gz: 1fc7a48c2f7243febf3d8f8e34a6acb658dfc321ee81bae513fbed3635c9a07289f2b3a93a6f2f2c8fa745e367b6581f2afc965d96a3613b901dcb46096c13d9
-  data.tar.gz: 0130fe663c07bf96352c36ab6e90a6d2bae8cd0731625c71ff2bb49f96c9870ec5daf9dea680aac4946f9044669e0a792e1f452955a49e4f4dd31ef6aed74d3e
+  metadata.gz: 14542a1f13ab977fed503fbc3ca4b96b3c67c75262399aea0eb38d18e763d35273f8cd2ed21f6973076fc8304d8444b83454778aa5987eaa00a8dfbfd822001d
+  data.tar.gz: 5576b4725d7829b107aee1b025df605e847144938227373bb437d52c2f8e3325ea5d7023f6831bdef6afc4769a0e7d849b09472963c6de36e0f73ea4a798e1ac

data/Guardfile

@@ -4,4 +4,5 @@ guard 'rspec' do
   watch(%r{^lib/dbd/helpers})       { "spec" }
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
+  watch('lib/dbd.rb')           { "spec" }
 end

data/HISTORY.txt

@@ -11,3 +11,9 @@
 * Adding a (Provenance)Resource directly to a Graph with <<
 * Simplification and cleaner implementations
 * Adding Fact to a Resource now sets (provenance_)subject
+
+0.0.3 (26 May 2013)
+=====
+
+* relax performance spec (on JRuby on Travis can be a bit slower)
+* add (Provenance)Fact#short for easer viewing of fact stream

data/README.md

@@ -46,50 +46,54 @@ Open Source [MIT]
 
 ## Examples
 
-    require 'dbd'
-
-    provenance = Dbd::ProvenanceResource.new
-
-    # PREFIX provenance: <https://data.vandenabeele.com/ontologies/provenance#>
-    # PREFIX dcterms: <http://purl.org/dc/terms/>
-    fact_context_public = Dbd::ProvenanceFact.new(predicate: "provenance:context", object: "public")
-    fact_creator_peter_v = Dbd::ProvenanceFact.new(predicate: "dcterms:creator", object: "@peter_v")
-    fact_created_at_now = Dbd::ProvenanceFact.new(predicate: "provenance:created_at", object: Time.now.utc)
-    provenance << fact_context_public
-    provenance << fact_creator_peter_v
-    provenance << fact_created_at_now
-
-    nobel_peace_2012 = Dbd::Resource.new(provenance_subject: provenance.subject)
-
-    # PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
-    # PREFIX base: <https://data.vandenabeele.com/ontologies/base#>
-    fact_nobel_peace_2012 = Dbd::Fact.new(predicate: "base:nobelPeacePriceWinner", object: "2012")
-    fact_EU_label = Dbd::Fact.new(predicate: "rdfs:label", object: "EU") #  this will use some RDF predicates in future
-    fact_EU_comment = Dbd::Fact.new(predicate: "rdfs:comment", object: "European Union")
-    fact_EU_story = Dbd::Fact.new(predicate: "base:story", object: "A long period of peace,\n that is a \"bliss\".")
-    nobel_peace_2012 << fact_nobel_peace_2012
-    nobel_peace_2012 << fact_EU_label
-    nobel_peace_2012 << fact_EU_comment
-    nobel_peace_2012 << fact_EU_story
-
-    graph = Dbd::Graph.new
-
-    graph << provenance
-    graph << nobel_peace_2012
-
-    puts graph.to_CSV
-
-results in
-
-    $ ruby test.rb
-    "aaf11676-d016-4e74-a502-2db042ea8c67","2013-05-22 21:30:08.830374243 UTC","","3fe37986-0c00-45fb-a574-ed2d0374b3fc","provenance:context","public"
-    "1fd25f59-b838-4872-a290-4857e783a12c","2013-05-22 21:30:08.830416859 UTC","","3fe37986-0c00-45fb-a574-ed2d0374b3fc","dcterms:creator","@peter_v"
-    "f118e66a-aa96-4523-ae47-4f9ceff11916","2013-05-22 21:30:08.830434360 UTC","","3fe37986-0c00-45fb-a574-ed2d0374b3fc","provenance:created_at","2013-05-22 21:30:08 UTC"
-    "c2d29b70-7135-4434-829b-f0640475aeb5","2013-05-22 21:30:08.830450090 UTC","3fe37986-0c00-45fb-a574-ed2d0374b3fc","f628f608-27c3-4eb6-a687-cb121f793a4d","base:nobelPeacePriceWinner","2012"
-    "9c8048a5-b9e3-459c-9e82-6ae195ce22e6","2013-05-22 21:30:08.830465012 UTC","3fe37986-0c00-45fb-a574-ed2d0374b3fc","f628f608-27c3-4eb6-a687-cb121f793a4d","rdfs:label","EU"
-    "5e06472d-2146-4933-a31c-90873fa9ed26","2013-05-22 21:30:08.830478065 UTC","3fe37986-0c00-45fb-a574-ed2d0374b3fc","f628f608-27c3-4eb6-a687-cb121f793a4d","rdfs:comment","European Union"
-    "d984e5c3-8acd-4c50-b40f-4cacf9f8f5c7","2013-05-22 21:30:08.830489061 UTC","3fe37986-0c00-45fb-a574-ed2d0374b3fc","f628f608-27c3-4eb6-a687-cb121f793a4d","base:story","A long period of peace,
- that is a ""bliss""."
+```
+require 'dbd'
+
+provenance = Dbd::ProvenanceResource.new
+
+# PREFIX prov: <https://data.vandenabeele.com/ontologies/provenance#>
+# PREFIX dcterms: <http://purl.org/dc/terms/>
+fact_context_public  = Dbd::ProvenanceFact.new(predicate: "prov:context", object: "public")
+fact_source_dbd      = Dbd::ProvenanceFact.new(predicate: "prov:source",  object: "http://github.com/petervandenabeele/dbd")
+fact_creator_peter_v = Dbd::ProvenanceFact.new(predicate: "dcterms:creator", object: "@peter_v")
+fact_created_now     = Dbd::ProvenanceFact.new(predicate: "dcterms:created", object: Time.now.utc)
+provenance << fact_context_public
+provenance << fact_source_dbd
+provenance << fact_creator_peter_v
+provenance << fact_created_now
+
+nobel_peace_2012 = Dbd::Resource.new(provenance_subject: provenance.subject)
+
+# PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
+# PREFIX base: <https://data.vandenabeele.com/ontologies/base#>
+fact_nobel_peace_2012 = Dbd::Fact.new(predicate: "base:nobelPeacePriceWinner", object: "2012")
+fact_EU_label = Dbd::Fact.new(predicate: "rdfs:label", object: "EU") #  this will use some RDF predicates in future
+fact_EU_comment = Dbd::Fact.new(predicate: "rdfs:comment", object: "European Union")
+fact_EU_story = Dbd::Fact.new(predicate: "base:story", object: "A long period of peace,\n that is a \"bliss\".")
+nobel_peace_2012 << fact_nobel_peace_2012
+nobel_peace_2012 << fact_EU_label
+nobel_peace_2012 << fact_EU_comment
+nobel_peace_2012 << fact_EU_story
+
+graph = Dbd::Graph.new
+
+graph << provenance
+graph << nobel_peace_2012
+
+puts "facts in short representation:"
+puts graph.map(&:short)
+# [ prov ] : bbc2248e : prov:context             : public
+# [ prov ] : bbc2248e : prov:source              : http://github.com/petervandenabeele/dbd
+# [ prov ] : bbc2248e : dcterms:creator          : @peter_v
+# [ prov ] : bbc2248e : dcterms:created          : 2013-05-26 22:01:50 UTC
+# bbc2248e : 78edb900 : base:nobelPeacePriceWinn : 2012
+# bbc2248e : 78edb900 : rdfs:label               : EU
+# bbc2248e : 78edb900 : rdfs:comment             : European Union
+# bbc2248e : 78edb900 : base:story               : A long period of peace,_ that is a "bliss".
+
+puts "facts in full detail in CSV:"
+puts graph.to_CSV
+```
 
 [RDF]:              http://www.w3.org/RDF/
 [Rationale]:        http://github.com/petervandenabeele/dbd/blob/master/docs/rationale.md

data/docs/stories/012_provenance_fact_properties_from_provenance_ontology.txt

@@ -3,8 +3,8 @@
 As a client
 I can read the predicates for a provenance_fact from provenance ontology
 
-* make an ontology in a separate gem
+* make an ontology in a separate gem (dbd_onto)
 * import that gem
 * use this ontology to build a validated Provenance Resource
-* use this validate Provenance Resource instance to better buildi
+* use this validate Provenance Resource instance to better build
   a ProvenanceResource

data/docs/test.rb

@@ -2,14 +2,16 @@ require 'dbd'
 
 provenance = Dbd::ProvenanceResource.new
 
-# PREFIX provenance: <https://data.vandenabeele.com/ontologies/provenance#>
+# PREFIX prov: <https://data.vandenabeele.com/ontologies/provenance#>
 # PREFIX dcterms: <http://purl.org/dc/terms/>
-fact_context_public = Dbd::ProvenanceFact.new(predicate: "provenance:context", object: "public")
+fact_context_public  = Dbd::ProvenanceFact.new(predicate: "prov:context", object: "public")
+fact_source_dbd      = Dbd::ProvenanceFact.new(predicate: "prov:source",  object: "http://github.com/petervandenabeele/dbd")
 fact_creator_peter_v = Dbd::ProvenanceFact.new(predicate: "dcterms:creator", object: "@peter_v")
-fact_created_at_now = Dbd::ProvenanceFact.new(predicate: "provenance:created_at", object: Time.now.utc)
+fact_created_now     = Dbd::ProvenanceFact.new(predicate: "dcterms:created", object: Time.now.utc)
 provenance << fact_context_public
+provenance << fact_source_dbd
 provenance << fact_creator_peter_v
-provenance << fact_created_at_now
+provenance << fact_created_now
 
 nobel_peace_2012 = Dbd::Resource.new(provenance_subject: provenance.subject)
 
@@ -29,14 +31,25 @@ graph = Dbd::Graph.new
 graph << provenance
 graph << nobel_peace_2012
 
+puts "facts in short representation:"
+puts graph.map(&:short)
+# [ prov ] : bbc2248e : prov:context             : public
+# [ prov ] : bbc2248e : prov:source              : http://github.com/petervandenabeele/dbd
+# [ prov ] : bbc2248e : dcterms:creator          : @peter_v
+# [ prov ] : bbc2248e : dcterms:created          : 2013-05-26 22:01:50 UTC
+# bbc2248e : 78edb900 : base:nobelPeacePriceWinn : 2012
+# bbc2248e : 78edb900 : rdfs:label               : EU
+# bbc2248e : 78edb900 : rdfs:comment             : European Union
+# bbc2248e : 78edb900 : base:story               : A long period of peace,_ that is a "bliss".
+
+puts "facts in full detail in CSV:"
 puts graph.to_CSV
-
-# "9f868d99-af27-4d83-86ae-ea5f4a1fa654","2013-05-22 21:25:48.136527770 UTC","","a6e028dd-a340-49ce-b3f8-2f158e257a87","provenance:context","public"
-# "28496b40-1891-4bd0-9ee1-0c6c2a878cc1","2013-05-22 21:25:48.136596276 UTC","","a6e028dd-a340-49ce-b3f8-2f158e257a87","dcterms:creator","@peter_v"
-# "98b9dd72-3473-4500-814d-d955eec2c5ee","2013-05-22 21:25:48.136621174 UTC","","a6e028dd-a340-49ce-b3f8-2f158e257a87","provenance:created_at","2013-05-22 21:25:40 UTC"
-# "a0482b46-414d-40df-b436-41142728fda6","2013-05-22 21:25:55.367834295 UTC","a6e028dd-a340-49ce-b3f8-2f158e257a87","cd66aece-0b21-4e3e-8286-4191efb3aea1","base:nobelPeacePriceWinner","2012"
-# "c1af381d-800f-4279-a2cc-ccccf31f5134","2013-05-22 21:25:55.367891996 UTC","a6e028dd-a340-49ce-b3f8-2f158e257a87","cd66aece-0b21-4e3e-8286-4191efb3aea1","rdfs:label","EU"
-# "ac08843a-baae-49ea-a725-81b7e199e8f9","2013-05-22 21:25:55.367910018 UTC","a6e028dd-a340-49ce-b3f8-2f158e257a87","cd66aece-0b21-4e3e-8286-4191efb3aea1","rdfs:comment","European Union"
-# "6e91fa40-daa8-45d1-916e-f9b243d01f2c","2013-05-22 21:25:55.367928936 UTC","a6e028dd-a340-49ce-b3f8-2f158e257a87","cd66aece-0b21-4e3e-8286-4191efb3aea1","base:story","A long period of peace,
+# "4c825f73-eda9-4b7f-a925-352f079857fb","2013-05-26 22:01:50.446202656 UTC","","bbc2248e-89f0-4480-853d-1dba51f1801d","prov:context","public"
+# "09fc0e21-4749-44ab-858b-254dc24ee5a4","2013-05-26 22:01:50.446241720 UTC","","bbc2248e-89f0-4480-853d-1dba51f1801d","prov:source","http://github.com/petervandenabeele/dbd"
+# "8db7f62a-d94b-43b1-b3de-827fd0e8b324","2013-05-26 22:01:50.446259428 UTC","","bbc2248e-89f0-4480-853d-1dba51f1801d","dcterms:creator","@peter_v"
+# "0a76e215-cca5-44c7-9f58-f093e3ef0da7","2013-05-26 22:01:50.446272919 UTC","","bbc2248e-89f0-4480-853d-1dba51f1801d","dcterms:created","2013-05-26 22:01:50 UTC"
+# "fe7c7b67-5344-4e64-a690-49c5e054b862","2013-05-26 22:01:50.446288352 UTC","bbc2248e-89f0-4480-853d-1dba51f1801d","78edb900-0ab7-4dc3-9e00-272de6d47c03","base:nobelPeacePriceWinner","2012"
+# "f22bc359-e2e1-4ef1-bd8a-7f6b01d1b703","2013-05-26 22:01:50.446307209 UTC","bbc2248e-89f0-4480-853d-1dba51f1801d","78edb900-0ab7-4dc3-9e00-272de6d47c03","rdfs:label","EU"
+# "7ddc9674-fcff-40bf-9fc9-d5ccdf80cfad","2013-05-26 22:01:50.446321315 UTC","bbc2248e-89f0-4480-853d-1dba51f1801d","78edb900-0ab7-4dc3-9e00-272de6d47c03","rdfs:comment","European Union"
+# "dc664aee-44cd-4fc8-a6f0-fdcf4242e9c5","2013-05-26 22:01:50.446333480 UTC","bbc2248e-89f0-4480-853d-1dba51f1801d","78edb900-0ab7-4dc3-9e00-272de6d47c03","base:story","A long period of peace,
 # that is a ""bliss""."
-

data/lib/dbd/fact.rb

@@ -139,6 +139,15 @@ module Dbd
       self.class.attributes.map{ |attribute| self.send(attribute) }
     end
 
+    ##
+    # @return [String] a short string representation of a Fact
+    def short
+      "#{provenance_subject_short} : " \
+      "#{subject.to_s[0...8]} : " \
+      "#{predicate.to_s.ljust(24, ' ')[0...24]} : " \
+      "#{object.to_s[0..60].gsub(/\n/, '_')}"
+    end
+
     ##
     # Executes the required update in used_provenance_subjects.
     #
@@ -181,5 +190,11 @@ module Dbd
       "Provenance subject is missing" unless provenance_subject
     end
 
+  private
+
+    def provenance_subject_short
+      "#{provenance_subject.to_s[0...8]}"
+    end
+
   end
 end

data/lib/dbd/provenance_fact.rb

@@ -72,5 +72,9 @@ module Dbd
       raise ProvenanceError if options[:provenance_subject]
     end
 
+    def provenance_subject_short
+      "[ prov ]"
+    end
+
   end
 end

data/lib/dbd/version.rb

@@ -1,3 +1,3 @@
 module Dbd
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/factories/fact.rb

@@ -48,6 +48,14 @@ module Factories
         object: "European Union")
     end
 
+    def self.fact_with_newline(provenance_subject = nil, subject = nil)
+      factory_for.new(
+        provenance_subject: provenance_subject,
+        subject: subject,
+        predicate: "http://example.org/test/comment",
+        object: "A long story\nreally.")
+    end
+
     module Collection
 
       def self.factory_for_instance

data/spec/factories/provenance_fact.rb

@@ -20,7 +20,7 @@ module Factories
       factory_for.new(
         subject: subject,
         predicate: "https://data.vandenabeele.com/ontologies/provenance#created_by",
-        object:"peter_v")
+        object: "peter_v")
     end
 
     def self.original_source(subject = nil)
@@ -30,5 +30,12 @@ module Factories
         object: "this has a comma , a newline \n and a double quote \"")
     end
 
+    def self.created(subject = nil)
+      factory_for.new(
+        subject: subject,
+        predicate: "dcterms:created",
+        object: Time.now.utc)
+    end
+
   end
 end

data/spec/lib/dbd/fact_spec.rb

@@ -11,6 +11,7 @@ module Dbd
     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) }
+    let(:fact_with_newline) { Factories::Fact.fact_with_newline(provenance_subject) }
 
     describe ".new_subject" do
       it "creates a new (random) subject" do
@@ -59,7 +60,6 @@ module Dbd
     end
 
     describe "time_stamp=" do
-
       it "checks the type (too easy to try to give a Time arg" do
         lambda { fact_1.time_stamp = Time.now } . should raise_error(ArgumentError)
       end
@@ -82,6 +82,19 @@ module Dbd
       end
     end
 
+    describe "short" do
+      it "for a base fact shows provenance, subj, predicate, object" do
+        fact_1.subject = subject
+        fact_1.time_stamp = TimeStamp.new
+        fact_1.short.should match(/^[0-9a-f]{8} : [0-9a-f]{8} : http:\/\/example\.org\/test\/ : Gandhi$/)
+      end
+
+      it "for a fact with a newline replaces it with a underscore" do
+        fact_with_newline.subject = subject
+        fact_with_newline.short.should match(/^[0-9a-f]{8} : [0-9a-f]{8} : http:\/\/example\.org\/test\/ : A long story_really.$/)
+      end
+    end
+
     describe "errors" do
       it "the factory has no errors" do
         fact_2_with_subject.errors.should be_empty

data/spec/lib/dbd/provenance_fact_spec.rb

@@ -14,6 +14,10 @@ module Dbd
         Factories::ProvenanceFact.created_by(subject)
       end
 
+      let(:provenance_fact_created) do
+        Factories::ProvenanceFact.created(subject)
+      end
+
       describe "#new" do
         it "has a unique id (new_id.class)" do
           provenance_fact_1.id.should be_a(id_class)
@@ -48,6 +52,16 @@ module Dbd
         end
       end
 
+      describe "short" do
+        it "for a provenance fact shows [ prov ], subj, predicate, object" do
+          provenance_fact_1.short.should match(/^\[ prov \] : [0-9a-f]{8} : https:\/\/data\.vandenabeel : public$/)
+        end
+
+        it "for a provenance fact with non string object also works" do
+          provenance_fact_created.short.should match(/^\[ prov \] : [0-9a-f]{8} : dcterms:created          : \d{4}/)
+        end
+      end
+
       describe "errors" do
 
         it "the factory has no errors" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbd
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Peter Vandenabeele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler