relaton-cli 1.8.0 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d1136ef4b30917aa5a29aa324cfacacc3be729c3a83f6aa3a41ddefc93e12c2
-  data.tar.gz: 8a727b79dce16e15467463d5bbf648a37fa6d49e988e904aa4826025e6b9c9e3
+  metadata.gz: 767e5966382c899d19561eb09eb1a623e6d70b3f7351d1af074a3ff5a07900a9
+  data.tar.gz: 52cc6b65943e3c5e02450f3479d6be987ca1c8253b393b5796d2455dc670970a
 SHA512:
-  metadata.gz: b8eececfadffa4cdf1e9eb57cb47e3241bfbcb6547e779026f61dc72625e751f9acd93946922b22d0159ffd4f60ec24c8abaa4011313d35ad62fe236399abb9a
-  data.tar.gz: e083e9481f91c42544e65426d05983bdc21841e5b8adf4ff4a90c7942cefbe65168842b22cc4e9e75d5d9cb6b6b46c6374a0233a6d8d6ac0147c2f53994aea65
+  metadata.gz: 4b57a654bf1eb73955fab8fdbc4b80d87f3d0bce522824e40d2ddbb16ea48975ce575f9974721483fa3e87a769ca1d5a71e8b7eeb9526c8ba3fdd28014443d14
+  data.tar.gz: fffae10fa7a938ccad785600bf61d4bca0d7cf65f7e7467ea1e8f39ee4debf46f74312d0aa6e292eb947d8fe27ef7ea1b6b972b78f4f2f8a41a56017e4de3680

data/.github/workflows/rake.yml

@@ -16,19 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
     steps:
       - uses: actions/checkout@v2
         with:

data/.rubocop.yml

@@ -5,6 +5,6 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
 Rails:
   Enabled: true

data/docs/README.adoc

@@ -54,7 +54,23 @@ Fetch the Relaton XML entry corresponding to the document identifier `CODE`.
 * `--all-parts` fetch all parts.
 * `--keep-year` undated reference should return actual reference with year.
 
-=== relaton extract
+=== relaton fetch-data
+
+[source,console]
+----
+$ relaton fetch-data DATASET -o DIR -f FORMAT
+----
+
+Fetch all the documents from a `DATASET` source and save them to a folder `DIR` in format `FORMAT`.
+
+Foloowing datasets are availabe:
+
+* `nist-tech-pubs` - https://raw.githubusercontent.com/usnistgov/NIST-Tech-Pubs/nist-pages/xml/allrecords.xml
+
+Options:
+
+* `DIR` - floder name to store documents (default `./data`).
+* `FORMAT` - format in which the documents are saved. Possimle formats are: `yaml`, `xml` (default `yaml`).
 
 [source,console]
 ----
@@ -310,38 +326,38 @@ 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
+=== Dadabase manipulation
 
-==== Create cache DB
+==== Create database
 
 ----
 $ 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.
+Creates a new database in a directory `DIR` (optional, deafult is `/home/USER/.relaton/dbpath`). In case the target directory exists it will be used as a database.
 
 ----
 $ relaton db create
-Cache DB is in "/Users/user/.relaton/cache"
+Database is in "/Users/user/.relaton/cache"
 
 $ relaton db create cachedb
-Cache DB is in "/Users/user/RubyProjects/relaton-cli/cachedb"
+Database is in "/Users/user/RubyProjects/relaton-cli/cachedb"
 ----
 
-==== Move cache DB
+==== Move database
 
 ----
 $ relaton db mv DIR
 ----
 
-Move cache DB to another place `DIR`.
+Move database to another place `DIR`.
 
 ----
 $ relaton db mv cache_dir
-Cache DB is moved to "/Users/user/RubyProjects/relaton-cli/cache_dir"
+Database is moved to "/Users/user/RubyProjects/relaton-cli/cache_dir"
 ----
 
-==== Clear cache DB
+==== Clear database
 
 Delete all entries from a chache DB.
 
@@ -349,13 +365,13 @@ Delete all entries from a chache DB.
 $ relaton db clear
 ----
 
-==== Fetch from cache DB
+==== Fetch from database
 
 ----
 $ 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 an entry from a database. See [relaton fetch](#relaton-fetch) for the arguments explanation.
 
 ==== Fetch all
 

data/lib/relaton/cli/command.rb

@@ -1,6 +1,7 @@
 require "relaton/cli/relaton_file"
 require "relaton/cli/xml_convertor"
 require "relaton/cli/yaml_convertor"
+require "relaton/cli/data_fetcher"
 require "relaton/cli/subcommand_collection"
 require "relaton/cli/subcommand_db"
 require "fcntl"
@@ -14,19 +15,19 @@ module Relaton
 
       desc "fetch CODE", "Fetch Relaton XML for Standard identifier CODE"
       option :type, aliases: :t, desc: "Type of standard to "\
-        "get bibliographic entry for"
+                                       "get bibliographic entry for"
       option :format, aliases: :f, desc: "Output format (xml, yaml, bibtex). "\
-        "Default xml."
+                                         "Default xml."
       option :year, aliases: :y, type: :numeric, desc: "Year the standard was "\
-        "published"
+                                                       "published"
       option :"all-parts", type: :boolean, desc: "Fetch all parts"
       option :"keep-year", type: :boolean, desc: "Undated reference should "\
-        "return actual reference with year"
+                                                 "return actual reference with year"
       option :retries, aliases: :r, type: :numeric, desc: "Number of network "\
         "retries. Default 1."
 
       def fetch(code)
-        io = IO.new(STDOUT.fcntl(::Fcntl::F_DUPFD), mode: "w:UTF-8")
+        io = IO.new($stdout.fcntl(::Fcntl::F_DUPFD), mode: "w:UTF-8")
         io.puts(fetch_document(code, options) || supported_type_message)
       end
 
@@ -43,7 +44,7 @@ module Relaton
         "DIRECTORY (containing Relaton-XML or YAML) into a Relaton Collection"
       option :title, aliases: :t,  desc: "Title of resulting Relaton collection"
       option :organization, aliases: :g, desc: "Organization owner of Relaton "\
-        "collection"
+                                               "collection"
       option :extension, aliases: :x, desc: "File extension of destination "\
         "Relaton file, defaults to 'rxl'"
 
@@ -61,15 +62,15 @@ module Relaton
       end
 
       desc "yaml2xml YAML", "Convert Relaton YAML into Relaton Collection XML "\
-        "or separate files"
+                            "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"
+                                         "Relaton XML files, defaults to empty"
       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"
+                                                        "prior to execution"
       option :overwrite, aliases: :f, type: :boolean, default: false,
                          desc: "Overwrite the existing file"
 
@@ -78,15 +79,15 @@ module Relaton
       end
 
       desc "xml2yaml XML", "Convert Relaton XML into Relaton Bibdata / "\
-        "Bibcollection YAML (and separate files)"
+                           "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"
+                                         "files, defaults to empty"
       option :outdir, aliases: :o, desc: "Output to the specified directory "\
-        "with individual Relaton Bibdata YAML files"
+                                         "with individual Relaton Bibdata YAML files"
       option :require, aliases: :r, type: :array, desc: "Require LIBRARY "\
-        "prior to execution"
+                                                        "prior to execution"
       option :overwrite, aliases: :f, type: :boolean, default: false,
                          desc: "Overwrite the existing file"
 
@@ -95,9 +96,9 @@ module Relaton
       end
 
       desc "xml2html RELATON-INDEX-XML", "Convert Relaton Collection XML into "\
-        "HTML"
+                                         "HTML"
       option :stylesheet, aliases: :s, desc: "Stylesheet file path for "\
-        "rendering HTML index"
+                                             "rendering HTML index"
       option :templatedir, aliases: :t, desc: "Liquid template directory for "\
         "rendering Relaton items and collection"
       option :overwrite, aliases: :f, type: :boolean, default: false,
@@ -108,9 +109,9 @@ module Relaton
       end
 
       desc "yaml2html RELATON-INDEX-YAML", "Concatenate Relaton Collection "\
-        "YAML into HTML"
+                                           "YAML into HTML"
       option :stylesheet, aliases: :s, desc: "Stylesheet file path for "\
-        "rendering HTML index"
+                                             "rendering HTML index"
       option :templatedir, aliases: :t, desc: "Liquid template directory for "\
         "rendering Relaton items and collection"
       option :overwrite, aliases: :f, type: :boolean, default: false,
@@ -137,10 +138,18 @@ module Relaton
               when "asciibib" then "adoc"
               else options[:format]
               end
-        output = options[:output] || file.sub(/(?<=\.)[^\.]+$/, ext)
+        output = options[:output] || file.sub(/(?<=\.)[^.]+$/, ext)
         File.write output, result, encoding: "UTF-8"
       end
 
+      desc "fetch-data SOURCE", "Fetch all the documents from a source"
+      option :output, aliases: :o, desc: "Output dir. Default: ./data/"
+      option :format, aliases: :f, desc: "Output format (yaml, xml). Default: yaml"
+
+      def fetch_data(source)
+        DataFetcher.fetch source, options
+      end
+
       desc "collection SUBCOMMAND", "Collection manipulations"
       subcommand "collection", SubcommandCollection
 

data/lib/relaton/cli/data_fetcher.rb

@@ -0,0 +1,15 @@
+module Relaton
+  module Cli
+    module DataFetcher
+      def fetch(source, options)
+        processor = Relaton::Registry.instance.find_processor_by_dataset source
+        opts = {}
+        opts[:output] = options[:output] if options[:output]
+        opts[:format] = options[:format] if options[:format]
+        processor.fetch_data source, opts
+      end
+
+      extend DataFetcher
+    end
+  end
+end

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "1.8.0".freeze
+    VERSION = "1.9.2".freeze
   end
 end

data/relaton-cli.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
   spec.add_development_dependency "byebug", "~> 11.0"
   # spec.add_development_dependency "debase"
@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
 
   spec.add_runtime_dependency "liquid", "~> 4"
-  spec.add_runtime_dependency "relaton", ">=1.8.0"
+  spec.add_runtime_dependency "relaton", ">= 1.9.1"
   spec.add_runtime_dependency "thor"
   spec.add_runtime_dependency "thor-hollaback"
 end

data/templates/_document.liquid

@@ -17,7 +17,7 @@
 
     <div class="doc-type-wrap">
       <div class="doc-type {{ document.type | downcase | split: " " | join: "-" }}">
-      {{ document.type }}
+      {{ document.doctype }}
       </div>
     </div>
   </div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-cli
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.9.1
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -237,6 +237,7 @@ files:
 - lib/relaton/cli.rb
 - lib/relaton/cli/base_convertor.rb
 - lib/relaton/cli/command.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
@@ -262,7 +263,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="