slaw 6.2.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eccd929903562e49bbd2ed7d10cd54733d4adce9e304aa94009e7c2ec8876b9a
-  data.tar.gz: ad3e092d320e446fb14c24b78ac85041da8f76c19c783ba559cee413f52d1b7e
+  metadata.gz: fde17ca3304eb910432a89b75fe777e9ce50cf1abed667d2bb7b2d673bc77aa0
+  data.tar.gz: 7102e2b19079e12bbf89c783aed99a48b9cd645f9dac396b0b68061279e86174
 SHA512:
-  metadata.gz: 2cd345f3906a9fa7742e7e57e631ef39e50c449e7f80beebd891c51a8053acbc2745b7ed7963d996494cf58478826d9161a57a25e3c0808f0d3a2f1a5bc924c6
-  data.tar.gz: afd015ffd10e75e222907a02b7c5bcd1cb0535287a6618cf78afd4c18333705985c060c78e5564e7a228d1047b33680c680a4526a22e6649164db6e54335f92b
+  metadata.gz: c7740c01a12b46d138051b82de734a67806155f5166c2c0c56a9aab1d7d5fc8e79526260bc4236310cd88215dd742ce3beabb298288c086f5a39111375d825ff
+  data.tar.gz: 219658ca25c23b52ce5f7ae499728a8e183b488db3f03477cb726d5f88f7ec290faf26a02727c8eb705f21ea85866f64d3e437799b0cafdb53fb3a087fd80144

data/README.md

@@ -81,6 +81,11 @@ You can create your own grammar by creating a gem that provides these files and
 
 ## Changelog
 
+### 7.0.0 (31 Jan 2020)
+
+* Lists ids are now numbered sequentially, rather than by tree position
+* New Slaw::Grammars::Counters helper module
+
 ### 6.2.0 (15 Jan 2020)
 
 * Better support for ol, ul and li when importing from HTML

data/lib/slaw/grammars/counters.rb

@@ -0,0 +1,27 @@
+module Slaw
+  module Grammars
+    class Counters
+      # Counters for generating element IDs. This is a hash from the element ID
+      # prefix, to another hash that maps the element type name to a count.
+      #
+      # For backwards compatibility, counters always start at -1, and must be
+      # incremented before being used. This ensures that element ids start at 0.
+      # This is NOT compatible with AKN 3.0 which requires that element numbers
+      # start at 1.
+      #
+      # eg.
+      #
+      #   section-1 => paragraph => 2
+      #
+      @@counters = Hash.new{ |h, k| h[k] = Hash.new(-1) }
+
+      def self.counters
+        @@counters
+      end
+
+      def self.reset!
+        @@counters.clear
+      end
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
 require 'slaw/grammars/core_nodes'
+require 'slaw/grammars/counters'
 
 module Slaw
   module Grammars
@@ -281,16 +282,9 @@ module Slaw
         end
 
         class BlockElements < Treetop::Runtime::SyntaxNode
-          @@counters = {}
-
-          def self.counters
-            @@counters
-          end
-
           def to_xml(b, idprefix='', i=0)
-            @@counters[idprefix] ||= -1
-            @@counters[idprefix] += 1
-            id = "#{idprefix}paragraph#{@@counters[idprefix]}"
+            cnt = Slaw::Grammars::Counters.counters[idprefix]['paragraph'] += 1
+            id = "#{idprefix}paragraph#{cnt}"
             idprefix = "#{id}."
 
             b.paragraph(id: id) { |b|
@@ -321,7 +315,8 @@ module Slaw
           # Render a block list to xml. If a block is given,
           # yield to it a builder to insert a listIntroduction node
           def to_xml(b, idprefix, i=0, &block)
-            id = idprefix + "list#{i}"
+            cnt = Slaw::Grammars::Counters.counters[idprefix]['list'] += 1
+            id = idprefix + "list#{cnt}"
             idprefix = id + '.'
 
             b.blockList(id: id, renest: true) { |b|
@@ -348,16 +343,9 @@ module Slaw
         end
 
         class Crossheading < Treetop::Runtime::SyntaxNode
-          @@counters = {}
-
-          def self.counters
-            @@counters
-          end
-
           def to_xml(b, idprefix, i=0)
-            @@counters[idprefix] ||= -1
-            @@counters[idprefix] += 1
-            id = "#{idprefix}crossheading-#{@@counters[idprefix]}"
+            cnt = Slaw::Grammars::Counters.counters[idprefix]['crossheading'] += 1
+            id = "#{idprefix}crossheading-#{cnt}"
 
             b.hcontainer(id: id, name: 'crossheading') { |b|
               b.heading { |b|

data/lib/slaw/version.rb

@@ -1,3 +1,3 @@
 module Slaw
-  VERSION = "6.2.0"
+  VERSION = "7.0.0"
 end

data/spec/za/act_block_spec.rb

@@ -29,8 +29,7 @@ describe Slaw::ActGenerator do
   end
 
   before(:each) do
-    Slaw::Grammars::ZA::Act::Crossheading.counters.clear
-    Slaw::Grammars::ZA::Act::BlockElements.counters.clear
+    Slaw::Grammars::Counters.reset!
   end
 
   #-------------------------------------------------------------------------------
@@ -85,12 +84,12 @@ EOS
   <paragraph id="paragraph0">
     <content>
       <p>Some content before the section</p>
-      <blockList id="paragraph0.list1" renest="true">
-        <item id="paragraph0.list1.a">
+      <blockList id="paragraph0.list0" renest="true">
+        <item id="paragraph0.list0.a">
           <num>(a)</num>
           <p>foo</p>
         </item>
-        <item id="paragraph0.list1.b">
+        <item id="paragraph0.list0.b">
           <num>(b)</num>
           <p>bar</p>
         </item>
@@ -778,20 +777,20 @@ EOS
   <num>(2)</num>
   <content>
     <p>title</p>
-    <blockList id="2.list1" renest="true">
-      <item id="2.list1.a">
+    <blockList id="2.list0" renest="true">
+      <item id="2.list0.a">
         <num>(a)</num>
         <p>one</p>
       </item>
-      <item id="2.list1.b">
+      <item id="2.list0.b">
         <num>(b)</num>
         <p>two</p>
       </item>
-      <item id="2.list1.c">
+      <item id="2.list0.c">
         <num>(c)</num>
         <p>three</p>
       </item>
-      <item id="2.list1.i">
+      <item id="2.list0.i">
         <num>(i)</num>
         <p>four</p>
       </item>
@@ -902,20 +901,20 @@ EOS
   <num>(1)</num>
   <content>
     <p>here\'s my really cool list,</p>
-    <blockList id="1.list1" renest="true">
-      <item id="1.list1.a">
+    <blockList id="1.list0" renest="true">
+      <item id="1.list0.a">
         <num>(a)</num>
         <p>one</p>
       </item>
-      <item id="1.list1.b">
+      <item id="1.list0.b">
         <num>(b)</num>
         <p/>
       </item>
-      <item id="1.list1.i">
+      <item id="1.list0.i">
         <num>(i)</num>
         <p>single</p>
       </item>
-      <item id="1.list1.ii">
+      <item id="1.list0.ii">
         <num>(ii)</num>
         <p>double</p>
       </item>
@@ -936,20 +935,20 @@ EOS
   <num>(1)</num>
   <content>
     <p>here\'s my really cool list,</p>
-    <blockList id="1.list1" renest="true">
-      <item id="1.list1.a">
+    <blockList id="1.list0" renest="true">
+      <item id="1.list0.a">
         <num>(a)</num>
         <p/>
       </item>
-      <item id="1.list1.b">
+      <item id="1.list0.b">
         <num>(b)</num>
         <p/>
       </item>
-      <item id="1.list1.i">
+      <item id="1.list0.i">
         <num>(i)</num>
         <p>single</p>
       </item>
-      <item id="1.list1.ii">
+      <item id="1.list0.ii">
         <num>(ii)</num>
         <p>double</p>
       </item>
@@ -978,16 +977,16 @@ EOS
   <num>9.9</num>
   <content>
     <p>foo</p>
-    <blockList id="9.9.list1" renest="true">
-      <item id="9.9.list1.9.9.1">
+    <blockList id="9.9.list0" renest="true">
+      <item id="9.9.list0.9.9.1">
         <num>9.9.1</num>
         <p>item1</p>
       </item>
-      <item id="9.9.list1.9.9.2">
+      <item id="9.9.list0.9.9.2">
         <num>9.9.2</num>
         <p>item2</p>
       </item>
-      <item id="9.9.list1.9.9.2.1">
+      <item id="9.9.list0.9.9.2.1">
         <num>9.9.2.1</num>
         <p>item3</p>
       </item>
@@ -1012,23 +1011,23 @@ EOS
   <num>(1)</num>
   <content>
     <p>a list</p>
-    <blockList id="1.list1" renest="true">
-      <item id="1.list1.a">
+    <blockList id="1.list0" renest="true">
+      <item id="1.list0.a">
         <num>(a)</num>
         <p>item 1</p>
       </item>
-      <item id="1.list1.b">
+      <item id="1.list0.b">
         <num>(b)</num>
         <p>item 2</p>
       </item>
     </blockList>
     <p>some text</p>
-    <blockList id="1.list3" renest="true">
-      <item id="1.list3.c">
+    <blockList id="1.list1" renest="true">
+      <item id="1.list1.c">
         <num>(c)</num>
         <p>item 3</p>
       </item>
-      <item id="1.list3.d">
+      <item id="1.list1.d">
         <num>(d)</num>
         <p>item 4</p>
       </item>
@@ -1615,12 +1614,12 @@ EOS
   <paragraph id="section-1.paragraph0">
     <content>
       <p>naked statement (c) blah</p>
-      <blockList id="section-1.paragraph0.list1" renest="true">
-        <item id="section-1.paragraph0.list1.a">
+      <blockList id="section-1.paragraph0.list0" renest="true">
+        <item id="section-1.paragraph0.list0.a">
           <num>(a)</num>
           <p>foo</p>
         </item>
-        <item id="section-1.paragraph0.list1.b">
+        <item id="section-1.paragraph0.list0.b">
           <num>(b)</num>
           <p>bar</p>
         </item>
@@ -1657,12 +1656,12 @@ EOS
     <num>(2)</num>
     <content>
       <p>Schedule 1</p>
-      <blockList id="section-1.2.list1" renest="true">
-        <item id="section-1.2.list1.a">
+      <blockList id="section-1.2.list0" renest="true">
+        <item id="section-1.2.list0.a">
           <num>(a)</num>
           <p>Part 1</p>
         </item>
-        <item id="section-1.2.list1.b">
+        <item id="section-1.2.list0.b">
           <num>(b)</num>
           <p>thing</p>
         </item>
@@ -1729,12 +1728,12 @@ EOS
     <num>3.1</num>
     <content>
       <p>Informal trading may include, amongst others:-</p>
-      <blockList id="section-3.3.1.list1" renest="true">
-        <item id="section-3.3.1.list1.3.1.1">
+      <blockList id="section-3.3.1.list0" renest="true">
+        <item id="section-3.3.1.list0.3.1.1">
           <num>3.1.1</num>
           <p>street trading;</p>
         </item>
-        <item id="section-3.3.1.list1.3.1.2">
+        <item id="section-3.3.1.list0.3.1.2">
           <num>3.1.2</num>
           <p>trading in pedestrian malls;</p>
         </item>

data/spec/za/act_inline_spec.rb

@@ -29,8 +29,7 @@ describe Slaw::ActGenerator do
   end
 
   before(:each) do
-    Slaw::Grammars::ZA::Act::Crossheading.counters.clear
-    Slaw::Grammars::ZA::Act::BlockElements.counters.clear
+    Slaw::Grammars::Counters.reset!
   end
 
   #-------------------------------------------------------------------------------
@@ -146,8 +145,8 @@ EOS
     <num>(1)</num>
     <content>
       <p>something</p>
-      <blockList id="section-1.1.list1" renest="true">
-        <item id="section-1.1.list1.a">
+      <blockList id="section-1.1.list0" renest="true">
+        <item id="section-1.1.list0.a">
           <num>(a)</num>
           <p>with a remark <remark status="editorial">[Section 1 amended by Act 23 of 2004]</remark></p>
         </item>

data/spec/za/act_schedules_spec.rb

@@ -29,8 +29,7 @@ describe Slaw::ActGenerator do
   end
 
   before(:each) do
-    Slaw::Grammars::ZA::Act::Crossheading.counters.clear
-    Slaw::Grammars::ZA::Act::BlockElements.counters.clear
+    Slaw::Grammars::Counters.reset!
   end
 
   #-------------------------------------------------------------------------------

data/spec/za/act_table_spec.rb

@@ -29,8 +29,7 @@ describe Slaw::ActGenerator do
   end
 
   before(:each) do
-    Slaw::Grammars::ZA::Act::Crossheading.counters.clear
-    Slaw::Grammars::ZA::Act::BlockElements.counters.clear
+    Slaw::Grammars::Counters.reset!
   end
 
   describe 'tables' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slaw
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Greg Kempe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2020-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -130,6 +130,7 @@ files:
 - lib/slaw/extract/html_to_akn_text.xsl
 - lib/slaw/generator.rb
 - lib/slaw/grammars/core_nodes.rb
+- lib/slaw/grammars/counters.rb
 - lib/slaw/grammars/inlines.treetop
 - lib/slaw/grammars/inlines_nodes.rb
 - lib/slaw/grammars/schedules.treetop