adiwg-mdtranslator 0.10.2 → 0.12.0

data/lib/adiwg/mdtranslator/readers/mdJson/modules_0.9/module_timeInstant.rb

@@ -0,0 +1,56 @@
+# unpack time instant
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-12-11 original script
+#   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+
+require $ReaderNS.readerModule('module_dateTime')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module TimeInstant
+
+                    def self.unpack(hTimeInst)
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+
+                        # time instant
+                        intTimeInst = intMetadataClass.newTimeInstant
+
+                        if hTimeInst.has_key?('id')
+                            s = hTimeInst['id']
+                            if s != ''
+                                intTimeInst[:timeId] = s
+                            end
+                        end
+
+                        if hTimeInst.has_key?('description')
+                            s = hTimeInst['description']
+                            if s != ''
+                                intTimeInst[:description] = s
+                            end
+                        end
+
+                        # time instant will only be inserted if time position provided
+                        if hTimeInst.has_key?('timePosition')
+                            s = hTimeInst['timePosition']
+                            if s != ''
+                                intTimeInst[:timePosition] = $ReaderNS::DateTime.unpack(s)
+                            end
+                        end
+
+                        return intTimeInst
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_0.9/module_timePeriod.rb

@@ -0,0 +1,64 @@
+# unpack time period
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-12-11 original script
+#   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+
+require $ReaderNS.readerModule('module_dateTime')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module TimePeriod
+
+                    def self.unpack(hTimePeriod)
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+
+                        # time period
+                        intTimePer = intMetadataClass.newTimePeriod
+
+                        if hTimePeriod.has_key?('id')
+                            s = hTimePeriod['id']
+                            if s != ''
+                                intTimePer[:timeId] = s
+                            end
+                        end
+
+                        if hTimePeriod.has_key?('description')
+                            s = hTimePeriod['description']
+                            if s != ''
+                                intTimePer[:description] = s
+                            end
+                        end
+
+                        if hTimePeriod.has_key?('beginPosition')
+                            s = hTimePeriod['beginPosition']
+                            if s != ''
+                                intTimePer[:beginTime] = $ReaderNS::DateTime.unpack(s)
+
+                            end
+                        end
+
+                        if hTimePeriod.has_key?('endPosition')
+                            s = hTimePeriod['endPosition']
+                            if s != ''
+                                intTimePer[:endTime] = $ReaderNS::DateTime.unpack(s)
+
+                            end
+                        end
+
+                        return intTimePer
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_0.9/module_verticalElement.rb

@@ -0,0 +1,64 @@
+# unpack vertical element
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-11-18 original script
+# 	Stan Smith 2013-12-11 modified to handle single vertical element
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module VerticalElement
+
+                    def self.unpack(hVertElement)
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+
+                        intVertEle = intMetadataClass.newVerticalElement
+
+                        # vertical element - minimum value
+                        if hVertElement.has_key?('minimumValue')
+                            s = hVertElement['minimumValue']
+                            if s != ''
+                                intVertEle[:minValue] = s
+                            end
+                        end
+
+                        # vertical element - maximum value
+                        if hVertElement.has_key?('maximumValue')
+                            s = hVertElement['maximumValue']
+                            if s != ''
+                                intVertEle[:maxValue] = s
+                            end
+                        end
+
+                        # vertical element - vertical crs title attribute
+                        if hVertElement.has_key?('verticalCRSTitle')
+                            s = hVertElement['verticalCRSTitle']
+                            if s != ''
+                                intVertEle[:crsTitle] = s
+                            end
+                        end
+
+                        # vertical element - vertical crs link attribute
+                        if hVertElement.has_key?('verticalCRSUri')
+                            s = hVertElement['verticalCRSUri']
+                            if s != ''
+                                intVertEle[:crsURI] = s
+                            end
+                        end
+
+                        return intVertEle
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/modules_0.9/module_voucher.rb

@@ -0,0 +1,49 @@
+# unpack voucher
+# Reader - ADIwg JSON V1 to internal data structure
+
+# History:
+# 	Stan Smith 2013-11-21 original script
+#   Stan Smith 2014-07-07 resolve require statements using Mdtranslator.reader_module
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+
+require $ReaderNS.readerModule('module_responsibleParty')
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+            module MdJson
+
+                module Voucher
+
+                    def self.unpack(hVoucher)
+
+                        # instance classes needed in script
+                        intMetadataClass = InternalMetadata.new
+                        intTaxVoucher = intMetadataClass.newTaxonVoucher
+
+                        # taxonomy voucher - specimen
+                        if hVoucher.has_key?('specimen')
+                            s = hVoucher['specimen']
+                            if s != ''
+                                intTaxVoucher[:specimen] = s
+                            end
+                        end
+
+                        # taxonomy - repository - responsible party
+                        if hVoucher.has_key?('repository')
+                            hRepository = hVoucher['repository']
+                            unless hRepository.empty?
+                                intTaxVoucher[:repository] = $ReaderNS::ResponsibleParty.unpack(hRepository)
+                            end
+                        end
+
+                        return intTaxVoucher
+
+                    end
+
+                end
+
+            end
+        end
+    end
+end

data/lib/adiwg/mdtranslator/readers/mdJson/readme.md

@@ -3,7 +3,7 @@
 
 ### Supported versions
 
-> 0.9.0
+> 0.9.1, 0.9.4
 
 ### Reader for ADIwg JSON metadata format (mdJson)
 

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

@@ -0,0 +1,43 @@
+=begin
+* Description: Patches json-schema gem to work on windows
+* Author: Josh Bradley
+* Date: 2014-09-17
+* License: Public Domain
+=end
+
+module JSON
+
+    class Validator
+
+        def load_ref_schema(parent_schema, ref)
+            uri = URI.parse(ref)
+            if uri.relative?
+                uri = parent_schema.uri.clone
+
+                # Check for absolute path
+                path = ref.split("#")[0]
+
+                # This is a self reference and thus the schema does not need to be re-loaded
+                if path.nil? || path == ''
+                    return
+                end
+
+                if path && path[0, 1] == '/'
+                    uri.path = Pathname.new(path).cleanpath.to_s
+                else
+                    uri = parent_schema.uri.merge(path)
+                end
+                uri.fragment = ''
+            end
+
+            if Validator.schemas[uri.to_s].nil?
+                schema = JSON::Schema.new(JSON::Validator.parse(open(uri.to_s.chomp('#')).read), uri, @options[:version])
+                Validator.add_schema(schema)
+                build_schemas(schema)
+            end
+
+        end
+
+    end
+
+end

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

@@ -0,0 +1,55 @@
+# MdTranslator - controller for evaluating and directing readers
+
+# History:
+# 	Stan Smith 2014-12-11 original script
+#   Stan Smith 2012-12-16 generalized handleReader to use :readerRequested
+
+module ADIWG
+    module Mdtranslator
+        module Readers
+
+            def self.handleReader(file)
+
+                # use reader name to load and initiate reader
+                # build directory path name for reader
+                readerDir = File.join(path_to_resources, $response[:readerRequested])
+                if File.directory?(readerDir)
+
+                    # if directory path exists, build reader file name and require it
+                    readerFile = File.join(readerDir, $response[:readerRequested] + '_reader')
+                    require readerFile
+
+                    # 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
+                else
+                    # directory path was not found
+                    $response[:readerValidationPass] = false
+                    $response[:readerValidationMessages] << "Reader name '#{$response[:readerRequested]}' is not supported."
+                    return false
+                end
+
+            end
+
+            # return path to readers
+            def self.path_to_resources
+                File.dirname(File.expand_path(__FILE__))
+            end
+
+            # return reader readme text
+            def self.get_reader_readme(reader)
+                readmeText = 'No readme found'
+                path = File.join(path_to_resources, reader, 'readme.md')
+                if File.exist?(path)
+                    file = File.open(path, 'r')
+                    readmeText = file.read
+                    file.close
+                end
+                return readmeText
+            end
+
+        end
+    end
+end

data/lib/adiwg/mdtranslator/version.rb

@@ -21,11 +21,22 @@
 # 0.9.2 2014-12-01 added data dictionary support
 # 0.10.0 2014-12-01 added ISO 19110 writer
 # 0.10.1 2014-12-04 fixed problem with messages not returned in an array
+# 0.10.2 2014-12-05
+# 0.11.0 2014-12-15 refactored code managing the readers and writers
+#               ... added namespaces to readers and writers
+# 0.11.1 2014-12-16 fixed problem of rails not access reader and writer readme files
+#               ... changed mdReader and mdWriter to use requested reader and writer
+#               ... names to resolved require and call statements
+# 0.11.2 2014-12-29 fixed problem with handling xml builder object rather than output
+#               ... output string created by builder
+# 0.11.3 2015-01-14 change return type from false to $response when writer name is invalid
+# 0.12.0 2015-01-16 changed translate entry point method to use keyword parameters
+#               ... must now be ruby version 2.0.0 or higher
 
 module ADIWG
-	module Mdtranslator
-		# current mdtranslator version
-		VERSION = "0.10.2"
-	end
+    module Mdtranslator
+        # current mdtranslator version
+        VERSION = "0.12.0"
+    end
 end
 

data/lib/adiwg/mdtranslator/writers/iso/classes/class_address.rb

@@ -3,89 +3,110 @@
 
 # History:
 # 	Stan Smith 2013-08-09 original script
-
-class CI_Address
-
-	def initialize(xml)
-		@xml = xml
-	end
-
-	def writeXML(hAddress)
-
-		deliveryPoints = hAddress[:deliveryPoints].length
-		eMails = hAddress[:eMailList].length
-
-		if deliveryPoints + eMails > 0
-			@xml.tag!('gmd:CI_Address') do
-				# address - address
-				if deliveryPoints > 0
-
-					# address - delivery points (address lines)
-					aDeliveryPoints = hAddress[:deliveryPoints]
-					aDeliveryPoints.each do |myPoint|
-						@xml.tag!('gmd:deliveryPoint') do
-							@xml.tag!('gco:CharacterString',myPoint)
-						end
-					end
-
-				elsif $showAllTags
-					@xml.tag!('gmd:deliveryPoint')
-				end
-
-				# address - city
-				s = hAddress[:city]
-				if !s.nil?
-					@xml.tag!('gmd:city') do
-						@xml.tag!('gco:CharacterString',s)
-					end
-				elsif $showAllTags
-					@xml.tag!('gmd:city')
-				end
-
-				# address - admin area (state)
-				s = hAddress[:adminArea]
-				if !s.nil?
-					@xml.tag!('gmd:administrativeArea') do
-						@xml.tag!('gco:CharacterString',s)
-					end
-				elsif $showAllTags
-					@xml.tag!('gmd:administrativeArea')
-				end
-
-				# address - postal code
-				s = hAddress[:postalCode]
-				if !s.nil?
-					@xml.tag!('gmd:postalCode') do
-						@xml.tag!('gco:CharacterString',s)
-					end
-				elsif $showAllTags
-					@xml.tag!('gmd:postalCode')
-				end
-
-				# address - country
-				s = hAddress[:country]
-				if !s.nil?
-					@xml.tag!('gmd:country') do
-						@xml.tag!('gco:CharacterString',s)
-					end
-				elsif $showAllTags
-					@xml.tag!('gmd:country')
-				end
-
-				# address - email addresses
-				if eMails > 0
-					hAddress[:eMailList].each do |myEmail|
-						@xml.tag!('gmd:electronicMailAddress') do
-							@xml.tag!('gco:CharacterString',myEmail)
-						end
-					end
-				elsif $showAllTags
-					@xml.tag!('gmd:electronicMailAddress')
-				end
-
-			end
-		end
-
-	end
-
-end
+#   Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
+#   Stan Smith 2014-12-22 added return if passed nil address objects
+#   Stan Smith 2014-12-23 refactored to drop physical address elements if no
+#                     ... deliveryPoints are provided
+
+module ADIWG
+    module Mdtranslator
+        module Writers
+            module Iso
+
+                class CI_Address
+
+                    def initialize(xml)
+                        @xml = xml
+                    end
+
+                    def writeXML(hAddress)
+
+                        return if hAddress.nil?
+
+                        deliveryPoints = hAddress[:deliveryPoints].length
+                        eMails = hAddress[:eMailList].length
+
+                        if deliveryPoints + eMails > 0
+                            @xml.tag!('gmd:CI_Address') do
+
+                                # physical address
+                                # ... if no delivery points are provided ignore rest
+                                # ... of physical address items
+                                if deliveryPoints > 0
+
+                                    # address - delivery points (address lines)
+                                    aDeliveryPoints = hAddress[:deliveryPoints]
+                                    aDeliveryPoints.each do |myPoint|
+                                        @xml.tag!('gmd:deliveryPoint') do
+                                            @xml.tag!('gco:CharacterString', myPoint)
+                                        end
+                                    end
+
+                                    # address - city
+                                    s = hAddress[:city]
+                                    if !s.nil?
+                                        @xml.tag!('gmd:city') do
+                                            @xml.tag!('gco:CharacterString', s)
+                                        end
+                                    elsif $showAllTags
+                                        @xml.tag!('gmd:city')
+                                    end
+
+                                    # address - admin area (state)
+                                    s = hAddress[:adminArea]
+                                    if !s.nil?
+                                        @xml.tag!('gmd:administrativeArea') do
+                                            @xml.tag!('gco:CharacterString', s)
+                                        end
+                                    elsif $showAllTags
+                                        @xml.tag!('gmd:administrativeArea')
+                                    end
+
+                                    # address - postal code
+                                    s = hAddress[:postalCode]
+                                    if !s.nil?
+                                        @xml.tag!('gmd:postalCode') do
+                                            @xml.tag!('gco:CharacterString', s)
+                                        end
+                                    elsif $showAllTags
+                                        @xml.tag!('gmd:postalCode')
+                                    end
+
+                                    # address - country
+                                    s = hAddress[:country]
+                                    if !s.nil?
+                                        @xml.tag!('gmd:country') do
+                                            @xml.tag!('gco:CharacterString', s)
+                                        end
+                                    elsif $showAllTags
+                                        @xml.tag!('gmd:country')
+                                    end
+
+                                elsif $showAllTags
+                                    @xml.tag!('gmd:deliveryPoint')
+                                    @xml.tag!('gmd:city')
+                                    @xml.tag!('gmd:administrativeArea')
+                                    @xml.tag!('gmd:postalCode')
+                                    @xml.tag!('gmd:country')
+                                end
+
+                                # address - email addresses
+                                if eMails > 0
+                                    hAddress[:eMailList].each do |myEmail|
+                                        @xml.tag!('gmd:electronicMailAddress') do
+                                            @xml.tag!('gco:CharacterString', myEmail)
+                                        end
+                                    end
+                                elsif $showAllTags
+                                    @xml.tag!('gmd:electronicMailAddress')
+                                end
+
+                            end
+                        end
+                    end # writeXML
+                end # CI_Address
+
+            end
+        end
+    end
+end