metanorma 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6da8527ed559d4b6833977c169022db5dfec3a9d93926257586d9e676a11e578
-  data.tar.gz: cf9cc8d31d2ae7cbd08787dcb3f4a79747e85fad5c142bc02fd377df91e467e0
+  metadata.gz: fec4f760c22a19793bca3f3cb2c5abc0b355a8554d5ac0720fe8e679a26db842
+  data.tar.gz: ffa03687166474e66611a2fa0f5841281ae5b1127e078dd7cbf2993ec1a15f65
 SHA512:
-  metadata.gz: 07f86288c180813daf6ceed810dec2bfecc1cdb2605bf45de5f363cf0a7187babffa37095f208679fd1d1a3cdc6aeebfc879a5293f51c4f49ecc9c473a077295
-  data.tar.gz: bc111d4ca32a5b3135cf518c748370654b9f99803b4123de42b2603965bba4a1e6164e6b3307f7f9afa8b53b7b721b1b01941eee22fd3dd5d63d95a8597cb71e
+  metadata.gz: 9721c89fe96d4bfb1bf6458fc79d824fa16887a349b2bdcd9618d6528ec0b32abf86158bc7658de8288bcf130ce3008427fcc06fe036179c652b70a2a3edd9f6
+  data.tar.gz: 74993bec3d7dca356699d821dadb55f35f7f7c20d6a8270e2c3fc9e224225504fe4fe3dee77cdf9cbc0a55eeee033df0253a17307fac8fec76772dc02c5c2f2f

data/lib/metanorma/collection.rb

@@ -51,16 +51,21 @@ module Metanorma
 
     # @return [String] XML
     def to_xml
-      Nokogiri::XML::Builder.new do |xml|
+      b = Nokogiri::XML::Builder.new do |xml|
         xml.send("metanorma-collection",
                  "xmlns" => "http://metanorma.org") do |mc|
-          mc << @bibdata.to_xml(bibdata: true, date_format: :full)
-          @manifest.to_xml mc
-          content_to_xml "prefatory", mc
-          doccontainer mc
-          content_to_xml "final", mc
+          collection_body(mc)
         end
-      end.to_xml
+      end
+      b.to_xml
+    end
+
+    def collection_body(coll)
+      coll << @bibdata.to_xml(bibdata: true, date_format: :full)
+      @manifest.to_xml coll
+      content_to_xml "prefatory", coll
+      doccontainer coll
+      content_to_xml "final", coll
     end
 
     def render(opts)
@@ -128,7 +133,7 @@ module Metanorma
         <<~CONT
 
           == #{xml.at('title')&.text}
-          #{xml.at('p')&.text}
+        #{xml.at('p')&.text}
         CONT
       end
     end
@@ -153,7 +158,7 @@ module Metanorma
       return unless (cnt = send(elm))
 
       require "metanorma-#{doctype}"
-      out = sections(dummy_header + cnt)
+      out = sections(dummy_header + cnt.strip)
       builder.send("#{elm}-content") { |b| b << out }
     end
 
@@ -169,13 +174,17 @@ module Metanorma
       return unless Array(@directives).include? "documents-inline"
 
       documents.each_with_index do |(_, d), i|
-        id = format("doc%<index>09d", index: i)
-        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
+        doccontainer1(builder, d, i)
+      end
+    end
+
+    def doccontainer1(builder, doc, idx)
+      id = format("doc%<index>09d", index: idx)
+      builder.send("doc-container", id: id) do |b|
+        if doc.attachment
+          doc.bibitem and b << doc.bibitem.root.to_xml
+          b.attachment Metanorma::Utils::datauri(doc.file)
+        else doc.to_xml b
         end
       end
     end

data/lib/metanorma/collection_fileparse.rb

@@ -8,19 +8,16 @@ module Metanorma
     # UUIDs, so that their IDs can at least be registered to be tracked
     # as existing.
     def read_anchors(xml)
-      ret = {}
       xrefs = @isodoc.xref_init(@lang, @script, @isodoc, @isodoc.i18n, {})
       xrefs.parse xml
-      xrefs.get.each do |k, v|
+      xrefs.get.each_with_object({}) do |(k, v), ret|
         ret[v[:type]] ||= {}
         index = if v[:container] || v[:label].nil? || v[:label].empty?
                   UUIDTools::UUID.random_create.to_s
-                else
-                  v[:label]
+                else v[:label]
                 end
         ret[v[:type]][index] = k
       end
-      ret
     end
 
     # @param id [String]
@@ -72,7 +69,8 @@ module Metanorma
       add_document_suffix(identifier, docxml)
       update_direct_refs_to_docs(docxml, identifier)
       svgmap_resolve(datauri_encode(docxml))
-      docxml.xpath(ns("//references[not(./bibitem[not(@hidden) or @hidden = 'false'])]")).each do |f|
+      docxml.xpath(ns("//references[not(./bibitem[not(@hidden) or "\
+                      "@hidden = 'false'])]")).each do |f|
         f["hidden"] = "true"
       end
       docxml.to_xml
@@ -89,33 +87,8 @@ module Metanorma
       isodoc = IsoDoc::Convert.new({})
       docxml.xpath(ns("//svgmap//eref")).each do |e|
         href = isodoc.eref_target(e)
-        next if href == "##{e['bibitemid']}"
-
-        # 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
+        next if href == "##{e['bibitemid']}" ||
+          href =~ /^#/ && !docxml.at("//*[@id = '#{href.sub(/^#/, '')}']")
 
         e["target"] = href.strip
         e.name = "link"
@@ -159,14 +132,16 @@ module Metanorma
       docid.previous = "<docidentifier type='X'>#{file}</docidentifier>"
     end
 
-    # update crossrefences to other documents, to include disambiguating document suffix on id
+    # update crossrefences to other documents, to include
+    # disambiguating document suffix on id
     def update_anchors(bib, docxml, _id) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       docid = bib&.at(ns("./docidentifier"))&.text
       docxml.xpath("//xmlns:eref[@citeas = '#{docid}']").each do |e|
         if @files[docid]
           update_anchor_loc(bib, e, docid)
         else
-          e << "<strong>** Unresolved reference to document #{docid}, id #{e['bibitemid']}</strong>"
+          e << "<strong>** Unresolved reference to document #{docid}, "\
+            "id #{e['bibitemid']}</strong>"
         end
       end
     end
@@ -219,18 +194,8 @@ module Metanorma
     # resolve file location for the target of each internal reference
     def locate_internal_refs
       refs = gather_internal_refs
-      @files.each do |identifier, x|
-        next if x[:attachment]
-
-        file, _filename = targetfile(x, read: true)
-        docxml = Nokogiri::XML(file)
-        refs.each do |schema, ids|
-          ids.each_key do |id|
-            n = docxml.at("//*[@id = '#{id}']") and
-              n.at("./ancestor-or-self::*[@type = '#{schema}']") and
-              refs[schema][id] = identifier
-          end
-        end
+      @files.keys.reject { |k| @files[k][:attachment] }.each do |identifier|
+        locate_internal_refs1(refs, identifier, @files[identifier])
       end
       refs.each do |schema, ids|
         ids.each do |id, key|
@@ -239,5 +204,17 @@ module Metanorma
       end
       refs
     end
+
+    def locate_internal_refs1(refs, identifier, filedesc)
+      file, _filename = targetfile(filedesc, read: true)
+      docxml = Nokogiri::XML(file)
+      refs.each do |schema, ids|
+        ids.each_key do |id|
+          n = docxml.at("//*[@id = '#{id}']") and
+            n.at("./ancestor-or-self::*[@type = '#{schema}']") and
+            refs[schema][id] = identifier
+        end
+      end
+    end
   end
 end

data/lib/metanorma/collection_fileprocess.rb

@@ -16,7 +16,7 @@ module Metanorma
       files = {}
       @xml.xpath(ns("//docref")).each do |d|
         identifier = d.at(ns("./identifier")).text
-        files[identifier] = file_entry(d, path)
+        files[identifier] = file_entry(d, identifier, path)
         if files[identifier][:attachment]
           files[identifier][:bibdata] = Metanorma::Document
             .attachment_bibitem(identifier).root
@@ -31,10 +31,14 @@ module Metanorma
       files
     end
 
-    def file_entry(docref, path)
+    # rel_path is the source file address, determined relative to the YAML.
+    # out_path is the destination file address, with any references outside
+    # the working directory (../../...) truncated
+    def file_entry(docref, identifier, _path)
       ret = if docref["fileref"]
-              { type: "fileref", ref: File.join(path, docref["fileref"]),
-                rel_path: docref["fileref"] }
+              { type: "fileref", ref: @documents[identifier].file,
+                rel_path: docref["fileref"],
+                out_path: Util::source2dest_filename(docref["fileref"]) }
             else
               { type: "id", ref: docref["id"] }
             end
@@ -65,12 +69,12 @@ module Metanorma
     # @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
+    # @param relative [Boolean] Return output path,
+    # formed relative to YAML file, not input path, relative to calling function
     # @return [Array<String, nil>]
     def targetfile(data, options)
       options = { read: false, doc: true, relative: false }.merge(options)
-      path = options[:relative] ? data[:rel_path] : data[:ref]
+      path = options[:relative] ? data[:out_path] : data[:ref]
       if data[:type] == "fileref"
         ref_file path, options[:read], options[:doc]
       else
@@ -90,23 +94,23 @@ module Metanorma
     end
 
     # compile and output individual file in collection
-    def file_compile(f, filename, identifier)
+    def file_compile(file, filename, identifier)
       # warn "metanorma compile -x html #{f.path}"
       c = Compile.new
-      c.compile f.path, { format: :asciidoc,
-                          extension_keys: @format }.merge(@compile_options)
+      c.compile file.path, { format: :asciidoc,
+                             extension_keys: @format }.merge(@compile_options)
       @files[identifier][:outputs] = {}
       @format.each do |e|
         ext = c.processor.output_formats[e]
         fn = File.basename(filename).sub(/(?<=\.)[^\.]+$/, ext.to_s)
-        FileUtils.mv f.path.sub(/\.xml$/, ".#{ext}"), File.join(@outdir, fn)
+        FileUtils.mv file.path.sub(/\.xml$/, ".#{ext}"), File.join(@outdir, fn)
         @files[identifier][:outputs][e] = File.join(@outdir, fn)
       end
     end
 
     def copy_file_to_dest(fileref)
       _file, filename = targetfile(fileref, read: true, doc: false)
-      dest = File.join(@outdir, fileref[:rel_path])
+      dest = File.join(@outdir, fileref[:out_path])
       FileUtils.mkdir_p(File.dirname(dest))
       FileUtils.cp filename, dest
     end

data/lib/metanorma/collection_manifest.rb

@@ -44,7 +44,7 @@ module Metanorma
       def parse_docref(mnf)
         mnf.xpath("xmlns:docref").map do |dr|
           h = { "identifier" => dr.at("identifier").text }
-          h["fileref"] = dr[:fileref] if dr[:fileref]
+          dr[:fileref] and h["fileref"] = dr[:fileref]
           h["attachment"] = dr[:attachment] if dr[:attachment]
           h
         end
@@ -102,7 +102,7 @@ module Metanorma
     def docref_to_xml(builder)
       @docref.each do |dr|
         drf = builder.docref { |b| b.identifier dr["identifier"] }
-        drf[:fileref] = dr["fileref"]
+        drf[:fileref] = Util::source2dest_filename(dr["fileref"])
         drf[:attachment] = dr["attachment"] if dr["attachment"]
         if collection.directives.include?("documents-inline")
           id = collection.documents.find_index { |k, _| k == dr["identifier"] }

data/lib/metanorma/collection_renderer.rb

@@ -21,9 +21,9 @@ module Metanorma
     # the collection, and that the flavour gem can sensibly process it. We may
     # need to enhance metadata in the flavour gems isodoc/metadata.rb with
     # collection metadata
-    def initialize(xml, folder, options = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    def initialize(collection, folder, options = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       check_options options
-      @xml = Nokogiri::XML xml # @xml is the collection manifest
+      @xml = Nokogiri::XML collection.to_xml # @xml is the collection manifest
       @lang = @xml&.at(ns("//bibdata/language"))&.text || "en"
       @script = @xml&.at(ns("//bibdata/script"))&.text || "Latn"
       @doctype = doctype
@@ -37,6 +37,7 @@ module Metanorma
       @format = options[:format]
       @compile_options = options[:compile] || {}
       @log = options[:log]
+      @documents = collection.documents
 
       # list of files in the collection
       @files = read_files folder
@@ -51,7 +52,7 @@ module Metanorma
     # @option options [Strong] :ourput_folder output directory
     def self.render(col, options = {})
       folder = File.dirname col.file
-      cr = new(col.to_xml, folder, options)
+      cr = new(col, folder, options)
       cr.files
       cr.concatenate(col, options)
       cr.coverpage if options[:format]&.include?(:html)
@@ -61,11 +62,13 @@ module Metanorma
       options[:format] << :presentation if options[:format].include?(:pdf)
       options[:format].uniq.each do |e|
         next unless %i(presentation xml).include?(e)
+
         ext = e == :presentation ? "presentation.xml" : e.to_s
         out = col.clone
         out.directives << "documents-inline"
         out.documents.keys.each do |id|
           next if @files[id][:attachment]
+
           filename = @files[id][:outputs][e]
           out.documents[id] = Metanorma::Document.raw_file(filename)
         end
@@ -135,6 +138,8 @@ module Metanorma
     # populate liquid template of ARGV[1] with metadata extracted from
     # collection manifest
     def coverpage
+      return unless @coverpage
+
       File.open(File.join(@outdir, "index.html"), "w:UTF-8") do |f|
         f.write @isodoc.populate_template(File.read(@coverpage))
       end
@@ -199,8 +204,6 @@ module Metanorma
       unless options[:format].is_a?(Array) && (FORMATS & options[:format]).any?
         raise ArgumentError, "Need to specify formats (xml,html,pdf,doc)"
       end
-      return if !options[:format].include?(:html) || options[:coverpage]
-      raise ArgumentError, "Need to specify a coverpage to render HTML"
     end
   end
 end

data/lib/metanorma/compile.rb

@@ -20,7 +20,7 @@ module Metanorma
     def compile(filename, options = {})
       require_libraries(options)
       options = options_extract(filename, options)
-      validate_type(options) && validate_format(options) || (return nil)
+      validate_options(options)
       @processor = @registry.find_processor(options[:type].to_sym)
       extensions = get_extensions(options) or return nil
       (file, isodoc = process_input(filename, options)) or return nil

data/lib/metanorma/compile_validate.rb

@@ -1,45 +1,51 @@
 module Metanorma
   class Compile
+    def validate_options(options)
+      validate_type(options)
+      validate_format(options)
+    end
+
     def validate_type(options)
       unless options[:type]
         Util.log("[metanorma] Error: Please specify a standard type: "\
-                 "#{@registry.supported_backends}.", :error)
-        return nil
+                 "#{@registry.supported_backends}.", :fatal)
       end
       stdtype = options[:type].to_sym
-      metanorma_flavor = "metanorma-#{stdtype}"
+      load_flavor(stdtype)
+    end
+
+    def validate_format(options)
+      unless options[:format] == :asciidoc
+        Util.log("[metanorma] Error: Only source file format currently "\
+                 "supported is 'asciidoc'.", :fatal)
+      end
+    end
+
+    private
+
+    def load_flavor(stdtype)
+      flavor = "metanorma-#{stdtype}"
       unless @registry.supported_backends.include? stdtype
-        Util.log("[metanorma] Info: Loading `#{metanorma_flavor}` gem "\
+        Util.log("[metanorma] Info: Loading `#{flavor}` gem "\
                  "for standard type `#{stdtype}`.", :info)
       end
-      begin
-        require "metanorma-#{stdtype}"
-        Util.log("[metanorma] Info: gem `#{metanorma_flavor}` loaded.", :info)
-      rescue Gem::ConflictError
-        Util.log("[metanorma] Error: Couldn't resolve dependencies for "\
-                 "`metanorma-#{stdtype}`, Please add it to your Gemfile "\
-                 "and run bundle install first", :error)
-        return false
-      rescue LoadError
-        Util.log("[metanorma] Error: loading gem `#{metanorma_flavor}` "\
-                 "failed. Exiting.", :error)
-        return false
-      end
+      require_flavor(flavor, stdtype)
       unless @registry.supported_backends.include? stdtype
-        Util.log("[metanorma] Error: The `#{metanorma_flavor}` gem "\
-                 "still doesn't support `#{stdtype}`. Exiting.", :error)
-        return false
+        Util.log("[metanorma] Error: The `#{flavor}` gem "\
+                 "still doesn't support `#{stdtype}`. Exiting.", :fatal)
       end
-      true
     end
 
-    def validate_format(options)
-      unless options[:format] == :asciidoc
-        Util.log("[metanorma] Error: Only source file format currently "\
-                 "supported is 'asciidoc'.", :error)
-        return false
-      end
-      true
+    def require_flavor(flavor, stdtype)
+      require flavor
+      Util.log("[metanorma] Info: gem `#{flavor}` loaded.", :info)
+    rescue Gem::ConflictError
+      Util.log("[metanorma] Error: Couldn't resolve dependencies for "\
+               "`metanorma-#{stdtype}`, Please add it to your Gemfile "\
+               "and run bundle install first", :fatal)
+    rescue LoadError
+      Util.log("[metanorma] Error: loading gem `#{flavor}` "\
+               "failed. Exiting.", :fatal)
     end
   end
 end

data/lib/metanorma/util.rb

@@ -11,5 +11,9 @@ module Metanorma
         exit(1)
       end
     end
+
+    def self.source2dest_filename(name)
+      name.sub(%r{^(\./)?(\.\./)+}, "")
+    end
   end
 end

data/lib/metanorma/version.rb

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

metadata

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