slaw 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9bf7237f83956f343675d24a55a77043dd4eaed
-  data.tar.gz: 4dbde167eb2194d5f8786c2a02b97204085b031d
+  metadata.gz: 657367d2055974b4c1e986050ef45bf27e625bec
+  data.tar.gz: 5b90b89cbc9bd4a3a546d4b2b7cd80e85ff9bc46
 SHA512:
-  metadata.gz: 3e204d080a241d971c49fcf06e4ff17fdd22418fcfaca3238f985c59a710895ce0d5ab61c32fde518f9885806d9c5bbf031b461b940e82c5acff85bd8daa6f3a
-  data.tar.gz: ce9e7b1b28a9799ad4d8451a0225be98707fd0ab144f10cae7a61cfb16a20a3720c975d0db08b9b5bfa36802ba874cff73f1d4fa41f46048e3f70453df99e61f
+  metadata.gz: e4f9f19d7f74e1721e5ef43daf946120ac0b518155d7167ef5d0677d249bc1cd47efb3e542d4288837c51561675850beb0591291dea9baa858827f3aedee7bd0
+  data.tar.gz: ec3b48956ed66ed38b309e6b60e7108d5bd89e90b018ca3f3472806de4ee1f2a4d636149922749b89e6503e9f5ae253c6dcab1765eaeec903a4ad164f01e95bf

data/README.md

@@ -218,6 +218,11 @@ Akoma Ntoso `component` elements at the end of the XML document, with a name of
 
 ## Changelog
 
+### 0.12.0
+
+* Support links/references using Markdown-like \[text](href) syntax.
+* FIX allow remarks in blocklist items
+
 ### 0.11.0
 
 * Support newlines in table cells as EOL (or BR in HTML)

data/lib/slaw/version.rb

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

data/lib/slaw/za/act.treetop

@@ -150,7 +150,7 @@ module Slaw
       end
 
       rule blocklist_item
-        space? blocklist_item_prefix whitespace item_content:(!blocklist_item_prefix content eol)? eol?
+        space? blocklist_item_prefix whitespace item_content:(!blocklist_item_prefix clauses eol)? eol?
         <BlocklistItem>
       end
 
@@ -192,7 +192,7 @@ module Slaw
 
       # one or more words, allowing inline elements
       rule clauses
-        ((remark / [^ \t\n]+) [ \t]*)+
+        (remark / ref / [^\n])*
         <Clauses>
       end
 
@@ -201,6 +201,13 @@ module Slaw
         <Remark>
       end
 
+      rule ref
+        # links like markdown
+        # eg. [link text](link url)
+        '[' content:(!'](' [^\n])+ '](' href:([^)\n]+) ')'
+        <Ref>
+      end
+
       ##########
       # prefixes
 

data/lib/slaw/za/act_nodes.rb

@@ -289,12 +289,10 @@ module Slaw
       class Clauses < Treetop::Runtime::SyntaxNode
         def to_xml(b, idprefix=nil)
           for e in elements
-            for e2 in e.elements
-              if e2.respond_to? :to_xml
-                e2.to_xml(b, idprefix)
-              else
-                b << e2.text_value
-              end
+            if e.respond_to? :to_xml
+              e.to_xml(b, idprefix)
+            else
+              b << e.text_value
             end
           end
         end
@@ -306,6 +304,12 @@ module Slaw
         end
       end
 
+      class Ref < Treetop::Runtime::SyntaxNode
+        def to_xml(b, idprefix)
+          b.ref(content.text_value, href: href.text_value)
+        end
+      end
+
       class Blocklist < Treetop::Runtime::SyntaxNode
         # Render a block list to xml. If a block is given,
         # yield to it a builder to insert a listIntroduction node
@@ -326,15 +330,10 @@ module Slaw
           blocklist_item_prefix.text_value
         end
 
-        def content
-          # TODO this really seems a bit odd
-          item_content.content.text_value if respond_to? :item_content and item_content.respond_to? :content
-        end
-
         def to_xml(b, idprefix)
           b.item(id: idprefix + num.gsub(/[()]/, '')) { |b|
             b.num(num)
-            b.p(content) if content
+            b.p { |b| item_content.clauses.to_xml(b, idprefix) } if respond_to? :item_content and item_content.respond_to? :clauses
           }
         end
       end

data/lib/slaw/za/act_text.xsl

@@ -230,6 +230,14 @@
     <xsl:text>]</xsl:text>
   </xsl:template>
 
+  <xsl:template match="a:ref">
+    <xsl:text>[</xsl:text>
+    <xsl:apply-templates />
+    <xsl:text>](</xsl:text>
+    <xsl:value-of select="@href" />
+    <xsl:text>)</xsl:text>
+  </xsl:template>
+
   <xsl:template match="a:eol">
     <xsl:text>
 </xsl:text>

data/spec/generator_spec.rb

@@ -166,6 +166,25 @@ XML
 
 Section 1 [[ foo ]]
 
+'
+    end
+
+    it 'should unparse refs correctly' do
+      doc = xml2doc(section(<<XML
+        <num>1.</num>
+        <paragraph id="section-19.paragraph-0">
+          <content>
+            <p>Hello <ref href="/za/act/123">there</ref> friend.</p>
+          </content>
+        </paragraph>
+XML
+      ))
+
+      text = subject.text_from_act(doc)
+      text.should == '1. 
+
+Hello [there](/za/act/123) friend.
+
 '
     end
 

data/spec/za/act_spec.rb

@@ -795,6 +795,37 @@ EOS
 </section>'
     end
 
+    it 'should handle a remark in a blocklist' do
+      node = parse :section, <<EOS
+      1. Section title
+      Some text is a long line.
+
+      (1) something
+      (a) with a remark [[Section 1 amended by Act 23 of 2004]]
+EOS
+      to_xml(node).should == '<section id="section-1">
+  <num>1.</num>
+  <heading>Section title</heading>
+  <paragraph id="section-1.paragraph-0">
+    <content>
+      <p>Some text is a long line.</p>
+    </content>
+  </paragraph>
+  <subsection id="section-1.1">
+    <num>(1)</num>
+    <content>
+      <p>something</p>
+      <blockList id="section-1.1.list1">
+        <item id="section-1.1.list1.a">
+          <num>(a)</num>
+          <p>with a remark <remark status="editorial">[Section 1 amended by Act 23 of 2004]</remark></p>
+        </item>
+      </blockList>
+    </content>
+  </subsection>
+</section>'
+    end
+
     it 'should handle a remark in a schedule' do
       node = parse :schedule, <<EOS
       Schedule 1
@@ -851,6 +882,98 @@ EOS
     end
   end
 
+  #-------------------------------------------------------------------------------
+  # Refs
+
+  describe 'ref' do
+    it 'should handle a plain ref' do
+      node = parse :block_paragraphs, <<EOS
+      Hello [there](/za/act/123) friend.
+EOS
+      to_xml(node, "").should == '<paragraph id="paragraph-0">
+  <content>
+    <p>Hello <ref href="/za/act/123">there</ref> friend.</p>
+  </content>
+</paragraph>'
+    end
+
+    it 'should work many on a line' do
+      node = parse :block_paragraphs, <<EOS
+      Hello [there](/za/act/123) friend [and](http://foo.bar.com/with space) you too.
+EOS
+      to_xml(node, "").should == '<paragraph id="paragraph-0">
+  <content>
+    <p>Hello <ref href="/za/act/123">there</ref> friend <ref href="http://foo.bar.com/with space">and</ref> you too.</p>
+  </content>
+</paragraph>'
+    end
+
+    it 'should handle brackets' do
+      node = parse :block_paragraphs, <<EOS
+      Hello ([there](/za/act/123)).
+EOS
+      to_xml(node, "").should == '<paragraph id="paragraph-0">
+  <content>
+    <p>Hello (<ref href="/za/act/123">there</ref>).</p>
+  </content>
+</paragraph>'
+    end
+
+    it 'should handle many clauses on a line' do
+      node = parse :block_paragraphs, <<EOS
+      Hello [there](/za/act/123)[[remark one]] my[friend](/za) [[remark 2]][end](/foo).
+EOS
+      to_xml(node, "").should == '<paragraph id="paragraph-0">
+  <content>
+    <p>Hello <ref href="/za/act/123">there</ref><remark status="editorial">[remark one]</remark> my<ref href="/za">friend</ref> <remark status="editorial">[remark 2]</remark><ref href="/foo">end</ref>.</p>
+  </content>
+</paragraph>'
+    end
+
+    it 'text should not cross end of line' do
+      node = parse :block_paragraphs, <<EOS
+      Hello [there
+      
+      my](/za/act/123) friend.
+EOS
+      to_xml(node, "").should == '<paragraph id="paragraph-0">
+  <content>
+    <p>Hello [there</p>
+    <p>my](/za/act/123) friend.</p>
+  </content>
+</paragraph>'
+    end
+
+    it 'href should not cross end of line' do
+      node = parse :block_paragraphs, <<EOS
+      Hello [there](/za/act
+      /123) friend.
+EOS
+      to_xml(node, "").should == '<paragraph id="paragraph-0">
+  <content>
+    <p>Hello [there](/za/act</p>
+    <p>/123) friend.</p>
+  </content>
+</paragraph>'
+    end
+
+    it 'href should handle refs in a list' do
+      node = parse :block_paragraphs, <<EOS
+      2.18.1 a traffic officer appointed in terms of section 3 of the Road Traffic [Act, No. 29 of 1989](/za/act/1989/29) or section 3A of the National Road Traffic [Act No. 93 of 1996](/za/act/1996/93) as the case may be;
+EOS
+      to_xml(node, "").should == '<paragraph id="paragraph-0">
+  <content>
+    <blockList id="paragraph-0.list0">
+      <item id="paragraph-0.list0.2.18.1">
+        <num>2.18.1</num>
+        <p>a traffic officer appointed in terms of section 3 of the Road Traffic <ref href="/za/act/1989/29">Act, No. 29 of 1989</ref> or section 3A of the National Road Traffic <ref href="/za/act/1996/93">Act No. 93 of 1996</ref> as the case may be;</p>
+      </item>
+    </blockList>
+  </content>
+</paragraph>'
+    end
+  end
+
   #-------------------------------------------------------------------------------
   # Numbered statements
 
@@ -2025,12 +2148,12 @@ EOS
     it 'should handle a clause with a remark' do
       node = parse :clauses, "simple [[remark]]. text"
       node.text_value.should == "simple [[remark]]. text"
-      node.elements[1].elements.first.is_a?(Slaw::ZA::Act::Remark).should be_true
+      node.elements[7].is_a?(Slaw::ZA::Act::Remark).should be_true
 
       node = parse :clauses, "simple [[remark]][[another]] text"
       node.text_value.should == "simple [[remark]][[another]] text"
-      node.elements[1].elements.first.is_a?(Slaw::ZA::Act::Remark).should be_true
-      node.elements[2].elements.first.is_a?(Slaw::ZA::Act::Remark).should be_true
+      node.elements[7].is_a?(Slaw::ZA::Act::Remark).should be_true
+      node.elements[7].is_a?(Slaw::ZA::Act::Remark).should be_true
     end
   end
 end

metadata

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