adiwg-mdtranslator 1.0.0rc1 → 1.0.0rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c323c30414ec1eba70403136085ae2eeba8f288f
-  data.tar.gz: 5b0f79036a8d2513e5b73a2c9eb29b651d8a4603
+  metadata.gz: aef130968578631bf49c4bdc764b4a207ddf6faa
+  data.tar.gz: 7b7a30dfe0bc5fa1c924d414be8520b5bd327974
 SHA512:
-  metadata.gz: 278f8307994c6faa5995139f61041721e91c1baca1fb2fceb3a92ef228597c9425e51c981a33abe22e6b512d4516c6cde9095fff1660f0115809a0f285c12a26
-  data.tar.gz: 7bcc1201a25fdbb735a00d71c68f412df564068ebcd0daacdc6ef7c537f3d763d588aaf62de1475ed439d614fee556ddb2e10885d4607f70e096c3add9b7873d
+  metadata.gz: 1014723327cf4bf6e2cfbbef689a7c9b4eb493dc0c478e86a3deaadb19018b1f9c057f61f4f2b8f32802e4dbc97593c7d754c41ebc25d12838df0b4d47a7bac4
+  data.tar.gz: 5a8ad6128813a53648d7f3ad263dd9f7b72fa251f39cf26133a1aaa736208df9bdab3ab9e203c5826c89b5d15b851c0af2445a1963116892854fa989eec7cc6d

data/lib/adiwg/mdtranslator.rb

@@ -17,6 +17,7 @@
 #   Stan Smith 2014-12-02 organized shared class/code/units folders for 19115-2, 19110
 #   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
 
 # add main directories to load_path
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'mdtranslator/internal'))
@@ -32,6 +33,24 @@ require 'adiwg/mdtranslator/writers/mdWriters'
 module ADIWG
     module Mdtranslator
 
+        def self.addFinalMessages
+            if $response[:readerStructurePass].nil?
+                $response[:readerStructureMessages].insert(0, 'Input file structure was not checked \n')
+            end
+
+            if $response[:readerValidationPass].nil?
+                $response[:readerValidationMessages].insert(0, 'Validator was not called \n')
+            end
+
+            if $response[:readerExecutionPass].nil?
+                $response[:readerExecutionMessages].insert(0, 'Reader was not called \n')
+            end
+
+            if $response[:writerPass].nil?
+                $response[:writerMessages].insert(0, 'Writer not called \n')
+            end
+        end
+
         def self.translate(file:, reader:, validate: 'normal', writer: nil, showAllTags: false)
 
             $showAllTags = showAllTags
@@ -60,10 +79,11 @@ module ADIWG
 
             # handle readers
             if reader.nil? || reader == ''
-                $response[:readerValidationPass] = false
+                $response[:readerStructureMessages] << 'Reader name is missing.'
                 $response[:readerValidationMessages] << 'Reader name is missing.'
-                $response[:readerExecutionPass] = false
-                $response[:readerExecutionMessages] << 'Reader failed to complete.'
+                $response[:readerExecutionMessages] << 'Reader name is missing.'
+                $response[:writerMessages] << 'Input file was not read.'
+                addFinalMessages()
                 return $response
             else
                 require File.join(File.dirname(__FILE__), 'mdtranslator/readers/mdReaders')
@@ -72,20 +92,19 @@ module ADIWG
                 if intObj
                     $response[:readerExecutionPass] = true
                 else
-                    $response[:readerExecutionPass] = false
-                    $response[:readerExecutionMessages] << 'Reader failed to complete.'
+                    addFinalMessages()
                     return $response
                 end
             end
 
             # handle writers
             if writer.nil? || writer == ''
-                $response[:writerPass] = false
-                $response[:writerMessages] << 'Writer name is missing.'
+                $response[:writerMessages] << 'Writer name was not provided.'
             else
                 require File.join(File.dirname(__FILE__), 'mdtranslator/writers/mdWriters')
                 ADIWG::Mdtranslator::Writers.handleWriter(intObj)
             end
+            addFinalMessages()
             return $response
 
         end

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

@@ -20,9 +20,6 @@ module ADIWG
         module Readers
             module MdJson
 
-                # set reader namespace
-                $ReaderNS = ADIWG::Mdtranslator::Readers::MdJson
-
                 def self.readFile(file)
                     # set anticipated format of file in $response
                     $response[:readerFormat] = 'json'
@@ -52,7 +49,7 @@ module ADIWG
                         return false
                     end
 
-                    # unpack mdJson file
+                    # load mdJson file into internal object
                     require readerModule('module_mdJson')
                     intObj = $ReaderNS.unpack(@hMdJson)
                     return intObj
@@ -67,8 +64,8 @@ module ADIWG
                         $response[:readerStructurePass] = true
                     rescue JSON::JSONError => err
                         $response[:readerStructurePass] = false
-                        $response[:readerStructureMessages] << err
-                        return
+                        $response[:readerStructureMessages] << 'JSON Parsing Failed - see following message(s):\n'
+                        $response[:readerStructureMessages] << err.to_s.slice(0,300)
                     end
                 end
 
@@ -78,6 +75,7 @@ module ADIWG
                         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.'
                         return
                     end
@@ -89,21 +87,23 @@ module ADIWG
                             $response[:readerFound] = s
                         else
                             $response[:readerStructurePass] = false
-                            $response[:readerStructureMessages] << 'The input file version name is missing.'
+                            $response[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                            $response[:readerStructureMessages] << 'The input file version: => name: is missing.'
                             return
                         end
                     else
                         $response[:readerStructurePass] = false
-                        $response[:readerStructureMessages] << "The input file version:{} block is missing the 'name' attribute."
+                        $response[:readerStructureMessages] << 'Invalid input file schema declaration - see following message(s):\n'
+                        $response[: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] << "The mdTranslator reader expected the input file version name to be 'mdJson'."
+                        $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}'."
-                        return
                     end
                 end
 
@@ -117,7 +117,8 @@ module ADIWG
                         end
                     else
                         $response[:readerStructurePass] = false
-                        $response[:readerStructureMessages] << "The input file version:{} block is missing the 'version' number attribute."
+                        $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."
                         return
                     end
 
@@ -131,6 +132,7 @@ module ADIWG
                         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
@@ -138,9 +140,9 @@ module ADIWG
                         $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.'
-                        return
                     end
                 end
 

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

@@ -36,11 +36,13 @@ module ADIWG
 
                         if aValErrs.length > 0
                             $response[:readerValidationPass] = false
+                            $response[:readerValidationMessages] << 'mdJson schema validation Failed - see following message(s):\n'
                             $response[:readerValidationMessages] = aValErrs
                             return
                         end
                     rescue JSON::Schema::ValidationError
                         $response[:readerValidationPass] = false
+                        $response[:readerValidationMessages] << 'mdJson schema validation Failed - see following message(s):\n'
                         $response[:readerValidationMessages] << $!.message
                         return
                     end

data/lib/adiwg/mdtranslator/readers/mdReaders.rb

@@ -3,6 +3,7 @@
 # History:
 # 	Stan Smith 2014-12-11 original script
 #   Stan Smith 2012-12-16 generalized handleReader to use :readerRequested
+#   Stan Smith 2015-03-04 changed method of setting $WriterNS
 
 module ADIWG
     module Mdtranslator
@@ -18,16 +19,20 @@ module ADIWG
                     # if directory path exists, build reader file name and require it
                     readerFile = File.join(readerDir, $response[:readerRequested] + '_reader')
                     require readerFile
+                    readerClassName = $response[:readerRequested].clone
+                    readerClassName[0] = readerClassName[0].upcase
+                    $ReaderNS = ADIWG::Mdtranslator::Readers.const_get(readerClassName)
+
 
                     # pass file to requested reader and return internal object
                     # $ReaderNS is the reader namespace constant set in
                     # ... readerRequested_reader.rb and initialized when the file is required
-                    intObj = $ReaderNS.readFile(file)
-                    return intObj
+                    return $ReaderNS.readFile(file)
                 else
                     # directory path was not found
                     $response[:readerValidationPass] = false
-                    $response[:readerValidationMessages] << "Reader name '#{$response[:readerRequested]}' is not supported."
+                    $response[:readerValidationMessages] << "Validation Failed - see following message(s):\n"
+                    $response[:readerValidationMessages] << "Reader '#{$response[:readerRequested]}' is not supported."
                     return false
                 end
 

data/lib/adiwg/mdtranslator/version.rb

@@ -41,7 +41,7 @@
 module ADIWG
     module Mdtranslator
         # current mdtranslator version
-        VERSION = "1.0.0rc1"
+        VERSION = "1.0.0rc2"
     end
 end
 

data/lib/adiwg/mdtranslator/writers/html/html_writer.rb

@@ -13,9 +13,6 @@ module ADIWG
         module Writers
             module Html
 
-                # set writer namespace
-                $WriterNS = ADIWG::Mdtranslator::Writers::Html
-
                 def self.startWriter(intObj)
 
                     # set the format of the output file based on the writer specified

data/lib/adiwg/mdtranslator/writers/iso19110/iso19110_writer.rb

@@ -3,6 +3,7 @@
 # History:
 # 	Stan Smith 2014-12-01 original script
 #   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
+#   Stan Smith 2015-03-02 added test and return for missing data dictionary
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../iso/units'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../iso/codelists'))
@@ -18,9 +19,6 @@ module ADIWG
         module Writers
             module Iso19110
 
-                # set writer namespace
-                $WriterNS = ADIWG::Mdtranslator::Writers::Iso19110
-
                 def self.startWriter(intObj)
 
                     # reset ISO id='' counter
@@ -30,14 +28,24 @@ module ADIWG
                     $response[:writerFormat] = 'xml'
                     $response[:writerVersion] = ADIWG::Mdtranslator::VERSION
 
+                    # test for a valid dataDictionary object in the internal object
+                    aDictionaries = intObj[:dataDictionary]
+                    if aDictionaries.length == 0
+                        $response[:writerMessages] << 'Writer Failed - see following message(s):\n'
+                        $response[:writerMessages] << 'No data dictionary was loaded from the input file'
+                        $response[:writerPass] = false
+                        return
+                    end
+
                     # create new XML document
                     xml = Builder::XmlMarkup.new(indent: 3)
                     metadataWriter = $WriterNS::FC_FeatureCatalogue.new(xml)
                     metadata = metadataWriter.writeXML(intObj)
 
-                    # set writer pass to true if no messages
+                    # set writer pass to true if no writer modules set it to false
                     # false or warning will be set by code that places the message
-                    if $response[:writerMessages].length == 0
+                    # load metadata into $response
+                    if $response[:writerPass].nil?
                         $response[:writerPass] = true
                     end
 

data/lib/adiwg/mdtranslator/writers/iso19115_2/iso19115_2_writer.rb

@@ -20,9 +20,6 @@ module ADIWG
         module Writers
             module Iso19115_2
 
-                # set writer namespace
-                $WriterNS = ADIWG::Mdtranslator::Writers::Iso19115_2
-
                 def self.startWriter(internalObj)
 
                     # reset ISO id='' counter
@@ -42,9 +39,10 @@ module ADIWG
                     metadataWriter = $WriterNS::MI_Metadata.new(xml)
                     metadata = metadataWriter.writeXML(internalObj)
 
-                    # set writer pass to true if no messages
+                    # set writer pass to true if no writer modules set it to false
                     # false or warning will be set by code that places the message
-                    if $response[:writerMessages].length == 0
+                    # load metadata into $response
+                    if $response[:writerPass].nil?
                         $response[:writerPass] = true
                     end
 

data/lib/adiwg/mdtranslator/writers/mdWriters.rb

@@ -3,6 +3,7 @@
 # History:
 # 	Stan Smith 2014-12-11 original script
 #   Stan Smith 2012-12-16 generalized handleWriter to use :writerName
+#   Stan Smith 2015-03-04 changed method of setting $WriterNS
 
 module ADIWG
     module Mdtranslator
@@ -10,21 +11,34 @@ module ADIWG
 
             def self.handleWriter(intObj)
 
+                # this is a temp fix until the directory structure is changed
+                if $response[:writerName] == 'iso'
+                    $response[:writerPass] = false
+                    $response[:writerMessages] << 'Writer not called - see following message(s):\n'
+                    $response[:writerMessages] << "Writer name 'iso' is not supported."
+                    return false
+                end
+
                 # use writer name to load and initiate requested writer
                 # build directory path for writer from writerName
                 writerDir = File.join(path_to_resources, $response[:writerName])
                 if File.directory?(writerDir)
+
                     # if directory path exists, build writer file name and then require it
                     writerFile = File.join(writerDir, $response[:writerName] + '_writer')
                     require writerFile
+                    writerClassName = $response[:writerName].clone
+                    writerClassName[0] = writerClassName[0].upcase
+                    $WriterNS = ADIWG::Mdtranslator::Writers.const_get(writerClassName)
 
                     # pass internal object to requested writer
                     $response[:writerOutput] = $WriterNS.startWriter(intObj)
-                    return $response
+
                 else
                     # directory path was not found
-                    $response[:writerValidationPass] = false
-                    $response[:readerValidationMessages] << "Writer name '#{$response[:writerName]}' is not supported."
+                    $response[:writerPass] = false
+                    $response[:writerMessages] << 'Writer not called - see following message(s):\n'
+                    $response[:writerMessages] << "Writer name '#{$response[:writerName]}' is not supported."
                     return false
                 end
 

data/test/readers/mdJson/v1_0/tc_reader_mdjson_additionalDocumentation.rb

@@ -14,6 +14,7 @@ require 'minitest/autorun'
 require 'json'
 require 'adiwg/mdtranslator/internal/internal_metadata_obj'
 require 'adiwg/mdtranslator/readers/mdJson/mdJson_reader'
+$ReaderNS = ADIWG::Mdtranslator::Readers::MdJson
 require 'adiwg/mdtranslator/readers/mdJson/modules_1.0/module_additionalDocumentation'
 
 class TestReaderMdJsonAdditionalDocumentation_v1_0 < MiniTest::Test

data/test/readers/mdJson/v1_0/tc_reader_mdjson_associatedResource.rb

@@ -14,6 +14,7 @@ require 'minitest/autorun'
 require 'json'
 require 'adiwg/mdtranslator/internal/internal_metadata_obj'
 require 'adiwg/mdtranslator/readers/mdJson/mdJson_reader'
+$ReaderNS = ADIWG::Mdtranslator::Readers::MdJson
 require 'adiwg/mdtranslator/readers/mdJson/modules_1.0/module_associatedResource'
 
 class TestReaderMdJsonAssociatedResource_v1_0 < MiniTest::Test

data/test/readers/mdJson/v1_0/tc_reader_mdjson_citation.rb

@@ -17,6 +17,7 @@ require 'json'
 require 'adiwg/mdtranslator/internal/internal_metadata_obj'
 require 'adiwg/mdtranslator/internal/module_dateTimeFun'
 require 'adiwg/mdtranslator/readers/mdJson/mdJson_reader'
+$ReaderNS = ADIWG::Mdtranslator::Readers::MdJson
 require 'adiwg/mdtranslator/readers/mdJson/modules_1.0/module_citation'
 
 class TestReaderMdJsonCitation_v1_0 < MiniTest::Test

data/test/readers/mdJson/v1_0/tc_reader_mdjson_contact.rb

@@ -16,6 +16,7 @@ require 'minitest/autorun'
 require 'json'
 require 'adiwg/mdtranslator/internal/internal_metadata_obj'
 require 'adiwg/mdtranslator/readers/mdJson/mdJson_reader'
+$ReaderNS = ADIWG::Mdtranslator::Readers::MdJson
 require 'adiwg/mdtranslator/readers/mdJson/modules_1.0/module_contacts'
 
 class TestReaderMdJsonContact_v1_0 < MiniTest::Test

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adiwg-mdtranslator
 version: !ruby/object:Gem::Version
-  version: 1.0.0rc1
+  version: 1.0.0rc2
 platform: ruby
 authors:
 - Stan Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-28 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler