adiwg-mdtranslator 0.9.0 → 0.10.2

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

@@ -1,19 +0,0 @@
-
-## adiwgJson
-
-### Supported versions
-
-> 0.8.0
-
-### Reader for ADIwg JSON metadata format
-
-The adiwgJson format is a simple JSON format for documenting and exchanging information
-about scientific projects and data.  The Alaska Data Integration working group (ADIwg) wrote the
-standard to support translation to complex standards such as the ISO 19115-2 Geographic Metadata standard
-and FGDC's Content Standard for Digital Geospatial Metadata.  The adiwgJson standard
-remains independent of any published standards while comprehensive enough to support translation
-to many. The adiwgJson standard is also a convenient format to exchange directly with other organizations as
-the JSON structure is easier read and ingest by many programming languages.
-
-The adiwg format is fully documented on the interactive
-[adiwgJson Viewer](http://jlblcc.github.io/json-schema-viewer/) website.

data/mdtranslator.rb

@@ -1,187 +0,0 @@
-#!/usr/bin/env ruby
-# ADIwg mdTranslator - Thor CLI for mdtranslator
-
-# History:
-# 	Stan Smith 2014-07-15 original script
-#   Stan Smith 2014-09-02 changed name to mdtranslator
-#   Stan Smith 2014-09-21 coded cli to 0.8.0 api
-#   Stan Smith 2014-10-09 added version command to the CLI
-
-# uncomment next 2 lines during development to run from code (not gem) ....
-lib = File.expand_path('lib')
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'thor'
-require 'adiwg-mdtranslator'
-
-class Mdtranslator < Thor
-
-	# exit_on_failure added to exit with code 1 if thor cannot complete task
-	# such as if required parameters are missing
-	def self.exit_on_failure?
-		true
-	end
-
-	# basic cli description
-	desc 'translate [FILE]', %q{Pass JSON string or filename plus parameters to mdtranslator translate}
-	long_desc <<-LONGDESC
-	    'mdtranslator translate' provides command line access to the ADIWG metadata translator
- with options to select the input file reader, select writer output format, show empty tags
- 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 :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
-	method_option :messages, :aliases => '-m', :desc => 'On error return messages as formatted text or json object', :enum => %w{json text}, :default => 'text'
-	method_option :returnObject, :aliases => '-o', :desc => 'Return full JSON object generated by translator', :type => :boolean, :default => false
-
-	# accept command and options
-	def translate(file)
-
-		# test to see if file parameter is a local file
-		# if not ... it is assumed to be a json string
-		if File.exist?(file)
-			# read file
-			my_file = File.open(file, 'r')
-			fileObj = my_file.read
-			my_file.close
-		else
-			fileObj = file
-		end
-
-		# for testing parameters
-		# puts 'reader: ' + options[:reader]
-		# puts 'writer: ' + options[:writer]
-		# puts 'validation level: ' + options[:validate]
-		# puts 'showAllTags: ' + options[:showAllTags].to_s
-		# puts 'message format: ' + options[:messages]
-		# puts 'return object format: ' + options[:returnObject]
-		# require 'pp'
-		# pp fileObj
-
-		# call mdtranslator
-		mdReturn = ADIWG::Mdtranslator.translate(fileObj, options[:reader], options[:writer],
-												 options[:validate], options[:showAllTags])
-
-		# determine return content and type of return ...
-		if mdReturn[:readerStructurePass] && mdReturn[:readerValidationPass]
-
-			# no problem was found with the input file
-			if options[:writer].nil?
-				# if no writer was specified the input was being validated only,
-				# ...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
-					return
-				else
-					$stdout.write 'Success'
-					return
-				end
-			else
-				# a writer was specified,
-				# output is expected from the translator's writer
-				if mdReturn[:writerPass]
-				    # writer output was generated
-					# ...return the writer output in its native format unless json was requested
-					if options[:returnObject]
-						$stdout.write mdReturn.to_json
-						return
-					else
-						$stdout.write 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
-						return
-					else
-						# build a string with messages issues from parser and validator
-						s = ''
-						s += "Failed\n"
-						s += "Writer failed to generate output or issued significant warnings\n"
-						s += "See following messages for further information\n"
-
-						# post structure messages
-						i = 0
-						mdReturn[:writerMessages].each do |message|
-							i += 1
-							s += "\nMessage: #{i}\n"
-							s += message + "\n"
-						end
-
-						$stdout.write s
-						return
-
-					end
-				end
-			end
-
-		else
-
-			# problems were found with the input file
-
-			# if no writer was specified the input was being validated only,
-			# ...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
-				return
-			else
-				# build a string with messages issues from parser and validator
-				s = ''
-				s += "Failed\n"
-				s += "Input failed to pass either file structure validation or content does not match schema\n"
-				s += "See following messages for further information\n"
-
-				# post structure messages
-				if mdReturn[:readerStructurePass]
-					s += "Success - Input structure is valid\n"
-				else
-					s += "Fail - Structure of input file is invalid - see following message(s):\n"
-					i = 0
-					mdReturn[:readerStructureMessages].each do |message|
-						i += 1
-						s += "\nMessage: #{i}\n"
-						s += message.to_s + "\n"
-					end
-				end
-
-				# post validator messages
-				unless mdReturn[:readerValidationPass].nil?
-					if mdReturn[:readerValidationPass]
-						s += "Success - Input content passes schema definition\n"
-					else
-						s += "Fail - Input content did not pass schema validation - see following message(s):\n"
-						i = 0
-						mdReturn[:readerValidationMessages].each do |message|
-							i += 1
-							s += "\nMessage: #{i}\n"
-							s += message.to_s + "\n"
-						end
-					end
-				end
-
-				$stdout.write s
-				return
-
-			end
-		end
-
-	end
-
-	desc 'version', %q{Returns the version of mdTranslator}
-	long_desc <<-LONGDESC
-		'mdtranslator version' returns the version number for mdTranslator
-	LONGDESC
-	def version
-		$stdout.write ADIWG::Mdtranslator::VERSION
-	end
-
-	Mdtranslator.start(ARGV)
-
-end