metanorma-iso 2.0.2 → 2.0.5

data/spec/metanorma/validate_spec.rb

@@ -733,6 +733,17 @@ RSpec.describe Metanorma::ISO do
       .to include "space between number and degrees/minutes/seconds"
   end
 
+  it "Style warning if hyphen instead of minus sign" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+      -2
+    INPUT
+    expect(File.read("test.err"))
+      .to include "hyphen instead of minus sign U+2212"
+  end
+
   it "Style warning if no space between number and SI unit" do
     Asciidoctor.convert(<<~"INPUT", *OPTIONS)
       #{VALIDATING_BLANK_HDR}
@@ -754,6 +765,61 @@ RSpec.describe Metanorma::ISO do
     expect(File.read("test.err")).to include "non-standard unit"
   end
 
+  it "Style warning if and/or used" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+      7 and/or 8
+    INPUT
+    expect(File.read("test.err")).to include "Use 'either x or y, or both'"
+  end
+
+  it "Style warning if & used" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+      7 & 8
+    INPUT
+    expect(File.read("test.err")).to include "Avoid ampersand in ordinary text"
+  end
+
+  it "Style warning if full stop used in title or caption" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause.
+
+      .Table.
+      |===
+      | A |B
+      |===
+
+      === Clause 2.
+
+      .Figure.
+      ....
+      Z
+      ....
+
+      .Other Figure
+      ....
+      A
+      ....
+    INPUT
+    expect(File.read("test.err"))
+      .to include "No full stop at end of title or caption: Clause."
+    expect(File.read("test.err"))
+      .to include "No full stop at end of title or caption: Clause 2."
+    expect(File.read("test.err"))
+      .to include "No full stop at end of title or caption: Table."
+    expect(File.read("test.err"))
+      .to include "No full stop at end of title or caption: Figure."
+    expect(File.read("test.err"))
+      .not_to include "No full stop at end of title or caption: Other Figure."
+  end
+
   # can't test: our asciidoc template won't allow this to be generated
   # it "Style warning if foreword contains subclauses" do
   # expect { Asciidoctor.convert(<<~"INPUT", *OPTIONS) }
@@ -812,8 +878,7 @@ RSpec.describe Metanorma::ISO do
     INPUT
     expect(File.read("test.err"))
       .not_to include "Symbols and Abbreviated Terms can only contain "\
-                  "a definition list"
-
+                      "a definition list"
   end
 
   it "Warning if missing foreword" do
@@ -1204,6 +1269,97 @@ RSpec.describe Metanorma::ISO do
       .to include "Only annexes and references can follow terms and clauses"
   end
 
+  it "No warning if there are two Symbols sections in a Vocabulary document" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :no-isobib:
+      :docsubtype: vocabulary
+
+      == Scope
+
+      == Terms and definitions
+
+      == A Clause
+
+      [heading=symbols and abbreviated terms]
+      == Terms related to clinical psychology
+
+      [heading=symbols and abbreviated terms]
+      == Symbols related to clinical psychology
+
+    INPUT
+    expect(File.read("test.err"))
+      .not_to include "Only one Symbols and Abbreviated Terms section "\
+                      "in the standard"
+  end
+
+  it "Warn if single terms section in vocabulary document not named properly" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :no-isobib:
+      :docsubtype: vocabulary
+
+      == Scope
+      [heading=terms and definitions]
+      == Terms and redefinitions
+
+    INPUT
+    expect(File.read("test.err"))
+      .to include "Single terms clause in vocabulary document should have normal Terms and definitions heading"
+    expect(File.read("test.err"))
+      .not_to include "Multiple terms clauses in vocabulary document should have 'Terms related to' heading"
+  end
+
+
+  it "Warn if vocabulary document contains Symbols section outside annex" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :no-isobib:
+      :docsubtype: vocabulary
+
+      == Scope
+
+      == Terms and definitions
+
+      == A Clause
+
+      [heading=symbols and abbreviated terms]
+      == Terms related to clinical psychology
+
+    INPUT
+    expect(File.read("test.err"))
+      .to include "In vocabulary documents, Symbols and Abbreviated Terms are only permitted in annexes"
+  end
+
+  it "Warning if multiple terms section in vocabulary document not named properly" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :no-isobib:
+      :docsubtype: vocabulary
+
+      == Terms and definitions
+
+      [heading=terms and definitions]
+      == Terms related to fish
+
+    INPUT
+    expect(File.read("test.err"))
+      .not_to include "Single terms clause in vocabulary document should have normal Terms and definitions heading"
+    expect(File.read("test.err"))
+      .to include "Multiple terms clauses in vocabulary document should have 'Terms related to' heading"
+  end
 
   it "Warning if final section is not named Bibliography" do
     Asciidoctor.convert(<<~"INPUT", *OPTIONS)
@@ -1631,12 +1787,7 @@ RSpec.describe Metanorma::ISO do
 
   it "Warn if more than 7 levels of subclause" do
     Asciidoctor.convert(<<~"INPUT", *OPTIONS)
-      = Document title
-      Author
-      :docfile: test.adoc
-      :nodoc:
-      :no-isobib:
-      :language: fr
+      #{VALIDATING_BLANK_HDR}
 
       == Clause
 
@@ -1664,12 +1815,7 @@ RSpec.describe Metanorma::ISO do
 
   it "Do not warn if not more than 7 levels of subclause" do
     Asciidoctor.convert(<<~"INPUT", *OPTIONS)
-      = Document title
-      Author
-      :docfile: test.adoc
-      :nodoc:
-      :no-isobib:
-      :language: fr
+      #{VALIDATING_BLANK_HDR}
 
       == Clause
 
@@ -1704,4 +1850,293 @@ RSpec.describe Metanorma::ISO do
       .to include "Reference ISO8 does not have an associated footnote "\
                   "indicating unpublished status"
   end
+
+  it "Warn if no colon or full stop before list" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+
+      X
+
+      * A very long
+      * B list
+      * C
+    INPUT
+    expect(File.read("test.err"))
+      .to include "All lists must be preceded by colon or full stop"
+  end
+
+  it "Do not warn if colon or full stop before list" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+
+      X.
+
+      * A very long
+      * B list
+      * C
+
+      X:
+
+      . A very long
+      . B list
+      . C
+    INPUT
+    expect(File.read("test.err"))
+      .not_to include "All lists must be preceded by colon or full stop"
+  end
+
+  it "Warn of list punctuation after colon" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+
+      X:
+
+      * this is;
+      * another broken up;
+      * Sentence.
+
+      X:
+
+      . this is
+      . another broken up;
+      . sentence
+
+      X:
+
+      . sentence.
+
+      X:
+
+      . This is.
+      . Another broken up.
+      . Sentence.
+    INPUT
+    expect(File.read("test.err"))
+      .to include "List entry of broken up sentence must start with lowercase letter: Sentence."
+    expect(File.read("test.err"))
+      .not_to include "List entry of broken up sentence must start with lowercase letter: another broken up;."
+    expect(File.read("test.err"))
+      .to include "List entry of broken up sentence must end with semicolon: this is"
+    expect(File.read("test.err"))
+      .to include "Final list entry of broken up sentence must end with full stop: sentence"
+    expect(File.read("test.err"))
+      .not_to include "Final list entry of broken up sentence must end with full stop: sentence."
+    expect(File.read("test.err"))
+      .not_to include "List entry of broken up sentence must start with lowercase letter: Another broken up."
+    expect(File.read("test.err"))
+      .not_to include "List entry of broken up sentence must end with semicolon: This is."
+  end
+
+  it "Warn of list punctuation after full stop" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+
+      X.
+
+      * This is;
+      * Another broken up.
+      * sentence.
+
+    INPUT
+    expect(File.read("test.err"))
+      .to include "List entry of separate sentences must end with full stop: This is;"
+    expect(File.read("test.err"))
+      .not_to include "List entry of separate sentences must end with full stop: Another broken up."
+    expect(File.read("test.err"))
+      .to include "List entry of separate sentences must start with uppercase letter: sentence."
+  end
+
+  it "Skips punctuation check for short entries in lists" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+
+      X.
+
+      * This is
+      * Another
+      * sentence
+
+    INPUT
+    expect(File.read("test.err"))
+      .not_to include "List entry after full stop must end with full stop: This is"
+  end
+
+  it "Skips punctuation check for lists within tables" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+
+      |===
+      | A
+      a|
+      * This is
+      * Another
+      * sentence
+      |===
+
+    INPUT
+    expect(File.read("test.err"))
+      .not_to include "List entry after full stop must end with full stop: This is"
+  end
+
+  it "Warn if more than one ordered lists in a clause" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+
+      . A
+      .. B
+      ... C
+
+      a
+
+      . A
+      .. B
+
+      a
+
+      . B
+
+    INPUT
+    expect(File.read("test.err"))
+      .to include "More than 1 ordered list in a numbered clause"
+
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+
+      . A
+      .. B
+      ... C
+
+      === Clause
+      a
+
+      . A
+      .. B
+
+      a
+
+    INPUT
+    expect(File.read("test.err"))
+      .not_to include "More than 1 ordered list in a numbered clause"
+  end
+
+  it "Warn if list more than four levels deep" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+
+      . A
+      .. B
+      ... C
+      .... D
+
+    INPUT
+    expect(File.read("test.err"))
+      .not_to include "List more than four levels deep"
+
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+
+      . A
+      .. B
+      ... C
+      .... D
+      ..... E
+
+    INPUT
+    expect(File.read("test.err"))
+      .to include "List more than four levels deep"
+
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+
+      * A
+      ** B
+      *** C
+      **** D
+      ***** E
+
+    INPUT
+    expect(File.read("test.err"))
+      .to include "List more than four levels deep"
+
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Clause
+
+      * A
+      .. B
+      *** C
+      .... D
+      ***** E
+
+    INPUT
+    expect(File.read("test.err"))
+      .to include "List more than four levels deep"
+  end
+
+  it "warn if term clause crossreferences non-term reference" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Terms and definitions
+
+      [[b]]
+      === Term 1
+      <<b>>
+      <<c>>
+
+      [[c]]
+      == Clause
+
+    INPUT
+    expect(File.read("test.err"))
+      .to include "non-terms clauses cannot cross-reference terms clause (c)"
+    expect(File.read("test.err"))
+      .not_to include "non-terms clauses cannot cross-reference terms clause (b)"
+  end
+
+
+  it "warn if non-term clause crossreferences term reference" do
+    Asciidoctor.convert(<<~"INPUT", *OPTIONS)
+      #{VALIDATING_BLANK_HDR}
+
+      == Terms and definitions
+
+      [[b]]
+      === Term 1
+      <<b>>
+      <<c>>
+
+      == Clause
+      <<b>>
+      <<c>>
+
+    INPUT
+    expect(File.read("test.err"))
+      .to include "only terms clauses can cross-reference terms clause (b)"
+    expect(File.read("test.err"))
+      .not_to include "only terms clauses can cross-reference terms clause (c)"
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require "vcr"
-  
+
 VCR.configure do |config|
   config.cassette_library_dir = "spec/vcr_cassettes"
   config.hook_into :webmock
@@ -51,7 +51,9 @@ def strip_guid(xml)
 end
 
 def metadata(hash)
-  Hash[hash.sort].delete_if { |_, v| v.nil? || v.respond_to?(:empty?) && v.empty? }
+  hash.sort.to_h.delete_if do |_, v|
+    v.nil? || (v.respond_to?(:empty?) && v.empty?)
+  end
 end
 
 def xmlpp(xml)
@@ -216,11 +218,11 @@ TERM_BOILERPLATE = <<~TERM.freeze
   <ul id="_">
     <li>
       <p id="_">ISO Online browsing platform: available at
-        <link target="http://www.iso.org/obp"/></p>
+        <link target="http://www.iso.org/obp"/>.</p>
     </li>
     <li>
       <p id="_">IEC Electropedia: available at
-        <link target="http://www.electropedia.org"/>
+        <link target="http://www.electropedia.org"/>.
       </p>
     </li>
   </ul>