relaton-cli 1.7.2 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9983d2d6b80b1d1ac3a1ad7da07f4de43d8509c44c61c050ab2046c11580c8bc
-  data.tar.gz: '09593a750543ab10dae21731732f7858c5467bd30494613e5b59c00f0967bbb9'
+  metadata.gz: d320bdb2aed574b0d56fb8bb94e4b7128d5261c8e88ac9fbeb25739392c96ca8
+  data.tar.gz: 88adb33264d4bfee902cff4f12a0cfc3e50ce99b61bc5c7841e6b09400f85003
 SHA512:
-  metadata.gz: 1419b4f0fdc45ca4dc5f9674eff0a9784ae89d6159a8bf23e4168d3f61776f28ddfd8caf76dc0540bf310e7b730095d94db03e7a5be95340cf668896d5446ed0
-  data.tar.gz: 5e4c6b9d094841f358566238406a6a08b1ad1080e33b48b190807c126c41fa17498f8f1b5707d66ac6f97aea06a04d73b567663fd6328e65db8dfc04b96d2736
+  metadata.gz: d7c396fe7319104f8433ebaf1778b291e2526fd95f8f8a6d7f8b12d375d767d4ce4cc494df8c8d2f7bf442b27154c1a9ef2059205e0468510a6c4ec2ab3dbbce
+  data.tar.gz: 81399b3e5b6685c76602282b4b95ece2865fa666c840bad188b150f530984d5da4113dd4f6414f9648e2ae7997fe44ae05acbd09475f73e418567fe5bdd279d6

data/docs/README.adoc

@@ -10,6 +10,7 @@ Please refer to https://github.com/relaton/relaton.
 
 == Commands
 
+Each command has an option `--verbose` (short form is `-v`). Use the option to get warnings in the commands outpput.
 The following commands are provided.
 
 === relaton concatenate
@@ -41,14 +42,17 @@ suports an additional `-x` or `--extension` options to use different extension.
 
 [source,console]
 ----
-$ relaton fetch CODE -t TYPE -f FORMAT -y YEAR
+$ relaton fetch CODE -t TYPE -f FORMAT -y YEAR -r RETRIES --all-parts --keep-year
 ----
 
 Fetch the Relaton XML entry corresponding to the document identifier `CODE`.
 
 * `YEAR` is optional, and specifies the year of publication of the standard.
-* `FORMAT` is optional, and specifies the output format; the recognised values for `FORMAT` are `xml` (default), `bibtex`.
-* `TYPE` specifies the standards class library to be used, that the identifier is part of. The recognised values for `TYPE` are `BIPM`, `CC`, `CN`, `IEC`, `IEEE`, `IETF`, `IHO`, `ISO`, `ITU`, `NIST`, `OGC`, `OMG`, `UN`, `W3C`.
+* `FORMAT` is optional, and specifies the output format; the recognised values for `FORMAT` are `xml` (default), yaml, `bibtex`.
+* `TYPE` is optional, specifies the standards class library to be used, that the identifier is part of. The recognised values for `TYPE` are `BIPM`, `CC`, `CIE`, `CN`, `ECMA`, `IEC`, `IEEE`, `IETF`, `IHO`, `ISO`, `ITU`, `NIST`, `OGC`, `OMG`, `UN`, `W3C`.
+* `RETRIES` is optional, number of network retries (default 1).
+* `--all-parts` fetch all parts.
+* `--keep-year` undated reference should return actual reference with year.
 
 === relaton extract
 
@@ -305,3 +309,107 @@ Import document or collection from XML `FILE` into `COLLECTION`.
 
 * `COLLECTION` is optional. If collection doesn't exist then it will be created.
 * `DIRECTORY` is optional, and specifies path to a directory with collections. Default is `$HOME/.relaton/collections`.
+
+=== Cache DB manipulation
+
+==== Create cache DB
+
+----
+$ relaton db create DIR
+----
+
+Creates a new cache DB in a directory `DIR` (optional, deafult is `/home/USER/.relaton/dbpath`). In case the target directory exists it will be used as a cache DB.
+
+----
+$ relaton db create
+Cache DB is in "/Users/user/.relaton/cache"
+
+$ relaton db create cachedb
+Cache DB is in "/Users/user/RubyProjects/relaton-cli/cachedb"
+----
+
+==== Move cache DB
+
+----
+$ relaton db mv DIR
+----
+
+Move cache DB to another place `DIR`.
+
+----
+$ relaton db mv cache_dir
+Cache DB is moved to "/Users/user/RubyProjects/relaton-cli/cache_dir"
+----
+
+==== Clear cache DB
+
+Delete all entries from a chache DB.
+
+----
+$ relaton db clear
+----
+
+==== Fetch from cache DB
+
+----
+$ relaton db fetch -t TYPE -f FORMAT -y YEAR
+----
+
+Fetch an entry from a cache DB. See [relaton fetch](#relaton-fetch) for the arguments explanation.
+
+==== Fetch all
+
+Fetch all entries from a chache DB.
+
+----
+$ relaton db fetch_all TEXT -e EDITION -y YEAR -f FORMAT
+----
+
+* `TEXT` (optional) search for a certan string
+* `EDITION` (optional) filter documets with a certain edition
+* `YEAR` (optional) filter documents by a year
+* `FORMAT` (optional) specify the output format. Recognised values are `xml` (default), yaml, `bibtex`.
+
+----
+$ relaton db fetch_all
+<bibitem id="ISO/IECDIR1" type="international-standard">
+...
+
+$ relaton db fetch_all 'Procedures for the technical work'
+<bibitem id="ISO/IECDIR1" type="international-standard">
+  <fetched>2021-04-01</fetched>
+  <title type="title-main" format="text/plain" language="en" script="Latn">Procedures for the technical work</title>
+...
+
+$ relaton db fetch_all -e 3                               
+<bibitem id="ISO2146-2010" type="standard">
+...
+<edition>3</edition>
+...
+
+$ relaton db fetch_all -e 8 -y 2018
+<bibitem id="ISO/IECDIR2IEC" type="international-standard">
+  <fetched>2021-04-01</fetched>
+  <title type="title-main" format="text/plain" language="en" script="Latn">Principles and rules for the structure and drafting of ISO and IEC documents</title>
+  <uri type="obp">https://www.iec.ch/members_experts/refdocs/iec/isoiecdir2%7Bed8.0.RLV%7Den.pdf</uri>
+  <docidentifier type="ISO">ISO/IEC DIR 2 IEC</docidentifier>
+  <date type="published">
+    <on>2018-05-01</on>
+  </date>
+  <edition>8</edition>
+...
+----
+
+==== Get document type
+
+----
+$ relaton db doctype REF
+----
+
+Takes a reference `REF` and retuern a document type.
+
+----
+$ relaton db doctype 'CN(GB/T 1.1)'
+Chinese Standard
+GB/T 1.1
+----

data/lib/relaton/cli.rb

@@ -1,18 +1,38 @@
 require "thor"
+require "thor/hollaback"
 require "relaton"
 require_relative "cli/command"
 
 module Relaton
-  def self.db
-    Cli.relaton
+  def self.db(dir = nil)
+    Cli.relaton dir
   end
 
   module Cli
     class RelatonDb
       include Singleton
 
-      def db
-        @db ||= Relaton::Db.new("#{Dir.home}/.relaton/cache", nil)
+      DBCONF = "#{Dir.home}/.relaton/dbpath".freeze
+
+      # @param dir [String, nil]
+      # @return [Relaton::Db]
+      def db(dir)
+        if dir
+          File.write DBCONF, dir, encoding: "UTF-8"
+          @db = Relaton::Db.new dir, nil
+        else
+          @db ||= Relaton::Db.new dbpath, nil
+        end
+      end
+
+      private
+
+      # @return [String] path to DB
+      def dbpath
+        if File.exist?(DBCONF)
+          File.read(DBCONF, encoding: "UTF-8")
+        else "#{Dir.home}/.relaton/cache"
+        end
       end
     end
 
@@ -28,8 +48,10 @@ module Relaton
       # easier we have added it as a class method so we can use this
       # whenever necessary.
       #
-      def relaton
-        RelatonDb.instance.db
+      # @param dir [String, nil]
+      # @return [Relaton::Db]
+      def relaton(dir)
+        RelatonDb.instance.db dir
       end
 
       # @param content [Nokogiri::XML::Document]

data/lib/relaton/cli/command.rb

@@ -2,21 +2,30 @@ require "relaton/cli/relaton_file"
 require "relaton/cli/xml_convertor"
 require "relaton/cli/yaml_convertor"
 require "relaton/cli/subcommand_collection"
+require "relaton/cli/subcommand_db"
 require "fcntl"
 
 module Relaton
   module Cli
     class Command < Thor
+      include Relaton::Cli
+      class_before :relaton_config
+      class_option :verbose, aliases: :v, type: :boolean, desc: "Output warnings"
+
       desc "fetch CODE", "Fetch Relaton XML for Standard identifier CODE"
-      option :type, aliases: :t, required: true, desc: "Type of standard to "\
+      option :type, aliases: :t, desc: "Type of standard to "\
         "get bibliographic entry for"
-      option :format, aliases: :f, desc: "Output format (xml, bibtex). "\
+      option :format, aliases: :f, desc: "Output format (xml, yaml, bibtex). "\
         "Default xml."
       option :year, aliases: :y, type: :numeric, desc: "Year the standard was "\
         "published"
+      option :"all-parts", type: :boolean, desc: "Fetch all parts"
+      option :"keep-year", type: :boolean, desc: "Undated reference should "\
+        "return actual reference with year"
+      option :retries, aliases: :r, type: :numeric, desc: "Number of network "\
+        "retries. Default 1."
 
       def fetch(code)
-        Relaton.db
         io = IO.new(STDOUT.fcntl(::Fcntl::F_DUPFD), mode: "w:UTF-8")
         io.puts(fetch_document(code, options) || supported_type_message)
       end
@@ -35,8 +44,6 @@ 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, desc: "File extension of destination "\
         "Relaton file, defaults to 'rxl'"
 
@@ -48,8 +55,6 @@ module Relaton
         "Relaton Collection into multiple files"
       option :extension, aliases: :x, default: "rxl", desc: "File extension "\
         "of Relaton XML files, defaults to 'rxl'"
-      option :new, aliases: :n, type: :boolean, desc: "Use the new Relaton "\
-        "YAML format"
 
       def split(source, outdir)
         Relaton::Cli::RelatonFile.split(source, outdir, options)
@@ -139,34 +144,60 @@ module Relaton
       desc "collection SUBCOMMAND", "Collection manipulations"
       subcommand "collection", SubcommandCollection
 
-      private
-
-      # @param code [String]
-      # @param options [Hash]
-      # @option options [String] :type
-      # @option options [String, NilClass] :format
-      # @option options [Integer, NilClass] :year
-      def fetch_document(code, options)
-        if registered_types.include?(options[:type])
-          doc = Cli.relaton.fetch(code, options[:year]&.to_s)
-          if doc
-            options[:format] == "bibtex" ? doc.to_bibtex : doc.to_xml
-          else
-            "No matching bibliographic entry found"
+      desc "db SUBCOMMAND", "Cache DB manipulation"
+      subcommand "db", SubcommandDb
+
+      no_commands do
+        def relaton_config
+          log_types = %i[info error]
+          log_types << :warning if options[:verbose]
+          Relaton.configure do |conf|
+            conf.logs = log_types
           end
         end
-      rescue RelatonBib::RequestError => e
-        e.message
       end
+    end
 
-      def supported_type_message
-        ["Recognised types:", registered_types.sort.join(", ")].join(" ")
+    private
+
+    # @param code [String]
+    # @param options [Hash]
+    # @option options [String] :type
+    # @option options [String, NilClass] :format
+    # @option options [Integer, NilClass] :year
+    # @return [String, nil]
+    def fetch_document(code, options) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/AbcSize
+      year = options[:year]&.to_s
+      if (processor = Relaton::Registry.instance.by_type options[:type]&.upcase)
+        doc = Relaton.db.fetch_std code, year, processor.short, options.dup
+      elsif options[:type] then return
+      else doc = Relaton.db.fetch(code, year, options.dup)
       end
+      return "No matching bibliographic entry found" unless doc
+
+      serialize doc, options[:format]
+    rescue RelatonBib::RequestError => e
+      e.message
+    end
 
-      def registered_types
-        @registered_types ||=
-          Relaton::Registry.instance.processors.each.map { |_n, pr| pr.prefix }
+    # @param doc [RelatonBib::BibliographicItem]
+    # @param format [String]
+    # @return [String]
+    def serialize(doc, format)
+      case format
+      when "yaml", "yml" then doc.to_hash.to_yaml
+      when "bibtex" then doc.to_bibtex
+      else doc.to_xml
       end
     end
+
+    def supported_type_message
+      ["Recognised types:", registered_types.sort.join(", ")].join(" ")
+    end
+
+    def registered_types
+      @registered_types ||=
+        Relaton::Registry.instance.processors.each.map { |_n, pr| pr.prefix }
+    end
   end
 end

data/lib/relaton/cli/subcommand_collection.rb

@@ -3,6 +3,9 @@ require "relaton/cli/full_text_search"
 module Relaton
   module Cli
     class SubcommandCollection < Thor
+      include Relaton::Cli
+      class_option :verbose, aliases: :v, type: :boolean, desc: "Output warnings"
+
       desc "create COLLECTION", "Create collection"
       option :dir, aliases: :d, desc: "Directory to store collection. Default "\
         "is $HOME/.relaton/collections."
@@ -104,21 +107,21 @@ module Relaton
       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)
+      def fetch(code) # rubocop:disable Metrics/AbcSize
+        doc = Relaton.db.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"
+        else warn "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 :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."
 

data/lib/relaton/cli/subcommand_db.rb

@@ -0,0 +1,74 @@
+module Relaton
+  module Cli
+    class SubcommandDb < Thor
+      include Relaton::Cli
+      class_option :verbose, aliases: :v, type: :boolean, desc: "Output warnings"
+
+      desc "create DIR", "Create new cache DB. Default DIR is "\
+        "/home/user/.relaon/cache/"
+
+      def create(dir = nil)
+        db = Relaton.db (dir && File.expand_path(dir))
+        path = db.instance_variable_get(:@db).dir
+        warn "Cache DB is in \"#{path}\""
+      end
+
+      desc "mv DIR", "Move cache DB to a new directory"
+
+      def mv(dir)
+        new_path = File.expand_path dir
+        path = Relaton.db.mv new_path
+        if path
+          File.write Cli::RelatonDb::DBCONF, path, encoding: "UTF-8"
+          warn "Cache DB is moved to \"#{path}\""
+        end
+      end
+
+      desc "clear", "Clear cache DB"
+
+      def clear
+        Relaton.db.clear
+        warn "Cache DB is cleared"
+      end
+
+      desc "fetch CODE", "Fetch Relaton XML for Standard identifier CODE from "\
+        "cache DB"
+      option :type, aliases: :t, desc: "Type of standard to "\
+        "get bibliographic entry for"
+      option :format, aliases: :f, desc: "Output format (xml, yaml, bibtex). "\
+        "Default xml."
+      option :year, aliases: :y, type: :numeric, desc: "Year the standard was "\
+        "published"
+
+      def fetch(code)
+        io = IO.new($stdout.fcntl(::Fcntl::F_DUPFD), mode: "w:UTF-8")
+        opts = options.merge(fetch_db: true)
+        io.puts(fetch_document(code, opts) || supported_type_message)
+      end
+
+      desc "fetch_all TEXT", "Query for all documents in a cache DB for a "\
+        "certain string"
+      option :edition, aliases: :e, desc: "Filter entries by edition"
+      option :year, aliases: :y, desc: "Filter entries by year"
+      option :format, aliases: :f, desc: "Output format (xml, yaml, bibtex). "\
+        "Default xml."
+
+      def fetch_all(text = nil) # rubocop:disable Metrics/AbcSize
+        io = IO.new($stdout.fcntl(::Fcntl::F_DUPFD), mode: "w:UTF-8")
+        opts = options.each_with_object({}) do |(k, v), o|
+          o[k.to_sym] = v unless k == "format"
+        end
+        Relaton.db.fetch_all(text, **opts).each do |doc|
+          io.puts serialize(doc, options[:format])
+        end
+      end
+
+      desc "doctype REF", "Detect document type from REF"
+
+      def doctype(ref)
+        io = IO.new($stdout.fcntl(::Fcntl::F_DUPFD), mode: "w:UTF-8")
+        io.puts Relaton.db.docid_type(ref)
+      end
+    end
+  end
+end

data/lib/relaton/cli/version.rb

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

data/relaton-cli.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
 
   spec.add_runtime_dependency "liquid", "~> 4"
-  spec.add_runtime_dependency "relaton", "~> 1.7.0"
+  spec.add_runtime_dependency "relaton", ">=1.7.7"
   spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "thor-hollaback"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-cli
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.7.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-20 00:00:00.000000000 Z
+date: 2021-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -168,16 +168,16 @@ dependencies:
   name: relaton
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor-hollaback
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Relaton Command-line Interface
 email:
 - open.source@ribose.com
@@ -226,6 +240,7 @@ files:
 - lib/relaton/cli/full_text_search.rb
 - lib/relaton/cli/relaton_file.rb
 - lib/relaton/cli/subcommand_collection.rb
+- lib/relaton/cli/subcommand_db.rb
 - lib/relaton/cli/version.rb
 - lib/relaton/cli/xml_convertor.rb
 - lib/relaton/cli/xml_to_html_renderer.rb