adiwg-mdtranslator 2.9.2 → 2.10.0

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_spatialDomain.rb

@@ -65,38 +65,59 @@ module ADIWG
                   hIntExtent[:geographicExtents] << hIntGeoExtent
                   hIntExtent[:description] = 'FGDC spatial domain'
 
-                  # spatial domain bio (descgeog) - geographic description
+                  # spatial domain bio (descgeog) - geographic description (required)
                   description = xDomain.xpath('./descgeog').text
                   unless description.empty?
                      hIntGeoExtent[:description] = description
                   end
+                  if description.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: BIO geographic description is missing'
+                  end
 
-                  # spatial domain 1.5.1 (bounding) - bounding box
+                  # spatial domain 1.5.1 (bounding) - bounding box (required)
                   xBbox = xDomain.xpath('./bounding')
                   unless xBbox.empty?
                      hBbox = intMetadataClass.newBoundingBox
 
-                     # bounding box 1.5.1.1 (westbc) - west coordinate
+                     # bounding box 1.5.1.1 (westbc) - west coordinate (required)
                      hBbox[:westLongitude] = xBbox.xpath('./westbc').text.to_f
+                     if hBbox[:westLongitude].nil?
+                        hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: bounding box west boundary is missing'
+                     end
 
-                     # bounding box 1.5.1.2 (eastbc) - east coordinate
+                     # bounding box 1.5.1.2 (eastbc) - east coordinate (required)
                      hBbox[:eastLongitude] = xBbox.xpath('./eastbc').text.to_f
+                     if hBbox[:eastLongitude].nil?
+                        hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: bounding box east boundary is missing'
+                     end
 
-                     # bounding box 1.5.1.3 (northbc) - north coordinate
+                     # bounding box 1.5.1.3 (northbc) - north coordinate (required)
                      hBbox[:northLatitude] = xBbox.xpath('./northbc').text.to_f
+                     if hBbox[:northLatitude].nil?
+                        hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: bounding box north boundary is missing'
+                     end
 
-                     # bounding box 1.5.1.4 (southbc) - south coordinate
+                     # bounding box 1.5.1.4 (southbc) - south coordinate (required)
                      hBbox[:southLatitude] = xBbox.xpath('./southbc').text.to_f
+                     if hBbox[:southLatitude].nil?
+                        hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: bounding box south boundary is missing'
+                     end
 
                      # bounding box bio (boundalt) - altitude
                      xAltitude = xBbox.xpath('./boundalt')
                      unless xAltitude.empty?
 
-                        # bounding box bio (altmin) - minimum altitude
+                        # bounding box bio (altmin) - minimum altitude (required)
                         hBbox[:minimumAltitude] = xAltitude.xpath('./altmin').text.to_f
+                        if hBbox[:minimumAltitude].nil?
+                           hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: BIO bounding box minimum altitude is missing'
+                        end
 
-                        # bounding box bio (altmax) - maximum altitude
+                        # bounding box bio (altmax) - maximum altitude (required)
                         hBbox[:maximumAltitude] = xAltitude.xpath('./altmax').text.to_f
+                        if hBbox[:maximumAltitude].nil?
+                           hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: BIO bounding box maximum altitude is missing'
+                        end
 
                         # bounding box bio (altunit) - altitude unit of measure
                         hBbox[:unitsOfAltitude] = xAltitude.xpath('./altunit').text
@@ -105,6 +126,9 @@ module ADIWG
 
                      hIntGeoExtent[:boundingBox] = hBbox
                   end
+                  if xBbox.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: bounding box is missing'
+                  end
 
                   # spatial domain 1.5.2 (dsgpoly) - data set geographic polygon []
                   axPoly = xDomain.xpath('//dsgpoly')

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_taxonClass.rb

@@ -21,19 +21,25 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   hTaxonClass = intMetadataClass.newTaxonClass
 
-                  # taxonomy bio.4.1 (taxonrn) - taxon rank name
+                  # taxonomy bio.4.1 (taxonrn) - taxon rank name (required)
                   # -> resourceInfo.taxonomy.taxonClass.taxonRank
                   rankName = xTaxonClass.xpath('./taxonrn').text
                   unless rankName.empty?
                      hTaxonClass[:taxonRank] = rankName
                   end
+                  if rankName.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: BIO taxon classification rank name is missing'
+                  end
 
-                  # taxonomy bio.4.2 (taxonrv) - taxon rank value
+                  # taxonomy bio.4.2 (taxonrv) - taxon rank value (required)
                   # -> resourceInfo.taxonomy.taxonClass.taxonValue
                   rankValue = xTaxonClass.xpath('./taxonrv').text
                   unless rankValue.empty?
                      hTaxonClass[:taxonValue] = rankValue
                   end
+                  if rankValue.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: BIO taxon classification rank value is missing'
+                  end
 
                   # taxonomy bio.4.3 (common) - taxon common name []
                   # -> resourceInfo.taxonomy.taxonClass.commonNames

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_taxonSystem.rb

@@ -21,7 +21,7 @@ module ADIWG
                   # instance classes needed in script
                   intMetadataClass = InternalMetadata.new
 
-                  # taxonomy bio.2.1 (classsys) - taxonomic classification authority []
+                  # taxonomy bio.2.1 (classsys) - taxonomic classification authority [] (required)
                   # -> resourceInfo.taxonomy.taxonSystem
                   axTaxClass = xSystem.xpath('./classsys')
                   unless axTaxClass.empty?
@@ -29,7 +29,7 @@ module ADIWG
 
                         hTaxonSystem = intMetadataClass.newTaxonSystem
 
-                        # taxonomy bio.2.1.1 (classcit) - taxonomic classification citation {citation}
+                        # taxonomy bio.2.1.1 (classcit) - taxonomic classification citation {citation} (required)
                         # -> resourceInfo.taxonomy.taxonSystem.citation
                         xCitation = xTaxClass.xpath('./classcit')
                         unless xCitation.empty?
@@ -38,6 +38,9 @@ module ADIWG
                               hTaxonSystem[:citation] = hCitation
                            end
                         end
+                        if xCitation.empty?
+                           hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: BIO taxonomy classification system citation missing'
+                        end
 
                         # taxonomy bio.2.1.2 (classmod) - taxonomic classification modifications
                         # -> resourceInfo.taxonomy.taxonSystem.modifications
@@ -50,6 +53,9 @@ module ADIWG
 
                      end
                   end
+                  if axTaxClass.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: BIO taxonomy classification system is missing'
+                  end
 
                   # taxonomy bio.2.2 (idref) - taxonomic identification reference [] {identifier}
                   # -> resourceInfo.taxonomy.idReferences.authority
@@ -79,12 +85,15 @@ module ADIWG
                      end
                   end
 
-                  # taxonomy bio.2.4 (taxonpro) - taxonomic procedures
+                  # taxonomy bio.2.4 (taxonpro) - taxonomic procedures (required)
                   # -> resourceInfo.taxonomy.idProcedure
                   procedures = xSystem.xpath('./taxonpro').text
                   unless procedures.empty?
                      hTaxonomy[:idProcedure] = procedures
                   end
+                  if procedures.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: BIO taxonomy classification procedures are missing'
+                  end
 
                   # taxonomy bio.2.5 (taxoncom) - taxonomic completeness
                   # -> resourceInfo.taxonomy.idCompleteness
@@ -101,14 +110,17 @@ module ADIWG
 
                         hVoucher = intMetadataClass.newTaxonVoucher
 
-                        # taxonomy bio.2.6.1 (specimen) - specimen
+                        # taxonomy bio.2.6.1 (specimen) - specimen (required)
                         # -> resourceInfo.taxonomy.vouchers.specimen
                         specimen = xVoucher.xpath('./specimen').text
                         unless specimen.empty?
                            hVoucher[:specimen] = specimen
                         end
+                        if procedures.empty?
+                           hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: BIO taxonomy voucher specimen is missing'
+                        end
 
-                        # taxonomy bio.2.6.2 (reposit) - repository {contact}
+                        # taxonomy bio.2.6.2 (reposit) - repository {contact} (required)
                         # -> resourceInfo.taxonomy.vouchers.repository
                         xRepository = xVoucher.xpath('./reposit')
                         unless xRepository.empty?
@@ -118,6 +130,9 @@ module ADIWG
                               hVoucher[:repository] = hResponsibility
                            end
                         end
+                        if xRepository.empty?
+                           hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: BIO taxonomy voucher repository is missing'
+                        end
 
                         hTaxonomy[:vouchers] << hVoucher
 

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_taxonomy.rb

@@ -23,7 +23,7 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   hTaxonomy = intMetadataClass.newTaxonomy
 
-                  # taxonomy bio.1 (keywtax) - taxonomic keywords [] {keyword}
+                  # taxonomy bio.1 (keywtax) - taxonomic keywords [] {keyword} (required)
                   # -> resourceInfo.keywords
                   axKeywords = xTaxonomy.xpath('./keywtax')
                   unless axKeywords.empty?
@@ -31,6 +31,9 @@ module ADIWG
                         Keyword.unpack(xKeyword, hResourceInfo, hResponseObj)
                      end
                   end
+                  if axKeywords.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: BIO taxonomy keywords are missing'
+                  end
 
                   # taxonomy bio.2 (taxonsys) - taxonomic system
                   xSystem = xTaxonomy.xpath('./taxonsys')
@@ -45,7 +48,7 @@ module ADIWG
                      hTaxonomy[:generalScope] = general
                   end
 
-                  # taxonomy bio.4 (taxoncl) - taxonomic classification
+                  # taxonomy bio.4 (taxoncl) - taxonomic classification (required)
                   # -> resourceInfo.taxonomy.taxonClass
                   xTaxClass = xTaxonomy.xpath('./taxoncl')
                   unless xTaxClass.empty?
@@ -54,6 +57,9 @@ module ADIWG
                         hTaxonomy[:taxonClass] = hTaxonClass
                      end
                   end
+                  if xTaxClass.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: BIO taxonomy classification is missing'
+                  end
 
                   return hTaxonomy
 

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_transferInfo.rb

@@ -31,7 +31,7 @@ module ADIWG
                      hFormat[:technicalPrerequisite] = techPre
                   end
 
-                  # distribution 6.4.2.1.1 (formname) - format name
+                  # distribution 6.4.2.1.1 (formname) - format name (required)
                   # -> transferOption.distributionFormat.formatSpecification.title
                   # -> transferOption.distributionFormat.formatSpecification.identifier[].identifier
                   formName = xTranInfo.xpath('./formname').text
@@ -39,6 +39,9 @@ module ADIWG
                      hSpecification[:title] = formName
                      hSpecification[:identifiers][0][:identifier] = formName
                   end
+                  if formName.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: distribution transfer format name is missing'
+                  end
 
                   # distribution 6.4.2.1.2 (formvern) - format version number
                   # -> transferOption.distributionFormat.formatSpecification.edition

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_verticalAltitude.rb

@@ -22,12 +22,15 @@ module ADIWG
 
                   hDatum[:isDepthSystem] = false
 
-                  # altitude datum 4.2.1.1 (altdatum) - altitude datum name
+                  # altitude datum 4.2.1.1 (altdatum) - altitude datum name (required)
                   # -> referenceSystemParameters.verticalDatum.datumName
                   datumName = xAltSys.xpath('./altdatum').text
                   unless datumName.empty?
                      hDatum[:datumName] = datumName
                   end
+                  if datumName.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: vertical altitude datum name is missing'
+                  end
 
                   # altitude datum 4.2.1.2 (altres) - altitude resolution []
                   # -> referenceSystemParameters.verticalDatum.verticalResolution
@@ -36,19 +39,25 @@ module ADIWG
                      hDatum[:verticalResolution] = altRes.to_f
                   end
 
-                  # altitude datum 4.2.1.3 (altunits) -  altitude distance units
+                  # altitude datum 4.2.1.3 (altunits) -  altitude distance units (required)
                   # -> referenceSystemParameters.verticalDatum.unitOfMeasure
                   altUnits = xAltSys.xpath('./altunits').text
                   unless altUnits.empty?
                      hDatum[:unitOfMeasure] = altUnits
                   end
+                  if altUnits.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: vertical altitude distance units are missing'
+                  end
 
-                  # altitude datum 4.2.1.4 (altenc) - altitude encoding method
+                  # altitude datum 4.2.1.4 (altenc) - altitude encoding method (required)
                   # -> referenceSystemParameters.verticalDatum.encodingMethod
                   altEncode = xAltSys.xpath('./altenc').text
                   unless altEncode.empty?
                      hDatum[:encodingMethod] = altEncode
                   end
+                  if altEncode.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: vertical altitude encoding method is missing'
+                  end
 
                   hParamSet = intMetadataClass.newReferenceSystemParameterSet
                   hRefSystem = intMetadataClass.newSpatialReferenceSystem

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_verticalDepth.rb

@@ -27,6 +27,9 @@ module ADIWG
                   unless datumName.empty?
                      hDatum[:datumName] = datumName
                   end
+                  if datumName.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: vertical depth datum name is missing'
+                  end
 
                   # depth datum 4.2.2.2 (depthres) - depth resolution [] (take first)
                   # -> referenceSystemParameters.verticalDatum.verticalResolution
@@ -41,6 +44,9 @@ module ADIWG
                   unless depthUnits.empty?
                      hDatum[:unitOfMeasure] = depthUnits
                   end
+                  if depthUnits.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: vertical depth distance units are missing'
+                  end
 
                   # depth datum 4.2.2.4 (depthem) - depth encoding method
                   # -> referenceSystemParameters.verticalDatum.encodingMethod
@@ -48,6 +54,9 @@ module ADIWG
                   unless depthEncode.empty?
                      hDatum[:encodingMethod] = depthEncode
                   end
+                  if depthEncode.empty?
+                     hResponseObj[:readerExecutionMessages] << 'WARNING: FGDC reader: vertical depth encoding method is missing'
+                  end
 
                   hParamSet = intMetadataClass.newReferenceSystemParameterSet
                   hRefSystem = intMetadataClass.newSpatialReferenceSystem

data/lib/adiwg/mdtranslator/readers/fgdc/version.rb

@@ -1,13 +1,14 @@
 # adiwg mdTranslator / readers / fgdc
 
 # version 1 history
+# 1.0.1 2018-02-15 add messaging
 # 1.0.0 2017-07-11 version 1 FGDC CSDGM
 
 module ADIWG
    module Mdtranslator
       module Readers
          module Fgdc
-            VERSION = "1.0.0"
+            VERSION = "1.0.1"
          end
       end
    end

data/lib/adiwg/mdtranslator/readers/mdJson/mdJson_reader.rb

@@ -36,7 +36,7 @@ module ADIWG
                begin
                   hMdJson = JSON.parse(file)
                rescue JSON::JSONError => err
-                  hResponseObj[:readerStructureMessages] << 'Parsing mdJson Failed - see following message(s):\n'
+                  hResponseObj[:readerStructureMessages] << 'ERROR: mdJson reader: Parsing mdJson Failed - see following message(s):\n'
                   hResponseObj[:readerStructureMessages] << err.to_s.slice(0, 300)
                   hResponseObj[:readerStructurePass] = false
                   return {}
@@ -44,45 +44,45 @@ module ADIWG
 
                # file must contain an mdJson object
                if hMdJson.empty?
-                  hResponseObj[:readerStructureMessages] << 'mdJson object is empty'
+                  hResponseObj[:readerStructureMessages] << 'ERROR: mdJson reader: object is empty'
                   hResponseObj[:readerStructurePass] = false
                   return {}
                end
 
                # schema - (required)
                unless hMdJson.has_key?('schema')
-                  hResponseObj[:readerStructureMessages] << 'mdJson is missing schema object'
+                  hResponseObj[:readerStructureMessages] << 'ERROR: mdJson reader: schema definition is missing '
                   hResponseObj[:readerStructurePass] = false
                   return {}
                end
 
                # schema - name (required) (must = 'mdJson')
                unless hMdJson['schema'].has_key?('name')
-                  hResponseObj[:readerStructureMessages] << 'mdJson schema:name attribute is missing'
+                  hResponseObj[:readerStructureMessages] << 'ERROR: mdJson reader: schema element is missing'
                   hResponseObj[:readerStructurePass] = false
                   return {}
                end
                schemaName = hMdJson['schema']['name']
                if schemaName.nil? || schemaName == ''
-                  hResponseObj[:readerStructureMessages] << 'mdJson schema name is missing'
+                  hResponseObj[:readerStructureMessages] << 'ERROR: mdJson reader: schema name is missing'
                   hResponseObj[:readerStructurePass] = false
                   return {}
                end
                unless schemaName.downcase == 'mdjson'
-                  hResponseObj[:readerStructureMessages] << "mdJson schema name is '#{schemaName}', should be mdJson"
+                  hResponseObj[:readerStructureMessages] << "ERROR: mdJson reader: schema name is '#{schemaName}', should be mdJson"
                   hResponseObj[:readerStructurePass] = false
                   return {}
                end
 
                # schema - version (required)
                unless hMdJson['schema'].has_key?('version')
-                  hResponseObj[:readerStructureMessages] << 'mdJson schema:version attribute is missing'
+                  hResponseObj[:readerStructureMessages] << 'ERROR: mdJson reader: schema version element is missing'
                   hResponseObj[:readerStructurePass] = false
                   return {}
                end
                requestedVersion = hMdJson['schema']['version']
                if requestedVersion.nil? || requestedVersion == ''
-                  hResponseObj[:readerStructureMessages] << 'mdJson schema version is missing'
+                  hResponseObj[:readerStructureMessages] << 'ERROR: mdJson reader: schema version is missing'
                   hResponseObj[:readerStructurePass] = false
                   return {}
                end
@@ -101,8 +101,8 @@ module ADIWG
                end
                unless approved
                   approvedVersion = aCurVersion[0] + '.0.0'
-                  hResponseObj[:readerStructureMessages] << "mdJson schema version '#{requestedVersion}' is not supported"
-                  hResponseObj[:readerStructureMessages] << "mdJson versions '#{approvedVersion}' to '#{currentVersion}' are supported"
+                  hResponseObj[:readerStructureMessages] << "ERROR: mdJson reader: schema version '#{requestedVersion}' is not supported"
+                  hResponseObj[:readerStructureMessages] << "... mdTranslator supports mdJson schema version '#{approvedVersion}' through '#{currentVersion}'"
                   hResponseObj[:readerStructurePass] = false
                   return {}
                end

data/lib/adiwg/mdtranslator/readers/mdJson/mdJson_validator.rb

@@ -1,17 +1,16 @@
 # Get minor version of ADIwg mdJson 2.x
 
 # History:
-#   Stan Smith 2017-02-22 refactor for mdJson/mdTranslator 2.0
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2014-12-11 added namespace
-#   Stan Smith 2014-12-03 changed class name to MdJsonValidation from AdiwgJsonValidation
-#   Stan Smith 2014-12-01 changed adiwgJson to mdJson in version name check
-#   Stan Smith 2014-09-26 added processing of minor release numbers
-#   Stan Smith 2014-08-21 parsed json-schema validation message to readable text
-#   Stan Smith 2014-07-21 added json structure validation method
+#  Stan Smith 2017-02-22 refactor for mdJson/mdTranslator 2.0
+#  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#  Stan Smith 2014-12-11 added namespace
+#  Stan Smith 2014-12-03 changed class name to MdJsonValidation from AdiwgJsonValidation
+#  Stan Smith 2014-12-01 changed adiwgJson to mdJson in version name check
+#  Stan Smith 2014-09-26 added processing of minor release numbers
+#  Stan Smith 2014-08-21 parsed json-schema validation message to readable text
+#  Stan Smith 2014-07-21 added json structure validation method
 # 	Stan Smith 2014-07-09 original script
 
-
 require 'json'
 require 'json-schema'
 require 'adiwg-mdjson_schemas'
@@ -35,17 +34,17 @@ module ADIWG
                   aErrors = []
                   aErrors = JSON::Validator.fully_validate('schema.json', file, :strict => bStrict)
 
-                  if aErrors.length > 0
-                     responseObj[:readerValidationPass] = false
-                     responseObj[:readerValidationMessages] << 'mdJson schema validation Failed - see following message(s):\n'
+                  unless aErrors.empty?
+                     responseObj[:readerValidationMessages] << 'ERROR: mdJson reader: schema validation Failed - see following message(s)'
                      responseObj[:readerValidationMessages] << aErrors
+                     responseObj[:readerValidationPass] = false
                      return
                   end
 
                rescue JSON::Schema::ValidationError
-                  responseObj[:readerValidationPass] = false
-                  responseObj[:readerValidationMessages] << 'mdJson schema validation Failed - see following message(s):\n'
+                  responseObj[:readerValidationMessages] << 'ERROR: mdJson reader: schema validation Failed - see following message(s)'
                   responseObj[:readerValidationMessages] << $!.message
+                  responseObj[:readerValidationPass] = false
                   return
                end
 
@@ -55,5 +54,3 @@ module ADIWG
       end
    end
 end
-
-

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

@@ -2,76 +2,76 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-17 refactored for mdJson 2.0
-#   Stan Smith 2015-07-14 refactored to remove global namespace constants
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2014-12-30 added return if empty input
-#   ... found & fixed error of method using associatedResource object instead of
-#   ... additionalDocumentation object
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-17 refactored for mdJson 2.0
+#  Stan Smith 2015-07-14 refactored to remove global namespace constants
+#  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#  Stan Smith 2014-12-30 added return if empty input
+#  ... found & fixed error of method using associatedResource object instead of
+#  ... additionalDocumentation object
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 # 	Stan Smith 2014-11-06 original script
 
 require_relative 'module_citation'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module AdditionalDocumentation
+            module AdditionalDocumentation
 
-                    def self.unpack(hAddDoc, responseObj)
+               def self.unpack(hAddDoc, responseObj)
 
-                        # return nil object if input is empty
-                        if hAddDoc.empty?
-                            responseObj[:readerExecutionMessages] << 'Additional Documentation object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hAddDoc.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: additional documentation object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intAddDoc = intMetadataClass.newAdditionalDocumentation
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intAddDoc = intMetadataClass.newAdditionalDocumentation
 
-                        # additional documentation - resource type [] (required) {resourceType}
-                        if hAddDoc.has_key?('resourceType')
-                            hAddDoc['resourceType'].each do |item|
-                                unless item.empty?
-                                    hReturn = ResourceType.unpack(item, responseObj)
-                                    unless hReturn.nil?
-                                        intAddDoc[:resourceTypes] << hReturn
-                                    end
-                                end
-                            end
-                        end
-                        if intAddDoc[:resourceTypes].empty?
-                            responseObj[:readerExecutionMessages] << 'Additional Documentation is missing resourceType'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # additional documentation - resource type [] (required) {resourceType}
+                  if hAddDoc.has_key?('resourceType')
+                     hAddDoc['resourceType'].each do |item|
+                        unless item.empty?
+                           hReturn = ResourceType.unpack(item, responseObj)
+                           unless hReturn.nil?
+                              intAddDoc[:resourceTypes] << hReturn
+                           end
                         end
+                     end
+                  end
+                  if intAddDoc[:resourceTypes].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: additional documentation is missing resource type'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # additional documentation - citation [] (required)
-                        if hAddDoc.has_key?('citation')
-                            hAddDoc['citation'].each do |item|
-                                hDoc = Citation.unpack(item, responseObj)
-                                unless hDoc.nil?
-                                    intAddDoc[:citation] << hDoc
-                                end
-                            end
-                        end
-                        if intAddDoc[:citation].empty?
-                            responseObj[:readerExecutionMessages] << 'Additional Documentation is missing citation'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # additional documentation - citation [] (required)
+                  if hAddDoc.has_key?('citation')
+                     hAddDoc['citation'].each do |item|
+                        hDoc = Citation.unpack(item, responseObj)
+                        unless hDoc.nil?
+                           intAddDoc[:citation] << hDoc
                         end
+                     end
+                  end
+                  if intAddDoc[:citation].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: additional documentation is missing citation'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        return intAddDoc
+                  return intAddDoc
 
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end