isodoc 1.2.7 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1a16a6af5cb8621eb1dd8e14a2680e7858476d5ffc1007e45566928e9ebaef7
-  data.tar.gz: ef5696d693f602b825457939bfab6f1ccfd827a9f24cbfa975ee6120c603b264
+  metadata.gz: 491a322b0df2e6b1c8b4f12e520ca349657a009058b416067acdd5437a16085c
+  data.tar.gz: 1f52844ffdc37875d2b40f8d46f52263abcbe5101c99adaf88d839a28a18ed49
 SHA512:
-  metadata.gz: f3f8718e404915ce3d9d7ad8de1b4f6c0eb6442c930ced3e05c6f1db25ee23324de1783c3fe96e41e86d765a705b7b41df78bd159ff1333f3809ed2682188cc6
-  data.tar.gz: 0ba52d047fb5b1119d1cf485eea60511066f5fec0152222123cedea05f346a7f2276a9ac90aede713d6ae14b3a2be4c5e41267ffdb4ccdff285b5d13350cd26c
+  metadata.gz: ce472eadec9ab44d5739f0e506813cb89cf7de6def2909e8ffd0788cf4fe246bf3433b75c22490528b0287bbfad1e2cc5ca50eeaacdd4156fe9bb32a36e912df
+  data.tar.gz: efb30d195c6a15f97133b76d1d4cac762800fe7620d11a58a2655e7ccd3bc972827d419337cbff13fb7d1c4b96004da7b9d95323ae7d8f6c1eaa07d784f67834

data/.github/workflows/rake.yml

@@ -4,7 +4,8 @@ name: rake
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, main ]
+    tags: [ v* ]
   pull_request:
 
 jobs:
@@ -31,11 +32,19 @@ jobs:
     steps:
       - uses: actions/checkout@master
 
-      - name: Use Ruby
-        uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
+
+      - uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
 
       - name: Install Inkscape macOS
         if: matrix.os == 'macos-latest'
@@ -57,8 +66,4 @@ jobs:
           choco install --no-progress -y inkscape
           inkscape --version
 
-      - name: Update gems
-        run: bundle install --jobs 4 --retry 3
-
-      - name: Run specs
-        run: bundle exec rake
+      - run: bundle exec rake

data/README.adoc

@@ -1,9 +1,7 @@
 = isodoc: Processor to generate HTML/Word from Metanorma XML
 
 image:https://img.shields.io/gem/v/isodoc.svg["Gem Version", link="https://rubygems.org/gems/isodoc"]
-image:https://github.com/metanorma/isodoc/workflows/ubuntu/badge.svg["Ubuntu Build Status", link="https://github.com/metanorma/isodoc/actions?query=workflow%3Aubuntu"]
-image:https://github.com/metanorma/isodoc/workflows/macos/badge.svg["OSX Build Status", link="https://github.com/metanorma/isodoc/actions?query=workflow%3Amacos"]
-image:https://github.com/metanorma/isodoc/workflows/windows/badge.svg["Windows Build Status", link="https://github.com/metanorma/isodoc/actions?query=workflow%3Awindows"]
+image:https://github.com/metanorma/isodoc/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/isodoc/actions?query=workflow%3Arake"]
 image:https://codeclimate.com/github/metanorma/isodoc/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/isodoc"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/isodoc.svg["Pull Requests", link="https://github.com/metanorma/isodoc/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/isodoc/latest.svg["Commits since latest",link="https://github.com/metanorma/isodoc/releases"]

data/isodoc.gemspec

@@ -35,10 +35,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "uuidtools"
   spec.add_dependency "html2doc", "~> 1.0.0"
   spec.add_dependency "liquid"
+  spec.add_dependency "twitter_cldr"
   spec.add_dependency "roman-numerals"
   spec.add_dependency "metanorma", "~> 1.2.0"
   spec.add_dependency "relaton-cli"
-  spec.add_dependency "gyoku", "~> 1.3"
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "byebug", "~> 9.1"

data/lib/isodoc-yaml/i18n-en.yaml

@@ -36,6 +36,7 @@ external_terms_boilerplate: |
 internal_external_terms_boilerplate: |
           <p>For the purposes of this document, the terms and definitions 
             given in % and the following apply.</p>
+term_defined_in: "[term defined in %]"
 note: NOTE
 note_xref: Note
 termnote: Note % to entry

data/lib/isodoc-yaml/i18n-fr.yaml

@@ -1,5 +1,5 @@
 term_def_boilerplate: 
-scope: Domaine d'application
+scope: Domaine d’application
 symbolsabbrev: Symboles et termes abrégés
 abbrev: Termes abrégés
 symbols: Symboles
@@ -18,20 +18,21 @@ clause: Article
 annex: Annexe
 appendix: Appendice
 no_terms_boilerplate: |
-          <p>Aucun terme n'est defini dans le présent document.</p>
+          <p>Aucun terme n’est defini dans le présent document.</p>
 internal_terms_boilerplate: |
-         <p>Pour les besoins du présent document, les termes et définitions suivants s'appliquent.</p>
+         <p>Pour les besoins du présent document, les termes et définitions suivants s’appliquent.</p>
 norm_with_refs_pref: 
-     Les documents suivants cités dans le texte constituent, pour tout ou partie de leur contenu, des exigences du présent document. Pour les références datées, seule l’édition citée s'applique. Pour les références non datées, la dernière édition du document de référence s'applique (y compris les éventuels amendements).
+     Les documents suivants cités dans le texte constituent, pour tout ou partie de leur contenu, des exigences du présent document. Pour les références datées, seule l’édition citée s’applique. Pour les références non datées, la dernière édition du document de référence s’applique (y compris les éventuels amendements).
 norm_empty_pref: 
           Le présent document ne contient aucune référence normative.
 external_terms_boilerplate: |
-          <p>Pour les besoins du présent document, les termes et définitions de % s'appliquent.</p>
+          <p>Pour les besoins du présent document, les termes et définitions de % s’appliquent.</p>
 internal_external_terms_boilerplate: |
-          <p>Pour les besoins du présent document, les termes et définitions de % ainsi que les suivants, s'appliquent.</p>
+          <p>Pour les besoins du présent document, les termes et définitions de % ainsi que les suivants, s’appliquent.</p>
+term_defined_in: "[terme défini dans %]"
 note: NOTE
 note_xref: Note
-termnote: Note % à l'article
+termnote: Note % à l’article
 figure: Figure
 formula: Formule
 inequality: Formule

data/lib/isodoc-yaml/i18n-zh-Hans.yaml

@@ -31,6 +31,7 @@ external_terms_boilerplate: |
           <p>% 界定的术语和定义适用于本文件。</p>
 internal_external_terms_boilerplate: |
           <p>% 界定的以及下列术语和定义适用于本文件。</p>
+term_defined_in: "〖术语于%中定义〗"
 note: 注
 note_xref: 注
 termnote: 注%

data/lib/isodoc/function/inline.rb

@@ -67,19 +67,6 @@ module IsoDoc::Function
       out << "Termbase #{node['base']}, term ID #{node['target']}"
     end
 
-    def concept_parse(node, out)
-      content = node.first_element_child.children.select do |c|
-        !%w{locality localityStack}.include? c.name 
-      end.select { |c| !c.text? || /\S/.match(c) }
-      if content.empty?
-        out << "[Term defined in "
-        parse(node.first_element_child, out)
-        out << "]"
-      else
-        content.each { |n| parse(n, out) }
-      end
-    end
-
     def stem_parse(node, out)
       ooml = if node["type"] == "AsciiMath"
                "#{@openmathdelim}#{HTMLEntities.new.encode(node.text)}"\
@@ -131,25 +118,5 @@ module IsoDoc::Function
         p.b(**{ role: "strong" }) { |e| e << text }
       end
     end
-
-    def variant_parse(node, out)
-      if node["lang"] == @lang && node["script"] == @script
-        node.children.each { |n| parse(n, out) }
-      else
-        return if found_matching_variant_sibling(node)
-        return unless !node.at("./preceding-sibling::xmlns:variant")
-        node.children.each { |n| parse(n, out) }
-      end
-    end
-
-    def found_matching_variant_sibling(node)
-      prev = node.xpath("./preceding-sibling::xmlns:variant")
-      foll = node.xpath("./following-sibling::xmlns:variant")
-      found = false
-      (prev + foll).each do |n|
-        found = true if n["lang"] == @lang && n["script"] == @script
-      end
-      found
-    end
   end
 end

data/lib/isodoc/function/references.rb

@@ -90,7 +90,7 @@ module IsoDoc::Function
     end
 
     def date_note_process(b, ref)
-      date_note = b.at(ns("./note[@type = 'ISO DATE']"))
+      date_note = b.at(ns("./note[@type = 'Unpublished-Status']"))
       return if date_note.nil?
       date_note.children.first.replace("<p>#{date_note.content}</p>")
       footnote_parse(date_note, ref)

data/lib/isodoc/function/to_word_html.rb

@@ -215,14 +215,12 @@ module IsoDoc::Function
         when "verification" then requirement_component_parse(node, out)
         when "import" then requirement_component_parse(node, out)
         when "index" then index_parse(node, out)
-        when "concept" then concept_parse(node, out)
         when "termref" then termrefelem_parse(node, out)
         when "copyright-statement" then copyright_parse(node, out)
         when "license-statement" then license_parse(node, out)
         when "legal-statement" then legal_parse(node, out)
         when "feedback-statement" then feedback_parse(node, out)
         when "passthrough" then passthrough_parse(node, out)
-        when "variant" then variant_parse(node, out)
         when "amend" then amend_parse(node, out)
         when "tab" then clausedelimspace(out) # in Presentation XML only
         else

data/lib/isodoc/html_function/postprocess.rb

@@ -221,6 +221,7 @@ module IsoDoc::HtmlFunction
     MATHJAX = <<~"MATHJAX".freeze
       <script type="text/x-mathjax-config">
         MathJax.Hub.Config({
+          "HTML-CSS": { preferredFont: "STIX" },
           asciimath2jax: { delimiters: [['OPEN', 'CLOSE']] }
        });
       </script>

data/lib/isodoc/i18n.rb

@@ -4,8 +4,21 @@ module IsoDoc
   class I18n
     def load_yaml(lang, script, i18nyaml = nil)
       ret = load_yaml1(lang, script)
-      return ret.merge(YAML.load_file(i18nyaml)) if i18nyaml
-      ret
+      return normalise_hash(ret.merge(YAML.load_file(i18nyaml))) if i18nyaml
+      normalise_hash(ret)
+    end
+
+    def normalise_hash(ret)
+      if ret.is_a? Hash 
+        ret.each do |k, v|
+          ret[k] = normalise_hash(v)
+        end
+        ret
+      elsif ret.is_a? Array then ret.map { |n| normalise_hash(n) }
+      elsif ret.is_a? String then ret.unicode_normalize(:nfc) 
+      else
+        ret
+      end
     end
 
     def load_yaml1(lang, script)

data/lib/isodoc/presentation_function/block.rb

@@ -1,5 +1,10 @@
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
+    def lower2cap(s)
+      return s if /^[[:upper:]][[:upper:]]/.match(s)
+      s.capitalize
+    end
+
     def figure(docxml)
       docxml.xpath(ns("//figure")).each do |f|
         figure1(f)
@@ -12,7 +17,7 @@ module IsoDoc
       return if labelled_ancestor(f) && f.ancestors("figure").empty?
       return if f.at(ns("./figure")) and !f.at(ns("./name"))
       lbl = @xrefs.anchor(f['id'], :label, false) or return
-      prefix_name(f, "&nbsp;&mdash; ", l10n("#{@i18n.figure} #{lbl}"), "name")
+      prefix_name(f, "&nbsp;&mdash; ", l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
     end
 
     def prefix_name(f, delim, number, elem)
@@ -36,7 +41,7 @@ module IsoDoc
       return if labelled_ancestor(f)
       return unless f.ancestors("example").empty?
       lbl = @xrefs.anchor(f['id'], :label, false) or return
-      prefix_name(f, "&nbsp;&mdash; ", l10n("#{@i18n.figure} #{lbl}"), "name")
+      prefix_name(f, "&nbsp;&mdash; ", l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
     end
 
     def formula(docxml)
@@ -65,7 +70,7 @@ module IsoDoc
 
     def example1(f)
       n = @xrefs.get[f["id"]]
-      lbl = (n.nil? || n[:label].nil? || n[:label].empty?) ? @i18n.example :
+      lbl = (n.nil? || n[:label].nil? || n[:label].empty?) ? @i18n.example:
         l10n("#{@i18n.example} #{n[:label]}")
       prefix_name(f, "&nbsp;&mdash; ", lbl, "name")
     end
@@ -81,7 +86,7 @@ module IsoDoc
       return if f.parent.name == "bibitem"
       n = @xrefs.get[f["id"]]
       lbl = (@i18n.note if n.nil? || n[:label].nil? || n[:label].empty?) ?
-        @i18n.note : l10n("#{@i18n.note} #{n[:label]}")
+        @i18n.note: l10n("#{@i18n.note} #{n[:label]}")
       prefix_name(f, "", lbl, "name")
     end
 
@@ -94,24 +99,24 @@ module IsoDoc
     # introduce name element
     def termnote1(f)
       lbl = l10n(@xrefs.anchor(f['id'], :label) || '???')
-      prefix_name(f, "", lbl, "name")
+      prefix_name(f, "", lower2cap(lbl), "name")
     end
 
     def recommendation(docxml)
       docxml.xpath(ns("//recommendation")).each do |f|
-        recommendation1(f, @i18n.recommendation)
+        recommendation1(f, lower2cap(@i18n.recommendation))
       end
     end
 
     def requirement(docxml)
       docxml.xpath(ns("//requirement")).each do |f|
-        recommendation1(f, @i18n.requirement)
+        recommendation1(f, lower2cap(@i18n.requirement))
       end
     end
 
     def permission(docxml)
       docxml.xpath(ns("//permission")).each do |f|
-        recommendation1(f, @i18n.permission)
+        recommendation1(f, lower2cap(@i18n.permission))
       end
     end
 
@@ -132,7 +137,7 @@ module IsoDoc
       return if labelled_ancestor(f)
       return if f["unnumbered"] && !f.at(ns("./name"))
       n = @xrefs.anchor(f['id'], :label, false)
-      prefix_name(f, "&nbsp;&mdash; ", l10n("#{@i18n.table} #{n}"), "name")
+      prefix_name(f, "&nbsp;&mdash; ", l10n("#{lower2cap @i18n.table} #{n}"), "name")
     end
 
     # we use this to eliminate the semantic amend blocks from rendering

data/lib/isodoc/presentation_function/inline.rb

@@ -1,3 +1,5 @@
+require "twitter_cldr"
+
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def prefix_container(container, linkend, _target)
@@ -8,8 +10,8 @@ module IsoDoc
       if node["citeas"].nil? && node["bibitemid"]
         return @xrefs.anchor(node["bibitemid"] ,:xref) || "???"
       elsif node["target"] && node["droploc"]
-        return @xrefs.anchor(node["target"], :value) || 
-          @xrefs.anchor(node["target"], :label) || 
+        return @xrefs.anchor(node["target"], :value) ||
+          @xrefs.anchor(node["target"], :label) ||
           @xrefs.anchor(node["target"], :xref) || "???"
       elsif node["target"] && !/.#./.match(node["target"])
         linkend = anchor_linkend1(node)
@@ -38,7 +40,7 @@ module IsoDoc
     end
 
     def nearest_block_parent(node)
-      until %w(p title td th name formula 
+      until %w(p title td th name formula
         li dt dd sourcecode pre).include?(node.name)
         node = node.parent
       end
@@ -51,13 +53,13 @@ module IsoDoc
       end
     end
 
-    def get_linkend(node)
-      contents = non_locality_elems(node).select { |c| !c.text? || /\S/.match(c) }
+    def get_linkend(n)
+      contents = non_locality_elems(n).select { |c| !c.text? || /\S/.match(c) }
       return unless contents.empty?
-      link = anchor_linkend(node, docid_l10n(node["target"] || node["citeas"]))
-      link += eref_localities(node.xpath(ns("./locality | ./localityStack")), link)
-      non_locality_elems(node).each { |n| n.remove }
-      node.add_child(link)
+      link = anchor_linkend(n, docid_l10n(n["target"] || n["citeas"]))
+      link += eref_localities(n.xpath(ns("./locality | ./localityStack")), link)
+      non_locality_elems(n).each { |n| n.remove }
+      n.add_child(link)
     end
     # so not <origin bibitemid="ISO7301" citeas="ISO 7301">
     # <locality type="section"><reference>3.1</reference></locality></origin>
@@ -104,7 +106,8 @@ module IsoDoc
     # TODO: move to localization file
     def eref_localities1(target, type, from, to, delim, lang = "en")
       return "" if type == "anchor"
-      return l10n(eref_localities1_zh(target, type, from, to, delim)) if lang == "zh"
+      lang == "zh" and
+        return l10n(eref_localities1_zh(target, type, from, to, delim))
       ret = delim
       loc = @i18n.locality[type] || type.sub(/^locality:/, "").capitalize
       ret += " #{loc}"
@@ -114,31 +117,130 @@ module IsoDoc
     end
 
     def xref(docxml)
-      docxml.xpath(ns("//xref")).each do |f|
-        xref1(f)
-      end
+      docxml.xpath(ns("//xref")).each { |f| xref1(f) }
     end
 
     def eref(docxml)
-      docxml.xpath(ns("//eref")).each do |f|
-        xref1(f)
-      end
+      docxml.xpath(ns("//eref")).each { |f| xref1(f) }
     end
 
     def origin(docxml)
-      docxml.xpath(ns("//origin[not(termref)]")).each do |f|
-        xref1(f)
-      end
+      docxml.xpath(ns("//origin[not(termref)]")).each { |f| xref1(f) }
     end
 
     def quotesource(docxml)
-      docxml.xpath(ns("//quote/source")).each do |f|
-        xref1(f)
-      end
+      docxml.xpath(ns("//quote/source")).each { |f| xref1(f) }
     end
 
     def xref1(f)
       get_linkend(f)
     end
+
+    def concept(docxml)
+      docxml.xpath(ns("//concept")).each { |f| concept1(f) }
+    end
+
+    def concept1(node)
+      content = node.first_element_child.children.select do |c|
+        !%w{locality localityStack}.include? c.name
+      end.select { |c| !c.text? || /\S/.match(c) }
+      node.replace content.empty? ? 
+        @i18n.term_defined_in.sub(/%/, node.first_element_child.to_xml) :
+        "<em>#{node.children.to_xml}</em>"
+    end
+
+
+    MATHML = { "m" => "http://www.w3.org/1998/Math/MathML" }.freeze
+
+    def mathml(docxml)
+      locale = twitter_cldr_localiser()
+      docxml.xpath("//m:math", MATHML).each do |f|
+        mathml1(f, locale)
+      end
+    end
+
+    # symbols is merged into
+    # TwitterCldr::DataReaders::NumberDataReader.new(locale).symbols
+    def localize_maths(f, locale)
+      f.xpath(".//m:mn", MATHML).each do |x|
+        num = /\./.match(x.text) ? x.text.to_f : x.text.to_i
+        x.children = localized_number(num, locale)
+      end
+    end
+
+    # By itself twiiter cldr does not support fraction part digits grouping
+    # and custom delimeter, will decorate fraction part manually
+    def localized_number(num, locale)
+      localized = num.localize(locale).to_s
+      twitter_cldr_reader_symbols = twitter_cldr_reader(locale)
+      return localized unless twitter_cldr_reader_symbols[:decimal]
+      integer, fraction = localized.split(twitter_cldr_reader_symbols[:decimal])
+      return localized if fraction.nil? || fraction.length.zero?
+      [integer, decorate_fraction_part(fraction, locale)].
+        join(twitter_cldr_reader_symbols[:decimal])
+    end
+
+    def decorate_fraction_part(fract, locale)
+      result = []
+      twitter_cldr_reader_symbols = twitter_cldr_reader(locale)
+      fract = fract.slice(0..(twitter_cldr_reader_symbols[:precision] || -1))
+      fr_group_digits = twitter_cldr_reader_symbols[:fraction_group_digits] || 1
+      until fract.empty?
+        result.push(fract.slice!(0, fr_group_digits))
+      end
+      result.join(twitter_cldr_reader_symbols[:fraction_group].to_s)
+    end
+
+    def twitter_cldr_localiser_symbols
+      {}
+    end
+
+    def twitter_cldr_reader(locale)
+      num = TwitterCldr::DataReaders::NumberDataReader.new(locale)
+      num.symbols.merge!(twitter_cldr_localiser_symbols)
+    end
+
+    def twitter_cldr_localiser()
+      locale = TwitterCldr.supported_locale?(@lang.to_sym) ? @lang.to_sym : :en
+      twitter_cldr_reader(locale)
+      locale
+    end
+
+    def mathml1(f, locale)
+      localize_maths(f, locale)
+      return unless f.elements.size == 1 && f.elements.first.name == "mn"
+      f.replace(f.at("./m:mn", MATHML).children)
+    end
+
+    def variant(docxml)
+      docxml.xpath(ns("//variant")).each { |f| variant1(f) }
+      docxml.xpath(ns("//variant[@remove = 'true']")).each { |f| f.remove }
+      docxml.xpath(ns("//variant")).each do |v|
+        next unless v&.next&.name == "variant"
+        v.next = "/"
+      end
+      docxml.xpath(ns("//variant")).each { |f| f.replace(f.children) }
+    end
+
+    def variant1(node)
+      if (!node["lang"] || node["lang"] == @lang) &&
+          (!node["script"] || node["script"] == @script)
+      elsif found_matching_variant_sibling(node)
+        node["remove"] = "true"
+      else
+        #return unless !node.at("./preceding-sibling::xmlns:variant")
+      end
+    end
+
+    def found_matching_variant_sibling(node)
+      prev = node.xpath("./preceding-sibling::xmlns:variant")
+      foll = node.xpath("./following-sibling::xmlns:variant")
+      found = false
+      (prev + foll).each do |n|
+        found = true if n["lang"] == @lang &&
+          (!n["script"] || n["script"] == @script)
+      end
+      found
+    end
   end
 end