relaton-cli 0.9.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b5ed5ee23cfdb909f597d54b0b79588eb229f4ec3801f77b4a5eafc9da583fb
-  data.tar.gz: 1410ee321bd05dfe6263e89f35835b748724dc4a209d95404b2aa7205a7f5719
+  metadata.gz: b2519a76d53e13022ef3f2da8010ee1bd1667e12e614763851a7a9e0a61c41e0
+  data.tar.gz: b4e920db6ded4e1fccec77497fee98a1b9b34172ffaad33a00fb3ff69f714ce6
 SHA512:
-  metadata.gz: a3199375c9004358be4ebde9be0595c6aa4230e33d5f67aefb22583035d429a385c38a2e8088ddebf617d6cad7b3cf14b95c3609fddd25bd104410ce28a23f2a
-  data.tar.gz: f4372b8f7b815999d897d9706e77a86d86b728c0e86eef671f4c54fa4b007875a3a0ef9f96c31820814907d3b723b7b904e67f87e53e8fefdb66e6fa11118c97
+  metadata.gz: 15b49542f88b8248a9177493670c91ee60107f67c432a785bda4b9c115ffd149cf6c5f3a72363f560e35cc1d0df1bf223ef339388de65e8b84d0b8882a5bcfce
+  data.tar.gz: 24427ff9a3fb6ef259e0d0b032815cece68e87afe9d48d1acb486b59d29e898796a5ddf7decb77f3f7caaeeefa886f6d4b5158de95a78c4784eb6102474fe7b4

data/.rubocop.yml

@@ -5,6 +5,6 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 Rails:
   Enabled: true

data/docs/README.adoc

@@ -43,12 +43,13 @@ suports an additional `-x` or `--extension` options to use different extension.
 
 [source,console]
 ----
-$ relaton fetch CODE -t TYPE -y YEAR
+$ relaton fetch CODE -t TYPE -f FORMAT -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.
+* `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`.
 

data/lib/relaton/cli/command.rb

@@ -8,6 +8,7 @@ module Relaton
     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"
 
       def fetch(code)
@@ -72,16 +73,7 @@ module Relaton
         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"
-
-      # def yaml2html(file, style = nil, template = nil)
-      #   Relaton::Cli::YAMLConvertor.to_html(file, style, template)
-      # end
-
-      desc "yaml2htmlnew RELATON-INDEX-YAML", "Concatenate Relaton Collection YAML into HTML"
+      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"
@@ -92,10 +84,19 @@ module Relaton
 
       private
 
+      # @param code [String]
+      # @param options [Hash]
+      # @option options [String] :type
+      # @option options [String, NilClass] :format
+      # @option options [Integer, NilClass] :year
       def fetch_document(code, options)
         if registered_types.include?(options[:type])
           doc = Cli.relaton.fetch(code, options[:year]&.to_s)
-          doc ? doc.to_xml : "No matching bibliographic entry found"
+          if doc
+            options[:format] == "bibtex" ? doc.to_bibtex : doc.to_xml
+          else
+            "No matching bibliographic entry found"
+          end
         end
       rescue RelatonBib::RequestError => e
         e.message

data/lib/relaton/cli/relaton_file.rb

@@ -137,15 +137,19 @@ module Relaton
       def concatenate_files
         xml_files = [convert_rxl_to_xml, convert_yamls_to_xml, convert_xml_to_xml]
 
-        xml_files.flatten.map do |xml|
+        xml_files.flatten.reduce([]) do |mem, xml|
           doc = nokogiri_document(xml[:content])
-          if (rfc = doc.at("//rfc"))
+          if (refs = doc.xpath("//rfc//reference")).any?
             require "relaton_ietf/scrapper"
-            #ietf = RelatonIetf::Scrapper.bib_item rfc, "rfc"
-            ietf = RelatonIetf::Scrapper.fetch_rfc rfc
-            doc = nokogiri_document ietf.to_xml(bibdata: true)
+            mem + refs.map do |rfc|
+              ietf = RelatonIetf::Scrapper.fetch_rfc rfc
+              d = nokogiri_document ietf.to_xml(bibdata: true)
+              bibdata_instance(d, xml[:file])
+            end
+          elsif doc&.root&.name == "bibdata"
+            mem << bibdata_instance(doc, xml[:file])
+          else mem
           end
-          bibdata_instance(doc, xml[:file]) if doc&.root&.name == "bibdata"
         end.compact
       end
 

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "0.9.0".freeze
+    VERSION = "1.1.0".freeze
   end
 end

data/lib/relaton/cli/xml_to_html_renderer.rb

@@ -13,7 +13,7 @@ module Relaton::Cli
     def render(index_xml)
       Liquid::Template.
         parse(template).
-        render(build_liquid_document(index_xml), { strict_variables: true })
+        render(build_liquid_document(index_xml))
     end
 
     def uri_for_extension(uri, extension)

data/relaton-cli.gemspec

@@ -1,5 +1,4 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "relaton/cli/version"
 
@@ -35,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
 
   spec.add_runtime_dependency "liquid"
-  spec.add_runtime_dependency "relaton", "~> 0.11.0"
+  spec.add_runtime_dependency "relaton", "~> 1.1.0"
   spec.add_runtime_dependency "thor"
   # spec.add_runtime_dependency 'byebug'
 end

data/templates/_document.liquid

@@ -32,12 +32,17 @@
     </h{{ depth | plus: 1 }}>
   </div>
 
-  <div class="doc-info {{ document.docstatus.stage | downcase }}">
-    <div class="doc-stage {{ document.docstatus.stage | downcase }}">
-      {{ document.docstatus.stage }}
+  <div class="doc-info {{ document.docstatus.stage.value | downcase }}">
+    <div class="doc-stage {{ document.docstatus.stage.value | downcase }}">
+      {{ document.docstatus.stage.abbreviation }}
+      {% if document.docstatus.substage %}
+        {{ document.docstatus.stage.value }}.{{ document.docstatus.substage.value }}
+      {% else %}
+        {{ document.docstatus.stage.value }}
+      {% endif %}
     </div>
     <div class="doc-dates">
-      {% unless document.docstatus.stage == "published" %}
+      {% unless document.docstatus.stage.value == "published" %}
       <div class="doc-updated">
       {% else %}
       <div class="doc-published">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-cli
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
+date: 2020-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -223,8 +223,6 @@ files:
 - lib/relaton/bibcollection.rb
 - lib/relaton/bibdata.rb
 - lib/relaton/cli.rb
-- lib/relaton/cli/_document.liquid
-- lib/relaton/cli/_index.liquid
 - lib/relaton/cli/base_convertor.rb
 - lib/relaton/cli/command.rb
 - lib/relaton/cli/relaton_file.rb

data/lib/relaton/cli/_document.liquid

@@ -1,82 +0,0 @@
-{%- if document.items.size > 0 -%}
-<div class="doc-section">
-{%- else -%}
-<div class="document">
-{%- endif -%}
-
-  <div class="doc-line">
-    <div class="doc-identifier">
-      <h{{ depth }}>
-      {% if document.html == "" %}
-        {{ document.docid.id }}
-      {% else %}
-        <a href="{{ document.html }}">{{ document.docid.id }}</a>
-      {% endif %}
-      </h{{ depth }}>
-    </div>
-
-    <div class="doc-type-wrap">
-      <div class="doc-type {{ document.type | downcase | split: " " | join: "-" }}">
-      {{ document.type }}
-      </div>
-    </div>
-  </div>
-
-  <div class="doc-title">
-    <h{{ depth | plus: 1 }}>
-      {% if document.html == blank or document.html == nil %}
-        {{ document.title }}
-      {% else %}
-        <a href="{{ document.html }}">{{ document.title }}</a>
-      {% endif %}
-    </h{{ depth | plus: 1 }}>
-  </div>
-
-  <div class="doc-info {{ document.docstatus.stage | downcase }}">
-    <div class="doc-stage {{ document.docstatus.stage | downcase }}">
-      {{ document.docstatus.stage }}
-    </div>
-    <div class="doc-dates">
-      {% unless document.docstatus.stage == "published" %}
-      <div class="doc-updated">
-      {% else %}
-      <div class="doc-published">
-      {% endunless %}
-        {{ document.revdate }}
-      </div>
-    </div>
-  </div>
-
-  <div class="doc-bib">
-    <div class="doc-bib-relaton">
-      <a href="{{ document.relaton }}">Relaton XML</a>
-    </div>
-  </div>
-
-  <div class="doc-access">
-  {% unless document.html == blank or document.html == nil %}
-    <div class="doc-access-button-html">
-      <a href="{{ document.html }}">HTML</a>
-    </div>
-  {% endunless %}
-  {% unless document.pdf == blank or document.pdf == nil %}
-    <div class="doc-access-button-pdf">
-      <a href="{{ document.pdf }}">PDF</a>
-    </div>
-  {% endunless %}
-  {% unless document.doc == blank or document.doc == nil %}
-    <div class="doc-access-button-doc">
-      <a href="{{ document.doc }}">Word</a>
-    </div>
-  {% endunless %}
-  {% unless document.xml == blank or document.xml == nil %}
-    <div class="doc-access-button-xml">
-      <a href="{{ document.xml }}">XML</a>
-    </div>
-  {% endunless %}
-  </div>
-</div>
-
-{%- if document.items.size > 0 -%}
-  {%- include 'document' for document.items -%}
-{%- endif -%}

data/lib/relaton/cli/_index.liquid

@@ -1,53 +0,0 @@
-<!DOCTYPE HTML>
-<html>
-  <head>
-    <title>{{ title }}</title>
-    <style>
-<!--
-{{ css }}
--->
-    </style>
-    <meta http-equiv="Content-Type" content="text/html" charset="utf-8"/>
-    <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js" type="text/javascript"></script>
-    <script src="https://cdn.rawgit.com/jgallen23/toc/0.3.2/dist/toc.min.js" type="text/javascript"></script>
-    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i|Space+Mono:400,700|Overpass:300,300i,600,900|Ek+Mukta:200" rel="stylesheet" type="text/css"/>
-    <link href="https://use.fontawesome.com/releases/v5.0.8/css/solid.css" integrity="sha384-v2Tw72dyUXeU3y4aM2Y0tBJQkGfplr39mxZqlTBDUZAb9BGoC40+rdFCG0m10lXk" crossorigin="anonymous"/>
-    <link href="https://use.fontawesome.com/releases/v5.0.8/css/fontawesome.css" integrity="sha384-q3jl8XQu1OpdLgGFvNRnPdj5VIlCvgsDQTQB6owSOHWlAurxul7f+JpUOVdAiJ5P" crossorigin="anonymous"/>
-  </head>
-  <body>
-    <header>
-      <div id="topbar-inner">
-        <div id="title-bar"><span>{{ author }}</span></div>
-      </div>
-      <div class="title-section">
-        <div class="coverpage">
-          <div class="wrapper-top">
-            <div class="coverpage-doc-identity">
-              <div class="coverpage-title"><span class="title-first">{{ title }}</span></div>
-            </div>
-          </div>
-        </div>
-      </div>
-    </header>
-    <main class="main-section">
-    {% include 'document' for documents %}
-    </main>
-    <footer>
-      <div class="copyright">
-        <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>
-    </footer>
-    <script>
-      $(document).ready(function() {
-        $('[id^=toc]').each(function () {
-           var currentToc = $(this);
-           var url = window.location.href;
-           currentToc.wrap("<a href='" + url + "#" + currentToc.attr("id") + "' <\/a>");
-        });
-      });
-      anchors.options = { placement: 'left' };
-      anchors.add('h1, h2, h3, h4');
-    </script>
-  </body>
-</html>