relaton-cli 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 189c177f77c4ebd844d4df2dbe9deb987d90443e3e91ff50d8ebf1a7ce8d3685
-  data.tar.gz: 73a886c43a4b0262a6f96725143a5714dae88440715122a36360e343d753ea56
+  metadata.gz: 7283d682da8a6ace042d4184849ff7007784a240498c11164a235bf6cf38e20f
+  data.tar.gz: 17c8c09ebd535f8851c487843d709077aac4a63b11cf145f97e71cccb41ea1f1
 SHA512:
-  metadata.gz: 7d7e76cfa44de6d91dc4ce1f631c68b845fa152de4ecbfa76a5deebb59e706784c0f0a5c1dea302336e153d751217e612f42c324498336390ce67891f4f773fa
-  data.tar.gz: ea44768cba9f5a88b46f03c588237d0de5fe91d0fb4952b5761236fafcabe1ec5992b921ecbd87052e3082e0f45c24ee074409825c0f32f934055ffac7eb2b93
+  metadata.gz: 29d79e044e21d3c8392fc8d28231e9b8646b227de12bb09669cf9d737d82cc6972c97cce1a0e9c291f132925805c00c3d43eb2a467e93ffbcd99185af7229504
+  data.tar.gz: 37952a6bb4ba3feb6cf88ce60a3899428e6da7686c719a6030e4fb6e851609e8c4a2279cfc333d60dae5e094cde8859f8c4f248606f2daa032b052949a6a6f35

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,13 +42,13 @@ 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
 
     def to_h
-      URL_TYPES.reduce({ items: [] }.merge(@bibitem.to_hash)) do |h, t|
+      URL_TYPES.reduce(@bibitem.to_hash) do |h, t|
         value = send t
         h[t.to_s] = value
         h

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

@@ -28,7 +28,7 @@ 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'"
+      option :extension, aliases: :x, desc: "File extension of destination Relaton file, defaults to 'rxl'"
 
       def concatenate(source_dir, outfile)
         Relaton::Cli::RelatonFile.concatenate(source_dir, outfile, options)
@@ -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/relaton_file.rb

@@ -174,14 +174,16 @@ module Relaton
         end
       end
 
-      def output_type(ext=options[:extension])
+      def output_type(ext = options[:extension])
+        ext ||= File.extname(outfile)[1..-1] if outfile
         case ext
         when "rxl", "xml"
           :to_xml
         when "yml", "yaml"
           :to_yaml
         else
-          puts "[relaton-cli] the given extension of '#{ext}' is not supported."
+          puts "[relaton-cli] the given extension of '#{ext}' is "\
+          "not supported. Use 'rxl'."
           :to_xml
         end
       end

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "1.1.2".freeze
+    VERSION = "1.3.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.3.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.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-08-21 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.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement