metanorma-standoc 1.3.29 → 1.4.0

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

@@ -0,0 +1,30 @@
+
+[yaml2text,<%= model_path %>,definition]
+----
+
+=== {definition.name || "<%= file_name %>"}
+{definition.definition}
+
+{if definition.attributes}
+.{definition.name || "<%= file_name %>"} attributes
+|===
+|Name |Definition |Mandatory/ Optional/ Conditional |Max Occur |Data Type
+
+{definition.attributes&.*,key,EOK}
+|{key} |{definition.attributes[key].definition || "TODO: enum " + key + "'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 + ">>" : ""}`{definition.attributes[key].type}`
+{EOK}
+|===
+{end}
+
+{if definition['values']}
+.{definition.name || "<%= file_name %>"} values
+|===
+|Name |Definition
+
+{definition['values']&.*,key,EOK}
+|{key} |{definition['values'][key].definition}
+{EOK}
+|===
+{end}
+
+----

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

@@ -0,0 +1,20 @@
+[plantuml,title=<%= diagram_caption %>]
+....
+@startuml
+
+<%= diagram_options_yml_to_plantuml %>
+
+<%= class_groups_yml_to_plantuml %>
+
+<%= imports_yml_to_plantuml %>
+
+<%= class_defs_yml_to_plantuml %>
+
+<%= class_relations_yml_to_plantuml %>
+
+<%= fidelity_yml_to_plantuml %>
+
+<%= bottom_yml_to_plantuml %>
+
+@enduml
+....

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-   VERSION = "1.3.29".freeze
+   VERSION = "1.4.0".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ruby-jing"
   spec.add_dependency "isodoc", "~> 1.0.20"
   spec.add_dependency "iev", "~> 0.2.1"
-  spec.add_dependency "relaton", "~> 1.0.0"
+  spec.add_dependency "relaton", "~> 1.1.0"
   spec.add_dependency "relaton-iev", "~> 1.0.0"
   spec.add_dependency "sterile", "~> 1.0.14"
   spec.add_dependency "concurrent-ruby"

data/spec/asciidoctor-standoc/cleanup_spec.rb

@@ -1844,6 +1844,57 @@ it "moves inherit macros to correct location" do
     </clause>
   </sections>
 </standard-document>
+OUTPUT
+end
+
+it "moves %beforeclause admonitions to right position" do
+  expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+  #{ASCIIDOC_BLANK_HDR}
+  
+  .Foreword
+  Foreword
+
+  [NOTE,beforeclauses=true]
+  ====
+  Note which is very important
+  ====
+
+  == Introduction
+  Introduction
+
+  == Scope
+  Scope statement
+
+  [IMPORTANT,beforeclauses=true]
+  ====
+  Notice which is very important
+  ====
+INPUT
+  #{BLANK_HDR}
+  <preface>
+    <foreword id='_' obligation='informative'>
+      <title>Foreword</title>
+      <p id='_'>Foreword</p>
+    </foreword>
+    <introduction id='_' obligation='informative'>
+      <title>Introduction</title>
+      <p id='_'>Introduction</p>
+    </introduction>
+  </preface>
+  <sections>
+    <note id='_'>
+      <p id='_'>Note which is very important</p>
+    </note>
+    <admonition id='_' type='important'>
+      <p id='_'>Notice which is very important</p>
+    </admonition>
+    <clause id='_' inline-header='false' obligation='normative'>
+      <title>Scope</title>
+      <p id='_'>Scope statement</p>
+    </clause>
+  </sections>
+</standard-document>
+
 OUTPUT
 end
 

data/spec/asciidoctor-standoc/datamodel/attributes_table_preprocessor_spec.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Asciidoctor::Standoc::Datamodel::AttributesTablePreprocessor do
+  describe '#process' do
+    context 'when simple models without relations' do
+      let(:datamodel_file) do
+        examples_path('datamodel/address_class_profile.adoc')
+      end
+      let(:result_file) do
+        examples_path('datamodel/address_class_profile.xml')
+      end
+      let(:output) do
+        [
+          BLANK_HDR,
+          File.read(fixtures_path('macros_datamodel/address_class_profile.xml'))
+        ]
+          .join
+      end
+
+      after do
+        %w[doc html xml err].each do |extention|
+          path = examples_path("datamodel/address_class_profile.#{extention}")
+          FileUtils.rm_f(path)
+          FileUtils.rm_f("address_class_profile.#{extention}")
+        end
+      end
+
+      it 'correctly renders input' do
+        Asciidoctor.convert_file(datamodel_file,
+                                 backend: :standoc,
+                                 safe: :safe,
+                                 header_footer: true)
+        expect(xmlpp(strip_guid(File.read(result_file))))
+          .to(be_equivalent_to(xmlpp(output)))
+      end
+    end
+
+    context 'when complex relations' do
+      let(:datamodel_file) do
+        examples_path('datamodel/address_component_profile.adoc')
+      end
+      let(:result_file) do
+        examples_path('datamodel/address_component_profile.xml')
+      end
+      let(:output) do
+        path = fixtures_path('macros_datamodel/address_component_profile.xml')
+        [
+          BLANK_HDR,
+          File.read(path)
+        ]
+          .join("\n")
+      end
+
+      after do
+        %w[doc html xml err].each do |extention|
+          path = examples_path(
+            "datamodel/address_component_profile.#{extention}"
+          )
+          FileUtils.rm_f(path)
+          FileUtils.rm_f("address_component_profile.#{extention}")
+        end
+      end
+
+      it 'correctly renders input' do
+        Asciidoctor.convert_file(datamodel_file,
+                                 backend: :standoc,
+                                 safe: :safe,
+                                 header_footer: true)
+        expect(xmlpp(strip_guid(File.read(result_file))))
+          .to(be_equivalent_to(xmlpp(output)))
+      end
+    end
+  end
+end

data/spec/asciidoctor-standoc/datamodel/diagram_preprocessor_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Asciidoctor::Standoc::Datamodel::DiagramPreprocessor do
+  describe '#process' do
+    context 'when simple models without relations' do
+      let(:datamodel_file) do
+        examples_path('datamodel/common_models_diagram.adoc')
+      end
+      let(:result_file) do
+        examples_path('datamodel/common_models_diagram.xml')
+      end
+      let(:output) do
+        [
+          BLANK_HDR,
+          File.read(
+            fixtures_path('macros_datamodel/common_models_diagram.xml')
+          )
+        ].join
+      end
+
+      after do
+        %w[doc html xml err].each do |extention|
+          path = examples_path("datamodel/common_models_diagram.#{extention}")
+          FileUtils.rm_f(path)
+          FileUtils.rm_f("common_models_diagram.#{extention}")
+        end
+        FileUtils.rm_rf('common_models_diagram_htmlimages')
+      end
+
+      it 'correctly renders input' do
+        Asciidoctor.convert_file(datamodel_file,
+                                 backend: :standoc,
+                                 safe: :safe,
+                                 header_footer: true)
+        expect(xmlpp(strip_src(strip_guid(File.read(result_file)))))
+          .to(be_equivalent_to(xmlpp(output)))
+      end
+    end
+
+    context 'when complex relations' do
+      let(:datamodel_file) { examples_path('datamodel/top_down_diagram.adoc') }
+      let(:result_file) { examples_path('datamodel/top_down_diagram.xml') }
+      let(:output) do
+        [
+          BLANK_HDR,
+          File.read(fixtures_path('macros_datamodel/top_down_diagram.xml'))
+        ].join("\n")
+      end
+
+      after do
+        %w[doc html xml err].each do |extention|
+          path = examples_path("datamodel/top_down_diagram.#{extention}")
+          FileUtils.rm_f(path)
+          FileUtils.rm_f("top_down_diagram.#{extention}")
+        end
+        FileUtils.rm_rf(examples_path('datamodel/plantuml'))
+        FileUtils.rm_rf('top_down_diagram_htmlimages')
+      end
+
+      it 'correctly renders input' do
+        Asciidoctor.convert_file(datamodel_file,
+                                 backend: :standoc,
+                                 safe: :safe,
+                                 header_footer: true)
+        expect(xmlpp(strip_src(strip_guid(File.read(result_file)))))
+          .to(be_equivalent_to(xmlpp(output)))
+      end
+    end
+  end
+end

data/spec/asciidoctor-standoc/inline_spec.rb

@@ -198,6 +198,8 @@ text, including nested markup.
       Inline Reference with Text to <<reference,text>>
       Footnoted Reference with Text to <<reference,fn: text>>
       Anchored Crossreference to other document <<a.adoc#b>>
+      Capitalised Reference to <<reference,capital%>>
+      Lowercase Footnoted Reference to <<reference,capital%fn>>
     INPUT
        #{BLANK_HDR}
         <sections>
@@ -207,7 +209,9 @@ text, including nested markup.
        Footnoted Reference to <xref target="reference"/>
        Inline Reference with Text to <xref target="reference">text</xref>
        Footnoted Reference with Text to <xref target="reference">text</xref>
-       Anchored Crossreference to other document <xref target="a#b"/></p>
+       Anchored Crossreference to other document <xref target="a#b"/>
+       Capitalised Reference to <xref target='reference' case='capital'></xref>
+       Lowercase Footnoted Reference to <xref target='reference' case='capital'></xref></p>
        </clause>
        </sections>
        </standard-document>

data/spec/asciidoctor-standoc/macros_spec.rb

@@ -270,6 +270,56 @@ OUTPUT
              </p>
            </figure>
 </sections>
+</standard-document>
+     OUTPUT
+    end
+
+    it "skips embedded blocks when supplying line breaks in pseudocode" do
+      expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+        #{ASCIIDOC_BLANK_HDR}
+
+        [pseudocode]
+        ====
+        [stem]
+        ++++
+        bar X' = (1)/(v) sum_(i = 1)^(v) t_(i)
+        ++++
+        ====
+        INPUT
+        #{BLANK_HDR}
+        <sections>
+<figure id='_' class='pseudocode'>
+ <formula id='_'>
+   <stem type='MathML'>
+     <math xmlns='http://www.w3.org/1998/Math/MathML'>
+       <mover>
+         <mi>X</mi>
+         <mo>¯</mo>
+       </mover>
+       <mi>'</mi>
+       <mo>=</mo>
+       <mfrac>
+         <mn>1</mn>
+         <mi>v</mi>
+       </mfrac>
+       <munderover>
+         <mo>∑</mo>
+         <mrow>
+           <mi>i</mi>
+           <mo>=</mo>
+           <mn>1</mn>
+         </mrow>
+         <mi>v</mi>
+       </munderover>
+       <msub>
+         <mi>t</mi>
+         <mi>i</mi>
+       </msub>
+     </math>
+   </stem>
+ </formula>
+           </figure>
+</sections>
 </standard-document>
      OUTPUT
     end

data/spec/asciidoctor-standoc/macros_yaml2text_spec.rb

@@ -402,7 +402,8 @@ RSpec.describe Asciidoctor::Standoc::Yaml2TextPreprocessor do
         TEXT
       end
 
-      it 'correctly renders input yaml' do
+      # TODO: fix frozen string error
+      xit 'correctly renders input yaml' do
         expect(
           xmlpp(
             strip_guid(

data/spec/asciidoctor-standoc/refs_spec.rb

@@ -543,7 +543,6 @@ RSpec.describe Asciidoctor::Standoc do
               <uri>www.iso.org</uri>
             </organization>
           </contributor>
-          <!--
           <contributor>
             <role type="publisher"/>
             <organization>
@@ -552,7 +551,6 @@ RSpec.describe Asciidoctor::Standoc do
               <uri>www.iec.ch</uri>
             </organization>
           </contributor>
-          -->
           <edition>2</edition>
           <language>en</language>
           <language>fr</language>
@@ -645,7 +643,6 @@ RSpec.describe Asciidoctor::Standoc do
               <uri>www.iso.org</uri>
             </organization>
           </contributor>
-          <!--
           <contributor>
             <role type="publisher"/>
             <organization>
@@ -654,7 +651,6 @@ RSpec.describe Asciidoctor::Standoc do
               <uri>www.iec.ch</uri>
             </organization>
           </contributor>
-          -->
           <edition>2</edition>
           <language>en</language>
           <language>fr</language>

data/spec/examples/datamodel/address_class_profile.adoc

@@ -0,0 +1,4 @@
+= Document title
+Author
+
+[datamodel_attributes_table,models/models/AddressClassProfile.yml]

data/spec/examples/datamodel/address_component_profile.adoc

@@ -0,0 +1,4 @@
+= Document title
+Author
+
+[datamodel_attributes_table,models/models/AddressComponentProfile.yml]

data/spec/examples/datamodel/common_models_diagram.adoc

@@ -0,0 +1,4 @@
+= Document title
+Author
+
+[datamodel_diagram,models/views/CommonModels.yml]

data/spec/examples/datamodel/models/models/AddressClassProfile.yml

@@ -0,0 +1,90 @@
+modelType: class
+# TODO
+definition: |
+  An `AddressClassProfile` represents a profile of a `ProfileCompliantAddress`.
+  It corresponds to the concept of an `AddressClass` originally
+  expressed in <<ISO19160-1>> as a referenced codelist.
+
+  It represents additional attributes and restrictions to the
+  `ProfileCompliantAddress` model. It also represents metadata for the use of
+  the profile.
+
+  A single profile can include and support multiple types of
+  address formats, such as a numbered street address and a
+  "`PO Box`" address simultaneously. Each of these address formats
+  is represented as an interchange address class.
+
+  [example]
+  --
+  The US Numbered Thoroughfare Address with this syntax can be
+  represented as an address class profile:
+
+  *{sp}{ Complete Landmark Name or Complete Place Name } +
+  *{sp}{ Complete Address Number * } +
+  *{sp}{ Complete Street Name * } +
+  *{sp}{ Complete Subaddress } +
+  *{sp}{ Complete Place Name * } +
+  *{sp}{ State Name * } +
+  *{sp}{ Zip Code } +
+  *{sp}{ Zip Plus 4 } +
+  *{sp}{ Country Name }
+  --
+attributes:
+  id:
+    definition: Unique identifier of this AddressClassProfile.
+    type: CharacterString
+  type:
+    definition: Intended usage of this profile.
+    type: CharacterString
+  description:
+    definition: Textual description of this profile.
+    type: CharacterString
+  localization:
+    definition: The language and script used within this profile.
+    type: Localization
+  signature:
+    definition: The digital signature to verify the integrity of this profile, and the identity of the publishing authority.
+    type: Signature
+    cardinality:
+      min: 0
+      max: 1
+  areaApplicability:
+    definition: The geographic representation of which this AddressClassProfile applies to. Overlapping geographic areas are allowed across different profiles.
+    type: iso19115MD_SpatialRepresentation
+    cardinality:
+      min: 0
+      max: "*"
+  timeToLive:
+    definition: The maximum time interval between refreshing of this profile via an authoritative source, in seconds.
+    type: Integer
+  validity:
+    definition: The period of date and time that this profile should be considered as valid.
+    type: Validity
+relations:
+  - target: AttributeProfile
+    relationship:
+      source:
+        type: aggregation
+        attribute:
+          addressClassProfile:
+      target:
+        type: direct
+        attribute:
+          attributeProfile:
+            cardinality:
+              min: 0
+              max: '*'
+
+  - target: ProfileCompliantAddress
+    relationship:
+      source:
+        attribute:
+          profile:
+            cardinality:
+              min: 1
+              max: 1
+      target:
+        type: direct
+    action:
+      verb: compliesWith
+      direction: source