slaw 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26b655c478bd057b9c89b7a7972984e387f9c447
-  data.tar.gz: 9c352182961b3c6a8dc6676c2de43e71777dc7ba
+  metadata.gz: ab4d37da9ebc5aadc6da5bb3b14a9d786541b187
+  data.tar.gz: 3fdf535965572c529ceaa60bcfa8e95ff3ba76bd
 SHA512:
-  metadata.gz: f1d882e1bbe07aa2ef08fcbeb5d82eb25aa4caede00b876a342ca050f89f4c184699c65e9a47787ceed1750644d9c634cb1281a0e070fad6f933bdca38ee6c23
-  data.tar.gz: 823fee99147547c3683685f443b6bd72b755fe840013059fa0ffecd02fae3a0bc3d0ccfcb66ecc6f419ba0aa2dbe42b44c27738f18db111232723a95fc169107
+  metadata.gz: 0b08087358bb70d8b17c276fed6501d5ddc67fe84114d5b066409fcd9825a81312dfbac68ec4add9f4481e9e3c44864beebf58a20cdb455d6134fb7751aab07d
+  data.tar.gz: d8a2983bb30778dbfee1d07822552d7efa9a0207ed30e2f1b10f7f52de671d3684dbc1a7adc82da9229e0f05f52300c5f1e151612459e40efe8df094d0c8eff7

data/README.md

@@ -216,6 +216,10 @@ Akoma Ntoso `component` elements at the end of the XML document, with a name of
 
 ## Changelog
 
+### 0.8.1
+
+* Schedules can have both a title and a heading, permitting schedules titled "First Schedule" and not just "Schedule 1"
+
 ### 0.8.0
 
 * FEATURE: parse command only reformats input for PDFs or when --reformat is given

data/lib/slaw/version.rb

@@ -1,3 +1,3 @@
 module Slaw
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/lib/slaw/za/act.treetop

@@ -65,7 +65,7 @@ module Slaw
       end
 
       rule schedule
-        schedule_heading
+        schedule_title
         body
         <Schedule>
       end
@@ -135,18 +135,10 @@ module Slaw
         space !numbered_statement_prefix content eol
       end
 
-      rule schedule_heading
-        space? schedule_heading_prefix
-        space? "\""? num:alphanums? "\""? space?
+      rule schedule_title
+        space? schedule_title_prefix space? "\""? num:alphanums? "\""? [ \t:-]* title:(content)?
+        heading:(newline space? content)?
         eol
-        schedule_title:schedule_title_content?
-      end
-
-      rule schedule_title_content
-        space? content eol
-
-        # if a schedule title ends in a non-character or it's really long, it's probably content
-        !{ |s| s[1].text_value[-1] =~ /[^a-zA-z]/ or s[1].text_value.length > 100 }
       end
 
       ##########
@@ -157,12 +149,12 @@ module Slaw
       end
 
       rule naked_statement
-        space? !(chapter_heading / part_heading / section_title / schedule_heading) clauses eol
+        space? !(chapter_heading / part_heading / section_title / schedule_title) clauses eol
         <NakedStatement>
       end
 
       rule schedule_statement
-        space? (!schedule_heading) clauses eol
+        space? (!schedule_title) clauses eol
         <ScheduleStatement>
       end
 
@@ -204,7 +196,7 @@ module Slaw
         'chapter'i space alphanums [ :-]*
       end
 
-      rule schedule_heading_prefix
+      rule schedule_title_prefix
         'schedule'i 's'i?
       end
 

data/lib/slaw/za/act_nodes.rb

@@ -407,12 +407,14 @@ module Slaw
 
       class Schedule < Treetop::Runtime::SyntaxNode
         def num
-          n = schedule_heading.num.text_value
+          n = schedule_title.num.text_value
           return (n && !n.empty?) ? n : nil
         end
 
         def alias
-          if num
+          if not schedule_title.title.text_value.blank?
+            schedule_title.title.text_value
+          elsif num
             "Schedule #{num}"
           else
             "Schedule"
@@ -420,26 +422,31 @@ module Slaw
         end
 
         def heading
-          if schedule_heading.schedule_title.respond_to? :content
-            schedule_heading.schedule_title.content.text_value
+          if schedule_title.heading.respond_to? :content
+            schedule_title.heading.content.text_value
           else
             nil
           end
         end
 
         def to_xml(b, idprefix=nil, i=1)
-          n = num.nil? ? i : num
+          if num
+            n = num
+            component = "schedule#{n}"
+          else
+            n = i
+            # make a component name from the schedule title
+            component = self.alias.downcase().strip().gsub(/[^a-z0-9]/i, '').gsub(/ +/, '')
+          end
 
-          # component name
-          comp = "schedule#{n}"
-          id = "#{idprefix}schedule-#{n}"
+          id = "#{idprefix}#{component}"
 
           b.component(id: "component-#{id}") { |b|
-            b.doc_(name: "schedule#{n}") { |b|
+            b.doc_(name: component) { |b|
               b.meta { |b|
                 b.identification(source: "#slaw") { |b|
                   b.FRBRWork { |b|
-                    b.FRBRthis(value: "#{Act::WORK_URI}/#{comp}")
+                    b.FRBRthis(value: "#{Act::WORK_URI}/#{component}")
                     b.FRBRuri(value: Act::WORK_URI)
                     b.FRBRalias(value: self.alias)
                     b.FRBRdate(date: '1980-01-01', name: 'Generation')
@@ -447,14 +454,14 @@ module Slaw
                     b.FRBRcountry(value: 'za')
                   }
                   b.FRBRExpression { |b|
-                    b.FRBRthis(value: "#{Act::EXPRESSION_URI}/#{comp}")
+                    b.FRBRthis(value: "#{Act::EXPRESSION_URI}/#{component}")
                     b.FRBRuri(value: Act::EXPRESSION_URI)
                     b.FRBRdate(date: '1980-01-01', name: 'Generation')
                     b.FRBRauthor(href: '#council')
                     b.FRBRlanguage(language: 'eng')
                   }
                   b.FRBRManifestation { |b|
-                    b.FRBRthis(value: "#{Act::MANIFESTATION_URI}/#{comp}")
+                    b.FRBRthis(value: "#{Act::MANIFESTATION_URI}/#{component}")
                     b.FRBRuri(value: Act::MANIFESTATION_URI)
                     b.FRBRdate(date: Time.now.strftime('%Y-%m-%d'), name: 'Generation')
                     b.FRBRauthor(href: '#slaw')

data/spec/za/act_spec.rb

@@ -683,7 +683,7 @@ EOS
 EOS
 
       today = Time.now.strftime('%Y-%m-%d')
-      to_xml(node, "").should == '<component id="component-schedule-1">
+      to_xml(node, "").should == '<component id="component-schedule1">
   <doc name="schedule1">
     <meta>
       <identification source="#slaw">
@@ -711,7 +711,7 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <article id="schedule-1">
+      <article id="schedule1">
         <heading>A Title</heading>
         <paragraph id="paragraph-0">
           <content>
@@ -1071,18 +1071,19 @@ EOS
     it 'should handle a simple schedule' do
       node = parse :schedules, <<EOS
 Schedule
+
 Subject to approval in terms of this By-Law, the erection:
 1. Foo
 2. Bar
 EOS
       s = to_xml(node)
       today = Time.now.strftime('%Y-%m-%d')
-      s.should == '<component id="component-schedule-1">
-  <doc name="schedule1">
+      s.should == '<component id="component-schedule">
+  <doc name="schedule">
     <meta>
       <identification source="#slaw">
         <FRBRWork>
-          <FRBRthis value="/za/act/1980/01/schedule1"/>
+          <FRBRthis value="/za/act/1980/01/schedule"/>
           <FRBRuri value="/za/act/1980/01"/>
           <FRBRalias value="Schedule"/>
           <FRBRdate date="1980-01-01" name="Generation"/>
@@ -1090,14 +1091,14 @@ EOS
           <FRBRcountry value="za"/>
         </FRBRWork>
         <FRBRExpression>
-          <FRBRthis value="/za/act/1980/01/eng@/schedule1"/>
+          <FRBRthis value="/za/act/1980/01/eng@/schedule"/>
           <FRBRuri value="/za/act/1980/01/eng@"/>
           <FRBRdate date="1980-01-01" name="Generation"/>
           <FRBRauthor href="#council"/>
           <FRBRlanguage language="eng"/>
         </FRBRExpression>
         <FRBRManifestation>
-          <FRBRthis value="/za/act/1980/01/eng@/schedule1"/>
+          <FRBRthis value="/za/act/1980/01/eng@/schedule"/>
           <FRBRuri value="/za/act/1980/01/eng@"/>
           <FRBRdate date="' + today + '" name="Generation"/>
           <FRBRauthor href="#slaw"/>
@@ -1105,7 +1106,7 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <article id="schedule-1">
+      <article id="schedule">
         <paragraph id="paragraph-0">
           <content>
             <p>Subject to approval in terms of this By-Law, the erection:</p>
@@ -1141,7 +1142,7 @@ EOS
       today = Time.now.strftime('%Y-%m-%d')
       s.should == <<EOS
 <components>
-  <component id="component-schedule-2">
+  <component id="component-schedule2">
     <doc name="schedule2">
       <meta>
         <identification source="#slaw">
@@ -1169,7 +1170,7 @@ EOS
         </identification>
       </meta>
       <mainBody>
-        <article id="schedule-2">
+        <article id="schedule2">
           <heading>A Title</heading>
           <section id="section-1">
             <num>1.</num>
@@ -1183,7 +1184,7 @@ EOS
       </mainBody>
     </doc>
   </component>
-  <component id="component-schedule-3">
+  <component id="component-schedule3">
     <doc name="schedule3">
       <meta>
         <identification source="#slaw">
@@ -1211,7 +1212,7 @@ EOS
         </identification>
       </meta>
       <mainBody>
-        <article id="schedule-3">
+        <article id="schedule3">
           <heading>Another Title</heading>
           <paragraph id="paragraph-0">
             <content>
@@ -1229,9 +1230,128 @@ EOS
 
     end
 
+    it 'should handle a schedule with a title and a number' do
+      node = parse :schedules, <<EOS
+Schedule 1 - First Schedule
+Schedule Heading
+
+Subject to approval in terms of this By-Law, the erection:
+1. Foo
+2. Bar
+EOS
+      s = to_xml(node)
+      today = Time.now.strftime('%Y-%m-%d')
+      s.should == '<component id="component-schedule1">
+  <doc name="schedule1">
+    <meta>
+      <identification source="#slaw">
+        <FRBRWork>
+          <FRBRthis value="/za/act/1980/01/schedule1"/>
+          <FRBRuri value="/za/act/1980/01"/>
+          <FRBRalias value="First Schedule"/>
+          <FRBRdate date="1980-01-01" name="Generation"/>
+          <FRBRauthor href="#council"/>
+          <FRBRcountry value="za"/>
+        </FRBRWork>
+        <FRBRExpression>
+          <FRBRthis value="/za/act/1980/01/eng@/schedule1"/>
+          <FRBRuri value="/za/act/1980/01/eng@"/>
+          <FRBRdate date="1980-01-01" name="Generation"/>
+          <FRBRauthor href="#council"/>
+          <FRBRlanguage language="eng"/>
+        </FRBRExpression>
+        <FRBRManifestation>
+          <FRBRthis value="/za/act/1980/01/eng@/schedule1"/>
+          <FRBRuri value="/za/act/1980/01/eng@"/>
+          <FRBRdate date="' + today + '" name="Generation"/>
+          <FRBRauthor href="#slaw"/>
+        </FRBRManifestation>
+      </identification>
+    </meta>
+    <mainBody>
+      <article id="schedule1">
+        <heading>Schedule Heading</heading>
+        <paragraph id="paragraph-0">
+          <content>
+            <p>Subject to approval in terms of this By-Law, the erection:</p>
+          </content>
+        </paragraph>
+        <section id="section-1">
+          <num>1.</num>
+          <heading>Foo</heading>
+        </section>
+        <section id="section-2">
+          <num>2.</num>
+          <heading>Bar</heading>
+        </section>
+      </article>
+    </mainBody>
+  </doc>
+</component>'
+    end
+
+    it 'should handle a schedule with a title' do
+      node = parse :schedules, <<EOS
+Schedule - First Schedule
+
+Subject to approval in terms of this By-Law, the erection:
+1. Foo
+2. Bar
+EOS
+      s = to_xml(node)
+      today = Time.now.strftime('%Y-%m-%d')
+      s.should == '<component id="component-firstschedule">
+  <doc name="firstschedule">
+    <meta>
+      <identification source="#slaw">
+        <FRBRWork>
+          <FRBRthis value="/za/act/1980/01/firstschedule"/>
+          <FRBRuri value="/za/act/1980/01"/>
+          <FRBRalias value="First Schedule"/>
+          <FRBRdate date="1980-01-01" name="Generation"/>
+          <FRBRauthor href="#council"/>
+          <FRBRcountry value="za"/>
+        </FRBRWork>
+        <FRBRExpression>
+          <FRBRthis value="/za/act/1980/01/eng@/firstschedule"/>
+          <FRBRuri value="/za/act/1980/01/eng@"/>
+          <FRBRdate date="1980-01-01" name="Generation"/>
+          <FRBRauthor href="#council"/>
+          <FRBRlanguage language="eng"/>
+        </FRBRExpression>
+        <FRBRManifestation>
+          <FRBRthis value="/za/act/1980/01/eng@/firstschedule"/>
+          <FRBRuri value="/za/act/1980/01/eng@"/>
+          <FRBRdate date="' + today + '" name="Generation"/>
+          <FRBRauthor href="#slaw"/>
+        </FRBRManifestation>
+      </identification>
+    </meta>
+    <mainBody>
+      <article id="firstschedule">
+        <paragraph id="paragraph-0">
+          <content>
+            <p>Subject to approval in terms of this By-Law, the erection:</p>
+          </content>
+        </paragraph>
+        <section id="section-1">
+          <num>1.</num>
+          <heading>Foo</heading>
+        </section>
+        <section id="section-2">
+          <num>2.</num>
+          <heading>Bar</heading>
+        </section>
+      </article>
+    </mainBody>
+  </doc>
+</component>'
+    end
+
     it 'should serialise a single schedule without a heading' do
       node = parse :schedules, <<EOS
 Schedule "1"
+
 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.
 1. Foo
 2. Bar
@@ -1240,7 +1360,7 @@ EOS
       s = to_xml(node)
       today = Time.now.strftime('%Y-%m-%d')
       s.should == <<EOS
-<component id="component-schedule-1">
+<component id="component-schedule1">
   <doc name="schedule1">
     <meta>
       <identification source="#slaw">
@@ -1268,7 +1388,7 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <article id="schedule-1">
+      <article id="schedule1">
         <paragraph id="paragraph-0">
           <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>
@@ -1309,7 +1429,7 @@ EOS
       s = to_xml(node)
       today = Time.now.strftime('%Y-%m-%d')
       s.should == <<EOS
-<component id="component-schedule-1">
+<component id="component-schedule1">
   <doc name="schedule1">
     <meta>
       <identification source="#slaw">
@@ -1337,7 +1457,7 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <article id="schedule-1">
+      <article id="schedule1">
         <heading>Forms</heading>
         <part id="part-I">
           <num>I</num>
@@ -1440,7 +1560,7 @@ EOS
 
       xml = to_xml(node, "")
       today = Time.now.strftime('%Y-%m-%d')
-      xml.should == '<component id="component-schedule-1">
+      xml.should == '<component id="component-schedule1">
   <doc name="schedule1">
     <meta>
       <identification source="#slaw">
@@ -1468,7 +1588,7 @@ EOS
       </identification>
     </meta>
     <mainBody>
-      <article id="schedule-1">
+      <article id="schedule1">
         <paragraph id="paragraph-0">
           <content>
             <p>Heres a table:</p>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slaw
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Greg Kempe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-06 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler