adiwg-mdtranslator 2.13.0 → 2.13.1

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_medium.rb

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-21 refactored error and warning messaging
 #  Stan Smith 2016-10-20 original script
 
 require_relative 'module_citation'
@@ -15,14 +15,19 @@ module ADIWG
 
             module Medium
 
-               def self.unpack(hMedium, responseObj)
+               def self.unpack(hMedium, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hMedium.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: offline distribution medium object is empty'
+                     @MessagePath.issueWarning(550, responseObj, inContext)
                      return nil
                   end
 
+                  outContext = 'offline option'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # instance classes needed in script
                   intMetadataClass = InternalMetadata.new
                   intMedium = intMetadataClass.newMedium
@@ -31,7 +36,7 @@ module ADIWG
                   if hMedium.has_key?('mediumSpecification')
                      hObject = hMedium['mediumSpecification']
                      unless hObject.empty?
-                        hReturn = Citation.unpack(hObject, responseObj)
+                        hReturn = Citation.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intMedium[:mediumSpecification] = hReturn
                         end
@@ -86,7 +91,7 @@ module ADIWG
                   if hMedium.has_key?('identifier')
                      hObject = hMedium['identifier']
                      unless hObject.empty?
-                        hReturn = Identifier.unpack(hObject, responseObj)
+                        hReturn = Identifier.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intMedium[:identifier] = hReturn
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_metadata.rb

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-21 refactored error and warning messaging
 #  Stan Smith 2016-11-02 original script
 
 require_relative 'module_metadataInfo'
@@ -22,10 +22,11 @@ module ADIWG
 
                def self.unpack(hMetadata, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hMetadata.empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     @MessagePath.issueWarning(560, responseObj)
                      return nil
                   end
 
@@ -44,9 +45,7 @@ module ADIWG
                      end
                   end
                   if intMetadata[:metadataInfo].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata metadata-info object is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(561, responseObj)
                   end
 
                   # metadata - resource info {resourceInfo} (required)
@@ -60,9 +59,7 @@ module ADIWG
                      end
                   end
                   if intMetadata[:resourceInfo].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata resource info object is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(562, responseObj)
                   end
 
                   # metadata - resource lineage [] {lineage}

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_metadataInfo.rb

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-21 refactored error and warning messaging
 #  Stan Smith 2018-01-27 add metadataConstraints
 #  Stan Smith 2017-01-31 remove metadataCreationDate
 #  Stan Smith 2016-10-31 original script
@@ -25,11 +25,11 @@ module ADIWG
 
                def self.unpack(hMetaInfo, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hMetaInfo.empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata info object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     @MessagePath.issueError(570, responseObj)
                      return nil
                   end
 
@@ -37,11 +37,13 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intMetaInfo = intMetadataClass.newMetadataInfo
 
+                  outContext = 'metadata-info'
+
                   # metadata information - metadata identifier {identifier}
                   if hMetaInfo.has_key?('metadataIdentifier')
                      hObject = hMetaInfo['metadataIdentifier']
                      unless hObject.empty?
-                        hReturn = Identifier.unpack(hObject, responseObj)
+                        hReturn = Identifier.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intMetaInfo[:metadataIdentifier] = hReturn
                         end
@@ -52,7 +54,7 @@ module ADIWG
                   if hMetaInfo.has_key?('parentMetadata')
                      hObject = hMetaInfo['parentMetadata']
                      unless hObject.empty?
-                        hReturn = Citation.unpack(hObject, responseObj)
+                        hReturn = Citation.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intMetaInfo[:parentMetadata] = hReturn
                         end
@@ -63,7 +65,7 @@ module ADIWG
                   if hMetaInfo.has_key?('defaultMetadataLocale')
                      hObject = hMetaInfo['defaultMetadataLocale']
                      unless hObject.empty?
-                        hReturn = Locale.unpack(hObject, responseObj)
+                        hReturn = Locale.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intMetaInfo[:defaultMetadataLocale] = hReturn
                         end
@@ -74,7 +76,7 @@ module ADIWG
                   if hMetaInfo.has_key?('otherMetadataLocale')
                      aItems = hMetaInfo['otherMetadataLocale']
                      aItems.each do |item|
-                        hReturn = Locale.unpack(item, responseObj)
+                        hReturn = Locale.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intMetaInfo[:otherMetadataLocales] << hReturn
                         end
@@ -85,23 +87,21 @@ module ADIWG
                   if hMetaInfo.has_key?('metadataContact')
                      aItems = hMetaInfo['metadataContact']
                      aItems.each do |item|
-                        hReturn = ResponsibleParty.unpack(item, responseObj)
+                        hReturn = ResponsibleParty.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intMetaInfo[:metadataContacts] << hReturn
                         end
                      end
                   end
                   if intMetaInfo[:metadataContacts].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata info contact is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(571, responseObj, outContext)
                   end
 
                   # metadata information - metadata dates [] {date}
                   if hMetaInfo.has_key?('metadataDate')
                      aItems = hMetaInfo['metadataDate']
                      aItems.each do |item|
-                        hReturn = Date.unpack(item, responseObj)
+                        hReturn = Date.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intMetaInfo[:metadataDates] << hReturn
                         end
@@ -112,7 +112,7 @@ module ADIWG
                   if hMetaInfo.has_key?('metadataOnlineResource')
                      aItems = hMetaInfo['metadataOnlineResource']
                      aItems.each do |item|
-                        hReturn = OnlineResource.unpack(item, responseObj)
+                        hReturn = OnlineResource.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intMetaInfo[:metadataLinkages] << hReturn
                         end
@@ -122,7 +122,7 @@ module ADIWG
                   # metadata information - metadata constraint [] {constraint}
                   if hMetaInfo.has_key?('metadataConstraint')
                      hMetaInfo['metadataConstraint'].each do |hItem|
-                        hReturn = Constraint.unpack(hItem, responseObj)
+                        hReturn = Constraint.unpack(hItem, responseObj, outContext)
                         unless hReturn.nil?
                            intMetaInfo[:metadataConstraints] << hReturn
                         end
@@ -133,7 +133,7 @@ module ADIWG
                   if hMetaInfo.has_key?('metadataMaintenance')
                      hObject = hMetaInfo['metadataMaintenance']
                      unless hObject.empty?
-                        hReturn = Maintenance.unpack(hObject, responseObj)
+                        hReturn = Maintenance.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intMetaInfo[:metadataMaintenance] = hReturn
                         end
@@ -144,7 +144,7 @@ module ADIWG
                   if hMetaInfo.has_key?('alternateMetadataReference')
                      aItems = hMetaInfo['alternateMetadataReference']
                      aItems.each do |item|
-                        hReturn = Citation.unpack(item, responseObj)
+                        hReturn = Citation.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intMetaInfo[:alternateMetadataReferences] << hReturn
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_metadataRepository.rb

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-21 refactored error and warning messaging
 #  Stan Smith 2017-06-06 add citation to repository
 # 	Stan Smith 2017-02-09 original script
 
@@ -17,9 +17,11 @@ module ADIWG
 
                def self.unpack(hMdDist, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hMdDist.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: metadata repository object is empty'
+                     @MessagePath.issueWarning(580, responseObj)
                      return nil
                   end
 
@@ -27,20 +29,20 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intMdDist = intMetadataClass.newMetadataRepository
 
+                  outContext = 'metadata repository'
+
                   # metadata distribution - repository (required)
                   if hMdDist.has_key?('repository')
                      intMdDist[:repository] = hMdDist['repository']
                   end
                   if intMdDist[:repository].nil? || intMdDist[:repository] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata repository name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(581, responseObj)
                   end
 
                   # metadata distribution - citation
                   if hMdDist.has_key?('citation')
                      unless hMdDist['citation'].empty?
-                        hReturn = Citation.unpack(hMdDist['citation'], responseObj)
+                        hReturn = Citation.unpack(hMdDist['citation'], responseObj, outContext)
                         unless hReturn.nil?
                            intMdDist[:citation] = hReturn
                         end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_obliqueLinePoint.rb

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-21 refactored error and warning messaging
 # 	Stan Smith 2017-10-23 original script
 
 module ADIWG
@@ -12,12 +12,13 @@ module ADIWG
 
             module ObliqueLinePoint
 
-               def self.unpack(hLinePt, responseObj)
+               def self.unpack(hLinePt, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hLinePt.empty?
-                     responseObj[:readerExecutionMessages] <<
-                        'WARNING: mdJson reader: spatial reference oblique line-point object is empty'
+                     @MessagePath.issueWarning(590, responseObj, inContext)
                      return nil
                   end
 
@@ -30,10 +31,7 @@ module ADIWG
                      intLinePoint[:azimuthLineLatitude] = hLinePt['azimuthLineLatitude']
                   end
                   if intLinePoint[:azimuthLineLatitude].nil? || intLinePoint[:azimuthLineLatitude] == ''
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: spatial reference oblique line-point latitude is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(591, responseObj, inContext)
                   end
 
                   # oblique line point - azimuth line longitude (required)
@@ -41,10 +39,7 @@ module ADIWG
                      intLinePoint[:azimuthLineLongitude] = hLinePt['azimuthLineLongitude']
                   end
                   if intLinePoint[:azimuthLineLongitude].nil? || intLinePoint[:azimuthLineLongitude] == ''
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: spatial reference oblique line-point longitude is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(592, responseObj, inContext)
                   end
 
                   return intLinePoint

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_onlineResource.rb

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-22 refactored error and warning messaging
 # 	Stan Smith 2016-10-03 original script
 #  Stan Smith 2015-07-14 refactored to remove global namespace constants
 #  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
@@ -20,11 +20,13 @@ module ADIWG
 
             module OnlineResource
 
-               def self.unpack(hOnlineRes, responseObj)
+               def self.unpack(hOnlineRes, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hOnlineRes.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: online resource object is empty'
+                     @MessagePath.issueWarning(600, responseObj, inContext)
                      return nil
                   end
 
@@ -37,9 +39,7 @@ module ADIWG
                      intOLRes[:olResURI] = hOnlineRes['uri']
                   end
                   if intOLRes[:olResURI].nil? || intOLRes[:olResURI] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: online resource URI is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(601, responseObj, inContext)
                   end
 
                   # resource - web link protocol

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_orderProcess.rb

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-22 refactored error and warning messaging
 #  Stan Smith 2016-10-21 original script
 
 require_relative 'module_dateTime'
@@ -14,11 +14,13 @@ module ADIWG
 
             module OrderProcess
 
-               def self.unpack(hOrder, responseObj)
+               def self.unpack(hOrder, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hOrder.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: distribution order process object is empty'
+                     @MessagePath.issueWarning(610, responseObj, inContext)
                      return nil
                   end
 

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_party.rb

@@ -2,11 +2,9 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2018-06-22 refactored error and warning messaging
 # 	Stan Smith 2016-10-09 original script
 
-require_relative 'module_mdJson'
-
 module ADIWG
    module Mdtranslator
       module Readers
@@ -14,11 +12,13 @@ module ADIWG
 
             module Party
 
-               def self.unpack(hParty, responseObj)
+               def self.unpack(hParty, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hParty.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: responsibility party object is empty'
+                     @MessagePath.issueWarning(620, responseObj, inContext)
                      return nil
                   end
 
@@ -27,25 +27,25 @@ module ADIWG
                   intParty = intMetadataClass.newParty
 
                   # party - contact ID (required)
+                  # load party with contact index, contact type, and name
+                  # return nil if contact ID does not exist in contact array
                   if hParty.has_key?('contactId')
                      intParty[:contactId] = hParty['contactId']
+                     unless intParty[:contactId].nil? || intParty[:contactId] == ''
+                        hContact = @MessagePath.findContact(hParty['contactId'])
+                        if hContact[0].nil?
+                           outContext = 'contact ID ' + intParty[:contactId]
+                           outContext = inContext + ' > ' + outContext unless inContext.nil?
+                           @MessagePath.issueError(622, responseObj, outContext)
+                        else
+                           intParty[:contactIndex] = hContact[0]
+                           intParty[:contactType] = hContact[1]
+                           intParty[:contactName] = hContact[2]
+                        end
+                     end
                   end
                   if intParty[:contactId].nil? || intParty[:contactId] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: responsibility party contact ID is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
-                  end
-
-                  # party - contact index, contact type (computed)
-                  # return nil if contact ID does not exist in contact array
-                  hContact = MdJson.findContact(hParty['contactId'])
-                  if hContact[0].nil?
-                     responseObj[:readerExecutionMessages] << "ERROR: mdJson reader: responsibility party contact ID #{hParty['contactId']} not found"
-                     responseObj[:readerExecutionPass] = false
-                     return nil
-                  else
-                     intParty[:contactIndex] = hContact[0]
-                     intParty[:contactType] = hContact[1]
+                     @MessagePath.issueError(621, responseObj, inContext)
                   end
 
                   # party - organization members []
@@ -53,15 +53,12 @@ module ADIWG
                   if intParty[:contactType] == 'organization'
                      if hParty.has_key?('organizationMembers')
                         hParty['organizationMembers'].each do |contactId|
-                           hContact = MdJson.findContact(contactId)
+                           intParty[:organizationMembers] << contactId
+                           hContact = @MessagePath.findContact(contactId)
                            if hContact[0].nil?
-                              responseObj[:readerExecutionMessages] << "WARNING: mdJson reader: responsibility party organization member contact ID #{contactId} not found"
-                           else
-                              newParty = intMetadataClass.newParty
-                              newParty[:contactId] = contactId
-                              newParty[:contactIndex] = hContact[0]
-                              newParty[:contactType] = hContact[1]
-                              intParty[:organizationMembers] << newParty
+                              outContext = 'contact ID ' + contactId
+                              outContext = inContext + ' > ' + outContext unless inContext.nil?
+                              @MessagePath.issueWarning(623, responseObj, outContext)
                            end
                         end
                      end