adiwg-mdtranslator 0.9.0 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 010b1cbf2339294147a58e5b78ded88b4df91be5
-  data.tar.gz: 8364931e9e108a14613fc714c32062e6c76f068c
+  metadata.gz: eb133f79461697e8f43a63ffb954558529f1c32d
+  data.tar.gz: 8d3e5b49675cf8bd0232d2ff01a8935f9bd8bf0a
 SHA512:
-  metadata.gz: 31f1fb5def4ba901a6c029f785c6c30d551e9e1e5a66aaaac3b7484d0bfbcfb78f47ee813997fd09d81a2193c7b626102712c2bb9b5b1a97daef9333509ac42a
-  data.tar.gz: d941add4d9e083587fd7fb800b2bb828373022ae9920343d59278357fcc91ab0fc0070e5e196036b0c47adad33a06bfe7db24f5a0b59d6c06f2d0924c9c066b1
+  metadata.gz: 9274cdf2cbeb17c54e1f5592d0920d169ebb570a83abf83b896adb75e575393f4666a02332c2d215f44a360d521c2a1a47c01a24b50da93e6fb72e3bf26ea33c
+  data.tar.gz: 77005bdc01f83d02b127def3d4e5a3a9542d98b098c574facaaa3c22eb0cb4ae367a4f3b4fe7e291fa6b692758715debd31bd3ff660b0fcfb19a16e680c3efa0

data/.gitignore

@@ -13,12 +13,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
-test/tmp
-test/version_tmp
-test/adiwgJson_full_test_example.json
-test/adiwgJson_min_test_example.json
-test/adiwgJson_template_data.json
-test/dev.rb
+dev
 tmp
 *.bundle
 *.so

data/adiwg-mdtranslator.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
 	spec.add_runtime_dependency "builder", "~>3.2"
 	spec.add_runtime_dependency "thor", "~>0.19"
 	spec.add_runtime_dependency "uuidtools", "~>2.1"
-	spec.add_runtime_dependency "json-schema", "~>2.4"
-	spec.add_runtime_dependency "adiwg-json_schemas", "~>0.9"
+	spec.add_runtime_dependency "json-schema", "~>2.4.0"
+	spec.add_runtime_dependency "adiwg-json_schemas", "~>0.9.4"
 end

data/bin/mdtranslator

@@ -26,7 +26,7 @@ class Mdtranslator < Thor
  in XML outputs, and choose level of validation for JSON inputs.
 	LONGDESC
 	# define cli options
-	method_option :reader, :aliases => '-r', :desc => 'Name of reader to read your input', :default => 'adiwgJson'
+	method_option :reader, :aliases => '-r', :desc => 'Name of reader to read your input', :default => 'mdJson'
 	method_option :writer, :aliases => '-w', :desc => 'Name of writer to create your metadata, or leave blank to validate input only'
 	method_option :validate, :aliases => '-v', :desc => 'Specify level of validation to be performed', :enum => %w{none normal strict}, :default => 'normal'
 	method_option :showAllTags, :aliases => '-s', :desc => 'Include tags for unused attributes', :type => :boolean, :default => false
@@ -60,10 +60,10 @@ class Mdtranslator < Thor
 				# ...no writer output will have been generated,
 				# ...and the return will be a string unless json was requested
 				if options[:messages] == 'json'
-					$stdout.write mdReturn.to_json
+					$stdout.puts mdReturn.to_json
 					return
 				else
-					$stdout.write 'Success'
+					$stdout.puts 'Success'
 					return
 				end
 			else
@@ -73,17 +73,17 @@ class Mdtranslator < Thor
 				    # writer output was generated
 					# ...return the writer output in its native format unless json was requested
 					if options[:returnObject]
-						$stdout.write mdReturn.to_json
+						$stdout.puts mdReturn.to_json
 						return
 					else
-						$stdout.write mdReturn[:writerOutput].to_s
+						$stdout.puts mdReturn[:writerOutput].to_s
 						return
 					end
 				else
 					# the writer failed or generated warnings to be reported
 					# ...return the messages as a string unless json was requested
 					if options[:messages] == 'json'
-						$stdout.write mdReturn.to_json
+						$stdout.puts mdReturn.to_json
 						return
 					else
 						# build a string with messages issues from parser and validator
@@ -100,7 +100,7 @@ class Mdtranslator < Thor
 							s += message + "\n"
 						end
 
-						$stdout.write s
+						$stdout.puts s
 						return
 
 					end
@@ -115,7 +115,7 @@ class Mdtranslator < Thor
 			# ...no writer output will have been generated,
 			# ...and return is always expected to be a string
 			if options[:messages] == 'json'
-				$stdout.write mdReturn.to_json
+				$stdout.puts mdReturn.to_json
 				return
 			else
 				# build a string with messages issues from parser and validator
@@ -152,7 +152,7 @@ class Mdtranslator < Thor
 					end
 				end
 
-				$stdout.write s
+				$stdout.puts s
 				return
 
 			end
@@ -165,7 +165,7 @@ class Mdtranslator < Thor
 		'mdtranslator version' returns the version number for mdTranslator
 	LONGDESC
 	def version
-		$stdout.write ADIWG::Mdtranslator::VERSION
+		$stdout.puts ADIWG::Mdtranslator::VERSION
 	end
 
 	Mdtranslator.start(ARGV)

data/lib/adiwg/mdtranslator.rb

@@ -11,6 +11,10 @@
 #   Stan Smith 2014-09-26 added processing of minor release numbers
 #   Stan Smith 2014-10-10 added method to return path to readers and writers
 #   Stan Smith 2014-10-11 added methods to return content of readme files
+#   Stan Smith 2014-12-01 changed adiwgJson ot mdJson
+#   Stan Smith 2014-12-01 added writer iso19110 (feature catalogue)
+#   Stan Smith 2014-12-01 added translator version to $response
+#   Stan Smith 2014-12-02 organized shared class/code/units folders for 19115-2, 19110
 
 # add main directories to load_path
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator'))
@@ -28,46 +32,78 @@ module ADIWG
 		def self.translate(file, reader, writer, validate, showAllTags)
 
 			$showAllTags = showAllTags
+
+			# load and return this hash
 			$response = {
 				readerFormat: nil,
 				readerStructurePass: nil,
 				readerStructureMessages: [],
-				readerName: reader,
-				readerNameFound: nil,
+				readerRequested: reader,
+				readerFound: nil,
 				readerVersionFound: nil,
 				readerVersionUsed: nil,
 				readerValidationLevel: validate,
 				readerValidationPass: nil,
 				readerValidationMessages: [],
 				writerName: writer,
+				writerVersion: ADIWG::Mdtranslator::VERSION,
 				writerFormat: nil,
 				writerPass: nil,
 				writerMessages: [],
 				writerOutput: nil
 			}
 
-			# the mdtranslator gem loads and returns the above hash
-
 			case reader
-				when 'adiwgJson'
-					require 'adiwgJson/adiwgJson_validator'
+
+				# ADIwg mdJson JSON schema
+				when 'mdJson'
+					require 'mdJson/mdJson_validator'
 
 					# validate adiwgJson file
-					AdiwgJsonValidation.validate(file)
+					MdJsonValidation.validate(file)
 					if $response[:readerStructurePass] && $response[:readerValidationPass]
 						# initiate the reader
-						require 'adiwgJson/adiwgJson_reader'
-						readerClass = AdiwgJsonReader.new
+						require 'mdJson/mdJson_reader'
+						readerClass = MdJsonReader.new
 						internalObj = readerClass.unpack(file)
 					else
 						return $response
 					end
+
+				# reader name not provided or not supported
+				else
+					$response[:readerValidationPass] = false
+					$response[:readerValidationMessages] << 'Reader name is missing or not supported.'
+					return $response
+
 			end
 
 			case writer
+
+				# ISO 19110 standard for feature catalogue used to describe tabular data dictionaries
+				when 'iso19110'
+					$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator/writers/iso/codelists'))
+					$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator/writers/iso/classes'))
+					$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator/writers/iso/units'))
+					require 'iso19110/iso19110_writer'
+
+					# set the format of the output file based on the writer specified
+					$response[:writerFormat] = 'xml'
+
+					writerClass = Iso19110Writer.new
+
+					# initiate the writer
+					$response[:writerOutput] = writerClass.writeXML(internalObj)
+					if $response[:writerMessages].length > 0
+						$response[:writerPass] = false
+					else
+						$response[:writerPass] = true
+					end
+
+				# ISO 19115-2:2009 standard for geospatial metadata
 				when 'iso19115_2'
-					$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator/writers/iso19115_2/codelists'))
-					$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator/writers/iso19115_2/classes'))
+					$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator/writers/iso/codelists'))
+					$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'mdtranslator/writers/iso/classes'))
 					require 'iso19115_2/iso19115_2_writer'
 
 					# set the format of the output file based on the writer specified
@@ -82,6 +118,12 @@ module ADIWG
 					else
 						$response[:writerPass] = true
 					end
+
+				# writer name is missing or not supported
+				else
+					$response[:writerPass] = false
+					$response[:writerMessages] << 'Writer name is missing or not supported.'
+
 			end
 
 			return $response
@@ -89,7 +131,7 @@ module ADIWG
 		end
 
 		def self.reader_module(moduleName, version)
-			dir = File.join($response[:readerName], 'modules_' + version)
+			dir = File.join($response[:readerFound], 'modules_' + version)
 			file = File.join(dir, moduleName)
 			return file
 		end

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

@@ -45,6 +45,7 @@
 #   Stan Smith 2014-11-06 added resourceType to resourceInfo for 0.9.0
 #   Stan Smith 2014-11-06 removed metadataScope from metadataInfo for 0.9.0
 #   Stan Smith 2014-11-06 added newAdditionalDocumentation
+#   Stan Smith 2014-12-01 added data dictionary
 
 class InternalMetadata
 
@@ -62,7 +63,8 @@ class InternalMetadata
 				version: nil
 			},
 			contacts: [],
-			metadata: {}
+			metadata: {},
+			dataDictionary: {}
 		}
 	end
 
@@ -76,7 +78,7 @@ class InternalMetadata
 
 	def newContact
 		intObj =  {
-			contactID: nil,
+			contactId: nil,
 			indName: nil,
 			orgName: nil,
 			position: nil,
@@ -132,7 +134,7 @@ class InternalMetadata
 
 	def newRespParty
 		intObj = {
-			contactID: nil,
+			contactId: nil,
 			roleName: nil
 		}
 	end
@@ -186,7 +188,7 @@ class InternalMetadata
 			citTitle: nil,
 			citDate: [],
 			citEdition: nil,
-			citResourceIDs: [],
+			citResourceIds: [],
 			citResponsibleParty: [],
 			citResourceForms: [],
 			citOlResources: []
@@ -359,7 +361,7 @@ class InternalMetadata
 
 	def newTimeInstant
 		intObj = {
-			timeID: nil,
+			timeId: nil,
 			description: nil,
 		    timePosition: {}
 		}
@@ -367,7 +369,7 @@ class InternalMetadata
 
 	def newTimePeriod
 		intObj = {
-			timeID: nil,
+			timeId: nil,
 			description: nil,
 			beginTime: {},
 			endTime: {}
@@ -459,7 +461,7 @@ class InternalMetadata
 
 	def newDataProcessStep
 		intObj = {
-			stepID: nil,
+			stepId: nil,
 			stepDescription: nil,
 			stepRationale: nil,
 			stepDateTime: {},
@@ -508,4 +510,82 @@ class InternalMetadata
 		}
 	end
 
+	def newDataDictionary
+		intObj = {
+			dictionaryInfo: {},
+			domains: [],
+			entities: []
+		}
+	end
+
+	def newDictionaryInfo
+		intObj = {
+			dictCitation: {},
+			dictDescription: nil,
+			dictResourceType: nil,
+			dictLanguage: nil
+		}
+	end
+
+	def newDictionaryDomain
+		intObj = {
+			domainId: nil,
+			domainName: nil,
+			domainCode: nil,
+			domainDescription: nil,
+			domainItems: []
+		}
+	end
+
+	def newDomainItem
+		intObj = {
+			itemName: nil,
+			itemValue: nil,
+			itemDefinition: nil
+		}
+	end
+
+	def newEntity
+		intObj = {
+			entityId: nil,
+			entityName: nil,
+			entityCode: nil,
+			entityDefinition: nil,
+			primaryKey: [],
+			indexes: [],
+			attributes: [],
+			foreignKeys: []
+		}
+	end
+
+	def newEntityIndex
+		intObj = {
+			indexCode: nil,
+            duplicate: false,
+			attributeNames: []
+		}
+	end
+
+	def newEntityAttribute
+		intObj = {
+			attributeName: nil,
+			attributeCode: nil,
+			attributeDefinition: nil,
+			dataType: nil,
+			allowNull: true,
+			unitOfMeasure: nil,
+			domainId: nil,
+			minValue: nil,
+			maxValue: nil
+		}
+	end
+
+	def newEntityForeignKey
+		intObj = {
+			fkLocalAttributes: [],
+			fkReferencedEntity: nil,
+			fkReferencedAttributes: []
+		}
+	end
+
 end

data/lib/adiwg/mdtranslator/readers/{adiwgJson/adiwgJson_reader.rb → mdJson/mdJson_reader.rb}

@@ -9,12 +9,15 @@
 #   Stan Smith 2014-07-03 resolve require statements using Mdtranslator.reader_module
 #   Stan Smith 2014-07-08 moved json schema version testing to 'adiwg_1_get_version'
 #   Stan Smith 2014-08-18 add json name/version to internal object
+#   Stan Smith 2014-12-01 add data dictionary
+#   Stan Smith 2014-12-03 changed class name to MdJsonReader from AdiwgJsonReader
 
 require 'json'
 require ADIWG::Mdtranslator.reader_module('module_contacts', $response[:readerVersionUsed])
 require ADIWG::Mdtranslator.reader_module('module_metadata', $response[:readerVersionUsed])
+require ADIWG::Mdtranslator.reader_module('module_dataDictionary', $response[:readerVersionUsed])
 
-class AdiwgJsonReader
+class MdJsonReader
 
 	def initialize
 	end
@@ -57,19 +60,25 @@ class AdiwgJsonReader
 			aContacts = hashObj['contact']
 			aContacts.each do |hContact|
 				unless hContact.empty?
-					intBase[:contacts] << Adiwg_Contact.unpack(hContact)
+					intBase[:contacts] << Md_Contact.unpack(hContact)
 				end
 			end
 		end
 
 		# add default contacts
-		intBase[:contacts].concat(Adiwg_Contact.setDefaultContacts)
+		intBase[:contacts].concat(Md_Contact.setDefaultContacts)
 
 		# metadata
 		# load metadata from the hash object
 		if hashObj.has_key?('metadata')
 			hMetadata = hashObj['metadata']
-			intBase[:metadata] = Adiwg_Metadata.unpack(hMetadata)
+			intBase[:metadata] = Md_Metadata.unpack(hMetadata)
+		end
+
+		# data dictionary
+		if hashObj.has_key?('dataDictionary')
+			hDictionary = hashObj['dataDictionary']
+			intBase[:dataDictionary] = Md_DataDictionary.unpack(hDictionary)
 		end
 
 		# return ADIwg internal container

data/lib/adiwg/mdtranslator/readers/{adiwgJson/adiwgJson_validator.rb → mdJson/mdJson_validator.rb}

@@ -5,6 +5,8 @@
 #   Stan Smith 2014-07-21 added json structure validation method
 #   Stan Smith 2014-08-21 parsed json-schema validation message to readable text
 #   Stan Smith 2014-09-26 added processing of minor release numbers
+#   Stan Smith 2014-12-01 changed adiwgJson to mdJson in version name check
+#   Stan Smith 2014-12-03 changed class name to MdJsonValidation from AdiwgJsonValidation
 
 require 'json'
 require 'json-schema'
@@ -12,7 +14,7 @@ require 'adiwg-json_schemas'
 #json-schema patch
 require 'validator.rb'
 
-module AdiwgJsonValidation
+module MdJsonValidation
 
 	def self.validate(file)
 
@@ -43,10 +45,10 @@ module AdiwgJsonValidation
 		if hVersion.has_key?('name')
 			s = hVersion['name']
 			if !s.nil?
-				$response[:readerNameFound] = s
-				if s != 'adiwgJson'
+				$response[:readerFound] = s
+				if s != 'mdJson'
 					$response[:readerStructurePass] = false
-					$response[:readerStructureMessages] << "input file version name must be 'adiwgJson'"
+					$response[:readerStructureMessages] << "input file version name must be 'mdJson'"
 					$response[:readerStructureMessages] << "found version name '#{s}'"
 					return
 				end
@@ -67,15 +69,21 @@ module AdiwgJsonValidation
 			# ...example: 'modules_1.2.0'
 			if !requestReaderVersion.nil?
 				aVersionParts = requestReaderVersion.split('.')
-				readerVersion = aVersionParts[0] +'.' + aVersionParts[1] + '.0'
-				dir = File.join(File.dirname(__FILE__),'modules_' + readerVersion)
-				if !File.directory?(dir)
+				if 3 == aVersionParts.length
+					readerVersion = aVersionParts[0] +'.' + aVersionParts[1] + '.0'
+					dir = File.join(File.dirname(__FILE__),'modules_' + readerVersion)
+					if !File.directory?(dir)
+						$response[:readerStructurePass] = false
+						$response[:readerStructureMessages] << 'input file version is not supported'
+						$response[:readerStructureMessages] << "mdJson version requested was '#{requestReaderVersion}'"
+						return
+					end
+					$response[:readerVersionUsed] = readerVersion
+				else
 					$response[:readerStructurePass] = false
-					$response[:readerStructureMessages] << 'input file version is not supported'
-					$response[:readerStructureMessages] << "adiwgJson version requested was '#{requestReaderVersion}'"
+					$response[:readerStructureMessages] << "input file version must be in the form MAJOR.MINOR.PATCH, e.g. 1.2.3"
 					return
 				end
-				$response[:readerVersionUsed] = readerVersion
 			end
 		else
 			$response[:readerStructurePass] = false