slaw 10.7.0 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e4cdd070ad171d0d999cbaa93da4fb2723df0a2d430679833d3588903049575
-  data.tar.gz: 33bffb144c455bb8d35f7c8dc7e3593041eead5d1c76569575afa8df73bd0a8e
+  metadata.gz: 736f598c8a9924a22e2474b2380a229a49188b9fab567280a167cc187554fdb0
+  data.tar.gz: 01de6d73cd7352ff0d6dfbf201b25e7eeb219f6f213dbb8d4c7e05bca40e5b6b
 SHA512:
-  metadata.gz: b69cf6e2303be5096d3697ced6fe3bb1538d46a5657c718f8e1c6e8e4edee1b1c24ea4b7a6f199920499412b716cfa21e0fddb72be46928377d02145236831cf
-  data.tar.gz: 13744a12c6e8f62d90cd6fd4b553e3d45f4dd7b38ca076c6da2d2dcea7e72a31feb9345f687d7d29fa5a0d9a8874c4a506929f5c1a73838f2b551df8cc063806
+  metadata.gz: faab27a9d122bde77325b295e1d9f705edd314cb9a7abd2cdff8b5e08fd9cdc43333c879e8e7c7e7dd1c7ba9e702457ef683372c890726739f46fc002ee26f3e
+  data.tar.gz: 0c289d9a797771c43be62059cf0b08f4a0730ca637400c2e38aedd2285c193cf1c6ce44763b1a4c6c33335200c00351982ff46002fd60cd5c5e194444b8798b6

data/README.md

@@ -86,6 +86,11 @@ You can create your own grammar by creating a gem that provides these files and
 
 ## Changelog
 
+### 11.0.0 (2021-10-29)
+
+* Prefix eId attributes in attachments with attachement's eId
+* Use crossHeading element for crossheadings
+
 ### 10.7.0 (11 June 2021)
 
 * Support underlines with `__text__`

data/lib/slaw/grammars/schedules_nodes.rb

@@ -97,8 +97,9 @@ module Slaw
 
           # the schedule id is derived from the heading
           schedule_id = self.schedule_id(heading_text, i)
+          eId = "att_#{i}"
 
-          b.attachment(eId: "att_#{i}") { |b|
+          b.attachment(eId: eId) { |b|
             schedule_title.to_xml(b, '', heading_text)
             b.doc_(name: "schedule") { |b|
               b.meta { |b|
@@ -128,7 +129,7 @@ module Slaw
               }
 
               b.mainBody { |b| 
-                body.children.elements.each_with_index { |e| e.to_xml(b, '', i) } if body.is_a? Body
+                body.children.elements.each_with_index { |e| e.to_xml(b, eId + "__", i) } if body.is_a? Body
               }
             }
           }

data/lib/slaw/grammars/za/act_nodes.rb

@@ -234,8 +234,14 @@ module Slaw
             section_title.num
           end
 
-          def to_xml(b, *args)
+          def to_xml(b, idprefix='', *args)
             id = "sec_#{Slaw::Grammars::Counters.clean(num)}"
+            # For historical reasons, we normally ignore the idprefix for sections, assuming
+            # them to be unique. However, in an attachment (eg. a schedule), ensure they
+            # are correctly prefixed
+            # TODO: always include the idprefix
+            id = idprefix + id if idprefix.start_with? 'att_'
+
             b.section(eId: id) { |b|
               section_title.to_xml(b)
 
@@ -371,13 +377,11 @@ module Slaw
 
         class Crossheading < Treetop::Runtime::SyntaxNode
           def to_xml(b, idprefix, i=0)
-            cnt = Slaw::Grammars::Counters.counters[idprefix]['hcontainer'] += 1
-            id = "#{idprefix}hcontainer_#{cnt}"
+            cnt = Slaw::Grammars::Counters.counters[idprefix]['crossHeading'] += 1
+            id = "#{idprefix}crossHeading_#{cnt}"
 
-            b.hcontainer(eId: id, name: 'crossheading') { |b|
-              b.heading { |b|
+            b.crossHeading(eId: id) { |b|
                 inline_items.to_xml(b, idprefix)
-              }
             }
           end
         end

data/lib/slaw/grammars/za/act_text.xsl

@@ -231,9 +231,9 @@
   </xsl:template>
 
   <!-- crossheadings -->
-  <xsl:template match="a:hcontainer[@name='crossheading']">
+  <xsl:template match="a:crossHeading">
     <xsl:text>CROSSHEADING </xsl:text>
-    <xsl:apply-templates select="a:heading" />
+    <xsl:apply-templates />
     <xsl:text>&#10;&#10;</xsl:text>
   </xsl:template>
 

data/lib/slaw/version.rb

@@ -1,3 +1,3 @@
 module Slaw
-  VERSION = "10.7.0"
+  VERSION = "11.0.0"
 end

data/spec/za/act_block_spec.rb

@@ -59,9 +59,7 @@ EOS
         <p>Hello there</p>
       </content>
     </hcontainer>
-    <hcontainer eId="sec_1__hcontainer_2" name="crossheading">
-      <heading>crossheading</heading>
-    </hcontainer>
+    <crossHeading eId="sec_1__crossHeading_1">crossheading</crossHeading>
   </section>
 </body>'
     end
@@ -96,9 +94,7 @@ EOS
       </blockList>
     </content>
   </hcontainer>
-  <hcontainer eId="hcontainer_2" name="crossheading">
-    <heading>crossheading</heading>
-  </hcontainer>
+  <crossHeading eId="crossHeading_1">crossheading</crossHeading>
   <section eId="sec_1">
     <num>1.</num>
     <heading>Section</heading>
@@ -107,9 +103,7 @@ EOS
         <p>Hello there</p>
       </content>
     </hcontainer>
-    <hcontainer eId="sec_1__hcontainer_2" name="crossheading">
-      <heading>crossheading</heading>
-    </hcontainer>
+    <crossHeading eId="sec_1__crossHeading_1">crossheading</crossHeading>
   </section>
 </body>'
     end
@@ -260,10 +254,8 @@ EOS
       to_xml(node).should == '<chapter eId="chp_2">
   <num>2</num>
   <heading>The Chapter Heading</heading>
-  <hcontainer eId="chp_2__hcontainer_1" name="crossheading">
-    <heading>crossheading</heading>
-  </hcontainer>
-  <hcontainer eId="chp_2__hcontainer_2" name="hcontainer">
+  <crossHeading eId="chp_2__crossHeading_1">crossheading</crossHeading>
+  <hcontainer eId="chp_2__hcontainer_1" name="hcontainer">
     <content>
       <p>Some lines at the start of the chapter.</p>
     </content>
@@ -489,9 +481,7 @@ EOS
       to_xml(node).should == '<part eId="part_2">
   <num>2</num>
   <heading>The Part Heading</heading>
-  <hcontainer eId="part_2__hcontainer_1" name="crossheading">
-    <heading>crossheading</heading>
-  </hcontainer>
+  <crossHeading eId="part_2__crossHeading_1">crossheading</crossHeading>
   <section eId="sec_1">
     <num>1.</num>
     <heading>Section</heading>
@@ -1872,9 +1862,7 @@ EOS
   context 'crossheadings' do
     it 'should handle a inline_items in crossheadings' do
       node = parse :crossheading, "CROSSHEADING something [[remark]] [link](/foo/bar)\n"
-      to_xml(node, '').should == '<hcontainer eId="hcontainer_1" name="crossheading">
-  <heading>something <remark status="editorial">[remark]</remark> <ref href="/foo/bar">link</ref></heading>
-</hcontainer>'
+      to_xml(node, '').should == '<crossHeading eId="crossHeading_1">something <remark status="editorial">[remark]</remark> <ref href="/foo/bar">link</ref></crossHeading>'
     end
 
     it 'should not be allowed in preface' do
@@ -1924,9 +1912,7 @@ Text
     <p>Some text</p>
   </preface>
   <body>
-    <hcontainer eId="hcontainer_1" name="crossheading">
-      <heading>In the body</heading>
-    </hcontainer>
+    <crossHeading eId="crossHeading_1">In the body</crossHeading>
     <section eId="sec_1">
       <num>1.</num>
       <heading>Section 1</heading>
@@ -1987,9 +1973,7 @@ Text
     <p>Some text</p>
   </preamble>
   <body>
-    <hcontainer eId="hcontainer_1" name="crossheading">
-      <heading>In the body</heading>
-    </hcontainer>
+    <crossHeading eId="crossHeading_1">In the body</crossHeading>
     <section eId="sec_1">
       <num>1.</num>
       <heading>Section 1</heading>

data/spec/za/act_inline_spec.rb

@@ -197,7 +197,7 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>
             <remark status="editorial">[Schedule 1 added by Act 23 of 2004]</remark>

data/spec/za/act_schedules_spec.rb

@@ -88,11 +88,11 @@ EOS
         </identification>
       </meta>
       <mainBody>
-        <section eId="sec_1">
+        <section eId="att_1__sec_1">
           <num>1.</num>
           <heading>Foo</heading>
         </section>
-        <section eId="sec_2">
+        <section eId="att_1__sec_2">
           <num>2.</num>
           <heading>Bar</heading>
         </section>
@@ -129,7 +129,7 @@ EOS
         </identification>
       </meta>
       <mainBody>
-        <hcontainer eId="hcontainer_1" name="hcontainer">
+        <hcontainer eId="att_2__hcontainer_1" name="hcontainer">
           <content>
             <p>Baz</p>
             <p>Boom</p>
@@ -186,16 +186,16 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Subject to approval in terms of this By-Law, the erection:</p>
         </content>
       </hcontainer>
-      <section eId="sec_1">
+      <section eId="att_1__sec_1">
         <num>1.</num>
         <heading>Foo</heading>
       </section>
-      <section eId="sec_2">
+      <section eId="att_1__sec_2">
         <num>2.</num>
         <heading>Bar</heading>
       </section>
@@ -246,16 +246,16 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Subject to approval in terms of this By-Law, the erection:</p>
         </content>
       </hcontainer>
-      <section eId="sec_1">
+      <section eId="att_1__sec_1">
         <num>1.</num>
         <heading>Foo</heading>
       </section>
-      <section eId="sec_2">
+      <section eId="att_1__sec_2">
         <num>2.</num>
         <heading>Bar</heading>
       </section>
@@ -304,16 +304,16 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Subject to approval in terms of this By-Law, the erection:</p>
         </content>
       </hcontainer>
-      <section eId="sec_1">
+      <section eId="att_1__sec_1">
         <num>1.</num>
         <heading>Foo</heading>
       </section>
-      <section eId="sec_2">
+      <section eId="att_1__sec_2">
         <num>2.</num>
         <heading>Bar</heading>
       </section>
@@ -372,19 +372,19 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <part eId="part_I">
+      <part eId="att_1__part_I">
         <num>I</num>
         <heading>Form of authentication statement</heading>
-        <hcontainer eId="part_I__hcontainer_1" name="hcontainer">
+        <hcontainer eId="att_1__part_I__hcontainer_1" name="hcontainer">
           <content>
             <p>This printed impression has been carefully compared by me with the bill which was passed by Parliament and found by me to be a true copy of the bill.</p>
           </content>
         </hcontainer>
       </part>
-      <part eId="part_II">
+      <part eId="att_1__part_II">
         <num>II</num>
         <heading>Form of statement of the President’s assent.</heading>
-        <hcontainer eId="part_II__hcontainer_1" name="hcontainer">
+        <hcontainer eId="att_1__part_II__hcontainer_1" name="hcontainer">
           <content>
             <p>I signify my assent to the bill and a whole bunch of other stuff.</p>
           </content>
@@ -447,7 +447,7 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Subject to approval in terms of this By-Law.</p>
           <p>Schedule another</p>
@@ -499,7 +499,7 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Subject to approval in terms of this By-Law.</p>
         </content>
@@ -550,16 +550,16 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Subject to approval in terms of this By-Law, the erection:</p>
         </content>
       </hcontainer>
-      <section eId="sec_1">
+      <section eId="att_1__sec_1">
         <num>1.</num>
         <heading>Foo</heading>
       </section>
-      <section eId="sec_2">
+      <section eId="att_1__sec_2">
         <num>2.</num>
         <heading>Bar</heading>
       </section>
@@ -608,12 +608,12 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Subject to approval in terms of this By-Law, the erection:</p>
         </content>
       </hcontainer>
-      <section eId="sec_1">
+      <section eId="att_1__sec_1">
         <num>1.</num>
         <heading>Foo</heading>
       </section>
@@ -665,16 +665,16 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Subject to approval in terms of this By-Law, the erection:</p>
         </content>
       </hcontainer>
-      <section eId="sec_1">
+      <section eId="att_1__sec_1">
         <num>1.</num>
         <heading>Foo</heading>
       </section>
-      <section eId="sec_2">
+      <section eId="att_1__sec_2">
         <num>2.</num>
         <heading>Bar</heading>
       </section>
@@ -729,11 +729,11 @@ EOS
         </identification>
       </meta>
       <mainBody>
-        <section eId="sec_1">
+        <section eId="att_1__sec_1">
           <num>1.</num>
           <heading>Foo</heading>
         </section>
-        <section eId="sec_2">
+        <section eId="att_1__sec_2">
           <num>2.</num>
           <heading>Bar</heading>
         </section>
@@ -770,7 +770,7 @@ EOS
         </identification>
       </meta>
       <mainBody>
-        <hcontainer eId="hcontainer_1" name="hcontainer">
+        <hcontainer eId="att_2__hcontainer_1" name="hcontainer">
           <content>
             <p>Baz</p>
             <p>Boom</p>
@@ -826,16 +826,16 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Subject to approval in terms of this By-Law, the erection:</p>
         </content>
       </hcontainer>
-      <section eId="sec_1">
+      <section eId="att_1__sec_1">
         <num>1.</num>
         <heading>Foo</heading>
       </section>
-      <section eId="sec_2">
+      <section eId="att_1__sec_2">
         <num>2.</num>
         <heading>Bar</heading>
       </section>
@@ -885,16 +885,16 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Subject to approval in terms of this By-Law, the erection:</p>
         </content>
       </hcontainer>
-      <section eId="sec_1">
+      <section eId="att_1__sec_1">
         <num>1.</num>
         <heading>Foo</heading>
       </section>
-      <section eId="sec_2">
+      <section eId="att_1__sec_2">
         <num>2.</num>
         <heading>Bar</heading>
       </section>
@@ -942,16 +942,16 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Subject to approval in terms of this By-Law, the erection:</p>
         </content>
       </hcontainer>
-      <section eId="sec_1">
+      <section eId="att_1__sec_1">
         <num>1.</num>
         <heading>Foo</heading>
       </section>
-      <section eId="sec_2">
+      <section eId="att_1__sec_2">
         <num>2.</num>
         <heading>Bar</heading>
       </section>
@@ -1001,16 +1001,16 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Other than as is set out hereinbelow, no signs other than locality bound signs, temporary signs including loose portable sign, estate agents signs, newspaper headline posters and posters (the erection of which must comply with the appropriate schedules pertinent thereto) shall be erected on Municipal owned land.</p>
         </content>
       </hcontainer>
-      <section eId="sec_1">
+      <section eId="att_1__sec_1">
         <num>1.</num>
         <heading>Foo</heading>
       </section>
-      <section eId="sec_2">
+      <section eId="att_1__sec_2">
         <num>2.</num>
         <heading>Bar</heading>
       </section>
@@ -1060,7 +1060,7 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Subject to approval in terms of this By-Law.</p>
         </content>

data/spec/za/act_table_spec.rb

@@ -298,10 +298,10 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <hcontainer eId="hcontainer_1" name="hcontainer">
+      <hcontainer eId="att_1__hcontainer_1" name="hcontainer">
         <content>
           <p>Heres a table:</p>
-          <table eId="hcontainer_1__table_1">
+          <table eId="att_1__hcontainer_1__table_1">
             <tr>
               <td>
                 <p>r1c1</p>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slaw
 version: !ruby/object:Gem::Version
-  version: 10.7.0
+  version: 11.0.0
 platform: ruby
 authors:
 - Greg Kempe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A lightweight library for using Akoma Ntoso acts in Ruby.