adiwg-mdtranslator 2.9.2 → 2.10.0

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

@@ -2,77 +2,76 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#   Stan Smith 2016-10-06 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 2015-07-24 added error reporting of missing items
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-06 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 2015-07-24 added error reporting of missing items
 # 	Stan Smith 2013-12-01 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module EntityForeignKey
+            module EntityForeignKey
 
-                    def self.unpack(hFKey, responseObj)
+               def self.unpack(hFKey, responseObj)
 
-                        # return nil object if input is empty
-                        if hFKey.empty?
-                            responseObj[:readerExecutionMessages] << 'Foreign Key object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hFKey.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data entity foreign key object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intFKey = intMetadataClass.newEntityForeignKey
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intFKey = intMetadataClass.newEntityForeignKey
 
-                        # entity foreign key - local attribute code name [] (required)
-                        # return nil if no local attribute is provided
-                        if hFKey.has_key?('localAttributeCodeName')
-                            intFKey[:fkLocalAttributes] = hFKey['localAttributeCodeName']
-                        else
-                            intFKey[:fkLocalAttributes] = []
-                        end
-                        if intFKey[:fkLocalAttributes].empty?
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary foreign key local attribute code name is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # entity foreign key - local attribute code name [] (required)
+                  # return nil if no local attribute is provided
+                  if hFKey.has_key?('localAttributeCodeName')
+                     intFKey[:fkLocalAttributes] = hFKey['localAttributeCodeName']
+                  end
+                  if intFKey[:fkLocalAttributes].empty?
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: data entity foreign key local attribute code name is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # entity foreign key - referenced entity code name (required)
-                        # return nil if no referenced entity is provided
-                        if hFKey.has_key?('referencedEntityCodeName')
-                            intFKey[:fkReferencedEntity] = hFKey['referencedEntityCodeName']
-                        end
-                        if intFKey[:fkReferencedEntity].nil? || intFKey[:fkReferencedEntity] == ''
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary foreign key referenced entity name is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # entity foreign key - referenced entity code name (required)
+                  # return nil if no referenced entity is provided
+                  if hFKey.has_key?('referencedEntityCodeName')
+                     intFKey[:fkReferencedEntity] = hFKey['referencedEntityCodeName']
+                  end
+                  if intFKey[:fkReferencedEntity].nil? || intFKey[:fkReferencedEntity] == ''
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: data entity foreign key referenced entity name is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # entity foreign key - referenced attribute code name [] (required)
-                        # return nil if no referenced attribute is provided
-                        if hFKey.has_key?('referencedAttributeCodeName')
-                            intFKey[:fkReferencedAttributes] = hFKey['referencedAttributeCodeName']
-                        else
-                            intFKey[:fkReferencedAttributes] = []
-                        end
-                        if intFKey[:fkReferencedAttributes].empty?
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary foreign key referenced attribute name is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # entity foreign key - referenced attribute code name [] (required)
+                  # return nil if no referenced attribute is provided
+                  if hFKey.has_key?('referencedAttributeCodeName')
+                     intFKey[:fkReferencedAttributes] = hFKey['referencedAttributeCodeName']
+                  end
+                  if intFKey[:fkReferencedAttributes].empty?
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: data entity foreign key referenced attribute name is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        return intFKey
+                  return intFKey
 
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,71 +2,70 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#   Stan Smith 2016-10-07 refactored for mdJson 2.0
-#   Stan Smith 2015-07-24 added error reporting of missing items
-#   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 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-07 refactored for mdJson 2.0
+#  Stan Smith 2015-07-24 added error reporting of missing items
+#  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 2013-12-01 original script
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module EntityIndex
+            module EntityIndex
 
-                    def self.unpack(hIndex, responseObj)
+               def self.unpack(hIndex, responseObj)
 
-                        # return nil object if input is empty
-                        if hIndex.empty?
-                            responseObj[:readerExecutionMessages] << 'Entity Index object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hIndex.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data dictionary entity index object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intIndex = intMetadataClass.newEntityIndex
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intIndex = intMetadataClass.newEntityIndex
 
-                        # entity index - code name (required)
-                        # return nil if no entity index is provided
-                        if hIndex.has_key?('codeName')
-                            intIndex[:indexCode] = hIndex['codeName']
-                        end
-                        if intIndex[:indexCode].nil? || intIndex[:indexCode] == ''
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary entity index name is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # entity index - code name (required)
+                  # return nil if no entity index is provided
+                  if hIndex.has_key?('codeName')
+                     intIndex[:indexCode] = hIndex['codeName']
+                  end
+                  if intIndex[:indexCode].nil? || intIndex[:indexCode] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary entity index code name is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # entity index - allow duplicates (required)
-                        if hIndex.has_key?('allowDuplicates')
-                            if hIndex['allowDuplicates'] === true
-                                intIndex[:duplicate] = true
-                            end
-                        end
+                  # entity index - allow duplicates (required)
+                  if hIndex.has_key?('allowDuplicates')
+                     if hIndex['allowDuplicates'] === true
+                        intIndex[:duplicate] = true
+                     end
+                  end
 
-                        # entity index - attribute list [] (required)
-                        # return nil if no attribute list is provided
-                        if hIndex.has_key?('attributeCodeName')
-                            intIndex[:attributeNames] = hIndex['attributeCodeName']
-                        else
-                            intIndex[:attributeNames] = []
-                        end
-                        if intIndex[:attributeNames].empty?
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary entity index attribute list is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # entity index - attribute list [] (required)
+                  # return nil if no attribute list is provided
+                  if hIndex.has_key?('attributeCodeName')
+                     intIndex[:attributeNames] = hIndex['attributeCodeName']
+                  end
+                  if intIndex[:attributeNames].empty?
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: data dictionary entity index attribute list is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        return intIndex
+                  return intIndex
 
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,82 +2,96 @@
 # Reader - mdJson to internal data structure
 
 # History:
-#   Stan Smith 2016-10-30 original script
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-10-30 original script
 
 require_relative 'module_geographicExtent'
 require_relative 'module_temporalExtent'
 require_relative 'module_verticalExtent'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module Extent
+            module Extent
 
-                    def self.unpack(hExtent, responseObj)
+               def self.unpack(hExtent, responseObj)
 
-                        # return nil object if input is empty
-                        if hExtent.empty?
-                            responseObj[:readerExecutionMessages] << 'Extent object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hExtent.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: extent object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intExtent = intMetadataClass.newExtent
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intExtent = intMetadataClass.newExtent
 
-                        # extent - description
-                        if hExtent.has_key?('description')
-                            if  hExtent['description'] != ''
-                                intExtent[:description] =  hExtent['description']
-                            end
-                        end
+                  haveExtent = false
 
-                        # extent - geographicExtent
-                        if hExtent.has_key?('geographicExtent')
-                            hExtent['geographicExtent'].each do |item|
-                                unless item.empty?
-                                    hReturn = GeographicExtent.unpack(item, responseObj)
-                                    unless hReturn.nil?
-                                        intExtent[:geographicExtents] << hReturn
-                                    end
-                                end
-                            end
+                  # extent - description
+                  if hExtent.has_key?('description')
+                     unless hExtent['description'] == ''
+                        intExtent[:description] = hExtent['description']
+                        haveExtent = true
+                     end
+                  end
+
+                  # extent - geographicExtent
+                  if hExtent.has_key?('geographicExtent')
+                     hExtent['geographicExtent'].each do |item|
+                        unless item.empty?
+                           hReturn = GeographicExtent.unpack(item, responseObj)
+                           unless hReturn.nil?
+                              intExtent[:geographicExtents] << hReturn
+                              haveExtent = true
+                           end
                         end
+                     end
+                  end
 
-                        # extent - temporalExtent
-                        if hExtent.has_key?('temporalExtent')
-                            hExtent['temporalExtent'].each do |item|
-                                unless item.empty?
-                                    hReturn = TemporalExtent.unpack(item, responseObj)
-                                    unless hReturn.nil?
-                                        intExtent[:temporalExtents] << hReturn
-                                    end
-                                end
-                            end
+                  # extent - temporalExtent
+                  if hExtent.has_key?('temporalExtent')
+                     hExtent['temporalExtent'].each do |item|
+                        unless item.empty?
+                           hReturn = TemporalExtent.unpack(item, responseObj)
+                           unless hReturn.nil?
+                              intExtent[:temporalExtents] << hReturn
+                              haveExtent = true
+                           end
                         end
+                     end
+                  end
 
-                        # extent - verticalExtent
-                        if hExtent.has_key?('verticalExtent')
-                            hExtent['verticalExtent'].each do |item|
-                                unless item.empty?
-                                    hReturn = VerticalExtent.unpack(item, responseObj)
-                                    unless hReturn.nil?
-                                        intExtent[:verticalExtents] << hReturn
-                                    end
-                                end
-                            end
+                  # extent - verticalExtent
+                  if hExtent.has_key?('verticalExtent')
+                     hExtent['verticalExtent'].each do |item|
+                        unless item.empty?
+                           hReturn = VerticalExtent.unpack(item, responseObj)
+                           unless hReturn.nil?
+                              intExtent[:verticalExtents] << hReturn
+                              haveExtent = true
+                           end
                         end
+                     end
+                  end
 
-                        return intExtent
+                  # error messages
+                  unless haveExtent
+                     responseObj[:readerExecutionMessages] <<
+                        'ERROR: mdJson reader: extent must have description or at least one geographic, temporal, or vertical extent'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                    end
+                  return intExtent
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,86 +2,87 @@
 # Reader - ADIwg JSON to internal data structure
 
 # History:
-#   Stan Smith 2016-11-10 added computedBbox computation
-#   Stan Smith 2016-10-25 original script
+#  Stan Smith 2018-02-18 refactored error and warning messaging
+#  Stan Smith 2016-11-10 added computedBbox computation
+#  Stan Smith 2016-10-25 original script
 
 require_relative 'module_geoJson'
 require 'adiwg/mdtranslator/internal/module_coordinates'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
+   module Mdtranslator
+      module Readers
+         module MdJson
 
-                module FeatureCollection
+            module FeatureCollection
 
-                    def self.unpack(hFeatCol, responseObj)
+               def self.unpack(hFeatCol, responseObj)
 
-                        # return nil object if input is empty
-                        if hFeatCol.empty?
-                            responseObj[:readerExecutionMessages] << 'Feature Collection object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # return nil object if input is empty
+                  if hFeatCol.empty?
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: GeoJson feature collection object is empty'
+                     return nil
+                  end
 
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intFeatCol = intMetadataClass.newFeatureCollection
-
-                        # feature collection - type (required)
-                        if hFeatCol.has_key?('type')
-                            if hFeatCol['type'] != ''
-                                if hFeatCol['type'] == 'FeatureCollection'
-                                    intFeatCol[:type] = hFeatCol['type']
-                                else
-                                    responseObj[:readerExecutionMessages] << 'Feature Collection type must be GeometryCollection'
-                                    responseObj[:readerExecutionPass] = false
-                                    return nil
-                                end
-                            end
-                        end
-                        if intFeatCol[:type].nil? || intFeatCol[:type] == ''
-                            responseObj[:readerExecutionMessages] << 'Feature Collection is missing type'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intFeatCol = intMetadataClass.newFeatureCollection
 
-                        # feature collection - bounding box
-                        if hFeatCol.has_key?('bbox')
-                            unless hFeatCol['bbox'].empty?
-                                intFeatCol[:bbox] = hFeatCol['bbox']
-                            end
-                        end
-
-                        # feature collection - features (required, but can be empty)
-                        if hFeatCol.has_key?('features')
-                            hFeatCol['features'].each do |hFeature|
-                                hReturn = GeoJson.unpack(hFeature, responseObj)
-                                unless hReturn.nil?
-                                    intFeatCol[:features] << hReturn
-                                end
-                            end
+                  # feature collection - type (required)
+                  if hFeatCol.has_key?('type')
+                     unless hFeatCol['type'] == ''
+                        if hFeatCol['type'] == 'FeatureCollection'
+                           intFeatCol[:type] = hFeatCol['type']
                         else
-                            responseObj[:readerExecutionMessages] << 'Features Collection is missing features'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                           responseObj[:readerExecutionMessages] <<
+                              'ERROR: mdJson reader: GeoJson feature collection type must be FeatureCollection'
+                           responseObj[:readerExecutionPass] = false
+                           return nil
                         end
-
-                        # geometry feature - computed bounding box for extent
-                        unless intFeatCol[:features].empty?
-                            intFeatCol[:computedBbox] = AdiwgCoordinates.computeBbox(intFeatCol[:features])
+                     end
+                  end
+                  if intFeatCol[:type].nil? || intFeatCol[:type] == ''
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJson feature collection type is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # feature collection - bounding box
+                  if hFeatCol.has_key?('bbox')
+                     unless hFeatCol['bbox'].empty?
+                        intFeatCol[:bbox] = hFeatCol['bbox']
+                     end
+                  end
+
+                  # feature collection - features (required, but can be empty)
+                  if hFeatCol.has_key?('features')
+                     hFeatCol['features'].each do |hFeature|
+                        hReturn = GeoJson.unpack(hFeature, responseObj)
+                        unless hReturn.nil?
+                           intFeatCol[:features] << hReturn
                         end
+                     end
+                  else
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: GeoJson feature collection features are missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
 
-                        # geometry feature - save native GeoJSON for feature
-                        intFeatCol[:nativeGeoJson] = hFeatCol
+                  # geometry feature - computed bounding box for extent
+                  unless intFeatCol[:features].empty?
+                     intFeatCol[:computedBbox] = AdiwgCoordinates.computeBbox(intFeatCol[:features])
+                  end
 
-                        return intFeatCol
+                  # geometry feature - save native GeoJSON for feature
+                  intFeatCol[:nativeGeoJson] = hFeatCol
 
-                    end
+                  return intFeatCol
 
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

data/lib/adiwg/mdtranslator/readers/mdJson/modules/module_format.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-02-05 add 'technicalPrerequisite'
 # 	Stan Smith 2016-10-20 original script
 
@@ -18,8 +19,7 @@ module ADIWG
 
                   # return nil object if input is empty
                   if hFormat.empty?
-                     responseObj[:readerExecutionMessages] << 'Format object is empty'
-                     responseObj[:readerExecutionPass] = false
+                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: distribution media format object is empty'
                      return nil
                   end
 
@@ -38,28 +38,28 @@ module ADIWG
                      end
                   end
                   if intFormat[:formatSpecification].empty?
-                     responseObj[:readerExecutionMessages] << 'Format is missing formatSpecification'
+                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: distribution media format specification is missing'
                      responseObj[:readerExecutionPass] = false
                      return nil
                   end
 
                   # format - amendment number
                   if hFormat.has_key?('amendmentNumber')
-                     if hFormat['amendmentNumber'] != ''
+                     unless hFormat['amendmentNumber'] == ''
                         intFormat[:amendmentNumber] = hFormat['amendmentNumber']
                      end
                   end
 
                   # format - compression method
                   if hFormat.has_key?('compressionMethod')
-                     if hFormat['compressionMethod'] != ''
+                     unless hFormat['compressionMethod'] == ''
                         intFormat[:compressionMethod] = hFormat['compressionMethod']
                      end
                   end
 
                   # format - compression method
                   if hFormat.has_key?('technicalPrerequisite')
-                     if hFormat['technicalPrerequisite'] != ''
+                     unless hFormat['technicalPrerequisite'] == ''
                         intFormat[:technicalPrerequisite] = hFormat['technicalPrerequisite']
                      end
                   end