bible_ref 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dea4f491ea3eb6ab3423ef43ffb28bfbf476c90c
-  data.tar.gz: 99173e007d6f7525a4e33bdd31539ac0752bcb02
+  metadata.gz: d7620ceecdf8eb2efd2f77531477b879276732c3
+  data.tar.gz: e1f60d7af94a285df7f58dfb25eb408ddcfb1ab1
 SHA512:
-  metadata.gz: 935df69f67503f12b49b4d9e86db595d4bbc14509f82de795c2a03209d4231f2c92a5bd1145b0bedc954d7a40aef7a1fadbf22e780db6cf7314a04fea5f92156
-  data.tar.gz: 58c8b85919fad6da9072b2a1da22d402513a0888057285c321c51229f18e7d3067e4dfd806554e79dab8233b4b43c268f3064028a7ddddb614cf0b0f53e17ea0
+  metadata.gz: 12ffede23ce5079666e1740fde4706ad43d67a5e776e700991a4d5ab423985c52e4953ffd4bf6cee578074736ce2a5ea30188d6ee0c94cc24580c72aa0b3be87
+  data.tar.gz: 96413110c682fccff792273c0e9fec29c8966ccf7b6d375e5cd348d1ac8524234dc8948fdce96d2685e27ab8f9a67efe8e5b8cb9b93b839ca001ff1fe2d1b60f

data/lib/bible_ref/book.rb

@@ -98,6 +98,93 @@ module BibleRef
       'REV' => /^re?v/
     }
 
+    FORMATTED_BOOKS = {
+      'GEN' => 'Genesis',
+      'EXO' => 'Exodus',
+      'LEV' => 'Leviticus',
+      'NUM' => 'Numbers',
+      'DEU' => 'Deuteronomy',
+      'JOS' => 'Joshua',
+      'JDG' => 'Judges',
+      'RUT' => 'Ruth',
+      '1SA' => '1 Samuel',
+      '2SA' => '2 Samuel',
+      '1KI' => '1 Kings',
+      '2KI' => '2 Kings',
+      '1CH' => '1 Chronicles',
+      '2CH' => '2 Chronicles',
+      'EZR' => 'Ezra',
+      'NEH' => 'Nehemiah',
+      'EST' => 'Esther',
+      'JOB' => 'Job',
+      'PSA' => 'Psalms',
+      'PRO' => 'Proverbs',
+      'ECC' => 'Ecclesiastes',
+      'SNG' => 'Song of Solomon',
+      'ISA' => 'Isaiah',
+      'JER' => 'Jeremiah',
+      'LAM' => 'Lamentations',
+      'EZK' => 'Ezekiel',
+      'DAN' => 'Daniel',
+      'HOS' => 'Hosea',
+      'JOL' => 'Joel',
+      'AMO' => 'Amos',
+      'OBA' => 'Obadiah',
+      'JON' => 'Jonah',
+      'MIC' => 'Micah',
+      'NAM' => 'Nahum',
+      'HAB' => 'Habakkuk',
+      'ZEP' => 'Zephaniah',
+      'HAG' => 'Haggai',
+      'ZEC' => 'Zechariah',
+      'MAL' => 'Malachi',
+      'TOB' => 'Tobit',
+      'JDT' => 'Judith',
+      'ESG' => 'Esther (Greek)',
+      'WIS' => 'Wisdom of Solomon',
+      'SIR' => 'Sirach',
+      'BAR' => 'Baruch',
+      'LJE' => 'Jeremy’s Letter',
+      'S3Y' => '3 Holy Children’s Song',
+      'SUS' => 'Susanna',
+      'BEL' => 'Bel and the Dragon',
+      '1MA' => '1 Maccabees',
+      '2MA' => '2 Maccabees',
+      '1ES' => '1 Esdras',
+      'MAN' => 'Prayer of Manasses',
+      'PS2' => 'Psalm 151',
+      '3MA' => '3 Maccabees',
+      '2ES' => '2 Esdras',
+      '4MA' => '4 Maccabees',
+      'MAT' => 'Matthew',
+      'MRK' => 'Mark',
+      'LUK' => 'Luke',
+      'JHN' => 'John',
+      'ACT' => 'Acts',
+      'ROM' => 'Romans',
+      '1CO' => '1 Corinthians',
+      '2CO' => '2 Corinthians',
+      'GAL' => 'Galatians',
+      'EPH' => 'Ephesians',
+      'PHP' => 'Philippians',
+      'COL' => 'Colossians',
+      '1TH' => '1 Thessalonians',
+      '2TH' => '2 Thessalonians',
+      '1TI' => '1 Timothy',
+      '2TI' => '2 Timothy',
+      'TIT' => 'Titus',
+      'PHM' => 'Philemon',
+      'HEB' => 'Hebrews',
+      'JAS' => 'James',
+      '1PE' => '1 Peter',
+      '2PE' => '2 Peter',
+      '1JN' => '1 John',
+      '2JN' => '2 John',
+      '3JN' => '3 John',
+      'JUD' => 'Jude',
+      'REV' => 'Revelation'
+    }
+
     def initialize(book, canon=:protestant)
       @canon = canon
       unless CANONS[@canon]
@@ -114,5 +201,9 @@ module BibleRef
       nil
     end
 
+    def formatted
+      FORMATTED_BOOKS[id]
+    end
+
   end
 end

data/lib/bible_ref/reference.rb

@@ -7,11 +7,17 @@ module BibleRef
     attr_reader :book
     attr_reader :reference
 
+    # Create a new Reference instance by passing in the user-supplied bible reference as a string.
     def initialize(reference)
       @reference = reference
       @details = parse
     end
 
+    # Returns an array of pairs, each one being the from and to for a range.
+    # For single verses, the same ref is repeated twice. This is most helpful
+    # for converting the entire passage into a SQL query, and in fact is exactly
+    # why this library was built. See https://github.com/seven1m/bible_api/blob/master/app.rb
+    # for an example.
     def ranges
       return nil unless valid?
       @chapter = nil
@@ -20,16 +26,42 @@ module BibleRef
       end
     end
 
+    # Returns a BibleRef::Book instance or nil if book not known.
     def book
-      @book ||= Book.new(@details[:book]).id
+      return nil unless @details
+      @book ||= Book.new(@details[:book])
     end
 
+    # Returns true if the reference is a known bible passage.
     def valid?
-      @details and book
+      @details and book.id
+    end
+
+    # Returns a normalized passage reference. e.g.
+    #
+    # 'JOHN 3:16&17' => 'John 3:16,17'
+    def normalize
+      book.formatted + ' ' +
+      ranges.map do |(ref_from, ref_to)|
+        if ref_from != ref_to
+          ref_part(ref_from) + '-' + ref_part(ref_to)
+        else
+          ref_part(ref_from)
+        end
+      end.join(',')
     end
 
     private
 
+    def ref_part(ref)
+      if @last_chapter != ref[:chapter] and ref[:chapter]
+        @last_chapter = ref[:chapter]
+        "#{ref[:chapter]}:#{ref[:verse]}"
+      else
+        ref[:verse].to_s
+      end
+    end
+
     def parse
       begin
         parsed = Parser.new.parse(@reference)
@@ -45,15 +77,15 @@ module BibleRef
       ch = range.detect { |_, r| r[:chapter] }
       @chapter = ch.last[:chapter] if ch
       [
-        { book: @book, chapter: @chapter }.merge(range[:from]),
-        { book: @book, chapter: @chapter }.merge(range[:to])
+        { book: @book.id, chapter: @chapter }.merge(range[:from]),
+        { book: @book.id, chapter: @chapter }.merge(range[:to])
       ]
     end
 
     def normalize_ref(ref)
       @chapter = ref[:chapter] if ref[:chapter]
       (1..2).map do
-        { book: @book, chapter: @chapter }.merge(ref)
+        { book: @book.id, chapter: @chapter }.merge(ref)
       end
     end
 

data/lib/bible_ref/version.rb

@@ -1,3 +1,3 @@
 module BibleRef
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bible_ref
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-06 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet