relaton-cli 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b19614f9f5484181337571cbc881a8f45d7131bbb8c1fea9ca77f8573935d8f3
-  data.tar.gz: 45429bb98e29ebfd54a2b1525a793b34f93a453f143ed1b9a9b2e0529eea6d9c
+  metadata.gz: acaf3abbad33304c0ab6dfb6be03a86d2d90e7746b494ddbd739c6a30643691d
+  data.tar.gz: a1c604c89f7543d7b73596384b5d851aa382900e4895ed81bc8c27ad4b83fd59
 SHA512:
-  metadata.gz: 2af0e98a901968e3751a1c209dc98b326098aae82b0ba0eb6d4562f9826da83e380ff05a3e8ff9884d4bb32a12e4ca43de933bd77754d31377e29052287364ee
-  data.tar.gz: 268053ca0bd8992ad7125829b3718e896b3bcbec6ca6220ccf3df98ebfce7d8680d062a89ffa3971b74474f2bdfa8ee57740d282fcdd67b869972b605cba202d
+  metadata.gz: f11878522fda0aa839d51f9a50407ae94965a67b8dabce4cc36b00601b563da3574ce9d4fda42ffdc2d257ce7e3d7e0159f92f8335928eac14d893c7f3452ae1
+  data.tar.gz: b618737bbc2bee1605ecc4541ccc6b99edc34e3cbb5668dbe6aca63d6c0e23e47ca519877491b4728f771b13e8b03d9b8be4246f7b3b257fd2870cdab7957695

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.pryrc
+/.rubocop-https*
+
+.rspec_status

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  Enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -3,13 +3,8 @@
 # All project-specific additions and overrides should be specified in this file.
 
 inherit_from:
-  # Thoughtbot's style guide from: https://github.com/thoughtbot/guides
-  - ".rubocop.tb.yml"
-  # Overrides from Ribose
-  - ".rubocop.ribose.yml"
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  DisplayCopNames: false
-  StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.3
 Rails:
   Enabled: true

data/.travis.yml

@@ -6,9 +6,14 @@ rvm:
   - 2.4
   - 2.3
   - ruby-head
+
 before_install:
   - gem install bundler -v 1.16.1
   - unset _JAVA_OPTIONS
+  - mkdir ./tmp
+  - mkdir ~/.relaton
+
 matrix:
   allow_failures:
+    - rvm: 2.3
     - rvm: ruby-head

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    relaton-cli (0.1.1)
+    relaton-cli (0.1.4)
       liquid
-      relaton (~> 0.2.4)
-      uuidtools
+      relaton (~> 0.3)
+      thor
 
 GEM
   remote: https://rubygems.org/
@@ -16,43 +16,49 @@ GEM
       json (>= 1.5.1)
     byebug (10.0.2)
     cnccs (0.1.3)
+    coderay (1.1.2)
     diff-lcs (1.3)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    gb-agencies (0.0.3)
-    gbbib (0.3.1)
+    gb-agencies (0.0.5)
+    gbbib (0.4.1)
       cnccs (~> 0.1.1)
       gb-agencies (~> 0.0.1)
-      iso-bib-item (~> 0.3.0)
+      iso-bib-item (~> 0.4.2)
     httpclient (2.8.3)
-    iecbib (0.1.2)
+    iecbib (0.2.1)
       addressable
-      iso-bib-item (~> 0.3.0)
-    ietfbib (0.4.1)
-      iso-bib-item (~> 0.3.0)
-    iso-bib-item (0.3.1)
+      iso-bib-item (~> 0.4.2)
+    ietfbib (0.4.3)
+      iso-bib-item (~> 0.4.2)
+    iso-bib-item (0.4.3)
       isoics (~> 0.1.6)
       nokogiri (~> 1.8.4)
       ruby_deep_clone (~> 0.8.0)
-    isobib (0.3.1)
+    isobib (0.4.1)
       algoliasearch
-      iso-bib-item (~> 0.3.0)
+      iecbib (~> 0.2.1)
+      iso-bib-item (~> 0.4.2)
     isoics (0.1.7)
     json (2.1.0)
-    liquid (4.0.0)
+    liquid (4.0.1)
+    method_source (0.9.2)
     mini_portile2 (2.3.0)
     mixlib-shellout (2.4.0)
-    nokogiri (1.8.4)
+    nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     public_suffix (3.0.3)
     rake (12.3.1)
-    relaton (0.2.4)
+    relaton (0.3.0)
       algoliasearch
-      gbbib (~> 0.3.1)
-      iecbib (~> 0.1.1)
-      ietfbib (~> 0.4.1)
-      iso-bib-item (~> 0.3.0)
-      isobib (~> 0.3.1)
+      gbbib (~> 0.4.0)
+      iecbib (~> 0.2.0)
+      ietfbib (~> 0.4.2)
+      iso-bib-item (~> 0.4.2)
+      isobib (~> 0.4.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -63,7 +69,7 @@ GEM
       rspec-its (~> 1.2)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-its (1.2.0)
@@ -74,7 +80,7 @@ GEM
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
     ruby_deep_clone (0.8.0)
-    uuidtools (2.1.5)
+    thor (0.20.3)
 
 PLATFORMS
   ruby
@@ -83,6 +89,7 @@ DEPENDENCIES
   bundler (~> 1.16)
   byebug (~> 10.0)
   equivalent-xml (~> 0.6)
+  pry
   rake (~> 12.0)
   relaton-cli!
   rspec (~> 3.0)
@@ -90,4 +97,4 @@ DEPENDENCIES
   rspec-core (~> 3.4)
 
 BUNDLED WITH
-   1.16.2
+   1.17.1

data/README.adoc

@@ -12,52 +12,67 @@ Please refer to https://github.com/riboseinc/relaton.
 
 The following executables are included:
 
-=== relaton-concatenate
+=== relaton concatenate
 
-```
-relaton-concatenate DIRECTORY
-```
+[source,console]
+----
+$ relaton concatenate Source-Directory Collection-File -t TITLE -g ORGANIZATION
+----
 
-Iterates through all the Relaton YAML files in DIRECTORY, and converts them in-place into Relaton XML.
+Iterates through all the Relaton YAML files in `Source-Directory`, and converts them in-place into Relaton XML.
 
-Iterates through all the Relaton XML files in DIRECTORY (including those just converted from Relaton YAML),
-and outputs to stdout a `relaton-collection` document containing all the Relaton XML objects read in.
+Iterates through all the Relaton XML files in `Source-Directory` (including those just converted from Relaton YAML),
+and outputs to `Collection-File` a `relaton-collection` document containing all the Relaton XML objects read in.
 
-=== relaton-fetch
+For each Relaton XML file, 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. 
 
-```
-relaton-fetch -t TYPE -y YEAR code
-```
+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` document.
 
-Fetch the Relaton XML entry corresponding to the document identifier `code`. 
+=== relaton fetch
+
+[source,console]
+----
+$ relaton fetch CODE -t TYPE -y YEAR
+----
+
+Fetch the Relaton XML entry corresponding to the document identifier `CODE`. 
 
 * `YEAR` is optional, and specifies the year of publication of the standard.
-* `TYPE` specifies the standards class library to be used, that the identifier is part of; the recognised 
+* `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`.
 
-=== relaton-metanorma-extract
+=== relaton extract
 
-```
-relaton-metanorma-extract Metanorma-XML-Directory Relaton-XML-Directory
-```
+[source,console]
+----
+$ relaton extract Metanorma-XML-Directory Relaton-XML-Directory -x EXTENSION
+----
 
 Iterate through all the Metanorma XML files in `Metanorma-XML-Directory`, and extract the `bibdata`
 element from each. Save the `bibdata` element for each file to `Relaton-XML-Directory`, as the Relaton XML
 description for that file. If a document identifier is present in `bibdata`, it is used as the name of the
-file; otherwise, the original file name is used.
+file; otherwise, the original file name is used. The filename is suffixed with `EXTENSION`; by default,
+`.rxl` is used.
 
-=== relaton-xml-html
+[[relaton-xml2html]]
+=== relaton xml2html
 
-```
-relaton-xml-html <relaton-xml> <stylesheet> <output-root> <html-template>
-```
+[source,console]
+----
+$ relaton xml2html <relaton-xml> <stylesheet> <html-template-dir>
+----
 
 Render a Relaton Collection XML as an HTML file. Used to generate an HTML index of standards.
 
 * `relaton-xml` is the Relaton Collection XML file.
 * `stylesheet` is the CSS stylesheet to be used to style the output. For the CSS styling of each bibliographic element, see below.
-* `output-root` is the directory containing the Relaton XML for each file, named after the document identifier (as generated by `relaton-metanorma-extract`)
-* `html-template` is the HTML Liquid Template file into which the bibliographic entries are to be inserted.  The HTML Template recognises the following parameters:
+* `html-template-dir` is a directory containing HTML Liquid Template files into which the bibliographic entries are to be inserted. There is one file for the overall file (`_index.liquid_`), and one file for the individual bibliographic entries (`_document.liquid`). A sample instance of this directory is available in the `templates` directory.
+
+The HTML Template file `_document.liquid` 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.
+
+The HTML Template file `_index.liquid` recognises 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`
@@ -65,7 +80,8 @@ Render a Relaton Collection XML as an HTML file. Used to generate an HTML index
 
 Sample HTML output for a bibliographic entry:
 
-```xml
+[source,xml]
+----
   <div class="document">
     <div class="doc-line">
       <div class="doc-identifier">
@@ -108,26 +124,29 @@ Sample HTML output for a bibliographic entry:
       </div>
     </div>
   </div>
-```
+----
 
-=== relaton-yaml-xml
+[[relaton-yaml]]
+=== relaton yaml2xml
 
-```
-relaton-yaml-xml -R relaton-dir yaml-file
-```
+[source,console]
+----
+$ relaton yaml2xml YAML -o OUTPUT-DIRECTORY -x RELATON_EXTENSION -p PREFIX -r LIBRARY
+----
 
-Convert a Relaton YAML file into a Relaton Collection XML.
+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.
 
-The Relaton YAML file contains some initial metadata, and a list of metadata about each bibliographic entry. The following is a sample:
+A Relaton Colleciton YAML file contains some initial metadata, and a list of metadata about each bibliographic entry. A Relaton YAML file describing an individual bibliographic entry is limited to metadata specific to that entry. The following illustrates the fields supported:
 
-```yaml
+[source,yaml]
+----
 htmlstylesheet: ./index-style.css
 root:
   title: CalConnect Standards Registry
   author: "CalConnect: The Calendaring and Scheduling Consortium"
   items:
     - technical_committee: TC VCARD
-      docid: CC 18001
+      docidentifier: 18001
       doctype: standard
       title: "Date and time -- Representations for information interchange -- Part 1: Basic rules"
       stage: Published
@@ -138,11 +157,33 @@ root:
       doc: standards/csd-datetime-explict/csd-datetime-explict.doc
       relaton: standards/csd-datetime-explict/cc-18001.xml
     - technical_committee: TC PUBLISH
-      docid: CC/DIR 10001
+      docidentifier: 10001
       doctype: governance
       title: "Standardization and publication"
       stage: proposal
       revdate: 2018-10-17
       uri: standards/csd-standardization/csd-standardization.xml
-```
+      agency: CalConnect
+      language: en
+      script: Latn
+      edition: 1
+----
+
+=== relaton xml2yaml
+
+[source,console]
+----
+$ relaton xml2yaml XML -o OUTPUT-DIRECTORY -x RELATON_EXTENSION -p PREFIX -r LIBRARY
+----
+
+Convert a Relaton XML file (`filename.xml` or `filename.rxl`) into a Relaton YAML file (`filename.yaml`). If the Relaton XML file is a collection, and `OUTPUT-DIRECTORY` is nominated, also convert the file into a list of Relaton YAML 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 `.yaml`) 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 yaml2html
+
+[source,console]
+----
+$ relaton yaml2xml YAML <stylesheet> <liquid-template-dir>
+----
 
+Render a Relaton YAML file as an HTML file. The stylesheet and liquid-template-dir directories are as for <<relaton-xml2html,relaton xml2html>>.

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/exe/relaton

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+#
+# resolve bin path, ignoring symlinks
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+
+# add self to libpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+# Fixes https://github.com/rubygems/rubygems/issues/1420
+require "rubygems/specification"
+
+class Gem::Specification
+  def this; self; end
+end
+
+require "relaton/cli"
+
+Relaton::Cli.start(ARGV)
+

data/lib/relaton/bibcollection.rb

@@ -20,58 +20,33 @@ module Relaton
     def initialize(options)
       self.items = []
       ATTRIBS.each do |k|
-        method = "#{k}="
         value = options[k] || options[k.to_s]
-        puts "K #{method}"
-        puts value.inspect
-
         self.send("#{k}=", value)
-        puts "SET! to #{self.send(k).inspect}"
       end
-
-      # puts items.inspect
       self.items = (self.items || []).inject([]) do |acc,item|
         acc << if item.is_a?(::Relaton::Bibcollection) ||
           item.is_a?(::Relaton::Bibdata)
-
           item
         else
-          # puts "item.inspect #{item.inspect}"
           new_bib_item_class(item)
         end
       end
-
       self
-      # byebug
     end
 
-    def self.from_xml(source)
-      # source = Nokogiri::XML(content)
+    # arbitrary number, must sort after all bib items
+    def doc_number
+      9999999
+    end
 
+    def self.from_xml(source)
       title = source&.at(ns("./relaton-collection/title"))&.text
       author = source&.at(ns("./relaton-collection/contributor[role/@type = 'author']/organization/name"))&.text
-
-      puts "!!!!!!!!!!"*3
-      puts "BC: title #{title}"
-      puts "BC: author #{author}"
-      puts "!!!!!!!!!!"*3
-
-      items = source.xpath(ns("./relaton-collection/relation")).map do |item|
-        puts "========="*3
-        puts "item #{item.to_s}"
+      items = source&.xpath(ns("./relaton-collection/relation"))&.map do |item|
         klass = item.at(ns("./bibdata")) ? Bibdata : Bibcollection
-        klass.from_xml(item.at(ns("./bibdata")))
+        klass.from_xml(item.at(ns("./bibdata")) || item)
       end
-
-      opts = {
-        title: title,
-        author: author,
-        items: items
-      }
-
-      puts "X"*38
-      puts opts.inspect
-      puts "X"*38
+      opts = { title: title, author: author, items: items }
       new(opts)
     end
 
@@ -84,6 +59,9 @@ module Relaton
     end
 
     def items_flattened
+      items.sort_by! do |b|
+        b.doc_number
+      end
 
       items.inject([]) do |acc,item|
         if item.is_a? ::Relaton::Bibcollection
@@ -92,14 +70,17 @@ module Relaton
           acc << item
         end
       end
-
     end
 
     def to_xml
+      items.sort_by! do |b|
+        b.doc_number
+      end
+
       collection_type = if doctype
         "type=\"#{doctype}\""
       else
-        'xmlns="http://riboseinc.com/isoxml"'
+        'xmlns="https://open.ribose.com/relaton-xml"'
       end
 
       ret = "<relaton-collection #{collection_type}>"
@@ -117,15 +98,23 @@ module Relaton
       ret += "</relaton-collection>\n"
     end
 
+    def to_yaml
+      to_h.to_yaml
+    end
+
     def to_h
+      items.sort_by! do |b|
+        b.doc_number
+      end
+
       a = ATTRIBS.inject({}) do |acc, k|
-        acc[k] = send(k)
+        acc[k.to_s] = send(k)
         acc
       end
 
-      a[:items] = a[:items].map(&:to_h)
+      a["items"] = a["items"].map(&:to_h)
 
-      a
+      { "root" => a }
     end
 
   end