bible_bot 2.0.0

data/lib/bible_bot/version.rb

@@ -0,0 +1,3 @@
+module BibleBot
+  VERSION = "2.0.0"
+end

data/spec/lib/book_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe BibleBot::Book do
+
+  describe "find_by_id" do
+    [
+      {id: 1, expected: "Genesis"},
+      {id: 19, expected: "Psalms"},
+      {id: 66, expected: "Revelation"},
+      {id: 67, expected: nil},
+    ].each do |t|
+      context "id=#{t[:id]}" do
+        it "It finds #{t[:expected]}" do
+          book = described_class.find_by_id(t[:id])
+
+          if t[:expected] == nil
+            expect(book).to be nil
+          else
+            expect(book).to be_a BibleBot::Book
+            expect(book.name).to eq t[:expected]
+          end
+        end
+      end
+    end
+  end
+
+  describe "find_by_name" do
+    [
+      {name: "genesis", expected: "Genesis"},
+      {name: "psalm", expected: "Psalms"},
+      {name: "rev", expected: "Revelation"},
+      {name: "nothing", expected: nil},
+    ].each do |t|
+      context "name=#{t[:name]}" do
+        it "It finds #{t[:expected]}" do
+          book = described_class.find_by_name(t[:name])
+
+          if t[:expected] == nil
+            expect(book).to be nil
+          else
+            expect(book).to be_a BibleBot::Book
+            expect(book.name).to eq t[:expected]
+          end
+        end
+      end
+    end
+  end
+
+
+  describe "reference" do
+    let(:book) { BibleBot::Book.find_by_name("1 John") }
+
+    it "returns reference" do
+      expect(book.reference.inspect).to include(start_verse: "1 John 1:1", end_verse: "1 John 5:21")
+    end
+  end
+end

data/spec/lib/reference_match_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+
+describe BibleBot::ReferenceMatch do
+  describe "scan" do
+    test_cases = [
+      {ref: "Matthew 1:1 - Mark 4:2", expected: ["Matthew 1:1-Mark 4:2"]},
+      {ref: "Matthew 2 - Mark 4", expected: ["Matthew 2-Mark 4"]},
+      {ref: "John 1:1", expected: ["John 1:1"]},
+      {ref: "John 1:1 is the first first but Romans 8:9-10 is another.", expected: ["John 1:1", "Romans 8:9-10"]},
+      {ref: "When Fiery Trials Come Genesis 35:16-29 Part 1", expected: ["Genesis 35:16-29"]},
+      {ref: "No book to see here 4:5", expected: []},
+      {ref: "Rom 1:6", expected: ["Romans 1:6"]},
+      {ref: "Romans 1:6", expected: ["Romans 1:6"]},
+      {ref: "Rm 1:8", expected: ["Romans 1:8"]},
+      {ref: "Ge 1:1", expected: ["Genesis 1:1"]},
+      {ref: "Gen 1:1", expected: ["Genesis 1:1"]},
+      {ref: "Genesis", expected: []},
+      {ref: "Genesis 5", expected: ["Genesis 5"]},
+      {ref: "Genesis 5-10", expected: ["Genesis 5-10"]},
+      {ref: "Genesis 1:1 - Exod 4", expected: ["Genesis 1-Exodus 4"]},
+      {ref: "Genesis 3 - Genesis 4:3", expected: ["Genesis 3:1-4:3"]},
+      {ref: "Ex", expected: []},
+      {ref: "Genesis 1:1", expected: ["Genesis 1:1"]},
+      {ref: "Ge 1:1", expected: ["Genesis 1:1"]},
+      {ref: "Gen 1:1", expected: ["Genesis 1:1"]},
+      {ref: "Exodus 1:1", expected: ["Exodus 1:1"]},
+      {ref: "Ex 1:1", expected: ["Exodus 1:1"]},
+      {ref: "Exod 1:1", expected: ["Exodus 1:1"]},
+      {ref: "Leviticus 1:1", expected: ["Leviticus 1:1"]},
+      {ref: "Lev 1:1", expected: ["Leviticus 1:1"]},
+      {ref: "Numbers 1:1", expected: ["Numbers 1:1"]},
+      {ref: "Num 1:1", expected: ["Numbers 1:1"]},
+      {ref: "Deuteronomy 1:1", expected: ["Deuteronomy 1:1"]},
+      {ref: "Deut 1:1", expected: ["Deuteronomy 1:1"]},
+      {ref: "Joshua 1:1", expected: ["Joshua 1:1"]},
+      {ref: "Josh 1:1", expected: ["Joshua 1:1"]},
+      {ref: "Judges 1:1", expected: ["Judges 1:1"]},
+      {ref: "Judg 1:1", expected: ["Judges 1:1"]},
+      {ref: "Ruth 1:1", expected: ["Ruth 1:1"]},
+      {ref: "1 Samuel 1:1", expected: ["1 Samuel 1:1"]},
+      {ref: "1 Sam 1:1", expected: ["1 Samuel 1:1"]},
+      {ref: "2 Samuel 1:1", expected: ["2 Samuel 1:1"]},
+      {ref: "2 Sam 1:1", expected: ["2 Samuel 1:1"]},
+      {ref: "1 Kings 1:1", expected: ["1 Kings 1:1"]},
+      {ref: "1 Kgs 1:1", expected: ["1 Kings 1:1"]},
+      {ref: "2 Kings 1:1", expected: ["2 Kings 1:1"]},
+      {ref: "2 Kgs 1:1", expected: ["2 Kings 1:1"]},
+      {ref: "1 Chronicles 1:1", expected: ["1 Chronicles 1:1"]},
+      {ref: "1 Chron 1:1", expected: ["1 Chronicles 1:1"]},
+      {ref: "2 Chronicles 1:1", expected: ["2 Chronicles 1:1"]},
+      {ref: "2 Chron 1:1", expected: ["2 Chronicles 1:1"]},
+      {ref: "Ezra 1:1", expected: ["Ezra 1:1"]},
+      {ref: "Nehemiah 1:1", expected: ["Nehemiah 1:1"]},
+      {ref: "Neh 1:1", expected: ["Nehemiah 1:1"]},
+      {ref: "Esther 1:1", expected: ["Esther 1:1"]},
+      {ref: "Esth 1:1", expected: ["Esther 1:1"]},
+      {ref: "Job 1:1", expected: ["Job 1:1"]},
+      {ref: "Psalms 1:1", expected: ["Psalm 1:1"]},
+      {ref: "Psalm 1:1", expected: ["Psalm 1:1"]},
+      {ref: "Psa 1:1", expected: ["Psalm 1:1"]},
+      {ref: "Ps 1:1", expected: ["Psalm 1:1"]},
+      {ref: "Proverbs 1:1", expected: ["Proverbs 1:1"]},
+      {ref: "Prov 1:1", expected: ["Proverbs 1:1"]},
+      {ref: "Ecclesiastes 1:1", expected: ["Ecclesiastes 1:1"]},
+      {ref: "Ecc 1:1", expected: ["Ecclesiastes 1:1"]},
+      {ref: "Song of Solomon 1:1", expected: ["Song of Solomon 1:1"]},
+      {ref: "Song of Songs 1:1", expected: ["Song of Solomon 1:1"]},
+      {ref: "Song 1:1", expected: ["Song of Solomon 1:1"]},
+      {ref: "Isaiah 1:1", expected: ["Isaiah 1:1"]},
+      {ref: "Isa 1:1", expected: ["Isaiah 1:1"]},
+      {ref: "Jeremiah 1:1", expected: ["Jeremiah 1:1"]},
+      {ref: "Jer 1:1", expected: ["Jeremiah 1:1"]},
+      {ref: "Lamentations 1:1", expected: ["Lamentations 1:1"]},
+      {ref: "Lam 1:1", expected: ["Lamentations 1:1"]},
+      {ref: "Ezekiel 1:1", expected: ["Ezekiel 1:1"]},
+      {ref: "Ezek 1:1", expected: ["Ezekiel 1:1"]},
+      {ref: "Daniel 1:1", expected: ["Daniel 1:1"]},
+      {ref: "Dan 1:1", expected: ["Daniel 1:1"]},
+      {ref: "Hosea 1:1", expected: ["Hosea 1:1"]},
+      {ref: "Hos 1:1", expected: ["Hosea 1:1"]},
+      {ref: "Joel 1:1", expected: ["Joel 1:1"]},
+      {ref: "Amos 1:1", expected: ["Amos 1:1"]},
+      {ref: "Obadiah 1:1", expected: ["Obadiah 1"]},
+      {ref: "Obad 1:1", expected: ["Obadiah 1"]},
+      {ref: "Jonah 1:1", expected: ["Jonah 1:1"]},
+      {ref: "Micah 1:1", expected: ["Micah 1:1"]},
+      {ref: "Mic 1:1", expected: ["Micah 1:1"]},
+      {ref: "Nahum 1:1", expected: ["Nahum 1:1"]},
+      {ref: "Nah 1:1", expected: ["Nahum 1:1"]},
+      {ref: "Habakkuk 1:1", expected: ["Habakkuk 1:1"]},
+      {ref: "Hab 1:1", expected: ["Habakkuk 1:1"]},
+      {ref: "Zephaniah 1:1", expected: ["Zephaniah 1:1"]},
+      {ref: "Zeph 1:1", expected: ["Zephaniah 1:1"]},
+      {ref: "Haggai 1:1", expected: ["Haggai 1:1"]},
+      {ref: "Hag 1:1", expected: ["Haggai 1:1"]},
+      {ref: "Zechariah 1:1", expected: ["Zechariah 1:1"]},
+      {ref: "Zech 1:1", expected: ["Zechariah 1:1"]},
+      {ref: "Malachi 1:1", expected: ["Malachi 1:1"]},
+      {ref: "Mal 1:1", expected: ["Malachi 1:1"]},
+      {ref: "Matthew 1:1", expected: ["Matthew 1:1"]},
+      {ref: "Matt 1:1", expected: ["Matthew 1:1"]},
+      {ref: "Mt 1:1", expected: ["Matthew 1:1"]},
+      {ref: "Mark 1:1", expected: ["Mark 1:1"]},
+      {ref: "Mk 1:1", expected: ["Mark 1:1"]},
+      {ref: "Luke 1:1", expected: ["Luke 1:1"]},
+      {ref: "Lk 1:1", expected: ["Luke 1:1"]},
+      {ref: "John 1:1", expected: ["John 1:1"]},
+      {ref: "Jn 1:1", expected: ["John 1:1"]},
+      {ref: "Acts 1:1", expected: ["Acts 1:1"]},
+      {ref: "Romans 1:1", expected: ["Romans 1:1"]},
+      {ref: "Rom 1:1", expected: ["Romans 1:1"]},
+      {ref: "1 Corinthians 1:1", expected: ["1 Corinthians 1:1"]},
+      {ref: "1 Cor 1:1", expected: ["1 Corinthians 1:1"]},
+      {ref: "2 Corinthians 1:1", expected: ["2 Corinthians 1:1"]},
+      {ref: "2 Cor 1:1", expected: ["2 Corinthians 1:1"]},
+      {ref: "Galatians 1:1", expected: ["Galatians 1:1"]},
+      {ref: "Gal 1:1", expected: ["Galatians 1:1"]},
+      {ref: "Ephesians 1:1", expected: ["Ephesians 1:1"]},
+      {ref: "Eph 1:1", expected: ["Ephesians 1:1"]},
+      {ref: "Philippians 1:1", expected: ["Philippians 1:1"]},
+      {ref: "Phil 1:1", expected: ["Philippians 1:1"]},
+      {ref: "Colossians 1:1", expected: ["Colossians 1:1"]},
+      {ref: "Col 1:1", expected: ["Colossians 1:1"]},
+      {ref: "1 Thessalonians 1:1", expected: ["1 Thessalonians 1:1"]},
+      {ref: "1 Thess 1:1", expected: ["1 Thessalonians 1:1"]},
+      {ref: "2 Thessalonians 1:1", expected: ["2 Thessalonians 1:1"]},
+      {ref: "2 Thess 1:1", expected: ["2 Thessalonians 1:1"]},
+      {ref: "1 Timothy 1:1", expected: ["1 Timothy 1:1"]},
+      {ref: "1 Tim 1:1", expected: ["1 Timothy 1:1"]},
+      {ref: "2 Timothy 1:1", expected: ["2 Timothy 1:1"]},
+      {ref: "2 Tim 1:1", expected: ["2 Timothy 1:1"]},
+      {ref: "Titus 1:1", expected: ["Titus 1:1"]},
+      {ref: "Tit 1:1", expected: ["Titus 1:1"]},
+      {ref: "Philemon 1:1", expected: ["Philemon 1"]},
+      {ref: "Philem 1:1", expected: ["Philemon 1"]},
+      {ref: "Hebrews 1:1", expected: ["Hebrews 1:1"]},
+      {ref: "Heb 1:1", expected: ["Hebrews 1:1"]},
+      {ref: "James 1:1", expected: ["James 1:1"]},
+      {ref: "Jas 1:1", expected: ["James 1:1"]},
+      {ref: "1 Peter 1:1", expected: ["1 Peter 1:1"]},
+      {ref: "1 Pet 1:1", expected: ["1 Peter 1:1"]},
+      {ref: "2 Peter 1:1", expected: ["2 Peter 1:1"]},
+      {ref: "2 Pet 1:1", expected: ["2 Peter 1:1"]},
+      {ref: "1 John 1:1", expected: ["1 John 1:1"]},
+      {ref: "I John 1:1", expected: ["1 John 1:1"]},
+      {ref: "1 Jn 1:1", expected: ["1 John 1:1"]},
+      {ref: "2 John 1:1", expected: ["2 John 1"]},
+      {ref: "II John 1:1", expected: ["2 John 1"]},
+      {ref: "2 Jn 1:1", expected: ["2 John 1"]},
+      {ref: "3 John 1:1", expected: ["3 John 1"]},
+      {ref: "III John 1:1", expected: ["3 John 1"]},
+      {ref: "3 Jn 1:1", expected: ["3 John 1"]},
+      {ref: "Jude 1:1", expected: ["Jude 1"]},
+      {ref: "Jude 5", expected: ["Jude 5"]},
+      {ref: "Revelation 1:1", expected: ["Revelation 1:1"]},
+      {ref: "Rev 1:1", expected: ["Revelation 1:1"]},
+    ]
+
+    test_cases.each do |t|
+      it "Can parse \"#{t[:ref]}\"" do
+        expect( ReferenceMatch.scan( t[:ref] ).map {|rm| rm.reference.formatted }).to eq t[:expected]
+      end
+
+      it "Can parse \"giberish 84 #{t[:ref]} foo bar\"" do
+        expect( ReferenceMatch.scan( "giberish 84 #{t[:ref]} foo bar" ).map {|rm| rm.reference.formatted }).to eq t[:expected]
+      end
+    end
+  end
+
+  describe "length and offset" do
+    let(:text) { "John 1:1 is the first first but Romans 8:9-10 is another." }
+    let(:matches) { ReferenceMatch.scan(text) }
+
+    it "stores the correct length and offset for each match" do
+      expect(matches[0].offset).to eq 0
+      expect(matches[0].length).to eq 8
+      expect(matches[1].offset).to eq 32
+      expect(matches[1].length).to eq 13
+    end
+  end
+end

data/spec/lib/reference_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe BibleBot::Reference do
+  describe "parse" do
+    [
+      ["Genesis 1:1", true, nil],
+      ["Genesis 51:4", false, InvalidVerseError],
+      ["Romans 5:2-4:11", false, InvalidReferenceError],
+    ].each do |ref, expected_valid, expected_error|
+      context "parsing \"#{ref}\"" do
+        let(:references) { Reference.parse(ref) }
+
+        it "skips invalid references" do
+          expect(references.count).to eq(expected_valid ? 1 : 0)
+        end
+
+        context "validate=false" do
+          let(:references) { Reference.parse(ref, validate: false) }
+
+          it "#{expected_valid ? 'is' : 'is not'} valid" do
+            expect(references.all?(&:valid?)).to be expected_valid
+          end
+
+          it "calls formatted without errors" do
+            expect(references.first.formatted).to be_a String
+          end
+        end
+
+        context "validate=:raise_errors" do
+          let(:references) { Reference.parse(ref, validate: :raise_errors) }
+
+          if expected_valid
+            it "includes valid references" do
+              expect(references.all?(&:valid?)).to be true
+            end
+          else
+            it "raises error" do
+              expect{ references }.to raise_error(expected_error)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe "formatted" do
+    [
+      [1_001_001, nil, "Genesis 1:1"],
+      [1_001_001, 1_001_001, "Genesis 1:1"],
+      [1_001_001, 1_001_030, "Genesis 1:1-30"],
+      [1_001_001, 1_001_031, "Genesis 1"], # Leaves out verses when range includes the entire chapter
+      [1_001_001, 1_002_004, "Genesis 1:1-2:4"],
+      [1_001_001, 1_002_025, "Genesis 1-2"],
+      [1_002_003, 1_003_003, "Genesis 2:3-3:3"],
+      [65_001_001, 65_001_006, "Jude 1-6"],
+      [65_001_001, 65_001_025, "Jude"],
+      [65_001_001, 66_001_015, "Jude 1-Revelation 1:15"],
+      [1_050_001, 2_002_013, "Genesis 50:1-Exodus 2:13"],
+      [1_001_001, 2_001_001, "Genesis 1:1-Exodus 1:1"],
+    ].each do |start_verse_id, end_verse_id, expected_formated_value|
+      describe "start_verse_id=#{start_verse_id} and end_verse_id=#{end_verse_id}" do
+        subject { described_class.from_verse_ids(start_verse_id, end_verse_id).formatted }
+        it { is_expected.to eq expected_formated_value }
+      end
+    end
+  end
+
+  describe "verses" do
+    [
+      [1_001_001, nil, 1],
+      [1_001_001, 1_001_005, 5],
+      [1_001_001, 1_002_005, 36],
+      [1_001_001, 2_001_001, 1534],
+    ].each do |start_verse_id, end_verse_id, expected_verse_count|
+      describe "start_verse_id=#{start_verse_id} and end_verse_id=#{end_verse_id}" do
+        subject { described_class.from_verse_ids(start_verse_id, end_verse_id).verses.count }
+        it { is_expected.to eq expected_verse_count }
+      end
+    end
+  end
+
+  describe "include_verses?" do
+    [
+      [1_001_010, 2_001_001, 1_001_002, false],
+      [1_001_010, 2_001_001, 1_001_010, true],
+      [1_001_010, 2_001_001, 1_034_005, true],
+      [1_001_010, 2_001_001, 2_001_001, true],
+      [1_001_010, 2_001_001, 2_001_002, false],
+      [1_001_010, 2_001_001, nil, false],
+    ].each do |start_verse_id, end_verse_id, included_verse_id, expect_incuded|
+      describe "start_verse_id=#{start_verse_id}, end_verse_id=#{end_verse_id}, included_verse_id=#{included_verse_id}" do
+        let(:reference) { described_class.from_verse_ids(start_verse_id, end_verse_id) }
+        subject { reference.includes_verse?(Verse.from_id(included_verse_id)) }
+        it { is_expected.to eq expect_incuded }
+      end
+    end
+  end
+
+  describe "intersects_reference?" do
+    [
+      [1_001_010, nil, 1_001_010, nil, true],
+      [1_001_010, 1_002_010, 1_002_011, 1_003_001, false],
+      [1_001_010, 1_002_010, 1_002_010, 1_003_001, true],
+      [1_001_010, 1_002_010, 1_002_009, 1_003_001, true],
+      [1_001_010, 1_002_010, 1_001_001, 1_003_001, true],
+      [1_001_010, 1_002_010, 1_001_001, 1_001_011, true],
+      [1_001_010, 1_002_010, 1_001_001, 1_001_010, true],
+      [1_001_010, 1_002_010, 1_001_001, 1_001_009, false],
+    ].each do |ref1_start, ref1_end, ref2_start, ref2_end, intersect_expected|
+      describe "ref1_start=#{ref1_start}, ref1_end=#{ref1_end}, ref2_start=#{ref2_start}, ref2_end=#{ref2_end}" do
+        let(:reference1) { described_class.from_verse_ids(ref1_start, ref1_end) }
+        let(:reference2) { described_class.from_verse_ids(ref2_start, ref2_end) }
+        subject { reference1.intersects_reference? reference2 }
+        it { is_expected.to eq intersect_expected }
+      end
+    end
+  end
+
+  describe "self.from_verse_ids" do
+    context "using Integer verse IDs" do
+      let(:reference) { Reference.from_verse_ids(1_001_001, 1_005_002) }
+
+      it "Successfully initializes Reference" do
+        expect(reference.formatted).to eq("Genesis 1:1-5:2")
+      end
+    end
+
+    context "using deprecated String verse IDs" do
+      let(:reference) { Reference.from_verse_ids("genesis-001-001", "genesis-005-002") }
+
+      it "Successfully initializes Reference" do
+        expect(reference.formatted).to eq("Genesis 1:1-5:2")
+      end
+    end
+  end
+end

data/spec/lib/verse_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Verse do
+  describe 'self.from_id' do
+    [
+      [19_105_001, "Psalm 105:1"],
+      [1_001_001, "Genesis 1:1"],
+      [66_022_021, "Revelation 22:21"],
+    ].each do |id, expected_reference|
+      context "id=integer" do
+        it "initializes verse #{expected_reference}" do
+          expect(Verse.from_id(id).formatted).to eq(expected_reference)
+        end
+      end
+    end
+
+    [
+      ["psalms-105-001", "Psalm 105:1"],
+      ["genesis-001-001", "Genesis 1:1"],
+      ["revelation-022-021", "Revelation 22:21"],
+    ].each do |id, expected_reference|
+      context "id=string" do
+        it "initializes verse #{expected_reference}" do
+          expect(Verse.from_id(id).formatted).to eq(expected_reference)
+        end
+      end
+    end
+  end
+
+  describe "id" do
+    let(:id) { 10_020_004 }
+    it "returns back the verse ID" do
+      expect(Verse.from_id(id).id).to eq(id)
+    end
+  end
+
+  describe "string_id" do
+    let(:id) { 10_020_004 }
+    let(:string_id) { "2_samuel-020-004" }
+    it "returns back the verse ID" do
+      expect(Verse.from_id(id).string_id).to eq(string_id)
+    end
+  end
+
+  describe "next_verse" do
+    context "starting at Genesis 1:1" do
+      let(:starting_verse) { Verse.from_id(1_001_001) }
+
+      it "works through every verse in the bible" do
+        count = 0
+        verse = starting_verse
+        while verse do
+          verse = verse.next_verse
+          count += 1
+        end
+
+        expect(count).to eq(31_103)
+      end
+    end
+  end
+
+  describe 'valid?' do
+    [
+      { verse_id: 1_050_001, expect_valid: true },
+      { verse_id: 5_001_046, expect_valid: true },
+      { verse_id: 1_051_001, expect_valid: false },
+      { verse_id: 5_001_047, expect_valid: false },
+    ].each do |t|
+      context "verse_id=#{t[:verse_id]}" do
+        it "#{t[:expect_valid] ? 'is' : 'is not'} valid" do
+          expect(Verse.from_id(t[:verse_id]).valid?).to be t[:expect_valid]
+        end
+      end
+    end
+  end
+end