adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,11 +2,12 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-17 refactored for mdJson 2.0
-#   Stan Smith 2015-07-14 refactored to remove global namespace constants
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
+#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2016-10-17 refactored for mdJson 2.0
+#  Stan Smith 2015-07-14 refactored to remove global namespace constants
+#  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
 # 	Stan Smith 2013-11-26 original script
 
 require_relative 'module_scope'
@@ -15,90 +16,93 @@ require_relative 'module_processStep'
 require_relative 'module_source'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module ResourceLineage
-
-                    def self.unpack(hLineage, responseObj)
-
-                        # return nil object if input is empty
-                        if hLineage.empty?
-                            responseObj[:readerExecutionMessages] << 'Resource Lineage object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intLineage = intMetadataClass.newLineage
-
-                        # lineage - statement
-                        if hLineage.has_key?('statement')
-                            if hLineage['statement'] != ''
-                                intLineage[:statement] = hLineage['statement']
-                            end
-                        end
-
-                        # lineage - resource scope
-                        if hLineage.has_key?('scope')
-                            hObject = hLineage['scope']
-                            unless hObject.empty?
-                                hReturn = Scope.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intLineage[:resourceScope] = hReturn
-                                end
-                            end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module ResourceLineage
+
+               def self.unpack(hLineage, responseObj)
+
+                  # return nil object if input is empty
+                  if hLineage.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: resource lineage object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intLineage = intMetadataClass.newLineage
+
+                  haveLineage = false
+
+                  # lineage - statement
+                  if hLineage.has_key?('statement')
+                     unless hLineage['statement'] == ''
+                        intLineage[:statement] = hLineage['statement']
+                        haveLineage = true
+                     end
+                  end
+
+                  # lineage - resource scope
+                  if hLineage.has_key?('scope')
+                     hObject = hLineage['scope']
+                     unless hObject.empty?
+                        hReturn = Scope.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intLineage[:resourceScope] = hReturn
                         end
-
-                        # lineage - citation []
-                        if hLineage.has_key?('citation')
-                            aCitation = hLineage['citation']
-                            aCitation.each do |item|
-                                hCitation = Citation.unpack(item, responseObj)
-                                unless hCitation.nil?
-                                    intLineage[:lineageCitation] << hCitation
-                                end
-                            end
+                     end
+                  end
+
+                  # lineage - citation []
+                  if hLineage.has_key?('citation')
+                     aCitation = hLineage['citation']
+                     aCitation.each do |item|
+                        hCitation = Citation.unpack(item, responseObj)
+                        unless hCitation.nil?
+                           intLineage[:lineageCitation] << hCitation
                         end
-
-                        # lineage - sources []
-                        if hLineage.has_key?('source')
-                            aSource = hLineage['source']
-                            aSource.each do |item|
-                                hSource = Source.unpack(item, responseObj)
-                                unless hSource.nil?
-                                    intLineage[:dataSources] << hSource
-                                end
-                            end
+                     end
+                  end
+
+                  # lineage - sources []
+                  if hLineage.has_key?('source')
+                     aSource = hLineage['source']
+                     aSource.each do |item|
+                        hSource = Source.unpack(item, responseObj)
+                        unless hSource.nil?
+                           intLineage[:dataSources] << hSource
+                           haveLineage = true
                         end
-
-                        # lineage - process steps []
-                        if hLineage.has_key?('processStep')
-                            aSteps = hLineage['processStep']
-                            aSteps.each do |item|
-                                hSteps = ProcessStep.unpack(item, responseObj)
-                                unless hSteps.nil?
-                                    intLineage[:processSteps] << hSteps
-                                end
-                            end
+                     end
+                  end
+
+                  # lineage - process steps []
+                  if hLineage.has_key?('processStep')
+                     aSteps = hLineage['processStep']
+                     aSteps.each do |item|
+                        hSteps = ProcessStep.unpack(item, responseObj)
+                        unless hSteps.nil?
+                           intLineage[:processSteps] << hSteps
+                           haveLineage = true
                         end
+                     end
+                  end
 
-                        if intLineage[:statement].nil? &&
-                            intLineage[:dataSources].empty? &&
-                            intLineage[:processSteps].empty?
-                            responseObj[:readerExecutionMessages] << 'Resource Lineage must have at least one statement, processStep, or ssource'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        return intLineage
-                    end
+                  unless haveLineage
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: resource lineage must have at least one statement, process step, or source'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                end
+                  return intLineage
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,65 +2,65 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2016-10-05 refactored for mdJson 2.0
 # 	Stan Smith 2015-07-28 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Locale
+            module Locale
 
-                    def self.unpack(hLocale, responseObj)
+               def self.unpack(hLocale, responseObj)
 
-                        # return nil object if input is empty
-                        if hLocale.empty?
-                            responseObj[:readerExecutionMessages] << 'Locale object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hLocale.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: locale object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intLocale = intMetadataClass.newLocale
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intLocale = intMetadataClass.newLocale
 
-                        # locale - language (required)
-                        # return nil if no language code is provided
-                        if hLocale.has_key?('language')
-                            intLocale[:languageCode] = hLocale['language']
-                        end
-                        if intLocale[:languageCode].nil? || intLocale[:languageCode] == ''
-                            responseObj[:readerExecutionMessages] << 'Locale object did not provide a language code'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # locale - language (required)
+                  # return nil if no language code is provided
+                  if hLocale.has_key?('language')
+                     intLocale[:languageCode] = hLocale['language']
+                  end
+                  if intLocale[:languageCode].nil? || intLocale[:languageCode] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: locale language code is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # locale - country
-                        if hLocale.has_key?('country')
-                            if hLocale['country'] != ''
-                                intLocale[:countryCode] = hLocale['country']
-                            end
-                        end
+                  # locale - country
+                  if hLocale.has_key?('country')
+                     unless hLocale['country'] == ''
+                        intLocale[:countryCode] = hLocale['country']
+                     end
+                  end
 
-                        # locale - character set (required)
-                        # return nil if no character set code is provided
-                        if hLocale.has_key?('characterSet')
-                            intLocale[:characterEncoding] = hLocale['characterSet']
-                        end
-                        if intLocale[:characterEncoding].nil? || intLocale[:characterEncoding] == ''
-                            responseObj[:readerExecutionMessages] << 'Locale object did not provide a character set code'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # locale - character set (required)
+                  # return nil if no character set code is provided
+                  if hLocale.has_key?('characterSet')
+                     intLocale[:characterEncoding] = hLocale['characterSet']
+                  end
+                  if intLocale[:characterEncoding].nil? || intLocale[:characterEncoding] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: locale character set code is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        return intLocale
+                  return intLocale
 
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,92 +2,91 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-23 original script
+#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2016-10-23 original script
 
 require_relative 'module_date'
 require_relative 'module_responsibleParty'
 require_relative 'module_scope'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Maintenance
-
-                    def self.unpack(hMaint, responseObj)
-
-
-                        # return nil object if input is empty
-                        if hMaint.empty?
-                            responseObj[:readerExecutionMessages] << 'Resource Maintenance object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module Maintenance
+
+               def self.unpack(hMaint, responseObj)
+
+                  # return nil object if input is empty
+                  if hMaint.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: resource maintenance object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intMaint = intMetadataClass.newMaintenance
+
+                  # maintenance - frequency (required)
+                  if hMaint.has_key?('frequency')
+                     intMaint[:frequency] = hMaint['frequency']
+                  end
+                  if intMaint[:frequency].nil? || intMaint[:frequency] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: resource maintenance frequency is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # maintenance - date []
+                  if hMaint.has_key?('date')
+                     aItems = hMaint['date']
+                     aItems.each do |item|
+                        hReturn = Date.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intMaint[:dates] << hReturn
                         end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intMaint = intMetadataClass.newMaintenance
-
-                        # maintenance - frequency (required)
-                        if hMaint.has_key?('frequency')
-                            intMaint[:frequency] = hMaint['frequency']
+                     end
+                  end
+
+                  # maintenance - scope []
+                  if hMaint.has_key?('scope')
+                     aItems = hMaint['scope']
+                     aItems.each do |item|
+                        hReturn = Scope.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intMaint[:scopes] << hReturn
                         end
-                        if intMaint[:frequency].nil? || intMaint[:frequency] == ''
-                            responseObj[:readerExecutionMessages] << 'Resource Maintenance attribute frequency is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                     end
+                  end
+
+                  # maintenance - note []
+                  if hMaint.has_key?('note')
+                     hMaint['note'].each do |item|
+                        if item != ''
+                           intMaint[:notes] << item
                         end
-
-                        # maintenance - date []
-                        if hMaint.has_key?('date')
-                            aItems = hMaint['date']
-                            aItems.each do |item|
-                                hReturn = Date.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intMaint[:dates] << hReturn
-                                end
-                            end
+                     end
+                  end
+
+                  # maintenance - contact []
+                  if hMaint.has_key?('contact')
+                     aItems = hMaint['contact']
+                     aItems.each do |item|
+                        hReturn = ResponsibleParty.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intMaint[:contacts] << hReturn
                         end
+                     end
+                  end
 
-                        # maintenance - scope []
-                        if hMaint.has_key?('scope')
-                            aItems = hMaint['scope']
-                            aItems.each do |item|
-                                hReturn = Scope.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intMaint[:scopes] << hReturn
-                                end
-                            end
-                        end
+                  return intMaint
 
-                        # maintenance - note []
-                        if hMaint.has_key?('note')
-                            hMaint['note'].each do |item|
-                                if item != ''
-                                    intMaint[:notes] << item
-                                end
-                            end
-                        end
-
-                        # maintenance - contact []
-                        if hMaint.has_key?('contact')
-                            aItems = hMaint['contact']
-                            aItems.each do |item|
-                                hReturn = ResponsibleParty.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intMaint[:contacts] << hReturn
-                                end
-                            end
-                        end
-
-                        return intMaint
-
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,7 +2,8 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-11-07 original script
+#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2016-11-07 original script
 
 require 'adiwg/mdtranslator/internal/internal_metadata_obj'
 require_relative 'module_schema'
@@ -22,7 +23,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hMdJson.empty?
-                     responseObj[:readerExecutionMessages] << 'mdJson object is empty'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: object is empty'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -42,7 +43,7 @@ module ADIWG
                      end
                   end
                   if intObj[:schema].empty?
-                     responseObj[:readerExecutionMessages] << 'mdJson object is missing schema'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: schema object is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -59,12 +60,12 @@ module ADIWG
                      end
                   end
                   if intObj[:contacts].empty?
-                     responseObj[:readerExecutionMessages] << 'mdJson object is missing contact'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: contact object is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
 
-                  # mdJson - metadata {metadata}
+                  # mdJson - metadata {metadata} (required)
                   if hMdJson.has_key?('metadata')
                      hObject = hMdJson['metadata']
                      unless hObject.empty?
@@ -74,6 +75,11 @@ module ADIWG
                         end
                      end
                   end
+                  if intObj[:metadata].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: metadata object is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
                   # mdJson - data dictionary [] {dataDictionary}
                   if hMdJson.has_key?('dataDictionary')