relaton-cli 1.2.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 123355f5af7996292e76a60dc07f46fa5593737d18b1453686a5750201d8be05
-  data.tar.gz: 2b67ff870e9111433388706fad09c93b53d1c16799745879080aa4dddbadd5f5
+  metadata.gz: 421e4a675216ae65860c59a257d87c10262528a5236e5658a59de0c22187848d
+  data.tar.gz: ee4355d9c9667991305a7ff65ce5f4f922c229fb07a5de8e9148ca27eade0a47
 SHA512:
-  metadata.gz: dab4b72334270f2e6d89a1321aa8dda62704b2098d0f992baca667c70caa0d65c72cb35d90a23e697fd57476387fd76eb06a1740acd9376c84dbb49af032de44
-  data.tar.gz: 922783e332d69cccffce0f2dc17edfe40f3f3d27697589ac41b14d04108ecd4a9db92551e57c38f6d73384f8b286ed185d61e1fc04077821ba0b2eb542095b88
+  metadata.gz: 9121a5b70e059c108d010a9b5a51355d61d505d0454cfbbff9bbe8142aee0972bf5490f9d85a96c27380feab2b618c911cd113c20b49859daec0f1bcb05a67f2
+  data.tar.gz: 65f2e8638b2802e4d72cbfdfbd7a7f378ed33fafbf9ce4d75ae1fa5863d12883c96f4450100b7e846cd5c865aea15fb28c2d9976ace0671a39abed22aa58ae26

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,9 +42,9 @@ 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
+      @bibitem.to_xml **options
     end
 
     def to_h

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.2.0".freeze
+    VERSION = "1.5.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

@@ -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.2.0"
+  spec.add_runtime_dependency "relaton", "~> 1.5.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.2.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.5.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: []