relaton-cli 1.5.pre → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06c38df62c297fd9442baf35d93d67c88ba4db3f5de065c9b60f6acd3ed21aa5
-  data.tar.gz: 6edcec27f8a15828986f1fbe7b15ed3974c64132b08f3ac0a8a8b6f88b32f794
+  metadata.gz: fa8a9b957e64afa8d7d001e5a0a8ba7f33121d03cf9e741895341b0f33e09d15
+  data.tar.gz: 8e8894eccf7b2ed2791885fe585257333d945a36f79297cfc8765788e8439b9b
 SHA512:
-  metadata.gz: 4f98489915c8424bc4240fe9ebeab0fd4cd9aaca450a42a44625b95a6ebc1dc33a1ab87e02963fbe2d6ed99e3bd11792aef54e994781e15ef63fbe963e8974a2
-  data.tar.gz: bfe7348c746b684a6091fab7b4669cb00392ebcc64bf120bf6cb72454bae151a816099f92fd6cb43605ed1e056b5d66ce5341813f359ced5691caad46c3d2be8
+  metadata.gz: 65a081d40aa9b4dab76d1d5508490715376abb28b3e7e359ede98dac55d4b27ca77a09b667ff1236bb3bc639013ad86799b76df0d887d8a3ab2c90fc7d0843c0
+  data.tar.gz: a3f4a5d4a87c2d227550cf955668e771c07e6c7efdd37283551df7d38517124db7a9049997e2a2aed4474c553ee5750bf7c8e5a90a3a6506475ed499e9825f91

data/.github/workflows/macos.yml

@@ -19,13 +19,15 @@ jobs:
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           architecture: 'x64'
       - name: Update gems
         run: |
           sudo gem install bundler --force
+          ruby -v | grep 2.5 && bundle config set build.debase --with-cflags="-Wno-error=implicit-function-declaration"
+          ruby -v | grep 2.5 && bundle config set build.ruby-debug-ide --with-cflags="-Wno-error=implicit-function-declaration"
           bundle install --jobs 4 --retry 3
       - name: Run specs
         run: |

data/.github/workflows/ubuntu.yml

@@ -19,7 +19,7 @@ jobs:
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           architecture: 'x64'

data/.github/workflows/windows.yml

@@ -19,7 +19,7 @@ jobs:
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           architecture: 'x64'

data/docs/README.adoc

@@ -50,8 +50,7 @@ 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`.
+* `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`.
 
 === relaton extract
 
@@ -217,3 +216,94 @@ $ 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`.

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

data/lib/relaton/cli.rb

@@ -16,40 +16,58 @@ module Relaton
       end
     end
 
-    def self.start(arguments)
-      Relaton::Cli::Command.start(arguments)
-    end
+    class << self
+      def start(arguments)
+        Relaton::Cli::Command.start(arguments)
+      end
 
-    # Relaton
-    #
-    # Based on current setup, we need to initiate a Db instance to
-    # register all of it's supported processor backends. To make it
-    # easier we have added it as a class method so we can use this
-    # whenever necessary.
-    #
-    def self.relaton
-      RelatonDb.instance.db
-    end
+      # Relaton
+      #
+      # Based on current setup, we need to initiate a Db instance to
+      # register all of it's supported processor backends. To make it
+      # easier we have added it as a class method so we can use this
+      # whenever necessary.
+      #
+      def relaton
+        RelatonDb.instance.db
+      end
 
-    # @param content [Nokogiri::XML::Document]
-    # @return [RelatonBib::BibliographicItem, RelatonIsoBib::IsoBibliongraphicItem]
-    def self.parse_xml(doc)
-      if (proc = Cli.processor(doc))
-        proc.from_xml(doc.to_s)
-      else
-        RelatonBib::XMLParser.from_xml(doc.to_s)
+      # @param content [Nokogiri::XML::Document]
+      # @return [RelatonBib::BibliographicItem,
+      #   RelatonIsoBib::IsoBibliongraphicItem]
+      def parse_xml(doc)
+        if (proc = Cli.processor(doc))
+          proc.from_xml(doc.to_s)
+        else
+          RelatonBib::XMLParser.from_xml(doc.to_s)
+        end
       end
-    end
 
-    # @param doc [Nokogiri::XML::Element]
-    # @return [String] Type prefix
-    def self.processor(doc)
-      docid = doc.at "docidentifier"
-      if docid && docid[:type]
-        proc = Relaton::Registry.instance.by_type(docid[:type])
+      # @param doc [Nokogiri::XML::Element]
+      # @return [RelatonIso::Processor, RelatonIec::Processor,
+      #   RelatonNist::Processor, RelatonIetf::Processot,
+      #   RelatonItu::Processor, RelatonGb::Processor,
+      #   RelatonOgc::Processor, RelatonCalconnect::Processor]
+      def processor(doc)
+        docid = doc.at "docidentifier"
+        proc = get_proc docid
         return proc if proc
+
+        Relaton::Registry.instance.by_type(docid&.text&.match(/^\w+/)&.to_s)
+      end
+
+      private
+
+      # @param doc [Nokogiri::XML::Element]
+      # @return [RelatonIso::Processor, RelatonIec::Processor,
+      #   RelatonNist::Processor, RelatonIetf::Processot,
+      #   RelatonItu::Processor, RelatonGb::Processor,
+      #   RelatonOgc::Processor, RelatonCalconnect::Processor]
+      def get_proc(docid)
+        return unless docid && docid[:type]
+
+        Relaton::Registry.instance.by_type(docid[:type])
       end
-      Relaton::Registry.instance.by_type(docid&.text&.match(/^\w+/)&.to_s)
     end
   end
 end

data/lib/relaton/cli/base_convertor.rb

@@ -52,7 +52,7 @@ module Relaton
         Relaton::Cli::XmlToHtmlRenderer.render(
           xml_content(file),
           stylesheet: options[:style],
-          liquid_dir: options[:template],
+          liquid_dir: options[:template]
         )
       end
 

data/lib/relaton/cli/command.rb

@@ -1,93 +1,128 @@
 require "relaton/cli/relaton_file"
 require "relaton/cli/xml_convertor"
 require "relaton/cli/yaml_convertor"
+require "relaton/cli/subcommand_collection"
 require "fcntl"
 
 module Relaton
   module Cli
     class Command < Thor
       desc "fetch CODE", "Fetch Relaton XML for Standard identifier CODE"
-      option :type, aliases: :t, required: true, desc: "Type of standard to get bibliographic entry for"
-      option :format, aliases: :f, desc: "Output format (xml, bibtex). Default xml."
-      option :year, aliases: :y, type: :numeric, desc: "Year the standard was published"
+      option :type, aliases: :t, required: true, desc: "Type of standard to "\
+        "get bibliographic entry for"
+      option :format, aliases: :f, desc: "Output format (xml, bibtex). "\
+        "Default xml."
+      option :year, aliases: :y, type: :numeric, desc: "Year the standard was "\
+        "published"
 
       def fetch(code)
         Relaton.db
-        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
 
-      desc "extract Metanorma-XML-File / Directory Relaton-XML-Directory", "Extract Relaton XML from Metanorma XML file / directory"
-      option :extension, aliases: :x, default: "rxl", desc: "File extension of Relaton XML files, defaults to 'rxl'"
+      desc "extract Metanorma-XML-File / Directory Relaton-XML-Directory",
+           "Extract Relaton XML from Metanorma XML file / directory"
+      option :extension, aliases: :x, default: "rxl", desc: "File extension "\
+        "of Relaton XML files, defaults to 'rxl'"
 
       def extract(source_dir, outdir)
         Relaton::Cli::RelatonFile.extract(source_dir, outdir, options)
       end
 
-      desc "concatenate SOURCE-DIR COLLECTION-FILE", "Concatenate entries in DIRECTORY (containing Relaton-XML or YAML) into a Relaton Collection"
+      desc "concatenate SOURCE-DIR COLLECTION-FILE", "Concatenate entries in "\
+        "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"
-      option :new, aliases: :n, type: :boolean, desc: "Use the new Relaton YAML format"
-      option :extension, aliases: :x, desc: "File extension of destination Relaton file, defaults to 'rxl'"
+      option :organization, aliases: :g, desc: "Organization owner of Relaton "\
+        "collection"
+      option :new, aliases: :n, type: :boolean, desc: "Use the new Relaton "\
+        "YAML format"
+      option :extension, aliases: :x, desc: "File extension of destination "\
+        "Relaton file, defaults to 'rxl'"
 
       def concatenate(source_dir, outfile)
         Relaton::Cli::RelatonFile.concatenate(source_dir, outfile, options)
       end
 
-      desc "split Relaton-Collection-File Relaton-XML-Directory", "Split a Relaton Collection into multiple files"
-      option :extension, aliases: :x, default: "rxl", desc: "File extension of Relaton XML files, defaults to 'rxl'"
-      option :new, aliases: :n, type: :boolean, desc: "Use the new Relaton YAML format"
+      desc "split Relaton-Collection-File Relaton-XML-Directory", "Split a "\
+        "Relaton Collection into multiple files"
+      option :extension, aliases: :x, default: "rxl", desc: "File extension "\
+        "of Relaton XML files, defaults to 'rxl'"
+      option :new, aliases: :n, type: :boolean, desc: "Use the new Relaton "\
+        "YAML format"
 
       def split(source, outdir)
         Relaton::Cli::RelatonFile.split(source, outdir, options)
       end
 
-      desc "yaml2xml YAML", "Convert Relaton YAML into Relaton Collection XML 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"
-      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"
-      option :overwrite, aliases: :f, type: :boolean, default: false, desc: "Overwrite the existing file"
+      desc "yaml2xml YAML", "Convert Relaton YAML into Relaton Collection XML "\
+        "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"
+      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"
+      option :overwrite, aliases: :f, type: :boolean, default: false,
+                         desc: "Overwrite the existing file"
 
       def yaml2xml(filename)
         Relaton::Cli::YAMLConvertor.to_xml(filename, options)
       end
 
-      desc "xml2yaml XML", "Convert Relaton XML into Relaton Bibdata / 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"
-      option :outdir, aliases: :o, desc: "Output to the specified directory with individual Relaton Bibdata YAML files"
-      option :require, aliases: :r, type: :array, desc: "Require LIBRARY prior to execution"
-      option :overwrite, aliases: :f, type: :boolean, default: false, desc: "Overwrite the existing file"
+      desc "xml2yaml XML", "Convert Relaton XML into Relaton Bibdata / "\
+        "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"
+      option :outdir, aliases: :o, desc: "Output to the specified directory "\
+        "with individual Relaton Bibdata YAML files"
+      option :require, aliases: :r, type: :array, desc: "Require LIBRARY "\
+        "prior to execution"
+      option :overwrite, aliases: :f, type: :boolean, default: false,
+                         desc: "Overwrite the existing file"
 
       def xml2yaml(filename)
         Relaton::Cli::XMLConvertor.to_yaml(filename, options)
       end
 
-      desc "xml2html RELATON-INDEX-XML", "Convert Relaton Collection XML into HTML"
-      option :stylesheet, aliases: :s, desc: "Stylesheet file path for 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, desc: "Overwrite the existing file"
+      desc "xml2html RELATON-INDEX-XML", "Convert Relaton Collection XML into "\
+        "HTML"
+      option :stylesheet, aliases: :s, desc: "Stylesheet file path for "\
+        "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,
+                         desc: "Overwrite the existing file"
 
       def xml2html(file, style = nil, template = nil)
         Relaton::Cli::XMLConvertor.to_html(file, style, template)
       end
 
-      desc "yaml2html RELATON-INDEX-YAML", "Concatenate Relaton Collection YAML into HTML"
-      option :stylesheet, aliases: :s, desc: "Stylesheet file path for 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, desc: "Overwrite the existing file"
+      desc "yaml2html RELATON-INDEX-YAML", "Concatenate Relaton Collection "\
+        "YAML into HTML"
+      option :stylesheet, aliases: :s, desc: "Stylesheet file path for "\
+        "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,
+                         desc: "Overwrite the existing file"
 
       def yaml2html(file, style = nil, template = nil)
         Relaton::Cli::YAMLConvertor.to_html(file, style, template)
       end
 
       desc "convert XML", "Convert Relaton XML document"
-      option :format, aliases: :f, required: true, desc: "Output format (yaml, bibtex, asciibib)"
+      option :format, aliases: :f, required: true, desc: "Output format "\
+        "(yaml, bibtex, asciibib)"
       option :output, aliases: :o, desc: "Output to the specified file"
 
-      def convert(file)
-        item = Relaton::Cli.parse_xml Nokogiri::XML(File.read(file, encoding: "UTF-8"))
+      def convert(file) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        xml = Nokogiri::XML(File.read(file, encoding: "UTF-8"))
+        item = Relaton::Cli.parse_xml xml
         result = if /yaml|yml/.match?(options[:format])
                    item.to_hash.to_yaml
                  else item.send "to_#{options[:format]}"
@@ -101,6 +136,9 @@ module Relaton
         File.write output, result, encoding: "UTF-8"
       end
 
+      desc "collection SUBCOMMAND", "Collection manipulations"
+      subcommand "collection", SubcommandCollection
+
       private
 
       # @param code [String]

data/lib/relaton/cli/full_text_search.rb

@@ -0,0 +1,91 @@
+# require "forwardable"
+
+module Relaton
+  class FullTextSeatch
+    # extend Forwardable
+
+    # def_delegators :@collections, :<<
+
+    # @return Regexp
+    attr_reader :regex
+
+    # @param collection [Relaton::Bibcollection]
+    def initialize(collection)
+      @collection = collection
+    end
+
+    # @param text [String]
+    # @return [Array<Hash>]
+    def search(text)
+      @regex = %{(.*?)(.{0,20})(#{text})(.{0,20})(.*)}
+      @matches = @collection.items.reduce({}) do |m, item|
+        # m + results(col, rgx)
+        res = result item
+        m[item.id] = res if res.any?
+        m
+      end
+    end
+
+    def print_results
+      @matches.each do |docid, attrs|
+        puts "  Document ID: #{docid}"
+        print_attrs attrs, 4
+      end
+    end
+
+    # @return [Boolean]
+    def any?
+      @matches.any?
+    end
+
+    private
+
+    # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+    def print_attrs(attrs, indent)
+      ind = " " * indent
+      if attrs.is_a? String then puts ind + attrs
+      elsif attrs.is_a? Hash
+        attrs.each do |key, val|
+          pref = "#{ind}#{key}:"
+          if val.is_a? String then puts pref + " " + val
+          else
+            puts pref
+            print_attrs val, indent + 2
+          end
+        end
+      elsif attrs.is_a? Array then attrs.each { |v| print_attrs v, indent + 2 }
+      end
+    end
+
+    # @param item [Relaton::Bibdata]
+    # @return [Hash]
+    def result(item)
+      if item.is_a? String
+        message $~ if item.match regex
+      elsif item.respond_to? :reduce
+        item.reduce([]) do |m, i|
+          res = result i
+          m << res if res && !res.empty?
+          m
+        end
+      else
+        item.instance_variables.reduce({}) do |m, var|
+          res = result item.instance_variable_get(var)
+          m[var.to_s.tr(":@", "")] = res if res && !res.empty?
+          m
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
+
+    # @param match [MatchData]
+    # @return [String]
+    def message(match)
+      msg = ""
+      msg += "..." unless match[1].empty?
+      msg += "#{match[2]}\e[4m#{match[3]}\e[24m#{match[4]}"
+      msg += "..." unless match[5].empty?
+      msg
+    end
+  end
+end

data/lib/relaton/cli/relaton_file.rb

@@ -150,7 +150,7 @@ module Relaton
             mem << bibdata_instance(doc, xml[:file])
           else mem
           end
-        end.uniq &:id
+        end
       end
 
       def concatenate_and_write_to_files

data/lib/relaton/cli/subcommand_collection.rb

@@ -0,0 +1,221 @@
+require "relaton/cli/full_text_search"
+
+module Relaton
+  module Cli
+    class SubcommandCollection < Thor
+      desc "create COLLECTION", "Create collection"
+      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"
+
+      def create(file)
+        dir = directory
+        file_path = File.join dir, file
+        col = Relaton::Bibcollection.new options
+        if File.exist? file_path
+          warn "Collection #{file} aready exist"
+        else
+          Dir.mkdir 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."
+
+      def info(file) # rubocop:disable Metrics/AbcSize
+        path = File.join directory, file
+        puts "Collection: #{File.basename path}"
+        puts "Last updated: #{File.mtime path}"
+        puts "File size: #{File.size path}"
+        col = Relaton::Bibcollection.new YAML.load_file(path)["root"]
+        puts "Number of items: #{col.items.size}"
+        puts "Author: #{col.author}"
+        puts "Title: #{col.title}"
+      end
+
+      desc "list", "List 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
+        Dir[File.join(directory, "*")].each do |f|
+          yml = read_yaml f
+          if yml && yml["root"]
+            puts File.basename f
+            puts_entries yml
+          end
+        end
+      end
+
+      map ls: :list
+
+      desc "get CODE", "Fetch document from collection by ID"
+      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). "\
+        "If not defined the output in a human-readable form."
+      option :output, aliases: :o, desc: "Output to the specified file. The "\
+        " file's extension (abb, xml) defines output format."
+
+      def get(docid)
+        collections.each do |col|
+          col[:collection].items.each do |item|
+            if item.docidentifier == docid
+              output_item(item)
+              return
+            end
+          end
+        end
+      end
+
+      desc "find TEXT", "Full-text search"
+      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."
+
+      def find(text)
+        collections.each do |col|
+          searcher = Relaton::FullTextSeatch.new(col[:collection])
+          searcher.search text
+          if searcher.any?
+            puts "Collection: #{File.basename(col[:file])}"
+            searcher.print_results
+          end
+        end
+      end
+
+      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."
+
+      def fetch(code)
+        doc = Cli.relaton.fetch(code, options[:year]&.to_s)
+        if doc
+          colfile = File.join directory, options[:collection]
+          coll = read_collection colfile
+          coll << doc
+          File.write colfile, coll.to_yaml, encoding: "UTF-8"
+        else "No matching bibliographic entry found"
+        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."
+
+      def import(file) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        collfile = File.join directory, options[:collection]
+        coll = read_collection collfile
+        xml = Nokogiri::XML File.read(file, encoding: "UTF-8")
+        if xml.at "relaton-collection"
+          if coll
+            coll << Relaton::Bibcollection.from_xml(xml)
+          else
+            coll = Relaton::Bibcollection.from_xml(xml)
+          end
+        else
+          coll ||= Relaton::Bibcollection.new({})
+          coll << Relaton::Bibdata.from_xml(xml)
+        end
+        File.write collfile, coll.to_yaml, encoding: "UTF-8"
+      end
+
+      desc "export COLLECTION", "Export collection into XML file"
+      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"
+        File.write outfile, coll.to_xml(bibdata: true), encoding: "UTF-8"
+      end
+
+      private
+
+      # @return [String]
+      def directory
+        options.fetch :dir, File.join(Dir.home, ".relaton/collections")
+      end
+
+      # @param file [String]
+      # @return [Hash]
+      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."
+      end
+
+      # @param file [String]
+      # @return [Relaton::Bibcollection, nil]
+      def read_collection(file)
+        return unless File.file?(file)
+
+        Relaton::Bibcollection.new YAML.load_file(file)["root"]
+      end
+
+      # @return [Array<Hash>]
+      def collections
+        file = options.fetch :collection, "*"
+        Dir[File.join directory, file].reduce([]) do |m, f|
+          yml = read_yaml f
+          if yml && yml["root"]
+            m << { collection: Relaton::Bibcollection.new(yml["root"]),
+                   file: f }
+          end
+          m
+        end
+      end
+
+      # Puts document IDs for each item in tthe cokllection
+      # @param hash [Hash] Relaton collection
+      def puts_entries(hash)
+        return unless options[:entries]
+
+        Relaton::Bibcollection.new(hash["root"]).items.each do |b|
+          puts "  " + b.docidentifier
+        end
+      end
+
+      # @param item [Relaton::Bibdata]
+      def output_item(item)
+        case options[:format]
+        when "xml" then puts item.to_xml bibdata: true
+        when "abb" then puts item.to_asciibib
+        else puts_human_readable_item item
+        end
+        out = case options[:output]
+              when /\.abb$/ then item.to_asciibib
+              when /\.xml$/ then item.to_xml bibitem: true
+              end
+        File.write options[:output], out, encoding: "UTF-8" if out
+      end
+
+      # @param item [Relaton::Bibdata]
+      def puts_human_readable_item(item) # rubocop:disable Metrics/AbcSize
+        puts "Document identifier: #{item.docidentifier}"
+        puts "Title: #{item.title.first.title.content}"
+        puts "Status: #{item.status.stage}"
+        item.date.each { |d| puts "Date #{d.type}: #{d.on || d.from}" }
+      end
+    end
+  end
+end

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "1.5.pre".freeze
+    VERSION = "1.7.1".freeze
   end
 end

data/lib/relaton/cli/xml_to_html_renderer.rb

@@ -13,9 +13,9 @@ module Relaton::Cli
     # @param index_xml [String] Relaton XML
     # @return [String] HTML
     def render(index_xml)
-      Liquid::Template.
-        parse(template).
-        render(build_liquid_document(index_xml))
+      Liquid::Template
+        .parse(template)
+        .render(build_liquid_document(index_xml))
     end
 
     def uri_for_extension(uri, extension)
@@ -43,16 +43,23 @@ module Relaton::Cli
       File.read(file, encoding: "utf-8")
     end
 
+    # rubocop:disable Metrics/MethodLength
     # @param source [String] Relaton XML
     def build_liquid_document(source)
       bibcollection = build_bibcollection(source)
-
+      begin
+        mnv = `metanorma -v`
+      rescue Errno::ENOENT
+        mnv = ""
+      end
       hash_to_liquid(
         depth: 2,
         css: stylesheet,
         title: bibcollection.title,
+        date: Date.today.to_s,
+        metanorma_v: mnv.lines.first&.strip,
         author: bibcollection.author,
-        documents: document_items(bibcollection),
+        documents: document_items(bibcollection)
       )
     end
 
@@ -63,7 +70,7 @@ module Relaton::Cli
       Liquid::Template.file_system = file_system
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     # TODO: This should be recursive, but it's not
     # @param hash [Hash]

data/lib/relaton/element_finder.rb

@@ -15,11 +15,11 @@ module Relaton
     end
 
     def apply_namespace(xpath)
-      xpath.
-        gsub(%r{/([a-zA-Z])}, "/xmlns:\\1").
-        gsub(%r{::([a-zA-Z])}, "::xmlns:\\1").
-        gsub(%r{\[([a-zA-Z][a-z0-9A-Z@/]* ?=)}, "[xmlns:\\1").
-        gsub(%r{\[([a-zA-Z][a-z0-9A-Z@/]*\])}, "[xmlns:\\1")
+      xpath
+        .gsub(%r{/([a-zA-Z])}, "/xmlns:\\1")
+        .gsub(%r{::([a-zA-Z])}, "::xmlns:\\1")
+        .gsub(%r{\[([a-zA-Z][a-z0-9A-Z@/]* ?=)}, "[xmlns:\\1")
+        .gsub(%r{\[([a-zA-Z][a-z0-9A-Z@/]*\])}, "[xmlns:\\1")
     end
   end
 end

data/relaton-cli.gemspec

@@ -32,9 +32,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-core", "~> 3.4"
   spec.add_development_dependency "ruby-debug-ide"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
 
-  spec.add_runtime_dependency "liquid"
-  spec.add_runtime_dependency "relaton", "~> 1.5.pre"
+  spec.add_runtime_dependency "liquid", "~> 4"
+  spec.add_runtime_dependency "relaton", "~> 1.7.0"
   spec.add_runtime_dependency "thor"
   # spec.add_runtime_dependency 'byebug'
 end

data/templates/_index.liquid

@@ -17,7 +17,12 @@
   <body>
     <header>
       <div id="topbar-inner">
-        <div id="title-bar"><span>{{ author }}</span></div>
+        <div id="title-bar">
+          <div class="doc-access">
+            Generated: {{ date }}{% if metanorma_v != nil %} {{ metanorma_v }}{% endif %}
+          </div>
+          <span>{{ author }}</span>
+        </div>
       </div>
       <div class="title-section">
         <div class="coverpage">
@@ -34,6 +39,9 @@
     </main>
     <footer>
       <div class="copyright">
+        <div class="doc-access">
+          Generated: {{ date }}{% if metanorma_v != nil %} {{ metanorma_v }}{% endif %}
+        </div>
         <p class="year">&copy; {{ author }}</p>
         <p class="message">All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized otherwise in any form or by any means, electronic or mechanical, including photocopying, or posting on the internet or an intranet, without prior written permission.</p>
       </div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-cli
 version: !ruby/object:Gem::Version
-  version: 1.5.pre
+  version: 1.7.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2021-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -151,33 +151,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: liquid
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: relaton
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.pre
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.pre
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -225,7 +253,9 @@ files:
 - lib/relaton/cli.rb
 - lib/relaton/cli/base_convertor.rb
 - lib/relaton/cli/command.rb
+- lib/relaton/cli/full_text_search.rb
 - lib/relaton/cli/relaton_file.rb
+- lib/relaton/cli/subcommand_collection.rb
 - lib/relaton/cli/version.rb
 - lib/relaton/cli/xml_convertor.rb
 - lib/relaton/cli/xml_to_html_renderer.rb
@@ -250,9 +280,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.6
 signing_key: