relaton-cli 1.13.0 → 1.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67074e0aa3fa8c3f3badfa9cd924ff0f861aaf14fb456f7a051668be827f5f78
-  data.tar.gz: b01b4c8710566bbffaa64ffd16ac3ce2f4e5a0d1fa24b1f8924b1d2ada4321db
+  metadata.gz: 2ce962bd33e29dc88c310af3cf05bccd843c57a8b729f1579d3d965cf221ce37
+  data.tar.gz: e3168dee95d3efe4ac61678ec2fa29b8a073d19a44a97958c0043bf3047e43e4
 SHA512:
-  metadata.gz: f2e2eff22baaca6079ffd6ce9fa07abac954db8bbb16138e740c910ccf8f5b5fada43c3809616e2f810fdc0f6eb54e281eff95d29d7b417ec888e6cf778053e1
-  data.tar.gz: dcaf6f5e5fe0d708ee02b0671beb0906f6173e8e69e9334f77b41526b3c2ec0c6a5cd506d17226cc15080ee038cc6d7cdac5264b1c7fb3a32c954f70e158ab5f
+  metadata.gz: 6c46aba4bfd39f2006b69634dad27bc434ef669cfca55f831a2fa75de5b62a50d67a96fb514be124931a8e8fe3004027e506a01efa70aceccee503501f2f910d
+  data.tar.gz: b670592e721a5b98e077dcb49c3f0fa3c22c1984246fea09541c713a2888a283bd88ddc2d26c499398cadc86dc10c294b6ba81814a8286e613065e8133490e56

data/.github/workflows/rake.yml

@@ -5,7 +5,6 @@ name: rake
 on:
   push:
     branches: [ master, main ]
-    tags: [ v* ]
   pull_request:
 
 jobs:

data/.github/workflows/release.yml

@@ -15,31 +15,8 @@ on:
 
 jobs:
   release:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '2.6'
-          bundler-cache: true
-
-      - run: gem install gem-release
-
-      - run: |
-          git config user.name github-actions
-          git config user.email github-actions@github.com
-
-      - if: github.event_name == 'workflow_dispatch' && github.event.inputs.next_version != 'skip'
-        run: gem bump --version ${{ github.event.inputs.next_version }} --tag --push
-
-      - name: publish to rubygems.org
-        env:
-          RUBYGEMS_API_KEY: ${{secrets.RELATON_CI_RUBYGEMS_API_KEY}}
-        run: |
-          envsubst << 'EOF' > ~/.gem/credentials
-          ---
-          :rubygems_api_key: ${RUBYGEMS_API_KEY}
-          EOF
-          chmod 0600 ~/.gem/credentials
-          gem release
+    uses: relaton/support/.github/workflows/release.yml@master
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.RELATON_CI_RUBYGEMS_API_KEY }}

data/docs/README.adoc

@@ -10,7 +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.
+Each command has an option `--verbose` (the short form is `-v`). Use the option to get warnings in the commands output.
 The following commands are provided.
 
 === relaton concatenate
@@ -23,7 +23,7 @@ $ relaton concatenate Source-Directory Relaton-Collection-File -t TITLE -g ORGAN
 Iterates through all the Relaton files (YAML and XML) in `Source-Directory`, and concatenates them into a Relaton Collection file. The extension of the Collection file can be set using the `Relaton-Collection-File` file name (i.e, if it uses an extension of `yaml`, a Relaton YAML file will be created; if `rxl`, a Relaton XML file will be created, or via the `-x [ext]` (or `--extension`) option.
 
 For each Relaton input file in the `Source-Directory`, if a document file with the same base name is identified (i.e. an XML, HTML, PDF or DOC
-file), a link to that file is inserted.
+file) a link to that file is inserted.
 
 If the `TITLE` or `ORGANIZATION` options are given, they are added to the `Collection-File` output as the
 title and author of the `Relaton-Collection-File` document.
@@ -47,12 +47,12 @@ $ relaton fetch CODE -t TYPE -f FORMAT -y YEAR -r RETRIES --all-parts --keep-yea
 
 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), 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 `3GPP, BIPM, BSI, CC, CEN, CIE, CN, ECMA, IANA, IEC, IEEE, IETF, IHO, ISO, ITU, NIST, OGC, OMG, UN, W3C`.
+* `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`.
 * `RETRIES` is optional, number of network retries (default 1).
 * `--all-parts` fetch all parts.
-* `--keep-year` undated reference should return actual reference with year.
+* `--keep-year` undated reference should return an actual reference with year.
 
 === relaton fetch-data
 
@@ -61,25 +61,26 @@ Fetch the Relaton XML entry corresponding to the document identifier `CODE`.
 $ 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`.
+Fetch all the documents from a `DATASET` source and save them to a folder `DIR` in the format `FORMAT`.
 
-Foloowing datasets are availabe:
+The following datasets are available:
 
 * `nist-tech-pubs` - https://raw.githubusercontent.com/usnistgov/NIST-Tech-Pubs/nist-pages/xml/allrecords.xml
 * `cie-techstreet` - https://www.techstreet.com/cie/searches/31156444
 * `calconnect-org` - https://standards.calconnect.org/relaton/index.yaml
 * `ogc-naming-authority` - https://raw.githubusercontent.com/opengeospatial/NamingAuthority/master/incubation/bibliography/bibliography.json
-* `ieee-rawbib` - looks for the IEEE dataset in local `./ieee-rawbib` directory. The dataset could be downloaded from https://github.com/ietf-ribose/ieee-rawbib repository
+* `ieee-rawbib` - looks for the IEEE dataset in the local `./ieee-rawbib` directory. The dataset could be downloaded from https://github.com/ietf-ribose/ieee-rawbib repository
 * `w3c-rdf` - http://www.w3.org/2002/01/tr-automation/tr.rdf
 * `w3c-tr-archive` - looks for the W3C archive dataset in local `./w3c-tr-archive` directory. The dataset could be downloaded from https://github.com/relaton/w3c-tr-archive repository
 * `iana-registries` - https://github.com/ietf-ribose/iana-registries
-* `status-smg-3GPP` - ftp://www.3gpp.org/Information/Databases/Spec_Status/
+* `status-smg-3GPP` - updates previously downloaded data if a new archive is available in ftp://www.3gpp.org/Information/Databases/Spec_Status/
+* `status-smg-3GPP-force` - download data from the latest archive in ftp://www.3gpp.org/Information/Databases/Spec_Status/
 * `ietf-rfcsubseries` - https://www.rfc-editor.org/rfc-index.xml (`<bcp-entry>`, `<fyi-entry>`, `<std-entry>`)
-* `ietf-internet-drafts` - looks for the Internet-Drafts dataset in local `./bibxml-ids` directory. The dataset could be downloaded using `rsync -avcizxL rsync.ietf.org::bibxml-ids ./bibxml-ids` command.
+* `ietf-internet-drafts` - looks for the Internet-Drafts dataset in the local `./bibxml-ids` directory. The dataset could be downloaded using `rsync -avcizxL rsync.ietf.org::bibxml-ids ./bibxml-ids` command.
 * `ietf-rfc-entries` - https://www.rfc-editor.org/rfc-index.xml (`<rfc-entry>`)
 * `oasis-open` - https://www.oasis-open.org/standards/
-* `bipm-data-outcomes` - looks for the BIPM dataset in local `./bipm-data-outcomes` directory. The dataset could be downloaded from https://github.com/metanorma/bipm-data-outcomes repository
-* `si-brochure` - looks for the SI-Brochure dataset in local `./bipm-si-brocure` directory. The dataset could be downloaded from https://github.com/metanorma/bipm-si-brochure repository
+* `bipm-data-outcomes` - looks for the BIPM dataset in the local `./bipm-data-outcomes` directory. The dataset could be downloaded from https://github.com/metanorma/bipm-data-outcomes repository
+* `si-brochure` - looks for the SI-Brochure dataset in the local `./bipm-si-brocure` directory. The dataset could be downloaded from https://github.com/metanorma/bipm-si-brochure repository
 
 Options:
 
@@ -116,7 +117,7 @@ There are two templates necessary:
 
 ** Index template (`_index.liquid_`)
 
-*** The HTML Template file `_index.liquid` recognises the following parameters:
+*** The HTML Template file `_index.liquid` recognizes the following parameters:
 *** `css`: where the CSS stylesheet `stylesheet` is injected
 *** `title`: the Title of the collection, `./relaton-collection/title` in `relaton-xml`
 *** `author`: the Author of the collection, `./relaton-collection/contributor[role/@type = 'author']/organization/name` in `relaton-xml`
@@ -124,7 +125,7 @@ There are two templates necessary:
 
 ** Individual bibliographic entries template (`_document.liquid`)
 
-*** This template recognises attributes of a bibliographic entry (`document`) which follow the naming convention of <<relaton-yaml,Relaton YAML>>; e.g. `document.html` is the HTML URI for the document.
+*** This template recognizes attributes of a bibliographic entry (`document`) that follow the naming convention of <<relaton-yaml,Relaton YAML>>; e.g. `document.html` is the HTML URI for the document.
 
 The default stylesheet and templates are given (which also demonstrates the structure) in the `templates` directory.
 
@@ -186,7 +187,7 @@ $ relaton yaml2xml YAML -o OUTPUT-DIRECTORY -x RELATON_EXTENSION -p PREFIX -r LI
 Convert a Relaton YAML file (`filename.yaml`) into a Relaton XML file (`filename.xml`). If the Relaton YAML file specifies multiple bibliograph items, and `OUTPUT-DIRECTORY` is nominated, also convert the file into a list of Relaton XML files for each entry, stored in that directory. The document identifier is used as the name of each Relaton XML file; the Relaton XML filename is suffixed with `RELATON_EXTENSION` (default `.rxl`) and prefixed with `PREFIX` (default empty). Any libraries that need to be required for the conversion are specified in `LIBRARY` as a space-delimited list.
 
 [[relaton-yaml]]
-A Relaton Collection YAML file contains some initial metadata, and a list of metadata about each bibliographic entry:
+A Relaton Collection YAML file contains some initial metadata and a list of metadata about each bibliographic entry:
 
 [source,yaml]
 ----

data/lib/relaton/cli/relaton_file.rb

@@ -109,7 +109,7 @@ module Relaton
         @relaton_collection ||= Bibcollection.from_xml(nokogiri_document(nil, source))
       end
 
-      def extract_and_write_to_files
+      def extract_and_write_to_files # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         select_source_files.each do |file|
           xml = nokogiri_document(nil, file)
           xml.remove_namespaces!

data/lib/relaton/cli/subcommand_collection.rb

@@ -7,8 +7,8 @@ module Relaton
       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."
+      option :dir, aliases: :d, desc: "Directory to store collection. " \
+                                      "Default is $HOME/.relaton/collections."
       option :author, desc: "Author"
       option :title, desc: "Title"
       option :doctype, desc: "Documents type"
@@ -20,14 +20,14 @@ module Relaton
         if File.exist? file_path
           warn "Collection #{file} aready exist"
         else
-          Dir.mkdir dir unless Dir.exist? dir
+          FileUtils.mkdir_p dir # unless Dir.exist? dir
           File.write file_path, col.to_yaml, encoding: "UTF-8"
         end
       end
 
       desc "info COLLECTION", "View collection information"
-      option :dir, aliases: :d, desc: "Directory to store collection. Default "\
-        "is $HOME/.relaton/collections."
+      option :dir, aliases: :d, desc: "Directory to store collection. " \
+                                      "Default is $HOME/.relaton/collections."
 
       def info(file) # rubocop:disable Metrics/AbcSize
         path = File.join directory, file
@@ -41,8 +41,8 @@ module Relaton
       end
 
       desc "list", "List collections"
-      option :dir, aliases: :d, desc: "Directory with collections. Default is "\
-        "$HOME/.relaton/collections."
+      option :dir, aliases: :d, desc: "Directory with collections. Default " \
+                                      "is $HOME/.relaton/collections."
       option :entries, aliases: :e, type: :boolean, desc: "Show entries"
 
       def list
@@ -58,13 +58,13 @@ module Relaton
       map ls: :list
 
       desc "get CODE", "Fetch document from collection by ID"
-      option :collection, aliases: :c, desc: "Collection to fetch document. "\
+      option :collection, aliases: :c, desc: "Collection to fetch document. " \
         "By default fetch the first match across all collections."
-      option :dir, aliases: :d, desc: "Directory with collections. Default is "\
-        "$HOME/.relaton/collections."
-      option :format, aliases: :f, desc: "Output format (xml, abb). "\
+      option :dir, aliases: :d, desc: "Directory with collections. Default " \
+                                      "is $HOME/.relaton/collections."
+      option :format, aliases: :f, desc: "Output format (xml, abb). " \
         "If not defined the output in a human-readable form."
-      option :output, aliases: :o, desc: "Output to the specified file. The "\
+      option :output, aliases: :o, desc: "Output to the specified file. The " \
         " file's extension (abb, xml) defines output format."
 
       def get(docid)
@@ -79,10 +79,10 @@ module Relaton
       end
 
       desc "find TEXT", "Full-text search"
-      option :collection, aliases: :c, desc: "Collection to search text. "\
+      option :collection, aliases: :c, desc: "Collection to search text. " \
         "By default search across all collections."
-      option :dir, aliases: :d, desc: "Directory with collections. Default is "\
-        "$HOME/.relaton/collections."
+      option :dir, aliases: :d, desc: "Directory with collections. Default is " \
+                                      "$HOME/.relaton/collections."
 
       def find(text)
         collections.each do |col|
@@ -98,14 +98,14 @@ module Relaton
       map search: :find
 
       desc "fetch CODE", "Fetch a document and store it into a collection"
-      option :type, aliases: :t, required: true, desc: "Type of standard to "\
-        "get bibliographic entry for"
-      option :year, aliases: :y, type: :numeric, desc: "Year the standard was "\
-        "published"
-      option :collection, aliases: :c, required: true, desc: "Collection "\
-        "to store a document"
-      option :dir, aliases: :d, desc: "Directory with collections. Default is "\
-        "$HOME/.relaton/collections."
+      option :type, aliases: :t, required: true,
+                    desc: "Type of standard to get bibliographic entry for"
+      option :year, aliases: :y, type: :numeric,
+                    desc: "Year the standard was published"
+      option :collection, aliases: :c, required: true,
+                          desc: "Collection to store a document"
+      option :dir, aliases: :d, desc: "Directory with collections. Default is " \
+                                      "$HOME/.relaton/collections."
 
       def fetch(code) # rubocop:disable Metrics/AbcSize
         doc = Relaton.db.fetch(code, options[:year]&.to_s)
@@ -118,12 +118,13 @@ module Relaton
         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 :dir, aliases: :d, desc: "Directory with collections. Default is "\
-        "$HOME/.relaton/collections."
+      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 :dir, aliases: :d, desc: "Directory with collections. Default is " \
+                                      "$HOME/.relaton/collections."
 
       def import(file) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
         collfile = File.join directory, options[:collection]
@@ -143,12 +144,12 @@ module Relaton
       end
 
       desc "export COLLECTION", "Export collection into XML file"
-      option :dir, aliases: :d, desc: "Directory with collections. Default is "\
-        "$HOME/.relaton/collections."
+      option :dir, aliases: :d, desc: "Directory with collections. Default is " \
+                                      "$HOME/.relaton/collections."
 
       def export(file)
         coll = read_collection File.join(directory, file)
-        outfile = file.sub(/\.\w+$/, "") + ".xml"
+        outfile = "#{file.sub(/\.\w+$/, '')}.xml"
         File.write outfile, coll.to_xml(bibdata: true), encoding: "UTF-8"
       end
 
@@ -194,7 +195,7 @@ module Relaton
         return unless options[:entries]
 
         Relaton::Bibcollection.new(hash["root"]).items.each do |b|
-          puts "  " + b.docidentifier
+          puts "  #{b.docidentifier}"
         end
       end
 

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "1.13.0".freeze
+    VERSION = "1.14.1".freeze
   end
 end

data/relaton-cli.gemspec

@@ -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.13.0"
+  spec.add_runtime_dependency "relaton", "~> 1.14.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.13.0
+  version: 1.14.1
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-21 00:00:00.000000000 Z
+date: 2022-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -256,7 +256,7 @@ homepage: https://github.com/metanorma/relaton-cli
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -271,8 +271,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Relaton Command-line Interface
 test_files: []