asciidoctor-iso 0.9.9 → 0.10.0

data/lib/isodoc/iso/html_convert.rb

@@ -0,0 +1,136 @@
+require "isodoc"
+require_relative "metadata"
+
+module IsoDoc
+  module Iso
+    class HtmlConvert < IsoDoc::HtmlConvert
+
+      def default_fonts(options)
+        b = options[:bodyfont] ||
+          (options[:script] == "Hans" ? '"SimSun",serif' :
+           '"Cambria",serif')
+        h = options[:headerfont] ||
+          (options[:script] == "Hans" ? '"SimHei",sans-serif' :
+           '"Cambria",serif')
+        m = options[:monospacefont] || '"Courier New",monospace'
+        "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
+      end
+
+      def alt_fonts(options)
+        b = options[:bodyfont] ||
+          (options[:script] == "Hans" ? '"SimSun",serif' :
+           '"Lato",sans-serif')
+        h = options[:headerfont] ||
+          (options[:script] == "Hans" ? '"SimHei",sans-serif' :
+           '"Lato",sans-serif')
+        m = options[:monospacefont] || '"Space Mono",monospace'
+        "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
+      end
+
+      def html_doc_path(file)
+        File.join(File.dirname(__FILE__), File.join("html", file))
+      end
+
+      def metadata_init(lang, script, labels)
+        @meta = Metadata.new(lang, script, labels)
+      end
+
+      def initialize(options)
+        super
+        if options[:alt]
+          css = generate_css(html_doc_path("style-human.scss"), true, alt_fonts(options))
+        else
+          css = generate_css(html_doc_path("style-iso.scss"), true, default_fonts(options))
+        end
+        @htmlstylesheet = css
+        @htmlcoverpage = html_doc_path("html_iso_titlepage.html")
+        @htmlintropage = html_doc_path("html_iso_intro.html")
+        @scripts = html_doc_path("scripts.html")
+      end
+
+      def implicit_reference(b)
+        isocode = b.at(ns("./docidentifier")).text
+        isocode == "IEV"
+      end
+
+      def introduction(isoxml, out)
+        f = isoxml.at(ns("//introduction")) || return
+        num = f.at(ns(".//clause")) ? "0" : nil
+        title_attr = { class: "IntroTitle" }
+        page_break(out)
+        out.div **{ class: "Section3", id: f["id"] } do |div|
+          # div.h1 "Introduction", **attr_code(title_attr)
+          clause_name(num, @introduction_lbl, div, title_attr)
+          f.elements.each do |e|
+            if e.name == "patent-notice"
+              e.elements.each { |e1| parse(e1, div) }
+            else
+              parse(e, div) unless e.name == "title"
+            end
+          end
+        end
+      end
+
+      def foreword(isoxml, out)
+        f = isoxml.at(ns("//foreword")) || return
+        page_break(out)
+        out.div **attr_code(id: f["id"]) do |s|
+          s.h1(**{ class: "ForewordTitle" }) { |h1| h1 << @foreword_lbl }
+          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        end
+      end
+
+      def initial_anchor_names(d)
+        super
+        introduction_names(d.at(ns("//introduction")))
+      end
+
+      # we can reference 0-number clauses in introduction
+      def introduction_names(clause)
+        return if clause.nil?
+        clause.xpath(ns("./clause")).each_with_index do |c, i|
+          section_names1(c, "0.#{i + 1}", 2)
+        end
+      end
+
+      # terms not defined in standoc
+      def error_parse(node, out)
+        case node.name
+        when "appendix" then clause_parse(node, out)
+        else
+          super
+        end
+      end
+
+      def annex_names(clause, num)
+        appendix_names(clause, num)
+        super
+      end
+
+      def appendix_names(clause, num)
+        clause.xpath(ns("./appendix")).each_with_index do |c, i|
+          @anchors[c["id"]] = anchor_struct(i + 1, nil, @appendix_lbl)
+          @anchors[c["id"]][:level] = 2
+          @anchors[c["id"]][:container] = clause["id"]
+        end
+      end
+
+      def section_names1(clause, num, level)
+        @anchors[clause["id"]] =
+          { label: num, level: level, xref: num }
+        # subclauses are not prefixed with "Clause"
+        clause.xpath(ns("./clause | ./terms | ./term | ./definitions")).
+          each_with_index do |c, i|
+          section_names1(c, "#{num}.#{i + 1}", level + 1)
+        end
+      end
+
+      def annex_names1(clause, num, level)
+        @anchors[clause["id"]] = { label: num, xref: num, level: level }
+        clause.xpath(ns(".//clause")).each_with_index do |c, i|
+          annex_names1(c, "#{num}.#{i + 1}", level + 1)
+        end
+      end
+    end
+  end
+end

data/lib/isodoc/iso/metadata.rb

@@ -0,0 +1,107 @@
+require "isodoc"
+
+module IsoDoc
+  module Iso
+    class  Metadata < IsoDoc::Metadata
+      def initialize(lang, script, labels)
+        super
+      end
+
+      STAGE_ABBRS = {
+        "00": "PWI",
+        "10": "NWIP",
+        "20": "WD",
+        "30": "CD",
+        "40": "DIS",
+        "50": "FDIS",
+        "60": "IS",
+        "90": "(Review)",
+        "95": "(Withdrawal)",
+      }.freeze
+
+      def stage_abbrev(stage, iter, draft)
+        stage = STAGE_ABBRS[stage.to_sym] || "??"
+        stage += iter.text if iter
+        stage = "Pre" + stage if draft&.text =~ /^0\./
+        stage
+      end
+
+      def docstatus(isoxml, _out)
+        docstatus = isoxml.at(ns("//status/stage"))
+        if docstatus
+          set(:stage, docstatus.text)
+          set(:stage_int, docstatus.text.to_i)
+          abbr = stage_abbrev(docstatus.text, isoxml.at(ns("//status/iteration")),
+                              isoxml.at(ns("//version/draft")))
+          set(:stageabbr, abbr)
+        end
+      end
+
+      def docid(isoxml, _out)
+        dn = docnumber(isoxml)
+        docstatus = get[:stage]
+        if docstatus
+          abbr = get[:stageabbr]
+          docstatus = get[:stage]
+          (docstatus.to_i < 60) && dn = abbr + " " + dn
+        end
+        set(:docnumber, dn)
+      end
+
+      # we don't leave this to i18n.rb, because we have both English and
+      # French titles in the same document
+      def part_label(lang)
+        case lang
+        when "en" then "Part"
+        when "fr" then "Partie"
+        end
+      end
+
+      def part_title(part, partnum, subpartnum, lang)
+        return "" unless part
+        suffix = @c.encode(part.text, :hexadecimal)
+        partnum = "#{partnum}&ndash;#{subpartnum}" if partnum && subpartnum
+        suffix = "#{part_label(lang)}&nbsp;#{partnum}: " + suffix if partnum
+        suffix
+      end
+
+      def compose_title(main, intro, part, partnum, subpartnum, lang)
+        main = main.nil? ? "" : @c.encode(main.text, :hexadecimal)
+        intro &&
+          main = "#{@c.encode(intro.text, :hexadecimal)}&nbsp;&mdash; #{main}"
+        if part
+          suffix = part_title(part, partnum, subpartnum, lang)
+          main = "#{main}&nbsp;&mdash; #{suffix}"
+        end
+        main
+      end
+
+      def title(isoxml, _out)
+        intro = isoxml.at(ns("//title-intro[@language='en']"))
+        main = isoxml.at(ns("//title-main[@language='en']"))
+        part = isoxml.at(ns("//title-part[@language='en']"))
+        partnumber = isoxml.at(ns("//project-number/@part"))
+        subpartnumber = isoxml.at(ns("//project-number/@subpart"))
+
+        set(:doctitlemain, @c.encode(main ? main.text : "", :hexadecimal))
+        main = compose_title(main, intro, part, partnumber, subpartnumber, "en")
+        set(:doctitle, main)
+        set(:doctitleintro, @c.encode(intro ? intro.text : "", :hexadecimal)) if intro
+        set(:doctitlepart, part_title(part, partnumber, subpartnumber, "en"))
+      end
+
+      def subtitle(isoxml, _out)
+        intro = isoxml.at(ns("//title-intro[@language='fr']"))
+        main = isoxml.at(ns("//title-main[@language='fr']"))
+        part = isoxml.at(ns("//title-part[@language='fr']"))
+        partnumber = isoxml.at(ns("//project-number/@part"))
+        subpartnumber = isoxml.at(ns("//project-number/@subpart"))
+        set(:docsubtitlemain, @c.encode(main ? main.text : "", :hexadecimal))
+        main = compose_title(main, intro, part, partnumber, subpartnumber, "fr")
+        set(:docsubtitle, main)
+        set(:docsubtitleintro, @c.encode(intro ? intro.text : "", :hexadecimal)) if intro
+        set(:docsubtitlepart, part_title(part, partnumber, subpartnumber, "fr"))
+      end
+    end
+  end
+end

data/lib/isodoc/iso/word_convert.rb

@@ -0,0 +1,139 @@
+require "isodoc"
+require_relative "metadata"
+
+module IsoDoc
+  module Iso
+    class WordConvert < IsoDoc::WordConvert
+
+      def default_fonts(options)
+        b = options[:bodyfont] ||
+          (options[:script] == "Hans" ? '"SimSun",serif' :
+           '"Cambria",serif')
+        h = options[:headerfont] ||
+          (options[:script] == "Hans" ? '"SimHei",sans-serif' :
+           '"Cambria",serif')
+        m = options[:monospacefont] || '"Courier New",monospace'
+        "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
+      end
+
+      def html_doc_path(file)
+        File.join(File.dirname(__FILE__), File.join("html", file))
+      end
+
+      def initialize(options)
+        super
+        @wordstylesheet = generate_css(html_doc_path("wordstyle.scss"), false, default_fonts(options))
+        @standardstylesheet = generate_css(html_doc_path("isodoc.scss"), false, default_fonts(options))
+        @header = html_doc_path("header.html")
+        @wordcoverpage = html_doc_path("word_iso_titlepage.html")
+        @wordintropage = html_doc_path("word_iso_intro.html")
+        @ulstyle = "l3"
+        @olstyle = "l2"
+      end
+
+      def metadata_init(lang, script, labels)
+        @meta = Metadata.new(lang, script, labels)
+      end
+
+      def implicit_reference(b)
+        isocode = b.at(ns("./docidentifier")).text
+        isocode == "IEV"
+      end
+
+      def make_body(xml, docxml)
+        body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72" }
+        xml.body **body_attr do |body|
+          make_body1(body, docxml)
+          make_body2(body, docxml)
+          make_body3(body, docxml)
+          colophon(body, docxml)
+        end
+      end
+
+      def colophon(body, docxml)
+        body.br **{ clear: "all", style: "page-break-before:left;mso-break-type:section-break" }
+        body.div **{ class: "colophon" } do |div|
+        end
+      end
+
+      def introduction(isoxml, out)
+        f = isoxml.at(ns("//introduction")) || return
+        num = f.at(ns(".//clause")) ? "0" : nil
+        title_attr = { class: "IntroTitle" }
+        page_break(out)
+        out.div **{ class: "Section3", id: f["id"] } do |div|
+          # div.h1 "Introduction", **attr_code(title_attr)
+          clause_name(num, @introduction_lbl, div, title_attr)
+          f.elements.each do |e|
+            if e.name == "patent-notice"
+              e.elements.each { |e1| parse(e1, div) }
+            else
+              parse(e, div) unless e.name == "title"
+            end
+          end
+        end
+      end
+
+      def foreword(isoxml, out)
+        f = isoxml.at(ns("//foreword")) || return
+        page_break(out)
+        out.div **attr_code(id: f["id"]) do |s|
+          s.h1(**{ class: "ForewordTitle" }) { |h1| h1 << @foreword_lbl }
+          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        end
+      end
+
+      def initial_anchor_names(d)
+        super
+        introduction_names(d.at(ns("//introduction")))
+      end
+
+      # we can reference 0-number clauses in introduction
+      def introduction_names(clause)
+        return if clause.nil?
+        clause.xpath(ns("./clause")).each_with_index do |c, i|
+          section_names1(c, "0.#{i + 1}", 2)
+        end
+      end
+
+      # terms not defined in standoc
+      def error_parse(node, out)
+        case node.name
+        when "appendix" then clause_parse(node, out)
+        else
+          super
+        end
+      end
+
+      def annex_names(clause, num)
+        appendix_names(clause, num)
+        super
+      end
+
+      def appendix_names(clause, num)
+        clause.xpath(ns("./appendix")).each_with_index do |c, i|
+          @anchors[c["id"]] = anchor_struct(i + 1, nil, @appendix_lbl)
+          @anchors[c["id"]][:level] = 2
+          @anchors[c["id"]][:container] = clause["id"]
+        end
+      end
+
+      def section_names1(clause, num, level)
+        @anchors[clause["id"]] =
+          { label: num, level: level, xref: num }
+        # subclauses are not prefixed with "Clause"
+        clause.xpath(ns("./clause | ./terms | ./term | ./definitions")).
+          each_with_index do |c, i|
+          section_names1(c, "#{num}.#{i + 1}", level + 1)
+        end
+      end
+
+      def annex_names1(clause, num, level)
+        @anchors[clause["id"]] = { label: num, xref: num, level: level }
+        clause.xpath(ns(".//clause")).each_with_index do |c, i|
+          annex_names1(c, "#{num}.#{i + 1}", level + 1)
+        end
+      end
+    end
+  end
+end

data/spec/asciidoctor-iso/isobib_cache_spec.rb

@@ -45,7 +45,9 @@ EOS
 
   it "does not activate biblio caches if isobib disabled" do
     system "mv ~/.relaton-bib.pstore ~/.relaton-bib.pstore1"
+    system "mv ~/.iev.pstore ~/.iev.pstore1"
     system "rm -f test.relaton.pstore"
+    system "rm -f test.iev.pstore"
     Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
       #{ASCIIDOC_BLANK_HDR}
       [bibliography]
@@ -54,15 +56,21 @@ EOS
       * [[[iso123,ISO 123:2001]]] _Standard_
     INPUT
     expect(File.exist?("#{Dir.home}/.relaton-bib.pstore")).to be false
+    expect(File.exist?("#{Dir.home}/.iev.pstore")).to be false
     expect(File.exist?("test.relaton.pstore")).to be false
+    expect(File.exist?("test.iev.pstore")).to be false
 
     system "rm ~/.relaton-bib.pstore"
+    system "rm ~/.iev.pstore"
     system "mv ~/.relaton-bib.pstore1 ~/.relaton-bib.pstore"
+    system "mv ~/.iev.pstore1 ~/.iev.pstore"
   end
 
   it "does not activate biblio caches if isobib caching disabled" do
     system "mv ~/.relaton-bib.pstore ~/.relaton-bib.pstore1"
+    system "mv ~/.iev.pstore ~/.iev.pstore1"
     system "rm -f test.relaton.pstore"
+    system "rm -f test.iev.pstore"
     mock_isobib_get_123
     Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
       #{ISOBIB_BLANK_HDR}
@@ -72,18 +80,22 @@ EOS
       * [[[iso123,ISO 123:2001]]] _Standard_
     INPUT
     expect(File.exist?("#{Dir.home}/.relaton-bib.pstore")).to be false
+    expect(File.exist?("#{Dir.home}/.iev.pstore")).to be false
     expect(File.exist?("test.relaton.pstore")).to be false
+    expect(File.exist?("test.iev.pstore")).to be false
 
     system "rm ~/.relaton-bib.pstore"
+    system "rm ~/.iev.pstore"
     system "mv ~/.relaton-bib.pstore1 ~/.relaton-bib.pstore"
+    system "mv ~/.iev.pstore1 ~/.iev.pstore"
   end
 
   it "flushes biblio caches" do
     system "cp ~/.relaton-bib.pstore ~/.relaton-bib.pstore1"
+    system "cp ~/.iev.pstore ~/.iev.pstore1"
 
-    File.open("#{Dir.home}/.relaton-bib.pstore", "w") do |f|
-      f.write "XXX"
-    end
+    File.open("#{Dir.home}/.relaton-bib.pstore", "w") { |f| f.write "XXX" }
+    system "rm ~/.iev.pstore"
 
     mock_isobib_get_123
     Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
@@ -94,6 +106,7 @@ EOS
       * [[[iso123,ISO 123:2001]]] _Standard_
     INPUT
     expect(File.exist?("#{Dir.home}/.relaton-bib.pstore")).to be true
+    expect(File.exist?("#{Dir.home}/.iev.pstore")).to be true
 
     db = Relaton::Db.new "#{Dir.home}/.relaton-bib.pstore", nil
     entry = db.load_entry("ISO 123:2001")
@@ -101,10 +114,11 @@ EOS
     expect(entry["bib"].to_xml).to be_equivalent_to(ISOBIB_123_DATED)
 
     system "rm ~/.relaton-bib.pstore"
+    system "rm ~/.iev.pstore"
     system "mv ~/.relaton-bib.pstore1 ~/.relaton-bib.pstore"
+    system "mv ~/.iev.pstore1 ~/.iev.pstore"
   end
 
-
   it "activates global cache" do
     system "mv ~/.relaton-bib.pstore ~/.relaton-bib.pstore1"
     system "rm -f test.relaton.pstore"