metanorma-standoc 1.5.1 → 1.6.2

data/lib/asciidoctor/standoc/validate.rb

@@ -8,7 +8,8 @@ module Asciidoctor
   module Standoc
     module Validate
 
-      SOURCELOCALITY = "./termsource/origin//locality[@type = 'clause']/referenceFrom".freeze
+      SOURCELOCALITY = "./termsource/origin//locality[@type = 'clause']/"\
+        "referenceFrom".freeze
 
       def init_iev
         return nil if @no_isobib
@@ -19,13 +20,16 @@ module Asciidoctor
 
       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
+          /^IEC 60050-/.match(t&.at("./termsource/origin/@citeas")&.text) &&
+            loc = t.xpath(SOURCELOCALITY)&.text or next
           @iev = init_iev or return
-          iev = @iev.fetch(locality, xmldoc&.at("//language")&.text || "en") or next
+          iev = @iev.fetch(loc, xmldoc&.at("//language")&.text || "en") or next
+          pref = t.xpath("./preferred").inject([]) do |m, x|
+            m << x&.text&.downcase
+          end
           pref.include?(iev.downcase) or
-          @log.add("Bibliography", t, %(Term "#{pref[0]}" does not match IEV #{locality} "#{iev}"))
+            @log.add("Bibliography", t, %(Term "#{pref[0]}" does not match ) +
+                     %(IEV #{loc} "#{iev}"))
         end
       end
 
@@ -35,20 +39,26 @@ module Asciidoctor
         iev_validate(doc.root)
       end
 
+      def repeat_id_validate1(ids, x)
+        if ids[x["id"]]
+          @log.add("Anchors", x, "Anchor #{x['id']} has already been used "\
+                   "at line #{ids[x['id']]}")
+          raise StandardError.new "Error: multiple instances of same ID"
+        else
+          ids[x["id"]] = x.line
+        end
+        ids
+      end
+
       def repeat_id_validate(doc)
         ids = {}
-        crash = false
-        doc.xpath("//*[@id]").each do |x|
-          if ids[x["id"]]
-            @log.add("Anchors", x, "Anchor #{x['id']} has already been used at line #{ids[x['id']]}")
-            crash = true
-          else
-            ids[x["id"]] = x.line
+        begin
+          doc.xpath("//*[@id]").each do |x|
+            ids = repeat_id_validate1(ids, x)
           end
-        end
-        if crash
+        rescue StandardError => e
           clean_exit
-          abort("Cannot deal with multiple instances of same ID")
+          abort(e.message)
         end
       end
 
@@ -59,8 +69,10 @@ module Asciidoctor
             f.close
             errors = Jing.new(schema).validate(f.path)
             warn "Syntax Valid!" if errors.none?
-            errors.each do |error|
-              @log.add("Syntax", "XML Line #{"%06d" % error[:line]}:#{error[:column]}", error[:message])
+            errors.each do |e|
+              @log.add("Metanorma XML Syntax",
+                       "XML Line #{"%06d" % e[:line]}:#{e[:column]}",
+                       e[:message])
             end
           rescue Jing::Error => e
             clean_exit

data/lib/asciidoctor/standoc/validate_section.rb

@@ -22,7 +22,7 @@ module Asciidoctor
       def style_warning(node, msg, text = nil)
         w = msg
         w += ": #{text}" if text
-        @log.add("Style Warning", node, w)
+        @log.add("Metanorma XML Style Warning", node, w)
       end
 
       def asset_title_style(root)

data/lib/asciidoctor/standoc/views/datamodel/model_representation.adoc.erb

@@ -2,29 +2,29 @@
 [yaml2text,<%= model_path %>,definition]
 ----
 
-=== {definition.name || "<%= file_name %>"}
+=== {definition.name | default: "<%= file_name %>"}
 {definition.definition}
 
-{if definition.attributes}
-.{definition.name || "<%= file_name %>"} attributes
+{% if definition.attributes %}
+.{definition.name | default: "<%= file_name %>"} attributes
 |===
 |Name |Definition |Mandatory/ Optional/ Conditional |Max Occur |Data Type
 
-{definition.attributes&.*,key,EOK}
-|{key} |{definition.attributes[key].definition || "TODO: enum " + key.to_s + "'s definition"} |{definition.attributes[key]&.cardinality&.min == 0 ? "O" : "M"} |{definition.attributes[key]&.cardinality&.max == "*" ? "N" : "1"} |{definition.attributes[key].origin ? "<<" + definition.attributes[key].origin.to_s + ">>" : ""}`{definition.attributes[key].type}`
+{definition.attributes.*,key,EOK}
+|{key} |{% if definition.attributes[key].definition %}{{ definition.attributes[key].definition }}{% else %}TODO: enum {{ key }}'s definition{% endif %} |{% if definition.attributes[key].cardinality.min == 0 %}O{% else %}M{% endif %} |{% if definition.attributes[key].cardinality.max == "*" %}N{% else %}1{% endif %} |{% if definition.attributes[key].origin %}<<{{ definition.attributes[key].origin }}>>{% endif %} `{definition.attributes[key].type}`
 {EOK}
 |===
-{end}
+{% endif %}
 
-{if definition['values']}
-.{definition.name || "<%= file_name %>"} values
+{% if definition['values'] %}
+.{definition.name | default: "<%= file_name %>"} values
 |===
 |Name |Definition
 
-{definition['values']&.*,key,EOK}
+{definition['values'].*,key,EOK}
 |{key} |{definition['values'][key].definition}
 {EOK}
 |===
-{end}
+{% endif %}
 
 ----

data/lib/liquid/custom_blocks/key_iterator.rb

@@ -0,0 +1,21 @@
+module Liquid
+  module CustomBlocks
+    class KeyIterator < Block
+      def initialize(tag_name, markup, tokens)
+        super
+        @context_name, @var_name = markup.split(',').map(&:strip)
+      end
+
+      def render(context)
+        res = ''
+        iterator = context[@context_name].is_a?(Hash) ? context[@context_name].keys : context[@context_name]
+        iterator.each.with_index do |key, index|
+          context['index'] = index
+          context[@var_name] = key
+          res += super
+        end
+        res
+      end
+    end
+  end
+end

data/lib/liquid/custom_blocks/with_json_nested_context.rb

@@ -0,0 +1,18 @@
+module Liquid
+  module CustomBlocks
+    class WithJsonNestedContext < Block
+      def initialize(tag_name, markup, tokens)
+        super
+        @context_file_variable, @context_name = markup.split(",").map(&:strip)
+      end
+
+      def render(context)
+        context_file = context[@context_file_variable].to_s.strip
+        context[@context_name] = JSON.parse(
+          File.read(context_file, encoding: "utf-8")
+        )
+        super
+      end
+    end
+  end
+end

data/lib/liquid/custom_blocks/with_yaml_nested_context.rb

@@ -0,0 +1,19 @@
+module Liquid
+  module CustomBlocks
+    class WithYamlNestedContext < Block
+      def initialize(tag_name, markup, tokens)
+        super
+        @context_file_variable, @context_name = markup.split(",").map(&:strip)
+      end
+
+      def render(context)
+        context_file = context[@context_file_variable].to_s.strip
+        context[@context_name] = YAML.safe_load(
+          File.read(context_file, encoding: "utf-8"),
+          [Date, Time]
+        )
+        super
+      end
+    end
+  end
+end

data/lib/liquid/custom_filters/values.rb

@@ -0,0 +1,7 @@
+module Liquid
+  module CustomFilters
+    def values(list)
+      list.values
+    end
+  end
+end

data/lib/metanorma/standoc.rb

@@ -1,11 +1,6 @@
 require_relative "./standoc/processor"
-require_relative "./standoc/requirement"
-require_relative "./standoc/latexml_requirement"
 
 module Metanorma
   module Standoc
-    Requirements = {
-      latexml: LatexmlRequirement.new
-    }
   end
 end

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,24 @@
 module Metanorma
+  class << self
+    # https://stackoverflow.com/a/53399471
+    def parent_of(mod)
+      parent_name = mod.name =~ /::[^:]+\Z/ ? $`.freeze : nil
+      Object.const_get(parent_name) if parent_name
+    end
+
+    def all_modules(mod)
+      [mod] + mod.constants.map { |c| mod.const_get(c) }
+        .select {|c| c.is_a?(Module) && parent_of(c) == mod }
+        .flat_map {|m| all_modules(m) }
+    end
+
+    def versioned(mod, flavour)
+      all_modules(mod).select {|c| defined? c::VERSION}.
+        select {|c| c.name =~ /::#{flavour}$/ }
+    end
+  end
+
   module Standoc
-   VERSION = "1.5.1".freeze
+    VERSION = "1.6.2".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -30,13 +30,16 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ruby-jing"
   spec.add_dependency "isodoc", "~> 1.2.0"
   spec.add_dependency "iev", "~> 0.2.1"
-  spec.add_dependency "relaton", "~> 1.2.0"
+  spec.add_dependency "metanorma-plugin-datastruct"
+  # relaton-cli not just relaton, to avoid circular reference in metanorma
+  spec.add_dependency "relaton-cli", "~> 1.5.0"
   spec.add_dependency "relaton-iev", "~> 1.0.0"
   spec.add_dependency "sterile", "~> 1.0.14"
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "unicode2latex", "~> 0.0.1"
   spec.add_dependency "mimemagic"
   spec.add_dependency "mathml2asciimath"
+  spec.add_dependency "latexmath"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "sassc", "2.4.0"
@@ -50,7 +53,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "timecop", "~> 0.9"
   spec.add_development_dependency "vcr", "~> 5.0.0"
   spec.add_development_dependency "webmock"
-  #spec.add_development_dependency "relaton-iec"
-  #spec.add_development_dependency "relaton-iso"
-  #spec.add_development_dependency "relaton-ietf"
 end

data/spec/asciidoctor-standoc/base_spec.rb

@@ -32,8 +32,101 @@ RSpec.describe Asciidoctor::Standoc do
     expect(File.exist?("htmlstyle.css")).to be false
   end
 
+    it "processes publisher abbreviations" do
+    mock_org_abbrevs
+    expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :publisher: International Electrotechnical Commission,IETF,ISO
+INPUT
+<standard-document xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Standoc::VERSION}'>
+  <bibdata type='standard'>
+    <title language='en' format='text/plain'>Document title</title>
+    <contributor>
+      <role type='author'/>
+      <organization>
+        <name>International Electrotechnical Commission</name>
+        <abbreviation>IEC</abbreviation>
+      </organization>
+    </contributor>
+    <contributor>
+      <role type='author'/>
+      <organization>
+        <name>IETF</name>
+      </organization>
+    </contributor>
+    <contributor>
+      <role type='author'/>
+      <organization>
+        <name>International Standards Organization</name>
+        <abbreviation>ISO</abbreviation>
+      </organization>
+    </contributor>
+    <contributor>
+      <role type='publisher'/>
+      <organization>
+        <name>International Electrotechnical Commission</name>
+        <abbreviation>IEC</abbreviation>
+      </organization>
+    </contributor>
+    <contributor>
+      <role type='publisher'/>
+      <organization>
+        <name>IETF</name>
+      </organization>
+    </contributor>
+    <contributor>
+      <role type='publisher'/>
+      <organization>
+        <name>International Standards Organization</name>
+        <abbreviation>ISO</abbreviation>
+      </organization>
+    </contributor>
+    <language>en</language>
+    <script>Latn</script>
+    <status>
+      <stage>published</stage>
+    </status>
+    <copyright>
+      <from>2020</from>
+      <owner>
+        <organization>
+          <name>International Electrotechnical Commission</name>
+          <abbreviation>IEC</abbreviation>
+        </organization>
+      </owner>
+    </copyright>
+    <copyright>
+      <from>2020</from>
+      <owner>
+        <organization>
+          <name>IETF</name>
+        </organization>
+      </owner>
+    </copyright>
+    <copyright>
+      <from>2020</from>
+      <owner>
+        <organization>
+          <name>International Standards Organization</name>
+          <abbreviation>ISO</abbreviation>
+        </organization>
+      </owner>
+    </copyright>
+    <ext>
+      <doctype>article</doctype>
+    </ext>
+  </bibdata>
+  <sections> </sections>
+</standard-document>
+OUTPUT
+  end
+
   it "processes default metadata" do
-    expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to xmlpp(<<~'OUTPUT')
+    expect(xmlpp(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       = Document title
       Author
       :docfile: test.adoc
@@ -98,7 +191,8 @@ RSpec.describe Asciidoctor::Standoc do
       :role_2: editor
       :affiliation_2: Rockhead and Quarry Cave Construction Company
       :affiliation_abbrev_2: RQCCC
-      :address_2: 6A Rubble Way, Bedrock
+      :address_2: 6A Rubble Way, + \\
+      Bedrock
       :email_2: barney@rockhead.example.com
       :phone_2: 789
       :fax_2: 012
@@ -107,12 +201,22 @@ RSpec.describe Asciidoctor::Standoc do
       :part-of: ABC
       :translated-from: DEF,GHI;JKL MNO,PQR
       :keywords: a, b, c
+      :pub-address: 1 Infinity Loop + \\
+      California
+      :pub-phone: 3333333
+      :pub-fax: 4444444
+      :pub-email: x@example.com
+      :pub-uri: http://www.example.com
+      :isbn: ISBN-13
+      :isbn10: ISBN-10
     INPUT
     <?xml version="1.0" encoding="UTF-8"?>
-<standard-document xmlns="https://www.metanorma.org/ns/standoc">
+<standard-document xmlns="https://www.metanorma.org/ns/standoc" type="semantic" version="#{Metanorma::Standoc::VERSION}">
 <bibdata type="standard">
 <title language="en" format="text/plain">Main Title — Title</title>
   <docidentifier>1000-1</docidentifier>
+  <docidentifier type='ISBN'>ISBN-13</docidentifier>
+<docidentifier type='ISBN10'>ISBN-10</docidentifier>
   <docnumber>1000</docnumber>
   <date type="published">
   <on>1000-01-01</on>
@@ -159,19 +263,19 @@ RSpec.describe Asciidoctor::Standoc do
 <contributor>
   <role type="author"/>
   <organization>
-    <name>Ribose, Inc.</name>
+    <name>Hanna Barbera</name>
   </organization>
 </contributor>
 <contributor>
   <role type="author"/>
   <organization>
-    <name>Hanna Barbera</name>
+    <name>Cartoon Network</name>
   </organization>
 </contributor>
 <contributor>
   <role type="author"/>
   <organization>
-    <name>Cartoon Network</name>
+    <name>Ribose, Inc.</name>
   </organization>
 </contributor>
 <contributor>
@@ -185,7 +289,9 @@ RSpec.describe Asciidoctor::Standoc do
      <name>Slate Rock and Gravel Company</name>
      <abbreviation>SRG</abbreviation>
   <address>
-    <formattedAddress>6 Rubble Way, Bedrock</formattedAddress>
+  <formattedAddress>
+  6 Rubble Way, Bedrock
+</formattedAddress>
   </address>
    </organization>
    </affiliation>
@@ -207,7 +313,7 @@ RSpec.describe Asciidoctor::Standoc do
     <name>Rockhead and Quarry Cave Construction Company</name>
     <abbreviation>RQCCC</abbreviation>
   <address>
-    <formattedAddress>6A Rubble Way, Bedrock</formattedAddress>
+    <formattedAddress>6A Rubble Way, <br/>Bedrock</formattedAddress>
   </address>
   </organization>
 </affiliation>
@@ -327,6 +433,9 @@ RSpec.describe Asciidoctor::Standoc do
       :doc-uri: E
       :relaton-uri: F
       :title-eo: Dokumenttitolo
+      :doctype: This is a DocType
+      :subdivision: Subdivision
+      :subdivision-abbr: SD
 
       [abstract]
       == Abstract
@@ -338,7 +447,7 @@ RSpec.describe Asciidoctor::Standoc do
       == Clause 1
     INPUT
            <?xml version="1.0" encoding="UTF-8"?>
-       <standard-document xmlns="https://www.metanorma.org/ns/standoc">
+       <standard-document xmlns="https://www.metanorma.org/ns/standoc"  type="semantic" version="#{Metanorma::Standoc::VERSION}">
        <bibdata type="standard">
          <title language="en" format="text/plain">Document title</title>
          <title language="eo" format="text/plain">Dokumenttitolo</title>
@@ -422,7 +531,7 @@ RSpec.describe Asciidoctor::Standoc do
            </owner>
          </copyright>
          <ext>
-         <doctype>article</doctype>
+         <doctype>this-is-a-doctype</doctype>
          </ext>
        </bibdata>
          <preface>
@@ -441,6 +550,105 @@ RSpec.describe Asciidoctor::Standoc do
     OUTPUT
   end
 
+   it "processes subdivisions" do
+     mock_default_publisher
+    expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :revdate: 2000-01
+      :published-date: 1000-01
+      :docnumber: 1000
+      :partnumber: 1-1
+      :tc-docnumber: 2000
+      :language: el
+      :script: Grek
+      :subdivision: Subdivision
+      :subdivision-abbr: SD
+      :doctype: This is a DocType
+      :pub-address: 1 Infinity Loop + \\
+      California
+      :pub-phone: 3333333
+      :pub-fax: 4444444
+      :pub-email: x@example.com
+      :pub-uri: http://www.example.com
+
+    INPUT
+       <standard-document xmlns="https://www.metanorma.org/ns/standoc"  type="semantic" version="#{Metanorma::Standoc::VERSION}">
+  <bibdata type='standard'>
+    <title language='en' format='text/plain'>Document title</title>
+    <docidentifier>1000-1-1</docidentifier>
+    <docnumber>1000</docnumber>
+    <date type='published'>
+      <on>1000-01</on>
+    </date>
+    <contributor>
+      <role type='author'/>
+      <organization>
+        <name>International Standards Organization</name>
+        <subdivision>Subdivision</subdivision>
+        <abbreviation>SD</abbreviation>
+        <address>
+  <formattedAddress>1 Infinity Loop <br/>California</formattedAddress>
+</address>
+<phone>3333333</phone>
+<phone type='fax'>4444444</phone>
+<email>x@example.com</email>
+<uri>http://www.example.com</uri>
+      </organization>
+    </contributor>
+    <contributor>
+      <role type='publisher'/>
+      <organization>
+        <name>International Standards Organization</name>
+        <subdivision>Subdivision</subdivision>
+        <abbreviation>SD</abbreviation>
+        <address>
+  <formattedAddress>1 Infinity Loop <br/>California</formattedAddress>
+</address>
+<phone>3333333</phone>
+<phone type='fax'>4444444</phone>
+<email>x@example.com</email>
+<uri>http://www.example.com</uri>
+      </organization>
+    </contributor>
+    <version>
+      <revision-date>2000-01</revision-date>
+    </version>
+    <language>el</language>
+    <script>Grek</script>
+    <status>
+      <stage>published</stage>
+    </status>
+    <copyright>
+      <from>2020</from>
+      <owner>
+        <organization>
+          <name>International Standards Organization</name>
+          <subdivision>Subdivision</subdivision>
+          <abbreviation>SD</abbreviation>
+        <address>
+  <formattedAddress>1 Infinity Loop <br/>California</formattedAddress>
+</address>
+<phone>3333333</phone>
+<phone type='fax'>4444444</phone>
+<email>x@example.com</email>
+<uri>http://www.example.com</uri>
+        </organization>
+      </owner>
+    </copyright>
+    <ext>
+      <doctype>this-is-a-doctype</doctype>
+    </ext>
+  </bibdata>
+  <sections> </sections>
+</standard-document>
+        
+OUTPUT
+   end
+
   it "reads scripts into blank HTML document" do
     FileUtils.rm_f "test.html"
     Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)
@@ -525,6 +733,36 @@ QU1FOiB0ZXN0Cgo=
 ])
   end
 
+  it "test submitting-organizations with delimiter in end" do
+    FileUtils.rm_f "test.doc"
+    Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)
+      = Document title
+      Author
+      :docfile: test.adoc
+      :doctype: standard
+      :encoding: utf-8
+      :lang: en
+      :submitting-organizations: Organization One; Organization Two;
+      :publisher: "Hanna Barbera", "Cartoon Network", "Ribose, Inc.",
+    INPUT
+    expect(File.exist?("test.doc")).to be true
+  end
+
+  private
+
+  def mock_org_abbrevs
+    allow_any_instance_of(::Asciidoctor::Standoc::Front).to receive(:org_abbrev).and_return(
+      { "International Standards Organization" => "ISO",
+        "International Electrotechnical Commission" => "IEC" }
+    )
+  end
+
+   def mock_default_publisher 
+    allow_any_instance_of(::Asciidoctor::Standoc::Front).to receive(:default_publisher).and_return(
+        "International Standards Organization"
+    )
+  end
+ 
 
 end