bible_bot 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9916c2ab85ce75d756b6afb51d332cda0a13b8b5d4c578e377777ed99d3689e8
-  data.tar.gz: 69b16b95ac47ee4184ddc010360ca0432b8b36b46b6a727ce29440286f4f1892
+  metadata.gz: 3077a1bf879fa300507e04dc57a24f8c64175a2c5145246b0d48801b96e24294
+  data.tar.gz: 711d60b4e2be2e930e0cad39c718c1473c643277ec13291264befe3dacb067a6
 SHA512:
-  metadata.gz: 4962346de98f90e84907ef1beedb903cd192e4e27534ebfb6223056651c3cc3712a1b7d3302eb4f812ae7484cbe9829cdec64ccaaf862a2db3d2f537e3daa01f
-  data.tar.gz: a6394ed4251f8730a031a8a53b8387b9e36319259bc3070a4204d9ed0d3aed3b2c6284c2605d15ccc451b6604af896fef39c5010e52ec23adae907c9326af118
+  metadata.gz: 4ed4b1cbbe420259d00a6e417243385245645268f01061b4081c8de668a1cb9eba0e9d32be58265971c62dda3f3f5ad4bbc52ec12c8a757dd13a343c22161c9e
+  data.tar.gz: e47c5b22bae6077562d8aa31781ec2d997c1b3f8c2b0aa052f34fc66c5afa8e5c88255564f944863c8e72a8cf6b2f77825ea454ad5247876aebe678c2b03a3bf

data/.gitignore

@@ -1,2 +1,3 @@
 .git
 .yardoc
+.idea

data/Gemfile.lock

@@ -1,17 +1,22 @@
 PATH
   remote: .
   specs:
-    bible_bot (1.4.4)
+    bible_bot (2.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
     diff-lcs (1.3)
+    io-console (0.5.9)
+    irb (1.3.7)
+      reline (>= 0.2.7)
     method_source (1.0.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    reline (0.2.7)
+      io-console (~> 0.5)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -31,8 +36,9 @@ PLATFORMS
 
 DEPENDENCIES
   bible_bot!
+  irb
   pry
   rspec (~> 3.5.0)
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/README.md

@@ -138,6 +138,19 @@ verse == other_verse
 verse > other_verse
 ```
 
+## Deuterocanonical References
+
+If you want to match deuterocanonical references in your strings, you can enable a collection of matchers like this:
+
+```ruby
+BibleBot.include_deuterocanonical_content = true
+
+ReferenceMatch.scan( "Tob 1:1" ).first.reference.formatted
+
+# > "Tobit 1:1"
+```
+
+You can see the supported deuterocanonical works in [bible.rb](https://github.com/LittleLea/bible_bot/blob/b94fe9b3948ceb23d39961ffdc4bdf7ffe23eff3/lib/bible_bot/bible.rb#L537)
 
 ## History
 

data/bible_bot.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rspec', '~> 3.5.0'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'irb'
 end

data/lib/bible_bot/bible.rb

@@ -534,8 +534,176 @@ module BibleBot
       )
     ]
 
+    @@deuterocanonical_books = [
+      Book.new(
+        id: 101,
+        name: "Tobit",
+        abbreviation: "Tob",
+        regex: "Tob(?:it)?",
+        testament: "",
+        chapters: [22, 14, 17, 21, 22, 18, 17, 21, 6, 14, 18, 22, 18, 15],
+      ),
+      Book.new(
+        id: 102,
+        name: "Judith",
+        abbreviation: "Jth",
+        regex: "(?:Ju?d?i?th?)",
+        testament: "",
+        chapters: [16, 28, 10, 15, 24, 21, 32, 36, 14, 23, 23, 20, 20, 19, 14, 25],
+      ),
+      Book.new(
+        id: 103,
+        name: "Additions to Esther",
+        abbreviation: "Add Esth",
+        regex: "(?:((Add\s?|(The\s)?Rest\sof\s|A))Est?h?e?r?)",
+        testament: "",
+        chapters: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 17, 8, 30, 16, 24, 10],
+      ),
+      Book.new(
+        id: 104,
+        name: "Wisdom of Solomon",
+        abbreviation: "Wis",
+        regex: "(?:(Wi?sd?\.?(\sof\s)?(Sol|om)?))",
+        testament: "",
+        chapters: [16, 24, 19, 20, 23, 25, 30, 21, 18, 21, 26, 27, 19, 31, 19, 29, 21, 25, 22],
+      ),
+      Book.new(
+        id: 105,
+        name: "Sirach", # a.k.a. Ecclesiasticus
+        abbreviation: "Sir",
+        regex: "Sir(?:ach)?",
+        testament: "",
+        chapters: [29, 18, 30, 31, 17, 37, 36, 19, 18, 30, 34, 18, 25, 27, 20, 28, 27, 33, 26, 30, 28, 27, 27, 31, 25, 20, 30, 26, 28, 25, 31, 24, 33, 26, 24, 27, 30, 34, 35, 30, 24, 25, 35, 23, 26, 20, 25, 25, 16, 29, 30],
+      ),
+      Book.new(
+        id: 106,
+        name: "Ecclesiasticus", # a.k.a. Sirach
+        abbreviation: "Ecclus",
+        regex: "(?:Ecclus|Ecclesiasticus)",
+        testament: "",
+        chapters: [29, 18, 30, 31, 17, 37, 36, 19, 18, 30, 34, 18, 25, 27, 20, 28, 27, 33, 26, 30, 28, 27, 27, 31, 25, 20, 30, 26, 28, 25, 31, 24, 33, 26, 24, 27, 30, 34, 35, 30, 24, 25, 35, 23, 26, 20, 25, 25, 16, 29, 30],
+      ),
+      Book.new(
+        id: 107,
+        name: "Baruch",
+        abbreviation: "Bar",
+        regex: "Bar(?:uch)?",
+        testament: "",
+        chapters: [22, 35, 38, 37, 9, 72],
+      ),
+      Book.new(
+        id: 108,
+        name: "Letter of Jeremiah", # Often placed as Baruch 6, but sometimes stands alone
+        abbreviation: "Ep Jer",
+        regex: "(?:((Le?t?t?e?r?|Ep)(\.\s|\sof\s)?Jer?))",
+        testament: "",
+        chapters: [73],
+      ),
+      Book.new(
+        id: 109,
+        name: "Song of Three Youths", # An extension of Daniel 3... a.k.a. Prayer of Azariah
+        abbreviation: "Sg of 3 Childr",
+        regex: "(?:(((The\s)?(So?n?g)(\.?\s?o?f?\s?)(the\s)?(3|Thr).*))|((Pr)?.*Aza?r?))",
+        testament: "",
+        chapters: [],
+      ),
+      Book.new(
+        id: 110,
+        name: "Susanna", # A book of Daniel
+        abbreviation: "Sus",
+        regex: "(?:(Sus))",
+        testament: "",
+        chapters: [64],
+      ),
+      Book.new(
+        id: 111,
+        name: "Bel and the Dragon", # A book of Daniel
+        abbreviation: "Bel and Dr",
+        regex: "(?:(Bel))",
+        testament: "",
+        chapters: [42],
+      ),
+      Book.new(
+        id: 112,
+        name: "1 Maccabees",
+        abbreviation: "1 Macc",
+        #regex: "(?:((1s?t?|^I{1}|First)\s?Ma?c?))",
+        regex: "(?:1|I)(?:\\s)?Macc(?:abees)?",
+        testament: "",
+        chapters: [63, 70, 59, 61, 68, 63, 50, 32, 73, 89, 74, 53, 53, 49, 41, 24],
+      ),
+      Book.new(
+        id: 113,
+        name: "2 Maccabees",
+        abbreviation: "2 Macc",
+        regex: "(?:((2n?d?|^I{2}|Second)\s?Ma?c?))",
+        testament: "",
+        chapters: [36, 32, 40, 50, 27, 31, 42, 36, 29, 38, 38, 46, 26, 46, 39],
+      ),
+      Book.new(
+        id: 114,
+        name: "3 Maccabees",
+        abbreviation: "3 Macc",
+        regex: "(?:((3r?d?|^I{3}|Third)\s?Ma?c?))",
+        testament: "",
+        chapters: [29, 33, 30, 21, 51, 41, 23],
+      ),
+      Book.new(
+        id: 115,
+        name: "4 Maccabees",
+        abbreviation: "4 Macc",
+        regex: "(?:((4t?h?|IV|Fourth)\s?Ma?c?))",
+        testament: "",
+        chapters: [35, 24, 21, 26, 38, 35, 23, 29, 32, 21, 27, 19, 27, 20, 32, 25, 24, 24],
+      ),
+      Book.new(
+        id: 116,
+        name: "1 Esdras",
+        abbreviation: "1 Esd",
+        regex: "(?:((1s?t?|^I{1}|First)\s?Esd?))",
+        testament: "",
+        chapters: [58, 30, 24, 63, 73, 34, 15, 96, 55],
+      ),
+      Book.new(
+        id: 117,
+        name: "2 Esdras",
+        abbreviation: "2 Esd",
+        regex: "(?:((2n?d?|^I{2}|Second)\s?Esd?))",
+        testament: "",
+        chapters: [40, 48, 36, 52, 56, 59, 140, 63, 47, 59, 46, 51, 58, 48, 63, 78],
+      ),
+      Book.new(
+        id: 118,
+        name: "Prayer of Manasseh",
+        abbreviation: "Pr of Man",
+        regex: "(?:(Pr?.*Man?))",
+        testament: "",
+        chapters: [15],
+      ),
+      Book.new(
+        id: 119,
+        name: "Additional Psalm",
+        abbreviation: "Add Ps",
+        regex: "(?:(Add.*Ps))",
+        testament: "",
+        chapters: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7],
+      ),
+      Book.new(
+        id: 120,
+        name: "Ode",
+        abbreviation: "Ode",
+        regex: "Ode",
+        testament: "",
+        chapters: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7],
+      ),
+    ]
+
     def self.books
-      @@books
+      if BibleBot.include_deuterocanonical_content?
+        @@books + @@deuterocanonical_books
+      else
+        @@books
+      end
     end
 
     # assemble the book regex
@@ -556,7 +724,7 @@ module BibleBot
          '[\s\.]*' +
          '(?<ChapterNumber>\d{1,3})' +
          '(?:\s*[:\.]\s*' +
-         '(?<VerseNumber>\d{1,3}))?' +
+         '(?<VerseNumber>\d{1,3})\w?)?' +
          '(?:\s*-\s*' +
            '(?<EndBookTitle>%s)?[\s\.]*' +
            '(?<EndChapterNumber>\d{1,3})?' +
@@ -564,5 +732,11 @@ module BibleBot
            '(?<EndVerseNumber>\d{1,3})?' +
          ')?', book_re_string, book_re_string), Regexp::IGNORECASE)
     end
+
+    def self.reset_regular_expressions
+      @@book_re_string = nil
+      @@book_re = nil
+      @@scripture_re = nil
+    end
   end
 end

data/lib/bible_bot/version.rb

@@ -1,3 +1,3 @@
 module BibleBot
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

data/lib/bible_bot.rb

@@ -1,3 +1,4 @@
+require "ostruct"
 require "bible_bot/version"
 require "bible_bot/book"
 require "bible_bot/bible"
@@ -5,3 +6,38 @@ require "bible_bot/errors"
 require "bible_bot/verse"
 require "bible_bot/reference"
 require "bible_bot/reference_match"
+
+module BibleBot
+  DEFAULTS = {
+    include_deuterocanonical_content: false
+  }
+
+  def self.options
+    @options ||= OpenStruct.new(DEFAULTS.dup)
+  end
+
+  def self.options=(opts)
+    @options = opts
+  end
+
+  ##
+  # Configuration for BibleBot, use like:
+  #
+  #   BibleBot.configure do |config|
+  #     config.include_deuterocanonical_content = true
+  #   end
+  def self.configure
+    yield(options)
+  end
+
+  def self.include_deuterocanonical_content?
+    !!self.options.include_deuterocanonical_content
+  end
+
+  def self.include_deuterocanonical_content=(inc)
+    self.options.include_deuterocanonical_content = (inc === true)
+
+    # We need to reset the stored regexps because they take content into account.
+    BibleBot::Bible.reset_regular_expressions
+  end
+end

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe BibleBot do
+
+  describe "scan with deuterocanonical content enabled" do
+    before(:each) do
+      BibleBot.include_deuterocanonical_content = true
+    end
+
+    it "has a config" do
+      expect(BibleBot.include_deuterocanonical_content?).to eq true
+    end
+
+    test_cases = [
+      {ref: "Tob 1:1", expected: ["Tobit 1:1"]},
+      {ref: "Judith 1:2", expected: ["Judith 1:2"]},
+      {ref: "Ecclus 1:8", expected: ["Ecclesiasticus 1:8"]},
+      {ref: "Ode 151:2", expected: ["Ode 151:2"]},
+    ]
+
+    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
+        BibleBot.include_deuterocanonical_content = true
+        expect( ReferenceMatch.scan( "giberish 84 #{t[:ref]} foo bar" ).map {|rm| rm.reference.formatted }).to eq t[:expected]
+      end
+    end
+  end
+
+  describe "scan with deuterocanonical content disabled" do
+    before(:each) do
+      BibleBot.include_deuterocanonical_content = false
+    end
+
+    it "has a config" do
+      expect(BibleBot.include_deuterocanonical_content?).to eq false
+    end
+
+    test_cases = [
+      {ref: "John 1:1", expected: ["John 1:1"]},
+      {ref: "Tob 1:1", expected: []},
+      {ref: "Ode 151:2", expected: []},
+    ]
+
+    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
+end

data/spec/lib/reference_match_spec.rb

@@ -154,6 +154,7 @@ describe BibleBot::ReferenceMatch do
       {ref: "Jude 5", expected: ["Jude 5"]},
       {ref: "Revelation 1:1", expected: ["Revelation 1:1"]},
       {ref: "Rev 1:1", expected: ["Revelation 1:1"]},
+      {ref: "Genesis 13:11b-12", expected: ["Genesis 13:11-12"]}
     ]
 
     test_cases.each do |t|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bible_bot
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Jeff McFadden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - jeff@littlelea.co
@@ -61,6 +75,7 @@ files:
 - lib/bible_bot/verse.rb
 - lib/bible_bot/version.rb
 - spec/lib/book_spec.rb
+- spec/lib/configuration_spec.rb
 - spec/lib/reference_match_spec.rb
 - spec/lib/reference_spec.rb
 - spec/lib/verse_spec.rb
@@ -84,12 +99,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Bible Verse Parsing, etc.
 test_files:
 - spec/lib/book_spec.rb
+- spec/lib/configuration_spec.rb
 - spec/lib/reference_match_spec.rb
 - spec/lib/reference_spec.rb
 - spec/lib/verse_spec.rb