slaw 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3403f22ffd64d8ab9ca92ad9e26fed22d0c38b9ab525cb0d91708c3f5e9a13d3
-  data.tar.gz: f2f40ece1aa1acc39bcb5cd2fdcda83449e883d98e86b6393433cb0284c060b0
+  metadata.gz: 4411a620b2f2ff5cad3942e1944d344a9e6282e654df6313a78a99e654a91347
+  data.tar.gz: '0789f05372eda817a52d97ba55ec4481f77d69557908709e3d4117b57c5d822b'
 SHA512:
-  metadata.gz: fc3a1f6fb83768feb8d1ec85538a33fffdb5e2d9678fdcf72ced7be712385b47c07dd141ba8caaf92fbcaeb0410c418999eab547f30ab521fe1717e820f8684a
-  data.tar.gz: 8c961961f1e3e7f43400c5541c9afca35cc3d26edfa78977a5e846626b743150657bf0441df2c465e12f1df28dd35af110dcdce52b1a94ab1a643a6b7194da79
+  metadata.gz: 9b0da1d5da9fb240a3efac4cd280fc567fc58979f219186c3b8719b13c3a3d2ebba5c20abc939e84b187539fa8a3d4ad1c5c7431b421902c0a7ae831dff51fda
+  data.tar.gz: be10a3d7c7ca33d81490b4c9c126a1bf2d6db2a9ec008bd989af4d3fb9485b55d74f560cf561b08b41669babd85831568be6f47937ee8b748ec6d4be02805712

data/README.md

@@ -81,7 +81,11 @@ You can create your own grammar by creating a gem that provides these files and
 
 ## Changelog
 
-### 3.1.1 (?)
+### 3.2.0 (22 April 2019)
+
+* Permit inline content in chapter, part and section headings
+
+### 3.1.1 (10 April 2019)
 
 * FIX don't error when a line is just a backslash
 

data/lib/slaw/grammars/terminals.treetop

@@ -3,15 +3,6 @@
 module Slaw
   module Grammars
     grammar Terminals
-      #########
-      ## one line of basic content
-
-      rule content
-        # anything but a newline, followed by a
-        # newline or end of file (without consuming the newline)
-        [^\n]+ &eol
-      end
-
       ##########
       # terminals
 

data/lib/slaw/grammars/za/act.treetop

@@ -106,12 +106,12 @@ module Slaw
         # headings
 
         rule chapter_heading
-          space? chapter_heading_prefix heading:(newline? content)? eol
+          space? chapter_heading_prefix heading:(newline? space? inline_items)? eol
           <ChapterHeading>
         end
 
         rule part_heading
-          space? part_heading_prefix heading:(newline? content)? eol
+          space? part_heading_prefix heading:(newline? space? inline_items)? eol
           <PartHeading>
         end
 
@@ -123,7 +123,7 @@ module Slaw
           &{ |s| options[:section_number_after_title] }
           # Section title
           # 1. Section content
-          content eol
+          space? inline_items eol
           section_title_prefix whitespace <SectionTitleType1>
         end
 
@@ -141,7 +141,7 @@ module Slaw
           # don't match subsections, eg.
           #
           # 10. (1) subsection content...
-          space !subsection_prefix content eol
+          space !subsection_prefix inline_items eol
         end
 
         ##########

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

@@ -154,15 +154,13 @@ module Slaw
             part_heading_prefix.alphanums.text_value
           end
 
-          def title
-            if heading.text_value and heading.respond_to? :content
-              heading.content.text_value.strip
-            end
-          end
-
           def to_xml(b)
             b.num(num)
-            b.heading(title) if title
+            if heading.respond_to? :inline_items
+              b.heading { |b|
+                heading.inline_items.to_xml(b)
+              }
+            end
           end
         end
 
@@ -191,15 +189,13 @@ module Slaw
             chapter_heading_prefix.alphanums.text_value
           end
 
-          def title
-            if heading.text_value and heading.respond_to? :content
-              heading.content.text_value.strip
-            end
-          end
-
           def to_xml(b)
             b.num(num)
-            b.heading(title) if title
+            if heading.respond_to? :inline_items
+              b.heading { |b|
+                heading.inline_items.to_xml(b)
+              }
+            end
           end
         end
 
@@ -208,18 +204,12 @@ module Slaw
             section_title.num
           end
 
-          def title
-            section_title.title
-          end
-
           def to_xml(b, *args)
             id = "section-#{num}"
             b.section(id: id) { |b|
-              b.num("#{num}.")
-              b.heading(title)
+              section_title.to_xml(b)
 
               idprefix = "#{id}."
-
               children.elements.each_with_index { |e, i| e.to_xml(b, idprefix, i) }
             }
           end
@@ -235,8 +225,14 @@ module Slaw
             section_title_prefix.number_letter.text_value
           end
 
-          def title
-            content.text_value
+          def to_xml(b, *args)
+            b.num("#{num}.")
+
+            if inline_items.text_value
+              b.heading { |b|
+                inline_items.to_xml(b)
+              }
+            end
           end
         end
 
@@ -253,8 +249,16 @@ module Slaw
             section_title_prefix.number_letter.text_value
           end
 
-          def title
-            section_title.empty? ? "" : section_title.content.text_value
+          def to_xml(b, *args)
+            b.num("#{num}.")
+
+            if section_title.respond_to? :inline_items and section_title.inline_items.text_value
+              b.heading { |b|
+                section_title.inline_items.to_xml(b)
+              }
+            else
+              b.heading
+            end
           end
         end
 

data/lib/slaw/version.rb

@@ -1,3 +1,3 @@
 module Slaw
-  VERSION = "3.1.1"
+  VERSION = "3.2.0"
 end

data/spec/za/act_block_spec.rb

@@ -201,7 +201,7 @@ CROSSHEADING crossheading
 Some lines at the start of the chapter.
 EOS
       node.num.should == "2"
-      node.heading.title.should == 'The Chapter Heading'
+      node.heading.heading.text_value.should == "\nThe Chapter Heading"
       to_xml(node).should == '<chapter id="chapter-2">
   <num>2</num>
   <heading>The Chapter Heading</heading>
@@ -227,7 +227,7 @@ Some lines at the start of the chapter.
 Section text.
 EOS
       node.num.should == "2"
-      node.heading.title.should == 'The Chapter Heading'
+      node.heading.heading.text_value.should == 'The Chapter Heading'
       to_xml(node).should == '<chapter id="chapter-2">
   <num>2</num>
   <heading>The Chapter Heading</heading>
@@ -270,6 +270,51 @@ EOS
 </chapter>'
     end
 
+    it 'should handle inlines in chapter titles after newline' do
+      node = parse :chapter, <<EOS
+Chapter 2
+  The **Chapter** [Heading](/za/act/1990/1) [[remark]]
+
+1. Section
+Hello there
+EOS
+      to_xml(node).should == '<chapter id="chapter-2">
+  <num>2</num>
+  <heading>The <b>Chapter</b> <ref href="/za/act/1990/1">Heading</ref> <remark status="editorial">[remark]</remark></heading>
+  <section id="section-1">
+    <num>1.</num>
+    <heading>Section</heading>
+    <paragraph id="section-1.paragraph0">
+      <content>
+        <p>Hello there</p>
+      </content>
+    </paragraph>
+  </section>
+</chapter>'
+    end
+
+    it 'should handle inlines in chapter titles' do
+      node = parse :chapter, <<EOS
+Chapter 2 -  The **Chapter** [Heading](/za/act/1990/1) [[remark]]
+
+1. Section
+Hello there
+EOS
+      to_xml(node).should == '<chapter id="chapter-2">
+  <num>2</num>
+  <heading>The <b>Chapter</b> <ref href="/za/act/1990/1">Heading</ref> <remark status="editorial">[remark]</remark></heading>
+  <section id="section-1">
+    <num>1.</num>
+    <heading>Section</heading>
+    <paragraph id="section-1.paragraph0">
+      <content>
+        <p>Hello there</p>
+      </content>
+    </paragraph>
+  </section>
+</chapter>'
+    end
+
     it 'should handle empty chapters' do
       node = parse :body, <<EOS
 Chapter 2 The Chapter Heading
@@ -453,6 +498,49 @@ EOS
 </part>'
     end
 
+    it 'should handle part headers with inline elements after newline' do
+      node = parse :part, <<EOS
+Part 2
+  The **Part** Heading
+1. Section
+Hello there
+EOS
+      to_xml(node).should == '<part id="part-2">
+  <num>2</num>
+  <heading>The <b>Part</b> Heading</heading>
+  <section id="section-1">
+    <num>1.</num>
+    <heading>Section</heading>
+    <paragraph id="section-1.paragraph0">
+      <content>
+        <p>Hello there</p>
+      </content>
+    </paragraph>
+  </section>
+</part>'
+    end
+
+    it 'should handle part headers with inline elements' do
+      node = parse :part, <<EOS
+Part 2 The **Part** Heading
+1. Section
+Hello there
+EOS
+      to_xml(node).should == '<part id="part-2">
+  <num>2</num>
+  <heading>The <b>Part</b> Heading</heading>
+  <section id="section-1">
+    <num>1.</num>
+    <heading>Section</heading>
+    <paragraph id="section-1.paragraph0">
+      <content>
+        <p>Hello there</p>
+      </content>
+    </paragraph>
+  </section>
+</part>'
+    end
+
     it 'should handle parts and odd section numbers' do
       subject.parser.options = {section_number_after_title: false}
       node = parse :parts, <<EOS
@@ -487,7 +575,7 @@ Some text before the part.
 Hello there
 EOS
       node.num.should == "2"
-      node.heading.title.should == 'The Part Heading'
+      node.heading.heading.text_value.should == "\nThe Part Heading"
       to_xml(node).should == '<part id="part-2">
   <num>2</num>
   <heading>The Part Heading</heading>
@@ -1274,6 +1362,47 @@ EOS
 </section>'
     end
 
+    it 'should handle sections with inline markup in headings' do
+      subject.parser.options = {section_number_after_title: false}
+      node = parse :section, <<EOS
+1. Section **bold** [foo](/za/act/1990/1)
+
+something
+EOS
+      
+      s = to_xml(node)
+      s.should == '<section id="section-1">
+  <num>1.</num>
+  <heading>Section <b>bold</b> <ref href="/za/act/1990/1">foo</ref></heading>
+  <paragraph id="section-1.paragraph0">
+    <content>
+      <p>something</p>
+    </content>
+  </paragraph>
+</section>'
+    end
+
+    it 'should handle prefixed sections with inline markup in headings' do
+      subject.parser.options = {section_number_after_title: true}
+      node = parse :section, <<EOS
+  Section **bold** [foo](/za/act/1990/1)
+1.
+
+something
+EOS
+      
+      s = to_xml(node)
+      s.should == '<section id="section-1">
+  <num>1.</num>
+  <heading>Section <b>bold</b> <ref href="/za/act/1990/1">foo</ref></heading>
+  <paragraph id="section-1.paragraph0">
+    <content>
+      <p>something</p>
+    </content>
+  </paragraph>
+</section>'
+    end
+
     it 'should handle a naked statement' do
       should_parse :section, <<EOS
 1. Section

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slaw
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Greg Kempe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2019-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake