Project

kj

0.0
No commit activity in last 3 years
No release in over 3 years
kj is a simple rubygem for accessing the King James Bible. It uses an embedded sqlite data store.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.0
~> 2.0
~> 3.0

Runtime

~> 1.3
 Project Readme

kj

kj is a simple rubygem for accessing the King James Bible. It uses an embedded sqlite data store.


Install

gem install kj

Usage

Create

require 'kj'
bible = Kj::Bible.new

Books

All return an array of Book objects.

books = bible.books 
books = bible.books(1) 
books = bible.books(:genesis)
books = bible.books('Gen')
books = bible.books(:genesis, 2, 'Levit')

Book

romans = bible.book(45)
romans = bible.book(:romans)
romans = bible.book('Rom')
puts romans.name
 => "Romans" 

Chapters

All return an array of Chapter objects for the book.

genesis = bible.book(:genesis)
chapters = genesis.chapters 
chapters = genesis.chapters(1, 2, (3..10).to_a)

Chapter

genesis = bible.book(:genesis)
chapter = genesis.chapter(1)
puts chapter.book_name
 => "Genesis" 
puts chapter.number
 => 1
puts chapter.title
 => "Genesis 1"
chapter.next # returns the next Chapter
chapter.prev # returns the previous Chapter

Verses

All return an array of Verse objects.

genesis = bible.book(:genesis)
verses = genesis.chapter(1).verses
verse = genesis.chapter(1).verses(1, 2, (3..10).to_a)

Verse

genesis = bible.book(:genesis)
verse = genesis.chapter(1).verse(1)
puts verse.title
 => "Genesis 1:1" 
puts verse.text
 => "In the beginning God..."
verse.next # returns the next Verse
verse.prev # returns the previous Verse

Other Stuff

Random

bible.random_book #returns a random Kj::Book
bible.random_chapter #returns a random Kj::Chapter
bible.random_verse #returns a random Kj::Verse
puts bible.random_verse.text
 => "But woe unto you, scribes and Pharisees, hypocrites! for ye shut up the kingdom of heaven against men: for ye neither go in yourselves, neither suffer ye them that are entering to go in."

Percentages

# Locate Verse objects by their decimal percent between 0 and 1
verse = bible.percent(0.5)
puts verse.title
 => "Psalms 103:1" 

Pages

# Locate Verse objects for a particular page (1-1609)
verses = bible.page(777)
puts verses.first.title
 => "Psalms 22:26" 

Exceptions

Kj will raise a Kj::Iniquity when it can't find what you're looking for.

bible.book(:tobit)
# Kj::Iniquity: Not found

As you can see, kj is a protestant gem.

FAQ

Q. Why only King James? Are you one of those 'King James only' nuts?

A. Yes

Contributing to kj

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2015 David John. See LICENSE.txt for further details.