relaton-cli 1.5.0 → 1.7.2

data/lib/relaton/cli/full_text_search.rb

@@ -0,0 +1,91 @@
+# require "forwardable"
+
+module Relaton
+  class FullTextSeatch
+    # extend Forwardable
+
+    # def_delegators :@collections, :<<
+
+    # @return Regexp
+    attr_reader :regex
+
+    # @param collection [Relaton::Bibcollection]
+    def initialize(collection)
+      @collection = collection
+    end
+
+    # @param text [String]
+    # @return [Array<Hash>]
+    def search(text)
+      @regex = %{(.*?)(.{0,20})(#{text})(.{0,20})(.*)}
+      @matches = @collection.items.reduce({}) do |m, item|
+        # m + results(col, rgx)
+        res = result item
+        m[item.id] = res if res.any?
+        m
+      end
+    end
+
+    def print_results
+      @matches.each do |docid, attrs|
+        puts "  Document ID: #{docid}"
+        print_attrs attrs, 4
+      end
+    end
+
+    # @return [Boolean]
+    def any?
+      @matches.any?
+    end
+
+    private
+
+    # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+    def print_attrs(attrs, indent)
+      ind = " " * indent
+      if attrs.is_a? String then puts ind + attrs
+      elsif attrs.is_a? Hash
+        attrs.each do |key, val|
+          pref = "#{ind}#{key}:"
+          if val.is_a? String then puts pref + " " + val
+          else
+            puts pref
+            print_attrs val, indent + 2
+          end
+        end
+      elsif attrs.is_a? Array then attrs.each { |v| print_attrs v, indent + 2 }
+      end
+    end
+
+    # @param item [Relaton::Bibdata]
+    # @return [Hash]
+    def result(item)
+      if item.is_a? String
+        message $~ if item.match regex
+      elsif item.respond_to? :reduce
+        item.reduce([]) do |m, i|
+          res = result i
+          m << res if res && !res.empty?
+          m
+        end
+      else
+        item.instance_variables.reduce({}) do |m, var|
+          res = result item.instance_variable_get(var)
+          m[var.to_s.tr(":@", "")] = res if res && !res.empty?
+          m
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+
+    # @param match [MatchData]
+    # @return [String]
+    def message(match)
+      msg = ""
+      msg += "..." unless match[1].empty?
+      msg += "#{match[2]}\e[4m#{match[3]}\e[24m#{match[4]}"
+      msg += "..." unless match[5].empty?
+      msg
+    end
+  end
+end

data/lib/relaton/cli/relaton_file.rb

@@ -150,7 +150,7 @@ module Relaton
             mem << bibdata_instance(doc, xml[:file])
           else mem
           end
-        end.uniq &:id
+        end
       end
 
       def concatenate_and_write_to_files

data/lib/relaton/cli/subcommand_collection.rb

@@ -0,0 +1,221 @@
+require "relaton/cli/full_text_search"
+
+module Relaton
+  module Cli
+    class SubcommandCollection < Thor
+      desc "create COLLECTION", "Create collection"
+      option :dir, aliases: :d, desc: "Directory to store collection. Default "\
+        "is $HOME/.relaton/collections."
+      option :author, desc: "Author"
+      option :title, desc: "Title"
+      option :doctype, desc: "Documents type"
+
+      def create(file)
+        dir = directory
+        file_path = File.join dir, file
+        col = Relaton::Bibcollection.new options
+        if File.exist? file_path
+          warn "Collection #{file} aready exist"
+        else
+          Dir.mkdir dir unless Dir.exist? dir
+          File.write file_path, col.to_yaml, encoding: "UTF-8"
+        end
+      end
+
+      desc "info COLLECTION", "View collection information"
+      option :dir, aliases: :d, desc: "Directory to store collection. Default "\
+        "is $HOME/.relaton/collections."
+
+      def info(file) # rubocop:disable Metrics/AbcSize
+        path = File.join directory, file
+        puts "Collection: #{File.basename path}"
+        puts "Last updated: #{File.mtime path}"
+        puts "File size: #{File.size path}"
+        col = Relaton::Bibcollection.new YAML.load_file(path)["root"]
+        puts "Number of items: #{col.items.size}"
+        puts "Author: #{col.author}"
+        puts "Title: #{col.title}"
+      end
+
+      desc "list", "List collections"
+      option :dir, aliases: :d, desc: "Directory with collections. Default is "\
+        "$HOME/.relaton/collections."
+      option :entries, aliases: :e, type: :boolean, desc: "Show entries"
+
+      def list
+        Dir[File.join(directory, "*")].each do |f|
+          yml = read_yaml f
+          if yml && yml["root"]
+            puts File.basename f
+            puts_entries yml
+          end
+        end
+      end
+
+      map ls: :list
+
+      desc "get CODE", "Fetch document from collection by ID"
+      option :collection, aliases: :c, desc: "Collection to fetch document. "\
+        "By default fetch the first match across all collections."
+      option :dir, aliases: :d, desc: "Directory with collections. Default is "\
+        "$HOME/.relaton/collections."
+      option :format, aliases: :f, desc: "Output format (xml, abb). "\
+        "If not defined the output in a human-readable form."
+      option :output, aliases: :o, desc: "Output to the specified file. The "\
+        " file's extension (abb, xml) defines output format."
+
+      def get(docid)
+        collections.each do |col|
+          col[:collection].items.each do |item|
+            if item.docidentifier == docid
+              output_item(item)
+              return
+            end
+          end
+        end
+      end
+
+      desc "find TEXT", "Full-text search"
+      option :collection, aliases: :c, desc: "Collection to search text. "\
+        "By default search across all collections."
+      option :dir, aliases: :d, desc: "Directory with collections. Default is "\
+        "$HOME/.relaton/collections."
+
+      def find(text)
+        collections.each do |col|
+          searcher = Relaton::FullTextSeatch.new(col[:collection])
+          searcher.search text
+          if searcher.any?
+            puts "Collection: #{File.basename(col[:file])}"
+            searcher.print_results
+          end
+        end
+      end
+
+      map search: :find
+
+      desc "fetch CODE", "Fetch a document and store it into a collection"
+      option :type, aliases: :t, required: true, desc: "Type of standard to "\
+        "get bibliographic entry for"
+      option :year, aliases: :y, type: :numeric, desc: "Year the standard was "\
+        "published"
+      option :collection, aliases: :c, required: true, desc: "Collection "\
+        "to store a document"
+      option :dir, aliases: :d, desc: "Directory with collections. Default is "\
+        "$HOME/.relaton/collections."
+
+      def fetch(code)
+        doc = Cli.relaton.fetch(code, options[:year]&.to_s)
+        if doc
+          colfile = File.join directory, options[:collection]
+          coll = read_collection colfile
+          coll << doc
+          File.write colfile, coll.to_yaml, encoding: "UTF-8"
+        else "No matching bibliographic entry found"
+        end
+      end
+
+      desc "import FILE", "Import document or collection from an XML file "\
+        "into another collection"
+      option :collection, aliases: :c, required: true, desc: "Collection "\
+        "to store a document. If collection doesn't exist then it'll be created."
+      option :dir, aliases: :d, desc: "Directory with collections. Default is "\
+        "$HOME/.relaton/collections."
+
+      def import(file) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        collfile = File.join directory, options[:collection]
+        coll = read_collection collfile
+        xml = Nokogiri::XML File.read(file, encoding: "UTF-8")
+        if xml.at "relaton-collection"
+          if coll
+            coll << Relaton::Bibcollection.from_xml(xml)
+          else
+            coll = Relaton::Bibcollection.from_xml(xml)
+          end
+        else
+          coll ||= Relaton::Bibcollection.new({})
+          coll << Relaton::Bibdata.from_xml(xml)
+        end
+        File.write collfile, coll.to_yaml, encoding: "UTF-8"
+      end
+
+      desc "export COLLECTION", "Export collection into XML file"
+      option :dir, aliases: :d, desc: "Directory with collections. Default is "\
+        "$HOME/.relaton/collections."
+
+      def export(file)
+        coll = read_collection File.join(directory, file)
+        outfile = file.sub(/\.\w+$/, "") + ".xml"
+        File.write outfile, coll.to_xml(bibdata: true), encoding: "UTF-8"
+      end
+
+      private
+
+      # @return [String]
+      def directory
+        options.fetch :dir, File.join(Dir.home, ".relaton/collections")
+      end
+
+      # @param file [String]
+      # @return [Hash]
+      def read_yaml(file)
+        YAML.load_file file if File.file? file
+      rescue Psych::SyntaxError
+        warn "[relaton-cli] WARNING: the file #{file} isn't a collection."
+      end
+
+      # @param file [String]
+      # @return [Relaton::Bibcollection, nil]
+      def read_collection(file)
+        return unless File.file?(file)
+
+        Relaton::Bibcollection.new YAML.load_file(file)["root"]
+      end
+
+      # @return [Array<Hash>]
+      def collections
+        file = options.fetch :collection, "*"
+        Dir[File.join directory, file].reduce([]) do |m, f|
+          yml = read_yaml f
+          if yml && yml["root"]
+            m << { collection: Relaton::Bibcollection.new(yml["root"]),
+                   file: f }
+          end
+          m
+        end
+      end
+
+      # Puts document IDs for each item in tthe cokllection
+      # @param hash [Hash] Relaton collection
+      def puts_entries(hash)
+        return unless options[:entries]
+
+        Relaton::Bibcollection.new(hash["root"]).items.each do |b|
+          puts "  " + b.docidentifier
+        end
+      end
+
+      # @param item [Relaton::Bibdata]
+      def output_item(item)
+        case options[:format]
+        when "xml" then puts item.to_xml bibdata: true
+        when "abb" then puts item.to_asciibib
+        else puts_human_readable_item item
+        end
+        out = case options[:output]
+              when /\.abb$/ then item.to_asciibib
+              when /\.xml$/ then item.to_xml bibitem: true
+              end
+        File.write options[:output], out, encoding: "UTF-8" if out
+      end
+
+      # @param item [Relaton::Bibdata]
+      def puts_human_readable_item(item) # rubocop:disable Metrics/AbcSize
+        puts "Document identifier: #{item.docidentifier}"
+        puts "Title: #{item.title.first.title.content}"
+        puts "Status: #{item.status.stage}"
+        item.date.each { |d| puts "Date #{d.type}: #{d.on || d.from}" }
+      end
+    end
+  end
+end

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "1.5.0".freeze
+    VERSION = "1.7.2".freeze
   end
 end

data/lib/relaton/cli/xml_to_html_renderer.rb

@@ -13,9 +13,9 @@ module Relaton::Cli
     # @param index_xml [String] Relaton XML
     # @return [String] HTML
     def render(index_xml)
-      Liquid::Template.
-        parse(template).
-        render(build_liquid_document(index_xml))
+      Liquid::Template
+        .parse(template)
+        .render(build_liquid_document(index_xml))
     end
 
     def uri_for_extension(uri, extension)
@@ -32,7 +32,7 @@ module Relaton::Cli
     # @param options [Hash]
     # @return [String] HTML
     def self.render(file, options)
-      new(options).render(file)
+      new(**options).render(file)
     end
 
     private
@@ -43,16 +43,23 @@ module Relaton::Cli
       File.read(file, encoding: "utf-8")
     end
 
+    # rubocop:disable Metrics/MethodLength
     # @param source [String] Relaton XML
     def build_liquid_document(source)
       bibcollection = build_bibcollection(source)
-
+      begin
+        mnv = `metanorma -v`
+      rescue Errno::ENOENT
+        mnv = ""
+      end
       hash_to_liquid(
         depth: 2,
         css: stylesheet,
         title: bibcollection.title,
+        date: Date.today.to_s,
+        metanorma_v: mnv.lines.first&.strip,
         author: bibcollection.author,
-        documents: document_items(bibcollection),
+        documents: document_items(bibcollection)
       )
     end
 
@@ -63,7 +70,7 @@ module Relaton::Cli
       Liquid::Template.file_system = file_system
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     # TODO: This should be recursive, but it's not
     # @param hash [Hash]

data/lib/relaton/cli/yaml_convertor.rb

@@ -37,7 +37,7 @@ module Relaton
             processor.hash_to_bib content
           else
             RelatonBib::BibliographicItem.new(
-              RelatonBib::HashConverter::hash_to_bib(content)
+              **RelatonBib::HashConverter::hash_to_bib(content)
             )
           end
         end

data/lib/relaton/element_finder.rb

@@ -15,11 +15,11 @@ module Relaton
     end
 
     def apply_namespace(xpath)
-      xpath.
-        gsub(%r{/([a-zA-Z])}, "/xmlns:\\1").
-        gsub(%r{::([a-zA-Z])}, "::xmlns:\\1").
-        gsub(%r{\[([a-zA-Z][a-z0-9A-Z@/]* ?=)}, "[xmlns:\\1").
-        gsub(%r{\[([a-zA-Z][a-z0-9A-Z@/]*\])}, "[xmlns:\\1")
+      xpath
+        .gsub(%r{/([a-zA-Z])}, "/xmlns:\\1")
+        .gsub(%r{::([a-zA-Z])}, "::xmlns:\\1")
+        .gsub(%r{\[([a-zA-Z][a-z0-9A-Z@/]* ?=)}, "[xmlns:\\1")
+        .gsub(%r{\[([a-zA-Z][a-z0-9A-Z@/]*\])}, "[xmlns:\\1")
     end
   end
 end

data/relaton-cli.gemspec

@@ -23,18 +23,19 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.4.0"
 
   spec.add_development_dependency "byebug", "~> 11.0"
-  spec.add_development_dependency "debase"
+  # spec.add_development_dependency "debase"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-command", "~> 1.0.3"
   spec.add_development_dependency "rspec-core", "~> 3.4"
-  spec.add_development_dependency "ruby-debug-ide"
+  # spec.add_development_dependency "ruby-debug-ide"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
 
-  spec.add_runtime_dependency "liquid"
-  spec.add_runtime_dependency "relaton", "~> 1.5.0"
+  spec.add_runtime_dependency "liquid", "~> 4"
+  spec.add_runtime_dependency "relaton", "~> 1.7.0"
   spec.add_runtime_dependency "thor"
-  # spec.add_runtime_dependency 'byebug'
 end

data/templates/_index.liquid

@@ -17,7 +17,12 @@
   <body>
     <header>
       <div id="topbar-inner">
-        <div id="title-bar"><span>{{ author }}</span></div>
+        <div id="title-bar">
+          <div class="doc-access">
+            Generated: {{ date }}{% if metanorma_v != nil %} {{ metanorma_v }}{% endif %}
+          </div>
+          <span>{{ author }}</span>
+        </div>
       </div>
       <div class="title-section">
         <div class="coverpage">
@@ -34,6 +39,9 @@
     </main>
     <footer>
       <div class="copyright">
+        <div class="doc-access">
+          Generated: {{ date }}{% if metanorma_v != nil %} {{ metanorma_v }}{% endif %}
+        </div>
         <p class="year">&copy; {{ author }}</p>
         <p class="message">All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized otherwise in any form or by any means, electronic or mechanical, including photocopying, or posting on the internet or an intranet, without prior written permission.</p>
       </div>