metanorma-standoc 1.9.0 → 1.10.0

data/lib/asciidoctor/standoc/isodoc.rng

@@ -45,6 +45,11 @@
         <optional>
           <attribute name="alt"/>
         </optional>
+        <optional>
+          <attribute name="updatetype">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -543,6 +548,9 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
       <optional>
         <ref name="editorialgroup"/>
       </optional>
@@ -876,8 +884,28 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="pagebreak">
+      <element name="pagebreak">
+        <optional>
+          <attribute name="orientation">
+            <choice>
+              <value>landscape</value>
+              <value>portrait</value>
+            </choice>
+          </attribute>
+        </optional>
+      </element>
+    </define>
   </include>
   <!-- end overrides -->
+  <define name="docsubtype">
+    <element name="docsubtype">
+      <ref name="DocumentSubtype"/>
+    </element>
+  </define>
+  <define name="DocumentSubtype">
+    <text/>
+  </define>
   <define name="colgroup">
     <element name="colgroup">
       <oneOrMore>
@@ -927,7 +955,24 @@
   <define name="concept">
     <element name="concept">
       <optional>
-        <attribute name="term"/>
+        <element name="refterm">
+          <zeroOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="stem"/>
+            </choice>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="renderterm">
+          <zeroOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="stem"/>
+            </choice>
+          </zeroOrMore>
+        </element>
       </optional>
       <choice>
         <ref name="eref"/>
@@ -943,8 +988,170 @@
       <ref name="permission"/>
       <ref name="imagemap"/>
       <ref name="svgmap"/>
+      <ref name="inputform"/>
+    </choice>
+  </define>
+  <define name="inputform">
+    <element name="form">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <attribute name="name"/>
+      <attribute name="action"/>
+      <zeroOrMore>
+        <choice>
+          <ref name="TextElement"/>
+          <ref name="FormInput"/>
+        </choice>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="FormInput">
+    <choice>
+      <ref name="input"/>
+      <ref name="formlabel"/>
+      <ref name="select"/>
+      <ref name="textarea"/>
     </choice>
   </define>
+  <define name="InputType">
+    <choice>
+      <value>button</value>
+      <value>checkbox</value>
+      <value>date</value>
+      <value>file</value>
+      <value>password</value>
+      <value>radio</value>
+      <value>submit</value>
+      <value>text</value>
+    </choice>
+  </define>
+  <define name="input">
+    <element name="input">
+      <attribute name="type">
+        <ref name="InputType"/>
+      </attribute>
+      <optional>
+        <attribute name="checked">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="readonly">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="maxlength">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="minlength">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+    </element>
+  </define>
+  <define name="formlabel">
+    <element name="label">
+      <attribute name="for">
+        <data type="IDREF"/>
+      </attribute>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="select">
+    <element name="select">
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="multiple">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="size">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <ref name="option"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="option">
+    <element name="option">
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="textarea">
+    <element name="textarea">
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="rows">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="cols">
+          <data type="int"/>
+        </attribute>
+      </optional>
+    </element>
+  </define>
   <define name="bibliography">
     <element name="bibliography">
       <oneOrMore>
@@ -1017,9 +1224,7 @@
   </define>
   <define name="IsoWorkgroup">
     <optional>
-      <attribute name="number">
-        <data type="int"/>
-      </attribute>
+      <attribute name="number"/>
     </optional>
     <optional>
       <attribute name="type"/>

data/lib/asciidoctor/standoc/lists.rb

@@ -28,14 +28,16 @@ module Asciidoctor
       end
 
       def ul_li_attrs(node)
+        c = node.attr?("checked")
         attr_code(
-          uncheckedcheckbox: node.attr?("checkbox") ? !node.attr?("checked") : nil,
-          checkedcheckbox: node.attr?("checkbox") ? node.attr?("checked") : nil,
+          uncheckedcheckbox: node.attr?("checkbox") ? !c : nil,
+          checkedcheckbox: node.attr?("checkbox") ? c : nil
         )
       end
 
       def ulist(node)
         return reference(node) if in_norm_ref? || in_biblio?
+
         noko do |xml|
           xml.ul **ul_attrs(node) do |xml_ul|
             node.items.each do |item|

data/lib/asciidoctor/standoc/macros.rb

@@ -4,6 +4,7 @@ require "uuidtools"
 require "yaml"
 require_relative "./macros_plantuml"
 require_relative "./macros_terms"
+require_relative "./macros_form"
 require_relative "./datamodel/attributes_table_preprocessor"
 require_relative "./datamodel/diagram_preprocessor"
 require "metanorma-plugin-datastruct"
@@ -74,12 +75,11 @@ module Asciidoctor
       def supply_br(lines)
         ignore = false
         lines.each_with_index do |l, i|
-          /^(--+|====+|\|===|\.\.\.\.+|\*\*\*\*+|\+\+\+\++|\`\`\`\`+|____\+)$/.match(l) &&
-            (ignore = !ignore)
-          next if l.empty? || l.match(/ \+$/)
-          next if /^\[.*\]$/.match?(l)
-          next if ignore
-          next if i == lines.size - 1 || i < lines.size - 1 && lines[i + 1].empty?
+          /^(--+|====+|\|===|\.\.\.\.+|\*\*\*\*+|\+\+\+\++|\`\`\`\`+|____\+)$/
+            .match(l) && (ignore = !ignore)
+          next if l.empty? || l.match(/ \+$/) || /^\[.*\]$/.match?(l) || ignore
+          next if i == lines.size - 1 ||
+            i < lines.size - 1 && lines[i + 1].empty?
 
           lines[i] += " +"
         end
@@ -128,22 +128,22 @@ module Asciidoctor
       def process(parent, reader, attrs)
         attrs["name"] = "todo"
         attrs["caption"] = "TODO"
-        create_block parent, :admonition, reader.lines, attrs,
-          content_model: :compound
+        create_block(parent, :admonition, reader.lines, attrs,
+                     content_model: :compound)
       end
     end
 
     class ToDoInlineAdmonitionBlock < Extensions::Treeprocessor
       def process(document)
         (document.find_by context: :paragraph).each do |para|
-          next unless /^TODO: /.match para.lines[0]
+          next unless /^TODO: /.match? para.lines[0]
 
           parent = para.parent
           para.set_attr("name", "todo")
           para.set_attr("caption", "TODO")
           para.lines[0].sub!(/^TODO: /, "")
-          todo = Block.new parent, :admonition, attributes: para.attributes,
-            source: para.lines, content_model: :compound
+          todo = Block.new(parent, :admonition, attributes: para.attributes,
+                           source: para.lines, content_model: :compound)
           parent.blocks[parent.blocks.index(para)] = todo
         end
       end

data/lib/asciidoctor/standoc/macros_form.rb

@@ -0,0 +1,63 @@
+module Asciidoctor
+  module Standoc
+    class FormInputMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :input
+
+      def process(_parent, target, attr)
+        m = %w(id name value disabled readonly checked maxlength minlength)
+          .map { |a| attr[a] ? " #{a}='#{attr[a]}'" : nil }.compact
+        %{<input type='#{target}' #{m.join}/>}
+      end
+    end
+
+    class FormLabelMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :label
+      parse_content_as :text
+
+      def process(parent, target, attr)
+        out = Asciidoctor::Inline.new(parent, :quoted, attr["text"]).convert
+        %{<label for="#{target}">#{out}</label>}
+      end
+    end
+
+    class FormTextareaMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :textarea
+      using_format :short
+
+      def process(_parent, _target, attr)
+        m = %w(id name rows cols value)
+          .map { |a| attr[a] ? " #{a}='#{attr[a]}'" : nil }.compact
+        %{<textarea #{m.join}/>}
+      end
+    end
+
+    class FormSelectMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :select
+      using_format :short
+
+      def process(parent, _target, attr)
+        m = %w(id name size disabled multiple value)
+          .map { |a| attr[a] ? " #{a}='#{attr[a]}'" : nil }.compact
+        out = Asciidoctor::Inline.new(parent, :quoted, attr["text"]).convert
+        %{<select #{m.join}>#{out}</select>}
+      end
+    end
+
+    class FormOptionMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :option
+      using_format :short
+
+      def process(parent, _target, attr)
+        m = %w(disabled value)
+          .map { |a| attr[a] ? " #{a}='#{attr[a]}'" : nil }.compact
+        out = Asciidoctor::Inline.new(parent, :quoted, attr["text"]).convert
+        %{<option #{m.join}">#{out}</option>}
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/macros_plantuml.rb

@@ -4,8 +4,8 @@ module Asciidoctor
       # https://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
       def self.plantuml_installed?
         cmd = "plantuml"
-        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+        ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
           exts.each do |ext|
             exe = File.join(path, "#{cmd}#{ext}")
             return exe if File.executable?(exe) && !File.directory?(exe)
@@ -15,7 +15,7 @@ module Asciidoctor
         nil
       end
 
-      def self.run umlfile, outfile
+      def self.run(umlfile, outfile)
         system "plantuml #{umlfile.path}" or (warn $? and return false)
         i = 0
         until !Gem.win_platform? || File.exist?(outfile) || i == 15
@@ -29,9 +29,9 @@ module Asciidoctor
       # 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
+      def self.generate_file(parent, reader)
         localdir = Metanorma::Utils::localdir(parent.document)
-        imagesdir = parent.document.attr('imagesdir')
+        imagesdir = parent.document.attr("imagesdir")
         umlfile, outfile = save_plantuml parent, reader, localdir
         run(umlfile, outfile) or raise "No image output from PlantUML (#{umlfile}, #{outfile})!"
         umlfile.unlink
@@ -40,7 +40,7 @@ module Asciidoctor
         File.writable?(localdir) or raise "Destination path #{path} not writable for PlantUML!"
         path.mkpath
         File.writable?(path) or raise "Destination path #{path} not writable for PlantUML!"
-        #File.exist?(path) or raise "Destination path #{path} already exists for PlantUML!"
+        # File.exist?(path) or raise "Destination path #{path} already exists for PlantUML!"
 
         # Warning: metanorma/metanorma-standoc#187
         # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
@@ -51,21 +51,21 @@ module Asciidoctor
         imagesdir ? filename : File.join(path, filename)
       end
 
-      def self.save_plantuml parent, reader, localdir
+      def self.save_plantuml(_parent, reader, _localdir)
         src = reader.source
         reader.lines.first.sub(/\s+$/, "").match /^@startuml($| )/ or
           src = "@startuml\n#{src}\n@enduml\n"
         /^@startuml (?<fn>[^\n]+)\n/ =~ src
-        Tempfile.open(["plantuml", ".pml"], :encoding => "utf-8") do |f|
+        Tempfile.open(["plantuml", ".pml"], encoding: "utf-8") do |f|
           f.write(src)
           [f, File.join(File.dirname(f.path),
                         (fn || File.basename(f.path, ".pml")) + ".png")]
         end
       end
 
-      def self.generate_attrs attrs
-        through_attrs = %w(id align float title role width height alt).
-          inject({}) do |memo, key|
+      def self.generate_attrs(attrs)
+        %w(id align float title role width height alt)
+          .inject({}) do |memo, key|
           memo[key] = attrs[key] if attrs.has_key? key
           memo
         end
@@ -81,19 +81,17 @@ module Asciidoctor
       def abort(parent, reader, attrs, msg)
         warn msg
         attrs["language"] = "plantuml"
-        create_listing_block parent, reader.source, attrs.reject { |k, v| k == 1 }
+        create_listing_block parent, reader.source, attrs.reject { |k, _v| k == 1 }
       end
 
       def process(parent, reader, attrs)
-        begin
-          PlantUMLBlockMacroBackend.plantuml_installed?
-          filename = PlantUMLBlockMacroBackend.generate_file(parent, reader)
-          through_attrs = PlantUMLBlockMacroBackend.generate_attrs attrs
-          through_attrs["target"] = filename
-          create_image_block parent, through_attrs
-        rescue StandardError => e
-          abort(parent, reader, attrs, e.message)
-        end
+        PlantUMLBlockMacroBackend.plantuml_installed?
+        filename = PlantUMLBlockMacroBackend.generate_file(parent, reader)
+        through_attrs = PlantUMLBlockMacroBackend.generate_attrs attrs
+        through_attrs["target"] = filename
+        create_image_block parent, through_attrs
+      rescue StandardError => e
+        abort(parent, reader, attrs, e.message)
       end
     end
   end