adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,69 +2,71 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2016-10-24 original script
 
 require_relative 'module_timeInstant'
 require_relative 'module_timePeriod'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module TemporalExtent
+            module TemporalExtent
 
-                    def self.unpack(hTemporal, responseObj)
+               def self.unpack(hTemporal, responseObj)
 
-                        # return nil object if input is empty
-                        if hTemporal.empty?
-                            responseObj[:readerExecutionMessages] << 'Temporal Extent object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intTemporal = intMetadataClass.newTemporalExtent
-                        haveOne = false
+                  # return nil object if input is empty
+                  if hTemporal.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: temporal extent object is empty'
+                     return nil
+                  end
 
-                        # temporal extent - time instant (required if not others)
-                        if hTemporal.has_key?('timeInstant')
-                            hTime = hTemporal['timeInstant']
-                            unless hTime.empty?
-                                hObject = TimeInstant.unpack(hTime, responseObj)
-                                unless hObject.nil?
-                                    intTemporal[:timeInstant] = hObject
-                                    haveOne = true
-                                end
-                            end
-                        end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intTemporal = intMetadataClass.newTemporalExtent
+                  haveOne = false
 
-                        # temporal extent - time period (required if not others)
-                        if hTemporal.has_key?('timePeriod')
-                            hTime = hTemporal['timePeriod']
-                            unless hTime.empty?
-                                hObject = TimePeriod.unpack(hTime, responseObj)
-                                unless hObject.nil?
-                                    intTemporal[:timePeriod] = hObject
-                                    haveOne = true
-                                end
-                            end
+                  # temporal extent - time instant (required if not others)
+                  if hTemporal.has_key?('timeInstant')
+                     hTime = hTemporal['timeInstant']
+                     unless hTime.empty?
+                        hObject = TimeInstant.unpack(hTime, responseObj)
+                        unless hObject.nil?
+                           intTemporal[:timeInstant] = hObject
+                           haveOne = true
                         end
+                     end
+                  end
 
-                        unless haveOne
-                            responseObj[:readerExecutionMessages] << 'Temporal Extent did not have an object of supported type'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # temporal extent - time period (required if not others)
+                  if hTemporal.has_key?('timePeriod')
+                     hTime = hTemporal['timePeriod']
+                     unless hTime.empty?
+                        hObject = TimePeriod.unpack(hTime, responseObj)
+                        unless hObject.nil?
+                           intTemporal[:timePeriod] = hObject
+                           haveOne = true
                         end
+                     end
+                  end
 
-                        return intTemporal
+                  # error messages
+                  unless haveOne
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: temporal extent must have a time period or time instant'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                    end
+                  return intTemporal
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 #  Stan Smith 2017-11-07 add geologic age
 # 	Stan Smith 2016-10-24 original script
 
@@ -20,8 +21,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hInstant.empty?
-                     responseObj[:readerExecutionMessages] << 'Time Instant object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: time instant object is empty'
                      return nil
                   end
 
@@ -31,14 +31,14 @@ module ADIWG
 
                   # time instant - id
                   if hInstant.has_key?('id')
-                     if hInstant['id'] != ''
+                     unless hInstant['id'] == ''
                         intInstant[:timeId] = hInstant['id']
                      end
                   end
 
                   # time instant - description
                   if hInstant.has_key?('description')
-                     if hInstant['description'] != ''
+                     unless hInstant['description'] == ''
                         intInstant[:description] = hInstant['description']
                      end
                   end
@@ -56,7 +56,7 @@ module ADIWG
                   # time instant - instant names []
                   if hInstant.has_key?('instantName')
                      hInstant['instantName'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intInstant[:instantNames] << item
                         end
                      end
@@ -64,7 +64,7 @@ module ADIWG
 
                   # time instant - datetime
                   if hInstant.has_key?('dateTime')
-                     if hInstant['dateTime'] != ''
+                     unless hInstant['dateTime'] == ''
                         hDate = DateTime.unpack(hInstant['dateTime'], responseObj)
                         unless hDate.nil?
                            intInstant[:timeInstant] = hDate
@@ -81,9 +81,9 @@ module ADIWG
                      end
                   end
 
-                  # time instant must have either a time instant or geologic age
+                  # time instant must have either a timeInstant or geologicAge
                   if intInstant[:timeInstant].empty? && intInstant[:geologicAge].empty?
-                     responseObj[:readerExecutionMessages] << 'Time Instant is missing dateTime or geologic age'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: time instant must have dateTime or geologic age'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end

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

@@ -2,68 +2,68 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2016-10-14 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module TimeInterval
+            module TimeInterval
 
-                    def self.unpack(hTimeInt, responseObj)
+               def self.unpack(hTimeInt, responseObj)
 
-                        # return nil object if input is empty
-                        if hTimeInt.empty?
-                            responseObj[:readerExecutionMessages] << 'Time Interval object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hTimeInt.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: time interval object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intTime = intMetadataClass.newTimeInterval
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intTime = intMetadataClass.newTimeInterval
 
-                        # time interval - interval (required)
-                        if hTimeInt.has_key?('interval')
-                            interval = hTimeInt['interval']
-                            if interval != ''
-                                if interval.is_a?(Integer) || interval.is_a?(Float)
-                                    intTime[:interval] = hTimeInt['interval']
-                                else
-                                    responseObj[:readerExecutionMessages] << 'Time Interval attribute interval is not a number'
-                                    responseObj[:readerExecutionPass] = false
-                                    return nil
-                                end
-                            end
-                        end
-                        if intTime[:interval].nil? || intTime[:interval] == ''
-                            responseObj[:readerExecutionMessages] << 'Time Interval attribute interval is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # time interval - interval (required)
+                  if hTimeInt.has_key?('interval')
+                     interval = hTimeInt['interval']
+                     unless interval == ''
+                        if interval.is_a?(Integer) || interval.is_a?(Float)
+                           intTime[:interval] = hTimeInt['interval']
+                        else
+                           responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: time interval must be a number'
+                           responseObj[:readerExecutionPass] = false
+                           return nil
                         end
+                     end
+                  end
+                  if intTime[:interval].nil? || intTime[:interval] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: time interval is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # time interval - units (required) {enum}
-                        if hTimeInt.has_key?('units')
-                            units = hTimeInt['units']
-                            unless units.nil?
-                                if %w{year month day hour minute second}.one? {|word| word == units}
-                                    intTime[:units] = hTimeInt['units']
-                                end
-                            end
-                        end
-                        if intTime[:units].nil? || intTime[:units] == ''
-                            responseObj[:readerExecutionMessages] << 'Time Interval attribute units is missing or invalid'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # time interval - units (required) {enum}
+                  if hTimeInt.has_key?('units')
+                     units = hTimeInt['units']
+                     unless units.nil?
+                        if %w{year month day hour minute second}.one? {|word| word == units}
+                           intTime[:units] = hTimeInt['units']
                         end
+                     end
+                  end
+                  if intTime[:units].nil? || intTime[:units] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: time interval units are missing or invalid'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        return intTime
-                    end
-
-                end
+                  return intTime
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 #  Stan Smith 2017-11-07 add geologic age
 # 	Stan Smith 2016-10-14 original script
 
@@ -22,8 +23,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hTimePeriod.empty?
-                     responseObj[:readerExecutionMessages] << 'Time Period object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: time period object is empty'
                      return nil
                   end
 
@@ -31,16 +31,18 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intTimePer = intMetadataClass.newTimePeriod
 
+                  haveTime = false
+
                   # time period - id
                   if hTimePeriod.has_key?('id')
-                     if hTimePeriod['id'] != ''
+                     unless hTimePeriod['id'] == ''
                         intTimePer[:timeId] = hTimePeriod['id']
                      end
                   end
 
                   # time period - description
                   if hTimePeriod.has_key?('description')
-                     if hTimePeriod['description'] != ''
+                     unless hTimePeriod['description'] == ''
                         intTimePer[:description] = hTimePeriod['description']
                      end
                   end
@@ -58,55 +60,60 @@ module ADIWG
                   # time period - period names []
                   if hTimePeriod.has_key?('periodName')
                      hTimePeriod['periodName'].each do |item|
-                        if item != ''
+                        unless item == ''
                            intTimePer[:periodNames] << item
                         end
                      end
                   end
 
-                  # time period - start datetime
+                  # time period - start datetime (required if)
                   if hTimePeriod.has_key?('startDateTime')
-                     if hTimePeriod['startDateTime'] != ''
+                     unless hTimePeriod['startDateTime'] == ''
                         hReturn = DateTime.unpack(hTimePeriod['startDateTime'], responseObj)
                         unless hReturn.nil?
                            intTimePer[:startDateTime] = hReturn
+                           haveTime = true
                         end
                      end
                   end
 
-                  # time period - end datetime
+                  # time period - end datetime (required if)
                   if hTimePeriod.has_key?('endDateTime')
-                     if hTimePeriod['endDateTime'] != ''
+                     unless hTimePeriod['endDateTime'] == ''
                         hReturn = DateTime.unpack(hTimePeriod['endDateTime'], responseObj)
                         unless hReturn.nil?
                            intTimePer[:endDateTime] = hReturn
+                           haveTime = true
                         end
                      end
                   end
 
-                  # time period - start geologic age
+                  # time period - start geologic age (required if)
                   if hTimePeriod.has_key?('startGeologicAge')
                      unless hTimePeriod['startGeologicAge'].empty?
                         hReturn = GeologicAge.unpack(hTimePeriod['startGeologicAge'], responseObj)
                         unless hReturn.nil?
                            intTimePer[:startGeologicAge] = hReturn
+                           haveTime = true
                         end
                      end
                   end
 
-                  # time period - end geologic age
+                  # time period - end geologic age (required if)
                   if hTimePeriod.has_key?('endGeologicAge')
                      unless hTimePeriod['endGeologicAge'].empty?
                         hReturn = GeologicAge.unpack(hTimePeriod['endGeologicAge'], responseObj)
                         unless hReturn.nil?
                            intTimePer[:endGeologicAge] = hReturn
+                           haveTime = true
                         end
                      end
                   end
 
-                  if intTimePer[:startDateTime].empty? && intTimePer[:endDateTime].empty? &&
-                     intTimePer[:startGeologicAge].empty? && intTimePer[:endGeologicAge].empty?
-                     responseObj[:readerExecutionMessages] << 'Time Period is missing a starting or ending time or geologic age'
+                  # error messages
+                  unless haveTime
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: time period must have a starting time, ending time, or geologic age'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end

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

@@ -2,7 +2,8 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-21 original script
+#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2016-10-21 original script
 
 require_relative 'module_medium'
 require_relative 'module_format'
@@ -10,86 +11,96 @@ require_relative 'module_onlineResource'
 require_relative 'module_duration'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module TransferOption
-
-                    def self.unpack(hTransOp, responseObj)
-
-                        # return nil object if input is empty
-                        if hTransOp.empty?
-                            responseObj[:readerExecutionMessages] << 'Transfer Option object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intTransOpt = intMetadataClass.newTransferOption
-
-                        # transfer option - units of distribution
-                        if hTransOp.has_key?('unitsOfDistribution')
-                            if hTransOp['unitsOfDistribution'] != ''
-                                intTransOpt[:unitsOfDistribution] = hTransOp['unitsOfDistribution']
-                            end
-                        end
-
-                        # transfer option - transfer size
-                        if hTransOp.has_key?('transferSize')
-                            if hTransOp['transferSize'] != ''
-                                intTransOpt[:transferSize] = hTransOp['transferSize']
-                            end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module TransferOption
+
+               def self.unpack(hTransOp, responseObj)
+
+                  # return nil object if input is empty
+                  if hTransOp.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: distributor transfer option object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intTransOpt = intMetadataClass.newTransferOption
+
+                  # transfer option - units of distribution
+                  if hTransOp.has_key?('unitsOfDistribution')
+                     unless hTransOp['unitsOfDistribution'] == ''
+                        intTransOpt[:unitsOfDistribution] = hTransOp['unitsOfDistribution']
+                     end
+                  end
+
+                  # transfer option - transfer size
+                  if hTransOp.has_key?('transferSize')
+                     unless hTransOp['transferSize'] == ''
+                        intTransOpt[:transferSize] = hTransOp['transferSize']
+                     end
+                  end
+
+                  haveOption = false
+                  # transfer option - online option [onlineResource]
+                  if hTransOp.has_key?('onlineOption')
+                     hTransOp['onlineOption'].each do |item|
+                        hReturn = OnlineResource.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intTransOpt[:onlineOptions] << hReturn
+                           haveOption = true
                         end
-
-                        # transfer option - online option [onlineResource]
-                        if hTransOp.has_key?('onlineOption')
-                            hTransOp['onlineOption'].each do |item|
-                                hReturn = OnlineResource.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intTransOpt[:onlineOptions] << hReturn
-                                end
-                            end
+                     end
+                  end
+
+                  # transfer option - offline option [medium]
+                  if hTransOp.has_key?('offlineOption')
+                     hTransOp['offlineOption'].each do |item|
+                        hReturn = Medium.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intTransOpt[:offlineOptions] << hReturn
+                           haveOption = true
                         end
-
-                        # transfer option - offline option [medium]
-                        if hTransOp.has_key?('offlineOption')
-                            hTransOp['offlineOption'].each do |item|
-                                hReturn = Medium.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intTransOpt[:offlineOptions] << hReturn
-                                end
-                            end
+                     end
+                  end
+
+                  # transfer option - transferFrequency {duration}
+                  if hTransOp.has_key?('transferFrequency')
+                     hObject = hTransOp['transferFrequency']
+                     unless hObject.empty?
+                        hReturn = Duration.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intTransOpt[:transferFrequency] = hReturn
                         end
-
-                        # transfer option - transferFrequency {duration}
-                        if hTransOp.has_key?('transferFrequency')
-                            hObject = hTransOp['transferFrequency']
-                            unless hObject.empty?
-                                hReturn = Duration.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intTransOpt[:transferFrequency] = hReturn
-                                end
-                            end
+                     end
+                  end
+
+                  # transfer option - distribution format [format]
+                  if hTransOp.has_key?('distributionFormat')
+                     hTransOp['distributionFormat'].each do |item|
+                        hReturn = Format.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intTransOpt[:distributionFormats] << hReturn
                         end
+                     end
+                  end
 
-                        # transfer option - distribution format [format]
-                        if hTransOp.has_key?('distributionFormat')
-                            hTransOp['distributionFormat'].each do |item|
-                                hReturn = Format.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intTransOpt[:distributionFormats] << hReturn
-                                end
-                            end
-                        end
-
-                        return intTransOpt
-                    end
+                  # error messages
+                  unless haveOption
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: transfer option must have an online or offline option'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                end
+                  return intTransOpt
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,6 +2,7 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2017-11-01 original script
 
 module ADIWG
@@ -15,8 +16,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hRange.empty?
-                     responseObj[:readerExecutionMessages] << 'Value Range object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: value range object is empty'
                      return nil
                   end
 
@@ -29,7 +29,7 @@ module ADIWG
                      intRange[:minRangeValue] = hRange['minRangeValue']
                   end
                   if intRange[:minRangeValue].nil? || intRange[:minRangeValue] == ''
-                     responseObj[:readerExecutionMessages] << 'Value Range object is missing minimum'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: value range minimum is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -39,7 +39,7 @@ module ADIWG
                      intRange[:maxRangeValue] = hRange['maxRangeValue']
                   end
                   if intRange[:maxRangeValue].nil? || intRange[:maxRangeValue] == ''
-                     responseObj[:readerExecutionMessages] << 'Value Range object is missing maximum'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: value range maximum is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end