adiwg-mdtranslator 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d4626d73ad3ea1e96257b5c2437c4215fe965c2
-  data.tar.gz: 82375f7932a14fa89aa68142a78956968c62dd44
+  metadata.gz: 0c9c38bce8eb28f8f717ca37d09e30519bbef40d
+  data.tar.gz: 85551feb2d6388a9debe63352b6bcd38d209d4f5
 SHA512:
-  metadata.gz: e9bd03f3a70e9d8bee7922827b73c2beeba00bc1047c85f226c0207e3ef3e296bea0c1102ca05543b7c65e715a8b8bdacf79963ff8c28614949c052d8d8fa08d
-  data.tar.gz: c474ef2684cf0fda1431c8e369c91362485eec31a27a8f5dcd49311f194d9a161c8a67be36360731b9267fd2a761164ad561298385d8ee1b1d921aa94bfec982
+  metadata.gz: c3c61a184344ed5340fad65398fac03bd5efb7f8e1f368a20717a3931d9bd4c0d784e7283d57473b72d0580ff8789b0fc157930bc061b49d9da3f9c644d6639c
+  data.tar.gz: 6027a62b7c3116e947c32dc6dbd9602243fc7748ecf5c3a9d228da28acd183228850ad1885ba5d26c79d3cd510e043ca1925ed8efd629ae8203603a6816e3af2

data/README.md

@@ -1,15 +1,15 @@
 [![Build Status](https://travis-ci.org/adiwg/mdTranslator.svg?branch=master)](https://travis-ci.org/adiwg/mdTranslator)
 [![Gem Version](https://badge.fury.io/rb/adiwg-mdtranslator.svg)](http://badge.fury.io/rb/adiwg-mdtranslator)
 
-# Mdtranslator
+# mdTranslator
 
-TODO: Write a gem description
+mdtranslator was written by the [Alaska Data Integration Working Group](http://www.adiwg.org) (ADIwg) to assist with creating ISO 19139 metadata records.  Input to the mdtranslator is JSON conforming to the [mdJson-schemas](https://github.com/adiwg/mdJson-schemas).  The mdtranslator architecture allows developers to write additional readers for other input formats and/or write additional writers for other output other than ISO 19139, e.g. HTML.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'mdtranslator'
+    gem 'adiwg-mdtranslator'
 
 And then execute:
 
@@ -17,15 +17,15 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install mdtranslator
+    $ gem install adiwg-mdtranslator
 
-## Usage
+## CLI Usage
 
-TODO: Write usage instructions here
+    $ mdtranslator help translate
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/mdtranslator/fork )
+1. Fork it ( https://github.com/[my-github-username]/mdTranslator/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -4,8 +4,7 @@ require 'rake/testtask'
 Rake::TestTask.new do |t|
 	t.libs << 'test'
 	t.test_files = FileList[
-		'test/readers/mdJson/v1_0/tc*.rb',
-		'test/writers/iso19115_2/tc*.rb',
+		'test/readers/mdJson/v1/tc*.rb'
 	]
 	t.verbose = true
 end

data/adiwg-mdtranslator.gemspec

@@ -5,32 +5,32 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'adiwg/mdtranslator/version'
 
 Gem::Specification.new do |spec|
-	spec.name          = "adiwg-mdtranslator"
-	spec.version       = ADIWG::Mdtranslator::VERSION
-	spec.authors       = ["Stan Smith", "Josh Bradley"]
-	spec.email         = ["stansmith@usgs.gov", "joshua_bradley@fws.gov"]
-	spec.summary       = %q{The mdtranslator (metadata translator) is a tool for translating metadata in one format to another. The tool is written and maintained by the Alaska Data Integration Working Group (ADIwg).}
-	spec.description   = %q{The mdtranslator was written by the Alaska Data Integration Working Group (ADIwg) to assist with creating ISO 19139 metadata records.  Input to the mdtranslator is JSON conforming to the mdJson-schema.  The mdtranslator architecture allows developers to write additional readers for other input formats and/or write additional writers for other output other than ISO 19139.}
-	spec.homepage      = "http://www.adiwg.org/mdTranslator"
-	spec.license       = "UNLICENSED"
+    spec.name = "adiwg-mdtranslator"
+    spec.version = ADIWG::Mdtranslator::VERSION
+    spec.authors = ["Stan Smith", "Josh Bradley"]
+    spec.email = ["stansmith@usgs.gov", "joshua_bradley@fws.gov"]
+    spec.summary = %q{The mdtranslator (metadata translator) is a tool for translating metadata in one format to another. The tool is written and maintained by the Alaska Data Integration Working Group (ADIwg).}
+    spec.description = %q{The mdtranslator was written by the Alaska Data Integration Working Group (ADIwg) to assist with creating ISO 19139 metadata records.  Input to the mdtranslator is JSON conforming to the mdJson-schema.  The mdtranslator architecture allows developers to write additional readers for other input formats and/or write additional writers for other output other than ISO 19139.}
+    spec.homepage = "http://www.adiwg.org/mdTranslator"
+    spec.license = "UNLICENSED"
 
-	spec.files         = %x(git ls-files).split($/)
-	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-	spec.test_files    = spec.files.grep(%r{^(tc|test|spec|features)/})
-	spec.require_paths = ["lib"]
+    spec.files = %x(git ls-files).split($/)
+    spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+    spec.test_files = spec.files.grep(%r{^(tc|test|spec|features)/})
+    spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.1'
+    spec.required_ruby_version = '>= 2.1'
 
-	spec.add_development_dependency "bundler", "~> 1"
-	spec.add_development_dependency "rake", "~> 10"
-	spec.add_development_dependency "minitest", "~> 5"
+    spec.add_development_dependency "bundler", "~> 1"
+    spec.add_development_dependency "rake", "~> 10"
+    spec.add_development_dependency "minitest", "~> 5"
 
-	spec.add_runtime_dependency "json", "~> 1.8"
-	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.0", "< 2.5.0"
-	spec.add_runtime_dependency "adiwg-mdjson_schemas", "~> 1.0.0"
-  spec.add_runtime_dependency "adiwg-mdcodes", "~> 1.0"
+    spec.add_runtime_dependency "json", "~> 1.8"
+    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.0", "< 2.5.0"
+    spec.add_runtime_dependency "adiwg-mdjson_schemas", "~> 1.0"
+    spec.add_runtime_dependency "adiwg-mdcodes", "~> 1.0"
 
 end

data/bin/mdtranslator

@@ -7,173 +7,205 @@
 #   Stan Smith 2014-09-21 coded cli to 0.8.0 api
 #   Stan Smith 2014-10-09 added version command to the CLI
 #   Stan Smith 2014-12-29 changed default reader from adiwgJson to mdJson
-#   Stan Smith 2015-01-15 changed translate method to use keyword arguments
+#   Stan Smith 2014-01-16 changed ADIWG::Mdtranslator.translate() to keyword parameter list
+#   Stan Smith 2015-07-17 added method_options to provide custom CSS
 
 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 => 'Reader to read your input metadata file', :enum => %w{mdJson}, :required => true
-	method_option :writer, :aliases => '-w', :desc => 'Writer to create your output metadata file, leave blank to validate input only', :enum => %w{iso19115_2 iso19110 html}
-	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
-
-		# call mdtranslator
+    # 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, mdTranslator.  The 'translate'
+method converts input metadata to supported established metadata metadata formats.  The CLI accepts an input metadata
+file with options to select the input reader format, writer output format, display empty tags
+in XML outputs, and choose level of validation for mdJson input files.
+    LONGDESC
+    # define cli options
+    method_option :reader, :aliases => '-r', :desc => 'Reader to read your input metadata file', :enum => %w{mdJson}, :required => true
+    method_option :writer, :aliases => '-w', :desc => 'Writer to create your output metadata file, leave blank to validate input only', :enum => %w{iso19115_2 iso19110 html}
+    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
+    method_option :cssLink, :desc => 'Fully qualified link to a CSS file to customize HTML writer output', :type => :string
+    method_option :css, :desc => 'Local CSS file or inline CSS to customize HTML writer output', :type => :string
+
+    # accept command and options
+    def translate(file)
+
+        # test to see if file parameter is a local file name
+        # if not ... assumed it is a JSON string
+        # note: this will need to be modified if/when a reader is added that is not in JSON format
+        if File.exist?(file)
+            # read file
+            my_file = File.open(file, 'r')
+            fileObj = my_file.read
+            my_file.close
+        else
+            fileObj = file
+        end
+
+        # test to see if css parameter is a local file name
+        # if not ... assumed it is a css string
+        css = options[:css]
+        if css
+            if File.exist?(css)
+                # read file
+                my_file = File.open(css, 'r')
+                cssObj = my_file.read
+                my_file.close
+            else
+                cssObj = css
+            end
+        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: ' + options[:returnObject].to_s
+        # puts 'css link: ' + options[:cssLink]
+        # puts 'css: ' + options[:css]
+
+        # call mdtranslator
         mdReturn = ADIWG::Mdtranslator.translate(
             file: fileObj,
             reader: options[:reader],
             writer: options[:writer],
             validate: options[:validate],
-            showAllTags: 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.puts mdReturn.to_json
-					return
-				else
-					$stdout.puts '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.puts mdReturn.to_json
-						return
-					else
-						$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.puts 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.puts 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.puts 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.puts s
-				return
-
-			end
-		end
-
-	end
-
-	desc 'version', %q{Returns the version of mdTranslator}
-	long_desc <<-LONGDESC
+            showAllTags: options[:showAllTags],
+            css: cssObj,
+            cssLink: options[:cssLink])
+
+        # 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.puts ADIWG::Mdtranslator::VERSION
-	end
+    LONGDESC
 
-	Mdtranslator.start(ARGV)
+    def version
+        $stdout.write ADIWG::Mdtranslator::VERSION
+    end
+
+    Mdtranslator.start(ARGV)
 
 end