adiwg-mdtranslator 2.9.2 → 2.10.0

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_dataDictionary.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 2018-01-25 rename dictionaryFormat to dictionaryFunctionalLanguage
 #  Stan Smith 2017-11-09 add dictionary description
 #  Stan Smith 2017-01-20 refactored for mdJson/mdTranslator 2.0
@@ -27,8 +28,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hDictionary.empty?
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data dictionary object is empty'
                      return nil
                   end
 
@@ -55,7 +55,7 @@ module ADIWG
                      end
                   end
                   if intDictionary[:citation].empty?
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary citation is empty'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary citation is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -64,13 +64,13 @@ module ADIWG
                   if hDictionary.has_key?('subject')
                      aSubjects = hDictionary['subject']
                      aSubjects.each do |item|
-                        if item != ''
+                        unless item == ''
                            intDictionary[:subjects] << item
                         end
                      end
                   end
                   if intDictionary[:subjects].empty?
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary subject is missing'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary subject is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -79,7 +79,7 @@ module ADIWG
                   if hDictionary.has_key?('recommendedUse')
                      aUses = hDictionary['recommendedUse']
                      aUses.each do |item|
-                        if item != ''
+                        unless item == ''
                            intDictionary[:recommendedUses] << item
                         end
                      end
@@ -107,7 +107,7 @@ module ADIWG
                      end
                   end
                   if intDictionary[:responsibleParty].empty?
-                     responseObj[:readerExecutionMessages] << 'Data Dictionary responsible party is empty'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary responsible party is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
@@ -119,6 +119,8 @@ module ADIWG
                      s = hDictionary['dictionaryFunctionalLanguage']
                   elsif hDictionary.has_key?('dictionaryFormat')
                      s = hDictionary['dictionaryFormat']
+                     responseObj[:readerExecutionMessages] <<
+                        'WARNING: mdJson reader: data dictionary dictionaryFormat is deprecated, use dictionaryFunctionalLanguage'
                   end
                   unless s.nil? || s == ''
                      intDictionary[:dictionaryFunctionalLanguage] = s

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

@@ -2,73 +2,73 @@
 # Reader - ADIwg JSON data structure
 
 # History:
-#   Stan Smith 2016-10-12 original script
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-12 original script
 
 require 'adiwg/mdtranslator/internal/module_dateTimeFun'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Date
+            module Date
 
-                    def self.unpack(hDate, responseObj)
+               def self.unpack(hDate, responseObj)
 
-                        # return nil object if input is empty
-                        if hDate.empty?
-                            responseObj[:readerExecutionMessages] << 'Date object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hDate.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: date object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intDate = intMetadataClass.newDate
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intDate = intMetadataClass.newDate
 
-                        # date - date (required)
-                        # if dateTimeFromString fails, [0] = nil; [1] = 'ERROR'
-                        if hDate.has_key?('date') && hDate['date'] != ''
-                            aDateTimeReturn = AdiwgDateTimeFun.dateTimeFromString(hDate['date'])
-                            if aDateTimeReturn[1] == 'ERROR'
-                                responseObj[:readerExecutionMessages] << 'Date string is invalid'
-                                responseObj[:readerExecutionPass] = false
-                                return nil
-                            else
-                                intDate[:date] = aDateTimeReturn[0]
-                                intDate[:dateResolution] = aDateTimeReturn[1]
-                            end
-                        else
-                            responseObj[:readerExecutionMessages] << 'Date string is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # date - date (required)
+                  # if dateTimeFromString fails, [0] = nil; [1] = 'ERROR'
+                  if hDate.has_key?('date') && hDate['date'] != ''
+                     aDateTimeReturn = AdiwgDateTimeFun.dateTimeFromString(hDate['date'])
+                     if aDateTimeReturn[1] == 'ERROR'
+                        responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: date string is invalid'
+                        responseObj[:readerExecutionPass] = false
+                        return nil
+                     else
+                        intDate[:date] = aDateTimeReturn[0]
+                        intDate[:dateResolution] = aDateTimeReturn[1]
+                     end
+                  else
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: date string is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # date - date type (required)
-                        if hDate.has_key?('dateType')
-                            intDate[:dateType] = hDate['dateType']
-                        end
-                        if intDate[:dateType].nil? || intDate[:dateType] == ''
-                            responseObj[:readerExecutionMessages] << 'Date attribute dateType is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # date - date type (required)
+                  if hDate.has_key?('dateType')
+                     intDate[:dateType] = hDate['dateType']
+                  end
+                  if intDate[:dateType].nil? || intDate[:dateType] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: date type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # date - description
-                        if hDate.has_key?('description')
-                            s = hDate['description']
-                            unless s == ''
-                                intDate[:description] = s
-                            end
-                        end
+                  # date - description
+                  if hDate.has_key?('description')
+                     s = hDate['description']
+                     unless s == ''
+                        intDate[:description] = s
+                     end
+                  end
 
-                        return intDate
+                  return intDate
 
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,53 +2,53 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#   Stan Smith 2016-10-05 refactored for mdJson 2.0
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
-#   Stan Smith 2015-07-14 refactored to remove global namespace constants
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-05 refactored for mdJson 2.0
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#  Stan Smith 2015-07-14 refactored to remove global namespace constants
 # 	Stan Smith 2013-12-11 original script
 
 require 'adiwg/mdtranslator/internal/module_dateTimeFun'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module DateTime
+            module DateTime
 
-                    def self.unpack(sDateTime, responseObj)
+               def self.unpack(sDateTime, responseObj)
 
-                        # return nil object if input is empty
-                        if sDateTime == ''
-                            responseObj[:readerExecutionMessages] << 'DateTime string is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if sDateTime == ''
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: dateTime string is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intDateTime = intMetadataClass.newDateTime
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intDateTime = intMetadataClass.newDateTime
 
-                        # dateTime - dateTime (required)
-                        # if dateTimeFromString fails, [0] = nil; [1] = 'ERROR'
-                        aDateTimeReturn = AdiwgDateTimeFun.dateTimeFromString(sDateTime)
-                        if aDateTimeReturn[1] == 'ERROR'
-                            responseObj[:readerExecutionMessages] << 'DateTime string is invalid'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        else
-                            intDateTime[:dateTime] = aDateTimeReturn[0]
-                            intDateTime[:dateResolution] = aDateTimeReturn[1]
-                        end
+                  # dateTime - dateTime (required)
+                  # if dateTimeFromString fails, [0] = nil; [1] = 'ERROR'
+                  aDateTimeReturn = AdiwgDateTimeFun.dateTimeFromString(sDateTime)
+                  if aDateTimeReturn[1] == 'ERROR'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: dateTime string is invalid'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  else
+                     intDateTime[:dateTime] = aDateTimeReturn[0]
+                     intDateTime[:dateResolution] = aDateTimeReturn[1]
+                  end
 
-                        return intDateTime
+                  return intDateTime
 
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,86 +2,86 @@
 # Reader - ADIwg JSON to internal dimension
 
 # History:
+#  Stan Smith 2018-02-18 refactored error and warning messaging
 # 	Stan Smith 2016-10-18 original script
 
 require_relative 'module_measure'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Dimension
-
-                    def self.unpack(hDimension, responseObj)
-
-                        # return nil object if input is empty
-                        if hDimension.empty?
-                            responseObj[:readerExecutionMessages] << 'Dimension object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intDimension = intMetadataClass.newDimension
-
-                        # dimension - dimension type (required)
-                        if hDimension.has_key?('dimensionType')
-                            if hDimension['dimensionType'] != ''
-                                intDimension[:dimensionType] = hDimension['dimensionType']
-                            end
-                        end
-                        if intDimension[:dimensionType].nil?
-                            responseObj[:readerExecutionMessages] << 'Dimension is missing dimensionType'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # dimension - dimension size (required)
-                        if hDimension.has_key?('dimensionSize')
-                            if hDimension['dimensionSize'] != ''
-                                intDimension[:dimensionSize] = hDimension['dimensionSize']
-                            end
-                        end
-                        if intDimension[:dimensionSize].nil?
-                            responseObj[:readerExecutionMessages] << 'Dimension is missing dimensionSize'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # dimension - resolution {measure}
-                        if hDimension.has_key?('resolution')
-                            hObject = hDimension['resolution']
-                            unless hObject.empty?
-                                hReturn = Measure.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intDimension[:resolution] = hReturn
-                                end
-                            end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module Dimension
+
+               def self.unpack(hDimension, responseObj)
+
+                  # return nil object if input is empty
+                  if hDimension.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: spatial representation dimension object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intDimension = intMetadataClass.newDimension
+
+                  # dimension - dimension type (required)
+                  if hDimension.has_key?('dimensionType')
+                     unless hDimension['dimensionType'] == ''
+                        intDimension[:dimensionType] = hDimension['dimensionType']
+                     end
+                  end
+                  if intDimension[:dimensionType].nil?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: spatial representation dimension type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # dimension - dimension size (required)
+                  if hDimension.has_key?('dimensionSize')
+                     unless hDimension['dimensionSize'] == ''
+                        intDimension[:dimensionSize] = hDimension['dimensionSize']
+                     end
+                  end
+                  if intDimension[:dimensionSize].nil?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: spatial representation dimension size is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # dimension - resolution {measure}
+                  if hDimension.has_key?('resolution')
+                     hObject = hDimension['resolution']
+                     unless hObject.empty?
+                        hReturn = Measure.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intDimension[:resolution] = hReturn
                         end
+                     end
+                  end
 
-                        # dimension - dimension title
-                        if hDimension.has_key?('dimensionTitle')
-                            if hDimension['dimensionTitle'] != ''
-                                intDimension[:dimensionTitle] = hDimension['dimensionTitle']
-                            end
-                        end
-
-                        # dimension - dimension description
-                        if hDimension.has_key?('dimensionDescription')
-                            if hDimension['dimensionDescription'] != ''
-                                intDimension[:dimensionDescription] = hDimension['dimensionDescription']
-                            end
-                        end
+                  # dimension - dimension title
+                  if hDimension.has_key?('dimensionTitle')
+                     unless hDimension['dimensionTitle'] == ''
+                        intDimension[:dimensionTitle] = hDimension['dimensionTitle']
+                     end
+                  end
 
-                        return intDimension
+                  # dimension - dimension description
+                  if hDimension.has_key?('dimensionDescription')
+                     unless hDimension['dimensionDescription'] == ''
+                        intDimension[:dimensionDescription] = hDimension['dimensionDescription']
+                     end
+                  end
 
-                    end
+                  return intDimension
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_distribution.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 2018-01-29 add liabilityStatement
 #  Stan Smith 2016-10-21 original script
 
@@ -18,8 +19,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hDistribution.empty?
-                     responseObj[:readerExecutionMessages] << 'Distribution object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: distribution object is empty'
                      return nil
                   end
 
@@ -27,16 +27,19 @@ module ADIWG
                   intMetadataClass = InternalMetadata.new
                   intDistribution = intMetadataClass.newDistribution
 
+                  haveDist = false
+
                   # distribution - description
                   if hDistribution.has_key?('description')
-                     if hDistribution['description'] != ''
+                     unless hDistribution['description'] == ''
                         intDistribution[:description] = hDistribution['description']
+                        haveDist = true
                      end
                   end
 
                   # distribution - liability statement
                   if hDistribution.has_key?('liabilityStatement')
-                     if hDistribution['liabilityStatement'] != ''
+                     unless hDistribution['liabilityStatement'] == ''
                         intDistribution[:liabilityStatement] = hDistribution['liabilityStatement']
                      end
                   end
@@ -48,10 +51,18 @@ module ADIWG
                         hReturn = Distributor.unpack(item, responseObj)
                         unless hReturn.nil?
                            intDistribution[:distributor] << hReturn
+                           haveDist = true
                         end
                      end
                   end
 
+                  # error messages
+                  unless haveDist
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: distribution must have description or distributor'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
                   return intDistribution
 
                end

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

@@ -2,77 +2,77 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-10-21 original script
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-21 original script
 
 require_relative 'module_responsibleParty'
 require_relative 'module_orderProcess'
 require_relative 'module_transferOption'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Distributor
+            module Distributor
 
-                    def self.unpack(hDistrib, responseObj)
+               def self.unpack(hDistrib, responseObj)
 
-                        # return nil object if input is empty
-                        if hDistrib.empty?
-                            responseObj[:readerExecutionMessages] << 'Distributor object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hDistrib.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: distributor object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intDistrib = intMetadataClass.newDistributor
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intDistrib = intMetadataClass.newDistributor
 
-                        # distributor - contact {responsibleParty} (required)
-                        if hDistrib.has_key?('contact')
-                            hObject = hDistrib['contact']
-                            unless hObject.empty?
-                                hReturn = ResponsibleParty.unpack(hObject, responseObj)
-                                unless hReturn.nil?
-                                    intDistrib[:contact] = hReturn
-                                end
-                            end
-                        end
-                        if intDistrib[:contact].empty?
-                            responseObj[:readerExecutionMessages] << 'Distributor object is missing contact'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                  # distributor - contact {responsibleParty} (required)
+                  if hDistrib.has_key?('contact')
+                     hObject = hDistrib['contact']
+                     unless hObject.empty?
+                        hReturn = ResponsibleParty.unpack(hObject, responseObj)
+                        unless hReturn.nil?
+                           intDistrib[:contact] = hReturn
                         end
+                     end
+                  end
+                  if intDistrib[:contact].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: distributor contact is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # distributor - order process [orderProcess]
-                        if hDistrib.has_key?('orderProcess')
-                            aItems = hDistrib['orderProcess']
-                            aItems.each do |item|
-                                hReturn = OrderProcess.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intDistrib[:orderProcess] << hReturn
-                                end
-                            end
+                  # distributor - order process [orderProcess]
+                  if hDistrib.has_key?('orderProcess')
+                     aItems = hDistrib['orderProcess']
+                     aItems.each do |item|
+                        hReturn = OrderProcess.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intDistrib[:orderProcess] << hReturn
                         end
+                     end
+                  end
 
-                        # distributor - transfer options [transferOption]
-                        if hDistrib.has_key?('transferOption')
-                            aItemss = hDistrib['transferOption']
-                            aItemss.each do |item|
-                                hReturn = TransferOption.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intDistrib[:transferOptions] << hReturn
-                                end
-                            end
+                  # distributor - transfer options [transferOption]
+                  if hDistrib.has_key?('transferOption')
+                     aItemss = hDistrib['transferOption']
+                     aItemss.each do |item|
+                        hReturn = TransferOption.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intDistrib[:transferOptions] << hReturn
                         end
+                     end
+                  end
 
-                        return intDistrib
+                  return intDistrib
 
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end