relaton-cli 1.19.3 → 1.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faecd52a59aad2e40f78a05eeaf36efdbd02bb24f763c0aefb55b5a7989d6ff5
-  data.tar.gz: def549db6f1cd24c9705628711ce30fa0bd02abc605425fa45e736e5650dcdeb
+  metadata.gz: fdb81bbf6a31f1630e5293f44843c96193c45d12f51be8694e1ef974e7d93de9
+  data.tar.gz: 6afff225a123228d81a04a6c2bdb731f2a42156176b6b1ce651e5b1223dd501b
 SHA512:
-  metadata.gz: 7e1e4adaed698092371b0a12d46a9e6aa798f5bee6a81a4f54a3725f17547d9f4bf60da182c4f259004b613fd5625ba0c187977e6187de9a1d64c4d0efe35267
-  data.tar.gz: 363e264850ac9a36d756b3b98d76cc0ada5e7c94d1d57cf2b307bc5c2276bc3f2b6207e9774d5d71a40079b261f9001303a18ebfcfa3cea340494b6baf1c932a
+  metadata.gz: c7f9c31bf75c73dfe95e6aeaec13fc2ea941b8c5d49ca9e520812121370f6462f83766290f21f619105a708f32eb74efaa5d967876cbd8310a78a498f77bb166
+  data.tar.gz: 9864fe496f513111cd339b2e47790aa7927cb25b7dcb8453999232fd41b75647e19b08f967473763680821b1bd70f766585066c048d28a23f673f5834c880158

data/Gemfile

@@ -10,6 +10,7 @@ gem "rake"
 gem "rspec", "~> 3.0"
 gem "rspec-command", "~> 1.0.3"
 gem "rspec-core", "~> 3.4"
+gem "rspec-html", "~> 0.3.0"
 gem "simplecov"
 gem "vcr"
 gem "webmock"

data/docs/README.adoc

@@ -88,6 +88,7 @@ The following datasets are available:
 * `etsi-csv` - https://www.etsi.org/
 * `plateau-handbooks` - https://www.mlit.go.jp/plateau/_next/data/1.3.0/libraries/handbooks.json
 * `plateau-technical-reports` - https://www.mlit.go.jp/plateau/_next/data/1.3.0/libraries/technical-reports.json
+* `jis-webdesk` - https://webdesk.jsa.or.jp/books/W11M0270
 
 Options:
 

data/lib/relaton/cli/relaton_file.rb

@@ -89,6 +89,8 @@ module Relaton
         )
       end
 
+      # Turn an XML string into a Nokogiri XML document.
+      #
       # @param document [String] XML
       # @param file [String, nil] path to file
       # @return [Nokogiri::XML::Document]
@@ -119,7 +121,7 @@ module Relaton
           elsif (rfc = xml.at("//rfc"))
             require "relaton_ietf/bibxml_parser"
             ietf = RelatonIetf::BibXMLParser.fetch_rfc rfc
-            bib = nokogiri_document ietf.to_xml(bibdata: true)
+            bib = nokogiri_document(ietf.to_xml(bibdata: true))
           else
             next
           end
@@ -136,6 +138,9 @@ module Relaton
         end
       end
 
+      # Map all relevant files to the corresponding bibdata instances
+      #
+      # @return [Array<Relaton::Bibdata>]
       def concatenate_files
         xml_files = [convert_rxl_to_xml, convert_yamls_to_xml, convert_xml_to_xml]
 
@@ -188,6 +193,10 @@ module Relaton
         end
       end
 
+      # Create a bibdata instance from the XML document,
+      # while also adding file paths of related artifacts
+      # as URI elements to the bibdata instance.
+      #
       # @param document [Nokogiri::XML::Document]
       # @param file [String] path to file
       # @return [Relaton::Bibdata]
@@ -199,6 +208,11 @@ module Relaton
         bibdata
       end
 
+      # For each file type, add to the bibdata:
+      #   - a URI element that points to the file of that file type
+      #
+      # The URI element generation is skipped if the file does not exist.
+      #
       # @param bibdata [Relaton::Bibdata]
       # @param file [String] path to file
       def build_bibdata_relaton(bibdata, file)

data/lib/relaton/cli/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Cli
-    VERSION = "1.19.3".freeze
+    VERSION = "1.20.1".freeze
   end
 end

data/relaton-cli.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 3.0.0"
 
   spec.add_runtime_dependency "liquid", "~> 5"
-  spec.add_runtime_dependency "relaton", "~> 1.19.2"
+  spec.add_runtime_dependency "relaton", "~> 1.20.0"
   spec.add_runtime_dependency "thor"
   spec.add_runtime_dependency "thor-hollaback"
 end

data/templates/_document.liquid

@@ -4,13 +4,25 @@
 <div class="document">
 {%- endif -%}
 
+  {%- if document.html != blank and document.html != nil -%}
+  {%-   assign default_link = document.html -%}
+  {%- elsif document.pdf != blank and document.pdf != nil -%}
+  {%-   assign default_link = document.pdf -%}
+  {%- elsif document.doc != blank and document.doc != nil -%}
+  {%-   assign default_link = document.doc -%}
+  {%- elsif document.xml != blank and document.xml != nil -%}
+  {%-   assign default_link = document.xml -%}
+  {%- else -%}
+  {%-   assign default_link = nil -%}
+  {%- endif -%}
+
   <div class="doc-line">
     <div class="doc-identifier">
       <h{{ depth }}>
-      {% if document.html == "" %}
-        {{ document.docid.id }}
+      {% if default_link %}
+        <a href="{{ default_link }}">{{ document.docid.id }}</a>
       {% else %}
-        <a href="{{ document.html }}">{{ document.docid.id }}</a>
+        {{ document.docid.id }}
       {% endif %}
       </h{{ depth }}>
     </div>
@@ -25,19 +37,20 @@
     <div class="doc-identifier">
       Edition: {{ document.edition.content }}
     </div>
-  {% endif %}  
+  {% endif %}
   </div>
 
   <div class="doc-title">
     <h{{ depth | plus: 1 }}>
-      {% if document.html == blank or document.html == nil %}
-        {{ document.title }}
+      {% if default_link %}
+        <a href="{{ default_link }}">{{ document.title }}</a>
       {% else %}
-        <a href="{{ document.html }}">{{ document.title }}</a>
+        {{ document.title }}
       {% endif %}
     </h{{ depth | plus: 1 }}>
   </div>
 
+  {% if document.docstatus %}
   <div class="doc-info {{ document.docstatus.stage.value | downcase }}">
     <div class="doc-stage {{ document.docstatus.stage.value | downcase }}">
       {{ document.docstatus.stage.abbreviation }}
@@ -57,6 +70,7 @@
       </div>
     </div>
   </div>
+  {% endif %}
 
   <div class="doc-bib">
     <div class="doc-bib-relaton">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-cli
 version: !ruby/object:Gem::Version
-  version: 1.19.3
+  version: 1.20.1
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-26 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.2
+        version: 1.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.2
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +117,7 @@ homepage: https://github.com/metanorma/relaton-cli
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,8 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Relaton Command-line Interface
 test_files: []