Skip to content

siwilkins/bible_passage

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bible_passage

A simple library for parsing and rendering bible passages.

Usage

The most common usage of bible_passage will be to parse a reference string, which will return a new BiblePassage::Reference object

ref = BiblePassage::Reference.parse "gen 1:2-3"

This BiblePassage::Reference object can be output as a string

> ref.to_s
=> "Genesis 1:2-3"

bible_passage can handle common book name abbreviations, and will also simplify references where appropriate, eg.

> BiblePassage::Reference.parse("Genesis 1:1-50:26").to_s
=> "Genesis"

It will check the validity of references and throw a BiblePassage::InvalidReferenceError if a reference is not valid

> BiblePassage::Reference.parse("mt 3-1")
BiblePassage::InvalidReferenceError: to_chapter cannot be before from_chapter

> BiblePassage::Reference.parse("Exudos")
BiblePassage::InvalidReferenceError: Exudos is not a valid book

> BiblePassage::Reference.parse("Ex 41")
BiblePassage::InvalidReferenceError: Exodus doesn't have a chapter 41

License

bible_passage is distributed under the MIT License.

About

A simple library for parsing and rendering bible passages

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages