relaton-cli 1.4.0 → 1.7.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d13fa9104c78c2a9bf1124ad4d191964c8aa6e0932be1984f21c0e1e0375daea
-  data.tar.gz: caceceb02f288b9993a76bb5d70cb0299cd2157e1740f4351f40b083bba4e84e
+  metadata.gz: b6c0e11fa51a48417dd591d2835b2637a79f9a021e58f1f1fb6e818d12e90ac3
+  data.tar.gz: da5753170d30401fab1a0b013a338ee3cd48da9d209a5ee17e83700f0999e59d
 SHA512:
-  metadata.gz: 19b8d69c34993fc76054bcf8e331a381f776b5da305d3936aa337a55b3ad2442d2cf493fcfa237e4da8b737debd1512c4965c6354fe12db4a40bcc5ee2487d1b
-  data.tar.gz: fec32e6be810a25db230c86f3946a0e9409103a1e7013c5ea73ee9b2ecea75274d420d53b77a2670b067459aecf96f8977c4e2f19332da4086e44dec8790f820
+  metadata.gz: cee2b8248080c68d64cc58e780e0aa77ba0ad9bd06d6e42ce4e8eda81c639bb2e5dd301e177cad0bdc12f3bd7d588a7f2b7f1eab9c426d1c81e6ef53e66e61a4
+  data.tar.gz: ed00bade15a250b8dcaa6d531c58ca1b979ad5a73175eb97a63593f1525ae62c4002f477e3bd84a717fdc571919e43f8021980c40d0e6dc9aba1282b050c6a51

data/.github/workflows/rake.yml

@@ -0,0 +1,46 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        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:
+          submodules: true
+
+      # https://github.com/ruby-debug/debase/issues/89#issuecomment-686827382
+      - if: matrix.os == 'macos-latest' && matrix.ruby == '2.5'
+        run: echo BUNDLE_BUILD__DEBASE="--with-cflags=\"-Wno-error=implicit-function-declaration\"" >> $GITHUB_ENV
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/Gemfile

@@ -5,4 +5,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in gemspec
 gemspec
-

data/docs/README.adoc

@@ -1,9 +1,7 @@
 = Relaton CLI (relaton-cli): Relaton Command-line Interface
 
 image:https://img.shields.io/gem/v/relaton-cli.svg["Gem Version", link="https://rubygems.org/gems/relaton-cli"]
-image:https://github.com/relaton/relaton-cli/workflows/ubuntu/badge.svg["Build Status", link="https://github.com/relaton/relaton-cli/actions?workflow=ubuntu"]
-image:https://github.com/relaton/relaton-cli/workflows/macos/badge.svg["Build Status", link="https://github.com/relaton/relaton-cli/actions?workflow=macos"]
-image:https://github.com/relaton/relaton-cli/workflows/windows/badge.svg["Build Status", link="https://github.com/relaton/relaton-cli/actions?workflow=windows"]
+image:https://github.com/relaton/relaton-cli/workflows/rake/badge.svg["Build Status", link="https://github.com/relaton/relaton-cli/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/relaton-cli/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/relaton-cli"]
 
 Documentation in development.
@@ -43,15 +41,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 `isobib`, `ietfbib`, `iecbib`, `gbbib`.
+* `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
 
@@ -217,3 +217,198 @@ $ relaton convert XML -f FORMAT -o OUTPUT-FILE
 ----
 
 Convert a Relaton XML document into YAML, AsciiBib, or BibTex format. Allowed -f or --format options are yaml, asciibib, bibtex. If the option -o or --output is omitted then a new file will be created in the folder where the original file is, with the same name but another appropriated extension.
+
+=== relaton collection
+
+The `relaton collection` is a set of subcommands for collections manipulations.
+
+==== relaton collection create
+
+----
+$ relaton collection create COLLECTION -d DIRECTORY --author AUTHOR --title TITLE --doctype DOCTYPE
+----
+
+Create new empty collection with name `COLLECTION`.
+* `DIRECTORY` is optional, and specifies path to a directory with collections. Default is `$HOME/.relaton/collections`.
+* `AUTHOR`, `TITLE`, and `DOCTYPE` are optional.
+
+==== relaton collection info
+
+----
+$ relaton collection info COLLECTION -d DIRECTORY
+----
+
+Show information about `COLLECTION` (number of items, file size of collection, last updated, name, metadata).
+* `DIRECTORY` is optional, and specifies path to a directory with collections. Default is `$HOME/.relaton/collections`.
+
+==== relaton collection list
+
+----
+$ relaton collection list -d DIRECTORY -e
+----
+
+List all collections.
+* `DIRECTORY` is optional, and specifies path to a directory with collections. Default is `$HOME/.relaton/collections`.
+* When parametr `-e` is defined the id of each entry id will be listed.
+
+==== relaton collection get
+
+----
+$ relaton collection get CODE -c COLLECTION -d DIRECTORY -f FORMAT -o FILE
+----
+
+Get a document matched to `CODE` from `COLLECTION`.
+
+* `COLLECTION` is optional name of collection. If undefined then fetch the first match across all collections in `DIRECTORY`.
+* `DIRECTORY` is optional, and specifies path to a directory with collections. Default is `$HOME/.relaton/collections`.
+* `FORMAT` is optional. If udefined then print documern in a human-readable form. Allowed values are `abb` (AsciiBib) or `xml` (XML).
+* `FILE` is optional. When it's defined then save document with given file name. File's extension defines format of the file. Possible extensions are `abb` (AsciiBib) or `xml` (XML).
+
+==== relaton collection find
+
+----
+$ relaton collection find TEXT -c COLLECTION -d DIRECTORY
+----
+
+Full-text search through a collection or all collections.
+
+* `COLLECTION` is optional name of collection. If udefined then search across all collections.
+* `DIRECTORY` is optional, and specifies path to a directory with collections. Default is `$HOME/.relaton/collections`.
+
+==== relaton collection fetch
+
+----
+$ relaton collection fetch CODE -t TYPE -y YEAR -c COLLECTION -d DIRECTORY
+----
+
+Fetch the Relaton XML entry corresponding to the document identifier `CODE` and save it into `COLLECTION`.
+
+* `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`.
+* `YEAR` is optional, and specifies the year of publication of the standard.
+* `COLLECTION` is a name of collection.
+* `DIRECTORY` is optional, and specifies path to a directory with collections. Default is `$HOME/.relaton/collections`.
+
+==== relaton collection export
+
+----
+$ relaton collection export COLLECTION -d DIRECTORY
+----
+
+Export `COLLECTION` into XML file.
+
+* `DIRECTORY` is optional, and specifies path to a directory with collections. Default is `$HOME/.relaton/collections`.
+
+==== relaton collection import
+
+----
+$ relaton collection import FILE -c COLLECTION -d DIRECTORY
+----
+
+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 caache 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/bibcollection.rb

@@ -8,36 +8,34 @@ module Relaton
 
     attr_accessor *ATTRIBS
 
-    # rubocop:disable Metrics/MethodLength
-
+    # @param options [Hash]
     def initialize(options)
-      self.items = []
       ATTRIBS.each do |k|
         value = options[k] || options[k.to_s]
         send("#{k}=", value)
       end
-      self.items = (items || []).reduce([]) do |acc, item|
-        acc << if item.is_a?(Bibcollection) || item.is_a?(Bibdata)
-                 item
-               else new_bib_item_class(item)
-               end
-      end
+      reduce_items
     end
-    # rubocop:enable Metrics/MethodLength
 
     # arbitrary number, must sort after all bib items
     def doc_number
       9999999
     end
 
+    # Add a dcoument to the collection
+    # @param item [RelatonBib::BibliographicItem]
+    def <<(item)
+      items << new_bib_item_class(item)
+    end
+
     # rubocop:disable Metrics/MethodLength
 
     # @param source [Nokogiri::XML::Element]
     def self.from_xml(source)
       title = find_text("./relaton-collection/title", source)
       author = find_text(
-        "./relaton-collection/contributor[role/@type='author']/organization/name",
-        source,
+        "./relaton-collection/contributor[role/@type='author']/organization/"\
+        "name", source
       )
 
       items = find_xpath("./relaton-collection/relation", source)&.map do |item|
@@ -48,29 +46,8 @@ module Relaton
 
       new(title: title, author: author, items: items)
     end
-    # rubocop:enable Metrics/MethodLength
-
-    def new_bib_item_class(options)
-      if options.is_a?(Hash) && options["items"]
-        ::Relaton::Bibcollection.new(options)
-      else
-        ::Relaton::Bibdata.new(options)
-      end
-    end
-
-    def items_flattened
-      items.sort_by! &:docnumber
-
-      items.reduce([]) do |acc,item|
-        acc << if item.is_a? ::Relaton::Bibcollection
-                 item.items_flattened
-               else
-                 item
-               end
-      end
-    end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
 
     # @param opts [Hash]
     # @return [String] XML
@@ -98,7 +75,37 @@ module Relaton
       end
       ret += "</relaton-collection>\n"
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+
+    # @param item [Hash, RelatonBib::BibliographicItem, Relatin::Bibdata,
+    #   Relaton::Bibcollection]
+    # @return [Relaton::Bibdata, Relaton::Bibcollection]
+    def new_bib_item_class(item)
+      if item.is_a?(Hash)
+        if item["items"]
+          ::Relaton::Bibcollection.new(item)
+        else
+          bibitem = ::Relaton::Cli::YAMLConvertor.convert_single_file item
+          ::Relaton::Bibdata.new bibitem
+        end
+      elsif item.is_a?(Relaton::Bibdata) || item.is_a?(Relaton::Bibcollection)
+        item
+      else ::Relaton::Bibdata.new(item)
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def items_flattened
+      items.sort_by! &:doc_number
+
+      items.reduce([]) do |acc, item|
+        acc << if item.is_a? ::Relaton::Bibcollection
+                 item.items_flattened
+               else
+                 item
+               end
+      end
+    end
 
     def to_yaml
       to_h.to_yaml
@@ -116,5 +123,16 @@ module Relaton
 
       { "root" => a }
     end
+
+    private
+
+    def reduce_items
+      self.items = (items || []).reduce([]) do |acc, item|
+        acc << if item.is_a?(Bibcollection) || item.is_a?(Bibdata)
+                 item
+               else new_bib_item_class(item)
+               end
+      end
+    end
   end
 end

data/lib/relaton/bibdata.rb

@@ -4,8 +4,10 @@ module Relaton
   class Bibdata
     URL_TYPES = %i[uri xml pdf doc html rxl txt].freeze
 
+    # @return [RelatonBib::BibliographicItem]
     attr_reader :bibitem
 
+    # @param bibitem [RelatonBib::BibliographicItem]
     def initialize(bibitem)
       @bibitem = bibitem
     end
@@ -44,7 +46,7 @@ module Relaton
       options = { bibdata: true, date_format: :full }.merge(
         opts.select { |k, _v| k.is_a? Symbol }
       )
-      @bibitem.to_xml nil, **options
+      @bibitem.to_xml **options
     end
 
     def to_h