metanorma-standoc 1.3.16 → 1.3.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cbc909f073c18439ea897d38577eab4e82753ca6aae23092d48d02afc8175c2
-  data.tar.gz: e2378d286cec5648f244435d00a65030d7ab4127637da2192cfd78928c353aee
+  metadata.gz: 4647d414467e7326fb0d0d30ee3ac79ad4f3f4a8a2e7d4ffa0948db689781db3
+  data.tar.gz: ca6d428a27678a89ff8188162046216a7f4f0efe450488d36b158319a91e45a0
 SHA512:
-  metadata.gz: f72a292b68b1f6399ff21317e15d5008acba3bd4a42023b120c14682697c22935fff14a98fbc385ef4d18ec0dbb56834e9bcfadb3e640911963a13ad4bb0a769
-  data.tar.gz: c818e921411293cca9d6727c80d7f2a4397c20f483d44076665d42f02d6c700408fd446a36977335b348e563beb05c73b70add8751afefc706cf03e91b8848a4
+  metadata.gz: 97847d11b89413d948324766bda68e416defdb35fd6fed828d6e3bcda8e67fe626a3d14054edce3d580af83c465c786b1a1c11e24585d15054d0cb01d9952bc2
+  data.tar.gz: 30e844b147945676fa516f98955f878d6b9442c3875f3edcea6ef27a6908a15bc15fedcd26a76619c3068f9f534820db419704abdcb7d2e5562a68dc4a77f9e8

data/lib/asciidoctor/standoc/base.rb

@@ -4,7 +4,6 @@ require "htmlentities"
 require "json"
 require "pathname"
 require "open-uri"
-require "pp"
 require "isodoc"
 require "relaton"
 require "fileutils"
@@ -12,6 +11,9 @@ require "fileutils"
 module Asciidoctor
   module Standoc
     module Base
+      XML_ROOT_TAG = "standard-document".freeze
+      XML_NAMESPACE = "https://www.metanorma.com/ns/standoc".freeze
+
       Asciidoctor::Extensions.register do
         inline_macro Asciidoctor::Standoc::AltTermInlineMacro
         inline_macro Asciidoctor::Standoc::DeprecatedTermInlineMacro
@@ -159,17 +161,18 @@ module Asciidoctor
       end
 
       def makexml1(node)
-        result = ["<?xml version='1.0' encoding='UTF-8'?>\n<standard-document>"]
+        result = ["<?xml version='1.0' encoding='UTF-8'?>",
+                  "<#{self.class::XML_ROOT_TAG}>"]
         result << noko { |ixml| front node, ixml }
         result << noko { |ixml| middle node, ixml }
-        result << "</standard-document>"
+        result << "</#{self.class::XML_ROOT_TAG}>"
         textcleanup(result)
       end
 
       def makexml(node)
         result = makexml1(node)
         ret1 = cleanup(Nokogiri::XML(result))
-        ret1.root.add_namespace(nil, "http://riboseinc.com/isoxml")
+        ret1.root.add_namespace(nil, self.class::XML_NAMESPACE)
         validate(ret1) unless @novalid
         ret1
       end
@@ -219,9 +222,8 @@ module Asciidoctor
 
       def extract_termsource_refs(text, node)
         matched = TERM_REFERENCE_RE.match text
-        if matched.nil?
+        matched.nil? and
           Utils::warning(node, "term reference not in expected format", text)
-        end
         matched
       end
 

data/lib/asciidoctor/standoc/inline.rb

@@ -89,7 +89,10 @@ module Asciidoctor
       end
 
       def page_break(node)
-        noko { |xml| xml.pagebreak }.join
+        attrs = {}
+        node.option?("landscape") and attrs[:orientation] = "landscape"
+        node.option?("portrait") and attrs[:orientation] = "portrait"
+        noko { |xml| xml.pagebreak **attr_code(attrs)}.join
       end
 
       def thematic_break(_node)

data/lib/asciidoctor/standoc/isodoc.rng

@@ -17,7 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<grammar ns="http://riboseinc.com/isoxml" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+<grammar ns="https://www.metanorma.com/ns/standoc" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="reqt.rng"/>
   <!-- include "biblio.rnc" { } -->
   <include href="basicdoc.rng">

data/lib/asciidoctor/standoc/macros.rb

@@ -182,19 +182,35 @@ module Asciidoctor
       end
 
       # if no :imagesdir: leave image file in plantuml
-      # sleep need for windows because dot works in separate process and 
-      # plantuml process may finish earlier then dot, as result png file 
+      # sleep need for windows because dot works in separate process and
+      # plantuml process may finish earlier then dot, as result png file
       # maybe not created yet after plantuml finish
       def self.generate_file parent, reader
         localdir = Utils::localdir(parent.document)
+
+        imagesdir = parent.document.attr('imagesdir')
         umlfile, outfile = save_plantuml parent, reader, localdir
+
+        # TODO: this should raise failure if there is no image output!!
         run(umlfile, outfile) or return
-        path = Pathname.new(localdir) + "plantuml"
-        path.mkpath()
-        File.exist?(path) && File.writable?(path) or return
-        FileUtils.cp outfile, path
         umlfile.unlink
-        File.join(path,File.basename(outfile))
+
+        path = Pathname.new(localdir) + (imagesdir || "plantuml")
+        path.mkpath
+
+        # TODO: this should raise failure if the destination path already exists!
+        File.exist?(path) or return
+
+        # TODO: this should raise failure if the destination path is not writable!
+        File.writable?(path) or return
+
+        # Warning for Heisenbug: metanorma/metanorma-standoc#187
+        # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
+        # This is why we need to copy and then unlink.
+        filename = File.basename(outfile.to_s)
+        FileUtils.cp(outfile, path) && outfile.unlink
+
+        imagesdir ? filename : File.join(path, filename)
       end
 
       def self.save_plantuml parent, reader, localdir
@@ -225,6 +241,7 @@ module Asciidoctor
       parse_content_as :raw
 
       def abort(parent, reader, attrs, msg)
+        # TODO: Abort should really raise an error
         warn msg
         attrs["language"] = "plantuml"
         create_listing_block parent, reader.source, attrs.reject { |k, v| k == 1 }

data/lib/asciidoctor/standoc/section.rb

@@ -20,15 +20,34 @@ module Asciidoctor
         @norm_ref
       end
 
-      def sectiontype(node)
+      def sectiontype(node, level = true)
         ret = node&.attr("heading")&.downcase ||
           node.title.gsub(/<[^>]+>/, "").downcase
-        return ret if ["symbols and abbreviated terms", "abbreviations",
-                       "abbreviated terms", "symbols"].include? ret
-        return nil unless node.level == 1
+        ret1 = sectiontype_streamline(ret)
+        return ret1 if "symbols and abbreviated terms" == ret1
+        return nil unless !level || node.level == 1
         return nil if @seen_headers.include? ret
         @seen_headers << ret
-        ret
+        ret1
+      end
+
+      def sectiontype_streamline(ret)
+        case ret
+        when "terms and definitions",
+          "terms, definitions, symbols and abbreviated terms",
+          "terms, definitions, symbols and abbreviations",
+          "terms, definitions and symbols",
+          "terms, definitions and abbreviations",
+          "terms, definitions and abbreviated terms"
+          "terms and definitions"
+        when "symbols and abbreviated terms",
+          "symbols",
+          "abbreviated terms",
+          "abbreviations"
+          "symbols and abbreviated terms"
+        else
+          ret
+        end
       end
 
       def section_attributes(node)
@@ -43,19 +62,11 @@ module Asciidoctor
           case sectiontype(node)
           when "introduction" then introduction_parse(a, xml, node)
           when "normative references" then norm_ref_parse(a, xml, node)
-          when "terms and definitions",
-            "terms, definitions, symbols and abbreviated terms",
-            "terms, definitions, symbols and abbreviations",
-            "terms, definitions and symbols",
-            "terms, definitions and abbreviations",
-            "terms, definitions and abbreviated terms"
+          when "terms and definitions"
             @term_def = true
             term_def_parse(a, xml, node, true)
             @term_def = false
-          when "symbols and abbreviated terms",
-            "symbols",
-            "abbreviated terms",
-            "abbreviations"
+          when "symbols and abbreviated terms"
             symbols_parse(a, xml, node)
           when "bibliography" then bibliography_parse(a, xml, node)
           else
@@ -139,9 +150,9 @@ module Asciidoctor
         @definitions = true
       end
 
-      def symbols_parse(attrs, xml, node)
-        node.role == "nonterm" and return nonterm_symbols_parse(attrs, xml, node)
-        xml.definitions **attr_code(attrs) do |xml_section|
+      def symbols_parse(attr, xml, node)
+        node.role == "nonterm" and return nonterm_symbols_parse(attr, xml, node)
+        xml.definitions **attr_code(attr) do |xml_section|
           xml_section.title { |t| t << node.title }
           defs = @definitions
           termdefs = @term_def
@@ -164,13 +175,18 @@ module Asciidoctor
 
       # subclause contains subclauses
       def term_def_subclause_parse(attrs, xml, node)
-        node.role == "nonterm" and
+        node.role == "nonterm" ||
+          sectiontype(node, false) == "terms and definitions" and
           return nonterm_term_def_subclause_parse(attrs, xml, node)
         return symbols_parse(attrs, xml, node) if @definitions
         sub = node.find_by(context: :section) { |s| s.level == node.level + 1 }
         sub.empty? || (return term_def_parse(attrs, xml, node, false))
-        SYMBOLS_TITLES.include?(node.title.downcase) and
+        sectiontype(node, false) == "symbols and abbreviated terms" and
           (return symbols_parse(attrs, xml, node))
+        term_def_subclause_parse1(attrs, xml, node)
+      end
+
+      def term_def_subclause_parse1(attrs, xml, node)
         xml.term **attr_code(attrs) do |xml_section|
           xml_section.preferred { |name| name << node.title }
           xml_section << node.content

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-   VERSION = "1.3.16".freeze
+   VERSION = "1.3.17".freeze
   end
 end

data/spec/asciidoctor-standoc/base_spec.rb

@@ -106,7 +106,7 @@ RSpec.describe Asciidoctor::Standoc do
       :keywords: a, b, c
     INPUT
     <?xml version="1.0" encoding="UTF-8"?>
-<standard-document xmlns="http://riboseinc.com/isoxml">
+<standard-document xmlns="https://www.metanorma.com/ns/standoc">
 <bibdata type="standard">
 <title language="en" format="text/plain">Main Title — Title</title>
   <docidentifier>1000-1</docidentifier>
@@ -315,7 +315,7 @@ RSpec.describe Asciidoctor::Standoc do
       == Clause 1
     INPUT
            <?xml version="1.0" encoding="UTF-8"?>
-       <standard-document xmlns="http://riboseinc.com/isoxml">
+       <standard-document xmlns="https://www.metanorma.com/ns/standoc">
        <bibdata type="standard">
          <title language="en" format="text/plain">Document title</title>
          <title language="eo" format="text/plain">Dokumenttitolo</title>

data/spec/asciidoctor-standoc/blocks_spec.rb

@@ -273,7 +273,7 @@ RSpec.describe Asciidoctor::Standoc do
       For further information on the Foreword, see *ISO/IEC Directives, Part 2, 2016, Clause 12.*
       ****
       INPUT
-      <standard-document xmlns="http://riboseinc.com/isoxml">
+      <standard-document xmlns="https://www.metanorma.com/ns/standoc">
        <bibdata type="standard">
          <title language="en" format="text/plain">Document title</title>
 

data/spec/asciidoctor-standoc/cleanup_spec.rb

@@ -1402,7 +1402,7 @@ it "removes bibdata bibitem IDs" do
 
     INPUT
     <?xml version='1.0' encoding='UTF-8'?>
-<standard-document xmlns='http://riboseinc.com/isoxml'>
+<standard-document xmlns='https://www.metanorma.com/ns/standoc'>
   <bibdata type='standard'>
     <title language='en' format='text/plain'>Document title</title>
     <language>en</language>
@@ -1448,7 +1448,7 @@ it "imports boilerplate file" do
     == Clause 1
 
     INPUT
-    <standard-document xmlns='http://riboseinc.com/isoxml'>
+    <standard-document xmlns='https://www.metanorma.com/ns/standoc'>
   <bibdata type='standard'>
     <title language='en' format='text/plain'>Document title</title>
     <language>en</language>

data/spec/asciidoctor-standoc/inline_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe Asciidoctor::Standoc do
       text, including **__nest__**ed markup.
       INPUT
       <?xml version="1.0" encoding="UTF-8"?>
-<standard-document xmlns="http://riboseinc.com/isoxml">
+<standard-document xmlns="https://www.metanorma.com/ns/standoc">
 <bibdata type="standard">
 <title language="en" format="text/plain">Document title</title>
 <language>en</language>
@@ -136,12 +136,21 @@ text, including <strong><em>nest</em></strong>ed markup.</p>
       '''
 
       <<<
+
+      [%landscape]
+      <<<
+
+      [%portrait]
+      <<<
     INPUT
             #{BLANK_HDR}
        <sections><p id="_">Line break<br/>
        line break</p>
        <hr/>
-       <pagebreak/></sections>
+       <pagebreak/>
+       <pagebreak orientation="landscape"/>
+       <pagebreak orientation="portrait"/>
+        </sections>
        </standard-document>
     OUTPUT
   end

data/spec/asciidoctor-standoc/macros_spec.rb

@@ -254,7 +254,7 @@ OUTPUT
   end
   
   it "processes the PlantUML macro" do
-    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)).gsub(%r{plantuml/plantuml[^.]+\.}, "plantuml/_."))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)).gsub(%r{plantuml/plantuml[^./]+\.}, "plantuml/_."))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
 
       [plantuml]
@@ -305,7 +305,7 @@ OUTPUT
   end
 
   it "processes the PlantUML macro with imagesdir" do
-      expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)).gsub(%r{spec/assets/[^.]+\.}, "spec/assets/_."))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)).gsub(%r{spec/assets/[^./]+\.}, "spec/assets/_."))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       = Document title
       Author
       :docfile: test.adoc

data/spec/asciidoctor-standoc/refs_spec.rb

@@ -1085,7 +1085,7 @@ OUTPUT
       * [[[iso124,(1)ISO 123]]] _Standard_
     INPUT
       <?xml version="1.0" encoding="UTF-8"?>
-      <standard-document xmlns="http://riboseinc.com/isoxml">
+      <standard-document xmlns="https://www.metanorma.com/ns/standoc">
       <bibdata type="standard">
       <title language="en" format="text/plain">Document title</title>
         <language>en</language>

data/spec/asciidoctor-standoc/section_spec.rb

@@ -561,6 +561,35 @@ RSpec.describe Asciidoctor::Standoc do
      OUTPUT
   end
 
+        it "processes terminal nodes in terms with term subsection names" do
+     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      #{ASCIIDOC_BLANK_HDR}
+
+      == Terms, definitions, symbols and abbreviated terms
+
+      === Terms and definitions
+
+      === Symbols
+
+     INPUT
+             #{BLANK_HDR}
+             <sections>
+  <terms id='_' obligation='normative'>
+    <title>Terms, definitions, symbols and abbreviated terms</title>
+    <p id='_'>No terms and definitions are listed in this document.</p>
+    <clause id='_' inline-header='false' obligation='normative'>
+      <title>Terms and definitions</title>
+    </clause>
+    <definitions id='_'>
+      <title>Symbols</title>
+    </definitions>
+  </terms>
+</sections>
+       </standard-document>
+     OUTPUT
+    end
+
+
       it "processes terms & definitions with external source" do
      expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}

data/spec/spec_helper.rb

@@ -128,7 +128,7 @@ HDR
 
 BLANK_HDR = <<~"HDR"
 <?xml version="1.0" encoding="UTF-8"?>
-<standard-document xmlns="http://riboseinc.com/isoxml">
+<standard-document xmlns="https://www.metanorma.com/ns/standoc">
 <bibdata type="standard">
 <title language="en" format="text/plain">Document title</title>
   <language>en</language>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 1.3.16
+  version: 1.3.17
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-30 00:00:00.000000000 Z
+date: 2020-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor