relaton-cli 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5637628f30aa3ee97df157962f423f0d3992dfe966e15222e2cd50998e6b9b5c
-  data.tar.gz: 39663cab86fc754ea8f87c57e586d903f6b08fb1b9766c886a582172b6d617a7
+  metadata.gz: dbb153837a43075460f32bbcc33fa18460868365f699dd6e2da57c01e1039066
+  data.tar.gz: 325431872002258b6d6f1d6d8f2c5ebfc674aadb06c8e08b23f08ed7031fe4ac
 SHA512:
-  metadata.gz: 6ac24bc52c30e2d684e9a5d51918d4f06dfa03f6c53bdfb341a1ed64773f4f3ee3fad392f5c72c6a522c7cff6d11203b30397df934bfe72afb9a53c8a65ef0aa
-  data.tar.gz: 55e966af337a8b38001366d7545778b712b94441a989e62cedf750d1ce7776e75368c55c0f7b631f55efe0f2824c707dc741b4adbf66e1ae5c99fabc3e1030a2
+  metadata.gz: 4b5d7221bf4951d058774df317617437de75648bfa1a5d720d2e130ab1df2f0ec503247a279ef0ee291603271282f69c866750d19406a1eca3e3010bb50b01c5
+  data.tar.gz: 40e035f13365c7664a7ebae2dd1ab302e264ab85cfa5b69e5a4c2210d257210c12f6b1639932a04e9a588e7f6076e4de926ee2821cbccf89340ce89661f0fdc0

data/docs/README.adoc

@@ -1,35 +1,33 @@
 = Relaton CLI (relaton-cli): Relaton Command-line Interface
 
 image:https://img.shields.io/gem/v/relaton-cli.svg["Gem Version", link="https://rubygems.org/gems/relaton-cli"]
-image:https://img.shields.io/travis/metanorma/relaton-cli/master.svg["Build Status", link="https://travis-ci.org/metanorma/relaton-cli"]
-image:https://ci.appveyor.com/api/projects/status/fyy87flpig4q5o2u?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/ribose/relaton-cli"]
+image:https://github.com/relaton/relaton-cli/workflows/ubuntu/badge.svg["Build Status", link="https://github.com/relaton/relaton-cli/actions?workflow=ubuntu"]
+image:https://github.com/relaton/relaton-cli/workflows/macos/badge.svg["Build Status", link="https://github.com/relaton/relaton-cli/actions?workflow=macos"]
+image:https://github.com/relaton/relaton-cli/workflows/windows/badge.svg["Build Status", link="https://github.com/relaton/relaton-cli/actions?workflow=windows"]
 image:https://codeclimate.com/github/metanorma/relaton-cli/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/relaton-cli"]
 
 Documentation in development.
 
-Please refer to https://github.com/metanorma/relaton.
+Please refer to https://github.com/relaton/relaton.
 
-== Executables
+== Commands
 
-The following executables are included:
+The following commands are provided.
 
 === relaton concatenate
 
 [source,console]
 ----
-$ relaton concatenate Source-Directory Collection-File -t TITLE -g ORGANIZATION -n
+$ relaton concatenate Source-Directory Relaton-Collection-File -t TITLE -g ORGANIZATION -n
 ----
 
-Iterates through all the Relaton YAML files in `Source-Directory`, and converts them in-place into Relaton XML.
+Iterates through all the Relaton files (YAML and XML) in `Source-Directory`, and concatenates them into a Relaton Collection file. The extension of the Collection file can be set using the `Relaton-Collection-File` file name (i.e, if it uses an extension of `yaml`, a Relaton YAML file will be created; if `rxl`, a Relaton XML file will be created, or via the `-x [ext]` (or `--extension`) option.
 
-Iterates through all the Relaton XML files in `Source-Directory` (including those just converted from Relaton YAML),
-and outputs to `Collection-File` a `relaton-collection` document containing all the Relaton XML objects read in.
-
-For each Relaton XML file, if a document file with the same base name is identified (i.e. an XML, HTML, PDF or DOC
+For each Relaton input file in the `Source-Directory`, if a document file with the same base name is identified (i.e. an XML, HTML, PDF or DOC
 file), a link to that file is inserted.
 
 If the `TITLE` or `ORGANIZATION` options are given, they are added to the `Collection-File` output as the
-title and author of the `relaton-collection` document.
+title and author of the `Relaton-Collection-File` document.
 
 If the `-n` or `--new` option given then use the new Relaton YAML format https://github.com/relaton/relaton-bib/blob/master/docs/hash.adoc.
 
@@ -37,11 +35,11 @@ If the `-n` or `--new` option given then use the new Relaton YAML format https:/
 
 [source,console]
 ----
-$ relaton split Collection-File Relaton-File-Directory -x rxl -n
+$ relaton split Relaton-Collection-File Relaton-File-Directory -x rxl -n
 ----
 
 Splits a `Relaton-Collection-File` into multiple files in the `Relaton-File-Directory`, and it also
-suports an addional `extension` options to use different extension.
+suports an additional `-x` or `--extension` options to use different extension.
 
 If the `-n` or `--new` option given then use the new Relaton YAML format https://github.com/relaton/relaton-bib/blob/master/docs/hash.adoc.
 
@@ -217,9 +215,9 @@ Render a Relaton YAML file (`filename.yaml`) as an HTML file. The stylesheet and
 $ relaton yaml2xmlnew <filename.yaml> -o OUTPUT-DIRECTORY -x RELATON_EXTENSION -p PREFIX -r LIBRARY
 ----
 
-Convert a Relaton YAML file (`filename.yaml`) in a new format into a Relaton XML file (`filename.xml`). If the Relaton YAML file specifies multiple bibliograph items, and `OUTPUT-DIRECTORY` is nominated, also convert the file into a list of Relaton XML files for each entry, stored in that directory. The document identifier is used as the name of each Relaton XML file; the Relaton XML filename is suffixed with `RELATON_EXTENSION` (default `.rxl`) and prefixed with `PREFIX` (default empty). Any libraries that need to be required for the conversion are specified in `LIBRARY` as a space-delimited list.
+Convert a Relaton YAML file (`filename.yaml`) in a new format into a Relaton XML file (`filename.xml`). If the Relaton YAML file specifies multiple bibliographic items, and `OUTPUT-DIRECTORY` is nominated, also convert the file into a list of Relaton XML files for each entry, stored in that directory. The document identifier is used as the name of each Relaton XML file; the Relaton XML filename is suffixed with `RELATON_EXTENSION` (default `.rxl`) and prefixed with `PREFIX` (default empty). Any libraries that need to be required for the conversion are specified in `LIBRARY` as a space-delimited list.
 
-A Relaton Colleciton YAML file contains some initial metadata, and a list of metadata about each bibliographic entry:
+A Relaton Collection YAML file contains some initial metadata, and a list of metadata about each bibliographic entry:
 
 [source,yaml]
 ----
@@ -228,11 +226,11 @@ root:
   title: CalConnect Standards Registry
   items:
     - technical_committee: PUBLISH
-      docid: 
+      docid:
         type: CC
         id: CC 36000
       type: standard
-      title: 
+      title:
         type: main
         content: Standardization documents -- Vocabulary
       docstatus:
@@ -241,11 +239,11 @@ root:
         type: issued
         value:  2018-10-25
     - technical_committee: DATETIME
-      docid: 
+      docid:
         type: CC
         id: CC 34000
       type: standard
-      title: 
+      title:
         type: main
         content: Date and time -- Concepts and vocabulary
       docstatus:
@@ -255,7 +253,7 @@ root:
         value: 2018-10-25
 ----
 
-A Relaton YAML file describing an individual bibliographic entry is limited to metadata specific to that entry. Flavor gems have aditional fields. The following illustrates the common fields supported by all flavor gems (see link:https://github.com/relaton/relaton-bib/blob/master/docs/hash.adoc#yaml[Relaton YAML]):
+A Relaton YAML file describing an individual bibliographic entry is limited to metadata specific to that entry. Flavor gems have additional fields. The following illustrates the common fields supported by all flavor gems (see link:https://github.com/relaton/relaton-bib/blob/master/docs/hash.adoc#yaml[Relaton YAML]):
 
 [source,yaml]
 ----
@@ -470,4 +468,5 @@ Convert a Relaton XML file (`filename.xml` or `filename.rxl`) into a Relaton YAM
 $ relaton yaml2xmlnew <filename.yaml> [<stylesheet>] [<liquid-template-dir>]
 ----
 
-Render a Relaton YAML file in a new format (`filename.yaml`) as an HTML file. The `stylesheet` and `liquid-template-dir` directories are as for <<relaton xml2html,relaton xml2html>>.
+Render a Relaton YAML file in a new format (`filename.yaml`) as an HTML file. The `stylesheet` and `liquid-template-dir` directories are as for <<relaton xml2html,relaton xml2html>>.
+

data/lib/relaton/cli/command.rb

@@ -19,7 +19,7 @@ module Relaton
       end
 
       desc "extract Metanorma-XML-File / Directory Relaton-XML-Directory", "Extract Relaton XML from Metanorma XML file / directory"
-      option :extension, aliases: :x, desc: "File extension of Relaton XML files, defaults to 'rxl'"
+      option :extension, aliases: :x, default: "rxl", desc: "File extension of Relaton XML files, defaults to 'rxl'"
 
       def extract(source_dir, outdir)
         Relaton::Cli::RelatonFile.extract(source_dir, outdir, options)
@@ -29,13 +29,14 @@ module Relaton
       option :title, aliases: :t,  desc: "Title of resulting Relaton collection"
       option :organization, aliases: :g, desc: "Organization owner of Relaton collection"
       option :new, aliases: :n, type: :boolean, desc: "Use the new Relaton YAML format"
+      option :extension, aliases: :x, default: "rxl", desc: "File extension of destination Relaton file, defaults to 'rxl'"
 
       def concatenate(source_dir, outfile)
         Relaton::Cli::RelatonFile.concatenate(source_dir, outfile, options)
       end
 
       desc "split Relaton-Collection-File Relaton-XML-Directory", "Split a Relaton Collection into multiple files"
-      option :extension, aliases: :x, desc: "File extension of Relaton XML files, defaults to 'rxl'"
+      option :extension, aliases: :x, default: "rxl", desc: "File extension of Relaton XML files, defaults to 'rxl'"
       option :new, aliases: :n, type: :boolean, desc: "Use the new Relaton YAML format"
 
       def split(source, outdir)
@@ -43,7 +44,7 @@ module Relaton
       end
 
       desc "yaml2xml YAML", "Convert Relaton YAML into Relaton Collection XML or separate files"
-      option :extension, aliases: :x, desc: "File extension of Relaton XML files, defaults to 'rxl'"
+      option :extension, aliases: :x, default: "rxl", desc: "File extension of Relaton XML files, defaults to 'rxl'"
       option :prefix, aliases: :p, desc: "Filename prefix of individual Relaton XML files, defaults to empty"
       option :outdir, aliases: :o,  desc: "Output to the specified directory with individual Relaton Bibdata XML files"
       option :require, aliases: :r, type: :array, desc: "Require LIBRARY prior to execution"
@@ -54,7 +55,7 @@ module Relaton
       end
 
       desc "yaml2xmlnew YAML", "Convert Relaton YAML into Relaton Collection XML or separate files"
-      option :extension, aliases: :x, desc: "File extension of Relaton XML files, defaults to 'rxl'"
+      option :extension, aliases: :x, default: "rxl", desc: "File extension of Relaton XML files, defaults to 'rxl'"
       option :prefix, aliases: :p, desc: "Filename prefix of individual Relaton XML files, defaults to empty"
       option :outdir, aliases: :o,  desc: "Output to the specified directory with individual Relaton Bibdata XML files"
       option :require, aliases: :r, type: :array, desc: "Require LIBRARY prior to execution"
@@ -65,7 +66,7 @@ module Relaton
       end
 
       desc "xml2yaml XML", "Convert Relaton XML into Relaton Bibdata / Bibcollection YAML (and separate files)"
-      option :extension, aliases: :x, desc: "File extension of Relaton YAML files, defaults to 'yaml'"
+      option :extension, aliases: :x, default: "yaml", desc: "File extension of Relaton YAML files, defaults to 'yaml'"
       option :prefix, aliases: :p, desc: "Filename prefix of Relaton XML files, defaults to empty"
       option :outdir, aliases: :o, desc: "Output to the specified directory with individual Relaton Bibdata YAML files"
       option :require, aliases: :r, type: :array, desc: "Require LIBRARY prior to execution"
@@ -76,7 +77,7 @@ module Relaton
       end
 
       desc "xml2yamlnew XML", "Convert Relaton XML into Relaton Bibdata / Bibcollection YAML (and separate files)"
-      option :extension, aliases: :x, desc: "File extension of Relaton YAML files, defaults to 'yaml'"
+      option :extension, aliases: :x, default: "yaml", desc: "File extension of Relaton YAML files, defaults to 'yaml'"
       option :prefix, aliases: :p, desc: "Filename prefix of Relaton XML files, defaults to empty"
       option :outdir, aliases: :o, desc: "Output to the specified directory with individual Relaton Bibdata YAML files"
       option :require, aliases: :r, type: :array, desc: "Require LIBRARY prior to execution"

data/lib/relaton/cli/relaton_file.rb

@@ -16,7 +16,7 @@ module Relaton
       end
 
       def concatenate
-        write_to_file(bibcollection.to_yaml)
+        concatenate_and_write_to_files
       end
 
       def split
@@ -128,7 +128,7 @@ module Relaton
           bibdata = Relaton::Bibdata.from_xml(bib.root)
           build_bibdata_relaton(bibdata, file)
 
-          write_to_file(bibdata.to_xml, outdir, build_filename(file))
+          write_to_file(bibdata.send(output_type), outdir, build_filename(file))
         end
       end
 
@@ -147,6 +147,10 @@ module Relaton
         end.compact
       end
 
+      def concatenate_and_write_to_files
+        write_to_file(bibcollection.send(output_type))
+      end
+
       def split_and_write_to_files
         output_dir = outdir || build_dirname(source)
 
@@ -164,9 +168,16 @@ module Relaton
         end
       end
 
-      def output_type
-        output_format = options[:extension] || "rxl"
-        (output_format == "rxl" ? "to_xml" : "to_#{output_format}").to_sym
+      def output_type(ext=options[:extension])
+        case ext
+        when "rxl", "xml"
+          :to_xml
+        when "yml", "yaml"
+          :to_yaml
+        else
+          puts "The given extension of '#{ext}' is not supported."
+          :to_xml
+        end
       end
 
       def bibdata_instance(document, file)

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "0.4.2".freeze
+    VERSION = "0.4.3".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-cli
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-18 00:00:00.000000000 Z
+date: 2019-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -210,7 +210,6 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - Rakefile
 - bin/console

data/Gemfile.lock

@@ -1,128 +0,0 @@
-PATH
-  remote: .
-  specs:
-    relaton-cli (0.4.2)
-      liquid
-      relaton (~> 0.6.0)
-      thor
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    byebug (10.0.2)
-    cnccs (0.1.5)
-    coderay (1.1.2)
-    debase (0.2.3)
-      debase-ruby_core_source (>= 0.10.2)
-    debase-ruby_core_source (0.10.5)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    equivalent-xml (0.6.0)
-      nokogiri (>= 1.4.3)
-    faraday (0.17.1)
-      multipart-post (>= 1.2, < 3)
-    gb-agencies (0.0.6)
-    isoics (0.1.8)
-    json (2.2.0)
-    liquid (4.0.3)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    mixlib-shellout (2.4.4)
-    multipart-post (2.1.1)
-    nokogiri (1.10.7)
-      mini_portile2 (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (4.0.1)
-    rake (12.3.3)
-    relaton (0.6.2)
-      relaton-calconnect (~> 0.2.0)
-      relaton-gb (~> 0.7.0)
-      relaton-iec (~> 0.5.0)
-      relaton-ietf (~> 0.7.0)
-      relaton-iso (~> 0.7.0)
-      relaton-itu (~> 0.4.0)
-      relaton-nist (~> 0.4.0)
-      relaton-ogc (~> 0.2.0)
-    relaton-bib (0.4.1)
-      addressable
-      nokogiri
-    relaton-calconnect (0.2.1)
-      faraday
-      relaton-iso-bib (~> 0.4.0)
-    relaton-gb (0.7.1)
-      cnccs (~> 0.1.1)
-      gb-agencies (~> 0.0.1)
-      relaton-iso-bib (~> 0.4.0)
-    relaton-iec (0.5.1)
-      addressable
-      relaton-iso-bib (~> 0.4.0)
-    relaton-ietf (0.7.2)
-      relaton-bib (~> 0.4.0)
-    relaton-iso (0.7.1)
-      relaton-iec (~> 0.5.0)
-      relaton-iso-bib (~> 0.4.0)
-    relaton-iso-bib (0.4.1)
-      isoics (~> 0.1.6)
-      relaton-bib (~> 0.4.0)
-      ruby_deep_clone (~> 0.8.0)
-    relaton-itu (0.4.1)
-      relaton-iso-bib (~> 0.4.0)
-    relaton-nist (0.4.1)
-      relaton-bib (~> 0.4.0)
-      rubyzip
-    relaton-ogc (0.2.1)
-      faraday
-      relaton-iso-bib (~> 0.4.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-command (1.0.3)
-      mixlib-shellout (~> 2.0)
-      rspec (~> 3.2)
-      rspec-its (~> 1.2)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-its (1.3.0)
-      rspec-core (>= 3.0.0)
-      rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    ruby-debug-ide (0.7.0)
-      rake (>= 0.8.1)
-    ruby_deep_clone (0.8.0)
-    rubyzip (2.0.0)
-    simplecov (0.17.0)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thor (0.20.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug (~> 10.0)
-  debase
-  equivalent-xml (~> 0.6)
-  pry
-  rake (~> 12.0)
-  relaton-cli!
-  rspec (~> 3.0)
-  rspec-command (~> 1.0.3)
-  rspec-core (~> 3.4)
-  ruby-debug-ide
-  simplecov
-
-BUNDLED WITH
-   2.0.2