metanorma 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 719e0a648d4b04e1bef5f855cde357b517551d50b3a8a0abca2f8f2c340c253c
-  data.tar.gz: 3cd70ccdd980e869bc130b2ca88d524741624ab926e37988634e5c97674054bf
+  metadata.gz: cb15f89f287c512af20258dac7a165a493d10fd69918c72597e599caa693712d
+  data.tar.gz: f185683fe26b26c49d3aa47542b924836dd6e87c9d5bee38647c578078e232bd
 SHA512:
-  metadata.gz: 6fea024ec085822b3637df3cab6abae988c32988c783af52281ce4da1592104d6bebc6ec8f39940fd4c916e6ca295b03133cee8f2abbeec7561bf3de54c325b8
-  data.tar.gz: a4b52af8af72a734f36dd5d95d24ce4765f12c6fbdd577a787229ed9701e7b0a116a31f102d5e7851b03af537ae237e7fe16b56bb1aa179ca9f13b0501ad890d
+  metadata.gz: 4f2174db12ddf90334042c9804e35b53ff6195703187bd19d2d82ad204d1c66505e3421ac71d635a18491f1b08aaf3885c698b4c49d329c562a8422e4ea9bddf
+  data.tar.gz: d306825846bd6bcd187741eec4ac806214bf2979143f3cb325167483d9050c1f07823b9143f146e2980bca868c9631d2d23e52502e15a619e1b249d41b477484

data/Gemfile.lock

@@ -1,22 +1,109 @@
 PATH
   remote: .
   specs:
-    metanorma (0.3.4)
+    metanorma (0.3.5)
       asciidoctor
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    algoliasearch (1.24.0)
+      httpclient (~> 2.8, >= 2.8.3)
+      json (>= 1.5.1)
     asciidoctor (1.5.8)
+    asciimath (1.0.6)
     byebug (10.0.2)
+    cnccs (0.1.3)
+    concurrent-ruby (1.1.3)
     diff-lcs (1.3)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
+    ffi (1.9.25)
+    gb-agencies (0.0.5)
+    gbbib (0.4.3)
+      cnccs (~> 0.1.1)
+      gb-agencies (~> 0.0.1)
+      iso-bib-item (~> 0.4.2)
+    html2doc (0.8.6)
+      asciimath
+      htmlentities (~> 4.3.4)
+      image_size
+      mime-types
+      nokogiri
+      ruby-xslt
+      thread_safe
+      uuidtools
+    htmlentities (4.3.4)
+    httpclient (2.8.3)
+    iecbib (0.2.2)
+      addressable
+      iso-bib-item (~> 0.4.2)
+    ietfbib (0.4.5)
+      iso-bib-item (~> 0.4.2)
+    iev (0.2.0)
+      nokogiri
+    image_size (2.0.0)
+    iso-bib-item (0.4.4)
+      isoics (~> 0.1.6)
+      nokogiri (~> 1.8.4)
+      ruby_deep_clone (~> 0.8.0)
+    isobib (0.4.2)
+      algoliasearch
+      iecbib (~> 0.2.1)
+      iso-bib-item (~> 0.4.2)
+    isodoc (0.9.11)
+      asciimath
+      html2doc (~> 0.8.6)
+      htmlentities (~> 4.3.4)
+      liquid
+      metanorma (~> 0.3.0)
+      nokogiri
+      rake (~> 12.0)
+      roman-numerals
+      ruby-xslt
+      sassc (~> 1.12.1)
+      thread_safe
+      uuidtools
+    isoics (0.1.7)
+    json (2.1.0)
+    liquid (4.0.1)
+    metanorma-iso (1.0.11)
+      asciidoctor (~> 1.5.7)
+      iev (~> 0.2.0)
+      isodoc (~> 0.9.8)
+      metanorma-standoc (~> 1.0.0)
+      ruby-jing
+    metanorma-standoc (1.0.11)
+      asciidoctor (~> 1.5.7)
+      concurrent-ruby
+      iev (~> 0.2.0)
+      isodoc (~> 0.9.0)
+      relaton (~> 0.3.1)
+      ruby-jing
+      sterile
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
     mini_portile2 (2.3.0)
-    mixlib-shellout (2.4.0)
+    mixlib-shellout (2.4.2)
     nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
-    rake (10.5.0)
+    optout (0.0.2)
+    public_suffix (3.0.3)
+    rake (12.3.2)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    relaton (0.3.1)
+      algoliasearch
+      gbbib (~> 0.4.0)
+      iecbib (~> 0.2.0)
+      ietfbib (~> 0.4.2)
+      iso-bib-item (~> 0.4.2)
+      isobib (~> 0.4.0)
+    roman-numerals (0.3.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -37,6 +124,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    ruby-jing (0.0.1)
+      optout (>= 0.0.2)
+    ruby-xslt (0.9.10)
+    ruby_deep_clone (0.8.0)
+    sass (3.7.2)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    sassc (1.12.1)
+      ffi (~> 1.9.6)
+      sass (>= 3.3.0)
+    sterile (1.0.13)
+      nokogiri
+    thread_safe (0.3.6)
+    uuidtools (2.1.5)
 
 PLATFORMS
   ruby
@@ -45,8 +148,10 @@ DEPENDENCIES
   bundler (~> 1.16)
   byebug (~> 10.0)
   equivalent-xml (~> 0.6)
+  isodoc (= 0.9.11)
   metanorma!
-  rake (~> 10.0)
+  metanorma-iso
+  rake (~> 12.0)
   rspec (~> 3.0)
   rspec-command (~> 1.0.3)
 

data/README.adoc

@@ -168,6 +168,8 @@ HTML renderings (e.g. `html_alt` for ISO).
 the same as the output file, without the `.html` suffix. Used to make distribution of HTML outputs
 more straightforward.
 
+`datauriimage`:: Encode all images as data URIs.
+
 `relaton`:: exports the bibdata Relaton XML description of the document (which is part of its Metanorma XML)
 to the nominated directory. The filename is the document identifier, if present, else the document filename.
 
@@ -207,6 +209,25 @@ of document attributes `mn-document-class:` and `:mn-output-extensions:`, e.g.
 .Foreword
 ----
 
+Metanorma can also be invoked within Ruby, through the metanorma gem:
+
+[source,asciidoctor]
+----
+require "metanorma"
+
+Metanorma::Compile.new().compile(filename, options)
+----
+
+The options hash has the same structure it does when invoked in metanorma-cli:
+
+`:type`:: one of `"iso"`, `"csd"`, `"rsd"`, etc. (mandatory)
+`:format`:: `:asciidoc` is only value currently allowed
+`:extension_keys`:: array of symbols: `:all`, `:xml`:, `:doc` etc.
+`:wrapper`: true/false
+`:darauriimage`: true/false
+`:require`: array of libraries to require
+`:relaton`: exports the bibdata Relaton XML description of the document (which is part of its Metanorma XML)
+to the nominated directory
 
 == Origin of name
 

data/lib/metanorma/compile.rb

@@ -0,0 +1,129 @@
+require "fileutils"
+require "nokogiri"
+
+module Metanorma
+  class Compile
+    def initialize
+      @registry = Metanorma::Registry.instance
+    end
+
+    def compile(filename, 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)) or return nil
+      relaton_export(isodoc, options)
+      process_extensions(extensions, file, isodoc, options)
+    end
+
+    def require_libraries(options)
+      if options[:require]
+        options[:require].each do |r|
+          require r
+        end
+      end
+    end
+
+    def options_extract(filename, options)
+      o = Metanorma::Input::Asciidoc.new.extract_metanorma_options(File.read(filename, encoding: "utf-8"))
+      options[:type] ||= o[:type]&.to_sym
+      options[:extension_keys] ||= o[:extensions]&.split(/,[ ]*/)&.map(&:to_sym)
+      options[:extension_keys] = nil if options[:extension_keys] == [:all]
+      options[:format] ||= :asciidoc
+      options[:filename] = filename
+      options
+    end
+
+    def validate(options)
+      validate_type(options) && validate_format(options)
+    end
+
+    def validate_type(options)
+      unless options[:type]
+        puts "[metanorma] Error: Please specify a standard type: #{@registry.supported_backends}."
+        return nil
+      end
+      stdtype = options[:type].to_sym
+      unless @registry.supported_backends.include? stdtype
+        puts "[metanorma] Warning: #{stdtype} is not a default standard type."
+        puts "[metanorma] Info: Attempting to load `metanorma-#{stdtype}` gem for standard type `#{stdtype}`."
+      end
+      begin
+        require "metanorma-#{stdtype}"
+        puts "[metanorma] Info: gem `metanorma-#{stdtype}` loaded."
+      rescue LoadError
+        puts "[metanorma] Error: loading gem `metanorma-#{stdtype}` failed. Exiting."
+        return false
+      end
+      unless @registry.supported_backends.include? stdtype
+        puts "[metanorma] Error: The `metanorma-#{stdtype}` gem still doesn't support `#{stdtype}`. Exiting."
+        return false
+      end
+      true
+    end
+
+    def validate_format(options)
+      unless options[:format] == :asciidoc
+        puts "[metanorma] Error: Only source file format currently supported is 'asciidoc'."
+        return false
+      end
+      true
+    end
+
+    def get_extensions(options)
+      options[:extension_keys] ||= @processor.output_formats.inject([]) do |memo, (k, _)|
+        memo << k; memo
+      end
+      extensions = options[:extension_keys].inject([]) do |memo, e|
+        @processor.output_formats[e] and memo << e or
+          puts "[metanorma] Error: #{e} format is not supported for this standard."
+        memo
+      end
+      extensions
+    end
+
+    def process_input(filename)
+      case extname = File.extname(filename)
+      when ".adoc"
+        puts "[metanorma] Processing: Asciidoctor input."
+        file = File.read(filename, encoding: "utf-8")
+        [file, @processor.input_to_isodoc(file, filename)]
+      when ".xml"
+        puts "[metanorma] Processing: Metanorma XML input."
+        # TODO NN: this is a hack -- we should provide/bridge the
+        # document attributes in Metanorma XML
+        ["", File.read(filename, encoding: "utf-8")]
+      else
+        puts "[metanorma] Error: file extension #{extname} is not supported."
+        nil
+      end
+    end
+
+    def relaton_export(isodoc, options)
+      return unless options[:relaton]
+    xml = Nokogiri::XML(isodoc)
+    bibdata = xml.at("//bibdata") || xml.at("//xmlns:bibdata")
+    #docid = bibdata&.at("./xmlns:docidentifier")&.text || options[:filename]
+    #outname = docid.sub(/^\s+/, "").sub(/\s+$/, "").gsub(/\s+/, "-") + ".xml"
+    File.open(options[:relaton], "w:UTF-8") { |f| f.write bibdata.to_xml }
+    end
+
+    def process_extensions(extensions, file, isodoc, options)
+      extensions.each do |ext|
+        isodoc_options = @processor.extract_options(file)
+        isodoc_options[:datauriimage] = true if options[:datauriimage]
+        file_extension = @processor.output_formats[ext]
+        outfilename = options[:filename].sub(/\.[^.]+$/, ".#{file_extension}")
+        @processor.output(isodoc, outfilename, ext, isodoc_options)
+        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
+    end
+  end
+end

data/lib/metanorma/input/asciidoc.rb

@@ -46,7 +46,7 @@ module Metanorma
         /\n:wordintropage: (?<wordintropage>[^\n]+)\n/ =~ headerextract
         /\n:ulstyle: (?<ulstyle>[^\n]+)\n/ =~ headerextract
         /\n:olstyle: (?<olstyle>[^\n]+)\n/ =~ headerextract
-        /\n(?<datauriimage>:data-uri-image:[^\n]*)\n/ =~ headerextract
+        /\n:data-uri-image: (?<datauriimage>[^\n]+)\n/ =~ headerextract
         {
           script: defined?(script) ? script : nil,
           bodyfont: defined?(bodyfont) ? bodyfont : nil,
@@ -66,7 +66,7 @@ module Metanorma
           wordintropage: defined?(wordintropage) ? wordintropage : nil,
           ulstyle: defined?(ulstyle) ? ulstyle : nil,
           olstyle: defined?(olstyle) ? olstyle : nil,
-          datauriimage: defined?(datauriimage) ? true : nil,
+          datauriimage: defined?(datauriimage) ? datauriimage != "false" : nil,
         }.reject { |_, val| val.nil? }
       end
 

data/lib/metanorma/version.rb

@@ -1,3 +1,3 @@
 module Metanorma
-  VERSION = "0.3.4"
+  VERSION = "0.3.5"
 end

data/lib/metanorma.rb

@@ -5,6 +5,7 @@ require "metanorma/output"
 require "metanorma/registry"
 require "metanorma/processor"
 require "metanorma/asciidoctor_extensions"
+require "metanorma/compile"
 
 module Metanorma
 

data/metanorma.gemspec

@@ -27,9 +27,11 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'asciidoctor'
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  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.3"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
+  spec.add_development_dependency "metanorma-iso"
+  spec.add_development_dependency "isodoc", "0.9.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-08 00:00:00.000000000 Z
+date: 2018-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: metanorma-iso
+  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: isodoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.11
 description: Library to process any Metanorma standard.
 email:
 - open.source@ribose.com
@@ -138,6 +166,7 @@ files:
 - lib/metanorma.rb
 - lib/metanorma/asciidoctor_extensions.rb
 - lib/metanorma/asciidoctor_extensions/glob_include_processor.rb
+- lib/metanorma/compile.rb
 - lib/metanorma/document.rb
 - lib/metanorma/input.rb
 - lib/metanorma/input/asciidoc.rb