lib/adiwg/mdtranslator/readers/mdJson/modules/module_additionalDocumentation.rb in adiwg-mdtranslator-2.9.2 vs lib/adiwg/mdtranslator/readers/mdJson/modules/module_additionalDocumentation.rb in adiwg-mdtranslator-2.10.0

@@ -1,77 +1,77 @@
 # unpack additional documentation
 # 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-30 added return if empty input
-#   ... found & fixed error of method using associatedResource object instead of
-#   ... additionalDocumentation object
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2018-02-18 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-30 added return if empty input
+#  ... found & fixed error of method using associatedResource object instead of
+#  ... additionalDocumentation object
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 # 	Stan Smith 2014-11-06 original script
 
 require_relative 'module_citation'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module AdditionalDocumentation
+            module AdditionalDocumentation
 
-                    def self.unpack(hAddDoc, responseObj)
+               def self.unpack(hAddDoc, responseObj)
 
-                        # return nil object if input is empty
-                        if hAddDoc.empty?
-                            responseObj[:readerExecutionMessages] << 'Additional Documentation object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hAddDoc.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: additional documentation object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intAddDoc = intMetadataClass.newAdditionalDocumentation
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intAddDoc = intMetadataClass.newAdditionalDocumentation
 
-                        # additional documentation - resource type [] (required) {resourceType}
-                        if hAddDoc.has_key?('resourceType')
-                            hAddDoc['resourceType'].each do |item|
-                                unless item.empty?
-                                    hReturn = ResourceType.unpack(item, responseObj)
-                                    unless hReturn.nil?
-                                        intAddDoc[:resourceTypes] << hReturn
-                                    end
-                                end
-                            end
+                  # additional documentation - resource type [] (required) {resourceType}
+                  if hAddDoc.has_key?('resourceType')
+                     hAddDoc['resourceType'].each do |item|
+                        unless item.empty?
+                           hReturn = ResourceType.unpack(item, responseObj)
+                           unless hReturn.nil?
+                              intAddDoc[:resourceTypes] << hReturn
+                           end
                         end
-                        if intAddDoc[:resourceTypes].empty?
-                            responseObj[:readerExecutionMessages] << 'Additional Documentation is missing resourceType'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                     end
+                  end
+                  if intAddDoc[:resourceTypes].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: additional documentation is missing resource type'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # additional documentation - citation [] (required)
-                        if hAddDoc.has_key?('citation')
-                            hAddDoc['citation'].each do |item|
-                                hDoc = Citation.unpack(item, responseObj)
-                                unless hDoc.nil?
-                                    intAddDoc[:citation] << hDoc
-                                end
-                            end
+                  # additional documentation - citation [] (required)
+                  if hAddDoc.has_key?('citation')
+                     hAddDoc['citation'].each do |item|
+                        hDoc = Citation.unpack(item, responseObj)
+                        unless hDoc.nil?
+                           intAddDoc[:citation] << hDoc
                         end
-                        if intAddDoc[:citation].empty?
-                            responseObj[:readerExecutionMessages] << 'Additional Documentation is missing citation'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                     end
+                  end
+                  if intAddDoc[:citation].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: additional documentation is missing citation'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        return intAddDoc
+                  return intAddDoc
 
-                    end
+               end
 
-                end
-
             end
-        end
-    end
+
+         end
+      end
+   end
 end