metanorma-iso 1.3.20 → 1.3.25

data/lib/isodoc/iso/metadata.rb

@@ -16,26 +16,12 @@ module IsoDoc
       }
       end
 
-      STAGE_ABBRS = {
-        "00": "PWI",
-        "10": "NWIP",
-        "20": "WD",
-        "30": "CD",
-        "40": "DIS",
-        "50": "FDIS",
-        "60": "IS",
-        "90": "(Review)",
-        "95": "(Withdrawal)",
-      }.freeze
-
-      def stage_abbr(stage)
-        self.class::STAGE_ABBRS[stage.to_sym] || "??"
-      end
-
-      def status_abbrev(stage, substage, iter, draft)
+      def status_abbrev(stage, substage, iter, draft, doctype)
         return "" unless stage
-        stage = self.class::STAGE_ABBRS[stage.to_sym] || "??"
-        stage = "PRF" if stage == "IS" && substage == "00"
+        if %w(technical-report technical-specification).include?(doctype)
+          stage = "DTS" if stage == "DIS"
+          stage = "FDTS" if stage == "FDIS"
+        end
         stage += iter if iter
         stage = "Pre" + stage if draft =~ /^0\./
         stage
@@ -48,12 +34,13 @@ module IsoDoc
           set(:stage, docstatus.text)
           set(:stage_int, docstatus.text.to_i)
           set(:unpublished, unpublished(docstatus.text))
-          set(:statusabbr, status_abbrev(docstatus.text,
+          set(:statusabbr, status_abbrev(docstatus["abbreviation"] || "??",
                                          isoxml&.at(ns("//bibdata/status/substage"))&.text,
                                          isoxml&.at(ns("//bibdata/status/iteration"))&.text,
-                                         isoxml&.at(ns("//version/draft"))&.text))
+                                         isoxml&.at(ns("//version/draft"))&.text,
+                                         isoxml&.at(ns("//bibdata/ext/doctype"))&.text))
           unpublished(docstatus.text) and
-            set(:stageabbr, stage_abbr(docstatus.text))
+            set(:stageabbr, docstatus["abbreviation"])
         end
         revdate = isoxml.at(ns("//version/revision-date"))
         set(:revdate, revdate&.text)
@@ -68,6 +55,10 @@ module IsoDoc
         set(:docnumber, dn&.text)
         tcdn = isoxml.xpath(ns("//bibdata/docidentifier[@type = 'iso-tc']"))
         set(:tc_docnumber, tcdn.map { |n| n.text })
+        dn = isoxml.at(ns("//bibdata/docidentifier[@type = 'iso-with-lang']"))
+        set(:docnumber_lang, dn&.text)
+        dn = isoxml.at(ns("//bibdata/docidentifier[@type = 'iso-reference']"))
+        set(:docnumber_reference, dn&.text)
       end
 
       # we don't leave this to i18n.rb, because we have both English and
@@ -79,6 +70,20 @@ module IsoDoc
         end
       end
 
+      def amd_label(lang)
+        case lang
+        when "en" then "AMENDMENT"
+        when "fr" then "AMENDMENT"
+        end
+      end
+
+      def corr_label(lang)
+        case lang
+        when "en" then "TECHNICAL CORRIGENDUM"
+        when "fr" then "RECTIFICATIF TECHNIQUE"
+        end
+      end
+
       def part_title(part, partnum, subpartnum, lang)
         return "" unless part
         suffix = @c.encode(part.text, :hexadecimal)
@@ -92,6 +97,14 @@ module IsoDoc
         "#{part_label(lang)} #{partnum}"
       end
 
+      def amd_prefix(num, lang)
+        "#{amd_label(lang)} #{num}"
+      end
+
+      def corr_prefix(num, lang)
+        "#{corr_label(lang)} #{num}"
+      end
+
       def compose_title(main, intro, part, partnum, subpartnum, lang)
         main = main.nil? ? "" : @c.encode(main.text, :hexadecimal)
         intro &&
@@ -109,6 +122,9 @@ module IsoDoc
         part = isoxml.at(ns("//bibdata//title[@type='title-part' and @language='en']"))
         partnumber = isoxml.at(ns("//bibdata//project-number/@part"))
         subpartnumber = isoxml.at(ns("//bibdata//project-number/@subpart"))
+        amdnumber = isoxml.at(ns("//bibdata//project-number/@amendment"))
+        corrnumber = isoxml.at(ns("//bibdata//project-number/@corrigendum"))
+        amd = isoxml.at(ns("//bibdata//title[@type='title-amd' and @language='en']"))
 
         set(:doctitlemain, @c.encode(main ? main.text : "", :hexadecimal))
         main = compose_title(main, intro, part, partnumber, subpartnumber, "en")
@@ -116,6 +132,9 @@ module IsoDoc
         set(:doctitleintro, @c.encode(intro ? intro.text : "", :hexadecimal)) if intro
         set(:doctitlepartlabel, part_prefix(partnumber, subpartnumber, "en"))
         set(:doctitlepart, @c.encode(part.text, :hexadecimal)) if part
+        set(:doctitleamdlabel, amd_prefix(amdnumber, "en")) if amdnumber
+        set(:doctitleamd, @c.encode(amd.text, :hexadecimal)) if amd
+        set(:doctitlecorrlabel, corr_prefix(corrnumber, "en")) if corrnumber
       end
 
       def subtitle(isoxml, _out)
@@ -124,12 +143,19 @@ module IsoDoc
         part = isoxml.at(ns("//bibdata//title[@type='title-part' and @language='fr']"))
         partnumber = isoxml.at(ns("//bibdata//project-number/@part"))
         subpartnumber = isoxml.at(ns("//bibdata//project-number/@subpart"))
+        amdnumber = isoxml.at(ns("//bibdata//project-number/@amendment"))
+        corrnumber = isoxml.at(ns("//bibdata//project-number/@corrigendum"))
+        amd = isoxml.at(ns("//bibdata//title[@type='title-amd' and @language='fr']"))
+
         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(:docsubtitlepartlabel, part_prefix(partnumber, subpartnumber, "fr"))
         set(:docsubtitlepart, @c.encode(part.text, :hexadecimal)) if part
+        set(:docsubtitleamdlabel, amd_prefix(amdnumber, "fr")) if amdnumber
+        set(:docsubtitleamd, @c.encode(amd.text, :hexadecimal)) if amd
+        set(:docsubtitlecorrlabel, corr_prefix(corrnumber, "fr")) if corrnumber
       end
 
       def author(xml, _out)

data/lib/isodoc/iso/pdf_convert.rb

@@ -0,0 +1,32 @@
+require_relative "base_convert"
+require "isodoc"
+
+module IsoDoc
+  module Iso
+
+    # A {Converter} implementation that generates HTML output, and a document
+    # schema encapsulation of the document for validation
+    #
+    class PdfConvert < IsoDoc::XslfoPdfConvert
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        super
+      end
+
+      def convert(filename, file = nil, debug = false)
+        file = File.read(filename, encoding: "utf-8") if file.nil?
+        docxml, outname_html, dir = convert_init(file, filename, debug)
+        /\.xml$/.match(filename) or
+          filename = Tempfile.open([outname_html, ".xml"], encoding: "utf-8") do |f|
+          f.write file
+          f.path
+        end
+        FileUtils.rm_rf dir
+        ::Metanorma::Output::XslfoPdf.new.convert(
+          filename, outname_html + ".pdf",
+          File.join(@libdir, "iso.international-standard.xsl"))
+      end
+    end
+  end
+end
+

data/lib/metanorma-iso.rb

@@ -3,6 +3,7 @@ require_relative "asciidoctor/iso/converter"
 require_relative "metanorma/iso/version"
 require_relative "isodoc/iso/html_convert"
 require_relative "isodoc/iso/word_convert"
+require_relative "isodoc/iso/pdf_convert"
 require "asciidoctor/extensions"
 
 if defined? Metanorma

data/lib/metanorma/iso/processor.rb

@@ -2,6 +2,15 @@ require "metanorma/processor"
 
 module Metanorma
   module Iso
+    def self.fonts_used
+      {
+        html: ["Cambria", "Times New Roman", "Cambria Math", "HanSans", "Courier New"],
+        html_alt: ["Cambria", "Times New Roman", "Cambria Math", "HanSans", "Courier New"],
+        doc: ["Cambria", "Times New Roman", "Cambria Math", "HanSans", "Courier New"],
+        pdf: ["Cambria", "Times New Roman", "Cambria Math", "HanSans", "Courier New"],
+      }
+    end
+
     class Processor < Metanorma::Processor
 
       def initialize
@@ -14,7 +23,8 @@ module Metanorma
         super.merge(
           html: "html",
           html_alt: "alt.html",
-          doc: "doc"
+          doc: "doc",
+          pdf: "pdf"
         )
       end
 
@@ -34,6 +44,8 @@ module Metanorma
           IsoDoc::Iso::HtmlConvert.new(options.merge(alt: true)).convert(outname, isodoc_node)
         when :doc
           IsoDoc::Iso::WordConvert.new(options).convert(outname, isodoc_node)
+        when :pdf
+          IsoDoc::Iso::PdfConvert.new(options).convert(outname, isodoc_node)
         else
           super
         end

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module ISO
-    VERSION = "1.3.20".freeze
+    VERSION = "1.3.25".freeze
   end
 end

data/spec/asciidoctor-iso/amd_spec.rb

@@ -0,0 +1,318 @@
+require "spec_helper"
+require "fileutils"
+
+RSpec.describe Asciidoctor::ISO do
+  it "validates amendment document against distinct ISO XML schema" do
+    FileUtils.rm_f "test.err"
+  Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
+  = Document title
+  Author
+  :docfile: test.adoc
+  :nodoc:
+  :no-isobib:
+  :doctype: amendment
+
+  [change=mid-air]
+  == Para
+  INPUT
+    expect(File.read("test.err")).to include 'value of attribute "change" is invalid; must be equal to'
+end
+
+    it "processes amendment sections" do
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      #{AMD_BLANK_HDR}
+      == Foreword
+
+      Text
+
+      == Introduction
+
+      === Introduction Subsection
+
+      == Scope
+
+      Text
+
+      == Acknowledgements
+
+      == Normative References
+
+      == Terms and Definitions
+
+      === Term1
+
+      == Terms, Definitions, Symbols and Abbreviated Terms
+
+      === Normal Terms
+
+      ==== Term2
+
+      === Symbols and Abbreviated Terms
+
+      == Symbols and Abbreviated Terms
+
+      == Clause 4
+
+      === Introduction
+
+      === Clause 4.2
+
+      == Terms and Definitions
+
+      [appendix]
+      == Annex
+
+      === Annex A.1
+
+      [%appendix]
+      === Appendix 1
+
+      == Bibliography
+
+      === Bibliography Subsection
+    INPUT
+    #{BLANK_HDR.sub(%r{<doctype>article</doctype>}, "<doctype>amendment</doctype>")}
+  <sections>
+    <clause id='_' obligation='normative'>
+      <title>Foreword</title>
+      <p id='_'>Text</p>
+    </clause>
+    <clause id='_' obligation='normative'>
+      <title>Introduction</title>
+      <clause id='_' obligation='normative'>
+        <title>Introduction Subsection</title>
+      </clause>
+    </clause>
+    <clause id='_' obligation='normative'>
+      <title>Scope</title>
+      <p id='_'>Text</p>
+    </clause>
+    <clause id='_' obligation='normative'>
+      <title>Acknowledgements</title>
+    </clause>
+    <clause id='_' obligation='normative'>
+      <title>Normative References</title>
+    </clause>
+    <clause id='_' obligation='normative'>
+      <title>Terms and Definitions</title>
+      <clause id='_' obligation='normative'>
+        <title>Term1</title>
+      </clause>
+    </clause>
+    <clause id='_' obligation='normative'>
+      <title>Terms, Definitions, Symbols and Abbreviated Terms</title>
+      <clause id='_' obligation='normative'>
+        <title>Normal Terms</title>
+        <clause id='_' obligation='normative'>
+          <title>Term2</title>
+        </clause>
+      </clause>
+      <clause id='_' obligation='normative'>
+        <title>Symbols and Abbreviated Terms</title>
+      </clause>
+    </clause>
+    <clause id='_' obligation='normative'>
+      <title>Symbols and Abbreviated Terms</title>
+    </clause>
+    <clause id='_' obligation='normative'>
+      <title>Clause 4</title>
+      <clause id='_' obligation='normative'>
+        <title>Introduction</title>
+      </clause>
+      <clause id='_' obligation='normative'>
+        <title>Clause 4.2</title>
+      </clause>
+    </clause>
+    <clause id='_' obligation='normative'>
+      <title>Terms and Definitions</title>
+    </clause>
+    <clause id='_' obligation='normative'>
+      <title>Bibliography</title>
+      <clause id='_' obligation='normative'>
+        <title>Bibliography Subsection</title>
+      </clause>
+    </clause>
+  </sections>
+  <annex id='_' obligation='normative'>
+    <title>Annex</title>
+    <clause id='_' obligation='normative'>
+      <title>Annex A.1</title>
+    </clause>
+    <appendix id='_' obligation='normative'>
+      <title>Appendix 1</title>
+    </appendix>
+  </annex>
+</iso-standard>
+
+OUTPUT
+    end
+
+      it "processes section attributes" do
+     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      #{AMD_BLANK_HDR}
+      [change=delete,locality="clause=introduction,paragraph=4-7",inline-header="true"]
+      == Clause 1
+
+     INPUT
+             #{BLANK_HDR.sub(%r{<doctype>article</doctype>}, "<doctype>amendment</doctype>")}
+       <sections><clause id="_" obligation="normative"  change="delete" locality="clause=introduction,paragraph=4-7">
+         <title>Clause 1</title>
+       </clause>
+       </sections>
+       </iso-standard>
+     OUTPUT
+  end
+
+  it "processes default metadata, amendment" do
+    expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true).sub(%r{<boilerplate>.*</boilerplate>}m, ""))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :docnumber: 17301
+      :partnumber: 1
+      :edition: 2
+      :revdate: 2000-01-01
+      :draft: 0.3.4
+      :technical-committee: TC
+      :technical-committee-number: 1
+      :technical-committee-type: A
+      :subcommittee: SC
+      :subcommittee-number: 2
+      :subcommittee-type: B
+      :workgroup: WG
+      :workgroup-number: 3
+      :workgroup-type: C
+      :technical-committee_2: TC1
+      :technical-committee-number_2: 11
+      :technical-committee-type_2: A1
+      :subcommittee_2: SC1
+      :subcommittee-number_2: 21
+      :subcommittee-type_2: B1
+      :workgroup_2: WG1
+      :workgroup-number_2: 31
+      :workgroup-type_2: C1
+      :secretariat: SECRETARIAT
+      :docstage: 10
+      :docsubstage: 20
+      :iteration: 3
+      :language: en
+      :title-intro-en: Introduction
+      :title-main-en: Main Title -- Title
+      :title-part-en: Title Part
+      :title-intro-fr: Introduction Française
+      :title-main-fr: Titre Principal
+      :title-part-fr: Part du Titre
+      :library-ics: 1,2,3
+      :copyright-year: 2017
+      :updates: ISO 17301-1:2016
+      :created-date: 2016-05-01
+      :amendment-number: 1
+      :title-amendment-en: Mass fraction of extraneous matter, milled rice (nonglutinous), sample dividers and recommendations relating to storage and transport conditions
+      :title-amendment-fr: Fraction massique de matière étrangère, riz usiné (non gluant), diviseurs d’échantillon et recommandations relatives aux conditions d’entreposage et de transport
+      :doctype: amendment
+      :updates-document-type: international-standard
+    INPUT
+    <iso-standard xmlns='https://www.metanorma.org/ns/iso'>
+  <bibdata type='standard'>
+    <title language='en' format='text/plain' type='main'>Introduction — Main Title — Title — Title Part — Mass fraction of
+       extraneous matter, milled rice (nonglutinous), sample dividers and
+       recommendations relating to storage and transport conditions</title>
+    <title language='en' format='text/plain' type='title-intro'>Introduction</title>
+    <title language='en' format='text/plain' type='title-main'>Main Title — Title</title>
+    <title language='en' format='text/plain' type='title-part'>Title Part</title>
+    <title language='en' format='text/plain' type='title-amd'>
+  Mass fraction of extraneous matter, milled rice (nonglutinous), sample
+  dividers and recommendations relating to storage and transport conditions
+</title>
+<title language='fr' format='text/plain' type='main'>
+  Introduction Française — Titre Principal — Part du Titre — Fraction
+  massique de matière étrangère, riz usiné (non gluant), diviseurs
+  d’échantillon et recommandations relatives aux conditions d’entreposage et
+  de transport
+</title>
+    <title language='fr' format='text/plain' type='title-intro'>Introduction Française</title>
+    <title language='fr' format='text/plain' type='title-main'>Titre Principal</title>
+    <title language='fr' format='text/plain' type='title-part'>Part du Titre</title>
+    <title language='fr' format='text/plain' type='title-amd'>
+  Fraction massique de matière étrangère, riz usiné (non gluant), diviseurs
+  d’échantillon et recommandations relatives aux conditions d’entreposage et
+  de transport
+</title>
+    <docidentifier type='iso'>ISO/PreNWIP3 17301-1:2016/Amd.1</docidentifier>
+    <docidentifier type='iso-with-lang'>ISO/PreNWIP3 17301-1:2016/Amd.1(E)</docidentifier>
+    <docidentifier type='iso-reference'>ISO/PreNWIP3 17301-1:2016/Amd.1:2017(E)</docidentifier>
+    <docnumber>17301</docnumber>
+    <date type='created'>
+      <on>2016-05-01</on>
+    </date>
+    <contributor>
+      <role type='author'/>
+      <organization>
+        <name>International Organization for Standardization</name>
+        <abbreviation>ISO</abbreviation>
+      </organization>
+    </contributor>
+    <contributor>
+      <role type='publisher'/>
+      <organization>
+        <name>International Organization for Standardization</name>
+        <abbreviation>ISO</abbreviation>
+      </organization>
+    </contributor>
+    <edition>2</edition>
+    <version>
+      <revision-date>2000-01-01</revision-date>
+      <draft>0.3.4</draft>
+    </version>
+    <language>en</language>
+    <script>Latn</script>
+    <status>
+      <stage abbreviation='NWIP'>10</stage>
+      <substage>20</substage>
+      <iteration>3</iteration>
+    </status>
+    <copyright>
+      <from>2017</from>
+      <owner>
+        <organization>
+          <name>International Organization for Standardization</name>
+          <abbreviation>ISO</abbreviation>
+        </organization>
+      </owner>
+    </copyright>
+    <ext>
+      <doctype>amendment</doctype>
+      <editorialgroup>
+        <technical-committee number='1' type='A'>TC</technical-committee>
+        <technical-committee number='11' type='A1'>TC1</technical-committee>
+        <subcommittee number='2' type='B'>SC</subcommittee>
+        <subcommittee number='21' type='B1'>SC1</subcommittee>
+        <workgroup number='3' type='C'>WG</workgroup>
+        <workgroup number='31' type='C1'>WG1</workgroup>
+        <secretariat>SECRETARIAT</secretariat>
+      </editorialgroup>
+      <ics>
+        <code>1</code>
+      </ics>
+      <ics>
+        <code>2</code>
+      </ics>
+      <ics>
+        <code>3</code>
+      </ics>
+      <structuredidentifier>
+        <project-number part='1' amendment='1' origyr='2016-05-01'>17301</project-number>
+      </structuredidentifier>
+      <stagename>New work item proposal</stagename>
+      <updates-document-type>international-standard</updates-document-type>
+    </ext>
+  </bibdata>
+  <sections/>
+</iso-standard>
+OUTPUT
+  end
+
+end