metanorma 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5afd8795a47a00890fd05c762db66dfdb4803e8a3e7279b5c25fc579094a4824
-  data.tar.gz: 21af01a41736b2c7b8a521d9489323c3a4ef2273670546acd898d9820445eaf0
+  metadata.gz: 315077d28cfe3e052808e9890d2f3c3f571b7350788e6d6423be1746e5559ef4
+  data.tar.gz: f8a9c7d3055af8a687fe8df52b725b1fadbceb8920bef8ea449af5cde0aafb6a
 SHA512:
-  metadata.gz: 0715b1527df4e4e3169f176c9301a1c6cec2fe0a72a46c61613d45addc11186d81a8f2400c65aa395e01721870f94e081706a935480d5e87c638e10f484afd70
-  data.tar.gz: d47bdf3f165768070fd249fa7f1bbb5e6f65305c345f4848ba7dd03820ae1729f3dde273986cd5d5e03c1f218f73da444387b19705399d50805b300d43991829
+  metadata.gz: ab023b366ca20c7d4fe3785e00698d2ccd868c0d119b0df74a5ba52e11f4bd69b884b18fea2b820838708c3bae5516be911c9e82de8302b6ade8cf52c99c36b4
+  data.tar.gz: 3f3520b67f58296be755b0e8b2b9cfb0e98611e214f73e131e1eccde7b74dfd611db1f476cee84d5071f6ef0c1b7b801ed9874e7261697b52fb7bf288282c57d

data/.github/workflows/macos.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/windows.yml
 
 jobs:
   test-macos:
     name: Test on Ruby ${{ matrix.ruby }} macOS
     runs-on: macos-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -29,10 +37,10 @@ jobs:
       - name: Use Node
         uses: actions/setup-node@v1
         with:
-          node-version: '8'
+          node-version: '12'
       - name: Install Puppeteer
         run: |
-          npm install -g puppeteer
+          npm install -g puppeteer@3.0.1
       - name: Run specs
         run: |
           bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/windows.yml
 
 jobs:
   test-linux:
     name: Test on Ruby ${{ matrix.ruby }} Ubuntu
     runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -29,15 +37,17 @@ jobs:
       - name: Use Node
         uses: actions/setup-node@v1
         with:
-          node-version: '8'
+          node-version: '12'
       - name: Install Puppeteer
         run: |
-          npm install -g puppeteer
+          sudo apt-get update
+          sudo apt-get install libgbm1
+          npm install -g puppeteer@3.0.1
       - name: Run specs
         run: |
           bundle exec rake
       - name: Trigger dependent repositories
-        if: github.ref == 'refs/heads/master'
+        if: github.ref == 'refs/heads/master' && matrix.ruby == '2.6'
         env:
           GH_USERNAME: ${{ secrets.PAT_USERNAME }}
           GH_ACCESS_TOKEN: ${{ secrets.PAT_TOKEN }}

data/.github/workflows/windows.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/ubuntu.yml
 
 jobs:
   test-windows:
     name: Test on Ruby ${{ matrix.ruby }} Windows
     runs-on: windows-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -31,10 +39,10 @@ jobs:
       - name: Use Node
         uses: actions/setup-node@v1
         with:
-          node-version: '8'
+          node-version: '12'
       - name: Install Puppeteer
         run: |
-          npm install -g puppeteer
+          npm install -g puppeteer@3.0.1
       - name: Run specs
         run: |
           bundle exec rake

data/.gitignore

@@ -16,3 +16,6 @@
 
 # rspec failure tracking
 .rspec_status
+.rubocop-https---raw-githubusercontent-com-riboseinc-oss-guides-master-ci-rubocop-yml
+Gemfile.lock
+relaton/

data/lib/metanorma/compile.rb

@@ -4,14 +4,18 @@ require "htmlentities"
 
 module Metanorma
   class Compile
+    # @return [Array<String>]
+    attr_reader :errors
+
     def initialize
       @registry = Metanorma::Registry.instance
+      @errors = []
     end
 
     def compile(filename, options = {})
+      require_libraries(options)
       options = options_extract(filename, options)
       validate(options) or return nil
-      require_libraries(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
@@ -89,21 +93,29 @@ module Metanorma
     end
 
     def get_extensions(options)
-      options[:extension_keys] ||= @processor.output_formats.inject([]) do |memo, (k, _)|
-        memo << k; memo
+      options[:extension_keys] ||= @processor.output_formats.reduce([]) do |memo, (k, _)|
+        memo << k
       end
-      extensions = options[:extension_keys].inject([]) do |memo, e|
-        @processor.output_formats[e] and memo << e or
-          Util.log("[metanorma] Error: #{e} format is not supported for this standard.", :error)
-        memo
+      extensions = options[:extension_keys].reduce([]) do |memo, e|
+        if @processor.output_formats[e]
+          memo << e
+        else
+          message = "[metanorma] Error: #{e} format is not supported for this standard."
+          @errors << message
+          Util.log(message, :error)
+          memo
+        end
       end
+      if !extensions.include?(:presentation) and extensions.any? { |e| @processor.use_presentation_xml(e) }
+        extensions << :presentation
+        end
       extensions
     end
 
     def process_input(filename, options)
       case extname = File.extname(filename)
       when ".adoc"
-        Util.log("[metanorma] Processing: Asciidoctor input.", :info)
+        Util.log("[metanorma] Processing: AsciiDoc input.", :info)
         file = read_file(filename)
         options[:asciimath] and
           file.sub!(/^(=[^\n]+\n)/, "\\1:mn-keep-asciimath:\n")
@@ -195,24 +207,51 @@ module Metanorma
       end
     end
 
+    # dependency ordering
+    def sort_extensions_execution(ext)
+       case ext
+       when :xml then 0
+       when :rxl then 1
+       when :presentation then 2
+       else
+         99
+       end
+    end
+
+    def wrap_html(options, file_extension, outfilename)
+      if options[:wrapper] and /html$/.match file_extension
+          outfilename = outfilename.sub(/\.html$/, "")
+          FileUtils.mkdir_p outfilename
+          FileUtils.mv "#{outfilename}.html", outfilename
+          FileUtils.mv "#{outfilename}_images", outfilename, force: true
+        end
+    end
+
+    # isodoc is Raw Metanorma XML
     def process_extensions(extensions, file, isodoc, options)
-      extensions.each do |ext|
-        isodoc_options = @processor.extract_options(file)
-        isodoc_options[:datauriimage] = true if options[:datauriimage]
+      xml_name = options[:filename].sub(/\.[^.]+$/, ".xml")
+      presentationxml_name = options[:filename].sub(/\.[^.]+$/, ".presentation.xml")
+      isodoc_options = @processor.extract_options(file)
+      isodoc_options[:datauriimage] = true if options[:datauriimage]
+      extensions.sort do |a, b|
+        sort_extensions_execution(a) <=> sort_extensions_execution(b)
+      end.each do |ext|
         file_extension = @processor.output_formats[ext]
         outfilename = options[:filename].sub(/\.[^.]+$/, ".#{file_extension}")
         if ext == :rxl
           options[:relaton] = outfilename
           relaton_export(isodoc, options)
         else
-          @processor.output(isodoc, outfilename, ext, isodoc_options)
-        end
-        if options[:wrapper] and /html$/.match file_extension
-          outfilename = outfilename.sub(/\.html$/, "")
-          FileUtils.mkdir_p outfilename
-          FileUtils.mv "#{outfilename}.html", outfilename
-          FileUtils.mv "#{outfilename}_images", outfilename, force: true
+          begin
+            #require "byebug"; byebug
+            @processor.use_presentation_xml(ext) ?
+              @processor.output(nil, presentationxml_name, outfilename, ext, isodoc_options) :
+              @processor.output(isodoc, xml_name, outfilename, ext, isodoc_options)
+          rescue StandardError => e  
+            puts e.message
+          end
         end
+        wrap_html(options, file_extension, outfilename)
       end
     end
   end

data/lib/metanorma/input/asciidoc.rb

@@ -34,6 +34,10 @@ module Metanorma
         }.reject { |_, val| val.nil? }
       end
 
+      def empty_attr(attr, name)
+        attr&.sub(/^#{name}:\s*$/, "#{name}: true")&.sub(/^#{name}:\s+/, "")
+      end
+
       def extract_options(file)
         headerextract = file.sub(/\n\n.*$/m, "\n")
 
@@ -58,8 +62,16 @@ module Metanorma
         /\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:(?<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
+
+        defined?(hierarchical_assets) and
+          hierarchical_assets = empty_attr(hierarchical_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,
@@ -84,6 +96,7 @@ module Metanorma
           doctoclevels: defined?(doctoclevels) ? doctoclevels : nil,
           hierarchical_assets: defined?(hierarchical_assets) ? hierarchical_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? }
       end
 

data/lib/metanorma/output.rb

@@ -1,5 +1,6 @@
 require_relative "./output/base"
 require_relative "./output/pdf"
+require_relative "./output/xslfo"
 
 module Metanorma
   module Output

data/lib/metanorma/output/pdf.rb

@@ -1,4 +1,5 @@
 require "open3"
+require_relative "./utils.rb"
 require "pathname"
 require "shellwords"
 
@@ -7,9 +8,7 @@ module Metanorma
     class Pdf < Base
 
       def convert(url_path, output_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
+        file_url = Utils::file_path(url_path)
         pdfjs = File.join(File.dirname(__FILE__), "../../../bin/metanorma-pdf.js")
 
         node_path = ENV["NODE_PATH"] || `npm root --quiet -g`.strip

data/lib/metanorma/output/utils.rb

@@ -0,0 +1,16 @@
+require "pathname"
+
+module Metanorma
+  module Output
+    module Utils
+      class << self
+        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
+          file_url
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/output/xslfo.rb

@@ -0,0 +1,15 @@
+require 'mn2pdf'
+require_relative "./utils.rb"
+
+module Metanorma
+  module Output
+    class XslfoPdf < Base
+      def convert(url_path, output_path, xsl_stylesheet)
+        return if url_path.nil? || output_path.nil? || xsl_stylesheet.nil?
+
+        Mn2pdf.convert(url_path, output_path, xsl_stylesheet)
+      end
+    end
+  end
+end
+

data/lib/metanorma/processor.rb

@@ -15,6 +15,7 @@ module Metanorma
     def output_formats
       {
         xml: "xml",
+        presentation: "presentation.xml",
         rxl: "rxl"
       }
     end
@@ -23,7 +24,15 @@ module Metanorma
       raise "This is an abstract class!"
     end
 
-    def output(isodoc_node, outname, format, options={})
+    def use_presentation_xml(ext)
+      case ext
+      when :html, :doc, :pdf then true
+      else
+        false
+      end
+    end
+
+    def output(isodoc_node, inname, outname, format, options={})
       File.open(outname, "w:UTF-8") { |f| f.write(isodoc_node) }
     end
 

data/lib/metanorma/registry.rb

@@ -48,7 +48,7 @@ module Metanorma
       @processors.inject({}) do |acc, (k,v)|
         if v.asciidoctor_backend
           x = Asciidoctor.load nil, {backend: v.asciidoctor_backend}
-          acc[k] = x.converter.class::XML_ROOT_TAG
+          acc[k] = x.converter.xml_root_tag
         end
         acc
       end

data/lib/metanorma/version.rb

@@ -1,3 +1,3 @@
 module Metanorma
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/metanorma.gemspec

@@ -26,11 +26,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'asciidoctor'
   spec.add_runtime_dependency 'htmlentities'
   spec.add_runtime_dependency 'nokogiri'
+  spec.add_runtime_dependency 'mn2pdf', "~> 1"
 
   spec.add_development_dependency "rake", "~> 12.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.3"
+  spec.add_development_dependency "metanorma-iso", "~> 1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mn2pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 description: Library to process any Metanorma standard.
 email:
 - open.source@ribose.com
@@ -177,6 +191,8 @@ files:
 - lib/metanorma/output.rb
 - lib/metanorma/output/base.rb
 - lib/metanorma/output/pdf.rb
+- lib/metanorma/output/utils.rb
+- lib/metanorma/output/xslfo.rb
 - lib/metanorma/processor.rb
 - lib/metanorma/registry.rb
 - lib/metanorma/util.rb
@@ -186,7 +202,7 @@ homepage: https://github.com/metanorma/metanorma
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -201,9 +217,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Metanorma is the standard of standards; the metanorma gem allows you to create
   any standard document type supported by Metanorma.