relaton-cli 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2519a76d53e13022ef3f2da8010ee1bd1667e12e614763851a7a9e0a61c41e0
-  data.tar.gz: b4e920db6ded4e1fccec77497fee98a1b9b34172ffaad33a00fb3ff69f714ce6
+  metadata.gz: d8049656d1afb46e4ba336f812b0eb6261525e64b6d127b313c03a8c5ce4c72e
+  data.tar.gz: bcfa7ebc31360fd27f2ccb2f21f1e864fc283433bdba045ff6c8e7393aabc25b
 SHA512:
-  metadata.gz: 15b49542f88b8248a9177493670c91ee60107f67c432a785bda4b9c115ffd149cf6c5f3a72363f560e35cc1d0df1bf223ef339388de65e8b84d0b8882a5bcfce
-  data.tar.gz: 24427ff9a3fb6ef259e0d0b032815cece68e87afe9d48d1acb486b59d29e898796a5ddf7decb77f3f7caaeeefa886f6d4b5158de95a78c4784eb6102474fe7b4
+  metadata.gz: 8a49edaeb34c75d64fcdb63ac642a3882086c0d994f169a0691f9f86fe27b7a1be4680f2295bbf80301b6089d76154bdfa734364ecbb2909ee0d630dd4cc616a
+  data.tar.gz: 2ead71208ec783d66af83bfcc89901d3d9da70e441d9464cb6f5f6b57838c5e5cde8bec940d4856804abe0260e60c6e30cfda9c7becec50c60a0b31fc66edf63

data/lib/relaton-cli.rb

@@ -1,4 +1,10 @@
 require_relative "relaton/bibcollection"
 require_relative "relaton/bibdata"
 require_relative "relaton/element_finder"
-require_relative "relaton/xml_document"
+# require_relative "relaton/xml_document"
+require_relative "relaton/cli/yaml_convertor"
+
+module Relaton
+  module Cli
+  end
+end

data/lib/relaton/bibcollection.rb

@@ -4,15 +4,12 @@ module Relaton
   class Bibcollection
     extend Relaton::ElementFinder
 
-    ATTRIBS = %i[
-      title
-      items
-      doctype
-      author
-    ].freeze
+    ATTRIBS = %i[title items doctype author].freeze
 
     attr_accessor *ATTRIBS
 
+    # rubocop:disable Metrics/MethodLength
+
     def initialize(options)
       self.items = []
       ATTRIBS.each do |k|
@@ -20,21 +17,28 @@ module Relaton
         send("#{k}=", value)
       end
       self.items = (items || []).reduce([]) do |acc, item|
-        acc << if item.is_a?(::Relaton::Bibcollection) || item.is_a?(::Relaton::Bibdata)
+        acc << if item.is_a?(Bibcollection) || item.is_a?(Bibdata)
                  item
                else new_bib_item_class(item)
                end
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     # arbitrary number, must sort after all bib items
     def doc_number
       9999999
     end
 
+    # rubocop:disable Metrics/MethodLength
+
+    # @param source [Nokogiri::XML::Element]
     def self.from_xml(source)
       title = find_text("./relaton-collection/title", source)
-      author = find_text("./relaton-collection/contributor[role/@type = 'author']/organization/name", source)
+      author = find_text(
+        "./relaton-collection/contributor[role/@type='author']/organization/name",
+        source,
+      )
 
       items = find_xpath("./relaton-collection/relation", source)&.map do |item|
         bibdata = find("./bibdata", item)
@@ -44,6 +48,7 @@ module Relaton
 
       new(title: title, author: author, items: items)
     end
+    # rubocop:enable Metrics/MethodLength
 
     def new_bib_item_class(options)
       if options.is_a?(Hash) && options["items"]
@@ -54,34 +59,35 @@ module Relaton
     end
 
     def items_flattened
-      items.sort_by! do |b|
-        b.docnumber
-      end
+      items.sort_by! &:docnumber
 
-      items.inject([]) do |acc,item|
-        if item.is_a? ::Relaton::Bibcollection
-          acc << item.items_flattened
-        else
-          acc << item
-        end
+      items.reduce([]) do |acc,item|
+        acc << if item.is_a? ::Relaton::Bibcollection
+                 item.items_flattened
+               else
+                 item
+               end
       end
     end
 
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+
+    # @param opts [Hash]
+    # @return [String] XML
     def to_xml(opts = {})
-      items.sort_by! do |b|
-        b.doc_number
-      end
+      items.sort_by! &:doc_number
 
       collection_type = if doctype
-        "type=\"#{doctype}\""
-      else
-        'xmlns="https://open.ribose.com/relaton-xml"'
-      end
+                          "type=\"#{doctype}\""
+                        else
+                          'xmlns="https://open.ribose.com/relaton-xml"'
+                        end
 
       ret = "<relaton-collection #{collection_type}>"
       ret += "<title>#{title}</title>" if title
       if author
-        ret += "<contributor><role type='author'/><organization><name>#{author}</name></organization></contributor>"
+        ret += "<contributor><role type='author'/><organization><name>"\
+        "#{author}</name></organization></contributor>"
       end
       unless items.empty?
         items.each do |item|
@@ -92,17 +98,16 @@ module Relaton
       end
       ret += "</relaton-collection>\n"
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     def to_yaml
       to_h.to_yaml
     end
 
     def to_h
-      items.sort_by! do |b|
-        b.doc_number
-      end
+      items.sort_by! &:doc_number
 
-      a = ATTRIBS.inject({}) do |acc, k|
+      a = ATTRIBS.reduce({}) do |acc, k|
         acc[k.to_s] = send(k)
         acc
       end

data/lib/relaton/bibdata.rb

@@ -2,7 +2,7 @@ require "date"
 
 module Relaton
   class Bibdata
-    URL_TYPES = %i[uri xml pdf doc html rxl txt]
+    URL_TYPES = %i[uri xml pdf doc html rxl txt].freeze
 
     attr_reader :bibitem
 
@@ -31,16 +31,18 @@ module Relaton
     # end
 
     # From http://gavinmiller.io/2016/creating-a-secure-sanitization-function/
-    FILENAME_BAD_CHARS = [ '/', '\\', '?', '%', '*', ':', '|', '"', '<', '>', '.', ' ' ]
+    FILENAME_BAD_CHARS = ["/", '\\', "?", "%", "*", ":", "|", '"', "<", ">",
+                          ".", " "].freeze
 
     def docidentifier_code
       return "" if docidentifier.nil?
-      a = FILENAME_BAD_CHARS.inject(docidentifier.downcase) do |result, bad_char|
-        result.gsub(bad_char, '-')
+
+      FILENAME_BAD_CHARS.reduce(docidentifier.downcase) do |result, bad_char|
+        result.gsub(bad_char, "-")
       end
     end
 
-    DOC_NUMBER_REGEX = /([\w\/]+)\s+(\d+):?(\d*)/
+    DOC_NUMBER_REGEX = /([\w\/]+)\s+(\d+):?(\d*)/.freeze
     def doc_number
       docidentifier&.match(DOC_NUMBER_REGEX) ? $2.to_i : 999999
     end
@@ -51,7 +53,9 @@ module Relaton
     end
 
     def to_xml(opts = {})
-      options = { bibdata: true, date_format: :full }.merge opts.select { |k,v| k.is_a? Symbol }
+      options = { bibdata: true, date_format: :full }.merge(
+        opts.select { |k, _v| k.is_a? Symbol },
+      )
       @bibitem.to_xml nil, **options
 
       # #datetype = stage&.casecmp("published") == 0 ? "published" : "circulated"
@@ -62,7 +66,7 @@ module Relaton
 
     def to_h
       URL_TYPES.reduce({ items: [] }.merge(@bibitem.to_hash)) do |h, t|
-        value = self.send t
+        value = send t
         h[t.to_s] = value
         h
       end
@@ -76,11 +80,15 @@ module Relaton
       if @bibitem.respond_to?(meth)
         @bibitem.send meth, *args
       elsif URL_TYPES.include? meth
-        link = @bibitem.link.detect { |l| l.type == meth.to_s || meth == :uri && l.type.nil? }
+        link = @bibitem.link.detect do |l|
+          l.type == meth.to_s || meth == :uri && l.type.nil?
+        end
         link&.content&.to_s
       elsif URL_TYPES.include? meth.match(/^\w+(?==)/).to_s.to_sym
         /^(?<type>\w+)/ =~ meth
-        link = @bibitem.link.detect { |l| l.type == type || type == "uri" && l.type.nil? }
+        link = @bibitem.link.detect do |l|
+          l.type == type || type == "uri" && l.type.nil?
+        end
         if link
           link.content = args[0]
         else

data/lib/relaton/cli/base_convertor.rb

@@ -17,6 +17,7 @@ module Relaton
         install_dependencies(options[:require] || [])
       end
 
+      # @return [String] HTML
       def to_html
         content = convert_to_html
         write_to_a_file(content)
@@ -32,12 +33,13 @@ module Relaton
       # @param style [String] Stylesheet file path for styles
       # @param template [String] The liquid tempalte directory
       #
+      # @return [String] HTML
       def self.to_html(file, style = nil, template = nil)
         new(
           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
 
@@ -45,6 +47,7 @@ module Relaton
 
       attr_reader :file, :outdir, :options, :writable, :overwrite
 
+      # @return [String] HTML
       def convert_to_html
         Relaton::Cli::XmlToHtmlRenderer.render(
           xml_content(file),
@@ -53,6 +56,9 @@ module Relaton
         )
       end
 
+      # @param file [String] path to a file
+      # @return [String] the file's content
+      # @return [String] HTML
       def xml_content(file)
         File.read(file, encoding: "utf-8")
       end
@@ -92,7 +98,7 @@ module Relaton
         #     write_to_a_file(item_output(item, format), collection)
         #   end
         # end
-        if outdir && (content.is_a?(Relaton::Bibcollection))
+        if outdir && content.is_a?(Relaton::Bibcollection)
           FileUtils.mkdir_p(outdir)
           content.items_flattened.each do |item|
             collection = collection_filename(extract_docid(item))
@@ -103,19 +109,21 @@ module Relaton
 
       def extract_docid(item)
         @default_filelabel += 1
-        item.docidentifier.nil? and return @default_filelabel.to_s
+        item.docidentifier.nil? && (return @default_filelabel.to_s)
         # item.docidentifier.is_a?(Array) or return @default_filelabel.to_s
-        item.docidentifier.empty? and return @default_filelabel.to_s
+        item.docidentifier.empty? && (return @default_filelabel.to_s)
         docidentifier_code(item.docidentifier)
       end
 
       # From http://gavinmiller.io/2016/creating-a-secure-sanitization-function/
-      FILENAME_BAD_CHARS = [ '/', '\\', '?', '%', '*', ':', '|', '"', '<', '>', '.', ' ' ]
+      FILENAME_BAD_CHARS = ["/", '\\', "?", '%", "*", ":', "|", '"', "<", ">",
+                            ".", " "].freeze
 
       def docidentifier_code(docidentifier)
         return "" if docidentifier.nil?
-        a = FILENAME_BAD_CHARS.inject(docidentifier.downcase) do |result, bad_char|
-          result.gsub(bad_char, '-')
+
+        FILENAME_BAD_CHARS.reduce(docidentifier.downcase) do |result, bad_char|
+          result.gsub(bad_char, "-")
         end
       end
 

data/lib/relaton/cli/relaton_file.rb

@@ -89,6 +89,9 @@ module Relaton
         )
       end
 
+      # @param document [String] XML
+      # @param file [String, nil] path to file
+      # @return [Nokogiri::XML::Document]
       def nokogiri_document(document, file = nil)
         document ||= File.read(file, encoding: "utf-8")
         Nokogiri.XML(document)
@@ -186,6 +189,9 @@ module Relaton
         end
       end
 
+      # @param document [Nokogiri::XML::Document]
+      # @param file [String] path to file
+      # @return [Relaton::Bibdata]
       def bibdata_instance(document, file)
         document = clean_nokogiri_document(document)
         bibdata = Relaton::Bibdata.from_xml document.root
@@ -194,6 +200,8 @@ module Relaton
         bibdata
       end
 
+      # @param bibdata [Relaton::Bibdata]
+      # @param file [String] path to file
       def build_bibdata_relaton(bibdata, file)
         ["xml", "pdf", "doc", "html", "rxl", "txt"].each do |type|
           file = Pathname.new(file).sub_ext(".#{type}")
@@ -206,6 +214,8 @@ module Relaton
       # has an xmlns. We don't want to change the code for bibdata
       # hence this hack #bibdata_doc.root['xmlns'] = "xmlns"
       #
+      # @param document [Nokogiri::XML::Document]
+      # @return [Nokogiri::XML::Document]
       def clean_nokogiri_document(document)
         document.remove_namespaces!
         document.root.add_namespace(nil, "xmlns")

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "1.1.0".freeze
+    VERSION = "1.1.1".freeze
   end
 end

data/lib/relaton/cli/xml_convertor.rb

@@ -32,7 +32,7 @@ module Relaton
       # @param content [Nokogiri::XML::Document]
       # @return [Hash]
       def convert_content(content)
-        if content.root.name == "bibdata"
+        if %w[bibitem bibdata].include? content.root.name
           Bibdata.from_xml(content)
           # Relaton::Cli.parse_xml(content).to_hash
         else

data/lib/relaton/cli/xml_to_html_renderer.rb

@@ -1,6 +1,6 @@
 require "nokogiri"
 require "liquid"
-require 'pp'
+require "pp"
 
 module Relaton::Cli
   class XmlToHtmlRenderer
@@ -10,6 +10,8 @@ module Relaton::Cli
       init_liquid_template_and_filesystem
     end
 
+    # @param index_xml [String] Relaton XML
+    # @return [String] HTML
     def render(index_xml)
       Liquid::Template.
         parse(template).
@@ -17,9 +19,7 @@ module Relaton::Cli
     end
 
     def uri_for_extension(uri, extension)
-      unless uri.nil?
-        uri.sub(/\.[^.]+$/, ".#{extension.to_s}")
-      end
+      uri&.sub(/\.[^.]+$/, ".#{extension}")
     end
 
     # Render HTML
@@ -28,6 +28,9 @@ module Relaton::Cli
     # using the specified liquid template and stylesheets. It
     # also do some minor clean during this conversion.
     #
+    # @param file [String] Relaton XML
+    # @param options [Hash]
+    # @return [String] HTML
     def self.render(file, options)
       new(options).render(file)
     end
@@ -40,16 +43,17 @@ module Relaton::Cli
       File.read(file, encoding: "utf-8")
     end
 
+    # @param source [String] Relaton XML
     def build_liquid_document(source)
       bibcollection = build_bibcollection(source)
 
-      hash_to_liquid({
+      hash_to_liquid(
         depth: 2,
         css: stylesheet,
         title: bibcollection.title,
         author: bibcollection.author,
-        documents: document_items(bibcollection)
-      })
+        documents: document_items(bibcollection),
+      )
     end
 
     def init_liquid_template_and_filesystem
@@ -59,7 +63,17 @@ module Relaton::Cli
       Liquid::Template.file_system = file_system
     end
 
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+
     # TODO: This should be recursive, but it's not
+    # @param hash [Hash]
+    # @option hash [Integer] :dept
+    # @option hash [String] :css path to stylesheet file
+    # @option hash [String] :title
+    # @option hash [String] :author
+    # @option hash [Array<Hash>] :documents
+    #
+    # @return [Hash]
     def hash_to_liquid(hash)
       hash.map do |key, value|
         case key
@@ -71,24 +85,30 @@ module Relaton::Cli
           else v = value
           end
         when "docid"
-          if value.is_a?(Array)
-            v = value.detect { |did| did["id"] !~ /^(http|https):\/\// } || value.first
-          else v = value
-          end
+          v = if value.is_a?(Array)
+                value.detect { |did| did["id"] !~ /^(http|https):\/\// } ||
+                  value.first
+              else value
+              end
         else v = value
         end
         [key.to_s, empty2nil(v)]
       end.to_h
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
 
     def empty2nil(value)
       value unless value.is_a?(String) && value.empty? && !value.nil?
     end
 
+    # @param source [String] Relaton XML
+    # @return [Relaton::Bibcollection]
     def build_bibcollection(source)
       Relaton::Bibcollection.from_xml(Nokogiri::XML(source))
     end
 
+    # @param bibcollection [Relaton::Bibcollection]
+    # @return [Array<Hash>]
     def document_items(bibcollection)
       bibcollection.to_h["root"]["items"].map { |item| hash_to_liquid(item) }
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-cli
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-07 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug