metanorma 1.3.1 → 1.3.6

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/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]
@@ -27,10 +30,18 @@ module Metanorma
 
       # raw XML file, can be used to put in entire file instead of just bibitem
       def raw_file(filename)
-        doc = Nokogiri::XML(File.read(filename, encoding: "UTF-8"))
+        doc = Nokogiri::XML(File.read(filename, encoding: "UTF-8")) do |config|
+          config.huge
+        end
         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 +62,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
@@ -88,7 +102,9 @@ module Metanorma
       if @raw
         builder << @bibitem.root.to_xml
       else
-        builder.send(type + "-standard") { |b| b << @bibitem.to_xml(bibdata: true) }
+        builder.send("#{type}-standard") do |b|
+          b << @bibitem.to_xml(bibdata: true)
+        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/input/asciidoc.rb

@@ -2,20 +2,14 @@ require "nokogiri"
 
 module Metanorma
   module Input
-
     class Asciidoc < Base
-
       def process(file, filename, type, options = {})
         require "asciidoctor"
         out_opts = {
-          to_file: false,
-          safe: :safe,
-          backend: type,
-          header_footer: true,
-          attributes: [
-            "nodoc", "stem", "xrefstyle=short", "docfile=#{filename}",
-            "output_dir=#{options[:output_dir]}"
-          ]
+          to_file: false, safe: :safe, backend: type, header_footer: true,
+          attributes: ["nodoc", "stem", "xrefstyle=short",
+                       "docfile=#{filename}",
+                       "output_dir=#{options[:output_dir]}"]
         }
         unless asciidoctor_validate(file, filename, out_opts)
           warn "Cannot continue compiling Asciidoctor document"
@@ -27,11 +21,12 @@ module Metanorma
       def asciidoctor_validate(file, filename, options)
         err = nil
         begin
-          previous_stderr, $stderr = $stderr, StringIO.new
+          previous_stderr = $stderr
+          $stderr = StringIO.new
           ::Asciidoctor.load(file, options)
-          %r{(\n|^)asciidoctor: ERROR: ['"]?#{Regexp.escape(filename || 
-            "<empty>")}['"]?: line \d+: include file not found: }.match($stderr.string) and
-              err = $stderr.string
+          %r{(\n|^)asciidoctor: ERROR: ['"]?#{Regexp.escape(filename ||
+            "<empty>")}['"]?: line \d+: include file not found: }
+            .match($stderr.string) and err = $stderr.string
         ensure
           $stderr = previous_stderr
         end
@@ -45,8 +40,9 @@ module Metanorma
         /\n:mn-output-extensions: (?<extensions>[^\n]+)\n/ =~ headerextract
         /\n:mn-relaton-output-file: (?<relaton>[^\n]+)\n/ =~ headerextract
         /\n(?<asciimath>:mn-keep-asciimath:[^\n]*)\n/ =~ headerextract
-        asciimath = defined?(asciimath) ?
-          (!asciimath.nil? && asciimath != ":mn-keep-asciimath: false") : nil
+        asciimath = if defined?(asciimath)
+                      (!asciimath.nil? && asciimath != ":mn-keep-asciimath: false")
+                    end
         asciimath = nil if asciimath == false
         {
           type: defined?(type) ? type : nil,
@@ -60,38 +56,39 @@ module Metanorma
         attr&.sub(/^#{name}:\s*$/, "#{name}: true")&.sub(/^#{name}:\s+/, "")
       end
 
+      ADOC_OPTIONS = %w(htmlstylesheet htmlcoverpage htmlintropage scripts
+                        scripts-override scripts-pdf wordstylesheet bare i18nyaml
+                        standardstylesheet header wordcoverpage wordintropage
+                        ulstyle olstyle htmlstylesheet-override
+                        htmltoclevels doctoclevels sectionsplit
+                        body-font header-font monospace-font title-font
+                        wordstylesheet-override).freeze
+
       def extract_options(file)
         header = file.sub(/\n\n.*$/m, "\n")
-        ret = %w(htmlstylesheet htmlcoverpage htmlintropage scripts
-                 scripts-pdf wordstylesheet
-                 standardstylesheet header wordcoverpage wordintropage i18nyaml
-                 ulstyle olstyle htmlstylesheet-override
-                 htmltoclevels doctoclevels sectionsplit
-                 body-font header-font monospace-font title-font
-                 wordstylesheet-override).each_with_object({}) do |w, acc|
+        ret = ADOC_OPTIONS.each_with_object({}) do |w, acc|
           m = /\n:#{w}: ([^\n]+)\n/.match(header) or next
           acc[w.gsub(/-/, "").sub(/override$/, "_override")
             .sub(/pdf$/, "_pdf").to_sym] = m[1]
         end
         /\n:data-uri-image: (?<datauriimage>[^\n]+)\n/ =~ header
-        /\n:(?<hierarchical_assets>hierarchical-assets:[^\n]*)\n/ =~ header
+        /\n:(?<hier_assets>hierarchical-assets:[^\n]*)\n/ =~ header
         /\n:(?<use_xinclude>use-xinclude:[^\n]*)\n/ =~ header
         /\n:(?<break_up>break-up-urls-in-tables:[^\n]*)\n/ =~ header
 
-        defined?(hierarchical_assets) and
-          hierarchical_assets = empty_attr(hierarchical_assets, "hierarchical-assets")
+        defined?(hier_assets) and
+          hier_assets = empty_attr(hier_assets, "hierarchical-assets")
         defined?(use_xinclude) and
           use_xinclude = empty_attr(use_xinclude, "use-xinclude")
         defined?(break_up) and
           break_up = empty_attr(break_up, "break-up-urls-in-tables")
-        ret.merge({
+        ret.merge(
           datauriimage: defined?(datauriimage) ? datauriimage != "false" : nil,
-          hierarchical_assets: defined?(hierarchical_assets) ? hierarchical_assets : nil,
+          hierarchical_assets: defined?(hier_assets) ? hier_assets : nil,
           use_xinclude: defined?(use_xinclude) ? use_xinclude : nil,
           break_up_urls_in_tables: defined?(break_up) ? break_up : nil,
-        }).reject { |_, val| val.nil? }
+        ).reject { |_, val| val.nil? }
       end
-
     end
   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/util.rb

@@ -11,5 +11,50 @@ module Metanorma
         exit(1)
       end
     end
+
+    # dependency ordering
+    def self.sort_extensions_execution_ord(ext)
+      case ext
+      when :xml then 0
+      when :rxl then 1
+      when :presentation then 2
+      else
+        99
+      end
+    end
+
+    def self.sort_extensions_execution(ext)
+      ext.sort do |a, b|
+        sort_extensions_execution_ord(a) <=> sort_extensions_execution_ord(b)
+      end
+    end
+
+    class DisambigFiles
+      def initialize
+        @seen_filenames = []
+      end
+
+      def source2dest_filename(name, disambig = true)
+        n = name.sub(%r{^(\./)?(\.\./)+}, "")
+        dir = File.dirname(n)
+        base = File.basename(n)
+        if disambig && @seen_filenames.include?(base)
+          base = disambiguate_filename(base)
+        end
+        @seen_filenames << base
+        dir == "." ? base : File.join(dir, base)
+      end
+
+      def disambiguate_filename(base)
+        m = /^(?<start>.+\.)(?!0)(?<num>\d+)\.(?<suff>[^.]*)$/.match(base) ||
+          /^(?<start>.+\.)(?<suff>[^.]*)/.match(base) ||
+          /^(?<start>.+)$/.match(base)
+        i = m.names.include?("num") ? m["num"].to_i + 1 : 1
+        while @seen_filenames.include? base = "#{m['start']}#{i}.#{m['suff']}"
+          i += 1
+        end
+        base
+      end
+    end
   end
 end

data/lib/metanorma/version.rb

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

data/metanorma.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
   spec.bindir        = "bin"
   # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
   spec.add_runtime_dependency "asciidoctor"
-  spec.add_runtime_dependency "fontist", "~> 1.8"
+  spec.add_runtime_dependency "fontist", "~> 1.9"
   spec.add_runtime_dependency "htmlentities"
   spec.add_runtime_dependency "metanorma-utils", "~> 1.2.0"
   spec.add_runtime_dependency "mn2pdf", "~> 1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-26 00:00:00.000000000 Z
+date: 2021-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -286,7 +286,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="