metanorma-iso 1.3.6 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b990d016a143d3d99c2d7effe05e237661bbfa046b31c5fae6af14ea6f9695f
-  data.tar.gz: d68fca0b2023046eae06bf883ef7dc8569da86c0ab9a249a108eed75d87388b5
+  metadata.gz: 7f3ac994687043ccc35d6421913c9abe3342c3ee4ea17d318f0446b7cc042958
+  data.tar.gz: 03b2ccb9739ee87347cd5c58e91eae9b2ad7a64061908d2e898f2d9b054d029b
 SHA512:
-  metadata.gz: d9e291ec902643bd28b8d164d4631f015782198ec855597d6c731deb11a87409d9d8ca3fbd586e83b9c1ce98c51d4eab124b4172448c749895811850d3f215d9
-  data.tar.gz: '049a3e2452504bd12829c34d2fe983c2a42b240191beb9a992d2d478f38a39391b1fbd413a01b181e4496c3ab4bf904b3b7231596ab77d230df69506862d5477'
+  metadata.gz: 30d3582ecc68ae76c321e6ea2923dbb28df65c6a024544cacad6c4ebec6f9a554099024544176d931b616d74cfafefd4e0d21296d0c1602aa939c749c85edfe4
+  data.tar.gz: 6e9b4a576472188de3b17f090d4fe192bf8247a9cae4039d3d2466c578764d32552f0929db521384777f9acdfda7e0a205de886ccfcd6080dec69ed201bad3cc

data/README.adoc

@@ -1,11 +1,11 @@
 = Metanorma-ISO: Metanorma processor for ISO standards
 
 image:https://img.shields.io/gem/v/metanorma-iso.svg["Gem Version", link="https://rubygems.org/gems/metanorma-iso"]
-image:https://img.shields.io/travis/metanorma/metanorma-iso/master.svg["Build Status", link="https://travis-ci.org/metanorma/metanorma-iso"]
-image:https://ci.appveyor.com/api/projects/status/hnc1wnc8i9nquqqb?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/ribose/metanorma-iso"]
+image:https://travis-ci.com/metanorma/metanorma-iso.svg["Build Status", link="https://travis-ci.com/metanorma/metanorma-iso"]
+image:https://ci.appveyor.com/api/projects/status/t874i1cbarhnrwki?svg=true["Appveyor Build Status", link="https://ci.appveyor.com/project/metanorma/metanorma-iso"]
 image:https://codeclimate.com/github/metanorma/metanorma-iso/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-iso"]
-
-WARNING: This gem is still under development.
+image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-iso.svg["Pull Requests", link="https://github.com/metanorma/metanorma-iso/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/metanorma-iso/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-iso/releases"]
 
 _Formerly known as_ `asciidoctor-iso`.
 

data/lib/asciidoctor/iso/basicdoc.rng

@@ -341,11 +341,6 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="tclass">
-    <element name="name">
-      <text/>
-    </element>
-  </define>
   <define name="thead">
     <element name="thead">
       <ref name="tr"/>
@@ -515,19 +510,22 @@
         <attribute name="subsequence"/>
       </optional>
       <optional>
-        <ref name="source"/>
+        <attribute name="class"/>
       </optional>
       <optional>
-        <ref name="tname"/>
+        <ref name="source"/>
       </optional>
       <optional>
-        <ref name="tclass"/>
+        <ref name="tname"/>
       </optional>
       <choice>
         <ref name="image"/>
         <ref name="video"/>
         <ref name="audio"/>
         <ref name="pre"/>
+        <oneOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </oneOrMore>
         <zeroOrMore>
           <ref name="figure"/>
         </zeroOrMore>

data/lib/asciidoctor/iso/validate.rb

@@ -2,106 +2,14 @@ require "metanorma-standoc"
 require_relative "./validate_style.rb"
 require_relative "./validate_requirements.rb"
 require_relative "./validate_section.rb"
+require_relative "./validate_title.rb"
 require "nokogiri"
 require "jing"
-require "pp"
 require "iev"
 
 module Asciidoctor
   module ISO
     class Converter < Standoc::Converter
-      def title_intro_validate(root)
-        title_intro_en = root.at("//title[@type='title-intro' and @language='en']")
-        title_intro_fr = root.at("//title[@type='title-intro' and @language='fr']")
-        if title_intro_en.nil? && !title_intro_fr.nil?
-          warn "No English Title Intro!"
-        end
-        if !title_intro_en.nil? && title_intro_fr.nil?
-          warn "No French Title Intro!"
-        end
-      end
-
-      def title_main_validate(root)
-        title_main_en = root.at("//title[@type='title-main' and @language='en']")
-        title_main_fr = root.at("//title[@type='title-main' and @language='fr']")
-        if title_main_en.nil? && !title_main_fr.nil?
-          warn "No English Title!"
-        end
-        if !title_main_en.nil? && title_main_fr.nil?
-          warn "No French Title!"
-        end
-      end
-
-      def title_part_validate(root)
-        title_part_en = root.at("//title[@type='title-part' and @language='en']")
-        title_part_fr = root.at("//title[@type='title-part' and @language='fr']")
-        (title_part_en.nil? && !title_part_fr.nil?) &&
-          warn("No English Title Part!")
-        (!title_part_en.nil? && title_part_fr.nil?) &&
-          warn("No French Title Part!")
-      end
-
-      # ISO/IEC DIR 2, 11.4
-      def title_subpart_validate(root)
-        docid = root.at("//bibdata/docidentifier[@type = 'iso']")
-        subpart = /-\d+-\d+/.match docid
-        iec = root.at("//bibdata/contributor[role/@type = 'publisher']/"\
-                      "organization[abbreviation = 'IEC' or "\
-                      "name = 'International Electrotechnical Commission']")
-        warn("Subpart defined on non-IEC document!") if subpart && !iec
-      end
-
-      # ISO/IEC DIR 2, 11.5.2
-      def title_names_type_validate(root)
-        doctypes = /International\sStandard | Technical\sSpecification |
-        Publicly\sAvailable\sSpecification | Technical\sReport | Guide /xi
-        title_main_en = root.at("//title[@type='title-main' and @language='en']")
-        if !title_main_en.nil? && doctypes.match(title_main_en.text)
-          warn "Main Title may name document type"
-        end
-        title_intro_en = root.at("//title[@type='title-intro' and @language='en']")
-        if !title_intro_en.nil? && doctypes.match(title_intro_en.text)
-          warn "Title Intro may name document type"
-        end
-      end
-
-      # ISO/IEC DIR 2, 22.2
-      def title_first_level_validate(root)
-        root.xpath(SECTIONS_XPATH).each do |s|
-          title = s&.at("./title")&.text || s.name
-          s.xpath("./clause | ./terms | ./references").each do |ss|
-            subtitle = ss.at("./title")
-            !subtitle.nil? && !subtitle&.text&.empty? ||
-              warn("#{title}: each first-level subclause must have a title")
-          end
-        end
-      end
-
-      # ISO/IEC DIR 2, 22.2
-      def title_all_siblings(xpath, label)
-        notitle = false
-        withtitle = false
-        xpath.each do |s|
-          title_all_siblings(s.xpath("./clause | ./terms | ./references"),
-                             s&.at("./title")&.text || s["id"])
-          subtitle = s.at("./title")
-          notitle = notitle || (!subtitle || subtitle.text.empty?)
-          withtitle = withtitle || (subtitle && !subtitle.text.empty?)
-        end
-        notitle && withtitle &&
-          warn("#{label}: all subclauses must have a title, or none")
-      end
-
-      def title_validate(root)
-        title_intro_validate(root)
-        title_main_validate(root)
-        title_part_validate(root)
-        title_subpart_validate(root)
-        title_names_type_validate(root)
-        title_first_level_validate(root)
-        title_all_siblings(root.xpath(SECTIONS_XPATH), "(top level)")
-      end
-
       # ISO/IEC DIR 2, 22.3.2
       def onlychild_clause_validate(root)
         root.xpath(Standoc::Utils::SUBCLAUSE_XPATH).each do |c|
@@ -245,6 +153,19 @@ module Asciidoctor
         see_erefs_validate(doc.root)
         locality_erefs_validate(doc.root)
         bibdata_validate(doc.root)
+        bibitem_validate(doc.root)
+      end
+
+      def bibitem_validate(xmldoc)
+        xmldoc.xpath("//bibitem[date/on = '--']").each do |b|
+          found = false
+          b.xpath("./note").each do |n|
+            found = true if /^ISO DATE:/.match n.text
+          end
+          found or
+            warn "Reference #{b&.at("./@id")&.text} does not have an "\
+          "associated footnote indicating unpublished status"
+        end
       end
 
       def validate(doc)

data/lib/asciidoctor/iso/validate_title.rb

@@ -0,0 +1,99 @@
+require "metanorma-standoc"
+
+module Asciidoctor
+  module ISO
+    class Converter < Standoc::Converter
+      def title_intro_validate(root)
+        title_intro_en = root.at("//title[@type='title-intro' and @language='en']")
+        title_intro_fr = root.at("//title[@type='title-intro' and @language='fr']")
+        if title_intro_en.nil? && !title_intro_fr.nil?
+          warn "No English Title Intro!"
+        end
+        if !title_intro_en.nil? && title_intro_fr.nil?
+          warn "No French Title Intro!"
+        end
+      end
+
+      def title_main_validate(root)
+        title_main_en = root.at("//title[@type='title-main' and @language='en']")
+        title_main_fr = root.at("//title[@type='title-main' and @language='fr']")
+        if title_main_en.nil? && !title_main_fr.nil?
+          warn "No English Title!"
+        end
+        if !title_main_en.nil? && title_main_fr.nil?
+          warn "No French Title!"
+        end
+      end
+
+      def title_part_validate(root)
+        title_part_en = root.at("//title[@type='title-part' and @language='en']")
+        title_part_fr = root.at("//title[@type='title-part' and @language='fr']")
+        (title_part_en.nil? && !title_part_fr.nil?) &&
+          warn("No English Title Part!")
+        (!title_part_en.nil? && title_part_fr.nil?) &&
+          warn("No French Title Part!")
+      end
+
+      # ISO/IEC DIR 2, 11.4
+      def title_subpart_validate(root)
+        docid = root.at("//bibdata/docidentifier[@type = 'iso']")
+        subpart = /-\d+-\d+/.match docid
+        iec = root.at("//bibdata/contributor[role/@type = 'publisher']/"\
+                      "organization[abbreviation = 'IEC' or "\
+                      "name = 'International Electrotechnical Commission']")
+        warn("Subpart defined on non-IEC document!") if subpart && !iec
+      end
+
+      # ISO/IEC DIR 2, 11.5.2
+      def title_names_type_validate(root)
+        doctypes = /International\sStandard | Technical\sSpecification |
+        Publicly\sAvailable\sSpecification | Technical\sReport | Guide /xi
+        title_main_en = root.at("//title[@type='title-main' and @language='en']")
+        if !title_main_en.nil? && doctypes.match(title_main_en.text)
+          warn "Main Title may name document type"
+        end
+        title_intro_en = root.at("//title[@type='title-intro' and @language='en']")
+        if !title_intro_en.nil? && doctypes.match(title_intro_en.text)
+          warn "Title Intro may name document type"
+        end
+      end
+
+      # ISO/IEC DIR 2, 22.2
+      def title_first_level_validate(root)
+        root.xpath(SECTIONS_XPATH).each do |s|
+          title = s&.at("./title")&.text || s.name
+          s.xpath("./clause | ./terms | ./references").each do |ss|
+            subtitle = ss.at("./title")
+            !subtitle.nil? && !subtitle&.text&.empty? ||
+              warn("#{title}: each first-level subclause must have a title")
+          end
+        end
+      end
+
+      # ISO/IEC DIR 2, 22.2
+      def title_all_siblings(xpath, label)
+        notitle = false
+        withtitle = false
+        xpath.each do |s|
+          title_all_siblings(s.xpath("./clause | ./terms | ./references"),
+                             s&.at("./title")&.text || s["id"])
+          subtitle = s.at("./title")
+          notitle = notitle || (!subtitle || subtitle.text.empty?)
+          withtitle = withtitle || (subtitle && !subtitle.text.empty?)
+        end
+        notitle && withtitle &&
+          warn("#{label}: all subclauses must have a title, or none")
+      end
+
+      def title_validate(root)
+        title_intro_validate(root)
+        title_main_validate(root)
+        title_part_validate(root)
+        title_subpart_validate(root)
+        title_names_type_validate(root)
+        title_first_level_validate(root)
+        title_all_siblings(root.xpath(SECTIONS_XPATH), "(top level)")
+      end
+    end
+  end
+end

data/lib/isodoc/iso/html/isodoc.scss

@@ -15,6 +15,23 @@ p.Sourcecode, li.Sourcecode, div.Sourcecode, pre.Sourcecode
 	mso-fareast-font-family:Calibri;
 	mso-bidi-font-family:"Courier New";
 	mso-ansi-language:EN-GB;}
+p.pseudocode, li.pseudocode, div.pseudocode
+        {mso-style-unhide:no;
+        mso-style-qformat:yes;
+        mso-style-parent:"";
+        margin-top:0cm;
+        margin-right:0cm;
+        margin-bottom:12.0pt;
+        margin-left:0cm;
+        text-align:left;
+        line-height:12.0pt;
+        mso-pagination:widow-orphan;
+        tab-stops:20.15pt;
+        font-size:9.0pt;
+        font-family:$bodyfont;
+        mso-fareast-font-family:Calibri;
+        mso-bidi-font-family:"Courier New";
+        mso-ansi-language:EN-GB;}
 p.Biblio, li.Biblio, div.Biblio
 	{mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -738,6 +755,10 @@ div.example p.MsoListParagraph {
   font-size: 10.0pt;
 }
 
+div.Note p.MsoListParagraph {
+  font-size: 10.0pt;
+}
+
 span.note_label, span.example_label, td.example_label, td.note_label
 {
 font-size: 10.0pt;

data/lib/isodoc/iso/html/style-human.scss

@@ -627,7 +627,7 @@ font-family: $monospacefont;
 font-variant-ligatures: none;
 }
 
-.figure, .Sourcecode {
+.figure, .Sourcecode, .pseudocode {
 background-color: #f7f7f7;
 line-height: 1.6em;
 padding: 1.5em;
@@ -694,7 +694,7 @@ margin-left:-1.5em;
 }
 
 
-.example .Sourcecode {
+.example .Sourcecode, .example .pseudocode {
       background: none;
 }
 

data/lib/isodoc/iso/html/style-iso.scss

@@ -620,7 +620,7 @@ font-family: $monospacefont;
 font-variant-ligatures: none;
 }
 
-.figure, .Sourcecode {
+.figure, .Sourcecode, .pseudocode {
 background-color: #f7f7f7;
 line-height: 1.6em;
 padding: 1.5em;
@@ -685,7 +685,7 @@ margin-top:0;
 }
 
 
-.example .Sourcecode {
+.example .Sourcecode, .example .pseudocode {
       background: none;
 }
 

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module ISO
-    VERSION = "1.3.6".freeze
+    VERSION = "1.3.7".freeze
   end
 end

data/metanorma-iso.gemspec

@@ -29,7 +29,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
-  spec.add_dependency "asciidoctor", "~> 1.5.7"
   spec.add_dependency "ruby-jing"
   spec.add_dependency "isodoc", "~> 1.0.0"
   spec.add_dependency "metanorma-standoc", "~> 1.3.0"

data/spec/asciidoctor-iso/base_spec.rb

@@ -11,14 +11,14 @@ RSpec.describe Asciidoctor::ISO do
     #FileUtils.cd "spec/examples"
     #Asciidoctor.convert_file "rice.adoc", {:attributes=>{"backend"=>"iso"}, :safe=>0, :header_footer=>true, :requires=>["metanorma-iso"], :failure_level=>4, :mkdirs=>true, :to_file=>nil}
     #FileUtils.cd "../.."
-    #expect(File.exist?("spec/examples/rice.xml")).to be true
-    #expect(File.exist?("spec/examples/rice.doc")).to be true
-    #expect(File.exist?("spec/examples/rice.html")).to be true
-    #expect(File.exist?("spec/examples/rice_alt.html")).to be true
+    #expect(File.exist?("spec/examples/rice.xml"))).to be true
+    #expect(File.exist?("spec/examples/rice.doc"))).to be true
+    #expect(File.exist?("spec/examples/rice.html"))).to be true
+    #expect(File.exist?("spec/examples/rice_alt.html"))).to be true
   #end
 
   it "processes a blank document" do
-    expect(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)).to be_equivalent_to <<~"OUTPUT"
+    expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
     #{ASCIIDOC_BLANK_HDR}
     INPUT
     #{BLANK_HDR}
@@ -29,7 +29,7 @@ RSpec.describe Asciidoctor::ISO do
 
   it "converts a blank document" do
     FileUtils.rm_f "test.doc"
-    expect(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)).to be_equivalent_to <<~"OUTPUT"
+    expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       = Document title
       Author
       :docfile: test.adoc
@@ -45,7 +45,7 @@ RSpec.describe Asciidoctor::ISO do
   end
 
   it "processes default metadata" do
-    expect(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)).to be_equivalent_to <<~"OUTPUT"
+    expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       = Document title
       Author
       :docfile: test.adoc
@@ -168,7 +168,7 @@ RSpec.describe Asciidoctor::ISO do
 
 
   it "processes complex metadata" do
-    expect(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+    expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true))).to be_equivalent_to <<~'OUTPUT'
       = Document title
       Author
       :docfile: test.adoc
@@ -280,7 +280,7 @@ RSpec.describe Asciidoctor::ISO do
   end
 
     it "defaults substage" do
-    expect(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)).to be_equivalent_to <<~"OUTPUT"
+    expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       = Document title
       Author
       :docfile: test.adoc
@@ -342,7 +342,7 @@ OUTPUT
     end
 
         it "defaults substage for stage 60" do
-    expect(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)).to be_equivalent_to <<~"OUTPUT"
+    expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       = Document title
       Author
       :docfile: test.adoc
@@ -404,7 +404,7 @@ OUTPUT
     end
 
   it "populates metadata for PRF" do
-    expect(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)).to be_equivalent_to <<~"OUTPUT"
+    expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       = Document title
       Author
       :docfile: test.adoc