Project

bible_bot

0.0
No release in over a year
bible_botlightstock/bible_botHomepageDocumentationSource CodeBug TrackerWiki
Bible Verse Parsing, etc.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
5,363
Stars
1
Forks
1
Watchers
5
 Releases
Current version
2.1.0
Total releases
3
First release
2020-07-16
Latest release
2021-09-13
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
9
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2023-05-01
Reverse Dependencies
0

 Dependencies

Development

pry
>= 0
rspec
~> 3.5.0
irb
>= 0
 Project Readme

bible_bot

Gem for parsing and working with bible verse references.

Getting Started

# Gemfile
gem 'bible_bot', github: 'LittleLea/bible_bot'
$ bundle install
require 'bible_bot'

# Parsing
references = BibleBot::Reference.parse( "John 1:1 is the first but Rom 8:9-10 is another." )

# Formatting
references.formatted #=> "John 1:1; Romans 8:9-10"
references.map(&:formatted).join( ", " ) #=> "John 1:1, Romans 8:9-10"
reference = references.last
reference.start_verse.formatted #=> "Romans 8:9"
reference.end_verse.formatted   #=> "Romans 8:10"

# Invalid references are skipped by default
BibleBot::Reference.parse( "Genesis 100:1" ) #=> []

# Optionally include invalid references
references = BibleBot::Reference.parse( "Genesis 100:1", validate: false )
references.first.valid? #=> false

# Optionally raise on errors
BibleBot::Reference.parse( "Genesis 100:1", validate: :raise_errors )
# => BibleBot::InvalidVerseError:
#      Verse is not valid: {:book=>"Genesis", :chapter_number=>100, :verse_number=>1}

# Find Books
book = BibleBot::Book.find_by_name("1 John")
book.reference.inspect #=> {:start_verse=>"1 John 1:1", :end_verse=>"1 John 5:21"}

Terms

  • Verse - A single verse in the bible.
  • Reference - A range of two verses. Start and end verse may be equal, in which case it is a single verse reference.
  • ReferenceMatch - A lower level wrapper around regular expression Match results. This class contains all the parsing logic. Except for advanced use cases, use Reference.parse instead.
  • Book - One of the 66 books in the bible.
  • Bible - A wrapper containing all 66 books and the regular expressions used for parsing.

Supported Abbreviation Rules

  • May abbreviate the book title. See BibleBot::Bible for which book abbreviations are supported.
"Gen 1:1"
  • May omit the end book if it is the same as the start book.
"Genesis 1:1-2:3"  #=> Genesis 1:1 - Genesis 2:3
  • May omit the end chapter if it is the same as the start chapter.
"Genesis 1:1-3"    #=> Genesis 1:1 - Genesis 1:3
  • May omit the verse number if the reference includes the entire chapter.
"Genesis 1"    #=> Genesis 1:1 - Genesis 1:31
"Genesis 1-2"  #=> Genesis 1:1 - Genesis 2:25

Persisting References and Verses

A Reference is made up of two Verse objects.

reference.start_verse
reference.end_verse

Each verse is represented by an integer ID that can be stored in your database.

#   |- book.id
#   |   |- chapter_number
#   |   |   |- verse_number
#   XX_XXX_XXX

reference.start_verse.id #=> 1_001_001  (Genesis 1:1)
reference.end_verse.id   #=> 2_010_020  (Exodus 10:20)

How you store the start_verse and end_verse is up to you.

To re-instantiate a reference, you can use Reference.from_verse_ids(:start_verse_id, :end_verse_id).

Reference.from_verse_ids(1_001_001, 2_010_020)

# Which is shorthand for
Reference.new(
  start_verse: Verse.from_id(1_001_001),
  end_verse: Verse.from_id(2_010_020)
)

Comparing References

If you want to see if a Reference intersects any you have stored in your database, you might do something like:

Foo.where("start_verse_id <= ?", reference.end_verse.id)
   .where("end_verse_id >= ?", reference.start_verse.id)

Reference and Verse also have built in methods for comparing against each other.

reference.intersects_reference?(other_reference)
reference.includes_verse?(verse)
verse < other_verse
verse == other_verse
verse > other_verse

Apocryphal References

If you want to match apocryphal references in your strings, you can enable a collection of matchers like this:

BibleBot.include_apocryphal_content = true

ReferenceMatch.scan( "Tob 1:1" ).first.reference.formatted

# > "Tobit 1:1"

You can see the supported apocryphal works in bible.rb

History

Originally ported from https://github.com/davisd/python-scriptures