relaton-cli 1.7.4 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 117244541f4bff6b5e41ede9703dc58814cab590af276879ef90dddf1d10358e
-  data.tar.gz: 60102f93d726c6e5aa4d23faa0808c1b149648815d72773631df45c7736ff569
+  metadata.gz: 39535b9c177165d658eeeab7b43592dbf2deb05575b3fec1ecb1502ec564b555
+  data.tar.gz: 8a7a53cc3d078fa0f9b26279f91f59cb521271b5d67d34fc006f81dabc326dca
 SHA512:
-  metadata.gz: 94dfb0dfcdc1091cb83145c5454fde257d34c69b5e4bf8f1399666bc45b3998f6419b068e4ba75fbf615ce4298537c522f2176f95dffeb6e1bccb73a4d9c869a
-  data.tar.gz: aa63575174009b87161354f447b4de6c3c1715d1bdd44d69ec43b53d5d849a7e9c69bdf6638df6a7383409b42d464517ee59ce79509a2429c7c96bc9573ba8f5
+  metadata.gz: 4a0e825551c8ec3fef0fca053352791d4d0747c22cf6fcf190af60e6a2e482bfced0c00623adb5c6a2671879d561337d1c2c6f16e82e034443653f25a3e0ed10
+  data.tar.gz: '0846c248faf4471db8a408a56101ac1ca543418365393b312c85492f281e3d3e085c8b25a7008c7075dad8e9e358e0aea8845e8336b1ef0eae0945aee9fffcf4'

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,12 @@
+module Relaton
+  module Cli
+    module DataFetcher
+      def fetch(source, options)
+        processor = Relaton::Registry.instance.find_processor_by_dataset source
+        processor.fetch_data source, options
+      end
+
+      extend DataFetcher
+    end
+  end
+end

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "1.7.4".freeze
+    VERSION = "1.9.1".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.7.7"
+  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.7.4
+  version: 1.9.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-24 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.7.7
+        version: 1.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        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,14 +263,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Relaton Command-line Interface