slaw 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 657367d2055974b4c1e986050ef45bf27e625bec
-  data.tar.gz: 5b90b89cbc9bd4a3a546d4b2b7cd80e85ff9bc46
+  metadata.gz: 60aacb892dc41e5b6f92e698df123bd34c46a585
+  data.tar.gz: 4aa1590df1aac33962cb38780235bd45a7e522be
 SHA512:
-  metadata.gz: e4f9f19d7f74e1721e5ef43daf946120ac0b518155d7167ef5d0677d249bc1cd47efb3e542d4288837c51561675850beb0591291dea9baa858827f3aedee7bd0
-  data.tar.gz: ec3b48956ed66ed38b309e6b60e7108d5bd89e90b018ca3f3472806de4ee1f2a4d636149922749b89e6503e9f5ae253c6dcab1765eaeec903a4ad164f01e95bf
+  metadata.gz: ebd4dfc35e3f15518236ddea7bfd961482e768a39703bb4e123cb04695825938cd426600773ef3323592a616ea07be9eeaf678222cd7243c6fccf263a9cf1065
+  data.tar.gz: 1fbfd3883cb51575e7318f2bf1e1935ad6e5dc3ff1bed9f9dd6d71e19eb9c7bf895b2b7829a3402bc529675d80b34aeb921853c179074d77dc72437a8bc1c6ea

data/README.md

@@ -218,6 +218,12 @@ Akoma Ntoso `component` elements at the end of the XML document, with a name of
 
 ## Changelog
 
+### 0.13.0
+
+* FIX allow Schedule, Part and other headings at the start of blocklist and subsections
+* FIX replace empty CONTENT elements with empty P tags so XML validates
+* Better handling of empty subsections and blocklist items
+
 ### 0.12.0
 
 * Support links/references using Markdown-like \[text](href) syntax.

data/lib/slaw/version.rb

@@ -1,3 +1,3 @@
 module Slaw
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/lib/slaw/za/act.treetop

@@ -52,8 +52,11 @@ module Slaw
       end
 
       rule subsection
-        # TODO: do it make sense to allow an eol here?
-        space? subsection_prefix whitespace eol?
+        space? subsection_prefix space?
+        # eg: (2) (a) foo
+        first_child:inline_block_element?
+        # eg: (2)
+        eol?
         children:block_element* <Subsection>
       end
 
@@ -125,6 +128,9 @@ module Slaw
       end
 
       rule section_title_content
+        # don't match subsections, eg.
+        #
+        # 10. (1) subsection content...
         space !subsection_prefix content eol
       end
 
@@ -145,12 +151,19 @@ module Slaw
         (table / blocklist / naked_statement)
       end
 
+      # Block elements that don't have to appear at the start of a line.
+      # ie. we don't need to guard against the start of a chapter, section, etc.
+      rule inline_block_element
+        (table / blocklist / inline_statement)
+      end
+
       rule blocklist
         blocklist_item+ <Blocklist>
       end
 
       rule blocklist_item
-        space? blocklist_item_prefix whitespace item_content:(!blocklist_item_prefix clauses eol)? eol?
+        # TODO: this whitespace should probably be space, to allow empty blocklist items followed by plain text
+        space? blocklist_item_prefix whitespace item_content:(!blocklist_item_prefix clauses:clauses? eol)? eol?
         <BlocklistItem>
       end
 
@@ -187,12 +200,17 @@ module Slaw
         <NakedStatement>
       end
 
+      rule inline_statement
+        space? '\\'? clauses eol
+        <NakedStatement>
+      end
+
       ##########
       # inline content
 
       # one or more words, allowing inline elements
       rule clauses
-        (remark / ref / [^\n])*
+        (remark / ref / [^\n])+
         <Clauses>
       end
 

data/lib/slaw/za/act_nodes.rb

@@ -267,10 +267,18 @@ module Slaw
           id = idprefix + num.gsub(/[()]/, '')
           idprefix = id + "."
 
+          kids = children.elements
+          kids = [first_child] + kids if first_child and !first_child.empty?
+
           b.subsection(id: id) { |b|
             b.num(num)
             b.content { |b|
-              children.elements.each_with_index { |e, i| e.to_xml(b, idprefix, i) }
+              if kids.empty?
+                # schema requires a non-empty content element
+                b.p
+              else
+                kids.each_with_index { |e, i| e.to_xml(b, idprefix, i) }
+              end
             }
           }
         end
@@ -333,7 +341,9 @@ module Slaw
         def to_xml(b, idprefix)
           b.item(id: idprefix + num.gsub(/[()]/, '')) { |b|
             b.num(num)
-            b.p { |b| item_content.clauses.to_xml(b, idprefix) } if respond_to? :item_content and item_content.respond_to? :clauses
+            b.p { |b|
+              item_content.clauses.to_xml(b, idprefix) if respond_to? :item_content and item_content.respond_to? :clauses
+            }
           }
         end
       end

data/spec/za/act_spec.rb

@@ -586,6 +586,63 @@ EOS
 </subsection>'
     end
 
+    it 'should handle a subsection that is empty and dives straight into a list' do
+      node = parse(:subsection, <<EOS
+        (1)
+        (a) one
+        (b) two
+EOS
+                  )
+      to_xml(node, "", 1).should == '<subsection id="1">
+  <num>(1)</num>
+  <content>
+    <blockList id="1.list0">
+      <item id="1.list0.a">
+        <num>(a)</num>
+        <p>one</p>
+      </item>
+      <item id="1.list0.b">
+        <num>(b)</num>
+        <p>two</p>
+      </item>
+    </blockList>
+  </content>
+</subsection>'
+    end
+
+    it 'should handle empty subsections' do
+      node = parse(:section, <<EOS
+        1. Section
+        (1)
+        (2)
+        next line
+        (3) third
+EOS
+                  )
+      to_xml(node).should == '<section id="section-1">
+  <num>1.</num>
+  <heading>Section</heading>
+  <subsection id="section-1.1">
+    <num>(1)</num>
+    <content>
+      <p/>
+    </content>
+  </subsection>
+  <subsection id="section-1.2">
+    <num>(2)</num>
+    <content>
+      <p>next line</p>
+    </content>
+  </subsection>
+  <subsection id="section-1.3">
+    <num>(3)</num>
+    <content>
+      <p>third</p>
+    </content>
+  </subsection>
+</section>'
+    end
+
     it 'should handle a blocklist that dives straight into another list' do
       node = parse(:subsection, <<EOS
         (1) here's my really cool list,
@@ -605,6 +662,41 @@ EOS
       </item>
       <item id="1.list1.b">
         <num>(b)</num>
+        <p/>
+      </item>
+      <item id="1.list1.i">
+        <num>(i)</num>
+        <p>single</p>
+      </item>
+      <item id="1.list1.ii">
+        <num>(ii)</num>
+        <p>double</p>
+      </item>
+    </blockList>
+  </content>
+</subsection>'
+    end
+
+    it 'should handle a blocklist with empty elements' do
+      node = parse(:subsection, <<EOS
+        (1) here's my really cool list,
+        (a)
+        (b) (i) single
+        (ii) double
+EOS
+                  )
+      to_xml(node, "", 1).should == '<subsection id="1">
+  <num>(1)</num>
+  <content>
+    <p>here\'s my really cool list,</p>
+    <blockList id="1.list1">
+      <item id="1.list1.a">
+        <num>(a)</num>
+        <p/>
+      </item>
+      <item id="1.list1.b">
+        <num>(b)</num>
+        <p/>
       </item>
       <item id="1.list1.i">
         <num>(i)</num>
@@ -721,6 +813,33 @@ EOS
   </content>
 </subsection>'
     end
+
+    it 'should ignore block elements mid-subsection' do
+      node = parse :body, <<EOS
+1. Section
+
+(2) Schedule 1 is cool.
+(3) Part 1
+EOS
+      to_xml(node).should == '<body>
+  <section id="section-1">
+    <num>1.</num>
+    <heading>Section</heading>
+    <subsection id="section-1.2">
+      <num>(2)</num>
+      <content>
+        <p>Schedule 1 is cool.</p>
+      </content>
+    </subsection>
+    <subsection id="section-1.3">
+      <num>(3)</num>
+      <content>
+        <p>Part 1</p>
+      </content>
+    </subsection>
+  </section>
+</body>'
+    end
   end
 
   #-------------------------------------------------------------------------------
@@ -1407,6 +1526,48 @@ EOS
 </section>'
     end
 
+    it 'should handle empty subsections and empty lines' do
+      node = parse :section, <<EOS
+1. Section
+
+(1)
+
+something
+
+(2) Schedule 1
+
+(a) Part 1
+
+(b) thing
+EOS
+      to_xml(node, "").should == '<section id="section-1">
+  <num>1.</num>
+  <heading>Section</heading>
+  <subsection id="section-1.1">
+    <num>(1)</num>
+    <content>
+      <p>something</p>
+    </content>
+  </subsection>
+  <subsection id="section-1.2">
+    <num>(2)</num>
+    <content>
+      <p>Schedule 1</p>
+      <blockList id="section-1.2.list1">
+        <item id="section-1.2.list1.a">
+          <num>(a)</num>
+          <p>Part 1</p>
+        </item>
+        <item id="section-1.2.list1.b">
+          <num>(b)</num>
+          <p>thing</p>
+        </item>
+      </blockList>
+    </content>
+  </subsection>
+</section>'
+    end
+
     it 'should ignore escaped section headings' do
       node = parse :section, <<EOS
 1. Section
@@ -2134,6 +2295,27 @@ EOS
   </content>
 </paragraph>'
     end
+
+    it 'should allow a table as part of a subsection' do
+      node = parse :subsection, <<EOS
+(1) {|
+| foo
+|}
+EOS
+
+      to_xml(node, '', 0).should == '<subsection id="1">
+  <num>(1)</num>
+  <content>
+    <table id="1.table0">
+      <tr>
+        <td>
+          <p>foo</p>
+        </td>
+      </tr>
+    </table>
+  </content>
+</subsection>'
+    end
   end
 
   #-------------------------------------------------------------------------------

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slaw
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Greg Kempe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-23 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler