adiwg-mdtranslator 0.10.2 → 0.12.0

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

@@ -5,127 +5,159 @@
 #   Stan Smith 2014-06-04 add internal object pre-scan to create extents
 #   ... for geometry supplemental information
 #   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
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../iso/codelists'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../iso/classes'))
 
 require 'builder'
 require 'date'
 require 'uuidtools'
-require 'class_MImetadata'
-
-$idCount = '_000'
-
-class Iso191152Writer
-
-	def initialize
-	end
-
-	def writeXML(internalObj)
-
-		# pre-scan the internal object to create a new extents for each geometry
-		# ... that has supplemental information (temporal, vertical, identity)
-		# ... new extents will be added to internalObj as needed
-		prescanGeoElements(internalObj)
-
-		# create new XML document
-		xml = Builder::XmlMarkup.new(indent: 3)
-		metadataWriter = MI_Metadata.new(xml)
-		metadata = metadataWriter.writeXML(internalObj)
-
-		return metadata
-	end
-
-	def prescanGeoElements(internalObj)
-		# supplemental information for the geographic element is carried in the
-		# ... internal structure in the temporalElements:, verticalElements:,
-		# ... and elementIdentifiers: attributes of the extGeoElements:
-		# ... of the extent.
-		# since temporal, vertical, and identify information in ISO is a property
-		# ... of EX_Extent and not of the geographicElement,
-		# ... this code creates a new extent for each geographicElement
-		# ... that has supplemental information and
-		# ... 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]
-		unless aExtents.empty?
-			aExtents.each do |hExtent|
-				aGeoElements = hExtent[:extGeoElements]
-				unless aGeoElements.empty?
-					aGeoElements.each do |hGeoElement|
-						hGeometry = hGeoElement[:elementGeometry]
-						unless hGeometry.empty?
-							geoType = hGeometry[:geoType]
-							case geoType
-								when 'Point', 'LineString', 'Polygon'
-									newExtent = extentFromGeoElement(hGeoElement, geoType)
-									if !newExtent.nil?
-										aExtents << newExtent
-									end
-
-								when 'MultiGeometry'
-									aGeoMembers = hGeometry[:geometry]
-									unless aGeoMembers.empty?
-										aGeoMembers.each do |hGeoMemberElement|
-											hGeometry = hGeoMemberElement[:elementGeometry]
-											unless hGeometry.empty?
-												geoType = hGeometry[:geoType]
-												case geoType
-													when 'Point', 'LineString', 'Polygon'
-														newExtent = extentFromGeoElement(hGeoMemberElement, geoType)
-														if !newExtent.nil?
-															aExtents << newExtent
-														end
-												end
-											end
-										end
-									end
-							end
-						end
-					end
-				end
-			end
-		end
-	end
-
-	def extentFromGeoElement(hGeoElement, geoType)
-		# build new extent to portray supplemental information
-		# from elementGeometry
-		if !hGeoElement[:temporalElements].empty? ||
-			!hGeoElement[:verticalElements].empty? ||
-			!hGeoElement[:elementIdentifiers].empty?
-
-			# get unique id for geometry
-			# if geometry id was missing, set it at this time so
-			# ... it will match the supplemental information extent description
-			geoID = hGeoElement[:elementId]
-			if geoID.nil?
-				$idCount = $idCount.succ
-				geoID = geoType + $idCount
-				hGeoElement[:elementId] = geoID
-			end
-
-			# build unique id for extent geometry
-			$idCount = $idCount.succ
-			extGeoID = geoType + $idCount
-
-			intMetadataClass = InternalMetadata.new
-			intExtent = intMetadataClass.newExtent
-			intGeoEle = intMetadataClass.newGeoElement
-
-			intGeoEle[:elementId] = extGeoID
-			intGeoEle[:elementGeometry] = hGeoElement[:elementGeometry]
-
-			intExtent[:extDesc] = 'Supplemental information for ' + geoID
-			intExtent[:extGeoElements] << intGeoEle
-			intExtent[:extIdElements] = hGeoElement[:elementIdentifiers]
-			intExtent[:extTempElements] = hGeoElement[:temporalElements]
-			intExtent[:extVertElements] = hGeoElement[:verticalElements]
-
-			return intExtent
-
-		else
-			return nil
-		end
-
-	end
-
+require 'adiwg/mdtranslator/writers/iso19115_2/class_MImetadata'
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso
+
+                # set writer namespace
+                $WriterNS = ADIWG::Mdtranslator::Writers::Iso
+
+                class Iso19115_2
+
+                    def initialize
+                        # reset ISO id='' counter
+                        $idCount = '_000'
+                    end
+
+                    def writeXML(internalObj)
+
+
+                        # set the format of the output file based on the writer specified
+                        $response[:writerFormat] = 'xml'
+                        $response[:writerVersion] = ADIWG::Mdtranslator::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)
+
+                        # create new XML document
+                        xml = Builder::XmlMarkup.new(indent: 3)
+                        metadataWriter = $WriterNS::MI_Metadata.new(xml)
+                        metadata = metadataWriter.writeXML(internalObj)
+
+                        # set writer pass to true if no messages
+                        # false or warning will be set by code that places the message
+                        if $response[:writerMessages].length == 0
+                            $response[:writerPass] = true
+                        end
+
+                        return metadata
+                    end
+
+                    def prescanGeoElements(internalObj)
+                        # supplemental information for the geographic element is carried in the
+                        # ... internal structure in the temporalElements:, verticalElements:,
+                        # ... and elementIdentifiers: attributes of the extGeoElements:
+                        # ... of the extent.
+                        # since temporal, vertical, and identify information in ISO is a property
+                        # ... of EX_Extent and not of the geographicElement,
+                        # ... this code creates a new extent for each geographicElement
+                        # ... that has supplemental information and
+                        # ... 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]
+                        unless aExtents.empty?
+                            aExtents.each do |hExtent|
+                                aGeoElements = hExtent[:extGeoElements]
+                                unless aGeoElements.empty?
+                                    aGeoElements.each do |hGeoElement|
+                                        hGeometry = hGeoElement[:elementGeometry]
+                                        unless hGeometry.empty?
+                                            geoType = hGeometry[:geoType]
+                                            case geoType
+                                                when 'Point', 'LineString', 'Polygon'
+                                                    newExtent = extentFromGeoElement(hGeoElement, geoType)
+                                                    if !newExtent.nil?
+                                                        aExtents << newExtent
+                                                    end
+
+                                                when 'MultiGeometry'
+                                                    aGeoMembers = hGeometry[:geometry]
+                                                    unless aGeoMembers.empty?
+                                                        aGeoMembers.each do |hGeoMemberElement|
+                                                            hGeometry = hGeoMemberElement[:elementGeometry]
+                                                            unless hGeometry.empty?
+                                                                geoType = hGeometry[:geoType]
+                                                                case geoType
+                                                                    when 'Point', 'LineString', 'Polygon'
+                                                                        newExtent = extentFromGeoElement(hGeoMemberElement, geoType)
+                                                                        if !newExtent.nil?
+                                                                            aExtents << newExtent
+                                                                        end
+                                                                end
+                                                            end
+                                                        end
+                                                    end
+                                            end
+                                        end
+                                    end
+                                end
+                            end
+                        end
+                    end
+
+                    def extentFromGeoElement(hGeoElement, geoType)
+                        # build new extent to portray supplemental information
+                        # from elementGeometry
+                        if !hGeoElement[:temporalElements].empty? ||
+                            !hGeoElement[:verticalElements].empty? ||
+                                !hGeoElement[:elementIdentifiers].empty?
+
+                            # get unique id for geometry
+                            # if geometry id was missing, set it at this time so
+                            # ... it will match the supplemental information extent description
+                            geoID = hGeoElement[:elementId]
+                            if geoID.nil?
+                                $idCount = $idCount.succ
+                                geoID = geoType + $idCount
+                                hGeoElement[:elementId] = geoID
+                            end
+
+                            # build unique id for extent geometry
+                            $idCount = $idCount.succ
+                            extGeoID = geoType + $idCount
+
+                            intMetadataClass = InternalMetadata.new
+                            intExtent = intMetadataClass.newExtent
+                            intGeoEle = intMetadataClass.newGeoElement
+
+                            intGeoEle[:elementId] = extGeoID
+                            intGeoEle[:elementGeometry] = hGeoElement[:elementGeometry]
+
+                            intExtent[:extDesc] = 'Supplemental information for ' + geoID
+                            intExtent[:extGeoElements] << intGeoEle
+                            intExtent[:extIdElements] = hGeoElement[:elementIdentifiers]
+                            intExtent[:extTempElements] = hGeoElement[:temporalElements]
+                            intExtent[:extVertElements] = hGeoElement[:verticalElements]
+
+                            return intExtent
+
+                        else
+                            return nil
+                        end
+
+                    end
+
+                end
+
+            end
+        end
+    end
 end
+
+
+
+

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

@@ -0,0 +1,63 @@
+# MdTranslator - controller for evaluating and directing writers
+
+# History:
+# 	Stan Smith 2014-12-11 original script
+#   Stan Smith 2012-12-16 generalized handleWriter to use :writerName
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+
+            def self.handleWriter(intObj)
+
+                # 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
+
+                    # build class name for writer from writerName
+                    # ... class name must begin with upper case
+                    # ... (1) writer file name must be writerName_writer.rb
+                    # ... (2) writer class name must be capitalized writerName
+                    # ... (3) $WriterNS is the writer namespace constant set in
+                    # ... writerName_writer.rb and initialized when the file is required
+                    writerUpCase = $response[:writerName][0].upcase + $response[:writerName][1..-1]
+                    writerClass = $WriterNS.const_get(writerUpCase).new
+
+                    # pass internal object to requested writer
+                    $response[:writerOutput] = writerClass.writeXML(intObj)
+                    return $response
+                else
+                    # directory path was not found
+                    $response[:writerValidationPass] = false
+                    $response[:readerValidationMessages] << "Writer name '#{$response[:writerName]}' is not supported."
+                    return false
+                end
+
+            end
+
+            # return path to writers
+            def self.path_to_resources
+                File.dirname(File.expand_path(__FILE__))
+            end
+
+            # return writer readme text
+            def self.get_writer_readme(writer)
+                readmeText = 'No readme found'
+                path = File.join(path_to_resources, writer, 'readme.md')
+                if File.exist?(path)
+                    file = File.open(path, 'r')
+                    readmeText = file.read
+                    file.close
+                end
+                return readmeText
+            end
+
+        end
+    end
+end
+

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

@@ -0,0 +1,84 @@
+# MdTranslator - minitest of
+# reader / mdJson / module_additionalDocumentation
+
+# History:
+# Stan Smith 2014-12-30 original script
+
+#set globals used in testing
+#set globals used by mdJson_reader.rb before requiring module
+$response = {
+    readerVersionUsed: '0.9'
+}
+
+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_0.9/module_additionalDocumentation'
+
+class TestReaderMdJsonAdditionalDocumentation_v0_9 < MiniTest::Test
+
+    # get json test example
+    file = File.open('test/schemas/v0_9/examples/additionalDocumentation.json', 'r')
+    jsonFile = file.read
+    file.close
+    aIn = JSON.parse(jsonFile)
+    @@hIn = aIn[0]
+
+    # set namespace
+    @@NameSpace = ADIWG::Mdtranslator::Readers::MdJson::AdditionalDocumentation
+
+    def test_complete_additionalDocumentation_object
+
+        hIn = @@hIn.clone
+        hIn.delete('citation')
+
+        intObj = {
+            resourceType: 'resourceType',
+            citation: {}
+        }
+
+        assert_equal intObj, @@NameSpace.unpack(hIn)
+
+    end
+
+    def test_empty_additionalDocumentation_elements
+
+        hIn = @@hIn.clone
+        hIn['resourceType'] = ''
+        hIn['citation'] = {}
+
+        intObj = {
+            resourceType: nil,
+            citation: {}
+        }
+
+        assert_equal intObj, @@NameSpace.unpack(hIn)
+
+    end
+
+    def test_missing_additionalDocumentation_citation
+
+        # note: except for resourceType
+
+        hIn = @@hIn.clone
+        hIn.delete('citation')
+
+        intObj = {
+            resourceType: 'resourceType',
+            citation: {}
+        }
+
+        assert_equal intObj, @@NameSpace.unpack(hIn)
+
+    end
+
+    def test_empty_additionalDocumentation_object
+
+        hIn = JSON.parse('{}')
+
+        assert_equal nil, @@NameSpace.unpack(hIn)
+
+    end
+
+end

data/test/readers/mdJson/v0_9/tc_reader_mdjson_address.rb

@@ -0,0 +1,100 @@
+# MdTranslator - minitest of
+# reader / mdJson / module_address
+
+# History:
+# Stan Smith 2014-12-09 original script
+# Stan Smith 2014-12-15 modified to use namespaces added to mdTranslator
+# Stan Smith 2014-12-16 restructure tests to use schema examples
+# Stan Smith 2014-12-19 added test for blank elements
+
+require 'minitest/autorun'
+require 'json'
+require 'adiwg/mdtranslator/internal/internal_metadata_obj'
+require 'adiwg/mdtranslator/readers/mdJson/modules_0.9/module_address'
+
+class TestReaderMdJsonAddress_v0_9 < MiniTest::Test
+
+    # get json test example
+    file = File.open('test/schemas/v0_9/examples/address.json', 'r')
+    jsonFile = file.read
+    file.close
+    aIn = JSON.parse(jsonFile)
+    @@hIn = aIn[0]
+
+    # set namespace
+    @@NameSpace = ADIWG::Mdtranslator::Readers::MdJson::Address
+
+    def test_complete_address_object
+
+        hIn = @@hIn.clone
+
+        intObj = {
+            deliveryPoints: %w[deliveryPoint1 deliveryPoint2],
+            city: 'city',
+            adminArea: 'administrativeArea',
+            postalCode: 'postalCode',
+            country: 'country',
+            eMailList: %w[example1@example.com example2@example.com]
+        }
+
+        assert_equal intObj, @@NameSpace.unpack(hIn)
+
+    end
+
+    def test_email_address_only
+
+        # note: this test also serves to test missing elements
+        # ... except for missing electronicMailAddress
+
+        hIn = @@hIn.clone
+        hIn.delete('deliveryPoint')
+        hIn.delete('city')
+        hIn.delete('administrativeArea')
+        hIn.delete('postalCode')
+        hIn.delete('country')
+
+        intObj = {
+            deliveryPoints: [],
+            city: nil,
+            adminArea: nil,
+            postalCode: nil,
+            country: nil,
+            eMailList: %w[example1@example.com example2@example.com]
+        }
+
+        assert_equal intObj,@@NameSpace.unpack(hIn)
+
+    end
+
+    def test_empty_address_elements
+
+        hIn = @@hIn.clone
+        hIn['deliveryPoint'] = ['']
+        hIn['city'] = ''
+        hIn['administrativeArea'] = ''
+        hIn['postalCode'] = ''
+        hIn['country'] = ''
+        hIn['electronicMailAddress'] = ['']
+
+        intObj = {
+            deliveryPoints: [],
+            city: nil,
+            adminArea: nil,
+            postalCode: nil,
+            country: nil,
+            eMailList: []
+        }
+
+        assert_equal intObj,@@NameSpace.unpack(hIn)
+
+    end
+
+    def test_empty_address_object
+
+        hIn = JSON.parse('{}')
+
+        assert_equal nil, @@NameSpace.unpack(hIn)
+
+    end
+
+end