adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 #  Stan Smith 2017-09-28 add altitude to support fgdc
 #  Stan Smith 2016-12-01 original script
 
@@ -16,8 +17,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hBBox.empty?
-                     responseObj[:readerExecutionMessages] << 'boundingBox object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: bounding box object is empty'
                      return nil
                   end
 
@@ -30,12 +30,12 @@ module ADIWG
                      intBBox[:westLongitude] = hBBox['westLongitude']
                   end
                   if intBBox[:westLongitude].nil? || intBBox[:westLongitude] == ''
-                     responseObj[:readerExecutionMessages] << 'boundingBox west boundary is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box west boundary is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
                   if intBBox[:westLongitude].abs > 180
-                     responseObj[:readerExecutionMessages] << 'boundingBox longitude must be between -180 and +180'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box longitude must be between -180 and +180'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -45,12 +45,12 @@ module ADIWG
                      intBBox[:eastLongitude] = hBBox['eastLongitude']
                   end
                   if intBBox[:eastLongitude].nil? || intBBox[:eastLongitude] == ''
-                     responseObj[:readerExecutionMessages] << 'boundingBox east boundary is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box east boundary is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
                   if intBBox[:eastLongitude].abs > 180
-                     responseObj[:readerExecutionMessages] << 'boundingBox longitude must be between -180 and +180'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box longitude must be between -180 and +180'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -60,12 +60,12 @@ module ADIWG
                      intBBox[:southLatitude] = hBBox['southLatitude']
                   end
                   if intBBox[:southLatitude].nil? || intBBox[:southLatitude] == ''
-                     responseObj[:readerExecutionMessages] << 'boundingBox south boundary is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box south boundary is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
                   if intBBox[:southLatitude].abs > 90
-                     responseObj[:readerExecutionMessages] << 'boundingBox latitude must be between -90 and +90'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box latitude must be between -90 and +90'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -75,12 +75,12 @@ module ADIWG
                      intBBox[:northLatitude] = hBBox['northLatitude']
                   end
                   if intBBox[:northLatitude].nil? || intBBox[:northLatitude] == ''
-                     responseObj[:readerExecutionMessages] << 'boundingBox north boundary is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box north boundary is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
                   if intBBox[:northLatitude].abs > 90
-                     responseObj[:readerExecutionMessages] << 'boundingBox latitude must be between -90 and +90'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box latitude must be between -90 and +90'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -107,7 +107,7 @@ module ADIWG
                   end
                   unless intBBox[:minimumAltitude].nil? && intBBox[:maximumAltitude].nil?
                      if intBBox[:unitsOfAltitude].nil? || intBBox[:unitsOfAltitude] == ''
-                        responseObj[:readerExecutionMessages] << 'boundingBox altitude unit of measure is missing'
+                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: bounding box altitude units of measure are missing'
                         responseObj[:readerExecutionPass] = false
                         return nil
                      end

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

@@ -2,16 +2,17 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   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
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2014-12-30 refactored
-#   Stan Smith 2014-12-19 refactored to return nil when hCitation is empty
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-08-18 changed additionalIdentifier section to identifier schema 0.6.0
-#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
-#   Stan Smith 2014-04-25 modified to support json schema 0.3.0
+#  Stan Smith 2018-02-18 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
+#  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#  Stan Smith 2014-12-30 refactored
+#  Stan Smith 2014-12-19 refactored to return nil when hCitation is empty
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2014-08-18 changed additionalIdentifier section to identifier schema 0.6.0
+#  Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+#  Stan Smith 2014-04-25 modified to support json schema 0.3.0
 # 	Stan Smith 2013-08-26 original script
 
 require_relative 'module_date'
@@ -33,8 +34,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hCitation.empty?
-                     responseObj[:readerExecutionMessages] << 'Citation object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: citation object is empty'
                      return nil
                   end
 
@@ -47,7 +47,7 @@ module ADIWG
                      intCitation[:title] = hCitation['title']
                   end
                   if intCitation[:title].nil? || intCitation[:title] == ''
-                     responseObj[:readerExecutionMessages] << 'Citation attribute title is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: citation title is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -55,7 +55,7 @@ module ADIWG
                   # citation - alternate title []
                   if hCitation.has_key?('alternateTitle')
                      hCitation['alternateTitle'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intCitation[:alternateTitles] << item
                         end
                      end
@@ -74,7 +74,7 @@ module ADIWG
 
                   # citation - edition
                   if hCitation.has_key?('edition')
-                     if hCitation['edition'] != ''
+                     unless hCitation['edition'] == ''
                         intCitation[:edition] = hCitation['edition']
                      end
                   end
@@ -93,7 +93,7 @@ module ADIWG
                   # citation - presentation form []
                   if hCitation.has_key?('presentationForm')
                      hCitation['presentationForm'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intCitation[:presentationForms] << item
                         end
                      end
@@ -124,7 +124,7 @@ module ADIWG
                   # citation - other details
                   if hCitation.has_key?('otherCitationDetails')
                      hCitation['otherCitationDetails'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intCitation[:otherDetails] << item
                         end
                      end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 # 	Stan Smith 2016-10-15 original script
 
 require_relative 'module_scope'
@@ -21,11 +22,9 @@ module ADIWG
 
                def self.unpack(hConstraint, responseObj)
 
-
                   # return nil object if input is empty
                   if hConstraint.empty?
-                     responseObj[:readerExecutionMessages] << 'Constraint object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: constraint object is empty'
                      return nil
                   end
 
@@ -36,19 +35,19 @@ module ADIWG
                   # constraint - type (required)
                   type = nil
                   if hConstraint.has_key?('type')
-                     if hConstraint['type'] != ''
+                     unless hConstraint['type'] == ''
                         type = hConstraint['type']
                         if %w{ use legal security }.one? {|word| word == type}
                            intConstraint[:type] = hConstraint['type']
                         else
-                           responseObj[:readerExecutionMessages] << 'Constraint type must be use, legal, or security'
+                           responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: constraint type must be use, legal, or security'
                            responseObj[:readerExecutionPass] = false
                            return nil
                         end
                      end
                   end
                   if intConstraint[:type].nil? || intConstraint[:type] == ''
-                     responseObj[:readerExecutionMessages] << 'Constraint type declaration is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: constraint type is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -56,7 +55,7 @@ module ADIWG
                   # constraint - use limitation [] (required if type='use')
                   if hConstraint.has_key?('useLimitation')
                      hConstraint['useLimitation'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intConstraint[:useLimitation] << item
                         end
                      end
@@ -125,10 +124,17 @@ module ADIWG
                            unless hReturn.nil?
                               intConstraint[:legalConstraint] = hReturn
                            end
+                           if hReturn.nil?
+                              return nil
+                           end
                         end
-                     end
-                     if intConstraint[:legalConstraint].empty?
-                        responseObj[:readerExecutionMessages] << 'Legal Constraint object is missing or empty'
+                        if hObject.empty?
+                           responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: legal constraint object is missing'
+                           responseObj[:readerExecutionPass] = false
+                           return nil
+                        end
+                     else
+                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: legal constraint object is missing'
                         responseObj[:readerExecutionPass] = false
                         return nil
                      end
@@ -142,10 +148,17 @@ module ADIWG
                            unless hReturn.nil?
                               intConstraint[:securityConstraint] = hReturn
                            end
+                           if hReturn.nil?
+                              return nil
+                           end
                         end
-                     end
-                     if intConstraint[:securityConstraint].empty?
-                        responseObj[:readerExecutionMessages] << 'Security Constraint object is missing or empty'
+                        if hObject.empty?
+                           responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: security constraint object is missing'
+                           responseObj[:readerExecutionPass] = false
+                           return nil
+                        end
+                     else
+                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: security constraint object is missing'
                         responseObj[:readerExecutionPass] = false
                         return nil
                      end

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

@@ -2,7 +2,8 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-23 original script
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-23 original script
 
 require_relative 'module_onlineResource'
 require_relative 'module_phone'
@@ -21,7 +22,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hContact.empty?
-                     responseObj[:readerExecutionMessages] << 'Contact object is empty'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: contact object is empty'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -35,7 +36,7 @@ module ADIWG
                      intContact[:contactId] = hContact['contactId']
                   end
                   if intContact[:contactId].nil? || intContact[:contactId] == ''
-                     responseObj[:readerExecutionMessages] << 'Contact is missing contactId'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: contact id is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -49,7 +50,7 @@ module ADIWG
 
                   # contact - position name
                   if hContact.has_key?('positionName')
-                     if hContact['positionName'] != ''
+                     unless hContact['positionName'] == ''
                         intContact[:positionName] = hContact['positionName']
                      end
                   end
@@ -58,18 +59,18 @@ module ADIWG
                   # ... isOrganization = true
                   # ... isOrganization = false && positionName = nil
                   if hContact.has_key?('name')
-                     if hContact['name'] != ''
+                     unless hContact['name'] == ''
                         intContact[:name] = hContact['name']
                      end
                   end
                   if intContact[:name].nil? || intContact[:name] == ''
                      if intContact[:isOrganization] === true
-                        responseObj[:readerExecutionMessages] << 'Organization contact is missing name'
+                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: organization contact name is missing'
                         responseObj[:readerExecutionPass] = false
                         return nil
                      end
                      if intContact[:positionName].nil? || intContact[:positionName] == ''
-                        responseObj[:readerExecutionMessages] << 'Individual contact is missing name and position'
+                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: individual contact name and/or position are missing'
                         responseObj[:readerExecutionPass] = false
                         return nil
                      end
@@ -78,7 +79,7 @@ module ADIWG
                   # contact - member of organization []
                   if hContact.has_key?('memberOfOrganization')
                      hContact['memberOfOrganization'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intContact[:memberOfOrgs] << item
                         end
                      end
@@ -120,7 +121,7 @@ module ADIWG
                   # contact - electronic mail addresses []
                   if hContact.has_key?('electronicMailAddress')
                      hContact['electronicMailAddress'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intContact[:eMailList] << item
                         end
                      end
@@ -140,7 +141,7 @@ module ADIWG
                   # contact - hours of service []
                   if hContact.has_key?('hoursOfService')
                      hContact['hoursOfService'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intContact[:hoursOfService] << item
                         end
                      end
@@ -148,14 +149,14 @@ module ADIWG
 
                   # contact - contact instructions
                   if hContact.has_key?('contactInstructions')
-                     if hContact['contactInstructions'] != ''
+                     unless hContact['contactInstructions'] == ''
                         intContact[:contactInstructions] = hContact['contactInstructions']
                      end
                   end
 
                   # contact - contact type
                   if hContact.has_key?('contactType')
-                     if hContact['contactType'] != ''
+                     unless hContact['contactType'] == ''
                         intContact[:contactType] = hContact['contactType']
                      end
                   end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 # 	Stan Smith 2017-10-19 original script
 
 module ADIWG
@@ -15,8 +16,8 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hCoordRes.empty?
-                     responseObj[:readerExecutionMessages] << 'Coordinate Resolution object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] <<
+                        'WARNING: mdJson reader: spatial resolution coordinate resolution object is empty'
                      return nil
                   end
 
@@ -29,7 +30,8 @@ module ADIWG
                      intCoordRes[:abscissaResolutionX] = hCoordRes['abscissaResolutionX']
                   end
                   if intCoordRes[:abscissaResolutionX].nil? || intCoordRes[:abscissaResolutionX] == ''
-                     responseObj[:readerExecutionMessages] << 'Coordinate Resolution is missing abscissa resolution'
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: coordinate spatial resolution abscissa resolution is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -39,7 +41,8 @@ module ADIWG
                      intCoordRes[:ordinateResolutionY] = hCoordRes['ordinateResolutionY']
                   end
                   if intCoordRes[:ordinateResolutionY].nil? || intCoordRes[:ordinateResolutionY] == ''
-                     responseObj[:readerExecutionMessages] << 'Coordinate Resolution is missing ordinate resolution'
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: coordinate spatial resolution ordinate resolution is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -49,7 +52,7 @@ module ADIWG
                      intCoordRes[:unitOfMeasure] = hCoordRes['unitOfMeasure']
                   end
                   if intCoordRes[:unitOfMeasure].nil? || intCoordRes[:unitOfMeasure] == ''
-                     responseObj[:readerExecutionMessages] << 'Coordinate Resolution is missing units of measure'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: coordinate spatial resolution units are missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 # 	Stan Smith 2016-10-18 original script
 
 require_relative 'module_identifier'
@@ -9,88 +10,87 @@ require_relative 'module_attributeGroup'
 require_relative 'module_imageDescription'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module CoverageDescription
-
-                    def self.unpack(hContent, responseObj)
-
-                        # return nil object if input is empty
-                        if hContent.empty?
-                            responseObj[:readerExecutionMessages] << 'Content Info object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intContent = intMetadataClass.newCoverageDescription
-
-                        # content information - coverage name (required)
-                        if hContent.has_key?('coverageName')
-                            if hContent['coverageName'] != ''
-                                intContent[:coverageName] = hContent['coverageName']
-                            end
-                        end
-                        if intContent[:coverageName].nil?
-                            responseObj[:readerExecutionMessages] << 'Content Info attribute coverageName is missing '
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # content information - coverage description (required)
-                        if hContent.has_key?('coverageDescription')
-                            if hContent['coverageDescription'] != ''
-                                intContent[:coverageDescription] = hContent['coverageDescription']
-                            end
-                        end
-                        if intContent[:coverageDescription].nil?
-                            responseObj[:readerExecutionMessages] << 'Content Info attribute coverageDescription is missing '
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # content information - processing level code
-                        if hContent.has_key?('processingLevelCode')
-                            hObject = hContent['processingLevelCode']
-                            unless hObject.empty?
-                                hReturn = Identifier.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intContent[:processingLevelCode] = hReturn
-                                end
-                            end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module CoverageDescription
+
+               def self.unpack(hContent, responseObj)
+
+                  # return nil object if input is empty
+                  if hContent.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: coverage description object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intContent = intMetadataClass.newCoverageDescription
+
+                  # content information - coverage name (required)
+                  if hContent.has_key?('coverageName')
+                     unless hContent['coverageName'] == ''
+                        intContent[:coverageName] = hContent['coverageName']
+                     end
+                  end
+                  if intContent[:coverageName].nil?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: coverage description name is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # content information - coverage description (required)
+                  if hContent.has_key?('coverageDescription')
+                     unless hContent['coverageDescription'] == ''
+                        intContent[:coverageDescription] = hContent['coverageDescription']
+                     end
+                  end
+                  if intContent[:coverageDescription].nil?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: coverage description description is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # content information - processing level code
+                  if hContent.has_key?('processingLevelCode')
+                     hObject = hContent['processingLevelCode']
+                     unless hObject.empty?
+                        hReturn = Identifier.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intContent[:processingLevelCode] = hReturn
                         end
-
-                        # content information - attribute group []
-                        if hContent.has_key?('attributeGroup')
-                            hContent['attributeGroup'].each do |item|
-                                hAttGrp = AttributeGroup.unpack(item, responseObj)
-                                unless hAttGrp.nil?
-                                    intContent[:attributeGroups] << hAttGrp
-                                end
-                            end
+                     end
+                  end
+
+                  # content information - attribute group []
+                  if hContent.has_key?('attributeGroup')
+                     hContent['attributeGroup'].each do |item|
+                        hAttGrp = AttributeGroup.unpack(item, responseObj)
+                        unless hAttGrp.nil?
+                           intContent[:attributeGroups] << hAttGrp
                         end
-
-                        # content information - image description
-                        if hContent.has_key?('imageDescription')
-                            hObject = hContent['imageDescription']
-                            unless hObject.empty?
-                                hReturn = ImageDescription.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intContent[:imageDescription] = hReturn
-                                end
-                            end
+                     end
+                  end
+
+                  # content information - image description
+                  if hContent.has_key?('imageDescription')
+                     hObject = hContent['imageDescription']
+                     unless hObject.empty?
+                        hReturn = ImageDescription.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intContent[:imageDescription] = hReturn
                         end
+                     end
+                  end
 
-                        return intContent
+                  return intContent
 
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end