metanorma-standoc 1.1.4 → 1.1.5

data/lib/asciidoctor/standoc/reqt.rng

@@ -0,0 +1,157 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Presupposes isodoc.rnc, is included in it
+    include "isodoc.rnc" { }
+  -->
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="recommendation">
+    <element name="recommendation">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="permission">
+    <element name="permission">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="RequirementType">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <optional>
+      <ref name="subject"/>
+    </optional>
+    <optional>
+      <ref name="reqinherit"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <choice>
+        <ref name="measurementtarget"/>
+        <ref name="specification"/>
+        <ref name="verification"/>
+        <ref name="import"/>
+        <ref name="description"/>
+      </choice>
+    </zeroOrMore>
+    <optional>
+      <ref name="reqt_references"/>
+    </optional>
+    <zeroOrMore>
+      <choice>
+        <ref name="requirement"/>
+        <ref name="recommendation"/>
+        <ref name="permission"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <define name="reqtitle">
+    <element name="title">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="label">
+    <element name="label">
+      <text/>
+    </element>
+  </define>
+  <define name="subject">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="reqinherit">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="measurementtarget">
+    <element name="measurement-target">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="specification">
+    <element name="specification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="verification">
+    <element name="verification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="import">
+    <element name="import">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="description">
+    <element name="description">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="reqt_references">
+    <element name="references">
+      <oneOrMore>
+        <ref name="bibitem"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="RequirementSubpart">
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="exclude">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="ObligationType">
+    <choice>
+      <value>requirement</value>
+      <value>recommendation</value>
+      <value>permission</value>
+    </choice>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
+</grammar>

data/lib/asciidoctor/standoc/utils.rb

@@ -116,7 +116,8 @@ module Asciidoctor
         ::Nokogiri::XML::Builder.with fragment, &block
         fragment.to_xml(encoding: "US-ASCII").lines.map do |l|
           #l.gsub(/(?<!\s)\n/, " ")
-          l.sub(/\n$/, " ")
+          #l.sub(/\n$/, " ")
+          l.sub(/\s*\n$/, " ")
         end
       end
 

data/lib/asciidoctor/standoc/validate.rb

@@ -11,11 +11,19 @@ module Asciidoctor
 
       SOURCELOCALITY = "./termsource/origin/locality[@type = 'clause']/referenceFrom".freeze
 
+      def init_iev
+        return nil if @no_isobib
+        return @iev if @iev
+        @iev = Iev::Db.new(@iev_globalname, @iev_localname) unless @no_isobib
+        @iev
+      end
+
       def iev_validate(xmldoc)
         xmldoc.xpath("//term").each do |t|
           /^IEC 60050-/.match(t&.at("./termsource/origin/@citeas")&.text) or next
           pref = t.xpath("./preferred").inject([]) { |m, x| m << x&.text&.downcase }
           locality = t.xpath(SOURCELOCALITY)&.text or next
+          @iev = init_iev or return
           iev = @iev.fetch(locality, xmldoc&.at("//language")&.text || "en") or next
           pref.include?(iev.downcase) or
             warn %(Term "#{pref[0]}" does not match IEV #{locality} "#{iev}")

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-    VERSION = "1.1.4".freeze
+    VERSION = "1.1.5".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
     This gem is in active development.
   DESCRIPTION
 
-  spec.homepage      = "https://github.com/riboseinc/metanorma-standoc"
+  spec.homepage      = "https://github.com/metanorma/metanorma-standoc"
   spec.license       = "BSD-2-Clause"
 
   spec.bindir        = "bin"
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "asciidoctor", "~> 1.5.7"
   spec.add_dependency "ruby-jing"
   spec.add_dependency "isodoc", "~> 0.9.0"
-  spec.add_dependency "iev", "~> 0.2.0"
+  spec.add_dependency "iev", "~> 0.2.1"
   spec.add_dependency "relaton", "~> 0.3.1"
   spec.add_dependency "sterile", "~> 1.0.14"
   spec.add_dependency "concurrent-ruby"

data/spec/asciidoctor-standoc/blocks_spec.rb

@@ -1,4 +1,5 @@
 require "spec_helper"
+require "open3"
 
 RSpec.describe Asciidoctor::Standoc do
     it "processes pass blocks" do
@@ -598,6 +599,27 @@ RSpec.describe Asciidoctor::Standoc do
       OUTPUT
     end
 
+    it "processes preambles with titles" do
+      expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to <<~"OUTPUT"
+      #{ASCIIDOC_BLANK_HDR}
+      .Preamble
+      This is a preamble
+
+      == Section 1
+      INPUT
+      #{BLANK_HDR}
+             <preface><foreword obligation="informative">
+         <title>Preamble</title>
+         <p id="_">This is a preamble</p>
+       </foreword></preface><sections>
+       <clause id="_" inline-header="false" obligation="normative">
+         <title>Section 1</title>
+       </clause></sections>
+       </standard-document>
+      OUTPUT
+    end
+
+
     it "processes images" do
       expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to <<~"OUTPUT"
       #{ASCIIDOC_BLANK_HDR}
@@ -616,17 +638,17 @@ RSpec.describe Asciidoctor::Standoc do
       OUTPUT
     end
 
-    it "accepts width and height attributes on images" do
+    it "accepts attributes on images" do
       expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to <<~"OUTPUT"
       #{ASCIIDOC_BLANK_HDR}
-      [height=4,width=3]
+      [height=4,width=3,alt="IMAGE",filename="riceimg1.png"]
       image::spec/examples/rice_images/rice_image1.png[]
 
       INPUT
       #{BLANK_HDR}
               <sections>
          <figure id="_">
-         <image src="spec/examples/rice_images/rice_image1.png" id="_" imagetype="PNG" height="4" width="3"/>
+         <image src="spec/examples/rice_images/rice_image1.png" id="_" imagetype="PNG" height="4" width="3" alt="IMAGE" filename="riceimg1.png"/>
        </figure>
        </sections>
        </standard-document>
@@ -718,7 +740,7 @@ RSpec.describe Asciidoctor::Standoc do
       expect(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to <<~"OUTPUT"
       #{ASCIIDOC_BLANK_HDR}
       .Caption
-      [source,ruby]
+      [source,ruby,filename=sourcecode1.rb]
       --
       puts "Hello, world."
       %w{a b c}.each do |x|
@@ -728,7 +750,7 @@ RSpec.describe Asciidoctor::Standoc do
       INPUT
       #{BLANK_HDR}
        <sections>
-         <sourcecode id="_" lang="ruby"><name>Caption</name>puts "Hello, world."
+         <sourcecode id="_" lang="ruby" filename="sourcecode1.rb"><name>Caption</name>puts "Hello, world."
        %w{a b c}.each do |x|
          puts x
        end</sourcecode>
@@ -924,7 +946,7 @@ RSpec.describe Asciidoctor::Standoc do
         it "processes recommendation with internal markup of structure" do
     input = <<~"INPUT"
       #{ASCIIDOC_BLANK_HDR}
-      [recommendation,label="/ogc/recommendation/wfs/2",subject="user",classification="control-class:Technical;priority:P0;family:System and Communications Protection,System and Communications Protocols",obligation="permission,recommendation"]
+      [recommendation,label="/ogc/recommendation/wfs/2",subject="user",classification="control-class:Technical;priority:P0;family:System and Communications Protection,System and Communications Protocols",obligation="permission,recommendation",filename="reqt1.rq"]
       ====
       I recommend _this_.
 
@@ -973,7 +995,7 @@ RSpec.describe Asciidoctor::Standoc do
              output = <<~"OUTPUT"
             #{BLANK_HDR}
        <sections>
-       <recommendation id="_"  obligation="permission,recommendation"><label>/ogc/recommendation/wfs/2</label><subject>user</subject>
+       <recommendation id="_"  obligation="permission,recommendation" filename="reqt1.rq"><label>/ogc/recommendation/wfs/2</label><subject>user</subject>
 <classification><tag>control-class</tag><value>Technical</value></classification><classification><tag>priority</tag><value>P0</value></classification><classification><tag>family</tag><value>System and Communications Protection</value></classification><classification><tag>family</tag><value>System and Communications Protocols</value></classification>
         <description><p id="_">I recommend <em>this</em>.</p>
        </description><specification exclude="false" type="tabular"><p id="_">This is the object of the recommendation:</p><table id="_">  <tbody>    <tr>      <td align="left">Object</td>      <td align="left">Value</td>    </tr>    <tr>      <td align="left">Mission</td>      <td align="left">Accomplished</td>    </tr>  </tbody></table></specification><description>

data/spec/asciidoctor-standoc/isobib_cache_spec.rb

@@ -119,7 +119,7 @@ EOS
   it "flushes biblio caches" do
     relaton_bib_file  = File.expand_path("~/.relaton/cache")
     relaton_bib_file1 = File.expand_path("~/.relaton-bib.pstore1")
-    iev_file          = File.expand_path("~/.iev.pstore")
+    iev_file          = File.expand_path("~/.iev/cache")
     iev_file1         = File.expand_path("~/.iev.pstore1")
     FileUtils.rm_rf relaton_bib_file1 if File.exist? relaton_bib_file1
     FileUtils.mv relaton_bib_file, relaton_bib_file1 if File.exist? relaton_bib_file
@@ -127,7 +127,7 @@ EOS
     FileUtils.mv iev_file, iev_file1 if File.exist? iev_file
 
     File.open("#{Dir.home}/.relaton/cache", "w") { |f| f.write "XXX" }
-    FileUtils.rm_rf File.expand_path("~/.iev.pstore")
+    FileUtils.rm_rf File.expand_path("~/.iev/cache")
 
     # mock_isobib_get_123
     VCR.use_cassette "isobib_get_123" do
@@ -140,7 +140,22 @@ EOS
       INPUT
     end
     expect(File.exist?("#{Dir.home}/.relaton/cache")).to be true
-    expect(File.exist?("#{Dir.home}/.iev.pstore")).to be true
+    expect(File.exist?("#{Dir.home}/.iev/cache")).to be false
+
+    mock_open_uri('103-01-02')
+      Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)
+    [bibliography]
+    == Normative References
+    * [[[iev,IEV]]], _iev_
+
+    == Terms and definitions
+    === Automation
+
+    [.source]
+    <<iev,clause="103-01-02">>
+    INPUT
+    expect(File.exist?("#{Dir.home}/.iev/cache")).to be true
+
 
     db = Relaton::Db.new "#{Dir.home}/.relaton/cache", nil
     entry = db.load_entry("ISO(ISO 123:2001)")
@@ -148,9 +163,9 @@ EOS
     expect(entry).to be_equivalent_to(ISO_123_DATED)
 
     FileUtils.rm_rf File.expand_path("~/.relaton/cache")
-    FileUtils.rm_rf File.expand_path("~/.iev.pstore")
+    FileUtils.rm_rf File.expand_path("~/.iev/cache")
     FileUtils.mv File.expand_path("~/.relaton-bib.pstore1"), File.expand_path("~/.relaton/cache"), force: true
-    FileUtils.mv File.expand_path("~/.iev.pstore1"), File.expand_path("~/.iev.pstore"), force: true
+    FileUtils.mv File.expand_path("~/.iev.pstore1"), File.expand_path("~/.iev/cache"), force: true
   end
 
   it "does not fetch references for ISO references in preparation" do

data/spec/asciidoctor-standoc/validate_spec.rb

@@ -73,8 +73,8 @@ it "validates document against ISO XML schema" do
 end
 
 it "Warning if terms mismatches IEV" do
-  FileUtils.mv File.expand_path("~/.iev.pstore"), File.expand_path("~/.iev.pstore1"), force: true
-  FileUtils.rm_f "test.iev.pstore"
+  FileUtils.mv File.expand_path("~/.iev/cache"), File.expand_path("~/.iev.pstore1"), force: true
+  FileUtils.rm_f "test_iev/pstore"
   mock_open_uri('103-01-02')
   expect { Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true) }.to output(%r{Term "automation" does not match IEV 103-01-02 "functional"}).to_stderr
   = Document title
@@ -91,12 +91,12 @@ it "Warning if terms mismatches IEV" do
   [.source]
   <<iev,clause="103-01-02">>
   INPUT
-  FileUtils.mv File.expand_path("~/.iev.pstore1"), File.expand_path("~/.iev.pstore"), force: true
+  FileUtils.mv File.expand_path("~/.iev.pstore1"), File.expand_path("~/.iev/cache"), force: true
 end
 
 it "No warning if English term matches IEV" do
-  FileUtils.mv File.expand_path("~/.iev.pstore"), File.expand_path("~/.iev.pstore1"), force: true
-  FileUtils.rm_f "test.iev.pstore"
+  FileUtils.mv File.expand_path("~/.iev/cache"), File.expand_path("~/.iev.pstore1"), force: true
+  FileUtils.rm_f "test_iev/cache"
   mock_open_uri('103-01-02')
   expect { Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true) }.not_to output(%r{does not match IEV 103-01-02}).to_stderr
   = Document title
@@ -113,12 +113,12 @@ it "No warning if English term matches IEV" do
   [.source]
   <<iev,clause="103-01-02">>
   INPUT
-  FileUtils.mv File.expand_path("~/.iev.pstore1"), File.expand_path("~/.iev.pstore"), force: true
+  FileUtils.mv File.expand_path("~/.iev.pstore1"), File.expand_path("~/.iev/cache"), force: true
 end
 
 it "No warning if French term matches IEV" do
-  FileUtils.mv File.expand_path("~/.iev.pstore"), File.expand_path("~/.iev.pstore1"), force: true
-  FileUtils.rm_f "test.iev.pstore"
+  FileUtils.mv File.expand_path("~/.iev/cache"), File.expand_path("~/.iev.pstore1"), force: true
+  FileUtils.rm_f "test_iev/cache"
   mock_open_uri('103-01-02')
   expect { Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true) }.not_to output(%r{does not match IEV 103-01-02}).to_stderr
   = Document title
@@ -137,7 +137,7 @@ it "No warning if French term matches IEV" do
   [.source]
   <<iev,clause="103-01-02">>
   INPUT
-  FileUtils.mv File.expand_path("~/.iev.pstore1"), File.expand_path("~/.iev.pstore"), force: true
+  FileUtils.mv File.expand_path("~/.iev.pstore1"), File.expand_path("~/.iev/cache"), force: true
 end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-06 00:00:00.000000000 Z
+date: 2019-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: relaton
   requirement: !ruby/object:Gem::Requirement
@@ -362,6 +362,7 @@ files:
 - lib/asciidoctor/standoc/lists.rb
 - lib/asciidoctor/standoc/macros.rb
 - lib/asciidoctor/standoc/ref.rb
+- lib/asciidoctor/standoc/reqt.rng
 - lib/asciidoctor/standoc/section.rb
 - lib/asciidoctor/standoc/table.rb
 - lib/asciidoctor/standoc/utils.rb
@@ -419,7 +420,7 @@ files:
 - spec/vcr_cassettes/isobib_get_124.yml
 - spec/vcr_cassettes/rfcbib_get_rfc8341.yml
 - spec/vcr_cassettes/separates_iev_citations_by_top_level_clause.yml
-homepage: https://github.com/riboseinc/metanorma-standoc
+homepage: https://github.com/metanorma/metanorma-standoc
 licenses:
 - BSD-2-Clause
 metadata: {}