metanorma-iso 2.0.4 → 2.0.6.1

data/lib/metanorma/iso/validate_style.rb

@@ -70,8 +70,8 @@ module Metanorma
         style(node, extract_text(node))
       end
 
-      def style_regex(regex, warning, n, text)
-        (m = regex.match(text)) && style_warning(n, warning, m[:num])
+      def style_regex(regex, warning, node, text)
+        (m = regex.match(text)) && style_warning(node, warning, m[:num])
       end
 
       # style check with a regex on a token
@@ -96,10 +96,12 @@ module Metanorma
         style_percent(node, text)
         style_abbrev(node, text)
         style_units(node, text)
+        style_punct(node, text)
       end
 
       # ISO/IEC DIR 2, 9.1
       # ISO/IEC DIR 2, Table B.1
+      # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-n-numbers
       def style_number(node, text)
         style_two_regex_not_prev(
           node, text, /^(?<num>-?[0-9]{4,}[,0-9]*)\Z/,
@@ -110,6 +112,8 @@ module Metanorma
                     "possible decimal point", node, text)
         style_regex(/\b(?<num>billions?)\b/i,
                     "ambiguous number", node, text)
+        style_regex(/(^|\s)(?<num>-[0-9][0-9,.]*)/i,
+                    "hyphen instead of minus sign U+2212", node, text)
       end
 
       # ISO/IEC DIR 2, 9.2.1
@@ -158,6 +162,15 @@ module Metanorma
         end
       end
 
+      # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-p-and
+      # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-p-andor
+      def style_punct(node, text)
+        style_regex(/\b(?<num>and\/?or)\b/i,
+                    "Use 'either x or y, or both'", node, text)
+        style_regex(/\s(?<num>&)\s/i,
+                    "Avoid ampersand in ordinary text'", node, text)
+      end
+
       def style_warning(node, msg, text = nil)
         return if @novalid
 
@@ -165,6 +178,23 @@ module Metanorma
         w += ": #{text}" if text
         @log.add("Style", node, w)
       end
+
+      ASSETS_TO_STYLE =
+        "//termsource | //formula | //termnote | "\
+        "//p[not(ancestor::boilerplate)] | //li[not(p)] | //dt | "\
+        "//dd[not(p)] | //td[not(p)] | //th[not(p)]".freeze
+
+      def asset_style(root)
+        root.xpath("//example | //termexample").each { |e| example_style(e) }
+        root.xpath("//definition/verbal-definition").each do |e|
+          definition_style(e)
+        end
+        root.xpath("//note").each { |e| note_style(e) }
+        root.xpath("//fn").each { |e| footnote_style(e) }
+        root.xpath(ASSETS_TO_STYLE).each { |e| style(e, extract_text(e)) }
+        norm_bibitem_style(root)
+        super
+      end
     end
   end
 end

data/lib/metanorma/iso/validate_title.rb

@@ -68,7 +68,7 @@ module Metanorma
           title = s&.at("./title")&.text || s.name
           s.xpath("./clause | ./terms | ./references").each do |ss|
             subtitle = ss.at("./title")
-            !subtitle.nil? && !subtitle&.text&.empty? or
+            (!subtitle.nil? && !subtitle&.text&.empty?) or
               @log.add("Style", ss,
                        "#{title}: each first-level subclause must have a title")
           end
@@ -91,6 +91,17 @@ module Metanorma
                    "#{label}: all subclauses must have a title, or none")
       end
 
+      # https://www.iso.org/ISO-house-style.html#iso-hs-s-text-r-p-full
+      def title_no_full_stop_validate(root)
+        root.xpath("//preface//title | //sections//title | //annex//title | "\
+                   "//references/title | //preface//name | //sections//name | "\
+                   "//annex//name").each do |t|
+          style_regex(/\A(?<num>.+\.\Z)/i,
+                      "No full stop at end of title or caption",
+                      t, t.text.strip)
+        end
+      end
+
       def title_validate(root)
         title_intro_validate(root)
         title_main_validate(root)
@@ -99,6 +110,7 @@ module Metanorma
         title_names_type_validate(root)
         title_first_level_validate(root)
         title_all_siblings(root.xpath(SECTIONS_XPATH), "(top level)")
+        title_no_full_stop_validate(root)
       end
     end
   end

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module ISO
-    VERSION = "2.0.4".freeze
+    VERSION = "2.0.6.1".freeze
   end
 end

data/metanorma-iso.gemspec

@@ -46,6 +46,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sassc", "2.4.0"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
-  spec.add_development_dependency "vcr", "~> 5.0.0"
+  spec.add_development_dependency "vcr", "~> 6.1.0"
   spec.add_development_dependency "webmock"
 end

data/spec/isodoc/inline_spec.rb

@@ -437,12 +437,12 @@ RSpec.describe IsoDoc do
             <li><concept><refterm>term6</refterm>
               <renderterm>word</renderterm>
               <eref bibitemid="ISO712" type="inline" citeas="ISO 712">
-              <localityStack>
+              <localityStack connective="and">
                 <locality type='clause'>
                   <referenceFrom>3.1</referenceFrom>
                 </locality>
               </localityStack>
-              <localityStack>
+              <localityStack connective="and">
                 <locality type='figure'>
                   <referenceFrom>b</referenceFrom>
                 </locality>
@@ -452,12 +452,12 @@ RSpec.describe IsoDoc do
             <li><concept><refterm>term7</refterm>
               <renderterm>word</renderterm>
               <eref bibitemid="ISO712" type="inline" citeas="ISO 712">
-              <localityStack>
+              <localityStack connective="and">
                 <locality type='clause'>
                   <referenceFrom>3.1</referenceFrom>
                 </locality>
               </localityStack>
-              <localityStack>
+              <localityStack connective="and">
                 <locality type='figure'>
                   <referenceFrom>b</referenceFrom>
                 </locality>
@@ -537,25 +537,25 @@ RSpec.describe IsoDoc do
             </li>
             <li>
               <em>word</em>
-              (<eref bibitemid="ISO712" type="inline" citeas="ISO 712"><localityStack>
+              (<eref bibitemid="ISO712" type="inline" citeas="ISO 712"><localityStack connective="and">
                 <locality type="clause">
                   <referenceFrom>3.1</referenceFrom>
                 </locality>
-              </localityStack><localityStack>
+              </localityStack><localityStack connective="and">
                 <locality type="figure">
                   <referenceFrom>b</referenceFrom>
                 </locality>
-              </localityStack>ISO 712, 3.1; Figure b</eref>)
+              </localityStack>ISO 712, 3.1 and Figure b</eref>)
             </li>
             <li>
               <em>word</em>
               (<eref bibitemid="ISO712" type="inline" citeas="ISO 712">
-              <localityStack>
+              <localityStack connective="and">
                 <locality type="clause">
                   <referenceFrom>3.1</referenceFrom>
                 </locality>
               </localityStack>
-              <localityStack>
+              <localityStack connective="and">
                 <locality type="figure">
                   <referenceFrom>b</referenceFrom>
                 </locality>
@@ -658,7 +658,7 @@ RSpec.describe IsoDoc do
                    <li>
                      <i>word</i>
                       (
-                     <a href='#ISO712'>ISO 712, 3.1; Figure b</a>
+                     <a href='#ISO712'>ISO 712, 3.1 and Figure b</a>
                      )
                    </li>
                    <li>
@@ -947,4 +947,121 @@ RSpec.describe IsoDoc do
     expect(xmlpp(IsoDoc::Iso::HtmlConvert.new({})
       .convert("test", presxml, true))).to be_equivalent_to xmlpp(output)
   end
+
+  it "combines locality stacks with connectives, omitting subclauses" do
+    input = <<~INPUT
+      <itu-standard xmlns="https://www.calconnect.org/standards/itu">
+                  <p id='_'>
+              <eref type='inline' bibitemid='ref1' citeas='XYZ'>
+                <localityStack connective='from'>
+                  <locality type='clause'>
+                    <referenceFrom>3</referenceFrom>
+                  </locality>
+                </localityStack>
+                <localityStack connective='to'>
+                  <locality type='clause'>
+                    <referenceFrom>5</referenceFrom>
+                  </locality>
+                </localityStack>
+              </eref>
+              <eref type='inline' bibitemid='ref1' citeas='XYZ'>
+                <localityStack connective='from'>
+                  <locality type='clause'>
+                    <referenceFrom>3.1</referenceFrom>
+                  </locality>
+                </localityStack>
+                <localityStack connective='to'>
+                  <locality type='clause'>
+                    <referenceFrom>5.1</referenceFrom>
+                  </locality>
+                </localityStack>
+              </eref>
+              <eref type='inline' bibitemid='ref1' citeas='XYZ'>
+                <localityStack connective='from'>
+                  <locality type='clause'>
+                    <referenceFrom>3.1</referenceFrom>
+                  </locality>
+                </localityStack>
+                <localityStack connective='to'>
+                  <locality type='clause'>
+                    <referenceFrom>5</referenceFrom>
+                  </locality>
+                </localityStack>
+              </eref>
+              <eref type='inline' bibitemid='ref1' citeas='XYZ'>
+                <localityStack connective='from'>
+                  <locality type='clause'>
+                    <referenceFrom>3.1</referenceFrom>
+                  </locality>
+                </localityStack>
+                <localityStack connective='to'>
+                  <locality type='table'>
+                    <referenceFrom>5</referenceFrom>
+                  </locality>
+                </localityStack>
+              </eref>
+            </p>
+            </itu-standard>
+    INPUT
+    output = <<~OUTPUT
+      <itu-standard xmlns='https://www.calconnect.org/standards/itu' type='presentation'>
+        <p id='_'>
+          <eref type='inline' bibitemid='ref1' citeas='XYZ' droploc=''>
+            <localityStack connective='from'>
+              <locality type='clause'>
+                <referenceFrom>3</referenceFrom>
+              </locality>
+            </localityStack>
+            <localityStack connective='to'>
+              <locality type='clause'>
+                <referenceFrom>5</referenceFrom>
+              </locality>
+            </localityStack>
+            XYZ, Clause 3 to 5
+          </eref>
+          <eref type='inline' bibitemid='ref1' citeas='XYZ' droploc=''>
+            <localityStack connective='from'>
+              <locality type='clause'>
+                <referenceFrom>3.1</referenceFrom>
+              </locality>
+            </localityStack>
+            <localityStack connective='to'>
+              <locality type='clause'>
+                <referenceFrom>5.1</referenceFrom>
+              </locality>
+            </localityStack>
+            XYZ, 3.1 to 5.1
+          </eref>
+          <eref type='inline' bibitemid='ref1' citeas='XYZ'>
+            <localityStack connective='from'>
+              <locality type='clause'>
+                <referenceFrom>3.1</referenceFrom>
+              </locality>
+            </localityStack>
+            <localityStack connective='to'>
+              <locality type='clause'>
+                <referenceFrom>5</referenceFrom>
+              </locality>
+            </localityStack>
+            XYZ, 3.1 to Clause 5
+          </eref>
+          <eref type='inline' bibitemid='ref1' citeas='XYZ'>
+            <localityStack connective='from'>
+              <locality type='clause'>
+                <referenceFrom>3.1</referenceFrom>
+              </locality>
+            </localityStack>
+            <localityStack connective='to'>
+              <locality type='table'>
+                <referenceFrom>5</referenceFrom>
+              </locality>
+            </localityStack>
+            XYZ, 3.1 to Table 5
+          </eref>
+        </p>
+      </itu-standard>
+    OUTPUT
+    expect(xmlpp(IsoDoc::Iso::PresentationXMLConvert.new({})
+      .convert("test", input, true))).to be_equivalent_to xmlpp(output)
+  end
 end

data/spec/isodoc/postproc_spec.rb

@@ -222,7 +222,7 @@ RSpec.describe IsoDoc do
       .sub(%r{<br[^>]*>\s*<div class="colophon".*$}m, "")
 
     expect(xmlpp(word)).to be_equivalent_to xmlpp(<<~"OUTPUT")
-           <div class='WordSection3'>
+      <div class='WordSection3'>
          <p class='zzSTDTitle1'/>
          <div>
            <a name='_terms_and_definitions' id='_terms_and_definitions'/>
@@ -241,9 +241,7 @@ RSpec.describe IsoDoc do
              rice retaining its husk after threshing
            </p>
            <p class='Source'>
-             [SOURCE:
-             <a href='#ISO7301'>ISO 7301:2011, 3.1</a>
-             , modified &#x2013; The term "cargo rice" is shown as deprecated, and Note
+             [SOURCE: ISO 7301:2011, 3.1, modified &#x2013; The term "cargo rice" is shown as deprecated, and Note
              1 to entry is not included here]
            </p>
          </div>

data/spec/isodoc/terms_spec.rb

@@ -161,7 +161,7 @@ RSpec.describe IsoDoc do
                 </ul>
               </div>
               <p>[SOURCE:
-                <a href="#ISO7301">ISO 7301:2011, 3.1</a>, modified &#8211;
+                ISO 7301:2011, 3.1, modified &#8211;
                   The term "cargo rice" is shown as deprecated, and Note 1 to entry is not included here]</p>
               <p class="TermNum" id="paddy">1.2</p>
               <p class="Terms" style="text-align:left;"><b>paddy</b></p>
@@ -187,7 +187,7 @@ RSpec.describe IsoDoc do
                   <p id="_19830f33-e46c-42cc-94ca-a5ef101132d5">The starch of waxy rice consists almost entirely of amylopectin. The kernels have a tendency to stick together after cooking.</p>
                 </p>
               </div>
-              <p>[SOURCE: <a href="#ISO7301">ISO 7301:2011, 3.1</a>]</p>
+              <p>[SOURCE: ISO 7301:2011, 3.1]</p>
               <p class='TermNum' id='A'>1.3</p>
               <p class='Terms' style='text-align:left;'><b>term1</b></p>
                term1 definition
@@ -213,7 +213,7 @@ RSpec.describe IsoDoc do
           </ul></div>
 
         <p class="Source">[SOURCE:
-          <a href="#ISO7301">ISO 7301:2011, 3.1</a>, modified &#8211;
+          ISO 7301:2011, 3.1, modified &#8211;
             The term "cargo rice" is shown as deprecated, and Note 1 to entry is not included here]</p>
         <p class="TermNum" id="paddy">1.2</p>
         <p class="Terms" style="text-align:left;"><b>paddy</b></p>
@@ -228,7 +228,7 @@ RSpec.describe IsoDoc do
         </div>
         <div id='_671a1994-4783-40d0-bc81-987d06ffb74e' class="Note"><p class="Note">Note 1 to entry: The starch of waxy rice consists almost entirely of amylopectin. The kernels have a tendency to stick together after cooking.</p></div>
         <div id='_671a1994-4783-40d0-bc81-987d06ffb74f' class="Note"><p class="Note">Note 2 to entry: <ul><li>A</li></ul><p id="_19830f33-e46c-42cc-94ca-a5ef101132d5">The starch of waxy rice consists almost entirely of amylopectin. The kernels have a tendency to stick together after cooking.</p></p></div>
-        <p class="Source">[SOURCE: <a href="#ISO7301">ISO 7301:2011, 3.1</a>]</p>
+        <p class="Source">[SOURCE: ISO 7301:2011, 3.1]</p>
         <p class='TermNum' id='A'>1.3</p>
         <p class='Terms' style='text-align:left;'><b>term1</b></p>
          term1 definition

data/spec/metanorma/cleanup_spec.rb

@@ -137,7 +137,7 @@ RSpec.describe Metanorma::ISO do
           <terms id="_" obligation="normative">
             <title>Terms and definitions</title>
             #{TERM_BOILERPLATE}
-            <term id="term-_-t90-">
+            <term id="term-t90">
               <preferred>
                 <letter-symbol><name>
                 <stem type="MathML">
@@ -1247,13 +1247,13 @@ RSpec.describe Metanorma::ISO do
               <li>
                 <p id='_'>
                   ISO Online browsing platform: available at
-                  <link target='http://www.iso.org/obp'/>
+                  <link target='https://www.iso.org/obp'/>
                 </p>
               </li>
               <li>
                 <p id='_'>
                   IEC Electropedia: available at
-                  <link target='http://www.electropedia.org'/>
+                  <link target='https://www.electropedia.org'/>
                 </p>
               </li>
             </ul>
@@ -1296,13 +1296,13 @@ RSpec.describe Metanorma::ISO do
                 <li>
                   <p id='_'>
                     ISO Online browsing platform: available at
-                    <link target='http://www.iso.org/obp'/>
+                    <link target='https://www.iso.org/obp'/>
                   </p>
                 </li>
                 <li>
                   <p id='_'>
                     IEC Electropedia: available at
-                    <link target='http://www.electropedia.org'/>
+                    <link target='https://www.electropedia.org'/>
                   </p>
                 </li>
               </ul>
@@ -1360,13 +1360,13 @@ RSpec.describe Metanorma::ISO do
                   <li>
                     <p id='_'>
                       ISO Online browsing platform: available at
-                      <link target='http://www.iso.org/obp'/>
+                      <link target='https://www.iso.org/obp'/>
                     </p>
                   </li>
                   <li>
                     <p id='_'>
                       IEC Electropedia: available at
-                      <link target='http://www.electropedia.org'/>
+                      <link target='https://www.electropedia.org'/>
                     </p>
                   </li>
                 </ul>
@@ -1427,13 +1427,13 @@ RSpec.describe Metanorma::ISO do
                   <li>
                     <p id='_'>
                       ISO Online browsing platform: available at
-                      <link target='http://www.iso.org/obp'/>
+                      <link target='https://www.iso.org/obp'/>
                     </p>
                   </li>
                   <li>
                     <p id='_'>
                       IEC Electropedia: available at
-                      <link target='http://www.electropedia.org'/>
+                      <link target='https://www.electropedia.org'/>
                     </p>
                   </li>
                 </ul>
@@ -1485,13 +1485,13 @@ RSpec.describe Metanorma::ISO do
               <li>
                 <p id='_'>
                   ISO Online browsing platform: available at
-                  <link target='http://www.iso.org/obp'/>
+                  <link target='https://www.iso.org/obp'/>
                 </p>
               </li>
               <li>
                 <p id='_'>
                   IEC Electropedia: available at
-                  <link target='http://www.electropedia.org'/>
+                  <link target='https://www.electropedia.org'/>
                 </p>
               </li>
             </ul>