adiwg-mdtranslator 1.4.0 → 2.0.0rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d119c6964605f7bb7b8ef236fbe8a0a03e86e5ad
-  data.tar.gz: 583ea465af573e34b63d8868215ce21cd992e7a1
+  metadata.gz: 67a8fedee867819701e4bb62f5e96ae04df7d6a3
+  data.tar.gz: 619bed91c53f7421dd15154cf01f4a7ec0834a76
 SHA512:
-  metadata.gz: 2410e06a29bed072919364b995bcf8d140764058909a472d6035ec1b2e36d1426c5b6adb68540e8e6ee371511002b6960bf2c5bea7ea273e8e3a88cb6449db98
-  data.tar.gz: 1719febe4350fcf14c3cfad7a636fcfaf8279d09f42faa9d9a540f43e5917fea9d0aead9c6a8b37513e74df0c41cc651b1ae8342f21be9a539b32346cb914f8c
+  metadata.gz: a4a3f729cd405218eee0f6c29fabd6e0fc9177f9974acd8bb37f9e17a5f2112013853ef18e1cb51fd2df14d0e46087384268fa883e2f878b114d822ab7ea8eeb
+  data.tar.gz: 94e309d0cc0577bd6ca6ab5432d3d607232b6d47969c9c288b16a940269c24fdf97609832df4964a4718fa3016bc826b5550f658e28bdaa24dfc208669279a58

data/.gitmodules

@@ -1,3 +1 @@
-[submodule "test/schemas/v1_0"]
-	path = test/schemas/v1_0
-	url = https://github.com/adiwg/mdJson-schemas.git
+

data/.travis.yml

@@ -5,9 +5,10 @@ before_install: 'gem install bundler'
 rvm:
   - 2.1
   - 2.2
-  - 2.3
-  - ruby-head
+  - "2.3.3"
+  - "2.4.0"
   - jruby-head
+  - ruby-head
 matrix:
   allow_failures:
-  - rvm: rbuy-head
+    - rvm: jruby-head

data/README.md

@@ -3,9 +3,7 @@
 
 # mdTranslator
 
-# __NOTE__: This branch (1.x) only supports mdJSON versions in the 1.x series.
-
-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.
+**mdtranslator** was written by the [Alaska Data Integration Working Group](http://www.adiwg.org) (ADIwg) to assist researchers with authoring both spatial and non-spatial metadata for projects and datasets.  Input to the mdtranslator is a JSON record conforming to the [mdJson-schemas](http://mdTools.adiwg.org).  The user can request the mdTranslator to translate the mdJson input into one or more established metadata standards.  The mdTranslator currently supports translation to ISO 19115-2, ISO 19110, HTML, and mdJson 2x.  The mdTranslator part of an open source architecture toolkit that allows developers to write additional readers and/or writers as may be required.
 
 ## Installation
 

data/Rakefile

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

data/adiwg-mdtranslator.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
     spec.homepage = "http://www.adiwg.org/mdTranslator"
     spec.license = "UNLICENSED"
 
-    spec.files = %x(git ls-files).split($/)
+    spec.files = %x(git ls-files).split($/).delete_if{|f| /^test*/.match(f)}
     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"]
@@ -25,13 +25,13 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency "rake", "~> 10"
     spec.add_development_dependency "minitest", "~> 5"
 
-    spec.add_runtime_dependency "json", "~> 1.8"
+    spec.add_runtime_dependency "json", "~> 2.0"
     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"
+    spec.add_runtime_dependency "json-schema", "~> 2.7"
+    spec.add_runtime_dependency "adiwg-mdjson_schemas", ">= 2.0"
+    spec.add_runtime_dependency "adiwg-mdcodes", "~> 2.1"
     spec.add_runtime_dependency "jbuilder", "~> 2.5"
     spec.add_runtime_dependency "rgeo", "~> 0.5"
     spec.add_runtime_dependency "activesupport", "< 5"

data/bin/mdtranslator

@@ -2,210 +2,8 @@
 # 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
-#   Stan Smith 2014-12-29 changed default reader from adiwgJson to mdJson
-#   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'
+# 	Stan Smith 2017-04-22 original script
 require 'adiwg-mdtranslator'
+require_relative '../lib/adiwg/mdtranslator_cli'
 
-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, 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 sbJson}, :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 mdJson sbJson}
-    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],
-            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.write ADIWG::Mdtranslator::VERSION
-    end
-
-    Mdtranslator.start(ARGV)
-
-end
+MdtranslatorCLI.start(ARGV)