adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,74 +2,75 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2016-10-17 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Measure
+            module Measure
 
-                    def self.unpack(hMeasure, responseObj)
+               def self.unpack(hMeasure, responseObj)
 
-                        # return nil object if input is empty
-                        if hMeasure.empty?
-                            responseObj[:readerExecutionMessages] << 'Measure object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intMeasure = intMetadataClass.newMeasure
+                  # return nil object if input is empty
+                  if hMeasure.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: measure object is empty'
+                     return nil
+                  end
 
-                        # measure - type enumeration (required)
-                        if hMeasure.has_key?('type')
-                            if hMeasure['type'] != ''
-                                type = hMeasure['type']
-                                if %w{ distance length vertical angle measure scale }.one? { |word| word == type }
-                                    intMeasure[:type] = hMeasure['type']
-                                else
-                                    responseObj[:readerExecutionMessages] << 'Measure type must be distance, length, vertical, or angle'
-                                    responseObj[:readerExecutionPass] = false
-                                    return nil
-                                end
-                            end
-                        end
-                        if intMeasure[:type].nil? || intMeasure[:type] == ''
-                            responseObj[:readerExecutionMessages] << 'Measure attribute type is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intMeasure = intMetadataClass.newMeasure
 
-                        # measure - value (required)
-                        if hMeasure.has_key?('value')
-                            intMeasure[:value] = hMeasure['value']
-                        end
-                        if intMeasure[:value].nil? || intMeasure[:value] == ''
-                            responseObj[:readerExecutionMessages] << 'Measure attribute value is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # measure - type enumeration (required)
+                  if hMeasure.has_key?('type')
+                     unless hMeasure['type'] == ''
+                        type = hMeasure['type']
+                        if %w{ distance length vertical angle measure scale }.one? {|word| word == type}
+                           intMeasure[:type] = hMeasure['type']
+                        else
+                           responseObj[:readerExecutionMessages] <<
+                              'ERROR: mdJson reader: measure type must be distance, length, vertical, or angle'
+                           responseObj[:readerExecutionPass] = false
+                           return nil
                         end
+                     end
+                  end
+                  if intMeasure[:type].nil? || intMeasure[:type] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: measure type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # measure - unit of measure (required)
-                        if hMeasure.has_key?('unitOfMeasure')
-                            intMeasure[:unitOfMeasure] = hMeasure['unitOfMeasure']
-                        end
-                        if intMeasure[:unitOfMeasure].nil? || intMeasure[:unitOfMeasure] == ''
-                            responseObj[:readerExecutionMessages] << 'Measure attribute unitOfMeasure is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # measure - value (required)
+                  if hMeasure.has_key?('value')
+                     intMeasure[:value] = hMeasure['value']
+                  end
+                  if intMeasure[:value].nil? || intMeasure[:value] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: measure value is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        return intMeasure
+                  # measure - unit of measure (required)
+                  if hMeasure.has_key?('unitOfMeasure')
+                     intMeasure[:unitOfMeasure] = hMeasure['unitOfMeasure']
+                  end
+                  if intMeasure[:unitOfMeasure].nil? || intMeasure[:unitOfMeasure] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: measure unit-of-measure is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                    end
+                  return intMeasure
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,104 +2,104 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-20 original script
+#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2016-10-20 original script
 
 require_relative 'module_citation'
 require_relative 'module_identifier'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Medium
-
-                    def self.unpack(hMedium, responseObj)
-
-                        # return nil object if input is empty
-                        if hMedium.empty?
-                            responseObj[:readerExecutionMessages] << 'Medium object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intMedium = intMetadataClass.newMedium
-
-                        # medium - mediumSpecification {citation}
-                        if hMedium.has_key?('mediumSpecification')
-                            hObject = hMedium['mediumSpecification']
-                            unless hObject.empty?
-                                hReturn = Citation.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intMedium[:mediumSpecification] = hReturn
-                                end
-                            end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module Medium
+
+               def self.unpack(hMedium, responseObj)
+
+                  # return nil object if input is empty
+                  if hMedium.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: offline distribution medium object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intMedium = intMetadataClass.newMedium
+
+                  # medium - mediumSpecification {citation}
+                  if hMedium.has_key?('mediumSpecification')
+                     hObject = hMedium['mediumSpecification']
+                     unless hObject.empty?
+                        hReturn = Citation.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intMedium[:mediumSpecification] = hReturn
                         end
-
-                        # medium - density
-                        if hMedium.has_key?('density')
-                            if hMedium['density'] != ''
-                                intMedium[:density] = hMedium['density']
-                            end
+                     end
+                  end
+
+                  # medium - density
+                  if hMedium.has_key?('density')
+                     unless hMedium['density'] == ''
+                        intMedium[:density] = hMedium['density']
+                     end
+                  end
+
+                  # medium - units
+                  if hMedium.has_key?('units')
+                     unless hMedium['units'] == ''
+                        intMedium[:units] = hMedium['units']
+                     end
+                  end
+
+                  # medium - numberOfVolumes
+                  if hMedium.has_key?('numberOfVolumes')
+                     unless hMedium['numberOfVolumes'] == ''
+                        intMedium[:numberOfVolumes] = hMedium['numberOfVolumes']
+                     end
+                  end
+
+                  # medium - numberOfVolumes
+                  if hMedium.has_key?('numberOfVolumes')
+                     unless hMedium['numberOfVolumes'] == ''
+                        intMedium[:numberOfVolumes] = hMedium['numberOfVolumes']
+                     end
+                  end
+
+                  # medium - mediumFormat
+                  if hMedium.has_key?('mediumFormat')
+                     hMedium['mediumFormat'].each do |item|
+                        if item != ''
+                           intMedium[:mediumFormat] << item
                         end
-
-                        # medium - units
-                        if hMedium.has_key?('units')
-                            if hMedium['units'] != ''
-                                intMedium[:units] = hMedium['units']
-                            end
+                     end
+                  end
+
+                  # medium - note
+                  if hMedium.has_key?('note')
+                     unless hMedium['note'] == ''
+                        intMedium[:note] = hMedium['note']
+                     end
+                  end
+
+                  # medium - identifier
+                  if hMedium.has_key?('identifier')
+                     hObject = hMedium['identifier']
+                     unless hObject.empty?
+                        hReturn = Identifier.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intMedium[:identifier] = hReturn
                         end
+                     end
+                  end
 
-                        # medium - numberOfVolumes
-                        if hMedium.has_key?('numberOfVolumes')
-                            if hMedium['numberOfVolumes'] != ''
-                                intMedium[:numberOfVolumes] = hMedium['numberOfVolumes']
-                            end
-                        end
+                  return intMedium
 
-                        # medium - numberOfVolumes
-                        if hMedium.has_key?('numberOfVolumes')
-                            if hMedium['numberOfVolumes'] != ''
-                                intMedium[:numberOfVolumes] = hMedium['numberOfVolumes']
-                            end
-                        end
-
-                        # medium - mediumFormat
-                        if hMedium.has_key?('mediumFormat')
-                            hMedium['mediumFormat'].each do |item|
-                                if item != ''
-                                    intMedium[:mediumFormat] << item
-                                end
-                            end
-                        end
-
-                        # medium - note
-                        if hMedium.has_key?('note')
-                            if hMedium['note'] != ''
-                                intMedium[:note] = hMedium['note']
-                            end
-                        end
-
-                        # medium - identifier
-                        if hMedium.has_key?('identifier')
-                            hObject = hMedium['identifier']
-                            unless hObject.empty?
-                                hReturn = Identifier.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intMedium[:identifier] = hReturn
-                                end
-                            end
-                        end
-
-                        return intMedium
-
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,7 +2,8 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-11-02 original script
+#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2016-11-02 original script
 
 require_relative 'module_metadataInfo'
 require_relative 'module_resourceInfo'
@@ -13,119 +14,119 @@ require_relative 'module_additionalDocumentation'
 require_relative 'module_funding'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Metadata
-
-                    def self.unpack(hMetadata, responseObj)
-
-                        # return nil object if input is empty
-                        if hMetadata.empty?
-                            responseObj[:readerExecutionMessages] << 'Metadata object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module Metadata
+
+               def self.unpack(hMetadata, responseObj)
+
+                  # return nil object if input is empty
+                  if hMetadata.empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata object is empty'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intMetadata = intMetadataClass.newMetadata
+
+                  # metadata - metadata info {metadataInfo} (required)
+                  if hMetadata.has_key?('metadataInfo')
+                     hObject = hMetadata['metadataInfo']
+                     unless hObject.empty?
+                        hReturn = MetadataInfo.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intMetadata[:metadataInfo] = hReturn
                         end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intMetadata = intMetadataClass.newMetadata
-
-                        # metadata - metadata info {metadataInfo} (required)
-                        if hMetadata.has_key?('metadataInfo')
-                            hObject = hMetadata['metadataInfo']
-                            unless hObject.empty?
-                                hReturn = MetadataInfo.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intMetadata[:metadataInfo] = hReturn
-                                end
-                            end
+                     end
+                  end
+                  if intMetadata[:metadataInfo].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata metadata-info object is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # metadata - resource info {resourceInfo} (required)
+                  if hMetadata.has_key?('resourceInfo')
+                     hObject = hMetadata['resourceInfo']
+                     unless hObject.empty?
+                        hReturn = ResourceInfo.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intMetadata[:resourceInfo] = hReturn
                         end
-                        if intMetadata[:metadataInfo].empty?
-                            responseObj[:readerExecutionMessages] << 'Metadata object is missing metadataInfo'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                     end
+                  end
+                  if intMetadata[:resourceInfo].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata resource info object is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # metadata - resource lineage [] {lineage}
+                  if hMetadata.has_key?('resourceLineage')
+                     aItems = hMetadata['resourceLineage']
+                     aItems.each do |item|
+                        hReturn = ResourceLineage.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intMetadata[:lineageInfo] << hReturn
                         end
-
-                        # metadata - resource info {resourceInfo} (required)
-                        if hMetadata.has_key?('resourceInfo')
-                            hObject = hMetadata['resourceInfo']
-                            unless hObject.empty?
-                                hReturn = ResourceInfo.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intMetadata[:resourceInfo] = hReturn
-                                end
-                            end
+                     end
+                  end
+
+                  # metadata - resource distribution [] {distribution}
+                  if hMetadata.has_key?('resourceDistribution')
+                     aItems = hMetadata['resourceDistribution']
+                     aItems.each do |item|
+                        hReturn = Distribution.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intMetadata[:distributorInfo] << hReturn
                         end
-                        if intMetadata[:resourceInfo].empty?
-                            responseObj[:readerExecutionMessages] << 'Metadata object is missing resourceInfo'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                     end
+                  end
+
+                  # metadata - associated resource [] {associatedResource}
+                  if hMetadata.has_key?('associatedResource')
+                     aItems = hMetadata['associatedResource']
+                     aItems.each do |item|
+                        hReturn = AssociatedResource.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intMetadata[:associatedResources] << hReturn
                         end
-
-                        # metadata - resource lineage [] {lineage}
-                        if hMetadata.has_key?('resourceLineage')
-                            aItems = hMetadata['resourceLineage']
-                            aItems.each do |item|
-                                hReturn = ResourceLineage.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intMetadata[:lineageInfo] << hReturn
-                                end
-                            end
+                     end
+                  end
+
+                  # metadata - additional resource [] {additionalResource}
+                  if hMetadata.has_key?('additionalDocumentation')
+                     aItems = hMetadata['additionalDocumentation']
+                     aItems.each do |item|
+                        hReturn = AdditionalDocumentation.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intMetadata[:additionalDocuments] << hReturn
                         end
-
-                        # metadata - resource distribution [] {distribution}
-                        if hMetadata.has_key?('resourceDistribution')
-                            aItems = hMetadata['resourceDistribution']
-                            aItems.each do |item|
-                                hReturn = Distribution.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intMetadata[:distributorInfo] << hReturn
-                                end
-                            end
+                     end
+                  end
+
+                  # metadata - funding [] {funding}
+                  if hMetadata.has_key?('funding')
+                     aItems = hMetadata['funding']
+                     aItems.each do |item|
+                        hReturn = Funding.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intMetadata[:funding] << hReturn
                         end
+                     end
+                  end
 
-                        # metadata - associated resource [] {associatedResource}
-                        if hMetadata.has_key?('associatedResource')
-                            aItems = hMetadata['associatedResource']
-                            aItems.each do |item|
-                                hReturn = AssociatedResource.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intMetadata[:associatedResources] << hReturn
-                                end
-                            end
-                        end
+                  return intMetadata
 
-                        # metadata - additional resource [] {additionalResource}
-                        if hMetadata.has_key?('additionalDocumentation')
-                            aItems = hMetadata['additionalDocumentation']
-                            aItems.each do |item|
-                                hReturn = AdditionalDocumentation.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intMetadata[:additionalDocuments] << hReturn
-                                end
-                            end
-                        end
-
-                        # metadata - funding [] {funding}
-                        if hMetadata.has_key?('funding')
-                            aItems = hMetadata['funding']
-                            aItems.each do |item|
-                                hReturn = Funding.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intMetadata[:funding] << hReturn
-                                end
-                            end
-                        end
-
-                        return intMetadata
-
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_metadataInfo.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 2018-01-27 add metadataConstraints
 #  Stan Smith 2017-01-31 remove metadataCreationDate
 #  Stan Smith 2016-10-31 original script
@@ -27,7 +28,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hMetaInfo.empty?
-                     responseObj[:readerExecutionMessages] << 'MetadataInfo object is empty'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata info object is empty'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -91,7 +92,7 @@ module ADIWG
                      end
                   end
                   if intMetaInfo[:metadataContacts].empty?
-                     responseObj[:readerExecutionMessages] << 'MetadataInfo object is missing metadataContacts'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata info contact is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -152,7 +153,7 @@ module ADIWG
 
                   # metadata information - metadata status
                   if hMetaInfo.has_key?('metadataStatus')
-                     if hMetaInfo['metadataStatus'] != ''
+                     unless hMetaInfo['metadataStatus'] == ''
                         intMetaInfo[:metadataStatus] = hMetaInfo['metadataStatus']
                      end
                   end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_metadataRepository.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-06-06 add citation to repository
 # 	Stan Smith 2017-02-09 original script
 
@@ -18,8 +19,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hMdDist.empty?
-                     responseObj[:readerExecutionMessages] << 'Metadata Repository object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: metadata repository object is empty'
                      return nil
                   end
 
@@ -32,7 +32,7 @@ module ADIWG
                      intMdDist[:repository] = hMdDist['repository']
                   end
                   if intMdDist[:repository].nil? || intMdDist[:repository] == ''
-                     responseObj[:readerExecutionMessages] << 'Metadata Repository repository is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata repository name is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -49,7 +49,7 @@ module ADIWG
 
                   # metadata distribution - metadata format
                   if hMdDist.has_key?('metadataStandard')
-                     if hMdDist['metadataStandard'] != ''
+                     unless hMdDist['metadataStandard'] == ''
                         intMdDist[:metadataStandard] = hMdDist['metadataStandard']
                      end
                   end