bible_passage 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fc1e8649445abc3e4f72219dfde67a38ab544b8
-  data.tar.gz: b44f468ef36330a2ac857246082b8e82702a2eb9
+  metadata.gz: b4b4b875333c8c0752f13e6a2de2638e41d4cfb0
+  data.tar.gz: 66f0275e662976d67e728451dd88f050428c8078
 SHA512:
-  metadata.gz: 726914e558027ab489d9aa2161c8420855fbeafbaa90051a92993532f00b938dec09c288af3c5591042c661f9a0e3c0b876592d95bcca366c1804fd13a38748e
-  data.tar.gz: 2cb4afb734bd696d8f2880cc881a098fbe82cca23c5e972d9583dc32a06d67789cb6503c99b8436b0c4464ea293b0c6c069424dd048efafd8764406e3bca53ac
+  metadata.gz: 32f934c2accc408fdb71db8b41a184ffeb2b8c3142e5d9d8800c861e01f4f51794daf40bf3ba7c09ce5344009b207418a73ce7ade77d70093a29e535f22b2f33
+  data.tar.gz: 424679412f391d8c395234d82bbe15d7cd5de7cb4ce0628ce4bc737dca45d6b28dbb30692f5597e852584134e83d53a496bec92eb61d49830d90934490467992

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bible_passage (0.0.1)
+    bible_passage (0.0.2)
 
 GEM
   remote: https://rubygems.org/

data/bible_passage.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'bible_passage'
   s.summary     = 'A simple library for parsing and rendering bible passages'
-  s.version     = '0.0.2'
+  s.version     = '0.1.0'
   s.authors     = ["Si Wilkins"]
   s.email       = 'si.wilkins@gmail.com'
   s.homepage    = 'https://github.com/siwilkins/bible_passage'

data/lib/bible_passage/book_data_store.rb

@@ -65,7 +65,7 @@ module BiblePassage
       },
       neh: {
         name: 'Nehemiah',
-        chapters: [11, 20, 38, 17, 19, 19, 72, 18, 38, 39, 36, 47, 31]
+        chapters: [11, 20, 32, 23, 19, 19, 73, 18, 38, 39, 36, 47, 31]
       },
       esth: {
         name: 'Esther',
@@ -85,7 +85,7 @@ module BiblePassage
       },
       eccl: {
         name: 'Ecclesiastes',
-        chapters: [18, 26, 22, 17, 19, 12, 29, 17, 18, 20, 10, 14]
+        chapters: [18, 26, 22, 16, 20, 12, 29, 17, 18, 20, 10, 14]
       },
       song: {
         name: 'Song of Songs',

data/lib/bible_passage/reference.rb

@@ -4,20 +4,73 @@ module BiblePassage
 
     class << self
 
+      # Parsing methods are currently very complex and long.
+      # Could need some work
+      
+      ##
+      # The main method used for parsing passage strings
       def parse(passage, options = {})
         translator = options.delete(:translator) || BookKeyTranslator.new
         data_store = options[:data_store] ||= BookDataStore.new
-        match = passage.match(/^\s*(\d?\s*[A-Za-z\s]+)\s*(\d+)?:?(\d+)?-?(\d+)?:?(\d+)?/)
+        match = match_passage_format(passage)
+        raise InvalidReferenceError.new("#{passage} is not a valid reference") if !match
         book_key = translator.keyify(match[1])
         if data_store.number_of_chapters(book_key) == 1
-          process_single_chapter_match(book_key, match, options)
+          ref = process_single_chapter_match(book_key, match, options)
         else
-          process_multi_chapter_match(book_key, match, options)
+          ref = process_multi_chapter_match(book_key, match, options)
         end
+        ref.parse_child(match[6].gsub(/^,\s*/, '')) if match[6]
+        ref
       end
 
+      ##
+      # Parses a child reference in a compound passage string
+      def parse_child(passage, parent, options = {})
+        if match_passage_format(passage)
+          ref = parse(passage, options)
+        else
+          match = passage.match(/\s*(\d+)?:?(\d+)?\s*(-?)\s*(\d+)?:?(\d+)?\s*(,.+)?$/)
+          book_key = parent.book_key
+          attrs = parent.inheritable_attributes
+          if attrs[:from_chapter]
+            if match[2]
+              attrs[:from_chapter] = match[1].to_i 
+              attrs[:from_verse] = match[2].to_i
+            else
+              attrs[:from_verse] = match[1].to_i
+            end
+          else
+            attrs[:from_chapter] = match[1].to_i
+            if match[2]
+              attrs[:from_verse] = match[2].to_i
+            else
+            end
+          end
+          if match[5]
+            attrs[:to_chapter] = int_param(match[4])
+            attrs[:to_verse] = int_param(match[5])
+          elsif attrs[:from_verse]
+            attrs[:to_verse] = int_param(match[4]) 
+          else
+            attrs[:to_chapter] = int_param(match[4])
+          end
+          ref = new(book_key, attrs[:from_chapter], attrs[:from_verse], 
+              attrs[:to_chapter], attrs[:to_verse])
+        end
+        ref.parent = parent
+        ref
+      end
 
       private
+      def match_passage_format(passage)
+        passage.match(/^\s*(\d?\s*[A-Za-z\s]+)\s*(\d+)?:?(\d+)?\s*-?\s*(\d+)?:?(\d+)?\s*(,.+)?/)
+      end
+
+      def int_param(param)
+        param ? param.to_i : nil
+      end
+
       def process_multi_chapter_match(book_key, match, options)
         if match[2]
           from_chapter = match[2].to_i 
@@ -28,11 +81,11 @@ module BiblePassage
               to_chapter = match[4].to_i
               to_verse = match[5].to_i
             else
-              to_verse = match[4].to_i if match[4]
+              to_verse = int_param(match[4])
             end
           else
-            from_verse = match[3].to_i if match[3]
-            to_chapter = match[4].to_i if match[4]
+            from_verse = int_param(match[3])
+            to_chapter = int_param(match[4])
           end
         end
         new(book_key, from_chapter, from_verse, to_chapter, to_verse, options)
@@ -53,7 +106,9 @@ module BiblePassage
 
     end
 
-    attr_reader :book_key, :book
+    attr_reader :book_key, :book, :child
+
+    attr_writer :parent
 
     def initialize(book_key, from_chapter = nil, from_verse = nil, 
                    to_chapter = nil, to_verse = nil, options = {})
@@ -65,6 +120,10 @@ module BiblePassage
       self.to_verse = calculate_to_verse(to_verse)
     end
 
+    def parse_child(child_passage)
+      @child = self.class::parse_child(child_passage, self)
+    end
+
     def book_key=(key)
       @book = @data_store.book_name(key)
       @book_key = key
@@ -79,6 +138,7 @@ module BiblePassage
         raise InvalidReferenceError.new(
           "#{book} doesn't have a chapter #{val}") if val < 1 || 
           val > @data_store.number_of_chapters(book_key)
+        @inherit_book_key = true
         @from_chapter = val
       end
     end
@@ -92,6 +152,7 @@ module BiblePassage
         raise InvalidReferenceError.new(
           "#{book} #{from_chapter} doesn't have a verse #{val}") if val < 1 ||
           val > @data_store.number_of_verses(book_key, from_chapter)
+        @inherit_chapter = true
         @from_verse = val
       end
     end
@@ -128,11 +189,13 @@ module BiblePassage
     end
 
     def to_s
-      if single_chapter_book?
-        "#{book}#{from_verse_part}#{to_verse_part}"
+      if @parent
+        out = to_s_child
       else
-        "#{book}#{from_part}#{to_part}"
+        out = to_s_root
       end
+      out << child.to_s if child
+      out
     end
 
     def whole_chapters?
@@ -149,6 +212,24 @@ module BiblePassage
       whole_chapters? && from_chapter == to_chapter
     end
 
+    def attributes
+      %w{book_key from_chapter from_verse to_chapter to_verse}.
+        inject({}) do |memo, attr_key|
+          memo.merge(attr_key.to_sym => send(attr_key))
+      end
+    end
+    
+    def ==(other)
+      attributes == other.attributes
+    end
+
+    def inheritable_attributes
+      out = {}
+      out[:book_key] = book_key if @inherit_book_key
+      out[:from_chapter] = to_chapter if @inherit_chapter
+      out
+    end
+
     private
     def from_part
       out = ''
@@ -201,7 +282,6 @@ module BiblePassage
       end
     end
 
-
     def int_param(param)
       param ? param.to_i : nil
     end
@@ -238,6 +318,23 @@ module BiblePassage
           @data_store.number_of_verses(book_key, self.to_chapter)
     end
 
+    def to_s_root
+      if single_chapter_book?
+        out = "#{book}#{from_verse_part}#{to_verse_part}"
+      else
+        out = "#{book}#{from_part}#{to_part}"
+      end
+    end
+
+    def to_s_child
+      out = ','
+      if book_key != @parent.book_key
+        out << " #{to_s_root}"
+      else
+        out << "#{from_part}#{to_part}"
+      end
+    end
+
   end
 
 end

data/spec/bible_passage/book_data_store_spec.rb

@@ -183,6 +183,14 @@ describe BiblePassage::BookDataStore do
     # Use non-Hebrew numbering of Nehemiah 9/10
     it_gets_number_of_verses(:neh, 9, 38)
     it_gets_number_of_verses(:neh, 10, 39)
+
+    it_gets_number_of_verses(:neh, 7, 73)
+    it_gets_number_of_verses(:neh, 4, 23)
+    it_gets_number_of_verses(:neh, 3, 32)
+
+    it_gets_number_of_verses(:eccl, 5, 20)
+    it_gets_number_of_verses(:eccl, 4, 16)
+
   end
 
 end

data/spec/bible_passage/reference_spec.rb

@@ -9,6 +9,13 @@ describe BiblePassage::Reference do
       it msg do
         expect(BiblePassage::Reference.parse(ref_str).send($1)).to eq(val)
       end
+    elsif mth.to_s =~ /^child_has_(\w+)$/
+      ref_str, val, msg = args
+      msg << " (#{ref_str})"
+      it msg do
+        expect(BiblePassage::Reference.parse(ref_str).child.send($1)).
+          to eq(val)
+      end
     else
       super
     end
@@ -68,6 +75,9 @@ describe BiblePassage::Reference do
       it_has_from_chapter('Luke12:3', 12, 'works when no space used')
 
       it_has_from_chapter('Jude 2', 1, 'works for single chapter book')
+
+      it_has_from_chapter('Revelation 8:6 - 11:19', 8, 'works with spaces around hyphen')
+
     end
 
     context "from_verse" do
@@ -112,6 +122,67 @@ describe BiblePassage::Reference do
 
     end
 
+    context "compound" do
+
+      context "full passage reference child" do
+
+        let(:ref) { BiblePassage::Reference }
+
+        it "behaves like a normal reference" do
+          expect(ref.parse("gen 1:2-3, ex 4:5-6:7").child).to eq(ref.parse("ex 4:5-6:7"))
+        end
+
+      end
+
+      context "from_chapter" do
+
+        child_has_from_chapter("Exodus 1:2-3:4,5", 3, "defaults to parent's to_chapter if supplied")
+
+        child_has_from_chapter("Exodus 1:2-3:4,5:6", 5, "uses supplied if chapter and verse given")
+
+        child_has_from_chapter("Exodus 1, 3", 3, 'uses supplied if chapter given')
+
+        child_has_from_chapter("Jude 1, 2", 1, 'sets to 1 if single-chapter book')
+
+      end
+
+      context "from_verse" do
+
+        child_has_from_verse("Exodus 1:2-3:4, 5", 5, "uses supplied from_verse")
+
+        child_has_from_verse("Exodus 1:2-3:4, 5:6", 6, "uses supplied if chapter and verse given")
+
+        child_has_from_verse("Exodus 1, 2:3", 3, "uses supplied if parent doesn't have one")
+
+        child_has_from_verse("Jude 1, 2", 2, "uses supplied for single-chapter book")
+
+      end
+
+      context "to_chapter" do
+
+        child_has_to_chapter("Exodus 1, 3-4", 4, "uses supplied if given")
+
+        child_has_to_chapter("Exodus 1, 3:4-5", 3, "doesn't use if not supplied")
+
+        child_has_to_chapter("Exodus 1, 3:4-5:6", 5, "uses if to_verse also supplied")
+
+        child_has_to_chapter("ex 1:2-3:4, 5:6-7:8 ", 7, "uses if all supplied")
+      end
+
+      context "to_verse" do
+
+        child_has_to_verse("Exodus 1, 2-3:4", 4, "uses supplied if chapter and verse given")
+
+        child_has_to_verse("Exodus 1, 2:3-4", 4, "uses supplied if just verse given")
+
+        child_has_to_verse("Exodus 1, 2:3", 3, "doesn't use if to-part not supplied")
+
+        child_has_to_verse("Exodus 1, 2-3", 22, "uses end verse if just to_chapter supplied")
+
+      end
+
+    end
+
   end
 
   context "whole_chapters?" do
@@ -178,7 +249,7 @@ describe BiblePassage::Reference do
 
   context "to_s" do
 
-    def self.it_renders_passage(book_key, from_chapter, from_verse, to_chapter,
+    def self.it_renders_reference(book_key, from_chapter, from_verse, to_chapter,
                                 to_verse, passage, msg)
       it "renders #{msg}" do
         expect(BiblePassage::Reference.new(book_key, from_chapter, from_verse,
@@ -186,23 +257,37 @@ describe BiblePassage::Reference do
       end
     end
 
-    it_renders_passage(:gen, 1, 2, 3, 4, 'Genesis 1:2-3:4', 'where all attributes differ')
+    def self.it_renders_passage(passage, expected)
+      it "renders #{passage} as #{expected}" do
+        expect(BiblePassage::Reference.parse(passage).to_s).to eq expected
+      end
+    end
+
+    it_renders_reference(:gen, 1, 2, 3, 4, 'Genesis 1:2-3:4', 'where all attributes differ')
 
-    it_renders_passage(:gen, 1, 2, 1, 3, 'Genesis 1:2-3', 'where only verses differ')
+    it_renders_reference(:gen, 1, 2, 1, 3, 'Genesis 1:2-3', 'where only verses differ')
 
-    it_renders_passage(:gen, 1, nil, 2, nil, 'Genesis 1-2', 'where full chapters')
+    it_renders_reference(:gen, 1, nil, 2, nil, 'Genesis 1-2', 'where full chapters')
 
-    it_renders_passage(:gen, 1, nil, nil, nil, 'Genesis 1', 'where single chapter')
+    it_renders_reference(:gen, 1, nil, nil, nil, 'Genesis 1', 'where single chapter')
 
-    it_renders_passage(:gen, 1, 2, nil, nil, 'Genesis 1:2', 'where single verse')
+    it_renders_reference(:gen, 1, 2, nil, nil, 'Genesis 1:2', 'where single verse')
 
-    it_renders_passage(:jude, 1, 2, 1, 4, 'Jude 2-4', 'where a single chapter book')
+    it_renders_reference(:jude, 1, 2, 1, 4, 'Jude 2-4', 'where a single chapter book')
 
-    it_renders_passage(:jude, 1, 2, 1, 2, 'Jude 2', 'where a single verse in a single chapter book')
+    it_renders_reference(:jude, 1, 2, 1, 2, 'Jude 2', 'where a single verse in a single chapter book')
 
-    it_renders_passage(:jude, nil, nil, nil, nil, 'Jude', 'where a whole single chapter book')
+    it_renders_reference(:jude, nil, nil, nil, nil, 'Jude', 'where a whole single chapter book')
 
-    it_renders_passage(:exod, nil, nil, nil, nil, 'Exodus', 'where a whole book')
+    it_renders_reference(:exod, nil, nil, nil, nil, 'Exodus', 'where a whole book')
+
+    it_renders_passage("gn 1:2-3:4, ex 5:6-7:8", "Genesis 1:2-3:4, Exodus 5:6-7:8")
+
+    it_renders_passage("ex 1:2-3:4, 5:6-7:8", 'Exodus 1:2-3:4, 5:6-7:8')
+
+    it_renders_passage("ex 1-2, 3-4", "Exodus 1-2, 3-4")
+
+    it_renders_passage("Ephesians 4:20-32, 5:18-19", "Ephesians 4:20-32, 5:18-19")
 
   end
 
@@ -265,8 +350,31 @@ describe BiblePassage::Reference do
           "Jude doesn't have any chapters")
       end
 
+      it "errors when no book is supplied to parse" do
+        expect { BiblePassage::Reference.parse('2') }.to raise_error(
+          BiblePassage::InvalidReferenceError, "2 is not a valid reference")
+      end
+
     end
 
   end
 
+  context "inheritable attributes" do
+
+    let(:ref) { BiblePassage::Reference }
+
+    it "is empty if just book supplied" do
+      expect(ref.new(:gen).inheritable_attributes).to eq({})
+    end
+
+    it "returns book_key if chapters specified" do
+      expect(ref.new(:gen, 1).inheritable_attributes).to eq(book_key: :gen)
+    end
+
+    it "returns to_chapter as from_chapter if verses specified" do
+      expect(ref.new(:gen, 1, 2, 3, 4).inheritable_attributes).
+        to eq(book_key: :gen, from_chapter: 3)
+    end
+
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bible_passage
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Si Wilkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec