adiwg-mdtranslator 1.2.1 → 1.3.0

data/lib/adiwg/mdtranslator/writers/{iso → iso19115_2}/classes/class_usage.rb

@@ -2,27 +2,31 @@
 # writer output in XML
 
 # History:
-# 	Stan Smith 2013-11-19 original script
+# 	Stan Smith 2013-11-19 original script.
 #   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
 #   Stan Smith 2014-12-12 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 make iso19110 independent of iso19115_2 classes
+#   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
 
-require 'class_responsibleParty'
+require_relative 'class_responsibleParty'
 
 module ADIWG
     module Mdtranslator
         module Writers
-            module Iso
+            module Iso19115_2
 
                 class MD_Usage
 
-                    def initialize(xml)
+                    def initialize(xml, responseObj)
                         @xml = xml
+                        @responseObj = responseObj
                     end
 
                     def writeXML(hUsage)
 
                         # classes used in MD_Usage
-                        rPartyClass = $IsoNS::CI_ResponsibleParty.new(@xml)
+                        rPartyClass = CI_ResponsibleParty.new(@xml, @responseObj)
 
                         @xml.tag!('gmd:MD_Usage') do
 
@@ -42,7 +46,7 @@ module ADIWG
                                 @xml.tag!('gmd:userDeterminedLimitations') do
                                     @xml.tag!('gco:CharacterString', s)
                                 end
-                            elsif $showAllTags
+                            elsif @responseObj[:writerShowTags]
                                 @xml.tag!('gmd:userDeterminedLimitations')
                             end
 
@@ -54,7 +58,7 @@ module ADIWG
                                         rPartyClass.writeXML(rParty)
                                     end
                                 end
-                            elsif $showAllTags
+                            elsif @responseObj[:writerShowTags]
                                 @xml.tag!('gmd:userContactInfo')
                             end
 

data/lib/adiwg/mdtranslator/writers/{iso → iso19115_2}/classes/class_useConstraints.rb

@@ -4,16 +4,20 @@
 # History:
 # 	Stan Smith 2013-10-31 original script
 #   Stan Smith 2014-12-12 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 make iso19110 independent of iso19115_2 classes
+#   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
 
 module ADIWG
     module Mdtranslator
         module Writers
-            module Iso
+            module Iso19115_2
 
                 class MD_Constraints
 
-                    def initialize(xml)
+                    def initialize(xml, responseObj)
                         @xml = xml
+                        @responseObj = responseObj
                     end
 
                     def writeXML(aUseCons)

data/lib/adiwg/mdtranslator/writers/{iso → iso19115_2}/classes/class_verticalExtent.rb

@@ -4,16 +4,20 @@
 # History:
 # 	Stan Smith 2013-11-15 original script
 #   Stan Smith 2014-12-12 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 make iso19110 independent of iso19115_2 classes
+#   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
 
 module ADIWG
     module Mdtranslator
         module Writers
-            module Iso
+            module Iso19115_2
 
                 class EX_VerticalExtent
 
-                    def initialize(xml)
+                    def initialize(xml, responseObj)
                         @xml = xml
+                        @responseObj = responseObj
                     end
 
                     def writeXML(hVertEle)

data/lib/adiwg/mdtranslator/writers/{iso → iso19115_2}/classes/class_vouchers.rb

@@ -5,24 +5,28 @@
 # 	Stan Smith 2013-11-19 original script
 #   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
 #   Stan Smith 2014-12-12 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 make iso19110 independent of iso19115_2 classes
+#   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
 
-require 'class_responsibleParty'
+require_relative 'class_responsibleParty'
 
 module ADIWG
     module Mdtranslator
         module Writers
-            module Iso
+            module Iso19115_2
 
                 class MD_Vouchers
 
-                    def initialize(xml)
+                    def initialize(xml, responseObj)
                         @xml = xml
+                        @responseObj = responseObj
                     end
 
                     def writeXML(hVoucher)
 
                         # classes used in MD_Vouchers
-                        rPartyClass = $IsoNS::CI_ResponsibleParty.new(@xml)
+                        rPartyClass =  CI_ResponsibleParty.new(@xml, @responseObj)
 
                         @xml.tag!('gmd:MD_Vouchers') do
 

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

@@ -7,49 +7,52 @@
 #   Stan Smith 2014-07-08 modify require statements to function in RubyGem structure
 #   Stan Smith 2014-12-12 refactored to handle namespacing readers and writers
 #   Stan Smith 2015-06-11 change all codelists to use 'class_codelist' method
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../iso/classes'))
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
+#   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
 
 require 'builder'
 require 'date'
 require 'uuidtools'
-require 'adiwg/mdtranslator/writers/iso19115_2/class_MImetadata'
+require_relative 'version'
+require_relative 'class_MImetadata'
 
 module ADIWG
     module Mdtranslator
         module Writers
             module Iso19115_2
 
-                def self.startWriter(internalObj)
+                def self.startWriter(intObj, responseObj, paramsObj)
 
-                    # reset ISO id='' counter
-                    $idCount = '_000'
+                    # make internal and response objects available to the instance
+                    @intObj = intObj
+                    @responseObj = responseObj
 
                     # set the format of the output file based on the writer specified
-                    $response[:writerFormat] = 'xml'
-                    $response[:writerVersion] = ADIWG::Mdtranslator::VERSION
+                    responseObj[:writerFormat] = 'xml'
+                    responseObj[:writerVersion] = ADIWG::Mdtranslator::Writers::Iso19115_2::VERSION
 
                     # pre-scan the internal object to create a new extents for each geometry
                     # ... that has supplemental information (temporal, vertical, identity).
                     # ... the new extents will be added to internalObj
-                    prescanGeoElements(internalObj)
+                    prescanGeoElements()
 
                     # create new XML document
                     xml = Builder::XmlMarkup.new(indent: 3)
-                    metadataWriter = $WriterNS::MI_Metadata.new(xml)
-                    metadata = metadataWriter.writeXML(internalObj)
+                    metadataWriter = MI_Metadata.new(xml, responseObj)
+                    metadata = metadataWriter.writeXML(@intObj)
 
                     # 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
                     # load metadata into $response
-                    if $response[:writerPass].nil?
-                        $response[:writerPass] = true
+                    if responseObj[:writerPass].nil?
+                        responseObj[:writerPass] = true
                     end
 
                     return metadata
                 end
 
-                def self.prescanGeoElements(internalObj)
+                def self.prescanGeoElements()
                     # supplemental information for the geographic element is carried in the
                     # ... internal structure in the temporalElements:, verticalElements:,
                     # ... and elementIdentifiers: attributes of the extGeoElements:
@@ -61,7 +64,7 @@ module ADIWG
                     # ... moves the supplemental information from the geometry to the new extent.
                     # In this implementation, supplemental information is only allowed for
                     # ... geometry types of Point, LineString, and Polygon
-                    aExtents = internalObj[:metadata][:resourceInfo][:extents]
+                    aExtents = @intObj[:metadata][:resourceInfo][:extents]
                     unless aExtents.empty?
                         aExtents.each do |hExtent|
                             aGeoElements = hExtent[:extGeoElements]
@@ -114,14 +117,14 @@ module ADIWG
                         # ... it will match the supplemental information extent description
                         geoID = hGeoElement[:elementId]
                         if geoID.nil?
-                            $idCount = $idCount.succ
-                            geoID = geoType + $idCount
+                            @responseObj[:writerMissingIdCount] = @responseObj[:writerMissingIdCount].succ
+                            geoID = geoType + @responseObj[:writerMissingIdCount]
                             hGeoElement[:elementId] = geoID
                         end
 
                         # build unique id for extent geometry
-                        $idCount = $idCount.succ
-                        extGeoID = geoType + $idCount
+                        @responseObj[:writerMissingIdCount] = @responseObj[:writerMissingIdCount].succ
+                        extGeoID = geoType + @responseObj[:writerMissingIdCount]
 
                         intMetadataClass = InternalMetadata.new
                         intExtent = intMetadataClass.newExtent
@@ -144,6 +147,16 @@ module ADIWG
 
                 end
 
+                # find contact in contact array and return the contact hash
+                def self.getContact(contactID)
+                    @intObj[:contacts].each do |hContact|
+                        if hContact[:contactId] == contactID
+                            return hContact
+                        end
+                    end
+                    return {}
+                end
+
             end
 
         end

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

@@ -0,0 +1,17 @@
+# mdJson version history
+# 1.3.0 2015-07-30 added support for locale in metadata record information
+# 1.3.0 2015-07-31 added support for grid information
+# 1.3.0 2015-08-28 added support for content coverage information
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso19115_2
+
+                # current version of iso19115_2 writer
+                VERSION = '1.3.0'
+
+            end
+        end
+    end
+end

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

@@ -4,55 +4,52 @@
 # 	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
+#   Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
+#   Stan Smith 2015-07-14 refactored to make iso19110 independent of iso19115_2 classes
+#   Stan Smith 2015-07-14 refactored to eliminate namespace globals $WriterNS and $IsoNS
 
 module ADIWG
     module Mdtranslator
         module Writers
 
-            def self.handleWriter(intObj)
+            def self.handleWriter(intObj, responseObj, paramsObj)
 
-                # 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])
+                # use writerName from responseObj to build directory path to writer
+                # the writer's high level folder must be under the 'writers' directory
+                writerDir = File.join(path_to_writers, responseObj[:writerName])
                 if File.directory?(writerDir)
 
-                    # if directory path exists, build writer file name and then require it
-                    writerFile = File.join(writerDir, $response[:writerName] + '_writer')
+                    # if directory path exists, build writer file name and require it
+                    writerFile = File.join(writerDir, responseObj[:writerName] + '_writer')
                     require writerFile
-                    writerClassName = $response[:writerName].dup
-                    writerClassName[0] = writerClassName[0].upcase
-                    $WriterNS = ADIWG::Mdtranslator::Writers.const_get(writerClassName)
 
-                    # pass internal object to requested writer
-                    $response[:writerOutput] = $WriterNS.startWriter(intObj)
+                    # build the namespace for the writer
+                    writerNS = responseObj[:writerName].dup
+                    writerNS[0] = writerNS[0].upcase
+
+                    # pass internal object and response object to the writer
+                    responseObj[:writerOutput] = ADIWG::Mdtranslator::Writers.const_get(writerNS).startWriter(intObj, responseObj, paramsObj)
 
                 else
                     # directory path was not found
-                    $response[:writerPass] = false
-                    $response[:writerMessages] << 'Writer not called - see following message(s):\n'
-                    $response[:writerMessages] << "Writer name '#{$response[:writerName]}' is not supported."
+                    responseObj[:writerPass] = false
+                    responseObj[:writerMessages] << 'Writer not called - see following message(s):\n'
+                    responseObj[:writerMessages] << "Writer name '#{responseObj[:writerName]}' is not supported."
                     return false
                 end
 
             end
 
             # return path to writers
-            def self.path_to_resources
+            def self.path_to_writers
                 File.dirname(File.expand_path(__FILE__))
             end
 
             # return writer readme text
+            # this is called from the Rails API
             def self.get_writer_readme(writer)
                 readmeText = 'No readme found'
-                path = File.join(path_to_resources, writer, 'readme.md')
+                path = File.join(path_to_writers, writer, 'readme.md')
                 if File.exist?(path)
                     file = File.open(path, 'r')
                     readmeText = file.read

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

@@ -0,0 +1,116 @@
+# MdTranslator - minitest of
+# reader / mdJson / module_additionalDocumentation
+
+# History:
+# Stan Smith 2014-12-30 original script
+# Stan Smith 2015-06-22 refactored setup to after removal of globals
+
+# set reader version used by mdJson_reader.rb to require correct modules
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                @responseObj = {
+                    readerVersionUsed: '1.2.0'
+                }
+
+            end
+        end
+    end
+end
+
+require 'minitest/autorun'
+require 'json'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require 'adiwg/mdtranslator/readers/mdJson/mdJson_reader'
+require 'adiwg/mdtranslator/readers/mdJson/modules_v1/module_additionalDocumentation'
+
+class TestReaderMdJsonAdditionalDocumentation_v1 < MiniTest::Test
+
+    # set variables for test
+    @@NameSpace = ADIWG::Mdtranslator::Readers::MdJson::AdditionalDocumentation
+    @@responseObj = {
+        readerVersionUsed: '1.0',
+        readerExecutionPass: true,
+        readerExecutionMessages: []
+    }
+
+    # get json file for tests from examples folder
+    file = File.join(File.dirname(__FILE__), '../../../', 'schemas/v1_0/examples', 'additionalDocumentation.json')
+    file = File.open(file, 'r')
+    jsonFile = file.read
+    file.close
+    aIn = JSON.parse(jsonFile)
+
+    # only the first instance in the example array is used for tests
+    # the first example is fully populated
+    # remove responsible party from citation to prevent search for contact
+    # in contact array which has not been loaded
+    @@hIn = aIn[0]
+    @@hIn['citation']['responsibleParty'] = []
+    @@hIn['citation']['identifier']= []
+
+    def test_complete_additionalDocumentation_object
+        hIn = Marshal::load(Marshal.dump(@@hIn))
+        hResponse = Marshal::load(Marshal.dump(@@responseObj))
+        metadata = @@NameSpace.unpack(hIn, hResponse)
+
+        assert_equal metadata[:resourceType], 'resourceType'
+        refute_empty metadata[:citation]
+    end
+
+    def test_empty_additionalDocumentation_citation
+        hIn = Marshal::load(Marshal.dump(@@hIn))
+        hIn['citation'] = ''
+        hResponse = Marshal::load(Marshal.dump(@@responseObj))
+        hResponse[:readerExecutionPass] = true
+        hResponse[:readerExecutionMessages] = []
+        metadata = @@NameSpace.unpack(hIn, hResponse)
+
+        assert_nil metadata
+        refute hResponse[:readerExecutionPass]
+        refute_empty hResponse[:readerExecutionMessages]
+    end
+
+    def test_missing_additionalDocumentation_citation
+        hIn = Marshal::load(Marshal.dump(@@hIn))
+        hIn.delete('citation')
+        hResponse = Marshal::load(Marshal.dump(@@responseObj))
+        hResponse[:readerExecutionPass] = true
+        hResponse[:readerExecutionMessages] = []
+        metadata = @@NameSpace.unpack(hIn, hResponse)
+
+        assert_nil metadata
+        refute hResponse[:readerExecutionPass]
+        refute_empty hResponse[:readerExecutionMessages]
+    end
+
+    def test_empty_additionalDocumentation_elements
+        hIn = Marshal::load(Marshal.dump(@@hIn))
+        hIn['resourceType'] = ''
+        hResponse = Marshal::load(Marshal.dump(@@responseObj))
+        metadata = @@NameSpace.unpack(hIn, hResponse)
+
+        assert_nil metadata[:resourceType]
+        refute_empty metadata[:citation]
+    end
+
+    def test_missing_additionalDocumentation_elements
+        hIn = Marshal::load(Marshal.dump(@@hIn))
+        hIn.delete('resourceType')
+        hResponse = Marshal::load(Marshal.dump(@@responseObj))
+        metadata = @@NameSpace.unpack(hIn, hResponse)
+
+        assert_nil metadata[:resourceType]
+        refute_empty metadata[:citation]
+    end
+
+    def test_empty_additionalDocumentation_object
+        hResponse = Marshal::load(Marshal.dump(@@responseObj))
+        metadata = @@NameSpace.unpack({}, hResponse)
+
+        assert_nil metadata
+    end
+
+end