adiwg-mdtranslator 2.4.0 → 2.5.0

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_range.rb

@@ -2,6 +2,7 @@
 # unpack fgdc entity range domain
 
 # History:
+#  Stan Smith 2017-10-30 added range domain
 #  Stan Smith 2017-09-06 original script
 
 require 'nokogiri'
@@ -14,31 +15,79 @@ module ADIWG
 
             module Range
 
+               def self.is_number?(str)
+                  return true if str =~ /[-+]?[0-9]*\.?[0-9]+/
+                  true if Float(str) rescue false
+               end
+
                def self.unpack(xRange, hAttribute, hResponseObj)
 
-                  # entity attribute 5.1.2.4.2.1 (rdommin) - range minimum
-                  # -> dataDictionary.entities.attributes.minValue
-                  min = xRange.xpath('./rdommin').text
-                  unless min.empty?
-                     hAttribute[:minValue] = min
-                  end
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
 
-                  # entity attribute 5.1.2.4.2.2 (rdommax) - range maximum
-                  # -> dataDictionary.entities.attributes.maxValue
-                  max = xRange.xpath('./rdommax').text
-                  unless max.empty?
-                     hAttribute[:maxValue] = max
-                  end
+                  axRanges = xRange.xpath('./rdom')
+                  unless axRanges.empty?
+                     axRanges.each do |xRange|
+
+                        hRange = intMetadataClass.newValueRange
+                        hAttribute[:rangeOfValues] << hRange
+
+                        # entity attribute 5.1.2.4.2.1 (rdommin) - range minimum
+                        # -> dataDictionary.entities.attributes.minValue
+                        # -> dataDictionary.entities.attributes.rangeOfValues.minRangeValue
+                        min = xRange.xpath('./rdommin').text
+                        unless min.empty?
+                           hRange[:minRangeValue] = min
+                           a = [min]
+                           a << hAttribute[:minValue] unless hAttribute[:minValue].nil?
+                           b = a.sort_by do |s|
+                              if s =~ /[-+]?[0-9]*\.?[0-9]+/
+                                 [2, $&.to_f]
+                              else
+                                 [1, s]
+                              end
+                           end
+                           hAttribute[:minValue] = b[0]
+                        end
+
+                        # entity attribute 5.1.2.4.2.2 (rdommax) - range maximum
+                        # -> dataDictionary.entities.attributes.maxValue
+                        # -> dataDictionary.entities.attributes.rangeOfValues.maxRangeValue
+                        max = xRange.xpath('./rdommax').text
+                        unless max.empty?
+                           hRange[:maxRangeValue] = max
+                           a = [max]
+                           a << hAttribute[:maxValue] unless hAttribute[:maxValue].nil?
+                           b = a.sort_by do |s|
+                              if s =~ /[-+]?[0-9]*\.?[0-9]+/
+                                 [2, $&.to_f]
+                              else
+                                 [1, s]
+                              end
+                           end
+                           hAttribute[:maxValue] = b[b.length-1]
+                        end
+
+                        # entity attribute 5.1.2.4.2.3 (attrunit) - units of measure
+                        # -> dataDictionary.entities.attributes.unitOfMeasure
+                        units = xRange.xpath('./attrunit').text
+                        unless units.empty?
+                           hAttribute[:unitOfMeasure] = units
+                        end
+
+                        # entity attribute 5.1.2.4.2.4 (attrmres) - measurement resolution
+                        # -> dataDictionary.entities.attributes.measureResolution
+                        resolution = xRange.xpath('./attrmres').text
+                        unless resolution.empty?
+                           if is_number?(resolution)
+                              hAttribute[:measureResolution] = resolution.to_f
+                           end
+                        end
 
-                  # entity attribute 5.1.2.4.2.3 (attrunit) - units of measure
-                  # -> dataDictionary.entities.attributes.unitOfMeasure
-                  units = xRange.xpath('./attrunit').text
-                  unless units.empty?
-                     hAttribute[:unitOfMeasure] = units
+                     end
                   end
 
-                  # entity attribute 5.1.2.4.2.4 (attrmres) - measurement resolution
-                  # -> not mapped
+                  return hAttribute
 
                end
 

data/lib/adiwg/mdtranslator/readers/fgdc/modules/module_transferInfo.rb

@@ -55,6 +55,9 @@ module ADIWG
                      hSpecification[:otherDetails] << specification
                   end
 
+                  # distribution bio (asciistr) - ASCII file specification
+                  # -> not mapped; cannot reliably merge with entity-attribute definition
+
                   # distribution 6.4.2.1.5 (formcont) - format information content
                   # -> distribution.distributor.transferOption.distributionFormat.formatSpecification.otherCitationDetails
                   specification = xTranInfo.xpath('./formcont').text

data/lib/adiwg/mdtranslator/readers/mdJson/mdJson_reader.rb

@@ -21,8 +21,8 @@
 # 	Stan Smith 2013-08-09 original script
 
 require 'json'
+require 'rubygems'
 require_relative 'mdJson_validator'
-require_relative 'version'
 require_relative 'modules/module_mdJson'
 
 module ADIWG
@@ -88,7 +88,7 @@ module ADIWG
                end
 
                # schema - 2.0.0 =< requested version =< current version
-               currentVersion = ADIWG::Mdtranslator::Readers::MdJson::VERSION
+               currentVersion = Gem::Specification.find_by_name('adiwg-mdjson_schemas').version.to_s
                hResponseObj[:readerVersionRequested] = requestedVersion
                hResponseObj[:readerVersionUsed] = currentVersion
                aCurVersion = currentVersion.split('.')
@@ -100,7 +100,9 @@ module ADIWG
                   end
                end
                unless approved
+                  approvedVersion = aCurVersion[0] + '.0.0'
                   hResponseObj[:readerStructureMessages] << "mdJson schema version '#{requestedVersion}' is not supported"
+                  hResponseObj[:readerStructureMessages] << "mdJson versions '#{approvedVersion}' to '#{currentVersion}' are supported"
                   hResponseObj[:readerStructurePass] = false
                   return {}
                end

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

@@ -2,94 +2,102 @@
 # Reader - ADIwg JSON V1 to internal data structure
 
 # History:
-#   Stan Smith 2016-10-07 refactored for mdJson 2.0
-#   Stan Smith 2015-07-23 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 2017-11-01 added domainReference
+#  Stan Smith 2016-10-07 refactored for mdJson 2.0
+#  Stan Smith 2015-07-23 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
 
 require_relative 'module_domainItem'
+require_relative 'module_citation'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Domain
-
-                    def self.unpack(hDomain, responseObj)
-
-                        # return nil object if input is empty
-                        if hDomain.empty?
-                            responseObj[:readerExecutionMessages] << 'Domain Member object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intDomain = intMetadataClass.newDictionaryDomain
-
-                        # data dictionary domain - id (required)
-                        if hDomain.has_key?('domainId')
-                            intDomain[:domainId] = hDomain['domainId']
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module Domain
+
+               def self.unpack(hDomain, responseObj)
+
+                  # return nil object if input is empty
+                  if hDomain.empty?
+                     responseObj[:readerExecutionMessages] << 'Domain Member object is empty'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intDomain = intMetadataClass.newDictionaryDomain
+
+                  # data dictionary domain - id (required)
+                  if hDomain.has_key?('domainId')
+                     intDomain[:domainId] = hDomain['domainId']
+                  end
+                  if intDomain[:domainId].nil? || intDomain[:domainId] == ''
+                     responseObj[:readerExecutionMessages] << 'Data Dictionary domain ID is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # data dictionary domain - name
+                  if hDomain.has_key?('commonName')
+                     if hDomain['commonName'] != ''
+                        intDomain[:domainName] = hDomain['commonName']
+                     end
+                  end
+
+                  # data dictionary domain - code (required)
+                  if hDomain.has_key?('codeName')
+                     intDomain[:domainCode] = hDomain['codeName']
+                  end
+                  if intDomain[:domainCode].nil? || intDomain[:domainCode] == ''
+                     responseObj[:readerExecutionMessages] << 'Data Dictionary domain code name is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # data dictionary domain - description (required)
+                  if hDomain.has_key?('description')
+                     intDomain[:domainDescription] = hDomain['description']
+                  end
+                  if intDomain[:domainDescription].nil? || intDomain[:domainDescription] == ''
+                     responseObj[:readerExecutionMessages] << 'Data Dictionary domain description is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # data dictionary domain - domain reference {citation}
+                  if hDomain.has_key?('domainReference')
+                     hCitation = hDomain['domainReference']
+                     unless hCitation.empty?
+                        hReturn = Citation.unpack(hCitation, responseObj)
+                        unless hReturn.nil?
+                           intDomain[:domainReference] = hReturn
                         end
-                        if intDomain[:domainId].nil? || intDomain[:domainId] == ''
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary domain ID is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                     end
+                  end
+
+                  # data dictionary domain - items []
+                  if hDomain.has_key?('domainItem')
+                     hDomain['domainItem'].each do |item|
+                        hDom = DomainItem.unpack(item, responseObj)
+                        unless hDom.nil?
+                           intDomain[:domainItems] << hDom
                         end
+                     end
+                  end
 
-                        # data dictionary domain - name
-                        if hDomain.has_key?('commonName')
-                            if hDomain['commonName'] != ''
-                                intDomain[:domainName] = hDomain['commonName']
-                            end
-                        end
+                  return intDomain
 
-                        # data dictionary domain - code (required)
-                        if hDomain.has_key?('codeName')
-                            intDomain[:domainCode] = hDomain['codeName']
-                        end
-                        if intDomain[:domainCode].nil? || intDomain[:domainCode] == ''
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary domain code name is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # data dictionary domain - description (required)
-                        if hDomain.has_key?('description')
-                            intDomain[:domainDescription] = hDomain['description']
-                        end
-                        if intDomain[:domainDescription].nil? || intDomain[:domainDescription] == ''
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary domain description is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # data dictionary domain - items [] (required)
-                        if hDomain.has_key?('domainItem')
-                            hDomain['domainItem'].each do |item|
-                                hDom = DomainItem.unpack(item, responseObj)
-                                unless hDom.nil?
-                                    intDomain[:domainItems] << hDom
-                                end
-                            end
-                        end
-                        if intDomain[:domainItems].empty?
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary domain has no domain items'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        return intDomain
-
-                    end
-
-                end
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end

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

@@ -2,134 +2,169 @@
 # Reader - mdJson 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 2015-02-17 add entity aliases
-#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#  Stan Smith 2017-11-01 added entityReference, fieldSeparator, headerLines, quoteCharacter
+#  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 2015-02-17 add entity aliases
+#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
 # 	Stan Smith 2013-12-01 original script
 
 require_relative 'module_entityIndex'
 require_relative 'module_entityAttribute'
 require_relative 'module_entityForeignKey'
+require_relative 'module_citation'
 
 module ADIWG
-    module Mdtranslator
-        module Readers
-            module MdJson
-
-                module Entity
-
-                    def self.unpack(hEntity, responseObj)
-
-                        # return nil object if input is empty
-                        if hEntity.empty?
-                            responseObj[:readerExecutionMessages] << 'Entity object is empty'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
-                        end
-
-                        # instance classes needed in script
-                        intMetadataClass = InternalMetadata.new
-                        intEntity = intMetadataClass.newEntity
-
-                        # entity - id
-                        if hEntity.has_key?('entityId')
-                            s = hEntity['entityId']
-                            unless s == ''
-                                intEntity[:entityId] = s
-                            end
+   module Mdtranslator
+      module Readers
+         module MdJson
+
+            module Entity
+
+               def self.unpack(hEntity, responseObj)
+
+                  # return nil object if input is empty
+                  if hEntity.empty?
+                     responseObj[:readerExecutionMessages] << 'Entity object is empty'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # instance classes needed in script
+                  intMetadataClass = InternalMetadata.new
+                  intEntity = intMetadataClass.newEntity
+
+                  # entity - id
+                  if hEntity.has_key?('entityId')
+                     s = hEntity['entityId']
+                     unless s == ''
+                        intEntity[:entityId] = s
+                     end
+                  end
+
+                  # entity - name
+                  if hEntity.has_key?('commonName')
+                     if hEntity['commonName'] != ''
+                        intEntity[:entityName] = hEntity['commonName']
+                     end
+                  end
+
+                  # entity - code (required)
+                  if hEntity.has_key?('codeName')
+                     intEntity[:entityCode] = hEntity['codeName']
+                  end
+                  if intEntity[:entityCode].nil? || intEntity[:entityCode] == ''
+                     responseObj[:readerExecutionMessages] << 'Data Dictionary entity code name is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # entity - alias []
+                  if hEntity.has_key?('alias')
+                     hEntity['alias'].each do |item|
+                        if item != ''
+                           intEntity[:entityAlias] << item
                         end
-
-                        # entity - name
-                        if hEntity.has_key?('commonName')
-                            if  hEntity['commonName'] != ''
-                                intEntity[:entityName] =  hEntity['commonName']
-                            end
-                        end
-
-                        # entity - code (required)
-                        if hEntity.has_key?('codeName')
-                            intEntity[:entityCode] = hEntity['codeName']
+                     end
+                  end
+
+                  # entity - definition (required)
+                  if hEntity.has_key?('definition')
+                     intEntity[:entityDefinition] = hEntity['definition']
+                  end
+                  if intEntity[:entityDefinition].nil? || intEntity[:entityDefinition] == ''
+                     responseObj[:readerExecutionMessages] << 'Data Dictionary entity definition is missing'
+                     responseObj[:readerExecutionPass] = false
+                     return nil
+                  end
+
+                  # entity - entity reference [] {citation}
+                  if hEntity.has_key?('entityReference')
+                     hEntity['entityReference'].each do |hCitation|
+                        unless hCitation.empty?
+                           hReturn = Citation.unpack(hCitation, responseObj)
+                           unless hReturn.nil?
+                              intEntity[:entityReferences] << hReturn
+                           end
                         end
-                        if intEntity[:entityCode].nil? || intEntity[:entityCode] == ''
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary entity code name is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                     end
+                  end
+
+                  # data entity - primary key (NOT required)
+                  if hEntity.has_key?('primaryKeyAttributeCodeName')
+                     hEntity['primaryKeyAttributeCodeName'].each do |item|
+                        if item != ''
+                           intEntity[:primaryKey] << item
                         end
-
-                        # entity - alias []
-                        if hEntity.has_key?('alias')
-                            hEntity['alias'].each do |item|
-                                if item != ''
-                                    intEntity[:entityAlias] << item
-                                end
-                            end
+                     end
+                  end
+
+                  # entity - indexes []
+                  if hEntity.has_key?('index')
+                     hEntity['index'].each do |hIndex|
+                        unless hIndex.empty?
+                           index = EntityIndex.unpack(hIndex, responseObj)
+                           unless index.nil?
+                              intEntity[:indexes] << index
+                           end
                         end
-
-                        # entity - definition (required)
-                        if hEntity.has_key?('definition')
-                            intEntity[:entityDefinition] = hEntity['definition']
+                     end
+                  end
+
+                  # entity - attributes []
+                  if hEntity.has_key?('attribute')
+                     hEntity['attribute'].each do |hAttribute|
+                        unless hAttribute.empty?
+                           attribute = EntityAttribute.unpack(hAttribute, responseObj)
+                           unless attribute.nil?
+                              intEntity[:attributes] << attribute
+                           end
                         end
-                        if intEntity[:entityDefinition].nil? || intEntity[:entityDefinition] == ''
-                            responseObj[:readerExecutionMessages] << 'Data Dictionary entity definition is missing'
-                            responseObj[:readerExecutionPass] = false
-                            return nil
+                     end
+                  end
+
+                  # entity - foreign keys []
+                  if hEntity.has_key?('foreignKey')
+                     hEntity['foreignKey'].each do |hFKey|
+                        unless hFKey.empty?
+                           fKey = EntityForeignKey.unpack(hFKey, responseObj)
+                           unless fKey.nil?
+                              intEntity[:foreignKeys] << fKey
+                           end
                         end
-
-                        # data entity - primary key (NOT required)
-                        if hEntity.has_key?('primaryKeyAttributeCodeName')
-                            hEntity['primaryKeyAttributeCodeName'].each do |item|
-                                if item != ''
-                                    intEntity[:primaryKey] << item
-                                end
-                            end
-                        end
-
-                        # entity - indexes []
-                        if hEntity.has_key?('index')
-                            hEntity['index'].each do |hIndex|
-                                unless hIndex.empty?
-                                    index = EntityIndex.unpack(hIndex, responseObj)
-                                    unless index.nil?
-                                        intEntity[:indexes] << index
-                                    end
-                                end
-                            end
-                        end
-
-                        # entity - attributes []
-                        if hEntity.has_key?('attribute')
-                            hEntity['attribute'].each do |hAttribute|
-                                unless hAttribute.empty?
-                                    attribute = EntityAttribute.unpack(hAttribute, responseObj)
-                                    unless attribute.nil?
-                                        intEntity[:attributes] << attribute
-                                    end
-                                end
-                            end
-                        end
-
-                        # entity - foreign keys []
-                        if hEntity.has_key?('foreignKey')
-                            hEntity['foreignKey'].each do |hFKey|
-                                unless hFKey.empty?
-                                    fKey = EntityForeignKey.unpack(hFKey, responseObj)
-                                    unless fKey.nil?
-                                        intEntity[:foreignKeys] << fKey
-                                    end
-                                end
-                            end
-                        end
-
-                        return intEntity
-
-                    end
-
-                end
+                     end
+                  end
+
+                  # entity - field separator
+                  if hEntity.has_key?('fieldSeparatorCharacter')
+                     if hEntity['fieldSeparatorCharacter'] != ''
+                        intEntity[:fieldSeparatorCharacter] = hEntity['fieldSeparatorCharacter']
+                     end
+                  end
+
+                  # entity - number of header lines
+                  if hEntity.has_key?('numberOfHeaderLines')
+                     if hEntity['numberOfHeaderLines'] != ''
+                        intEntity[:numberOfHeaderLines] = hEntity['numberOfHeaderLines'].to_i
+                     end
+                  end
+
+                  # entity - quote character
+                  if hEntity.has_key?('quoteCharacter')
+                     if hEntity['quoteCharacter'] != ''
+                        intEntity[:quoteCharacter] = hEntity['quoteCharacter']
+                     end
+                  end
+
+                  return intEntity
+
+               end
 
             end
-        end
-    end
+
+         end
+      end
+   end
 end