metanorma 1.2.8 → 1.3.4

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,20 +1,25 @@
 module Metanorma
   class Document
     # @return [Strin]
-    attr_reader :file
+    attr_reader :file, :attachment, :bibitem
 
     # @param bibitem [RelatonBib::BibliographicItem]
     def initialize(bibitem, file, options = {})
       @bibitem = bibitem
       @file = file
+      @attachment = options[:attachment]
       @raw = options[:raw]
     end
 
     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)
-        new bibitem(file), file
+      def parse_file(file, attachment, identifier = nil)
+        new(bibitem(file, attachment, identifier), file,
+            { attachment: attachment })
       end
 
       # #param xml [Nokogiri::XML::Document, Nokogiri::XML::Element]
@@ -29,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]
@@ -49,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/fontist_utils.rb

@@ -0,0 +1,108 @@
+module Metanorma
+  class FontistUtils
+    class << self
+      private
+
+      def validate_options(options)
+        agree_to_terms = options[:agree_to_terms] || false
+        continue_without_fonts = options[:continue_without_fonts] || false
+        no_progress = options[:no_progress] || false
+
+        [agree_to_terms, continue_without_fonts, no_progress]
+      end
+
+      def validate_install_fonts(processor, options)
+        if options[:no_install_fonts]
+          Util.log("[fontist] Skip font installation because" \
+                   " --no-install-fonts argument passed", :debug)
+          return false
+        elsif missing_fontist_manifest?(processor)
+          Util.log("[fontist] Skip font installation because "\
+                   "font_manifest is missing", :debug)
+          return false
+        end
+        true
+      end
+
+      def install_fonts_safe(manifest, agree, continue, no_progress)
+        fontist_install(manifest, agree, no_progress)
+      rescue Fontist::Errors::LicensingError
+        if continue
+          Util.log(
+            "[fontist] Processing will continue without fonts installed",
+            :debug
+          )
+        else
+          Util.log("[fontist] Aborting without proper fonts installed," \
+                   " make sure that you have set option --agree-to-terms",
+                   :fatal)
+        end
+      rescue Fontist::Errors::FontError => e
+        log_level = continue ? :warning : :fatal
+        Util.log("[fontist] '#{e.font}' font is not supported. " \
+                 "Please report this issue at github.com/metanorma/metanorma" \
+                 "/issues to report this issue.", log_level)
+      rescue Fontist::Errors::FormulaIndexNotFoundError
+        if @@updated_formulas_repo
+          Util.log(
+            "[fontist] Bug: formula index not found after 'fontist update'",
+            :fatal
+          )
+        end
+        Util.log("[fontist] Missing formula index. Fetching it...", :debug)
+        Fontist::Formula.update_formulas_repo
+        @@updated_formulas_repo = true
+        install_fonts_safe(manifest, agree, continue, no_progress)
+      end
+
+      def fontist_install(manifest, agree, no_progress)
+        Fontist::Manifest::Install.from_hash(
+          manifest,
+          confirmation: agree ? "yes" : "no",
+          no_progress: no_progress
+        )
+      end
+
+      def dump_fontist_manifest_locations(manifest)
+        location_manifest = Fontist::Manifest::Locations.from_hash(
+          manifest
+        )
+        location_manifest_file = Tempfile.new(["fontist_locations", ".yml"])
+        location_manifest_file.write location_manifest.to_yaml
+        location_manifest_file.flush
+        location_manifest_file
+      end
+
+      def missing_fontist_manifest?(processor)
+        !processor.respond_to?(:fonts_manifest) || processor.fonts_manifest.nil?
+      end
+    end
+
+    def self.install_fonts(processor, options)
+      return unless validate_install_fonts(processor, options)
+
+      @@updated_formulas_repo = false
+      manifest = processor.fonts_manifest
+      agree_to_terms, can_without_fonts, no_progress = validate_options(options)
+
+      install_fonts_safe(
+        manifest,
+        agree_to_terms,
+        can_without_fonts,
+        no_progress
+      )
+    end
+
+    def self.fontist_font_locations(processor, options)
+      if missing_fontist_manifest?(processor) || options[:no_install_fonts]
+        return nil
+      end
+
+      dump_fontist_manifest_locations(processor.fonts_manifest)
+    rescue Fontist::Errors::FormulaIndexNotFoundError
+      raise unless options[:continue_without_fonts]
+
+      nil
+    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,72 +56,39 @@ module Metanorma
         attr&.sub(/^#{name}:\s*$/, "#{name}: true")&.sub(/^#{name}:\s+/, "")
       end
 
-      def extract_options(file)
-        headerextract = file.sub(/\n\n.*$/m, "\n")
+      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
 
-        /\n:script: (?<script>[^\n]+)\n/ =~ headerextract
-        /\n:body-font: (?<bodyfont>[^\n]+)\n/ =~ headerextract
-        /\n:header-font: (?<headerfont>[^\n]+)\n/ =~ headerextract
-        /\n:monospace-font: (?<monospacefont>[^\n]+)\n/ =~ headerextract
-        /\n:title-font: (?<titlefont>[^\n]+)\n/ =~ headerextract
-        /\n:i18nyaml: (?<i18nyaml>[^\n]+)\n/ =~ headerextract
-        /\n:htmlstylesheet: (?<htmlstylesheet>[^\n]+)\n/ =~ headerextract
-        /\n:htmlstylesheet-override: (?<htmlstylesheet_override>[^\n]+)\n/ =~ headerextract
-        /\n:htmlcoverpage: (?<htmlcoverpage>[^\n]+)\n/ =~ headerextract
-        /\n:htmlintropage: (?<htmlintropage>[^\n]+)\n/ =~ headerextract
-        /\n:scripts: (?<scripts>[^\n]+)\n/ =~ headerextract
-        /\n:scripts-pdf: (?<scripts_pdf>[^\n]+)\n/ =~ headerextract
-        /\n:wordstylesheet: (?<wordstylesheet>[^\n]+)\n/ =~ headerextract
-        /\n:wordstylesheet-override: (?<wordstylesheet_override>[^\n]+)\n/ =~ headerextract
-        /\n:standardstylesheet: (?<standardstylesheet>[^\n]+)\n/ =~ headerextract
-        /\n:header: (?<header>[^\n]+)\n/ =~ headerextract
-        /\n:wordcoverpage: (?<wordcoverpage>[^\n]+)\n/ =~ headerextract
-        /\n:wordintropage: (?<wordintropage>[^\n]+)\n/ =~ headerextract
-        /\n:ulstyle: (?<ulstyle>[^\n]+)\n/ =~ headerextract
-        /\n:olstyle: (?<olstyle>[^\n]+)\n/ =~ headerextract
-        /\n:data-uri-image: (?<datauriimage>[^\n]+)\n/ =~ headerextract
-        /\n:htmltoclevels: (?<htmltoclevels>[^\n]+)\n/ =~ headerextract
-        /\n:doctoclevels: (?<doctoclevels>[^\n]+)\n/ =~ headerextract
-        /\n:(?<hierarchical_assets>hierarchical-assets:[^\n]*)\n/ =~ headerextract
-        /\n:(?<use_xinclude>use-xinclude:[^\n]*)\n/ =~ headerextract
-        /\n:(?<break_up_urls_in_tables>break-up-urls-in-tables:[^\n]*)\n/ =~ headerextract
+      def extract_options(file)
+        header = file.sub(/\n\n.*$/m, "\n")
+        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:(?<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_urls_in_tables) and
-          break_up_urls_in_tables = empty_attr(break_up_urls_in_tables, "break-up-urls-in-tables")
-        {
-          script: defined?(script) ? script : nil,
-          bodyfont: defined?(bodyfont) ? bodyfont : nil,
-          headerfont: defined?(headerfont) ? headerfont : nil,
-          monospacefont: defined?(monospacefont) ? monospacefont : nil,
-          titlefont: defined?(titlefont) ? titlefont : nil,
-          i18nyaml: defined?(i18nyaml) ? i18nyaml : nil,
-          htmlstylesheet: defined?(htmlstylesheet) ? htmlstylesheet : nil,
-          htmlstylesheet_override: defined?(htmlstylesheet_override) ? htmlstylesheet_override : nil,
-          htmlcoverpage: defined?(htmlcoverpage) ? htmlcoverpage : nil,
-          htmlintropage: defined?(htmlintropage) ? htmlintropage : nil,
-          scripts: defined?(scripts) ? scripts : nil,
-          scripts_pdf: defined?(scripts_pdf) ? scripts_pdf : nil,
-          wordstylesheet: defined?(wordstylesheet) ? wordstylesheet : nil,
-          wordstylesheet_override: defined?(wordstylesheet_override) ? wordstylesheet_override : nil,
-          standardstylesheet: defined?(standardstylesheet) ? standardstylesheet : nil,
-          header: defined?(header) ? header : nil,
-          wordcoverpage: defined?(wordcoverpage) ? wordcoverpage : nil,
-          wordintropage: defined?(wordintropage) ? wordintropage : nil,
-          ulstyle: defined?(ulstyle) ? ulstyle : nil,
-          olstyle: defined?(olstyle) ? olstyle : nil,
+        defined?(break_up) and
+          break_up = empty_attr(break_up, "break-up-urls-in-tables")
+        ret.merge(
           datauriimage: defined?(datauriimage) ? datauriimage != "false" : nil,
-          htmltoclevels: defined?(htmltoclevels) ? htmltoclevels : nil,
-          doctoclevels: defined?(doctoclevels) ? doctoclevels : 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_urls_in_tables) ? break_up_urls_in_tables : nil,
-        }.reject { |_, val| val.nil? }
+          break_up_urls_in_tables: defined?(break_up) ? break_up : 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,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.2.8"
+  VERSION = "1.3.4".freeze
 end

data/metanorma.gemspec

@@ -1,16 +1,15 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "metanorma/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "metanorma"
   spec.version       = Metanorma::VERSION
-  spec.authors       = ['Ribose Inc.']
-  spec.email         = ['open.source@ribose.com']
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
 
-  spec.summary       = %q{Metanorma is the standard of standards; the metanorma gem allows you to create any standard document type supported by Metanorma.}
-  spec.description   = %q{Library to process any Metanorma standard.}
+  spec.summary       = "Metanorma is the standard of standards; the metanorma gem allows you to create any standard document type supported by Metanorma."
+  spec.description   = "Library to process any Metanorma standard."
   spec.homepage      = "https://github.com/metanorma/metanorma"
   spec.license       = "BSD-2-Clause"
 
@@ -19,28 +18,28 @@ Gem::Specification.new do |spec|
   end
   spec.extra_rdoc_files = %w[README.adoc CHANGELOG.adoc LICENSE.txt]
   spec.bindir        = "bin"
-  #spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  # 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.4.0"
 
-  spec.add_runtime_dependency 'asciidoctor'
-  spec.add_runtime_dependency 'htmlentities'
-  spec.add_runtime_dependency 'nokogiri'
-  spec.add_runtime_dependency 'mn2pdf', "~> 1"
-  spec.add_runtime_dependency 'metanorma-utils', "~> 1.1.0"
-  spec.add_runtime_dependency 'pry'
-  spec.add_runtime_dependency 'fontist', '~> 1.8'
+  spec.add_runtime_dependency "asciidoctor"
+  spec.add_runtime_dependency "fontist", "~> 1.8"
+  spec.add_runtime_dependency "htmlentities"
+  spec.add_runtime_dependency "metanorma-utils", "~> 1.2.0"
+  spec.add_runtime_dependency "mn2pdf", "~> 1"
+  spec.add_runtime_dependency "nokogiri"
+  spec.add_runtime_dependency "pry"
 
-# get relaton-cli to avoid circular reference with metanorma-standoc
-  #spec.add_dependency "relaton-cli"
-  #spec.add_dependency "metanorma-standoc"
+  # get relaton-cli to avoid circular reference with metanorma-standoc
+  # spec.add_dependency "relaton-cli"
+  # spec.add_dependency "metanorma-standoc"
 
+  spec.add_development_dependency "byebug", "~> 10.0"
+  spec.add_development_dependency "equivalent-xml", "~> 0.6"
+  spec.add_development_dependency "metanorma-iso", "~> 1.8.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "byebug", "~> 10.0"
   spec.add_development_dependency "rspec-command", "~> 1.0"
-  spec.add_development_dependency "equivalent-xml", "~> 0.6"
-  spec.add_development_dependency "metanorma-iso", "~> 1.7.0"
-  spec.add_development_dependency "sassc", "~> 2.4.0"
   spec.add_development_dependency "rubocop", "~> 1.5.2"
+  spec.add_development_dependency "sassc", "~> 2.4.0"
 end