metanorma 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e823c389c083ead32851781abb9fa3e28d7744d7fcd3ebacb60b051c118157ed
-  data.tar.gz: 6a3ef75f087f322c0fcf317f72cf5d91c52576b3f322c0935c368e9c74fb7e6d
+  metadata.gz: 6da8527ed559d4b6833977c169022db5dfec3a9d93926257586d9e676a11e578
+  data.tar.gz: cf9cc8d31d2ae7cbd08787dcb3f4a79747e85fad5c142bc02fd377df91e467e0
 SHA512:
-  metadata.gz: b942d2fadf478c4aa4e8f27437a29a75c37d9515541bc1c13aec1fece10c8d81b07ad8d60cdce455341fc8f65b35d1a53b3d20bf6005281753774e21e1130354
-  data.tar.gz: f744d5316edcd92e46fcfff79128a20353849b8a5d7037cc808afbc39aeb5c1feecb503d3e47fffad4f5fd175129f152be83c5208dc3f8ca771d748d4deb5736
+  metadata.gz: 07f86288c180813daf6ceed810dec2bfecc1cdb2605bf45de5f363cf0a7187babffa37095f208679fd1d1a3cdc6aeebfc879a5293f51c4f49ecc9c473a077295
+  data.tar.gz: bc111d4ca32a5b3135cf518c748370654b9f99803b4123de42b2603965bba4a1e6164e6b3307f7f9afa8b53b7b721b1b01941eee22fd3dd5d63d95a8597cb71e

data/.github/workflows/rake.yml

@@ -49,5 +49,5 @@ jobs:
         with:
           token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
           repository: ${{ github.repository }}
-          event-type: notify
+          event-type: tests-passed
           client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.hound.yml

@@ -1,3 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 ruby:
-  Enabled: true
+  enabled: true
   config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,14 +1,10 @@
-# This project follows the Ribose OSS style guide.
-# https://github.com/riboseinc/oss-guides
-# All project-specific additions and overrides should be specified in this file.
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 
 # local repo-specific modifications
+# ...
 
 AllCops:
-  DisplayCopNames: false
-  StyleGuideCopsOnly: false
   TargetRubyVersion: 2.4
-Rails:
-  Enabled: true

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/metanorma/asciidoctor_extensions/glob_include_processor.rb

@@ -1,20 +1,18 @@
 module Metanorma::AsciidoctorExtensions
-
   class GlobIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
-    def process doc, reader, target_glob, attributes
+    def process(_doc, reader, target_glob, attributes)
       Dir[File.join reader.dir, target_glob].sort.reverse_each do |target|
         content = IO.readlines target
-        content.unshift '' unless attributes['adjoin-option']
+        content.unshift "" unless attributes["adjoin-option"]
         reader.push_include content, target, target, 1, attributes
       end
       reader
     end
 
-    def handles? target
-      target.include? '*'
+    def handles?(target)
+      target.include? "*"
     end
   end
-
 end
 
 Asciidoctor::Extensions.register do

data/lib/metanorma/collection.rb

@@ -44,9 +44,10 @@ module Metanorma
     end
 
     # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
-     def clean_exit
-       @log.write(File.join(File.dirname(@file), File.basename(@file, ".*") + ".err"))
-     end
+    def clean_exit
+      @log.write(File.join(File.dirname(@file),
+                           "#{File.basename(@file, '.*')}.err"))
+    end
 
     # @return [String] XML
     def to_xml
@@ -110,7 +111,7 @@ module Metanorma
       # @parma mnf [Metanorma::CollectionManifest]
       # @return [Hash{String=>Metanorma::Document}]
       def docs_from_xml(xml, mnf)
-        xml.xpath("//xmlns:doc-container/*/xmlns:bibdata")
+        xml.xpath("//xmlns:doc-container//xmlns:bibdata")
           .each_with_object({}) do |b, m|
           bd = Relaton::Cli.parse_xml b
           docref = mnf.docref_by_id bd.docidentifier.first.id
@@ -153,7 +154,7 @@ module Metanorma
 
       require "metanorma-#{doctype}"
       out = sections(dummy_header + cnt)
-      builder.send(elm + "-content") { |b| b << out }
+      builder.send("#{elm}-content") { |b| b << out }
     end
 
     # @param cnt [String] prefatory/final content
@@ -168,9 +169,14 @@ module Metanorma
       return unless Array(@directives).include? "documents-inline"
 
       documents.each_with_index do |(_, d), i|
-        next if d.attachment
         id = format("doc%<index>09d", index: i)
-        builder.send("doc-container", id: id) { |b| d.to_xml b }
+        builder.send("doc-container", id: id) do |b|
+          if d.attachment
+            d.bibitem and b << d.bibitem.root.to_xml
+            b.attachment Metanorma::Utils::datauri(d.file)
+          else d.to_xml b
+          end
+        end
       end
     end
 

data/lib/metanorma/collection_fileparse.rb

@@ -13,8 +13,11 @@ module Metanorma
       xrefs.parse xml
       xrefs.get.each do |k, v|
         ret[v[:type]] ||= {}
-        index = v[:container] || v[:label].nil? || v[:label].empty? ?
-          UUIDTools::UUID.random_create.to_s : v[:label]
+        index = if v[:container] || v[:label].nil? || v[:label].empty?
+                  UUIDTools::UUID.random_create.to_s
+                else
+                  v[:label]
+                end
         ret[v[:type]][index] = k
       end
       ret
@@ -46,7 +49,8 @@ module Metanorma
       newbib["id"] = id
       newbib["hidden"] = "true"
       newbib&.at(ns("./ext"))&.remove
-      _file, url = targetfile(@files[docid], false, !@files[docid][:attachment])
+      _file, url = targetfile(@files[docid], relative: true, read: false,
+                                             doc: !@files[docid][:attachment])
       uri_node = Nokogiri::XML::Node.new "uri", newbib
       uri_node[:type] = "citation"
       uri_node.content = url
@@ -87,9 +91,32 @@ module Metanorma
         href = isodoc.eref_target(e)
         next if href == "##{e['bibitemid']}"
 
-        if href.match(/^#/)
-          next unless docxml.at("//*[@id = '#{href.sub(/^#/, '')}']")
+        # XML collection renderer
+        # map locality type and label (e.g. "clause" "1") to id = anchor for
+        # a document
+        # Note: will only key clauses, which have unambiguous reference label in
+        # locality. Notes, examples etc with containers are just plunked against
+        # UUIDs, so that their IDs can at least be registered to be tracked
+        # as existing.
+        # @param id [String]
+        # @param read [Boolean]
+        # @return [Array<String, nil>]
+        # @param bib [Nokogiri::XML::Element]
+        # @param identifier [String]
+        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        # Resolves direct links to other files in collection
+        # (repo(current-metanorma-collection/x),
+        # and indirect links to other files in collection
+        # (bibitem[@type = 'internal'] pointing to a file anchor
+        # in another file in the collection)
+        # @param file [String] XML content
+        # @param identifier [String] docid
+        # @param internal_refs [Hash{String=>Hash{String=>String}] schema name to anchor to filename
+        # @return [String] XML content
+        if href =~ /^#/ && !docxml.at("//*[@id = '#{href.sub(/^#/, '')}']")
+          next
         end
+
         e["target"] = href.strip
         e.name = "link"
         e&.elements&.remove
@@ -106,6 +133,7 @@ module Metanorma
       docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |b|
         docid = b&.at(ns("./docidentifier[@type = 'repository']"))&.text
         next unless docid && %r{^current-metanorma-collection/}.match(docid)
+
         update_bibitem(b, identifier)
         update_anchors(b, docxml, docid)
       end
@@ -150,8 +178,9 @@ module Metanorma
       ref = loc.at(ns("./referenceFrom")) || return
       anchor = "#{ref.text}_#{document_suffix}"
       return unless @files[docid][:anchors].inject([]) do |m, (_, x)|
-        m+= x.values
+        m += x.values
       end.include?(anchor)
+
       ref.content = anchor
     end
 
@@ -174,7 +203,8 @@ module Metanorma
     def gather_internal_refs
       @files.each_with_object({}) do |(_, x), refs|
         next if x[:attachment]
-        file, _ = targetfile(x, true)
+
+        file, = targetfile(x, read: true)
         Nokogiri::XML(file)
           .xpath(ns("//bibitem[@type = 'internal']/"\
         "docidentifier[@type = 'repository']")).each do |d|
@@ -192,7 +222,7 @@ module Metanorma
       @files.each do |identifier, x|
         next if x[:attachment]
 
-        file, _filename = targetfile(x, true)
+        file, _filename = targetfile(x, read: true)
         docxml = Nokogiri::XML(file)
         refs.each do |schema, ids|
           ids.each_key do |id|

data/lib/metanorma/collection_fileprocess.rb

@@ -17,13 +17,16 @@ module Metanorma
       @xml.xpath(ns("//docref")).each do |d|
         identifier = d.at(ns("./identifier")).text
         files[identifier] = file_entry(d, path)
-        next if files[identifier][:attachment]
-
-        file, _filename = targetfile(files[identifier], true)
-        xml = Nokogiri::XML(file)
-        add_document_suffix(identifier, xml)
-        files[identifier][:anchors] = read_anchors(xml)
-        files[identifier][:bibdata] = xml.at(ns("//bibdata"))
+        if files[identifier][:attachment]
+          files[identifier][:bibdata] = Metanorma::Document
+            .attachment_bibitem(identifier).root
+        else
+          file, _filename = targetfile(files[identifier], read: true)
+          xml = Nokogiri::XML(file)
+          add_document_suffix(identifier, xml)
+          files[identifier][:anchors] = read_anchors(xml)
+          files[identifier][:bibdata] = xml.at(ns("//bibdata"))
+        end
       end
       files
     end
@@ -58,12 +61,20 @@ module Metanorma
 
     # return file contents + output filename for each file in the collection,
     # given a docref entry
-    # @param data [Hash]
-    # @param read [Boolean]
+    # @param data [Hash] docref entry
+    # @param read [Boolean] read the file in and return it
+    # @param doc [Boolean] I am a Metanorma document,
+    # so my URL should end with html or pdf or whatever
+    # @param relative [Boolean] Return path relative to YAML file,
+    # not relative to calling function
     # @return [Array<String, nil>]
-    def targetfile(data, read = false, doc = true)
-      if data[:type] == "fileref" then ref_file data[:ref], read, doc
-      else xml_file data[:id], read
+    def targetfile(data, options)
+      options = { read: false, doc: true, relative: false }.merge(options)
+      path = options[:relative] ? data[:rel_path] : data[:ref]
+      if data[:type] == "fileref"
+        ref_file path, options[:read], options[:doc]
+      else
+        xml_file data[:id], options[:read]
       end
     end
 
@@ -94,7 +105,7 @@ module Metanorma
     end
 
     def copy_file_to_dest(fileref)
-      _file, filename = targetfile(fileref, true, false)
+      _file, filename = targetfile(fileref, read: true, doc: false)
       dest = File.join(@outdir, fileref[:rel_path])
       FileUtils.mkdir_p(File.dirname(dest))
       FileUtils.cp filename, dest
@@ -107,7 +118,7 @@ module Metanorma
       @files.each do |identifier, x|
         if x[:attachment] then copy_file_to_dest(x)
         else
-          file, filename = targetfile(x, true)
+          file, filename = targetfile(x, read: true)
           file = update_xrefs(file, identifier, internal_refs)
           Tempfile.open(["collection", ".xml"], encoding: "utf-8") do |f|
             f.write(file)

data/lib/metanorma/collection_manifest.rb

@@ -63,12 +63,13 @@ module Metanorma
       docs = @docref.each_with_object({}) do |dr, m|
         next m unless dr["fileref"]
 
-        m[dr["identifier"]] = Document.parse_file(File.join(dir, dr["fileref"]), dr["attachment"])
+        m[dr["identifier"]] = Document.parse_file(
+          File.join(dir, dr["fileref"]),
+          dr["attachment"], dr["identifier"]
+        )
         m
       end
-      @manifest.reduce(docs) do |mem, mnf|
-        mem.merge mnf.documents(dir)
-      end
+      @manifest.reduce(docs) { |mem, mnf| mem.merge mnf.documents(dir) }
     end
 
     # @param builder [Nokogiri::XML::Builder]

data/lib/metanorma/compile.rb

@@ -223,7 +223,7 @@ module Metanorma
               @processor.output(nil, presentationxml_name, outfilename, ext, isodoc_options) :
               @processor.output(isodoc, xml_name, outfilename, ext, isodoc_options)
           rescue StandardError => e
-            if e.message.start_with? "mn2pdf"
+            if e.message.include? "Fatal:"
               @errors << e.message
             else
               puts e.message

data/lib/metanorma/config.rb

@@ -15,7 +15,7 @@ module Metanorma
     attr_accessor :logs
 
     def initialize
-      @logs ||= [:warning, :error, :fatal]
+      @logs ||= %i[warning error fatal]
     end
   end
 

data/lib/metanorma/document.rb

@@ -1,7 +1,7 @@
 module Metanorma
   class Document
     # @return [Strin]
-    attr_reader :file, :attachment
+    attr_reader :file, :attachment, :bibitem
 
     # @param bibitem [RelatonBib::BibliographicItem]
     def initialize(bibitem, file, options = {})
@@ -14,9 +14,12 @@ module Metanorma
     class << self
       # @param file [String] file path
       # @param attachment [Bool] is an attachment
+      # @param identifier [String] is the identifier assigned the file
+      # in the collection file
       # @return [Metanorma::Document]
-      def parse_file(file, attachment)
-        new bibitem(file), file, { attachment: attachment }
+      def parse_file(file, attachment, identifier = nil)
+        new(bibitem(file, attachment, identifier), file,
+            { attachment: attachment })
       end
 
       # #param xml [Nokogiri::XML::Document, Nokogiri::XML::Element]
@@ -31,6 +34,12 @@ module Metanorma
         new(doc, filename, raw: true)
       end
 
+      def attachment_bibitem(identifier)
+        Nokogiri::XML(
+          "<bibdata><docidentifier>#{identifier}</docidentifier></bibdata>",
+        )
+      end
+
       private
 
       # #param xml [Nokogiri::XML::Document, Nokogiri::XML::Element]
@@ -51,13 +60,16 @@ module Metanorma
       # @param file [String]
       # @return [RelatonBib::BibliographicItem,
       #   RelatonIso::IsoBibliographicItem]
-      def bibitem(file)
-        case format(file)
-        when :xml
-          from_xml Nokogiri::XML(File.read(file, encoding: "UTF-8"))
-        when :yaml
-          yaml = File.read(file, encoding: "UTF-8")
-          Relaton::Cli::YAMLConvertor.convert_single_file(yaml)
+      def bibitem(file, attachment, identifier)
+        if attachment then attachment_bibitem(identifier)
+        else
+          case format(file)
+          when :xml
+            from_xml Nokogiri::XML(File.read(file, encoding: "UTF-8"))
+          when :yaml
+            yaml = File.read(file, encoding: "UTF-8")
+            Relaton::Cli::YAMLConvertor.convert_single_file(yaml)
+          end
         end
       end
     end

data/lib/metanorma/input.rb

@@ -3,6 +3,5 @@ require_relative "./input/asciidoc"
 
 module Metanorma
   module Input
-
   end
 end

data/lib/metanorma/output.rb

@@ -4,7 +4,5 @@ require_relative "./output/xslfo"
 
 module Metanorma
   module Output
-
   end
 end
-

data/lib/metanorma/output/utils.rb

@@ -7,7 +7,8 @@ module Metanorma
         def file_path(url_path)
           file_url = url_path
           file_url = "file://#{url_path}" if Pathname.new(file_url).absolute?
-          file_url = "file://#{Dir.pwd}/#{url_path}" unless %r{^file://} =~ file_url
+          %r{^file://}.match?(file_url) or
+            file_url = "file://#{Dir.pwd}/#{url_path}"
           file_url
         end
       end

data/lib/metanorma/version.rb

@@ -1,3 +1,3 @@
 module Metanorma
-  VERSION = "1.3.1".freeze
+  VERSION = "1.3.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-26 00:00:00.000000000 Z
+date: 2021-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor