adiwg-mdtranslator 2.13.0 → 2.13.1

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-15 refactored error and warning messaging
 #  Stan Smith 2016-10-13 refactored for mdJson 2.0
 #  Stan Smith 2015-08-28 added alternate title
 #  Stan Smith 2015-07-14 refactored to remove global namespace constants
@@ -29,12 +29,13 @@ module ADIWG
 
             module Citation
 
-               def self.unpack(hCitation, responseObj)
+               def self.unpack(hCitation, responseObj, inContext = nil)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hCitation.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: citation object is empty'
+                     @MessagePath.issueWarning(80, responseObj, inContext)
                      return nil
                   end
 
@@ -42,14 +43,15 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intCitation = intMetadataClass.newCitation
 
+                  outContext = 'citation'
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # citation - title (required)
                   if hCitation.has_key?('title')
                      intCitation[:title] = hCitation['title']
                   end
                   if intCitation[:title].nil? || intCitation[:title] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: citation title is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(81, responseObj, inContext)
                   end
 
                   # citation - alternate title []
@@ -114,7 +116,7 @@ module ADIWG
                   if hCitation.has_key?('series')
                      hObject = hCitation['series']
                      unless hObject.empty?
-                        hReturn = Series.unpack(hObject, responseObj)
+                        hReturn = Series.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intCitation[:series] = hReturn
                         end
@@ -145,7 +147,7 @@ module ADIWG
                   if hCitation.has_key?('graphic')
                      aItems = hCitation['graphic']
                      aItems.each do |item|
-                        hReturn = Graphic.unpack(item, responseObj)
+                        hReturn = Graphic.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intCitation[:browseGraphics] << hReturn
                         end

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-16 refactored error and warning messaging
 # 	Stan Smith 2016-10-15 original script
 
 require_relative 'module_scope'
@@ -20,11 +20,13 @@ module ADIWG
 
             module Constraint
 
-               def self.unpack(hConstraint, responseObj)
+               def self.unpack(hConstraint, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hConstraint.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: constraint object is empty'
+                     @MessagePath.issueWarning(90, responseObj, inContext)
                      return nil
                   end
 
@@ -40,18 +42,18 @@ module ADIWG
                         if %w{ use legal security }.one? {|word| word == type}
                            intConstraint[:type] = hConstraint['type']
                         else
-                           responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: constraint type must be use, legal, or security'
-                           responseObj[:readerExecutionPass] = false
-                           return nil
+                           @MessagePath.issueError(91, responseObj, inContext)
                         end
                      end
                   end
                   if intConstraint[:type].nil? || intConstraint[:type] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: constraint type is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(92, responseObj, inContext)
                   end
 
+                  outContext = 'constraint'
+                  outContext = intConstraint[:type] + ' constraint' unless intConstraint[:type].nil?
+                  outContext = inContext + ' > ' + outContext unless inContext.nil?
+
                   # constraint - use limitation [] (required if type='use')
                   if hConstraint.has_key?('useLimitation')
                      hConstraint['useLimitation'].each do |item|
@@ -65,7 +67,7 @@ module ADIWG
                   if hConstraint.has_key?('scope')
                      hObject = hConstraint['scope']
                      unless hObject.empty?
-                        hReturn = Scope.unpack(hObject, responseObj)
+                        hReturn = Scope.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intConstraint[:scope] = hReturn
                         end
@@ -76,7 +78,7 @@ module ADIWG
                   if hConstraint.has_key?('graphic')
                      aGraphic = hConstraint['graphic']
                      aGraphic.each do |item|
-                        hGraphic = Graphic.unpack(item, responseObj)
+                        hGraphic = Graphic.unpack(item, responseObj, outContext)
                         unless hGraphic.nil?
                            intConstraint[:graphic] << hGraphic
                         end
@@ -87,7 +89,7 @@ module ADIWG
                   if hConstraint.has_key?('reference')
                      aReference = hConstraint['reference']
                      aReference.each do |item|
-                        hReference = Citation.unpack(item, responseObj)
+                        hReference = Citation.unpack(item, responseObj, outContext)
                         unless hReference.nil?
                            intConstraint[:reference] << hReference
                         end
@@ -98,7 +100,7 @@ module ADIWG
                   if hConstraint.has_key?('releasability')
                      hObject = hConstraint['releasability']
                      unless hObject.empty?
-                        hReturn = Releasability.unpack(hObject, responseObj)
+                        hReturn = Releasability.unpack(hObject, responseObj, outContext)
                         unless hReturn.nil?
                            intConstraint[:releasability] = hReturn
                         end
@@ -109,7 +111,7 @@ module ADIWG
                   if hConstraint.has_key?('responsibleParty')
                      aRParty = hConstraint['responsibleParty']
                      aRParty.each do |item|
-                        hParty = ResponsibleParty.unpack(item, responseObj)
+                        hParty = ResponsibleParty.unpack(item, responseObj, outContext)
                         unless hParty.nil?
                            intConstraint[:responsibleParty] << hParty
                         end
@@ -120,7 +122,7 @@ module ADIWG
                      if hConstraint.has_key?('legal')
                         hObject = hConstraint['legal']
                         unless hObject.empty?
-                           hReturn = LegalConstraint.unpack(hObject, responseObj)
+                           hReturn = LegalConstraint.unpack(hObject, responseObj, inContext)
                            unless hReturn.nil?
                               intConstraint[:legalConstraint] = hReturn
                            end
@@ -129,14 +131,10 @@ module ADIWG
                            end
                         end
                         if hObject.empty?
-                           responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: legal constraint object is missing'
-                           responseObj[:readerExecutionPass] = false
-                           return nil
+                           @MessagePath.issueError(93, responseObj, inContext)
                         end
                      else
-                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: legal constraint object is missing'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
+                        @MessagePath.issueError(93, responseObj, inContext)
                      end
                   end
 
@@ -144,7 +142,7 @@ module ADIWG
                      if hConstraint.has_key?('security')
                         hObject = hConstraint['security']
                         unless hObject.empty?
-                           hReturn = SecurityConstraint.unpack(hObject, responseObj)
+                           hReturn = SecurityConstraint.unpack(hObject, responseObj, inContext)
                            unless hReturn.nil?
                               intConstraint[:securityConstraint] = hReturn
                            end
@@ -153,14 +151,10 @@ module ADIWG
                            end
                         end
                         if hObject.empty?
-                           responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: security constraint object is missing'
-                           responseObj[:readerExecutionPass] = false
-                           return nil
+                           @MessagePath.issueError(94, responseObj, inContext)
                         end
                      else
-                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: security constraint object is missing'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
+                        @MessagePath.issueError(94, responseObj, inContext)
                      end
                   end
 

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-17 refactored error and warning messaging
 #  Stan Smith 2016-10-23 original script
 
 require_relative 'module_onlineResource'
@@ -19,11 +19,11 @@ module ADIWG
 
                def self.unpack(hContact, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
 
                   # return nil object if input is empty
                   if hContact.empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: contact object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     @MessagePath.issueWarning(100, responseObj)
                      return nil
                   end
 
@@ -31,14 +31,15 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intContact = intMetadataClass.newContact
 
+                  outContext = nil
+
                   # contact - contact id (required)
                   if hContact.has_key?('contactId')
                      intContact[:contactId] = hContact['contactId']
+                     outContext = 'contact ID ' + hContact['contactId']
                   end
                   if intContact[:contactId].nil? || intContact[:contactId] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: contact id is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(101, responseObj)
                   end
 
                   # contact - is organization (required)
@@ -65,14 +66,11 @@ module ADIWG
                   end
                   if intContact[:name].nil? || intContact[:name] == ''
                      if intContact[:isOrganization] === true
-                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: organization contact name is missing'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
-                     end
-                     if intContact[:positionName].nil? || intContact[:positionName] == ''
-                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: individual contact name and/or position are missing'
-                        responseObj[:readerExecutionPass] = false
-                        return nil
+                        @MessagePath.issueError(102, responseObj, outContext)
+                     else
+                        if intContact[:positionName].nil? || intContact[:positionName] == ''
+                           @MessagePath.issueError(103, responseObj, outContext)
+                        end
                      end
                   end
 
@@ -89,7 +87,7 @@ module ADIWG
                   if hContact.has_key?('logoGraphic')
                      aItems = hContact['logoGraphic']
                      aItems.each do |item|
-                        hReturn = Graphic.unpack(item, responseObj)
+                        hReturn = Graphic.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intContact[:logos] << hReturn
                         end
@@ -100,18 +98,19 @@ module ADIWG
                   if hContact.has_key?('phone')
                      aItems = hContact['phone']
                      aItems.each do |item|
-                        hReturn = Phone.unpack(item, responseObj)
+                        hReturn = Phone.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intContact[:phones] << hReturn
                         end
                      end
                   end
 
+                  # TODO need outContext
                   # contact - address [address]
                   if hContact.has_key?('address')
                      aItems = hContact['address']
                      aItems.each do |item|
-                        hReturn = Address.unpack(item, responseObj)
+                        hReturn = Address.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intContact[:addresses] << hReturn
                         end
@@ -131,7 +130,7 @@ module ADIWG
                   if hContact.has_key?('onlineResource')
                      aItems = hContact['onlineResource']
                      aItems.each do |item|
-                        hReturn = OnlineResource.unpack(item, responseObj)
+                        hReturn = OnlineResource.unpack(item, responseObj, outContext)
                         unless hReturn.nil?
                            intContact[:onlineResources] << hReturn
                         end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-06-17 refactored error and warning messaging
 #  Stan Smith 2018-02-20 original script
 
 require_relative 'module_mdJson'
@@ -15,15 +16,16 @@ module ADIWG
 
                def self.examine(aContact, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # test that all organizationMember IDs are in the contacts array
                   aContact.each do |hContact|
                      contactId = hContact[:contactId]
                      hContact[:memberOfOrgs].each do |orgId|
                         hOrg = MdJson.findContact(orgId)
                         if hOrg[0].nil?
-                           responseObj[:readerExecutionMessages] <<
-                              "ERROR: mdJson reader: contact #{contactId} organization contact ID #{orgId} not found"
-                           responseObj[:readerExecutionPass] = false
+                           outContext = "contact #{contactId}, membership organization ID #{orgId}"
+                           @MessagePath.issueWarning(110, responseObj, outContext)
                         end
                      end
                   end

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-17 refactored error and warning messaging
 # 	Stan Smith 2017-10-19 original script
 
 module ADIWG
@@ -12,12 +12,14 @@ module ADIWG
 
             module CoordinateResolution
 
-               def self.unpack(hCoordRes, responseObj)
+               def self.unpack(hCoordRes, responseObj, inContext = nil)
+
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
 
                   # return nil object if input is empty
                   if hCoordRes.empty?
-                     responseObj[:readerExecutionMessages] <<
-                        'WARNING: mdJson reader: spatial resolution coordinate resolution object is empty'
+                     @MessagePath.issueWarning(120, responseObj, inContext)
                      return nil
                   end
 
@@ -30,10 +32,7 @@ module ADIWG
                      intCoordRes[:abscissaResolutionX] = hCoordRes['abscissaResolutionX']
                   end
                   if intCoordRes[:abscissaResolutionX].nil? || intCoordRes[:abscissaResolutionX] == ''
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: coordinate spatial resolution abscissa resolution is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(121, responseObj, inContext)
                   end
 
                   # coordinate resolution - ordinate (Y) (required)
@@ -41,10 +40,7 @@ module ADIWG
                      intCoordRes[:ordinateResolutionY] = hCoordRes['ordinateResolutionY']
                   end
                   if intCoordRes[:ordinateResolutionY].nil? || intCoordRes[:ordinateResolutionY] == ''
-                     responseObj[:readerExecutionMessages] <<
-                        'ERROR: mdJson reader: coordinate spatial resolution ordinate resolution is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(122, responseObj, inContext)
                   end
 
                   # coordinate resolution - units of measure (required)
@@ -52,9 +48,7 @@ module ADIWG
                      intCoordRes[:unitOfMeasure] = hCoordRes['unitOfMeasure']
                   end
                   if intCoordRes[:unitOfMeasure].nil? || intCoordRes[:unitOfMeasure] == ''
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: coordinate spatial resolution units are missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(123, responseObj, inContext)
                   end
 
                   return intCoordRes

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-18 refactored error and warning messaging
 # 	Stan Smith 2016-10-18 original script
 
 require_relative 'module_identifier'
@@ -18,9 +18,11 @@ module ADIWG
 
                def self.unpack(hContent, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hContent.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: coverage description object is empty'
+                     @MessagePath.issueWarning(130, responseObj)
                      return nil
                   end
 
@@ -35,9 +37,7 @@ module ADIWG
                      end
                   end
                   if intContent[:coverageName].nil?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: coverage description name is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(131, responseObj)
                   end
 
                   # content information - coverage description (required)
@@ -47,9 +47,7 @@ module ADIWG
                      end
                   end
                   if intContent[:coverageDescription].nil?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: coverage description description is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(132, responseObj)
                   end
 
                   # content information - processing level code

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

@@ -2,7 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2018-06-18 refactored error and warning messaging
 #  Stan Smith 2018-01-25 rename dictionaryFormat to dictionaryFunctionalLanguage
 #  Stan Smith 2017-11-09 add dictionary description
 #  Stan Smith 2017-01-20 refactored for mdJson/mdTranslator 2.0
@@ -26,9 +26,11 @@ module ADIWG
 
                def self.unpack(hDictionary, responseObj)
 
+                  @MessagePath = ADIWG::Mdtranslator::Readers::MdJson::MdJson
+
                   # return nil object if input is empty
                   if hDictionary.empty?
-                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data dictionary object is empty'
+                     @MessagePath.issueWarning(140, responseObj)
                      return nil
                   end
 
@@ -55,9 +57,7 @@ module ADIWG
                      end
                   end
                   if intDictionary[:citation].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary citation is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(141, responseObj)
                   end
 
                   # dictionary - subject [] (required)
@@ -70,9 +70,7 @@ module ADIWG
                      end
                   end
                   if intDictionary[:subjects].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary subject is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(142, responseObj)
                   end
 
                   # dictionary - recommended use []
@@ -107,9 +105,7 @@ module ADIWG
                      end
                   end
                   if intDictionary[:responsibleParty].empty?
-                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary responsible party is missing'
-                     responseObj[:readerExecutionPass] = false
-                     return nil
+                     @MessagePath.issueError(143, responseObj)
                   end
 
                   # dictionary - dictionary format
@@ -119,8 +115,7 @@ module ADIWG
                      s = hDictionary['dictionaryFunctionalLanguage']
                   elsif hDictionary.has_key?('dictionaryFormat')
                      s = hDictionary['dictionaryFormat']
-                     responseObj[:readerExecutionMessages] <<
-                        'WARNING: mdJson reader: data dictionary dictionaryFormat is deprecated, use dictionaryFunctionalLanguage'
+                     @MessagePath.issueWarning(144, responseObj)
                   end
                   unless s.nil? || s == ''
                      intDictionary[:dictionaryFunctionalLanguage] = s