relaton-cli 1.1.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57f7abf09dc691dbeca299fe1960057c040778da128d45b5cff25748c8442f72
-  data.tar.gz: 39520c2293ea0f938ba81acfe13b5def8cd505bf3d6a0bf0e4c8d2ff2ec90beb
+  metadata.gz: d13fa9104c78c2a9bf1124ad4d191964c8aa6e0932be1984f21c0e1e0375daea
+  data.tar.gz: caceceb02f288b9993a76bb5d70cb0299cd2157e1740f4351f40b083bba4e84e
 SHA512:
-  metadata.gz: 8efa168c29a5d1a6f49142e19d86a24f3e2ad26afb97f8126e2104f14eb86276d8e0a778bc58ff328f542d4579776ddd925d130a406c959616ece08a0a997583
-  data.tar.gz: 75aedff7abac327dfe3b7d0abd9948fba5447e326a887dc06f0fe8fbc1b247797303193e788e13c7330f2c6b6ad0febd2f8752701b363e411f69ee34c28e35be
+  metadata.gz: 19b8d69c34993fc76054bcf8e331a381f776b5da305d3936aa337a55b3ad2442d2cf493fcfa237e4da8b737debd1512c4965c6354fe12db4a40bcc5ee2487d1b
+  data.tar.gz: fec32e6be810a25db230c86f3946a0e9409103a1e7013c5ea73ee9b2ecea75274d420d53b77a2670b067459aecf96f8977c4e2f19332da4086e44dec8790f820

data/docs/README.adoc

@@ -209,3 +209,11 @@ $ relaton yaml2html YAML [<stylesheet>] [<liquid-template-dir>]
 
 Render a Relaton YAML file (`filename.yaml`) as an HTML file. The `stylesheet` and `liquid-template-dir` directories are as for <<relaton-xml2html,relaton xml2html>>.
 
+=== relaton convert
+
+[source,conxole]
+----
+$ relaton convert XML -f FORMAT -o OUTPUT-FILE
+----
+
+Convert a Relaton XML document into YAML, AsciiBib, or BibTex format. Allowed -f or --format options are yaml, asciibib, bibtex. If the option -o or --output is omitted then a new file will be created in the folder where the original file is, with the same name but another appropriated extension.

data/exe/relaton

@@ -18,4 +18,3 @@ end
 require "relaton/cli"
 
 Relaton::Cli.start(ARGV)
-

data/lib/relaton/bibdata.rb

@@ -42,7 +42,7 @@ module Relaton
 
     def to_xml(opts = {})
       options = { bibdata: true, date_format: :full }.merge(
-        opts.select { |k, _v| k.is_a? Symbol },
+        opts.select { |k, _v| k.is_a? Symbol }
       )
       @bibitem.to_xml nil, **options
     end

data/lib/relaton/cli.rb

@@ -34,20 +34,22 @@ module Relaton
     # @param content [Nokogiri::XML::Document]
     # @return [RelatonBib::BibliographicItem, RelatonIsoBib::IsoBibliongraphicItem]
     def self.parse_xml(doc)
-      if (processor = Relaton::Registry.instance.by_type(Relaton::Cli.doctype(doc)))
-        processor.from_xml(doc.to_s)
+      if (proc = Cli.processor(doc))
+        proc.from_xml(doc.to_s)
       else
         RelatonBib::XMLParser.from_xml(doc.to_s)
       end
     end
 
-    # @param content [Nokogiri::XML::Document] Document
+    # @param doc [Nokogiri::XML::Element]
     # @return [String] Type prefix
-    def self.doctype(doc)
+    def self.processor(doc)
       docid = doc.at "docidentifier"
-      return docid[:type] if docid && docid[:type]
-
-      docid&.text&.match(/^\w+/)&.to_s
+      if docid && docid[:type]
+        proc = Relaton::Registry.instance.by_type(docid[:type])
+        return proc if proc
+      end
+      Relaton::Registry.instance.by_type(docid&.text&.match(/^\w+/)&.to_s)
     end
   end
 end

data/lib/relaton/cli/base_convertor.rb

@@ -39,7 +39,7 @@ module Relaton
           file,
           style: style || File.join(File.dirname(__FILE__), "../../../templates/index-style.css"),
           template: template || File.join(File.dirname(__FILE__), "../../../templates/"),
-          extension: "html",
+          extension: "html"
         ).to_html
       end
 
@@ -91,13 +91,6 @@ module Relaton
       end
 
       def write_to_file_collection(content, format)
-        # if outdir && (content.is_a?(Relaton::Bibcollection))
-        #   FileUtils.mkdir_p(outdir)
-        #   content.items_flattened.each do |item|
-        #     collection = collection_filename(item.docidentifier_code)
-        #     write_to_a_file(item_output(item, format), collection)
-        #   end
-        # end
         if outdir && content.is_a?(Relaton::Bibcollection)
           FileUtils.mkdir_p(outdir)
           content.items_flattened.each do |item|

data/lib/relaton/cli/command.rb

@@ -45,7 +45,7 @@ module Relaton
       desc "yaml2xml YAML", "Convert Relaton YAML into Relaton Collection XML or separate files"
       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 :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"
       option :overwrite, aliases: :f, type: :boolean, default: false, desc: "Overwrite the existing file"
 
@@ -53,7 +53,7 @@ module Relaton
         Relaton::Cli::YAMLConvertor.to_xml(filename, options)
       end
 
-      desc "xml2yamlnew XML", "Convert Relaton XML into Relaton Bibdata / Bibcollection YAML (and separate files)"
+      desc "xml2yaml XML", "Convert Relaton XML into Relaton Bibdata / Bibcollection YAML (and separate files)"
       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"
@@ -82,6 +82,25 @@ module Relaton
         Relaton::Cli::YAMLConvertor.to_html(file, style, template)
       end
 
+      desc "convert XML", "Convert Relaton XML document"
+      option :format, aliases: :f, required: true, desc: "Output format (yaml, bibtex, asciibib)"
+      option :output, aliases: :o, desc: "Output to the specified file"
+
+      def convert(file)
+        item = Relaton::Cli.parse_xml Nokogiri::XML(File.read(file, encoding: "UTF-8"))
+        result = if /yaml|yml/.match?(options[:format])
+                   item.to_hash.to_yaml
+                 else item.send "to_#{options[:format]}"
+                 end
+        ext = case options[:format]
+              when "bibtex" then "bib"
+              when "asciibib" then "adoc"
+              else options[:format]
+              end
+        output = options[:output] || file.sub(/(?<=\.)[^\.]+$/, ext)
+        File.write output, result, encoding: "UTF-8"
+      end
+
       private
 
       # @param code [String]

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "1.1.3".freeze
+    VERSION = "1.4.0".freeze
   end
 end

data/lib/relaton/cli/yaml_convertor.rb

@@ -9,23 +9,49 @@ module Relaton
         if writable
           convert_and_write(file_content, :to_xml)
         else
-          convert_content(file_content).to_xml(date_format: :full, bibdata: true)
+          convert_content(file_content).to_xml date_format: :full, bibdata: true
         end
       end
 
-      # Convert to XML
-      #
-      # This interface allow us to convert any YAML file to XML.
-      # It only require us to provide a valid YAML file and it can
-      # do converstion using default attributes, but it also allow
-      # us to provide custom options to customize this converstion
-      # process.
-      #
-      # @param file [File] The complete path to a YAML file
-      # @param options [Hash] Options as hash key, value pairs.
-      #
-      def self.to_xml(file, options = {})
-        new(file, options).to_xml
+      class << self
+        # Convert to XML
+        #
+        # This interface allow us to convert any YAML file to XML.
+        # It only require us to provide a valid YAML file and it can
+        # do converstion using default attributes, but it also allow
+        # us to provide custom options to customize this converstion
+        # process.
+        #
+        # @param file [File] The complete path to a YAML file
+        # @param options [Hash] Options as hash key, value pairs.
+        #
+        def to_xml(file, options = {})
+          new(file, options).to_xml
+        end
+
+        # @param content [Hash] document in YAML format
+        # @return [RelatonBib::BibliographicItem,
+        #   RelatonIso::IsoBiblioraphicItem]
+        def convert_single_file(content)
+          if (processor = Registry.instance.by_type(doctype(content["docid"])))
+            processor.hash_to_bib content
+          else
+            RelatonBib::BibliographicItem.new(
+              RelatonBib::HashConverter::hash_to_bib(content)
+            )
+          end
+        end
+
+        private
+
+        # @param content [Hash]
+        # @return [String]
+        def doctype(docid)
+          did = docid.is_a?(Array) ? docid.fetch(0) : docid
+          return unless did
+
+          did["type"] || did.fetch("id")&.match(/^\w+/)&.to_s
+        end
       end
 
       private
@@ -39,35 +65,23 @@ module Relaton
       end
 
       def date_to_string(obj)
-        obj.is_a? Hash and
-          return obj.inject({}){|memo,(k,v)| memo[k] = date_to_string(v); memo}
-        obj.is_a? Array and
-          return obj.inject([]){|memo,v    | memo      << date_to_string(v); memo}
-        return obj.is_a?(Date) ? obj.to_s : obj
-      end
-
-      def convert_single_file(content)
-        if (processor = Relaton::Registry.instance.by_type(doctype(content["docid"])))
-          processor.hash_to_bib content
+        if obj.is_a? Hash
+          obj.reduce({}) do |memo, (k, v)|
+            memo[k] = date_to_string(v)
+            memo
+          end
+        elsif obj.is_a? Array
+          obj.reduce([]) { |memo, v| memo << date_to_string(v) }
         else
-          RelatonBib::BibliographicItem.new(RelatonBib::HashConverter::hash_to_bib(content))
+          obj.is_a?(Date) ? obj.to_s : obj
         end
       end
 
-      # @param content [Hash]
-      # @return [String]
-      def doctype(docid)
-        did = docid.is_a?(Array) ? docid.fetch(0) : docid
-        return did["type"] if did && did["type"]
-
-        did&.fetch("id")&.match(/^\w+/)&.to_s
-      end
-
       def convert_collection(content)
         if content.has_key?("root")
           content["root"]["items"] = content["root"]["items"].map do |i|
             # RelatonBib::HashConverter::hash_to_bib(i)
-            convert_single_file(i)
+            self.class.convert_single_file(i)
           end
           Relaton::Bibcollection.new(content["root"])
         end
@@ -78,7 +92,7 @@ module Relaton
       end
 
       def convert_content(content)
-        convert_collection(content) || convert_single_file(content)
+        convert_collection(content) || self.class.convert_single_file(content)
       end
     end
   end

data/relaton-cli.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 2.4.0"
 
-  spec.add_development_dependency "byebug", "~> 10.0"
+  spec.add_development_dependency "byebug", "~> 11.0"
   spec.add_development_dependency "debase"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "pry"
@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
 
   spec.add_runtime_dependency "liquid"
-  spec.add_runtime_dependency "relaton", "~> 1.1.0"
+  spec.add_runtime_dependency "relaton", "~> 1.4.0"
   spec.add_runtime_dependency "thor"
   # spec.add_runtime_dependency 'byebug'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-cli
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: debase
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -239,7 +239,7 @@ homepage: https://github.com/metanorma/relaton-cli
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -255,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Relaton Command-line Interface
 test_files: []