metanorma 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9167ec4dc502678a508ea35bb8ed81d3914487b0dd2f2562b2e26bd2803faff
-  data.tar.gz: cfe251c6ed0436df5b7f9eba6c01e368fb0bee55651366a83a949f403f2b10bc
+  metadata.gz: cc6ddbece893102c78d8b27a94f175a85c45cfb911e8d7bc908440bd19a58e85
+  data.tar.gz: 226289825a52fe8da92a744a00a2239385e46f0964468be522f6b5bb7ba8066d
 SHA512:
-  metadata.gz: 5fe17ebf90571ce884b547f38a8736947d749ad9ec45a7dfcc9e8bb1aef91f2b0e2e284d509d70da150cb806c402945555d698c6f06e03006a46500e4648707e
-  data.tar.gz: 6bf8355bd20b904f7fc7960aadbbbb6363e052b0c7d83689562f0f1fea4811a0785006f24e1766fbf5d354a44424b37f7ea749328229b8e0af925ab90288176f
+  metadata.gz: 0d9c775a338fc4b30a27aa53e217037583228a702c61977070f7e76895718b7a1d8e138b26f3053eed4ae9bdfb361a9b4545b62ad4c6e98df5f187eef8209399
+  data.tar.gz: f5c41df1386891d848d76576e783335697c80adb75eefda918a990c414ec112844d53e9f94717049873171f9978acaa28e7eed98e04ab11eedcbb11d87119576

data/lib/metanorma/collection/collection.rb

@@ -11,6 +11,9 @@ module Metanorma
 
   class AdocFileNotFoundException < StandardError; end
 
+  # One or more collection members failed to render (#586)
+  class RenderFailureException < StandardError; end
+
   # Metanorma collection of documents
   class Collection
     attr_reader :file, :prefatory, :final
@@ -132,8 +135,24 @@ module Metanorma
       opts[:log] = @log
       opts[:flavor] = @flavor
       output_folder(opts)
-      ::Metanorma::Collection::Renderer.render self, opts
+      cr = ::Metanorma::Collection::Renderer.render self, opts
       clean_exit
+      render_failures_abort(cr)
+      cr
+    end
+
+    # A member whose rendering fails no longer lets the collection
+    # report success with the document missing from the output (#586).
+    # Every member is rendered before aborting, so one run reports all
+    # failures; the raise makes callers (CLI, suma) exit non-zero. Runs
+    # after clean_exit so the failures are in the written log.
+    def render_failures_abort(renderer)
+      f = renderer.fatal_errors
+      f.empty? and return
+      raise RenderFailureException.new(
+        "Collection render failed for #{f.size} document(s):\n" +
+        f.join("\n"),
+      )
     end
 
     def output_folder(opts)

data/lib/metanorma/collection/log.rb

@@ -11,6 +11,13 @@ module Metanorma
       "METANORMA_3": { category: "Cross-References",
                        error: "<strong>** Unresolved reference to document %s from eref</strong>",
                        severity: 2 },
+      "METANORMA_4": { category: "Rendering",
+                       error: "Collection member %s: expected output " \
+                              "file not generated: %s",
+                       severity: 0 },
+      "METANORMA_5": { category: "Rendering",
+                       error: "Collection member %s: rendering error: %s",
+                       severity: 0 },
     }.freeze
     # rubocop:enable Naming/VariableNumber
   end

data/lib/metanorma/collection/renderer/filelocation.rb

@@ -26,12 +26,16 @@ module Metanorma
         end
       end
 
-      # Move file to new output filename if specified
+      # Move file to new output filename if specified. A member that
+      # failed to render has nothing to move: keep the original name
+      # registered so output verification reports it as missing, rather
+      # than crashing the whole collection on the mv (#586).
       def handle_new_output_filename(output_fname, new_output_fname)
         return output_fname unless new_output_fname
 
-        FileUtils.mv(File.join(@outdir, output_fname),
-                     File.join(@outdir, new_output_fname))
+        src = File.join(@outdir, output_fname)
+        File.exist?(src) or return output_fname
+        FileUtils.mv(src, File.join(@outdir, new_output_fname))
         new_output_fname
       end
 

data/lib/metanorma/collection/renderer/fileprocess.rb

@@ -18,9 +18,61 @@ module Metanorma
         opts = compile_options_base(identifier)
           .merge(compile_options_update(identifier))
 
+        err_count = @compile.errors.size
         @compile.compile file, opts
         @files.set(identifier, :outputs, {})
         file_compile_formats(filename, identifier, opts)
+        file_compile_verify(identifier, @compile.errors[err_count..] || [])
+      end
+
+      # A member whose rendering raised produces no output file, but the
+      # collection build used to continue, exit 0, and link the absent
+      # document from index.html -- silent data loss (#586). Two
+      # complementary checks close that hole. (1) Compile pools rescued
+      # error messages in @compile.errors for its caller to surface; the
+      # standalone CLI does, but the collection pipeline never read the
+      # pool. The pool is shared across members and never reset, so the
+      # slice appended during this member's compile is this member's
+      # errors -- sound while members compile sequentially (the current
+      # design; @compile's own format-level parallelism is joined before
+      # compile returns). (2) Independently of whether anything was
+      # pooled, verify the outputs registered for the member exist on
+      # disk. Failures are reported here and accumulated; the collection
+      # renders every remaining member before Collection#render aborts,
+      # so one run reports all failed members.
+      def file_compile_verify(identifier, errors)
+        # Section-split parts (marked with :parentid) register format
+        # slots they never produce -- their :xml slot in particular is
+        # never written, and under filename renaming it aliases to the
+        # parent's name -- so verifying them is a false positive. #586
+        # was scoped to the non-sectionsplit path; parts are excluded
+        # like their parents (which return early above).
+        @files.get(identifier, :parentid) and return
+        missing = (@files.get(identifier, :outputs) || {})
+          .reject { |_fmt, path| File.exist?(path) }
+        errors.empty? && missing.empty? and return
+        file_compile_failure_log(identifier, errors, missing)
+        msg = file_compile_failure_msg(identifier, errors, missing)
+        ::Metanorma::Util.log("[metanorma] Error: #{msg}", :error)
+        fatal_errors << msg
+      end
+
+      def file_compile_failure_log(identifier, errors, missing)
+        missing.each_value do |path|
+          @log&.add("METANORMA_4", nil, params: [identifier, path])
+        end
+        errors.each do |e|
+          @log&.add("METANORMA_5", nil, params: [identifier, e])
+        end
+      end
+
+      def file_compile_failure_msg(identifier, errors, missing)
+        ret = []
+        missing.empty? or
+          ret << "expected output not generated: " \
+                 "#{missing.values.join(', ')}"
+        ret += errors
+        "Failed to render collection member #{identifier}: #{ret.join('; ')}"
       end
 
       def compile_options_base(identifier)
@@ -198,7 +250,7 @@ module Metanorma
       end
 
       def update_bibitem(bib, identifier)
-        newbib, url = update_bibitem_prep(bib, identifier)
+        newbib, url, attachment = update_bibitem_prep(bib, identifier)
         newbib or return
         dest = begin
           newbib.at("./docidentifier") || newbib.at(ns("./docidentifier"))
@@ -206,18 +258,22 @@ module Metanorma
           nil
         end
         dest or dest = newbib.elements[-1]
+        # An attachment carries both a <uri type="attachment"> (which drives
+        # isodoc's fmt-link attachment="true") and the citation uri; the
+        # attachment uri goes first. metanorma/iso-10303#208.
+        attachment and dest.previous = "<uri type='attachment'>#{url}</uri>"
         dest.previous = "<uri type='citation'>#{url}</uri>"
         bib.replace(newbib)
       end
 
       def update_bibitem_prep(bib, identifier)
-        docid = get_bibitem_docid(bib, identifier) or return [nil, nil]
+        docid = get_bibitem_docid(bib, identifier) or return [nil, nil, nil]
         newbib = dup_bibitem(docid, bib)
         attachment = @files.get(docid, :attachment)
         url = @files.url(docid, relative: true, doc: !attachment)
         current_html = referencing_html_location(identifier, attachment)
         url = make_relative_path(current_html, url) if current_html
-        [newbib, url]
+        [newbib, url, attachment]
       end
 
       # Location of the HTML that will carry the cross-reference to the target,

data/lib/metanorma/collection/renderer/renderer.rb

@@ -19,7 +19,7 @@ module Metanorma
 
       attr_accessor :isodoc, :isodoc_presxml
       attr_reader :xml, :compile, :compile_options, :documents, :outdir,
-                  :manifest
+                  :manifest, :fatal_errors
 
       # Run the block with the renderer in nested mode, restoring the previous
       # mode afterwards. Nested mode (used by sectionsplit, which re-enters this
@@ -93,6 +93,10 @@ module Metanorma
         @final = collection.final
         @c = HTMLEntities.new
         @files_to_delete = []
+        # Per-member rendering failures (missing outputs, pooled compile
+        # errors), accumulated by file_compile_verify; Collection#render
+        # aborts on them once every member has rendered (#586).
+        @fatal_errors = []
         @nested = options[:nested]
         # if false, this is the root instance of Renderer
         # if true, then this is not the last time Renderer will be run
@@ -302,7 +306,10 @@ module Metanorma
           # (Sectionsplit parents get a :presentation output upstream, so they
           # inline whole for the PDF/presentation path.)
           outputs = @files.get(id, :outputs)
-          if outputs.nil? || outputs[ext].nil?
+          # The registered path may exist without the file: a member whose
+          # rendering failed registers its intended outputs but writes
+          # nothing (#586), so check the disk, not just the registration.
+          if outputs.nil? || outputs[ext].nil? || !File.exist?(outputs[ext])
             warn "[metanorma] collection document '#{id}' has no compiled " \
                  "#{ext} output to inline; skipping (its doc-container would " \
                  "otherwise be bibdata-only)."

data/lib/metanorma/compile/render.rb

@@ -135,8 +135,7 @@ module Metanorma
                         output_paths[:out], ext, isodoc_options)
       wrap_html(options, output_paths[:ext], output_paths[:out])
     rescue StandardError => e
-      strict = ext == :presentation || isodoc_options[:strict] == true
-      isodoc_error_process(e, strict, false)
+      isodoc_error_process(e, strict_error?(ext, isodoc_options), false)
     end
 
     # Process format directly from semantic XML
@@ -145,8 +144,7 @@ module Metanorma
                         ext, isodoc_options)
       true # Return as Thread equivalent
     rescue StandardError => e
-      strict = ext == :presentation || isodoc_options[:strict] == "true"
-      isodoc_error_process(e, strict, true)
+      isodoc_error_process(e, strict_error?(ext, isodoc_options), true)
       ext != :presentation
     end
 
@@ -168,12 +166,29 @@ module Metanorma
 
     private
 
+    # A presentation failure is always strict: every downstream format
+    # needs the presentation XML. The :strict option arrives as a
+    # boolean from the CLI but as a string from document attributes, so
+    # accept both (the two rescue sites previously each checked only
+    # one form).
+    def strict_error?(ext, isodoc_options)
+      ext == :presentation ||
+        [true, "true"].include?(isodoc_options[:strict])
+    end
+
+    # On the strict path the message is pooled into @errors for the
+    # caller to surface (the standalone CLI reports the pool and
+    # aborts; the collection renderer attributes it to the failed
+    # member, #586). The class+message line is also printed here in all
+    # cases, so it sits adjacent to its backtrace in the build log: a
+    # pooled message surfaces only at end of run, and a bare backtrace
+    # mid-log is undiagnosable. The exception class is retained because
+    # for errors like Encoding::UndefinedConversionError it carries
+    # half the diagnosis.
     def isodoc_error_process(err, strict, must_abort)
-      if strict || err.message.include?("Fatal:")
-        @errors << err.message
-      else
-        puts err.message
-      end
+      msg = "#{err.class}: #{err.message}"
+      strict || err.message.include?("Fatal:") and @errors << msg
+      puts msg
       puts err.backtrace.join("\n")
       must_abort and 1
     end

data/lib/metanorma/version.rb

@@ -1,3 +1,3 @@
 module Metanorma
-  VERSION = "2.5.1".freeze
+  VERSION = "2.5.2".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - Ribose Inc.
@@ -217,7 +217,6 @@ extra_rdoc_files:
 files:
 - ".envrc"
 - ".gitignore"
-- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.adoc

data/.hound.yml

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