relaton-cli 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d96e141da8f193b480b52e742609971db8358e90819b9cdd1a3406141c8e9c5
-  data.tar.gz: 684e2c529cbd077e58f526b421e62c2bea874eb0167c11e2601e3212546eca80
+  metadata.gz: 1fd1d595711558f13d1861c3d1077054c9666f19aa2ce534f4c28cb28468fa08
+  data.tar.gz: 7bd64a7c60d3b71b2dcc255d18b967e36acfdd2c75e7af1636f428e188fd260f
 SHA512:
-  metadata.gz: 430b486d9df71df93ce4dd1a8c1d306cae8df2018766cbc0a8f886ac2ec09c40678b62541e448427b9f63a94d49b6ae1705fa14c4ed54277191ecd9b6b869547
-  data.tar.gz: d83743a5a0fd38719f083bee3e1f373848d6111d70915592fa0262f569468918dfebecf5ee7745e5cd9a76a5ba70f1c64c336f5e18718c4aa1d5ea1838e2c148
+  metadata.gz: 42471b6f147ed05d83238ee91357cf5a6154727eba2f8760e7f7b00965fb689e8cfe1a065fdf82f93a9b9d12d46f9b56e0c612ddbcf371d8ad428e7a7e0b9212
+  data.tar.gz: e003e6e51b727b0b9bfa6a6c157eb4f142f9b3481bf2e598d74f48e30f4ba8125ef45918def68d10832bd0b95e1e716e5754242aaa651e9008868eb47770bf12

data/docs/README.adoc

@@ -42,17 +42,18 @@ suports an additional `-x` or `--extension` options to use different extension.
 
 [source,console]
 ----
-$ relaton fetch CODE -t TYPE -f FORMAT -y YEAR -r RETRIES --all-parts --keep-year
+$ relaton fetch CODE -t TYPE -f FORMAT -y YEAR -r RETRIES --all-parts --keep-year --no-cache
 ----
 
 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 recognized values for `FORMAT` are `xml` (default), yaml, `bibtex`.
-* `TYPE` is optional and specifies the standards class library to be used, that the identifier is part of. The recognized values for `TYPE` are `3GPP, BIPM, BSI, CC, CEN, CIE, CN, ECMA, IANA, IEC, IEEE, IETF, IHO, ISO, ITU, NIST, OGC, OMG, UN, W3C`.
+* `TYPE` is optional and specifies the standards class library to be used, that the identifier is part of. The recognized values for `TYPE` are `3GPP, BIPM, BSI, CC, CCSDS, CEN, CIE, CN, ECMA, IANA, IEC, IEEE, IETF, IHO, ISO, ITU, NIST, OASIS, OGC, OMG, UN, W3C, XSF`.
 * `RETRIES` is optional, number of network retries (default 1).
 * `--all-parts` fetch all parts.
 * `--keep-year` undated reference should return an actual reference with year.
+* `--no-cache` do not use cache.
 
 === relaton fetch-data
 
@@ -392,10 +393,10 @@ Creates a new database in a directory `DIR` (optional, deafult is `/home/USER/.r
 
 ----
 $ relaton db create
-Database is in "/Users/user/.relaton/cache"
+[relaton-cli] Database is in `/Users/user/.relaton/cache`
 
 $ relaton db create cachedb
-Database is in "/Users/user/RubyProjects/relaton-cli/cachedb"
+[relaton-cli] Database is in `/Users/user/RubyProjects/relaton-cli/cachedb`
 ----
 
 ==== Move database
@@ -408,7 +409,7 @@ Move database to another place `DIR`.
 
 ----
 $ relaton db mv cache_dir
-Database is moved to "/Users/user/RubyProjects/relaton-cli/cache_dir"
+[relaton-cli] Database is moved to `/Users/user/RubyProjects/relaton-cli/cache_dir`
 ----
 
 ==== Clear database

data/lib/relaton/cli/command.rb

@@ -20,16 +20,17 @@ module Relaton
       end
 
       desc "fetch CODE", "Fetch Relaton XML for Standard identifier CODE"
-      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 :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"
       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."
+      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."
+      option :"no-cache", type: :boolean, desc: "Ignore cache"
 
       def fetch(code)
         io = IO.new($stdout.fcntl(::Fcntl::F_DUPFD), mode: "w:UTF-8")
@@ -160,10 +161,9 @@ module Relaton
 
       no_commands do
         def relaton_config
-          log_types = %i[info error]
-          log_types << :warning if options[:verbose]
+          log_type = options[:verbose] ? ::Logger::INFO : ::Logger::WARN
           Relaton.configure do |conf|
-            conf.logs = log_types
+            conf.logger.level = log_type
           end
         end
       end
@@ -177,12 +177,13 @@ module Relaton
     # @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
+    def fetch_document(code, options) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/AbcSize,Metrics/MethodLength
       year = options[:year]&.to_s
+      dup_opts = options.dup.transform_keys { |k| k.to_s.gsub("-", "_").to_sym }
       if (processor = Relaton::Registry.instance.by_type options[:type]&.upcase)
-        doc = Relaton.db.fetch_std code, year, processor.short, options.dup
+        doc = Relaton.db.fetch_std code, year, processor.short, **dup_opts
       elsif options[:type] then return
-      else doc = Relaton.db.fetch(code, year, options.dup)
+      else doc = Relaton.db.fetch(code, year, **dup_opts)
       end
       return "No matching bibliographic entry found" unless doc
 

data/lib/relaton/cli/config.rb

@@ -0,0 +1,12 @@
+module Relaton
+  module Cli
+    module Config
+      include RelatonBib::Config
+    end
+    extend Config
+
+    class Configuration < RelatonBib::Configuration
+      PROGNAME = "relaton-cli".freeze
+    end
+  end
+end

data/lib/relaton/cli/data_fetcher.rb

@@ -4,7 +4,7 @@ module Relaton
       def fetch(source, options)
         processor = Relaton::Registry.instance.find_processor_by_dataset source
         unless processor
-          warn "[relaton-cli] WARNING: no processor found for #{source}"
+          Util.warn "WARNING: no processor found for `#{source}`"
           return
         end
 

data/lib/relaton/cli/subcommand_collection.rb

@@ -18,7 +18,7 @@ module Relaton
         file_path = File.join dir, file
         col = Relaton::Bibcollection.new options
         if File.exist? file_path
-          warn "Collection #{file} aready exist"
+          Util.warn "Collection `#{file}` aready exist"
         else
           FileUtils.mkdir_p dir # unless Dir.exist? dir
           File.write file_path, col.to_yaml, encoding: "UTF-8"
@@ -114,7 +114,7 @@ module Relaton
           coll = read_collection colfile
           coll << doc
           File.write colfile, coll.to_yaml, encoding: "UTF-8"
-        else warn "No matching bibliographic entry found"
+        else Util.warn "No matching bibliographic entry found"
         end
       end
 
@@ -161,11 +161,12 @@ module Relaton
       end
 
       # @param file [String]
-      # @return [Hash]
+      # @return [Hash, nil]
       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."
+        Util.warn "WARNING: the file `#{file}` isn't a collection."
+        nil
       end
 
       # @param file [String]

data/lib/relaton/cli/subcommand_db.rb

@@ -10,7 +10,7 @@ module Relaton
       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}\""
+        Util.warn "Cache DB is in `#{path}`"
       end
 
       desc "mv DIR", "Move cache DB to a new directory"
@@ -20,7 +20,7 @@ module Relaton
         path = Relaton.db.mv new_path
         if path
           File.write Cli::RelatonDb::DBCONF, path, encoding: "UTF-8"
-          warn "Cache DB is moved to \"#{path}\""
+          Util.warn "Cache DB is moved to `#{path}`"
         end
       end
 
@@ -29,7 +29,7 @@ module Relaton
       def clear
         db = Relaton.db
         db.clear
-        warn "Cache DB is cleared"
+        Util.warn "Cache DB is cleared"
       end
 
       desc "fetch CODE", "Fetch Relaton XML for Standard identifier CODE " \

data/lib/relaton/cli/util.rb

@@ -0,0 +1,11 @@
+module Relaton
+  module Cli
+    module Util
+      extend RelatonBib::Util
+
+      def self.logger
+        Relaton::Cli.configuration.logger
+      end
+    end
+  end
+end

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "1.16.0".freeze
+    VERSION = "1.17.0".freeze
   end
 end

data/lib/relaton/cli.rb

@@ -2,6 +2,8 @@ require "thor"
 require "thor/hollaback"
 require "relaton"
 require "relaton/cli/version"
+require_relative "cli/config"
+require_relative "cli/util"
 require_relative "cli/command"
 
 module Relaton

data/relaton-cli.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.7.0"
 
   spec.add_runtime_dependency "liquid", "~> 5"
-  spec.add_runtime_dependency "relaton", "~> 1.16.0"
+  spec.add_runtime_dependency "relaton", "~> 1.17.0"
   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.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-03 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -98,11 +98,13 @@ files:
 - lib/relaton/cli.rb
 - lib/relaton/cli/base_convertor.rb
 - lib/relaton/cli/command.rb
+- lib/relaton/cli/config.rb
 - lib/relaton/cli/data_fetcher.rb
 - 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/util.rb
 - lib/relaton/cli/version.rb
 - lib/relaton/cli/xml_convertor.rb
 - lib/relaton/cli/xml_to_html_renderer.rb