metanorma 0.3.9 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8162aba3ac1d75ae0feca29816f033aa318b6ea07198414dca00faf7e1ab0ae2
-  data.tar.gz: 8ffcb1addda80439b364d9c8b502cec40e0ffa3a113b3fb744bc7354b915f5e0
+  metadata.gz: 557db569d4700a9cf6ace8a14b05a889ce6f87cea027b778812903719dfd8e18
+  data.tar.gz: 0b8bd009747c7da6c111ead0ab76c77debc3262f03d97ade6564779312d90fa0
 SHA512:
-  metadata.gz: cfcf0e8e9eab44f5838aa487fa1e0bcfc0551b3c2601ce40c8a4886a4946ac404e6fe62853939919fcc4c9003458e62014f3cbb9dc8d3ed205b18b984ed0072d
-  data.tar.gz: d4b10d194fd843cf1238442524e6cf41e0ad1486443bdb7e6706899badd835b5f571774db7f4376d0c49b9d75e4ab8f369e1eef80f55c6b6db6dace41fd7f331
+  metadata.gz: c430032f283fae4569805a7a0a539eadd393d1209f7e0ab00482e9a59ca2a3a84de5958b1d4bdd7fd96a5732941172d3d114443318a18e534ba3f8712d02cc00
+  data.tar.gz: e08907e2d2eb37b0938debf6233ceb3ac483fd10fc44e4c01e9eea36cb4a1a4f5edc56b0beb0804719332b0e6ad5e350c22c800855039e3e7862363f429f38ff

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    metanorma (0.3.8)
+    metanorma (0.3.10)
       asciidoctor
       htmlentities
 
@@ -17,7 +17,7 @@ GEM
     asciimath (1.0.8)
     byebug (10.0.2)
     cnccs (0.1.3)
-    concurrent-ruby (1.1.4)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
@@ -43,7 +43,7 @@ GEM
       iso-bib-item (~> 0.4.2)
     ietfbib (0.4.5)
       iso-bib-item (~> 0.4.2)
-    iev (0.2.0)
+    iev (0.2.1)
       nokogiri
     image_size (2.0.0)
     iso-bib-item (0.4.4)
@@ -69,22 +69,23 @@ GEM
       uuidtools
     isoics (0.1.7)
     json (2.2.0)
-    liquid (4.0.1)
-    metanorma-iso (1.1.2)
+    liquid (4.0.3)
+    metanorma-iso (1.1.4)
       asciidoctor (~> 1.5.7)
       iev (~> 0.2.0)
       isodoc (~> 0.9.8)
       metanorma-standoc (~> 1.1.0)
       ruby-jing
-    metanorma-standoc (1.1.3)
+    metanorma-standoc (1.1.5)
       asciidoctor (~> 1.5.7)
       concurrent-ruby
       html2doc (~> 0.8.0)
-      iev (~> 0.2.0)
+      iev (~> 0.2.1)
       isodoc (~> 0.9.0)
       relaton (~> 0.3.1)
       ruby-jing
       sterile (~> 1.0.14)
+      unicode2latex (~> 0.0.1)
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2018.0812)
@@ -98,7 +99,7 @@ GEM
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
-    relaton (0.3.1)
+    relaton (0.3.2)
       algoliasearch
       gbbib (~> 0.4.0)
       iecbib (~> 0.2.0)
@@ -141,6 +142,7 @@ GEM
     sterile (1.0.14)
       nokogiri
     thread_safe (0.3.6)
+    unicode2latex (0.0.2)
     uuidtools (2.1.5)
 
 PLATFORMS
@@ -152,8 +154,8 @@ DEPENDENCIES
   equivalent-xml (~> 0.6)
   isodoc (= 0.9.13)
   metanorma!
-  metanorma-iso (~> 1.1.0)
-  metanorma-standoc (~> 1.1.0)
+  metanorma-iso (~> 1.1.3)
+  metanorma-standoc (~> 1.1.4)
   rake (~> 12.0)
   rspec (~> 3.0)
   rspec-command (~> 1.0.3)

data/README.adoc

@@ -1,9 +1,9 @@
 = Metanorma: the standard for standards
 
 image:https://img.shields.io/gem/v/metanorma.svg["Gem Version", link="https://rubygems.org/gems/metanorma"]
-image:https://img.shields.io/travis/riboseinc/metanorma/master.svg["Build Status", link="https://travis-ci.org/riboseinc/metanorma"]
-image:https://codeclimate.com/github/riboseinc/metanorma/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/riboseinc/metanorma"]
-image:https://ci.appveyor.com/api/projects/status/t8irmy9iq4xf1ouy?svg=true["AppVeyor Build Status", link="https://ci.appveyor.com/project/ribose/metanorma"]
+image:https://img.shields.io/travis/metanorma/metanorma/master.svg["Build Status", link="https://travis-ci.org/metanorma/metanorma"]
+image:https://codeclimate.com/github/metanorma/metanorma/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma"]
+image:https://ci.appveyor.com/api/projects/status/t8irmy9iq4xf1ouy?svg=true["AppVeyor Build Status", link="https://ci.appveyor.com/project/metanorma/metanorma"]
 
 Metanorma is dedicated to harmonizing standard documents
 produced by different standard-setting bodies in a manner that
@@ -20,36 +20,36 @@ document model.
 
 Metanorma includes the following sub-projects:
 
-* The https://github.com/riboseinc/metanorma-model-standoc[Metanorma Standard Document model]
+* The https://github.com/metanorma/metanorma-model-standoc[Metanorma Standard Document model]
 
 * IETF Internet-Drafts and RFCs: the https://datatracker.ietf.org/doc/draft-ribose-asciirfc/[AsciiRFC syntax],
-the https://github.com/riboseinc/asciidoctor-rfc/[asciidoctor-rfc RFC XML v2 and v3 implementations]
+the https://github.com/metanorma/asciidoctor-rfc/[asciidoctor-rfc RFC XML v2 and v3 implementations]
 
 * ISO Standards: the AsciiISO syntax,
-the https://github.com/riboseinc/metanorma-model-iso/[Metanorma ISO model],
-the https://github.com/riboseinc/metanorma-iso/[metanorma-iso IsoDoc implementation]
+the https://github.com/metanorma/metanorma-model-iso/[Metanorma ISO model],
+the https://github.com/metanorma/metanorma-iso/[metanorma-iso IsoDoc implementation]
 
 * CalConnect Standard Documents (CSD): the AsciiCSD syntax,
-https://github.com/riboseinc/metanorma-model-csd[Metanorma CSD model],
-the https://github.com/riboseinc/metanorma-csd/[metanorma-csd implementation]
+https://github.com/metanorma/metanorma-model-csd[Metanorma CSD model],
+the https://github.com/metanorma/metanorma-csd/[metanorma-csd implementation]
 
 * Chinese GuoBiao (GB) Standards: the AsciiGB syntax,
-https://github.com/riboseinc/metanorma-model-gb[Metanorma GB models, for Chinese standards],
-the https://github.com/riboseinc/metanorma-gb/[metanorma-gb implementation]
+https://github.com/metanorma/metanorma-model-gb[Metanorma GB models, for Chinese standards],
+the https://github.com/metanorma/metanorma-gb/[metanorma-gb implementation]
 
 * Cloud Security Alliance Normal Documents (CSAND): the AsciiCSAND syntax,
-https://github.com/riboseinc/metanorma-model-csand[Metanorma CSAND model],
-the https://github.com/riboseinc/metanorma-csand/[metanorma-csand implementation]
+https://github.com/metanorma/metanorma-model-csand[Metanorma CSAND model],
+the https://github.com/metanorma/metanorma-csand/[metanorma-csand implementation]
 
 * M3AAWG Documents (M3D): the AsciiM3D syntax,
-https://github.com/riboseinc/metanorma-model-m3d[Metanorma M3D model],
-the https://github.com/riboseinc/metanorma-m3d/[metanorma-m3d implementation]
+https://github.com/metanorma/metanorma-model-m3d[Metanorma M3D model],
+the https://github.com/metanorma/metanorma-m3d/[metanorma-m3d implementation]
 
-* Ribose Specification Documents (RSD): AsciiRSD, RSD XML schema, and the https://github.com/riboseinc/metanorma-rsd[metanorma-rsd implementation]
+* Ribose Specification Documents (RSD): AsciiRSD, RSD XML schema, and the https://github.com/metanorma/metanorma-rsd[metanorma-rsd implementation]
 
-* Mandatory Provident Fund Schemes Authority of Hong Kong Documents (MPFD): https://github.com/riboseinc/metanorma-mpfd[metanorma-mpfd implementation] (still at proof-of-concept stage)
+* Mandatory Provident Fund Schemes Authority of Hong Kong Documents (MPFD): https://github.com/metanorma/metanorma-mpfd[metanorma-mpfd implementation] (still at proof-of-concept stage)
 
-* United Nations Economic Commision for Europe Documents (UNECE): https://github.com/riboseinc/metanorma-unece[metanorma-unece implementation]
+* United Nations Economic Commision for Europe Documents (UNECE): https://github.com/metanorma/metanorma-unece[metanorma-unece implementation]
 
 
 == Installation on supported platforms
@@ -58,7 +58,7 @@ the https://github.com/riboseinc/metanorma-m3d/[metanorma-m3d implementation]
 
 We recommend macOS users to directly run the Metanorma setup script
 located here:
-https://github.com/riboseinc/metanorma-macos-setup
+https://github.com/metanorma/metanorma-macos-setup
 
 This is a one-stop installation script that setups Ruby, Node
 and all necessary parts for running Metanorma.
@@ -67,13 +67,13 @@ Alternatively, you can also use the Metanorma Docker container (see below).
 
 === Linux
 
-Please see: https://github.com/riboseinc/metanorma-linux-setup
+Please see: https://github.com/metanorma/metanorma-linux-setup
 
 Alternatively, you can also use the Metanorma Docker container (see below).
 
 === Docker: Windows and other platforms
 
-Please use the Metanorma Docker container: https://github.com/riboseinc/metanorma-docker
+Please use the Metanorma Docker container: https://github.com/metanorma/metanorma-docker
 
 
 ////
@@ -137,15 +137,15 @@ Usage: metanorma [options] <file>
   }
   In addition, xml (outside of rfc2, rfc3) generates IsoDoc XML. If the argument is "all" or the option is
   missing, all available extensions are generated.
-  -f, --format FORMAT              Format of source file: asciidoc (current default, only format supported)
-  -r, --require LIBRARY            Require LIBRARY prior to execution
-  -w, --wrapper                    Create wrapper folder for HTML output
-  -d, --data-uri-image             Encode HTML output images as data URIs
-  -a, --asciimath                  Preserve AsciiMath in Metanorma XML, instead of transforming it into MathML
-  -R, --relaton FILENAME           Export Relaton XML (bibdata) for this document to FILENAME
+  -f, --format FORMAT                   Format of source file: asciidoc (current default, only format supported)
+  -r, --require LIBRARY                 Require LIBRARY prior to execution
+  -w, --wrapper                         Create wrapper folder for HTML output
+  -d, --data-uri-image                  Encode HTML output images as data URIs
+  -a, --asciimath                       Preserve AsciiMath in Metanorma XML, instead of transforming it into MathML
+  -R, --relaton FILENAME                Export Relaton XML (bibdata) for this document to FILENAME
       (Also triggered through -x rxl)
-  -S, --sourcecode DIR             Export sourcecode fragments from this document to directory DIR
-  -h, --help                       Show this message
+  -e, --extract DIR(,ASSET1,ASSET2...)  Extract assets from this document to directory DIR. If ASSET1,ASSET2 are named, only those types of asset are extracted.
+  -h, --help                            Show this message
 ----
 
 Basically it is used like this:
@@ -177,6 +177,15 @@ more straightforward.
 `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.
 
+`asciimath`:: Preserve AsciiMath in Metanorma XML, instead of transforming it into MathML (which is the default).
+
+`extract`:: export assets found in the document to the nominated directory. If no other arguments are given,
+then all asset classes are exported, each to its own subdirectory. If trailing arguments are given, they
+are taken as naming which asset classes to extract from the document. Three asset classes are recognised:
+`sourcecode`, `image`, and `requirement` (which includes `recommendation` and `permission` elements).
+The assets are given autonumbered names, unless they were given a `filename` attribute in the source
+Metanorma XML, which is used instead.
+
 `format`:: (optional, specified via `--format` or `-f`) only accepts `asciidoc` for now,
 defaults to `asciidoc`
 

data/lib/metanorma/compile.rb

@@ -16,7 +16,7 @@ module Metanorma
       extensions = get_extensions(options) or return nil
       (file, isodoc = process_input(filename, options)) or return nil
       relaton_export(isodoc, options)
-      sourcecode_export(isodoc, options[:sourcecode])
+      extract(isodoc, options[:extract], options[:extract_type])
       process_extensions(extensions, file, isodoc, options)
     end
 
@@ -126,13 +126,55 @@ module Metanorma
       HTMLEntities.new.decode(xml.children.to_xml)
     end
 
-    def sourcecode_export(isodoc, dirname)
+    def extract(isodoc, dirname, extract_types)
       return unless dirname
-      xml = Nokogiri::XML(isodoc)
+      if extract_types.nil? || extract_types.empty?
+        extract_types = [:sourcecode, :image, :requirement]
+      end
       FileUtils.rm_rf dirname
       FileUtils.mkdir_p dirname
+      xml = Nokogiri::XML(isodoc)
+      sourcecode_export(xml, dirname) if extract_types.include? :sourcecode
+      image_export(xml, dirname) if extract_types.include? :image
+      requirement_export(xml, dirname) if extract_types.include? :requirement
+    end
+
+    def sourcecode_export(xml, dirname)
+      xml.at("//sourcecode | //xmlns:sourcecode") or return
+      FileUtils.mkdir_p "#{dirname}/sourcecode"
       xml.xpath("//sourcecode | //xmlns:sourcecode").each_with_index do |s, i|
-        File.open("#{dirname}/#{i}", "w:UTF-8") { |f| f.write clean_sourcecode(s.dup) }
+        filename = s["filename"] || sprintf("sourcecode-%04d.txt", i)
+        File.open("#{dirname}/sourcecode/#{filename}", "w:UTF-8") do |f|
+          f.write clean_sourcecode(s.dup) 
+        end
+      end
+    end
+
+    def image_export(xml, dirname)
+      xml.at("//image | //xmlns:image") or return
+      FileUtils.mkdir_p "#{dirname}/image"
+      xml.xpath("//image | //xmlns:image").each_with_index do |s, i|
+        next unless /^data:image/.match s["src"]
+        %r{^data:image/(?<imgtype>[^;]+);base64,(?<imgdata>.+)$} =~ s["src"]
+        filename = s["filename"] || sprintf("image-%04d.%s", i, imgtype)
+        File.open("#{dirname}/image/#{filename}", "wb") do |f|
+          f.write(Base64.strict_decode64(imgdata))
+        end
+      end
+    end
+
+    REQUIREMENT_XPATH = "//requirement | //xmlns:requirement | "\
+      "//recommendation | //xmlns:recommendation | //permission | "\
+      "//xmlns:permission".freeze
+
+    def requirement_export(xml, dirname)
+      xml.at(REQUIREMENT_XPATH) or return
+      FileUtils.mkdir_p "#{dirname}/requirement"
+      xml.xpath(REQUIREMENT_XPATH).each_with_index do |s, i|
+        filename = s["filename"] || sprintf("%s-%04d.xml", s.name, i)
+        File.open("#{dirname}/requirement/#{filename}", "w:UTF-8") do |f|
+          f.write s
+        end
       end
     end
 

data/lib/metanorma/version.rb

@@ -1,3 +1,3 @@
 module Metanorma
-  VERSION = "0.3.9"
+  VERSION = "0.3.10"
 end

data/metanorma.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   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.homepage      = "https://github.com/riboseinc/metanorma"
+  spec.homepage      = "https://github.com/metanorma/metanorma"
   spec.license       = "BSD-2-Clause"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   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", "~> 1.1.0"
-  spec.add_development_dependency "metanorma-standoc", "~> 1.1.0"
+  spec.add_development_dependency "metanorma-iso", "~> 1.1.3"
+  spec.add_development_dependency "metanorma-standoc", "~> 1.1.4"
   spec.add_development_dependency "isodoc", "0.9.13"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.10
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-25 00:00:00.000000000 Z
+date: 2019-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -128,28 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.4
 - !ruby/object:Gem::Dependency
   name: isodoc
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +206,7 @@ files:
 - lib/metanorma/registry.rb
 - lib/metanorma/version.rb
 - metanorma.gemspec
-homepage: https://github.com/riboseinc/metanorma
+homepage: https://github.com/metanorma/metanorma
 licenses:
 - BSD-2-Clause
 metadata: {}