metanorma 1.7.6 → 2.0.0

data/lib/metanorma/util/util.rb

@@ -0,0 +1,45 @@
+module Metanorma
+  module Util
+    class << self
+      def log(message, type = :info)
+        log_types = Metanorma.configuration.logs.map(&:to_s) || []
+
+        if log_types.include?(type.to_s)
+          puts(message)
+        end
+
+        if type == :fatal
+          exit(1)
+        end
+      end
+
+      # dependency ordering
+      def sort_extensions_execution_ord(ext)
+        case ext
+        when :xml then 0
+        when :rxl then 1
+        when :presentation then 2
+        else
+          99
+        end
+      end
+
+      def sort_extensions_execution(ext)
+        ext.sort do |a, b|
+          sort_extensions_execution_ord(a) <=> sort_extensions_execution_ord(b)
+        end
+      end
+
+      def recursive_string_keys(hash)
+        case hash
+        when Hash then hash.map do |k, v|
+                         [k.to_s, recursive_string_keys(v)]
+                       end.to_h
+        when Enumerable then hash.map { |v| recursive_string_keys(v) }
+        else
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/util/worker_pool.rb

@@ -0,0 +1,39 @@
+module Metanorma
+  module Util
+    class WorkersPool
+      def initialize(workers)
+        init_vars(workers)
+        @threads = Array.new(@workers) do
+          init_thread
+        end
+      end
+
+      def init_vars(workers)
+        @workers = workers
+        @queue = SizedQueue.new(@workers)
+      end
+
+      def init_thread
+        Thread.new do
+          catch(:exit) do
+            loop do
+              job, args = @queue.pop
+              job.call *args
+            end
+          end
+        end
+      end
+
+      def schedule(*args, &block)
+        @queue << [block, args]
+      end
+
+      def shutdown
+        @workers.times do
+          schedule { throw :exit }
+        end
+        @threads.map(&:join)
+      end
+    end
+  end
+end

data/lib/metanorma/version.rb

@@ -1,3 +1,3 @@
 module Metanorma
-  VERSION = "1.7.6".freeze
+  VERSION = "2.0.0".freeze
 end

data/lib/metanorma.rb

@@ -1,17 +1,22 @@
 # frozen_string_literal: true
 
+class Array
+  alias orig_filter filter
+end
+
 require "metanorma/version"
 require "asciidoctor"
-require "metanorma/util"
-require "metanorma/config"
+require "metanorma/util/util"
+require "metanorma/config/config"
 require "metanorma/input"
-require "metanorma/registry"
-require "metanorma/processor"
+require "metanorma/registry/registry"
+require "metanorma/processor/processor"
 require "metanorma/asciidoctor_extensions"
-require "metanorma/compile"
-require "metanorma/collection"
-require "metanorma/collection_renderer"
-require "metanorma/document"
+require "metanorma/compile/compile"
+require "metanorma/collection/collection"
+require "metanorma/collection/manifest/manifest"
+require "metanorma/collection/renderer/renderer"
+require "metanorma/collection/document/document"
 require "vectory"
 
 # Metanorma module

data/metanorma.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "isodoc", ">= 2.6.3"
   spec.add_runtime_dependency "mn2pdf", "~> 1"
   spec.add_runtime_dependency "nokogiri"
-  spec.add_runtime_dependency "pry"
+  spec.add_runtime_dependency "shale"
 
   # get relaton-cli to avoid circular reference with metanorma-standoc
   # spec.add_dependency "relaton-cli"
@@ -39,6 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "metanorma-iso"
   spec.add_development_dependency "mnconvert"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-command", "~> 1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 1.7.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: shale
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -265,38 +279,49 @@ files:
 - CHANGELOG.adoc
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.devel
 - LICENSE.txt
 - README.adoc
 - lib/metanorma.rb
+- lib/metanorma/array_monkeypatch.rb
 - lib/metanorma/asciidoctor_extensions.rb
 - lib/metanorma/asciidoctor_extensions/glob_include_processor.rb
-- lib/metanorma/collection.rb
-- lib/metanorma/collection_fileparse.rb
-- 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
-- lib/metanorma/compile_validate.rb
-- lib/metanorma/config.rb
-- lib/metanorma/document.rb
-- lib/metanorma/extract.rb
-- lib/metanorma/files_lookup.rb
-- lib/metanorma/files_lookup_sectionsplit.rb
-- lib/metanorma/fontist_utils.rb
+- lib/metanorma/collection/collection.rb
+- lib/metanorma/collection/config/bibdata.rb
+- lib/metanorma/collection/config/compile_options.rb
+- lib/metanorma/collection/config/config.rb
+- lib/metanorma/collection/config/converters.rb
+- lib/metanorma/collection/config/directive.rb
+- lib/metanorma/collection/config/manifest.rb
+- lib/metanorma/collection/document/document.rb
+- lib/metanorma/collection/filelookup/filelookup.rb
+- lib/metanorma/collection/filelookup/filelookup_sectionsplit.rb
+- lib/metanorma/collection/manifest/manifest.rb
+- lib/metanorma/collection/renderer/fileparse.rb
+- lib/metanorma/collection/renderer/fileprocess.rb
+- lib/metanorma/collection/renderer/navigation.rb
+- lib/metanorma/collection/renderer/render_word.rb
+- lib/metanorma/collection/renderer/renderer.rb
+- lib/metanorma/collection/renderer/utils.rb
+- lib/metanorma/collection/sectionsplit/sectionsplit.rb
+- lib/metanorma/collection/util/disambig_files.rb
+- lib/metanorma/collection/util/util.rb
+- lib/metanorma/collection/xrefprocess/xrefprocess.rb
+- lib/metanorma/compile/compile.rb
+- lib/metanorma/compile/compile_options.rb
+- lib/metanorma/compile/compile_validate.rb
+- lib/metanorma/compile/extract.rb
+- lib/metanorma/config/config.rb
 - lib/metanorma/input.rb
 - lib/metanorma/input/asciidoc.rb
 - lib/metanorma/input/base.rb
 - lib/metanorma/processor.rb
-- lib/metanorma/registry.rb
-- lib/metanorma/sectionsplit.rb
-- lib/metanorma/sectionsplit_links.rb
-- lib/metanorma/util.rb
+- lib/metanorma/processor/processor.rb
+- lib/metanorma/registry/registry.rb
+- lib/metanorma/shale_monkeypatch.rb
+- lib/metanorma/util/fontist_helper.rb
+- lib/metanorma/util/util.rb
+- lib/metanorma/util/worker_pool.rb
 - lib/metanorma/version.rb
-- lib/metanorma/worker_pool.rb
 - metanorma.gemspec
 homepage: https://github.com/metanorma/metanorma
 licenses:
@@ -317,7 +342,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Metanorma is the standard of standards; the metanorma gem allows you to create

data/Gemfile.devel

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

data/lib/metanorma/collection.rb

@@ -1,243 +0,0 @@
-# frozen_string_literal: true
-
-require "relaton"
-require "relaton/cli"
-require "metanorma/collection_manifest"
-require "metanorma-utils"
-require_relative "util"
-
-module Metanorma
-  # Metanorma collection of documents
-  class Collection
-    attr_reader :file
-
-    # @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, :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]
-    # @param manifest [Metanorma::CollectionManifest]
-    # @param documents [Hash<String, Metanorma::Document>]
-    # @param prefatory [String]
-    # @param coverpage [String]
-    # @param final [String]
-    # 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
-      @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(@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(@dirname,
-                           "#{File.basename(@file, '.*')}.err.html"))
-    end
-
-    # @return [String] XML
-    def to_xml
-      b = Nokogiri::XML::Builder.new do |xml|
-        xml.send(:"metanorma-collection",
-                 "xmlns" => "http://metanorma.org") do |mc|
-          collection_body(mc)
-        end
-      end
-      b.to_xml
-    end
-
-    def collection_body(coll)
-      coll << @bibdata.to_xml(bibdata: true, date_format: :full)
-      @directives.each do |d|
-        coll << "<directives>#{obj_to_xml(d)}</directives>"
-      end
-      @manifest.to_xml coll
-      content_to_xml "prefatory", coll
-      doccontainer coll
-      content_to_xml "final", coll
-    end
-
-    def obj_to_xml(elem)
-      case elem
-      when ::Array
-        elem.each_with_object([]) do |v, m|
-          m << "<value>#{obj_to_xml(v)}</value>"
-        end.join
-      when ::Hash
-        elem.each_with_object([]) do |(k, v), m|
-          m << "<#{k}>#{obj_to_xml(v)}</#{k}>"
-        end.join
-      else elem end
-    end
-
-    def render(opts)
-      CollectionRenderer.render self, opts.merge(log: @log)
-      clean_exit
-    end
-
-    class << self
-      # @param file [String]
-      # @return [RelatonBib::BibliographicItem,
-      #   RelatonIso::IsoBibliographicItem]
-      def parse(file)
-        case file
-        when /\.xml$/ then parse_xml(file)
-        when /.ya?ml$/ then parse_yaml(file)
-        end
-      end
-
-      private
-
-      def parse_xml(file)
-        xml = Nokogiri::XML(File.read(file, encoding: "UTF-8"), &:huge)
-        (b = xml.at("/xmlns:metanorma-collection/xmlns:bibdata")) and
-          bd = Relaton::Cli.parse_xml(b)
-        mnf_xml = xml.at("/xmlns:metanorma-collection/xmlns:manifest")
-        mnf = CollectionManifest.from_xml mnf_xml
-        pref = pref_final_content xml.at("//xmlns:prefatory-content")
-        fnl = pref_final_content xml.at("//xmlns:final-content")
-        cov = pref_final_content xml.at("//xmlns:coverpage")
-        new(file: file, bibdata: bd, manifest: mnf,
-            directives: directives_from_xml(xml.xpath("//xmlns:directives")),
-            documents: docs_from_xml(xml, mnf),
-            bibdatas: docs_from_xml(xml, mnf),
-            prefatory: pref, final: fnl, coverpage: cov)
-      end
-
-      # TODO refine
-      def directives_from_xml(dir)
-        dir.each_with_object([]) do |d, m|
-          m << if d.at("./xmlns:value")
-                 x.xpath("./xmlns:value").map(&:text)
-               elsif d.at("./*")
-                 d.elements.each_with_object({}) do |e, ret|
-                   ret[e.name] = e.children.to_xml
-                 end
-               else d.children.to_xml
-               end
-        end
-      end
-
-      def parse_yaml(file)
-        yaml = YAML.load_file file
-        if yaml["bibdata"]
-          bd = Relaton::Cli::YAMLConvertor.convert_single_file yaml["bibdata"]
-        end
-        mnf = CollectionManifest.from_yaml yaml["manifest"]
-        dirs = yaml["directives"]
-        pref = yaml["prefatory-content"]
-        fnl = yaml["final-content"]
-        new(file: file, directives: dirs, bibdata: bd, manifest: mnf,
-            prefatory: pref, final: fnl)
-      end
-
-      # @param xml [Nokogiri::XML::Document]
-      # @parma mnf [Metanorma::CollectionManifest]
-      # @return [Hash{String=>Metanorma::Document}]
-      def docs_from_xml(xml, mnf)
-        xml.xpath("//xmlns:doc-container//xmlns:bibdata")
-          .each_with_object({}) do |b, m|
-          bd = Relaton::Cli.parse_xml b
-          docref = mnf.docref_by_id bd.docidentifier.first.id
-          m[docref["identifier"]] = Document.new bd, docref["fileref"]
-          m
-        end
-      end
-
-      # @param xml [Nokogiri::XML::Element, nil]
-      # @return [String, nil]
-      def pref_final_content(xml)
-        xml or return
-        <<~CONT
-
-            == #{xml.at('title')&.text}
-          #{xml.at('p')&.text}
-        CONT
-      end
-    end
-
-    private
-
-    # @return [String, nil]
-    attr_reader :prefatory, :final
-
-    # @return [String]
-    def dummy_header
-      <<~DUMMY
-        = X
-        A
-
-      DUMMY
-    end
-
-    # @param elm [String] 'prefatory' or 'final'
-    # @param builder [Nokogiri::XML::Builder]
-    def content_to_xml(elm, builder)
-      return unless (cnt = send(elm))
-
-      @compile.load_flavor(doctype)
-      out = sections(dummy_header + cnt.strip)
-      builder.send("#{elm}-content") { |b| b << out }
-    end
-
-    # @param cnt [String] prefatory/final content
-    # @return [String] XML
-    def sections(cnt)
-      c = Asciidoctor.convert(cnt, backend: doctype.to_sym, header_footer: true)
-      Nokogiri::XML(c, &:huge).at("//xmlns:sections").children.to_xml
-    end
-
-    # @param builder [Nokogiri::XML::Builder]
-    def doccontainer(builder)
-      Array(@directives).include? "documents-inline" or return
-      documents.each_with_index do |(_, d), i|
-        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 Vectory::Utils::datauri(doc.file)
-        else doc.to_xml b
-        end
-      end
-    end
-
-    def doctype
-      @doctype ||= fetch_doctype || "standoc"
-    end
-
-    def fetch_doctype
-      docid = @bibdata.docidentifier.first
-      docid or return
-      docid.type&.downcase || docid.id&.sub(/\s.*$/, "")&.downcase
-    end
-  end
-end