adiwg-mdtranslator 1.2.1 → 1.3.0

data/lib/adiwg/mdtranslator.rb

@@ -1,6 +1,4 @@
 # MdTranslator - ADIwg MdTranslator RubyGem entry point
-# ... pass input file to appropriate reader and writer;
-# ... assign module path names for require statements
 
 # History:
 # 	Stan Smith 2014-07-02 original script
@@ -18,28 +16,30 @@
 #   Stan Smith 2014-12-11 refactored to handle namespacing readers and writers
 #   Stan Smith 2015-01-15 changed translate() to keyword parameter list
 #   Stan Smith 2015-03-04 moved addFinalMessages into this module from rails app
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   ... created as an instance of class ResponseHash
+#   Stan Smith 2015-07-14 deleted readerFound
+#   Stan Smith 2015-07-14 renamed readerVersionFound to readerVersionRequested
+#   Stan Smith 2015-07-16 moved module_coordinates from mdJson reader to internal
+#   Stan Smith 2015-07-17 added support for user supplied CSS for html writer
 
-# add main directories to load_path
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'mdtranslator/internal'))
-
+# required by readers and writers
 require 'adiwg/mdtranslator/version'
-
-# additional require statements to support rails
-# ... these modules contain methods called by rails endpoints
-# ... by default rails does not resolve namespaces beyond this point
 require 'adiwg/mdtranslator/readers/mdReaders'
 require 'adiwg/mdtranslator/writers/mdWriters'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require 'adiwg/mdtranslator/internal/module_dateTimeFun'
+require 'adiwg/mdtranslator/internal/module_geoFormat'
+require 'adiwg/mdtranslator/internal/module_coordinates'
 
 module ADIWG
     module Mdtranslator
 
-        def self.translate(file:, reader:, validate: 'normal', writer: nil, showAllTags: false)
-
-            $showAllTags = showAllTags
+        def self.translate(file:, reader:, validate: 'normal', writer: nil, showAllTags: false, css: nil, cssLink: nil)
 
             # the reader and writer specified in the translate parameter string should load and
             #     return this hash ...
-            # ---------------------------
+            # ------------------------------------------------------------------------------------
             # readerFormat: the anticipated format of the input file, parsing by the reader will
             #     proceed assuming this format, set by reader
             # readerStructurePass: 'true' if input file structure is determined to be valid.
@@ -49,9 +49,7 @@ module ADIWG
             #    problems.  Set by reader.
             # readerRequested: name of the reader requested by the user, set from  the translate
             #    parameter list
-            # readerFound: name of the reader used by the reader, set by reader.  Will be same as
-            #    readerRequested if readerRequested name is valid
-            # readerVersionFound: version of the reader requested by the input file, set by reader
+            # readerVersionRequested: version of the reader requested by the input file, set by reader
             # readerVersionUsed: version of the reader the reader method decided to use in processing
             #    the input file.  Set by the reader.  Default 'normal'.
             # readerValidationLevel: validation level requested to be applied to the input file, set
@@ -76,54 +74,81 @@ module ADIWG
             # writerMessages: an array of quoted string messages.  If writerPass is 'false', set one
             #    or more messages to assist user in fixing file data problems.  Set by writer.
             # writerOutput: output file returned from the writer, set by writer
+            # writerShowTags: include tags in XML output for empty elements
+            # writerMissingIdCount: counter for creating unique elements IDs for ISO elements that did not
+            #    provide IDs in the input metadata file
+            # translatorVersion: current version of the mdTranslator
 
-            $response = {
+            responseObj =  {
                 readerFormat: nil,
                 readerStructurePass: nil,
                 readerStructureMessages: [],
-                readerRequested: reader,
-                readerFound: nil,
-                readerVersionFound: nil,
+                readerRequested: nil,
+                readerVersionRequested: nil,
                 readerVersionUsed: nil,
-                readerValidationLevel: validate,
+                readerValidationLevel: nil,
                 readerValidationPass: nil,
                 readerValidationMessages: [],
                 readerExecutionPass: nil,
                 readerExecutionMessages: [],
-                writerName: writer,
+                writerName: nil,
                 writerVersion: nil,
                 writerFormat: nil,
                 writerPass: nil,
                 writerMessages: [],
-                writerOutput: nil
+                writerOutput: nil,
+                writerShowTags: false,
+                writerMissingIdCount: '_000',
+                translatorVersion: nil
             }
 
+            paramsObj = {
+                cssLink: cssLink,
+                css: css
+            }
+
+            # add the passed in parameters to the response hash
+            responseObj[:readerRequested] = reader
+            responseObj[:readerValidationLevel] = validate
+            responseObj[:writerName] = writer
+            responseObj[:writerShowTags] = showAllTags
+
+            # add mdTranslator version to response hash
+            responseObj[:translatorVersion] = ADIWG::Mdtranslator::VERSION
+
             # handle readers
             if reader.nil? || reader == ''
-                $response[:readerExecutionPass] = false
-                $response[:readerExecutionMessages] << 'Reader name was not provided'
-                return $response
+                responseObj[:readerExecutionPass] = false
+                responseObj[:readerExecutionMessages] << 'Reader name was not provided'
+                return responseObj
+
             else
-                require File.join(File.dirname(__FILE__), 'mdtranslator/readers/mdReaders')
-                intObj = ADIWG::Mdtranslator::Readers.handleReader(file)
-
-                # if readerExecutionPass is nil no error messages were set during exection
-                # and the execution is assumed to have been successful
-                if $response[:readerExecutionPass].nil?
-                    $response[:readerExecutionPass] = true
-                elsif !$response[:readerExecutionPass]
-                    return $response
+                intObj = ADIWG::Mdtranslator::Readers.handleReader(file, responseObj)
+
+                # if readerValidation failed - exit
+                if !responseObj[:readerValidationPass]
+                    return responseObj
+                end
+
+                # if readerExecutionPass is nil no error messages were set while
+                # reading the input file into the internal object.
+                # the read operation is assumed to have been successful and pass is set to true.
+                if responseObj[:readerExecutionPass].nil?
+                    responseObj[:readerExecutionPass] = true
+                elsif !responseObj[:readerExecutionPass]
+                    return responseObj
                 end
             end
 
             # handle writers
             if writer.nil? || writer == ''
-                $response[:writerMessages] << 'Writer name was not provided.'
+                responseObj[:writerMessages] << 'Writer name was not provided.'
             else
                 require File.join(File.dirname(__FILE__), 'mdtranslator/writers/mdWriters')
-                ADIWG::Mdtranslator::Writers.handleWriter(intObj)
+                ADIWG::Mdtranslator::Writers.handleWriter(intObj, responseObj, paramsObj)
             end
-            return $response
+
+            return responseObj
 
         end
 

data/lib/adiwg/mdtranslator/internal/internal_metadata_obj.rb

@@ -48,6 +48,11 @@
 #   Stan Smith 2014-12-01 added data dictionary
 #   Stan Smith 2015-02-17 add entity and attribute alias
 #   Stan Smith 2015-02-17 added support for multiple data dictionaries
+#   Stan Smith 2015-07-23 added gridInfo, gridDimension for 1.3.0
+#   Stan Smith 2015-07-28 added locale for 1.3.0
+#   Stan Smith 2015-08-19 added coverageInfo, imageInfo, sensorInfo, coverageItem,
+#                     ... classifiedData, and classedDataItem for 1.3.0
+#   Stan Smith 2015-09-18 extended distributionInfo sections for 1.3.0
 
 class InternalMetadata
 
@@ -128,6 +133,7 @@ class InternalMetadata
             metadataCreateDate: {},
             metadataUpdateDate: {},
             metadataCharacterSet: nil,
+            metadataLocales: [],
             metadataURI: nil,
             metadataStatus: nil,
             maintInfo: {},
@@ -170,6 +176,7 @@ class InternalMetadata
             resourceFormats: [],
             resourceLanguages: [],
             resourceCharacterSets: [],
+            resourceLocales: [],
             descriptiveKeywords: [],
             resourceUses: [],
             useConstraints: [],
@@ -182,6 +189,8 @@ class InternalMetadata
             topicCategories: [],
             environmentDescription: nil,
             extents: [],
+            gridInfo: [],
+            coverageInfo: [],
             dataQualityInfo: [],
             supplementalInfo: nil
         }
@@ -190,6 +199,7 @@ class InternalMetadata
     def newCitation
         intObj = {
             citTitle: nil,
+            citAltTitle: nil,
             citDate: [],
             citEdition: nil,
             citResourceIds: [],
@@ -200,9 +210,13 @@ class InternalMetadata
     end
 
     def newResourceId
+        # handles both MD_Identifier and RS_Identifier
         intObj = {
             identifier: nil,
             identifierType: nil,
+            identifierNamespace: nil,
+            identifierVersion: nil,
+            identifierDescription: nil,
             identifierCitation: {}
         }
     end
@@ -210,7 +224,8 @@ class InternalMetadata
     def newResourceFormat
         intObj = {
             formatName: nil,
-            formatVersion: nil
+            formatVersion: nil,
+            compressionMethod: nil
         }
     end
 
@@ -250,9 +265,9 @@ class InternalMetadata
     def newDistributor
         intObj = {
             distContact: {},
-            distOrderProc: [],
-            distFormat: [],
-            distTransOption: []
+            distOrderProcs: [],
+            distFormats: [],
+            distTransOptions: []
         }
     end
 
@@ -267,6 +282,9 @@ class InternalMetadata
 
     def newDigitalTransOption
         intObj = {
+            distFormats: [],
+            transferSize: nil,
+            transferSizeUnits: nil,
             online: [],
             offline: {}
         }
@@ -274,7 +292,9 @@ class InternalMetadata
 
     def newMedium
         intObj = {
-            mediumName: nil,
+            mediumType: nil,
+            mediumCapacity: nil,
+            mediumCapacityUnits: nil,
             mediumFormat: nil,
             mediumNote: nil
         }
@@ -577,4 +597,102 @@ class InternalMetadata
         }
     end
 
+    def newGridInfo
+        intObj = {
+            dimensions: nil,
+            dimensionInfo: [],
+            dimensionGeometry: nil,
+            dimensionTransformParams: false
+        }
+    end
+
+    def newDimensionInfo
+        intObj = {
+            dimensionType: nil,
+            dimensionTitle: nil,
+            dimensionDescription: nil,
+            dimensionSize: nil,
+            resolution: nil,
+            resolutionUnits: nil
+        }
+    end
+
+    def newCoverageInfo
+        intObj = {
+            coverageType: nil,
+            coverageName: nil,
+            coverageDescription: nil,
+            processingLevel: {},
+            coverageItems: [],
+            imageInfo: {}
+        }
+    end
+
+    def newCoverageItem
+        intObj = {
+            itemName: nil,
+            itemType: nil,
+            itemDescription: nil,
+            minValue: nil,
+            maxValue: nil,
+            units: nil,
+            scaleFactor: nil,
+            offset: nil,
+            meanValue: nil,
+            standardDeviation: nil,
+            bitsPerValue: nil,
+            classedData: {},
+            sensorInfo: {}
+        }
+    end
+
+    def newClassedData
+        intObj = {
+            numberOfClasses: nil,
+            classedDataItems: []
+        }
+    end
+
+    def newClassedDataItem
+        intObj = {
+            className: nil,
+            classDescription: nil,
+            classValue: nil
+        }
+    end
+
+    def newImageInfo
+        intObj = {
+            illuminationElevationAngle: nil,
+            illuminationAzimuthAngle: nil,
+            imageCondition: nil,
+            imageQuality: {},
+            cloudCoverPercent: nil,
+            compressionQuantity: nil,
+            triangulationInfo: false,
+            radiometricCalibrationInfo: false,
+            cameraCalibrationInfo: false,
+            filmDistortionInfo: false,
+            lensDistortionInfo: false
+        }
+    end
+
+    def newSensorInfo
+        intObj = {
+            toneGradations: nil,
+            sensorMin: nil,
+            sensorMax: nil,
+            sensorUnits: nil,
+            sensorPeakResponse: nil
+        }
+    end
+
+    def newLocale
+        intObj = {
+            languageCode: nil,
+            countryCode: nil,
+            characterEncoding: nil
+        }
+    end
+
 end

data/lib/adiwg/mdtranslator/internal/module_coordinates.rb

@@ -0,0 +1,55 @@
+# repack coordinates
+
+# History:
+# 	Stan Smith 2013-11-07 original script
+# 	Stan Smith 2013-11-13 added getDimension
+#   Stan Smith 2014-05-23 added getLevels
+#   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-16 moved module_coordinates from mdJson reader to internal
+
+module AdiwgCoordinates
+
+    # repack coordinate array into single string for ISO
+    def self.unpack(aCoords, responseObj)
+        s = ''
+        i = 0
+        coordCount = aCoords.length
+        aCoords.each do |coord|
+            if coord.kind_of?(Array)
+                s = s + unpack(coord, responseObj)
+            else
+                i += 1
+                s = s + coord.to_s
+                if i < coordCount
+                    s = s + ','
+                end
+                s = s + ' '
+            end
+        end
+
+        return s
+    end
+
+    # get the number of dimensions in a coordinate array
+    def self.getDimension(aCoords)
+        if aCoords[0].kind_of?(Array)
+            coordDim = getDimension(aCoords[0])
+        else
+            coordDim = aCoords.length
+        end
+
+        return coordDim
+    end
+
+    # get the number of levels in the coordinate array
+    def self.getLevels(aCoords)
+        i = 1
+        if aCoords[0].kind_of?(Array)
+            i = i + getLevels(aCoords[0])
+        end
+        return i
+    end
+
+end

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

@@ -13,40 +13,47 @@
 #   Stan Smith 2014-12-03 changed class name to MdJsonReader from AdiwgJsonReader
 #   Stan Smith 2014-12-11 refactored to handle namespacing readers and writers
 #   Stan Smith 2015-06-12 added method to lookup contact in contact array
+#   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-14 added support for mdJson version numbers
 
 require 'json'
+require_relative 'mdJson_validator'
 
 module ADIWG
     module Mdtranslator
         module Readers
             module MdJson
 
-                def self.readFile(file)
-                    # set anticipated format of file in $response
-                    $response[:readerFormat] = 'json'
+                def self.readFile(file, responseObj)
+
+                    # set reference to responseObj for use throughout this module
+                    @responseObj = responseObj
 
                     # receive json file into ruby hash
                     parseJson(file)
-                    if !$response[:readerStructurePass]
+                    if !@responseObj[:readerStructurePass]
                         return false
                     end
 
+                    # set format of file in $response
+                    @responseObj[:readerFormat] = 'json'
+
                     # check mdJson version name
                     checkVersionName
-                    if !$response[:readerStructurePass]
+                    if !@responseObj[:readerStructurePass]
                         return false
                     end
 
                     # check mdJson version number
                     checkVersionNumber
-                    if !$response[:readerStructurePass]
+                    if !@responseObj[:readerStructurePass]
                         return false
                     end
 
                     # validate file against mdJson schema definition
-                    require 'adiwg/mdtranslator/readers/mdJson/mdJson_validator'
-                    $ReaderNS.validate(file)
-                    if !$response[:readerValidationPass]
+                    validate(file, @responseObj)
+                    if !@responseObj[:readerValidationPass]
                         return false
                     end
 
@@ -57,7 +64,9 @@ module ADIWG
 
                     # create new internal metadata container for the reader
                     @intObj = intMetadataClass.newBase
-                    $ReaderNS.unpack(@intObj, @hMdJson)
+
+                    #
+                    ADIWG::Mdtranslator::Readers::MdJson.unpack(@intObj, @hMdJson, @responseObj)
                     return @intObj
 
                 end
@@ -67,11 +76,11 @@ module ADIWG
                     # test for valid json syntax by attempting to parse the file
                     begin
                         @hMdJson = JSON.parse(file)
-                        $response[:readerStructurePass] = true
+                        @responseObj[:readerStructurePass] = true
                     rescue JSON::JSONError => err
-                        $response[:readerStructurePass] = false
-                        $response[:readerStructureMessages] << 'JSON Parsing Failed - see following message(s):\n'
-                        $response[:readerStructureMessages] << err.to_s.slice(0,300)
+                        @responseObj[:readerStructurePass] = false
+                        @responseObj[:readerStructureMessages] << 'JSON Parsing Failed - see following message(s):\n'
+                        @responseObj[:readerStructureMessages] << err.to_s.slice(0,300)
                     end
                 end
 
@@ -80,36 +89,34 @@ module ADIWG
                     if @hMdJson.has_key?('version')
                         hVersion = @hMdJson['version']
                     else
-                        $response[:readerStructurePass] = false
-                        $response[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                        $response[:readerStructureMessages] << 'The input file is missing the version:{} block.'
+                        @responseObj[:readerStructurePass] = false
+                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @responseObj[:readerStructureMessages] << 'The input file is missing the version:{} block.'
                         return
                     end
 
                     # check the version name
                     if hVersion.has_key?('name')
                         s = hVersion['name']
-                        if !s.nil?
-                            $response[:readerFound] = s
-                        else
-                            $response[:readerStructurePass] = false
-                            $response[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                            $response[:readerStructureMessages] << 'The input file version: => name: is missing.'
+                        if s.nil?
+                            @responseObj[:readerStructurePass] = false
+                            @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                            @responseObj[:readerStructureMessages] << 'The input file version: => name: is missing.'
                             return
                         end
                     else
-                        $response[:readerStructurePass] = false
-                        $response[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                        $response[:readerStructureMessages] << "The input file version:{} block is missing the 'name:' attribute."
+                        @responseObj[:readerStructurePass] = false
+                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @responseObj[:readerStructureMessages] << "The input file version:{} block is missing the 'name:' attribute."
                         return
                     end
 
                     # check the version name is 'mdJson'
                     if s != 'mdJson'
-                        $response[:readerStructurePass] = false
-                        $response[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                        $response[:readerStructureMessages] << "The mdTranslator reader expected the input file version: name: to be 'mdJson'."
-                        $response[:readerStructureMessages] << "Version name found was: '#{s}'."
+                        @responseObj[:readerStructurePass] = false
+                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @responseObj[:readerStructureMessages] << "The mdTranslator reader expected the input file version: name: to be 'mdJson'."
+                        @responseObj[:readerStructureMessages] << "Version name found was: '#{s}'."
                     end
                 end
 
@@ -119,55 +126,55 @@ module ADIWG
                     if hVersion.has_key?('version')
                         s = hVersion['version']
                         if !s.nil?
-                            $response[:readerVersionFound] = s
+                            @responseObj[:readerVersionRequested] = s
                         end
                     else
-                        $response[:readerStructurePass] = false
-                        $response[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                        $response[:readerStructureMessages] << "The input file version:{} block is missing the 'version:' number attribute."
+                        @responseObj[:readerStructurePass] = false
+                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @responseObj[:readerStructureMessages] << "The input file version:{} block is missing the 'version:' number attribute."
                         return
                     end
 
-                    # test the reader version requested is supported
-                    # remove maintenance release number first
-                    # ... then look for a module folder name ending with the requested version
-                    # ... example: 'modules_1.2'
-                    aVersionParts = s.split('.')
-                    if aVersionParts.length >= 2
-                        readerVersion = aVersionParts[0] +'.' + aVersionParts[1]
-                        dir = File.join(File.dirname(__FILE__), 'modules_' + readerVersion)
-                        if !File.directory?(dir)
-                            $response[:readerStructurePass] = false
-                            $response[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                            $response[:readerStructureMessages] << 'The input file version is not supported.'
-                            $response[:readerStructureMessages] << "mdJson version requested was '#{s}'"
-                            return
-                        end
-                        $response[:readerVersionUsed] = readerVersion
-                    else
-                        $response[:readerStructurePass] = false
-                        $response[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
-                        $response[:readerStructureMessages] << 'The input file version number must be in the form MAJOR.MINOR.PATCH, e.g. 1.2.3'
-                        $response[:readerStructureMessages] << 'Note the PATCH number is optional.'
-                    end
-                end
+                    # split the version number into its parts
+                    aReqVersion = s.split('.')
 
-                # require modules for the requested version
-                def self.readerModule(moduleName)
-                    dir = File.join(File.dirname(__FILE__), 'modules_' + $response[:readerVersionUsed])
-                    file = File.join(dir, moduleName)
+                    reqMajor = 0
+                    if !aReqVersion[0].nil?
+                        reqMajor = aReqVersion[0]
+                    end
 
-                    # test for the existance of the module in the current mdJson version directory
-                    if !File.exist?(File.join(dir, moduleName + '.rb'))
-                        # file not found
-                        # ... look for module in previous version directory
-                        # ... note: no previous version directories exist yet
+                    # test if the requested reader major version is supported
+                    # look for a folder with modules for the major version number
+                    dirName = File.join(File.dirname(__FILE__), 'modules_v' + reqMajor)
+                    if !File.directory?(dirName)
+                        @responseObj[:readerStructurePass] = false
+                        @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        @responseObj[:readerStructureMessages] << 'A reader for the requested version is not supported.'
+                        @responseObj[:readerStructureMessages] << "mdJson version requested was '#{s}'"
+                        return false
+                    end
 
-                        # no prior version directory found
-                        # ... file not found
-                        return nil
+                    # the requested major version is supported
+                    # get the full version number for this major version of mdJson
+                    require File.join(dirName, 'version')
+                    curVersion = ADIWG::Mdtranslator::Readers::MdJson::VERSION
+                    @responseObj[:readerVersionUsed] = curVersion
+                    aCurVersion = curVersion.split('.')
+                    curMinor = aCurVersion[1]
+
+                    # test that minor version number is not exceeded
+                    reqMinor = 0
+                    if !aReqVersion[1].nil?
+                        reqMinor = aReqVersion[1]
+                        if curMinor < reqMinor
+                            @responseObj[:readerStructurePass] = false
+                            @responseObj[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                            @responseObj[:readerStructureMessages] << 'The requested reader minor version is not supported.'
+                            @responseObj[:readerStructureMessages] << "mdJson version requested was '#{s}'"
+                            return false
+                        end
                     end
-                    return file
+
                 end
 
                 # find the array pointer for a contact
@@ -180,9 +187,30 @@ module ADIWG
                         end
                         i += 1
                     end
+
                     return pointer
                 end
 
+                # require modules for the requested version
+                def self.readerModule(moduleName)
+                    majVersion = @responseObj[:readerVersionUsed].split('.')[0]
+                    dirName = File.join(File.dirname(__FILE__), 'modules_v' + majVersion.to_s)
+                    fileName = File.join(dirName, moduleName)
+
+                    # test for the existance of the module in the current mdJson version directory
+                    if !File.exist?(File.join(dirName, moduleName + '.rb'))
+                        # file not found
+                        # ... look for module in previous version directory
+                        # ... note: no previous version directories exist yet
+
+                        # no prior version directory found
+                        # ... file not found
+                        return nil
+                    end
+
+                    return fileName
+                end
+
             end
         end
     end