adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,12 +2,13 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#   Stan Smith 2016-10-11 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 2014-04-28 modified attribute names to match json schema 0.3.0
+#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2016-10-11 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 2014-04-28 modified attribute names to match json schema 0.3.0
 # 	Stan Smith 2013-11-27 modified to process a single resource usage
 # 	Stan Smith 2013-11-25 original script
 
@@ -16,102 +17,101 @@ require_relative 'module_citation'
 require_relative 'module_responsibleParty'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module ResourceUsage
-
-                    def self.unpack(hUsage, responseObj)
-
-                        # return nil object if input is empty
-                        if hUsage.empty?
-                            responseObj[:readerExecutionMessages] << 'Resource Usage object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module ResourceUsage
+
+               def self.unpack(hUsage, responseObj)
+
+                  # return nil object if input is empty
+                  if hUsage.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: resource usage object is empty'
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intUsage = intMetadataClass.newResourceUsage
+
+                  # resource usage - specific usage (required)
+                  if hUsage.has_key?('specificUsage')
+                     intUsage[:specificUsage] = hUsage['specificUsage']
+                  end
+                  if intUsage[:specificUsage].nil? || intUsage[:specificUsage] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: resource usage specific usage is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # resource usage - temporal extent []
+                  if hUsage.has_key?('temporalExtent')
+                     aItems = hUsage['temporalExtent']
+                     aItems.each do |hItem|
+                        hReturn = TemporalExtent.unpack(hItem, responseObj)
+                        unless hReturn.nil?
+                           intUsage[:temporalExtents] << hReturn
                         end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intUsage = intMetadataClass.newResourceUsage
-
-                        # resource usage - specific usage (required)
-                        if hUsage.has_key?('specificUsage')
-                            intUsage[:specificUsage] = hUsage['specificUsage']
+                     end
+                  end
+
+                  # resource usage - user determined limitations
+                  if hUsage.has_key?('userDeterminedLimitation')
+                     unless hUsage['userDeterminedLimitation'] == ''
+                        intUsage[:userLimitation] = hUsage['userDeterminedLimitation']
+                     end
+                  end
+
+                  # resource usage - repository - limitation response []
+                  if hUsage.has_key?('limitationResponse')
+                     hUsage['limitationResponse'].each do |item|
+                        unless item == ''
+                           intUsage[:limitationResponses] << item
                         end
-                        if intUsage[:specificUsage].nil? || intUsage[:specificUsage] == ''
-                            responseObj[:readerExecutionMessages] << 'Resource Usage attribute specificUsage is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                     end
+                  end
+
+                  # resource usage - repository - documented issue
+                  if hUsage.has_key?('documentedIssue')
+                     hCitation = hUsage['documentedIssue']
+                     unless hCitation.empty?
+                        hReturn = Citation.unpack(hCitation, responseObj)
+                        unless hReturn.nil?
+                           intUsage[:identifiedIssue] = hReturn
                         end
-
-                        # resource usage - temporal extent []
-                        if hUsage.has_key?('temporalExtent')
-                            aItems = hUsage['temporalExtent']
-                            aItems.each do |hItem|
-                                hReturn = TemporalExtent.unpack(hItem, responseObj)
-                                unless hReturn.nil?
-                                    intUsage[:temporalExtents] << hReturn
-                                end
-                            end
+                     end
+                  end
+
+                  # resource usage - repository - additional documentation []
+                  if hUsage.has_key?('additionalDocumentation')
+                     aItems = hUsage['additionalDocumentation']
+                     aItems.each do |hItem|
+                        hReturn = Citation.unpack(hItem, responseObj)
+                        unless hReturn.nil?
+                           intUsage[:additionalDocumentation] << hReturn
                         end
-
-                        # resource usage - user determined limitations
-                        if hUsage.has_key?('userDeterminedLimitation')
-                            if hUsage['userDeterminedLimitation'] != ''
-                                intUsage[:userLimitation] = hUsage['userDeterminedLimitation']
-                            end
+                     end
+                  end
+
+                  # resource usage - repository - responsible party []
+                  if hUsage.has_key?('userContactInfo')
+                     aContacts = hUsage['userContactInfo']
+                     aContacts.each do |item|
+                        hReturn = ResponsibleParty.unpack(item, responseObj)
+                        unless hReturn.nil?
+                           intUsage[:userContacts] << hReturn
                         end
+                     end
+                  end
 
-                        # resource usage - repository - limitation response []
-                        if hUsage.has_key?('limitationResponse')
-                            hUsage['limitationResponse'].each do |item|
-                                if item != ''
-                                    intUsage[:limitationResponses] << item
-                                end
-                            end
-                        end
+                  return intUsage
 
-                        # resource usage - repository - documented issue
-                        if hUsage.has_key?('documentedIssue')
-                            hCitation = hUsage['documentedIssue']
-                            unless hCitation.empty?
-                                hReturn = Citation.unpack(hCitation, responseObj)
-                                unless hReturn.nil?
-                                    intUsage[:identifiedIssue] = hReturn
-                                end
-                            end
-                        end
-
-                        # resource usage - repository - additional documentation []
-                        if hUsage.has_key?('additionalDocumentation')
-                            aItems = hUsage['additionalDocumentation']
-                            aItems.each do |hItem|
-                                hReturn = Citation.unpack(hItem, responseObj)
-                                unless hReturn.nil?
-                                    intUsage[:additionalDocumentation] << hReturn
-                                end
-                            end
-                        end
-
-                        # resource usage - repository - responsible party []
-                        if hUsage.has_key?('userContactInfo')
-                            aContacts = hUsage['userContactInfo']
-                            aContacts.each do |item|
-                                hReturn = ResponsibleParty.unpack(item, responseObj)
-                                unless hReturn.nil?
-                                    intUsage[:userContacts] << hReturn
-                                end
-                            end
-                        end
-
-                        return intUsage
-
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,90 +2,90 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#   Stan Smith 2017-01-19 changed timePeriod to extent []
-#   Stan Smith 2016-10-09 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 2015-06-12 added check that contactId for responsibleParty
-#   ... matches an actual contact in the contact array
-#   Stan Smith 2015-01-18 added nil return if hRParty empty
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
-#   Stan Smith 2014-05-28 modified to support JSON schema 0.5.0
-#   ... removed resource IDs associated with contact
+#  Stan Smith 2018-02-19 refactored error and warning messaging
+#  Stan Smith 2017-01-19 changed timePeriod to extent []
+#  Stan Smith 2016-10-09 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 2015-06-12 added check that contactId for responsibleParty
+#  ... matches an actual contact in the contact array
+#  Stan Smith 2015-01-18 added nil return if hRParty empty
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2014-05-28 modified to support JSON schema 0.5.0
+#  ... removed resource IDs associated with contact
 # 	Stan Smith 2013-08-26 original script
 
 require_relative 'module_extent'
 require_relative 'module_party'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module ResponsibleParty
+            module ResponsibleParty
 
-                    def self.unpack(hRParty, responseObj)
+               def self.unpack(hRParty, responseObj)
 
-                        # return nil object if input is empty
-                        if hRParty.empty?
-                            responseObj[:readerExecutionMessages] << 'Responsible Party object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hRParty.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: responsible party object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        # CI_Responsibility replaces CI_ResponsibleParty in 19115-1
-                        # Responsibility object is translated to ResponsibleParty by 19115-2 writer
-                        intMetadataClass = InternalMetadata.new
-                        intResParty = intMetadataClass.newResponsibility
+                  # instance classes needed in script
+                  # CI_Responsibility replaces CI_ResponsibleParty in 19115-1
+                  # Responsibility object is translated to ResponsibleParty by 19115-2 writer
+                  intMetadataClass = InternalMetadata.new
+                  intResParty = intMetadataClass.newResponsibility
 
-                        # responsible party - role - required
-                        if hRParty.has_key?('role')
-                            intResParty[:roleName] = hRParty['role']
-                        end
-                        if intResParty[:roleName].nil? || intResParty[:roleName] == ''
-                            responseObj[:readerExecutionMessages] << 'Responsible Party role is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # responsible party - role - (required)
+                  if hRParty.has_key?('role')
+                     intResParty[:roleName] = hRParty['role']
+                  end
+                  if intResParty[:roleName].nil? || intResParty[:roleName] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: responsible party role is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # responsible party - role extent
-                        if hRParty.has_key?('roleExtent')
-                            aExtent = hRParty['roleExtent']
-                            aExtent.each do |hItem|
-                                unless hItem.empty?
-                                    hTimeExtent = Extent.unpack(hItem, responseObj)
-                                    unless hTimeExtent.nil?
-                                        intResParty[:roleExtents] << hTimeExtent
-                                    end
-                                end
-                            end
+                  # responsible party - role extent
+                  if hRParty.has_key?('roleExtent')
+                     aExtent = hRParty['roleExtent']
+                     aExtent.each do |hItem|
+                        unless hItem.empty?
+                           hTimeExtent = Extent.unpack(hItem, responseObj)
+                           unless hTimeExtent.nil?
+                              intResParty[:roleExtents] << hTimeExtent
+                           end
                         end
+                     end
+                  end
 
-                        # responsible party - party [] (minimum 1)
-                        if hRParty.has_key?('party')
-                            hRParty['party'].each do |hParty|
-                                unless hParty.empty?
-                                    party = Party.unpack(hParty, responseObj)
-                                    unless party.nil?
-                                        intResParty[:parties] << party
-                                    end
-                                end
-                            end
+                  # responsible party - party [] (minimum 1)
+                  if hRParty.has_key?('party')
+                     hRParty['party'].each do |hParty|
+                        unless hParty.empty?
+                           party = Party.unpack(hParty, responseObj)
+                           unless party.nil?
+                              intResParty[:parties] << party
+                           end
                         end
-                        if intResParty[:parties].empty?
-                            responseObj[:readerExecutionMessages] << 'Responsible Party object must have at least one party'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        return intResParty
+                     end
+                  end
+                  if intResParty[:parties].empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: responsible party must have at least one party'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                    end
+                  return intResParty
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,55 +2,56 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
+#  Stan Smith 2018-02-19 refactored error and warning messaging
 # 	Stan Smith 2016-11-02 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Schema
-
-                    def self.unpack(hSchema, responseObj)
-
-                        # return nil object if input is empty
-                        if hSchema.empty?
-                            responseObj[:readerExecutionMessages] << 'Schema object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intSchema = intMetadataClass.newSchema
-
-                        # schema - name (required)
-                        if hSchema.has_key?('name')
-                            intSchema[:name] = hSchema['name']
-                        end
-                        if intSchema[:name].nil? || intSchema[:name] == ''
-                            responseObj[:readerExecutionMessages] << 'Schema is missing name'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # schema - version (required)
-                        if hSchema.has_key?('version')
-                            intSchema[:version] = hSchema['version']
-                        end
-                        if intSchema[:version].nil? || intSchema[:version] == ''
-                            responseObj[:readerExecutionMessages] << 'Schema is missing version'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        return intSchema
-
-                    end
-
-                end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module Schema
+
+               def self.unpack(hSchema, responseObj)
+
+                  # return nil object if input is empty
+                  if hSchema.empty?
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: schema object is empty'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intSchema = intMetadataClass.newSchema
+
+                  # schema - name (required)
+                  if hSchema.has_key?('name')
+                     intSchema[:name] = hSchema['name']
+                  end
+                  if intSchema[:name].nil? || intSchema[:name] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: schema name is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # schema - version (required)
+                  if hSchema.has_key?('version')
+                     intSchema[:version] = hSchema['version']
+                  end
+                  if intSchema[:version].nil? || intSchema[:version] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: schema version is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  return intSchema
+
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_scope.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 2016-10-14 original script
 
 require_relative 'module_scopeDescription'
@@ -9,64 +10,63 @@ require_relative 'module_timePeriod'
 require_relative 'module_extent'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Scope
+            module Scope
 
-                    def self.unpack(hScope, responseObj)
+               def self.unpack(hScope, responseObj)
 
-                        # return nil object if input is empty
-                        if hScope.empty?
-                            responseObj[:readerExecutionMessages] << 'Scope object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hScope.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: mdJson scope object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intScope = intMetadataClass.newScope
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intScope = intMetadataClass.newScope
 
-                        # scope - scope code (required)
-                        if hScope.has_key?('scopeCode')
-                            intScope[:scopeCode] = hScope['scopeCode']
-                        end
-                        if intScope[:scopeCode].nil? || intScope[:scopeCode] == ''
-                            responseObj[:readerExecutionMessages] << 'Scope attribute scopeCode is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # scope - scope code (required)
+                  if hScope.has_key?('scopeCode')
+                     intScope[:scopeCode] = hScope['scopeCode']
+                  end
+                  if intScope[:scopeCode].nil? || intScope[:scopeCode] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: scope scopeCode is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # scope - scope description [] {MD_ScopeDescription}
-                        if hScope.has_key?('scopeDescription')
-                            aScopeDes = hScope['scopeDescription']
-                            aScopeDes.each do |item|
-                                hScopeDes = ScopeDescription.unpack(item, responseObj)
-                                unless hScopeDes.nil?
-                                    intScope[:scopeDescriptions] << hScopeDes
-                                end
-                            end
+                  # scope - scope description [] {MD_ScopeDescription}
+                  if hScope.has_key?('scopeDescription')
+                     aScopeDes = hScope['scopeDescription']
+                     aScopeDes.each do |item|
+                        hScopeDes = ScopeDescription.unpack(item, responseObj)
+                        unless hScopeDes.nil?
+                           intScope[:scopeDescriptions] << hScopeDes
                         end
+                     end
+                  end
 
-                        # scope - extent [] {EX_Extent}
-                        if hScope.has_key?('scopeExtent')
-                            aExtents = hScope['scopeExtent']
-                            aExtents.each do |item|
-                                hExtent = Extent.unpack(item, responseObj)
-                                unless hExtent.nil?
-                                    intScope[:extents] << hExtent
-                                end
-                            end
+                  # scope - extent [] {EX_Extent}
+                  if hScope.has_key?('scopeExtent')
+                     aExtents = hScope['scopeExtent']
+                     aExtents.each do |item|
+                        hExtent = Extent.unpack(item, responseObj)
+                        unless hExtent.nil?
+                           intScope[:extents] << hExtent
                         end
+                     end
+                  end
 
-                        return intScope
+                  return intScope
 
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end