metanorma 1.7.4 → 1.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3a50d8116aadebecaf6fbdcdc1b9ffaee19cb233bf38ad6ea2f7b6b1b320fa8
-  data.tar.gz: 67283cbe9df47b100e3b6598f08bb7a00e9be1602d3a6cc7d41ff3b527673556
+  metadata.gz: 3a0536c88a7c8537b315bda6cfd570203898587b523a2b627db62474a7f53f37
+  data.tar.gz: fec598a14f605c2e9af31195e30d7c725a74477efaad572592c149dd5579c69e
 SHA512:
-  metadata.gz: 195226d8f70127bfe659d1a032824482ec02911ca8f7f1e9d0f75f14f5b319e90912300345a50c05422b6dd87fc5b0b1674b11f66471e06c8ff79c39a4ab3db3
-  data.tar.gz: 4fbf96851ca7857e83767abbb86c13cc9a28130b289543f82b9d30841d55298703149b82d48597c6d25acc8ea7a0667ff00a49784187f471d0f685c0598a2104
+  metadata.gz: 0e2978dcd6a5b2269465f8a710eeaf04acc6b261ba5d7848aa46be5b1b44479420e7249d22b75df423e9cee91a5be55f423e6910856d0259bbdd2000f0c5d478
+  data.tar.gz: e63eb96bea888b9e383f0f9f1131ea1a419f87b3c39b31c07dfdbbf91fafe7f061a3b73da8a9532c910869de1a9a0b4174828f6dcba8997c5be1129f0bbf4e95

data/Gemfile.devel

@@ -0,0 +1,2 @@
+gem "metanorma-cli"
+gem "isodoc", git: "https://github.com/metanorma/isodoc", branch: "main"

data/lib/metanorma/collection.rb

@@ -13,10 +13,11 @@ module Metanorma
 
     # @return [Array<String>] documents-inline to inject the XML into
     #   the collection manifest; documents-external to keeps them outside
-    attr_accessor :directives, :documents, :bibdatas, :coverpage
+    attr_accessor :directives, :documents, :bibdatas, :coverpage, :dirname
     attr_accessor :disambig, :manifest
 
     # @param file [String] path to source file
+    # @param dirname [String] directory of source file
     # @param directives [Array<String>] documents-inline to inject the XML into
     #   the collection manifest; documents-external to keeps them outside
     # @param bibdata [RelatonBib::BibliographicItem]
@@ -28,30 +29,33 @@ module Metanorma
     # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
     def initialize(**args)
       @file = args[:file]
+      @dirname = File.dirname(@file)
       @directives = args[:directives] || []
       @bibdata = args[:bibdata]
       @manifest = args[:manifest]
       @manifest.collection = self
-      c = @directives.detect { |x| x.is_a?(Hash) && x["coverpage"] }
-      c and @coverpage = c["coverpage"]
-      c = @directives.detect { |x| x.is_a?(Hash) && x["coverpage-style"] }
-      c and @coverpage_style = c["coverpage-style"]
+      @coverpage = Util::hash_key_detect(@directives, "coverpage", @coverpage)
+      @coverpage_style = Util::hash_key_detect(@directives, "coverpage-style",
+                                               @coverpage_style)
       @documents = args[:documents] || {}
       @bibdatas = args[:documents] || {}
       if @documents.any? && !@directives.include?("documents-inline")
         @directives << "documents-inline"
       end
-      @documents.merge! @manifest.documents(File.dirname(@file))
-      @bibdatas.merge! @manifest.documents(File.dirname(@file))
+      @documents.merge! @manifest.documents(@dirname)
+      @bibdatas.merge! @manifest.documents(@dirname)
+      @documents.transform_keys { |k| Util::key(k) }
+      @bibdatas.transform_keys { |k| Util::key(k) }
       @prefatory = args[:prefatory]
       @final = args[:final]
+      @compile = Metanorma::Compile.new
       @log = Metanorma::Utils::Log.new
       @disambig = Util::DisambigFiles.new
     end
 
     # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
     def clean_exit
-      @log.write(File.join(File.dirname(@file),
+      @log.write(File.join(@dirname,
                            "#{File.basename(@file, '.*')}.err.html"))
     end
 
@@ -195,7 +199,7 @@ module Metanorma
     def content_to_xml(elm, builder)
       return unless (cnt = send(elm))
 
-      require "metanorma-#{doctype}"
+      @compile.load_flavor(doctype)
       out = sections(dummy_header + cnt.strip)
       builder.send("#{elm}-content") { |b| b << out }
     end

data/lib/metanorma/collection_fileparse.rb

@@ -8,6 +8,7 @@ module Metanorma
         .targetfile_id(docid, relative: true, read: false,
                               doc: !@files.get(docid, :attachment))
       dest = newbib.at("./docidentifier") || newbib.at(ns("./docidentifier"))
+      dest or dest = newbib.elements[-1]
       dest.previous = "<uri type='citation'>#{url}</uri>"
       bib.replace(newbib)
     end
@@ -178,8 +179,9 @@ module Metanorma
     def indirect_ref_key(schema, id, docxml)
       /^#{schema}_/.match?(id) and return id
       ret = "#{schema}_#{id}"
-      (k = docxml.root["type"]) && k != schema and
-        ret = "#{ret}_#{docxml.root['document_suffix']}"
+      suffix = docxml.root['document_suffix']
+      (k = docxml.root["type"]) && k != schema && suffix and 
+        ret = "#{ret}_#{suffix}"
       ret
     end
 

data/lib/metanorma/collection_fileprocess.rb

@@ -56,7 +56,7 @@ module Metanorma
     # process each file in the collection
     # files are held in memory, and altered as postprocessing
     def files # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      warn "\n\n\n\n\nInternal Refs: #{DateTime.now.strftime('%H:%M:%S')}"
+      warn "\n\n\n\n\nRender Files: #{DateTime.now.strftime('%H:%M:%S')}"
       internal_refs = locate_internal_refs
       @files.keys.each_with_index do |ident, i|
         i.positive? && Array(@directives).include?("bare-after-first") and
@@ -121,6 +121,7 @@ module Metanorma
 
     # resolve file location for the target of each internal reference
     def locate_internal_refs
+      warn "\n\n\n\n\nInternal Refs: #{DateTime.now.strftime('%H:%M:%S')}"
       refs = populate_internal_refs(gather_internal_refs)
       refs.each do |schema, ids|
         ids.each do |id, key|

data/lib/metanorma/collection_manifest.rb

@@ -67,8 +67,8 @@ module Metanorma
     def documents(dir = "")
       docs = @docref.each_with_object({}) do |dr, m|
         dr["fileref"] or next m
-        m[dr["identifier"]] = Document.parse_file(
-          rel_path_resolve(dir, dr["fileref"]),
+        m[Util::key dr["identifier"]] = Document.parse_file(
+          Util::rel_path_resolve(dir, dr["fileref"]),
           dr["attachment"], dr["identifier"], dr["index"]
         )
         m
@@ -76,11 +76,6 @@ module Metanorma
       @manifest.reduce(docs) { |mem, mnf| mem.merge mnf.documents(dir) }
     end
 
-    def rel_path_resolve(dir, path)
-      p = Pathname.new(path)
-      p.absolute? ? path : File.join(dir, path)
-    end
-
     # @param builder [Nokogiri::XML::Builder]
     def to_xml(builder)
       builder.manifest do |b|
@@ -114,7 +109,7 @@ module Metanorma
         drf = builder.docref do |b|
           b.identifier { |i| i << dr["identifier"] }
           !dr["attachment"] && !dr["sectionsplit"] &&
-            d = @collection.bibdatas[dr["identifier"]] and
+            d = @collection.bibdatas[Util::key dr["identifier"]] and
             b.parent.add_child(d.bibitem.to_xml(bibdata: true))
         end
         docref_to_xml_attrs(drf, dr)

data/lib/metanorma/collection_render_utils.rb

@@ -148,10 +148,10 @@ module Metanorma
         "final-content": isodoc_builder(@xml.at(ns("//final-content"))),
         doctitle: m.at(ns("../bibdata/title"))&.text,
         docnumber: m.at(ns("../bibdata/docidentifier"))&.text }.each do |k, v|
-        v and @isodoc.meta.set(
-          k, v
-        )
-      end
+          v and @isodoc.meta.set(
+            k, v
+          )
+        end
     end
 
     def isodoc_builder(node)

data/lib/metanorma/collection_render_word.rb

@@ -0,0 +1,131 @@
+module Metanorma
+  class CollectionRenderer
+    def docconv
+      @tempfile_cache ||= []
+      doctype = @doctype.to_sym
+      x = Asciidoctor.load nil, backend: doctype
+      x.converter.doc_converter(DocOptionsNode.new(@directives, @dirname))
+    end
+
+    def concat_extract_files(filename)
+      xml = Nokogiri::XML(File.read(filename, encoding: "UTF-8"), &:huge)
+      docs = xml.xpath(ns("//doc-container")).each_with_object([]) do |x, m|
+        n = Nokogiri::XML::Document.new
+        n.add_child(x.elements.first.remove)
+        m << n
+      end
+      [wrapping_doc(docs.first.dup, xml), docs]
+    end
+
+    def wrapping_doc(doc, xml)
+      doc.at(ns("//bibdata")).replace(xml.at(ns("//bibdata")).to_xml)
+      sections = wrapping_doc_body(doc)
+      wrapping_doc_intro_outro(xml, sections)
+      set_displayorder_wrapping_doc(doc)
+    end
+
+    def wrapping_doc_intro_outro(xml, sections)
+      p = xml.at(ns("//prefatory-content")) and
+        sections.previous = "<preface>#{p.children.to_xml}</preface>"
+      p = xml.at(ns("//final-content")) and
+        sections.next = "<annex>#{p.children.to_xml}</annex>"
+    end
+
+    def wrapping_doc_body(doc)
+      doc.xpath(ns("//annex | //preface | //bibliography")).each(&:remove)
+      s = doc.at(ns("//sections"))
+      repl = <<~BODY
+        <sections><clause id='_collection_placeholder'><p>PLACEHOLDER</p></clause></sections>
+      BODY
+      s.replace(repl)
+      doc.at(ns("//sections"))
+    end
+
+    def set_displayorder_wrapping_doc(doc)
+      doc.xpath(ns("//preface/* | //sections/* | //annex"))
+        .each_with_index do |x, i|
+        x["displayorder"] = i + 1
+      end
+      doc
+    end
+
+    SECTION_BREAK = '<p class="MsoNormal"><br clear="all" class="section"/></p>'
+      .freeze
+    DIV1 = '<div class="WordSection1">&#xa0;</div>'.freeze
+    DIV2 = '<div class="WordSection2">&#xa0;</div>'.freeze
+
+    def docconv_convert1(docs)
+      docs.each_with_index.with_object([]) do |(d, i), m|
+        conv = docconv
+        conv.convert_init(d.to_xml(encoding: "UTF-8"), "xxxx", false)
+        html = conv.postprocess_cleanup(conv.convert1(d, "xxx", "."))
+        @tempfile_cache += conv.tempfile_cache # hold on to the temp img files
+        b = Nokogiri::XML(html).at("//body")
+        i == docs.size - 1 or
+          b << '<p class="MsoNormal"><br clear="all" class="section"/></p>'
+        m << b.children
+      end
+    end
+
+    def collection_coverpages(conv, docs)
+      conv.wordintropage and [DIV2, SECTION_BREAK].reverse.each do |s|
+        docs.unshift(Nokogiri::XML(s).root)
+      end
+      conv.wordcoverpage and [DIV1, SECTION_BREAK].reverse.each do |s|
+        docs.unshift(Nokogiri::XML(s).root)
+      end
+      docs
+    end
+
+    def docconv_convert(filename)
+      pref_file, docs = concat_extract_files(filename)
+      body = docconv_convert1(docs)
+      collection_conv = overall_docconv_converter(body)
+      collection_coverpages(collection_conv, body)
+      collection_conv.convert(filename, pref_file.to_xml, false)
+    end
+
+    def overall_docconv_cover(collection_conv)
+      p = Util::hash_key_detect(@directives, "collection-word-coverpage", nil)
+      collection_conv.wordcoverpage =
+        Util::rel_path_resolve(@dirname, p)
+      p = Util::hash_key_detect(@directives, "collection-word-intropage", nil)
+      collection_conv.wordintropage =
+        Util::rel_path_resolve(@dirname, p)
+    end
+
+    def overall_docconv_converter(body)
+      collection_conv = docconv
+      collection_conv.options[:collection_doc] = body.map(&:to_xml).join
+      overall_docconv_cover(collection_conv)
+
+      def collection_conv.postprocess_cleanup(result)
+        ret = to_xhtml(super)
+        b = ret.at("//div[@id = '_collection_placeholder']")
+        b.replace(@options[:collection_doc])
+        from_xhtml(ret)
+      end
+
+      collection_conv
+    end
+
+    class DocOptionsNode
+      def initialize(directives, dir)
+        @dir = dir
+        @wordcoverpage =
+          Util::hash_key_detect(directives, "document-word-coverpage",
+                                @wordcoverpage)
+        @wordintropage =
+          Util::hash_key_detect(directives, "document-word-intropage",
+                                @wordintropage)
+      end
+
+      def attr(key)
+        case key
+        when "wordcoverpage" then Util::rel_path_resolve(@dir, @wordcoverpage)
+        when "wordintropage" then Util::rel_path_resolve(@dir, @wordintropage)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/collection_renderer.rb

@@ -5,6 +5,7 @@ require_relative "fontist_utils"
 require_relative "util"
 require_relative "files_lookup"
 require_relative "collection_render_utils"
+require_relative "collection_render_word"
 
 module Metanorma
   # XML collection renderer
@@ -33,7 +34,8 @@ module Metanorma
       @script = @xml.at("//xmlns:bibdata/xmlns:script")&.text || "Latn"
       @locale = @xml.at("//xmlns:bibdata/xmlns:locale")&.text
       @doctype = doctype
-      require "metanorma-#{@doctype}"
+      @compile = Compile.new
+      @compile.load_flavor(@doctype)
 
       @isodoc = isodoc_create # output processor for flavour
       @outdir = dir_name_cleanse(options[:output_folder])
@@ -45,8 +47,8 @@ module Metanorma
       @documents = collection.documents
       @bibdata = collection.documents
       @directives = collection.directives
+      @dirname = collection.dirname
       @disambig = Util::DisambigFiles.new
-      @compile = Compile.new
       @c = HTMLEntities.new
       @files_to_delete = []
       @nested = options[:nested] # if false, this is the root instance of Renderer
@@ -61,6 +63,7 @@ module Metanorma
     end
 
     def flush_files
+      warn "\n\n\n\n\nDone: #{DateTime.now.strftime('%H:%M:%S')}"
       warn @files.files_to_delete
       @files.files_to_delete.each { |f| FileUtils.rm_f(f) }
       @files_to_delete.each { |f| FileUtils.rm_f(f) }
@@ -72,31 +75,37 @@ module Metanorma
     # @option options [Array<Symbol>] :format list of formats
     # @option options [Strong] :ourput_folder output directory
     def self.render(col, options = {})
-      folder = File.dirname col.file
       warn "\n\n\n\n\nRender Init: #{DateTime.now.strftime('%H:%M:%S')}"
-      cr = new(col, folder, options)
-      warn "\n\n\n\n\nRender Files: #{DateTime.now.strftime('%H:%M:%S')}"
+      cr = new(col, File.dirname(col.file), options)
       cr.files
-      warn "\n\n\n\n\nConcatenate: #{DateTime.now.strftime('%H:%M:%S')}"
       cr.concatenate(col, options)
-      warn "\n\n\n\n\nCoverpage: #{DateTime.now.strftime('%H:%M:%S')}"
-      cr.coverpage if options[:format]&.include?(:html)
-      warn "\n\n\n\n\nDone: #{DateTime.now.strftime('%H:%M:%S')}"
+      options[:format]&.include?(:html) and cr.coverpage
       cr.flush_files
       cr
     end
 
     def concatenate(col, options)
-      options[:format] << :presentation if options[:format].include?(:pdf)
-      options[:format].uniq.each do |e|
-        %i(presentation xml).include?(e) or next
+      warn "\n\n\n\n\nConcatenate: #{DateTime.now.strftime('%H:%M:%S')}"
+      (options[:format] & %i(pdf doc)).empty? or
+        options[:format] << :presentation
+      concatenate_prep(col, options)
+      concatenate_outputs(options)
+    end
+
+    def concatenate_prep(col, options)
+      %i(xml presentation).each do |e|
+        options[:format].include?(e) or next
         ext = e == :presentation ? "presentation.xml" : e.to_s
         File.open(File.join(@outdir, "collection.#{ext}"), "w:UTF-8") do |f|
           f.write(concatenate1(col.clone, e).to_xml)
         end
       end
-      options[:format].include?(:pdf) and
-        pdfconv.convert(File.join(@outdir, "collection.presentation.xml"))
+    end
+
+    def concatenate_outputs(options)
+      pres = File.join(@outdir, "collection.presentation.xml")
+      options[:format].include?(:pdf) and pdfconv.convert(pres)
+      options[:format].include?(:doc) and docconv_convert(pres)
     end
 
     def concatenate1(out, ext)
@@ -104,8 +113,7 @@ module Metanorma
       out.bibdatas.each_key do |ident|
         id = @isodoc.docid_prefix(nil, ident.dup)
         @files.get(id, :attachment) || @files.get(id, :outputs).nil? and next
-
-        out.documents[id] =
+        out.documents[Util::key id] =
           Metanorma::Document.raw_file(@files.get(id, :outputs)[ext])
       end
       out
@@ -127,6 +135,7 @@ module Metanorma
     # collection manifest
     def coverpage
       @coverpage or return
+      warn "\n\n\n\n\nCoverpage: #{DateTime.now.strftime('%H:%M:%S')}"
       File.open(File.join(@outdir, "index.html"), "w:UTF-8") do |f|
         f.write @isodoc.populate_template(File.read(@coverpage))
       end
@@ -153,8 +162,7 @@ module Metanorma
     # @param builder [Nokogiri::XML::Builder]
     def docrefs(elm, builder)
       elm.xpath(ns("./docref[@index = 'true']")).each do |d|
-        ident = d.at(ns("./identifier")).children.to_xml
-        ident = @c.decode(@isodoc.docid_prefix(nil, ident))
+        ident = docref_ident(d)
         builder.li do |li|
           li.a href: index_link(d, ident) do |a|
             a << ident.split(/([<>&])/).map do |x|
@@ -165,6 +173,11 @@ module Metanorma
       end
     end
 
+    def docref_ident(docref)
+      ident = docref.at(ns("./identifier")).children.to_xml
+      @c.decode(@isodoc.docid_prefix(nil, ident))
+    end
+
     def index_link(docref, ident)
       if docref["fileref"]
         @files.get(ident, :out_path).sub(/\.xml$/, ".html")

data/lib/metanorma/compile_validate.rb

@@ -21,19 +21,25 @@ module Metanorma
       end
     end
 
-    private
-
     def load_flavor(stdtype)
-      flavor = "metanorma-#{stdtype}"
-      unless @registry.supported_backends.include? stdtype
+      stdtype = stdtype.to_sym
+      flavor = stdtype2flavor(stdtype)
+      @registry.supported_backends.include? stdtype or
         Util.log("[metanorma] Info: Loading `#{flavor}` gem "\
                  "for standard type `#{stdtype}`.", :info)
-      end
       require_flavor(flavor)
-      unless @registry.supported_backends.include? stdtype
+      @registry.supported_backends.include? stdtype or
         Util.log("[metanorma] Error: The `#{flavor}` gem does not "\
                  "support the standard type #{stdtype}. Exiting.", :fatal)
-      end
+    end
+
+    private
+
+    STDTYPE2FLAVOR = { plateau: "jis" }.freeze
+
+    def stdtype2flavor(stdtype)
+      flavor = STDTYPE2FLAVOR[stdtype] || stdtype
+      "metanorma-#{flavor}"
     end
 
     def require_flavor(flavor)

data/lib/metanorma/document.rb

@@ -33,6 +33,7 @@ module Metanorma
 
       # raw XML file, can be used to put in entire file instead of just bibitem
       def raw_file(filename)
+        require "debug"; binding.b if filename.nil?
         doc = Nokogiri::XML(File.read(filename, encoding: "UTF-8")) do |config|
           config.huge
         end

data/lib/metanorma/files_lookup.rb

@@ -67,7 +67,7 @@ module Metanorma
       out = ref["attachment"] ? ref["fileref"] : File.basename(ref["fileref"])
       out1 = @disambig.source2dest_filename(out)
       ret = if ref["fileref"]
-              { type: "fileref", ref: @documents[identifier].file,
+              { type: "fileref", ref: @documents[Util::key identifier].file,
                 rel_path: ref["fileref"],
                 out_path: out1 } # @disambig.source2dest_filename(out) }
             else { type: "id", ref: ref["id"] }

data/lib/metanorma/util.rb

@@ -74,6 +74,24 @@ module Metanorma
       end
     end
 
+    def self.hash_key_detect(directives, key, variable)
+      c = directives.detect { |x| x.is_a?(Hash) && x.has_key?(key) } or
+        return variable
+      c[key]
+    end
+
+    def self.rel_path_resolve(dir, path)
+      path.nil? and return path
+      path.empty? and return path
+      p = Pathname.new(path)
+      p.absolute? ? path : File.join(dir, path)
+    end
+
+    def self.key(ident)
+      @c ||= HTMLEntities.new
+      @c.decode(ident).gsub(/(\p{Zs})+/, " ")
+    end
+
     class DisambigFiles
       def initialize
         @seen_filenames = []

data/lib/metanorma/version.rb

@@ -1,3 +1,3 @@
 module Metanorma
-  VERSION = "1.7.4".freeze
+  VERSION = "1.7.5".freeze
 end

data/metanorma.gemspec

@@ -44,4 +44,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-command", "~> 1.0"
   spec.add_development_dependency "rubocop", "~> 1.5.2"
   spec.add_development_dependency "sassc", "~> 2.4.0"
+  spec.add_development_dependency "simplecov", "~> 0.15"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 1.7.4
+  version: 1.7.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-11 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -234,6 +234,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
 description: Library to process any Metanorma standard.
 email:
 - open.source@ribose.com
@@ -251,6 +265,7 @@ files:
 - CHANGELOG.adoc
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.devel
 - LICENSE.txt
 - README.adoc
 - lib/metanorma.rb
@@ -261,6 +276,7 @@ files:
 - lib/metanorma/collection_fileprocess.rb
 - lib/metanorma/collection_manifest.rb
 - lib/metanorma/collection_render_utils.rb
+- lib/metanorma/collection_render_word.rb
 - lib/metanorma/collection_renderer.rb
 - lib/metanorma/compile.rb
 - lib/metanorma/compile_options.rb