isodoc 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14a2b122e4618bfd1d6ef74231405ad9b28d18bb7a8b812df2381c65f3443ca9
-  data.tar.gz: 47ee8c2b1bc90444256371e188ffec407ca79facafe199684ac8693c1254dd80
+  metadata.gz: 271b0b210ccc7da3e9b0a09cf49fb248ff4708fd4f92adfb5529683db655fe63
+  data.tar.gz: 4345484709eba0f0ac06dc772fd62455c0f601c2f36c57b0ae1d8fdade47dbdd
 SHA512:
-  metadata.gz: a6d74be6c585040de05deb7aeb5d92ec39651dc5a77f4f210479b77ef9cbb6fb82013ac87dfa77863853132b4026c3946039e79e51aad691243ca8fbfa86c5cf
-  data.tar.gz: '010093e4801400b6308c204cdd9745944def9a405b98934f57f16529e0cd1272cdcaf03ef85befe4acb91392d694161af5a38ea35d67dffeeda2ccede0ea1298'
+  metadata.gz: 80a4d6a127130129671f6553283d7a09b2afb8f69756435cc5e20381309a92b5edd055eda730b10cf025fa6bb5169db65e38cff64cdfbf9d0dc20de415fe1f20
+  data.tar.gz: b90a49e79bf3b1d03c15adfcaed42b2e64293ab161b6e585448487db29e40129f8994da57d8429130c54bc66dc73640f5ca929d285c7d3528e44b341150ca2b5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    isodoc (0.9.0)
+    isodoc (0.9.1)
       asciimath
       html2doc (~> 0.8.1)
       htmlentities (~> 4.3.4)
@@ -60,7 +60,7 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
-    metanorma (0.2.8)
+    metanorma (0.2.9)
     method_source (0.9.0)
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
@@ -98,7 +98,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.58.2)
+    rubocop (0.59.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)

data/README.adoc

@@ -32,6 +32,7 @@ wordcoverpage:: Cover page for Word output
 wordintropage:: Introductory page for Word output
 ulstyle:: Style identifier in Word stylesheet for unordered lists
 olstyle:: Style identifier in Word stylesheet for ordered list
+suppressheadingnumbers:: Suppress heading numbers for clauses (does not apply to annexes)
 
 The IsoDoc gem classes themselves are abstract (though their current implementation contains rendering specific to the ISO standard.) Subclasses of the Isodoc gem classes are specific to different standards, and are associated with templates and stylesheets speciific to the rendering of those standards. Subclasses also provide the default values for the rendering parameters above; they should be used only as overrides.
 

data/lib/isodoc/convert.rb

@@ -19,6 +19,10 @@ module IsoDoc
     # bodyfont: font to use for body text
     # headerfont: font to use for header text
     # monospace: font to use for monospace text
+    # suppressheadingnumbers: suppress heading numbers for clauses
+    # scripts: Scripts file for HTML
+    # scripts_pdf: Scripts file for PDF
+    # datauriimage: Encode images in HTML output as data URIs
     def initialize(options)
       @libdir = File.dirname(__FILE__) unless @libdir
       options.merge!(default_fonts(options)) { |_, old, new| old || new }.
@@ -38,6 +42,8 @@ module IsoDoc
       @i18nyaml = options[:i18nyaml]
       @ulstyle = options[:ulstyle]
       @olstyle = options[:olstyle]
+      @datauriimage = options[:datauriimage]
+      @suppressheadingnumbers = options[:suppressheadingnumbers]
       @termdomain = ""
       @termexample = false
       @note = false

data/lib/isodoc/function/section.rb

@@ -5,10 +5,9 @@ module IsoDoc::Function
       out.span **{ class: "zzMoveToFollowing" } do |s|
         s.b do |b|
           if get_anchors[node['id']][:label]
-            b << "#{get_anchors[node['id']][:label]}. #{title} "
-          else
-            b << "#{title} "
+            b << "#{get_anchors[node['id']][:label]}. " unless @suppressheadingnumbers
           end
+          b << "#{title} "
         end
       end
     end
@@ -19,7 +18,7 @@ module IsoDoc::Function
       else
         div.send "h#{get_anchors[node['id']][:level]}" do |h|
           lbl = get_anchors[node['id']][:label]
-          h << "#{lbl}. " if lbl
+          h << "#{lbl}. " if lbl && !@suppressheadingnumbers
           c1&.children&.each { |c2| parse(c2, h) }
         end
       end
@@ -37,7 +36,7 @@ module IsoDoc::Function
     def clause_name(num, title, div, header_class)
       header_class = {} if header_class.nil?
       div.h1 **attr_code(header_class) do |h1|
-        if num
+        if num && !@suppressheadingnumbers
           h1 << "#{num}."
           insert_tab(h1, 1)
         end
@@ -114,7 +113,6 @@ module IsoDoc::Function
     end
 
     def term_defs_boilerplate_cont(src, term)
-      #sources = sentence_join(src.map { |s| @anchors[s["bibitemid"]][:xref] })
       sources = sentence_join(src.map { |s| @anchors.dig(s["bibitemid"], :xref) })
       if src.empty? then @internal_terms_boilerplate
       elsif term.nil? then external_terms_boilerplate(sources)

data/lib/isodoc/html_function/html.rb

@@ -1,4 +1,5 @@
 require "fileutils"
+require "base64"
 
 module IsoDoc::HtmlFunction
   module Html
@@ -195,15 +196,23 @@ module IsoDoc::HtmlFunction
       system "rm -r #{tmpimagedir}; mkdir #{tmpimagedir}"
       docxml.xpath("//*[local-name() = 'img']").each do |i|
         next if /^data:image/.match i["src"]
-        matched = /\.(?<suffix>\S+)$/.match i["src"]
-        uuid = UUIDTools::UUID.random_create.to_s
-        new_full_filename = File.join(tmpimagedir, "#{uuid}.#{matched[:suffix]}")
-        move_image1(i, new_full_filename)
+        @datauriimage ? datauri(i) : move_image1(i)
       end
       docxml
     end
 
-    def move_image1(i, new_full_filename)
+    def datauri(i)
+      type = i["src"].split(".")[-1]
+      #bin = open(i["src"]).read(encoding: "utf-8")
+      bin = File.read(i["src"], encoding: "utf-8")
+      data = Base64.strict_encode64(bin)
+      i["src"] = "data:image/#{type};base64,#{data}"
+    end
+
+    def move_image1(i)
+      matched = /\.(?<suffix>\S+)$/.match i["src"]
+      uuid = UUIDTools::UUID.random_create.to_s
+      new_full_filename = File.join(tmpimagedir, "#{uuid}.#{matched[:suffix]}")
       FileUtils.cp i["src"], new_full_filename
       i["src"] = new_full_filename
       i["width"], i["height"] = Html2Doc.image_resize(i, @maxheight, @maxwidth)

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "0.9.1".freeze
+  VERSION = "0.9.2".freeze
 end

data/spec/isodoc/postproc_spec.rb

@@ -501,6 +501,36 @@ CkZJTEVOQU1FOiB0ZXN0Cgo=
 
   end
 
+  it "encodes images in HTML as data URIs" do
+    system "rm -f test.html"
+    system "rm -rf test_images"
+    IsoDoc::HtmlConvert.new({htmlstylesheet: "spec/assets/html.css", datauriimage: true}).convert("test", <<~"INPUT", false)
+        <iso-standard xmlns="http://riboseinc.com/isoxml">
+        <preface><foreword>
+         <figure id="_">
+         <name>Split-it-right sample divider</name>
+                  <image src="spec/assets/rice_image1.png" id="_" imagetype="PNG"/>
+       </figure>
+       </foreword></preface>
+        </iso-standard>
+    INPUT
+    html = File.read("test.html").sub(/^.*<main class="main-section">/m, '<main class="main-section">').
+      sub(%r{</main>.*$}m, "</main>")
+    expect(html.gsub(%r{src="data:image/png;base64,[^"]+"}, %{src="data:image/png;base64,_"})).to be_equivalent_to <<~"OUTPUT"
+           <main class="main-section"><button onclick="topFunction()" id="myBtn" title="Go to top">Top</button>
+             <br />
+             <div>
+               <h1 class="ForewordTitle">Foreword</h1>
+               <div id="_" class="figure">
+               <img src="data:image/png;base64,_" height="auto" width="auto" />
+       <p class="FigureTitle" align="center">Figure 1&#xA0;&#x2014; Split-it-right sample divider</p></div>
+             </div>
+             <p class="zzSTDTitle1"></p>
+           </main>
+    OUTPUT
+
+  end
+
   it "processes IsoXML terms for HTML" do
     system "rm -f test.doc"
     system "rm -f test.html"

data/spec/isodoc/section_spec.rb

@@ -315,6 +315,155 @@ OUTPUT
 OUTPUT
   end
 
+    it "processes section names suppressing section numbering" do
+    expect(IsoDoc::HtmlConvert.new({suppressheadingnumbers: true}).convert("test", <<~"INPUT", true)).to be_equivalent_to <<~"OUTPUT"
+      <iso-standard xmlns="http://riboseinc.com/isoxml">
+      <preface>
+      <foreword obligation="informative">
+         <title>Foreword</title>
+         <p id="A">This is a preamble</p>
+       </foreword>
+        <introduction id="B" obligation="informative"><title>Introduction</title><clause id="C" inline-header="false" obligation="informative">
+         <title>Introduction Subsection</title>
+       </clause>
+       </introduction></preface><sections>
+       <clause id="D" obligation="normative">
+         <title>Scope</title>
+         <p id="E">Text</p>
+       </clause>
+
+       <clause id="H" obligation="normative"><title>Terms, Definitions, Symbols and Abbreviated Terms</title><terms id="I" obligation="normative">
+         <title>Normal Terms</title>
+         <term id="J">
+         <preferred>Term2</preferred>
+       </term>
+       </terms>
+       <definitions id="K">
+         <dl>
+         <dt>Symbol</dt>
+         <dd>Definition</dd>
+         </dl>
+       </definitions>
+       </clause>
+       <definitions id="L">
+         <dl>
+         <dt>Symbol</dt>
+         <dd>Definition</dd>
+         </dl>
+       </definitions>
+       <clause id="M" inline-header="false" obligation="normative"><title>Clause 4</title><clause id="N" inline-header="false" obligation="normative">
+         <title>Introduction</title>
+       </clause>
+       <clause id="O" inline-header="false" obligation="normative">
+         <title>Clause 4.2</title>
+       </clause>
+       <clause id="O1" inline-header="false" obligation="normative">
+       </clause>
+        </clause>
+
+       </sections><annex id="P" inline-header="false" obligation="normative">
+         <title>Annex</title>
+         <clause id="Q" inline-header="false" obligation="normative">
+         <title>Annex A.1</title>
+         <clause id="Q1" inline-header="false" obligation="normative">
+         <title>Annex A.1a</title>
+         </clause>
+       </clause>
+       </annex><bibliography><references id="R" obligation="informative">
+         <title>Normative References</title>
+       </references><clause id="S" obligation="informative">
+         <title>Bibliography</title>
+         <references id="T" obligation="informative">
+         <title>Bibliography Subsection</title>
+       </references>
+       </clause>
+       </bibliography>
+       </iso-standard>
+    INPUT
+    #{HTML_HDR}
+              <br/>
+             <div>
+               <h1 class="ForewordTitle">Foreword</h1>
+               <p id="A">This is a preamble</p>
+             </div>
+             <br/>
+             <div class="Section3" id="B">
+               <h1 class="IntroTitle">Introduction</h1>
+               <div id="C"><h2>Introduction Subsection</h2>
+
+        </div>
+             </div>
+             <p class="zzSTDTitle1"/>
+             <div id="D">
+               <h1>Scope</h1>
+               <p id="E">Text</p>
+             </div>
+             <div>
+               <h1>Normative references</h1>
+               <p>There are no normative references in this document.</p>
+             </div>
+             <div id="H"><h1>Terms, definitions, symbols and abbreviated terms</h1><p>For the purposes of this document,
+           the following terms and definitions apply.</p>
+       <p>ISO and IEC maintain terminological databases for use in
+       standardization at the following addresses:</p>
+
+       <ul>
+       <li> <p>ISO Online browsing platform: available at
+         <a href="http://www.iso.org/obp">http://www.iso.org/obp</a></p> </li>
+       <li> <p>IEC Electropedia: available at
+         <a href="http://www.electropedia.org">http://www.electropedia.org</a>
+       </p> </li> </ul>
+       <div id="I"><h2>Normal Terms</h2>
+
+          <p class="TermNum" id="J">3.1.1</p>
+          <p class="Terms" style="text-align:left;">Term2</p>
+
+        </div><div id="K"><h2>Symbols and abbreviated terms</h2>
+          <dl><dt><p>Symbol</p></dt><dd>Definition</dd></dl>
+        </div></div>
+             <div id="L" class="Symbols">
+               <h1>Symbols and abbreviated terms</h1>
+               <dl>
+                 <dt>
+                   <p>Symbol</p>
+                 </dt>
+                 <dd>Definition</dd>
+               </dl>
+             </div>
+             <div id="M">
+               <h1>Clause 4</h1>
+               <div id="N"><h2>Introduction</h2>
+
+        </div>
+               <div id="O"><h2>Clause 4.2</h2>
+
+        </div>
+               <div id="O1"><h2/>
+        </div>
+             </div>
+             <br/>
+             <div id="P" class="Section3">
+               <h1 class="Annex"><b>Annex A</b><br/>(normative)<br/><br/><b>Annex</b></h1>
+               <div id="Q"><h2>Annex A.1</h2>
+
+          <div id="Q1"><h3>Annex A.1a</h3>
+
+          </div>
+        </div>
+             </div>
+             <br/>
+             <div>
+               <h1 class="Section3">Bibliography</h1>
+               <div>
+                 <h2 class="Section3">Bibliography Subsection</h2>
+               </div>
+             </div>
+           </div>
+         </body>
+       </html>
+OUTPUT
+    end
+
   it "processes simple terms & definitions" do
         expect(IsoDoc::HtmlConvert.new({}).convert("test", <<~"INPUT", true)).to be_equivalent_to <<~"OUTPUT"
                <iso-standard xmlns="http://riboseinc.com/isoxml">
@@ -364,7 +513,6 @@ OUTPUT
 INPUT
 end
 
-
   it "processes terms & definitions with external source" do
         expect(IsoDoc::HtmlConvert.new({}).convert("test", <<~"INPUT", true)).to be_equivalent_to <<~"OUTPUT"
                <iso-standard xmlns="http://riboseinc.com/isoxml">
@@ -528,6 +676,37 @@ end
 OUTPUT
     end
 
+        it "processes inline section headers with suppressed heading numbering" do
+    expect(IsoDoc::HtmlConvert.new({suppressheadingnumbers: true}).convert("test", <<~"INPUT", true)).to be_equivalent_to <<~"OUTPUT"
+      <iso-standard xmlns="http://riboseinc.com/isoxml">
+      <sections>
+       <clause id="M" inline-header="false" obligation="normative"><title>Clause 4</title><clause id="N" inline-header="false" obligation="normative">
+         <title>Introduction</title>
+       </clause>
+       <clause id="O" inline-header="true" obligation="normative">
+         <title>Clause 4.2</title>
+       </clause></clause>
+
+       </sections>
+      </iso-standard>
+    INPUT
+    #{HTML_HDR}
+               <p class="zzSTDTitle1"/>
+               <div id="M">
+                 <h1>Clause 4</h1>
+                 <div id="N">
+          <h2>Introduction</h2>
+        </div>
+                 <div id="O">
+          <span class="zzMoveToFollowing"><b>Clause 4.2 </b></span>
+        </div>
+               </div>
+             </div>
+           </body>
+       </html>
+OUTPUT
+    end
+
         it "processes sections without titles" do
     expect(IsoDoc::HtmlConvert.new({}).convert("test", <<~"INPUT", true)).to be_equivalent_to <<~"OUTPUT"
       <iso-standard xmlns="http://riboseinc.com/isoxml">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-15 00:00:00.000000000 Z
+date: 2018-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciimath