adiwg-mdtranslator 2.9.2 → 2.10.0

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_funding.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-08-30 refactored for mdJson schema 2.3
 #  Stan Smith 2016-10-30 original script
 
@@ -19,8 +20,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hFunding.empty?
-                     responseObj[:readerExecutionMessages] << 'Funding object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: funding object is empty'
                      return nil
                   end
 
@@ -30,10 +30,12 @@ module ADIWG
 
                   # funding - description
                   if hFunding.has_key?('description')
-                     intFunding[:description] = hFunding['description']
+                     unless hFunding['description'] == ''
+                        intFunding[:description] = hFunding['description']
+                     end
                   end
 
-                  # funding - timePeriod
+                  # funding - timePeriod (required if)
                   if hFunding.has_key?('timePeriod')
                      hObject = hFunding['timePeriod']
                      unless hObject.empty?
@@ -44,7 +46,7 @@ module ADIWG
                      end
                   end
 
-                  # funding - allocation []
+                  # funding - allocation [] (required if)
                   if hFunding.has_key?('allocation')
                      aItems = hFunding['allocation']
                      aItems.each do |item|
@@ -55,8 +57,9 @@ module ADIWG
                      end
                   end
 
+                  # error messages
                   if intFunding[:allocations].empty? && intFunding[:timePeriod].empty?
-                     responseObj[:readerExecutionMessages] << 'Funding must have either an allocation or timePeriod'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: funding must have either allocation or timePeriod'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end

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

@@ -2,7 +2,8 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-25 original script
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-25 original script
 
 require_relative 'module_geometryObject'
 require_relative 'module_geometryCollection'
@@ -10,61 +11,60 @@ require_relative 'module_geometryFeature'
 require_relative 'module_featureCollection'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module GeoJson
+            module GeoJson
 
-                    def self.unpack(hGeoJson, responseObj)
+               def self.unpack(hGeoJson, responseObj)
 
-                        # return nil object if input is empty
-                        if hGeoJson.empty?
-                            responseObj[:readerExecutionMessages] << 'GeoJson object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        intGeoEle = {}
+                  # return nil object if input is empty
+                  if hGeoJson.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GeoJSON object is empty'
+                     return nil
+                  end
 
-                        if hGeoJson.has_key?('type')
-                            if hGeoJson['type'] != ''
-                                type = hGeoJson['type']
-                                if %w{ Point LineString Polygon MultiPoint MultiLineString MultiPolygon }.one? { |word| word == type }
-                                    hReturn = GeometryObject.unpack(hGeoJson, responseObj)
-                                    unless hReturn.nil?
-                                        intGeoEle = hReturn
-                                    end
-                                end
-                                if type == 'GeometryCollection'
-                                    hReturn = GeometryCollection.unpack(hGeoJson, responseObj)
-                                    unless hReturn.nil?
-                                        intGeoEle = hReturn
-                                    end
-                                end
-                                if type == 'Feature'
-                                    hReturn = GeometryFeature.unpack(hGeoJson, responseObj)
-                                    unless hReturn.nil?
-                                        intGeoEle = hReturn
-                                    end
-                                end
-                                if type == 'FeatureCollection'
-                                    hReturn = FeatureCollection.unpack(hGeoJson, responseObj)
-                                    unless hReturn.nil?
-                                        intGeoEle = hReturn
-                                    end
-                                end
+                  intGeoEle = {}
 
-                            end
+                  if hGeoJson.has_key?('type')
+                     if hGeoJson['type'] != ''
+                        type = hGeoJson['type']
+                        if %w{ Point LineString Polygon MultiPoint MultiLineString MultiPolygon }.one? {|word| word == type}
+                           hReturn = GeometryObject.unpack(hGeoJson, responseObj)
+                           unless hReturn.nil?
+                              intGeoEle = hReturn
+                           end
+                        end
+                        if type == 'GeometryCollection'
+                           hReturn = GeometryCollection.unpack(hGeoJson, responseObj)
+                           unless hReturn.nil?
+                              intGeoEle = hReturn
+                           end
+                        end
+                        if type == 'Feature'
+                           hReturn = GeometryFeature.unpack(hGeoJson, responseObj)
+                           unless hReturn.nil?
+                              intGeoEle = hReturn
+                           end
+                        end
+                        if type == 'FeatureCollection'
+                           hReturn = FeatureCollection.unpack(hGeoJson, responseObj)
+                           unless hReturn.nil?
+                              intGeoEle = hReturn
+                           end
                         end
 
-                        return intGeoEle
+                     end
+                  end
 
-                    end
+                  return intGeoEle
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_geodetic.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-23 original script
 
 require_relative 'module_identifier'
@@ -17,8 +18,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hGeodetic.empty?
-                     responseObj[:readerExecutionMessages] << 'Geodetic object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: spatial reference geodetic object is empty'
                      return nil
                   end
 
@@ -38,7 +38,7 @@ module ADIWG
 
                   # geodetic - datum name
                   if hGeodetic.has_key?('datumName')
-                     if hGeodetic['datumName'] != ''
+                     unless hGeodetic['datumName'] == ''
                         intGeodetic[:datumName] = hGeodetic['datumName']
                      end
                   end
@@ -58,28 +58,28 @@ module ADIWG
                      intGeodetic[:ellipsoidName] = hGeodetic['ellipsoidName']
                   end
                   if intGeodetic[:ellipsoidName].nil? || intGeodetic[:ellipsoidName] == ''
-                     responseObj[:readerExecutionMessages] << 'Ellipsoid name is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: spatial reference geodetic ellipsoid name is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
 
                   # geodetic - semi-major axis
                   if hGeodetic.has_key?('semiMajorAxis')
-                     if hGeodetic['semiMajorAxis'] != ''
+                     unless hGeodetic['semiMajorAxis'] == ''
                         intGeodetic[:semiMajorAxis] = hGeodetic['semiMajorAxis']
                      end
                   end
 
                   # geodetic - axis units
                   if hGeodetic.has_key?('axisUnits')
-                     if hGeodetic['axisUnits'] != ''
+                     unless['axisUnits'] == ''
                         intGeodetic[:axisUnits] = hGeodetic['axisUnits']
                      end
                   end
 
                   # geodetic - denominator of flattening ratio
                   if hGeodetic.has_key?('denominatorOfFlatteningRatio')
-                     if hGeodetic['denominatorOfFlatteningRatio'] != ''
+                     unless hGeodetic['denominatorOfFlatteningRatio'] == ''
                         intGeodetic[:denominatorOfFlatteningRatio] = hGeodetic['denominatorOfFlatteningRatio']
                      end
                   end

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

@@ -1,7 +1,9 @@
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 # unpack geoJson
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 #  Stan Smith 2017-09-28 added description element to support fgdc
 #  Stan Smith 2016-12-01 original script
 
@@ -20,8 +22,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hGeoExt.empty?
-                     responseObj[:readerExecutionMessages] << 'geographicExtent object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: geographic extent object is empty'
                      return nil
                   end
 
@@ -29,10 +30,13 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intGeoExt = intMetadataClass.newGeographicExtent
 
+                  haveGExtent = false
+
                   # geographic extent - description
                   if hGeoExt.has_key?('description')
                      if hGeoExt['description'] != ''
                         intGeoExt[:description] = hGeoExt['description']
+                        haveGExtent = true
                      end
                   end
 
@@ -50,6 +54,7 @@ module ADIWG
                         unless hReturn.nil?
                            intGeoExt[:identifier] = hReturn
                         end
+                        haveGExtent = true
                      end
                   end
 
@@ -59,6 +64,7 @@ module ADIWG
                         hReturn = BoundingBox.unpack(hGeoExt['boundingBox'], responseObj)
                         unless hReturn.nil?
                            intGeoExt[:boundingBox] = hReturn
+                           haveGExtent = true
                         end
                      end
                   end
@@ -69,6 +75,7 @@ module ADIWG
                         hReturn = GeoJson.unpack(hElement, responseObj)
                         unless hReturn.nil?
                            intGeoExt[:geographicElements] << hReturn
+                           haveGExtent = true
                         end
                      end
                   end
@@ -85,12 +92,10 @@ module ADIWG
                      intGeoExt[:computedBbox] = AdiwgCoordinates.computeBbox(intGeoExt[:geographicElements])
                   end
 
-                  # test for completeness
-                  if intGeoExt[:identifier].empty? &&
-                     intGeoExt[:boundingBox].empty? &&
-                     intGeoExt[:geographicElements].empty?
+                  # error messages
+                  unless haveGExtent
                      responseObj[:readerExecutionMessages] <<
-                        'geographicExtent must have at least one identifier, boundingBox, or geographic element'
+                        'ERROR: mdJson reader: geographic extent must have at least one description, identifier, bounding box, or geographic element'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_geographicResolution.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,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hGeoRes.empty?
-                     responseObj[:readerExecutionMessages] << 'Geographic Resolution object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: geographic spatial resolution object is empty'
                      return nil
                   end
 
@@ -29,7 +29,8 @@ module ADIWG
                      intGeoRes[:latitudeResolution] = hGeoRes['latitudeResolution']
                   end
                   if intGeoRes[:latitudeResolution].nil? || intGeoRes[:latitudeResolution] == ''
-                     responseObj[:readerExecutionMessages] << 'Geographic Resolution is missing latitude resolution'
+                     responseObj[:readerExecutionMessages] <<
+                        'WARNING: mdJson reader: geographic spatial resolution latitude resolution is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -39,7 +40,7 @@ module ADIWG
                      intGeoRes[:longitudeResolution] = hGeoRes['longitudeResolution']
                   end
                   if intGeoRes[:longitudeResolution].nil? || intGeoRes[:longitudeResolution] == ''
-                     responseObj[:readerExecutionMessages] << 'Geographic Resolution is missing longitude resolution'
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: geographic spatial resolution longitude resolution is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -49,7 +50,7 @@ module ADIWG
                      intGeoRes[:unitOfMeasure] = hGeoRes['unitOfMeasure']
                   end
                   if intGeoRes[:unitOfMeasure].nil? || intGeoRes[:unitOfMeasure] == ''
-                     responseObj[:readerExecutionMessages] << 'Geographic resolution is missing unit of measure'
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: geographic spatial resolution units are missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_geologicAge.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-11-07 original script
 
 require_relative 'module_citation'
@@ -17,8 +18,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hGeoAge.empty?
-                     responseObj[:readerExecutionMessages] << 'Geologic Age object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: geologic age object is empty'
                      return nil
                   end
 
@@ -31,7 +31,7 @@ module ADIWG
                      intGeoAge[:ageTimeScale] = hGeoAge['ageTimeScale']
                   end
                   if intGeoAge[:ageTimeScale].nil? || intGeoAge[:ageTimeScale] == ''
-                     responseObj[:readerExecutionMessages] << 'Geologic Age is missing time scale'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: geologic age time scale is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -41,21 +41,21 @@ module ADIWG
                      intGeoAge[:ageEstimate] = hGeoAge['ageEstimate']
                   end
                   if intGeoAge[:ageEstimate].nil? || intGeoAge[:ageEstimate] == ''
-                     responseObj[:readerExecutionMessages] << 'Geologic Age is missing age estimate'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: geologic age age-estimate is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
 
                   # geologic age - age uncertainty
                   if hGeoAge.has_key?('ageUncertainty')
-                     if hGeoAge['ageUncertainty'] != ''
+                     unless hGeoAge['ageUncertainty'] == ''
                         intGeoAge[:ageUncertainty] = hGeoAge['ageUncertainty']
                      end
                   end
 
                   # geologic age - age explanation
                   if hGeoAge.has_key?('ageExplanation')
-                     if hGeoAge['ageExplanation'] != ''
+                     unless hGeoAge['ageExplanation'] == ''
                         intGeoAge[:ageExplanation] = hGeoAge['ageExplanation']
                      end
                   end

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

@@ -2,86 +2,86 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-11-11 added computedBbox computation
-#   Stan Smith 2016-10-25 original script
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-11-11 added computedBbox computation
+#  Stan Smith 2016-10-25 original script
 
 require_relative 'module_geoJson'
 require 'adiwg/mdtranslator/internal/module_coordinates'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module GeometryCollection
+            module GeometryCollection
 
-                    def self.unpack(hGeoCol, responseObj)
+               def self.unpack(hGeoCol, responseObj)
 
-                        # return nil object if input is empty
-                        if hGeoCol.empty?
-                            responseObj[:readerExecutionMessages] << 'Geometry Collection object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hGeoCol.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GeoJSON geometry collection object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intGeoCol = intMetadataClass.newGeometryCollection
-
-                        # geometry collection - type (required)
-                        if hGeoCol.has_key?('type')
-                            if hGeoCol['type'] != ''
-                                if hGeoCol['type'] == 'GeometryCollection'
-                                    intGeoCol[:type] = hGeoCol['type']
-                                else
-                                    responseObj[:readerExecutionMessages] << 'Geometry Collection type must be GeometryCollection'
-                                    responseObj[:readerExecutionPass] = false
-                                    return nil
-                                end
-                            end
-                        end
-                        if intGeoCol[:type].nil? || intGeoCol[:type] == ''
-                            responseObj[:readerExecutionMessages] << 'Geometry Collection is missing type'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intGeoCol = intMetadataClass.newGeometryCollection
 
-                        # geometry collection - bounding box
-                        if hGeoCol.has_key?('bbox')
-                            unless hGeoCol['bbox'].empty?
-                                intGeoCol[:bbox] = hGeoCol['bbox']
-                            end
-                        end
-
-                        # geometry collection - geometries (required, but can be empty)
-                        if hGeoCol.has_key?('geometries')
-                            hGeoCol['geometries'].each do |hGeometry|
-                                hReturn = GeoJson.unpack(hGeometry, responseObj)
-                                unless hReturn.nil?
-                                    intGeoCol[:geometryObjects] << hReturn
-                                end
-                            end
+                  # geometry collection - type (required)
+                  if hGeoCol.has_key?('type')
+                     if hGeoCol['type'] != ''
+                        if hGeoCol['type'] == 'GeometryCollection'
+                           intGeoCol[:type] = hGeoCol['type']
                         else
-                            responseObj[:readerExecutionMessages] << 'Geometry Collection is missing geometries'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                           responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry collection type must be GeometryCollection'
+                           responseObj[:readerExecutionPass] = false
+                           return nil
                         end
-
-                        # geometry collection - compute bbox for geometry collection
-                        unless intGeoCol[:geometryObjects].empty?
-                            intGeoCol[:computedBbox] = AdiwgCoordinates.computeBbox(intGeoCol[:geometryObjects])
+                     end
+                  end
+                  if intGeoCol[:type].nil? || intGeoCol[:type] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry collection type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # geometry collection - bounding box
+                  if hGeoCol.has_key?('bbox')
+                     unless hGeoCol['bbox'].empty?
+                        intGeoCol[:bbox] = hGeoCol['bbox']
+                     end
+                  end
+
+                  # geometry collection - geometries (required, but can be empty)
+                  if hGeoCol.has_key?('geometries')
+                     hGeoCol['geometries'].each do |hGeometry|
+                        hReturn = GeoJson.unpack(hGeometry, responseObj)
+                        unless hReturn.nil?
+                           intGeoCol[:geometryObjects] << hReturn
                         end
+                     end
+                  else
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJSON geometry collection geometries are missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # geometry collection - save GeoJSON for the collection
-                        intGeoCol[:nativeGeoJson] = hGeoCol
+                  # geometry collection - compute bbox for geometry collection
+                  unless intGeoCol[:geometryObjects].empty?
+                     intGeoCol[:computedBbox] = AdiwgCoordinates.computeBbox(intGeoCol[:geometryObjects])
+                  end
 
-                        return intGeoCol
+                  # geometry collection - save GeoJSON for the collection
+                  intGeoCol[:nativeGeoJson] = hGeoCol
 
-                    end
+                  return intGeoCol
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end