rof 1.2.7 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 827e88ec60564b1d9f6dbf9c268db50994dc0c1c
-  data.tar.gz: 4bf1f3095bdf70cc8b2f0968eb3041b56be0ce2e
+  metadata.gz: 273923b81f29ea92d235344c8049639158b81659
+  data.tar.gz: 94ddc93adfa0d5f48cf1813c5a36a8d91aaf9643
 SHA512:
-  metadata.gz: 9495282350fb90ae4b7a6a039ff8412e3092b59c12ac069b0ca3cfb14383146327ceb2d9768cd9ecfb4e1853e0336afc4ac2b553c7ad26d19862c310a171d286
-  data.tar.gz: c8413636f1e6178d046f857d30d005c27781ec177880702b4074f0fa10f9815089b0e76920dc0be097e22007eed2a92f5ac7a4ba655cbaa3dcba951fabe9e46b
+  metadata.gz: 672c4233841ea90d6aed64756c5ce636f39cd8588ef8ee14d3b1ac53c6d300cd576263f80052ac66f54c67bf20b861bb455e12997c57d44557296dd389ba5d2d
+  data.tar.gz: 130fe821768bccd49307ff9a8ede1b8f078cbdd9247add97448c2f354e539a5eb64e95b8adbda09bcb49ec3d35e923d14d533b664af7d5474870f68f8b5a6396

data/lib/rof/translators/jsonld_to_rof.rb

@@ -8,7 +8,7 @@ module ROF
   module Translators
     # @api public
     #
-    # Responsible for converting JSON LD into an ROF Hash via registered URI maps.
+    # Responsible for converting JSON LD into an ROF Hash via registered URI maps via the `.call` method
     #
     # @note Some predicates require explicit mapping where as others have an assumed mapping. At present all URLs for @context of JSON-LD documents must be registered.
     #
@@ -34,20 +34,23 @@ module ROF
       end
 
       PredicateHandler.register('https://library.nd.edu/ns/terms/') do |handler|
-        handler.map('accessEdit', to: ['rights', 'edit'])
-        handler.map('accessRead', to: ['rights', 'read'])
-        handler.map('accessEditGroup', to: ['rights', 'edit-groups'])
-        handler.map('accessReadGroup', to: ['rights', 'read-groups'])
-        handler.map('accessEmbargoDate', to: ['rights', 'embargo-date'])
-        handler.map('afmodel', to: ["af-model"])
-        handler.map('bendoitem', to: ["bendo-item"])
+        handler.namespace_prefix('nd:')
+        handler.within(['metadata'])
+        handler.map('accessEdit', to: ['rights', 'edit'], force: true)
+        handler.map('accessRead', to: ['rights', 'read'], force: true)
+        handler.map('accessEditGroup', to: ['rights', 'edit-groups'], force: true)
+        handler.map('accessReadGroup', to: ['rights', 'read-groups'], force: true)
+        handler.map('accessEmbargoDate', to: ['rights', 'embargo-date'], multiple: false, force: true)
+        handler.map('afmodel', to: ["af-model"], force: true)
+        handler.map('alephIdentifier', to: ['alephIdentifier'], multiple: false)
+        handler.map('bendoitem', to: ["bendo-item"], multiple: false, force: true)
         handler.map('depositor') do |object, accumulator|
           accumulator.register_properties('depositor', object)
         end
         handler.map('owner') do |object, accumulator|
           accumulator.register_properties('owner', object)
         end
-        handler.map('representativeFile') do |object, accumulator|
+        handler.map('representativeFile', multiple: false) do |object, accumulator|
           accumulator.register_properties('representative', object)
         end
       end

data/lib/rof/translators/jsonld_to_rof/accumulator.rb

@@ -24,7 +24,6 @@ module ROF
           rof = @rof.deep_dup
           expand_blank_node_locations!(rof)
           rof = append_properties_to(rof)
-          rof = force_cardinality_for_backwards_compatability(rof)
           rof
         end
 
@@ -72,36 +71,11 @@ module ROF
         end
 
         class TooManyElementsError < RuntimeError
-          def initialize(context, expected_count, got_count)
-            super(%(Expected #{expected_count} in "#{context}" but instead got #{got_count}))
+          def initialize(context)
+            super(%(Attempted to set more than one value for #{context}))
           end
         end
 
-        def force_cardinality_for_backwards_compatability(rof)
-          rof = force_rights_cardinality(rof)
-          rof = force_bendo_cardinality(rof)
-          rof
-        end
-
-        def force_rights_cardinality(rof)
-          rights = rof.fetch('rights', {})
-          if rights.key?('embargo-date')
-            embargo_dates = Array.wrap(rights['embargo-date'])
-            raise TooManyElementsError.new('rights > embargo-date', 1, embargo_dates.size) if embargo_dates.size > 1
-            rof['rights']['embargo-date'] = embargo_dates.first
-          end
-          rof
-        end
-
-        def force_bendo_cardinality(rof)
-          if rof.key?('bendo-item')
-            bendo_items = Array.wrap(rof['bendo-item'])
-            raise TooManyElementsError.new('bendo-item', 1, bendo_items.size) if bendo_items.size > 1
-            rof['bendo-item'] = bendo_items.first
-          end
-          rof
-        end
-
         public
 
         # @api public
@@ -155,42 +129,54 @@ module ROF
         # @api public
         # @param [Array<String>, String] location - a list of nested hash keys (or a single string)
         # @param [String] value - a translated value for the original RDF Statement
-        # @param [false, RDF::Node] blank_node
+        # @param [Hash] options
+        # @option options [false, RDF::Node] blank_node
+        # @option options [Boolean] multiple  (default true) - if true will append values to an Array; if false will have a singular (non-Array) value
         # @return [Array] location, value
-        def add_predicate_location_and_value(location, value, blank_node = false)
+        def add_predicate_location_and_value(location, value, options = {})
+          blank_node = options.fetch(:blank_node, false)
+          multiple = options.fetch(:multiple, true)
           # Because I am making transformation on the location via #shift method, I need a duplication.
           location = Array.wrap(location)
           if location == ['pid']
             return add_pid(value)
           end
           if blank_node
-            add_predicate_location_and_value_direct_for_blank_node(location, value, blank_node)
+            add_predicate_location_and_value_direct_for_blank_node(location, value, blank_node, multiple)
           else
-            add_predicate_location_and_value_direct_for_non_blank_node(location, value)
+            add_predicate_location_and_value_direct_for_non_blank_node(location, value, multiple)
           end
           [location, value]
         end
 
-        def add_predicate_location_and_value_direct_for_blank_node(location, value, blank_node)
+        private
+
+        def add_predicate_location_and_value_direct_for_blank_node(location, value, blank_node, multiple)
           fetch_blank_node(blank_node) # Ensure the node exists
           @blank_node_locations[blank_node] ||= {}
           @blank_node_locations[blank_node][location[0..-2]] ||= []
           @blank_node_locations[blank_node][location[0..-2]] << { location[-1] => Array.wrap(coerce_object_to_string(value)) }
         end
 
-        def add_predicate_location_and_value_direct_for_non_blank_node(location, value)
+        def add_predicate_location_and_value_direct_for_non_blank_node(location, value, multiple)
           data = @rof
           location[0..-2].each do |slug|
             data[slug] ||= {}
             data = data[slug]
           end
           slug = location[-1]
-          data[slug] ||= []
-          data[slug] << coerce_object_to_string(value)
+          if multiple
+            data[slug] ||= []
+            data[slug] << coerce_object_to_string(value)
+          else
+            if data[slug].present?
+              raise TooManyElementsError.new(location)
+            else
+              data[slug] = coerce_object_to_string(value)
+            end
+          end
         end
 
-        private
-
         def coerce_object_to_string(object)
           return object if object.nil?
           if object.to_s =~ ROF::Translators::JsonldToRof::REGEXP_FOR_A_CURATE_RDF_SUBJECT

data/lib/rof/translators/jsonld_to_rof/predicate_handler.rb

@@ -4,6 +4,11 @@ module ROF
   module Translators
     module JsonldToRof
       # Responsible for dealing with registered predicates and how those are handled.
+      #
+      # The two primary entry points are `.call` and `.register`
+      #
+      # @see ROF::Translators::JsonldToRof::PredicateHandler.call
+      # @see ROF::Translators::JsonldToRof::PredicateHandler.register
       module PredicateHandler
         class UnhandledPredicateError < RuntimeError
           def initialize(predicate, urls)
@@ -38,6 +43,9 @@ module ROF
         end
 
         # @api public
+        #
+        # Register a map of an RDF Predicate URL to it's spot in the ROF Hash.
+        #
         # @param [String] url - The URL that we want to match against
         # @yield The block to configure how we handle RDF Predicates that match the gvien URL
         # @yieldparam [ROF::JsonldToRof::PredicateHandler::UrlHandler]
@@ -133,6 +141,7 @@ module ROF
           # @param [Hash] options (with symbol keys)
           # @option options [Boolean] :force - don't apply the within nor namespace prefix
           # @option options [Array] :to - an array that will be nested Hash keys
+          # @option options [Boolean] :multiple (default true) - if true will append values to an Array; if false will have a singular (non-Array) value
           # @yield If a block is given, call the block (and skip all other configuration)
           # @yieldparam [String] object
           # @see BlockSlugHandler for details concerning a mapping via a block
@@ -172,7 +181,7 @@ module ROF
             def call(object, accumulator, blank_node)
               to = @url_handler.within + Array.wrap(slug)
               to[-1] = "#{@url_handler.namespace_prefix}#{to[-1]}"
-              accumulator.add_predicate_location_and_value(to, object, blank_node)
+              accumulator.add_predicate_location_and_value(to, object, blank_node: blank_node)
             end
           end
           private_constant :ImplicitLocationHandler
@@ -203,11 +212,12 @@ module ROF
 
             def call(object, accumulator, blank_node)
               to = @options.fetch(:to)
+              multiple = @options.fetch(:multiple, true)
               unless force?
                 to = @url_handler.within + Array.wrap(to)
                 to[-1] = "#{@url_handler.namespace_prefix}#{to[-1]}"
               end
-              accumulator.add_predicate_location_and_value(to, object, blank_node)
+              accumulator.add_predicate_location_and_value(to, object, blank_node: blank_node, multiple: multiple)
             end
 
             def force?

data/lib/rof/translators/jsonld_to_rof/predicate_object_handler.rb

@@ -5,6 +5,8 @@ module ROF
   module Translators
     module JsonldToRof
       # We need to handle the Predicate / Object pair as one (thank you RDF blank nodes for this nuance)
+      #
+      # @see ROF::Translators::JsonldToRof::PredicateObjectHandler.call
       module PredicateObjectHandler
         # @api public
         #
@@ -39,6 +41,7 @@ module ROF
         def self.new(predicate, object, accumulator, options)
           klass_for(object).new(predicate, object, accumulator, options)
         end
+        private_class_method :new
 
         class UnknownRdfObjectTypeError < RuntimeError
         end
@@ -56,6 +59,7 @@ module ROF
             raise UnknownRdfObjectTypeError, "Unable to determine object handler for #{object.inspect}"
           end
         end
+        private_class_method :klass_for
 
         # @api private
         class UriPredicateObjectHandler

data/lib/rof/translators/jsonld_to_rof/statement_handler.rb

@@ -4,6 +4,8 @@ module ROF
   module Translators
     module JsonldToRof
       # Responsible for parsing an RDF statement and adding to the accumulator.
+      #
+      # @see ROF::Translators::JsonldToRof::StatementHandler.call
       module StatementHandler
         # @api public
         #

data/lib/rof/version.rb

@@ -1,3 +1,3 @@
 module ROF
-  VERSION="1.2.7"
+  VERSION="1.2.8"
 end

data/spec/fixtures/DLTP-1007/remediated-z029p269r94.jsonld

@@ -115,6 +115,7 @@
       "ms:degree": {
         "@id": "_:b3"
       },
+      "nd:bendoItem": "bendo1234",
       "nd:accessEdit": "curate_batch_user",
       "nd:accessReadGroup": "public",
       "nd:afmodel": "Etd",

data/spec/fixtures/DLTP-1015/dltp1015.jsonld

@@ -0,0 +1,62 @@
+{
+  "@context": {
+    "und": "https://curatesvrpprd.library.nd.edu/show/",
+    "bibo": "http://purl.org/ontology/bibo/",
+    "dc": "http://purl.org/dc/terms/",
+    "ebucore": "http://www.ebu.ch/metadata/ontologies/ebucore/ebucore#",
+    "foaf": "http://xmlns.com/foaf/0.1/",
+    "mrel": "http://id.loc.gov/vocabulary/relators/",
+    "nd": "https://library.nd.edu/ns/terms/",
+    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
+    "vracore": "http://purl.org/vra/",
+    "frels": "info:fedora/fedora-system:def/relations-external#",
+    "ms": "http://www.ndltd.org/standards/metadata/etdms/1.1/",
+    "pav": "http://purl.org/pav/",
+    "fedora-model": "info:fedora/fedora-system:def/model#",
+    "hydra": "http://projecthydra.org/ns/relations#",
+    "hasModel": {
+      "@id": "fedora-model:hasModel",
+      "@type": "@id"
+    },
+    "hasEditor": {
+      "@id": "hydra:hasEditor",
+      "@type": "@id"
+    },
+    "hasEditorGroup": {
+      "@id": "hydra:hasEditorGroup",
+      "@type": "@id"
+    },
+    "hasViewer": {
+      "@id": "hydra:hasViewer",
+      "@type": "@id"
+    },
+    "hasViewerGroup": {
+      "@id": "hydra:hasViewerGroup",
+      "@type": "@id"
+    },
+    "isPartOf": {
+      "@id": "frels:isPartOf",
+      "@type": "@id"
+    },
+    "isMemberOfCollection": {
+      "@id": "frels:isMemberOfCollection",
+      "@type": "@id"
+    },
+    "isEditorOf": {
+      "@id": "hydra:isEditorOf",
+      "@type": "@id"
+    },
+    "hasMember": {
+      "@id": "frels:hasMember",
+      "@type": "@id"
+    },
+    "previousVersion": "pav:previousVersion"
+  },
+  "@id": "und:9g54xg96r27",
+  "nd:alephIdentifier": "aleph123",
+  "nd:accessEmbargoDate": "2016-11-16",
+  "nd:bendoitem": "bendo123",
+  "nd:representativeFile": {
+    "@id": "und:representative123"
+  }
+}

data/spec/lib/rof/translators/jsonld_to_rof/accumulator_spec.rb

@@ -44,13 +44,26 @@ module ROF
             expect(subject.to_rof).to eq({ "hello" => { "world" => ["value"] }, "kitchen" => ["another"] } )
           end
 
+          context 'with multiple: true' do
+            it 'will raise an error if too many' do
+              subject.add_predicate_location_and_value(['hello', 'world'], "value", multiple: false)
+              expect do
+                subject.add_predicate_location_and_value(['hello', 'world'], "another", multiple: false)
+              end.to raise_error(described_class::TooManyElementsError)
+            end
+            it 'will not be an array (but instead a String)' do
+              subject.add_predicate_location_and_value(['hello', 'world'], "value", multiple: false)
+              expect(subject.to_rof.fetch('hello').fetch('world')).to eq('value')
+            end
+          end
+
           context 'handling blank nodes' do
             context 'for the same node' do
               it 'collects values for the same location' do
                 blank_node = RDF::Node.new('_b0')
                 subject.add_blank_node(RDF::Statement.new(blank_node, nil, nil))
-                subject.add_predicate_location_and_value(['parent', 'child'], "value", blank_node)
-                subject.add_predicate_location_and_value(['parent', 'child'], "another", blank_node)
+                subject.add_predicate_location_and_value(['parent', 'child'], "value", blank_node: blank_node)
+                subject.add_predicate_location_and_value(['parent', 'child'], "another", blank_node: blank_node)
                 expect(subject.to_rof).to eq({
                   "parent" => [{
                     "child" => ["value", "another"]
@@ -61,8 +74,8 @@ module ROF
               it 'collects values for the same deep location' do
                 blank_node = RDF::Node.new('_b0')
                 subject.add_blank_node(RDF::Statement.new(blank_node, nil, nil))
-                subject.add_predicate_location_and_value(['parent', 'child', 'grandchild'], "value", blank_node)
-                subject.add_predicate_location_and_value(['parent', 'child', 'grandchild'], "another", blank_node)
+                subject.add_predicate_location_and_value(['parent', 'child', 'grandchild'], "value", blank_node: blank_node)
+                subject.add_predicate_location_and_value(['parent', 'child', 'grandchild'], "another", blank_node: blank_node)
                 expect(subject.to_rof).to eq({
                   "parent" => {
                     "child" => [{
@@ -75,8 +88,8 @@ module ROF
               it 'collects values for the same location' do
                 blank_node = RDF::Node.new('_b0')
                 subject.add_blank_node(RDF::Statement.new(blank_node, nil, nil))
-                subject.add_predicate_location_and_value(['parent'], "value", blank_node)
-                subject.add_predicate_location_and_value(['parent'], "another", blank_node)
+                subject.add_predicate_location_and_value(['parent'], "value", blank_node: blank_node)
+                subject.add_predicate_location_and_value(['parent'], "another", blank_node: blank_node)
                 expect(subject.to_rof).to eq({
                   "parent" => ["value", "another"]
                 })
@@ -85,8 +98,8 @@ module ROF
               it 'merges different locations' do
                 blank_node = RDF::Node.new('_b0')
                 subject.add_blank_node(RDF::Statement.new(blank_node, nil, nil))
-                subject.add_predicate_location_and_value(['parent', 'child_one'], "value", blank_node)
-                subject.add_predicate_location_and_value(['parent', 'child_two'], "another", blank_node)
+                subject.add_predicate_location_and_value(['parent', 'child_one'], "value", blank_node: blank_node)
+                subject.add_predicate_location_and_value(['parent', 'child_two'], "another", blank_node: blank_node)
                 expect(subject.to_rof).to eq({
                   "parent" => [{
                     "child_one" => ["value"],
@@ -102,8 +115,8 @@ module ROF
                 blank_node_2 = RDF::Node.new('_b1')
                 subject.add_blank_node(RDF::Statement.new(blank_node_1, nil, nil))
                 subject.add_blank_node(RDF::Statement.new(blank_node_2, nil, nil))
-                subject.add_predicate_location_and_value(['parent', 'child'], "value", blank_node_1)
-                subject.add_predicate_location_and_value(['parent', 'child'], "another", blank_node_2)
+                subject.add_predicate_location_and_value(['parent', 'child'], "value", blank_node: blank_node_1)
+                subject.add_predicate_location_and_value(['parent', 'child'], "another", blank_node: blank_node_2)
                 expect(subject.to_rof).to eq({
                   "parent" => [{
                     "child" => ["value"]
@@ -115,70 +128,6 @@ module ROF
             end
           end
         end
-
-        describe '#to_rof' do
-          describe 'for embargo-date' do
-            let(:initial_rof) do
-              {
-                "rights"=> {
-                  "edit"=>["curate_batch_user"],
-                  "embargo-date"=>["2016-11-16"],
-                  "read"=>["wma1"],
-                  "read-groups"=>["public"]
-                }
-              }
-            end
-            context 'with one embargo-date' do
-              it 'will have a single embargo date' do
-                rof = initial_rof
-                rof['rights']['embargo-date'] = ['2016-1-2']
-                expect(described_class.new(rof).to_rof['rights'].fetch('embargo-date')).to eq('2016-1-2')
-              end
-            end
-            context 'with more than one embargo-date' do
-              it 'will raise an exception' do
-                rof = initial_rof
-                rof['rights']['embargo-date'] = ['2016-1-2', '2016-2-3']
-                expect { described_class.new(rof).to_rof }.to raise_error(described_class::TooManyElementsError)
-              end
-            end
-            context 'no embargo-date' do
-              it 'will not have an embargo-date' do
-                rof = initial_rof
-                rof['rights'].delete('embargo-date')
-                expect { described_class.new(rof).to_rof['rights'].fetch('embargo-date') }.to raise_error(KeyError)
-              end
-            end
-          end
-          describe 'bendo-item' do
-            let(:initial_rof) do
-              {
-                "bendo-item"=> ['abcd1']
-              }
-            end
-            context 'with one embargo-date' do
-              it 'will have a single embargo date' do
-                rof = initial_rof
-                rof['bendo-item'] = ['abcd1']
-                expect(described_class.new(rof).to_rof.fetch('bendo-item')).to eq('abcd1')
-              end
-            end
-            context 'with more than one embargo-date' do
-              it 'will raise an exception' do
-                rof = initial_rof
-                rof['bendo-item'] = ['abcd1', 'efgh1']
-                expect { described_class.new(rof).to_rof }.to raise_error(described_class::TooManyElementsError)
-              end
-            end
-            context 'no embargo-date' do
-              it 'will not have an embargo-date' do
-                rof = initial_rof
-                rof.delete('bendo-item')
-                expect { described_class.new(rof).to_rof.fetch('bendo-item') }.to raise_error(KeyError)
-              end
-            end
-          end
-        end
       end
     end
   end

data/spec/lib/rof/translators/jsonld_to_rof/predicate_handler_spec.rb

@@ -5,9 +5,11 @@ module ROF
     module JsonldToRof
       RSpec.describe PredicateHandler do
         around do |spec|
-          # Ensuring that we preserve duplication of
+          # Ensuring that we preserve duplication of registry.
+          # We take a snap-shot of the registry, clear, do our tests, then restore the registry
           previous_registry = described_class.send(:registry)
           described_class.send(:clear_registry!)
+
           described_class.register('https://library.nd.edu/ns/terms/') do |handler|
             handler.map('accessRead', to: ['rights', 'read'])
           end
@@ -26,6 +28,7 @@ module ROF
             handler.map('something', to: ['another', 'somewhere'])
           end
           spec.run
+
           described_class.send(:clear_registry!, previous_registry)
         end
 

data/spec/lib/rof/translators/jsonld_to_rof_spec.rb

@@ -28,6 +28,19 @@ module ROF
         end
       end
 
+      describe 'DLTP-1015 regression verification' do
+        it 'converts bendo-item, embargo-date, representative and alephNumber to string' do
+          jsonld_from_curatend = JSON.load(File.read(File.join(GEM_ROOT, "spec/fixtures/DLTP-1015/dltp1015.jsonld")))
+          output = described_class.call(jsonld_from_curatend, {})
+          expect(output.size).to eq(1)
+          object = output.first
+          expect(object.fetch('properties')).to include('<representative>und:representative123</representative>')
+          expect(object.fetch('rights').fetch('embargo-date')).to eq("2016-11-16")
+          expect(object.fetch('metadata').fetch('nd:alephIdentifier')).to eq("aleph123")
+          expect(object.fetch('bendo-item')).to eq("bendo123")
+        end
+      end
+
       describe '::REGEXP_FOR_A_CURATE_RDF_SUBJECT' do
         it 'handles data as expected' do
           [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rof
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.2.8
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdf
@@ -410,6 +410,7 @@ files:
 - rof.gemspec
 - spec/coverage_helper.rb
 - spec/fixtures/DLTP-1007/remediated-z029p269r94.jsonld
+- spec/fixtures/DLTP-1015/dltp1015.jsonld
 - spec/fixtures/DLTP-999/pr76f190f54.jsonld
 - spec/fixtures/a.json
 - spec/fixtures/for_utility_load_items_from_json_file/multiple_items.json
@@ -499,6 +500,7 @@ summary: Raw Object Format
 test_files:
 - spec/coverage_helper.rb
 - spec/fixtures/DLTP-1007/remediated-z029p269r94.jsonld
+- spec/fixtures/DLTP-1015/dltp1015.jsonld
 - spec/fixtures/DLTP-999/pr76f190f54.jsonld
 - spec/fixtures/a.json
 - spec/fixtures/for_utility_load_items_from_json_file/multiple_items.json