bible_passage 0.0.1

data/lib/bible_passage/book_key_translator.rb

@@ -0,0 +1,346 @@
+module BiblePassage
+
+  class BookKeyTranslator
+
+    TRANSLATIONS = {
+      ge: :gen,
+      gen: :gen,
+      gene: :gen,
+      genes: :gen,
+      genesis: :gen,
+      gn: :gen,
+
+      ex: :exod,
+      exo: :exod,
+      exod: :exod,
+      exodus: :exod,
+
+      le: :lev,
+      lev: :lev,
+      levit: :lev,
+      leviticus: :lev,
+
+      nm: :num,
+      nu: :num,
+      num: :num,
+      numb: :num,
+      numbers: :num,
+
+      de: :deut,
+      de: :deut,
+      deu: :deut,
+      deut: :deut,
+      deuter: :deut,
+      deuteronomy: :deut,
+      dt: :deut,
+
+      jos: :josh,
+      josh: :josh,
+      joshua: :josh,
+
+      jd: :judg,
+      jdg: :judg,
+      judg: :judg,
+      judges: :judg,
+
+      ruth: :ruth,
+
+      '1 sa'.to_sym => '1sam'.to_sym,
+      '1 sam'.to_sym => '1sam'.to_sym,
+      '1 samuel'.to_sym => '1sam'.to_sym,
+
+      '2 sa'.to_sym => '2sam'.to_sym,
+      '2 sam'.to_sym => '2sam'.to_sym,
+      '2 samuel'.to_sym => '2sam'.to_sym,
+
+      '1 kgs'.to_sym => '1kgs'.to_sym,
+      '1 ki'.to_sym => '1kgs'.to_sym,
+      '1 king'.to_sym => '1kgs'.to_sym,
+      '1 kings'.to_sym => '1kgs'.to_sym,
+      '1 kngs'.to_sym => '1kgs'.to_sym,
+
+      '2 kgs'.to_sym => '2kgs'.to_sym,
+      '2 ki'.to_sym => '2kgs'.to_sym,
+      '2 king'.to_sym => '2kgs'.to_sym,
+      '2 kings'.to_sym => '2kgs'.to_sym,
+      '2 kngs'.to_sym => '2kgs'.to_sym,
+
+      '1 ch'.to_sym => '1chr'.to_sym,
+      '1 chr'.to_sym => '1chr'.to_sym,
+      '1 chro'.to_sym => '1chr'.to_sym,
+      '1 chron'.to_sym => '1chr'.to_sym,
+      '1 chronicles'.to_sym => '1chr'.to_sym,
+
+      '2 ch'.to_sym => '2chr'.to_sym,
+      '2 chr'.to_sym => '2chr'.to_sym,
+      '2 chro'.to_sym => '2chr'.to_sym,
+      '2 chron'.to_sym => '2chr'.to_sym,
+      '2 chronicles'.to_sym => '2chr'.to_sym,
+
+      ezr: :ezra,
+      ezra: :ezra,
+
+      ne: :neh,
+      neh: :neh,
+      nehem: :neh,
+      nehemiah: :neh,
+
+      es: :esth,
+      est: :esth,
+      esth: :esth,
+      esther: :esth,
+
+      jo: :job,
+      job: :job,
+
+      ps: :ps,
+      psa: :ps,
+      psal: :ps,
+      psalm: :ps,
+      psalms: :ps,
+
+      pr: :prov,
+      pro: :prov,
+      prov: :prov,
+      proverbs: :prov,
+
+      ec: :eccl,
+      ecc: :eccl,
+      eccl: :eccl,
+      eccles: :eccl,
+      ecclesiastes: :eccl,
+
+      so: :song,
+      'song of solomon'.to_sym => :song,
+      'song of songs'.to_sym => :song,
+      'song of sol'.to_sym => :song,
+      ss: :song,
+      ssong: :song,
+
+      is: :isa,
+      isa: :isa,
+      isaiah: :isa,
+
+      je: :jer,
+      jer: :jer,
+      jere: :jer,
+      jerem: :jer,
+      jeremiah: :jer,
+
+      la: :lam,
+      lam: :lam,
+      lamen: :lam,
+      lament: :lam,
+      lamentations: :lam,
+
+      eze: :ezek,
+      ezek: :ezek,
+      ezekiel: :ezek,
+
+      da: :dan,
+      dan: :dan,
+      daniel: :dan,
+
+      ho: :hos,
+      hos: :hos,
+      hosea: :hos,
+
+      joe: :joel,
+      joel: :joel,
+
+      am: :amos,
+      amos: :amos,
+
+      ob: :obad,
+      oba: :obad,
+      obad: :obad,
+      obadiah: :obad,
+
+      jon: :jonah,
+      jona: :jonah,
+      jonah: :jonah,
+
+      mi: :mic,
+      mic: :mic,
+      micah: :mic,
+
+      na: :nah,
+      nah: :nah,
+      nahum: :nah,
+
+      hab: :hab,
+      habak: :hab,
+      habakkuk: :hab,
+
+      zep: :zeph,
+      zeph: :zeph,
+      zephaniah: :zeph,
+
+      hag: :hag,
+      hagg: :hag,
+      haggai: :hag,
+
+      zec: :zech,
+      zech: :zech,
+      zechariah: :zech,
+
+      mal: :mal,
+      malac: :mal,
+      malach: :mal,
+      malachi: :mal,
+
+      mat: :matt,
+      matt: :matt,
+      matth: :matt,
+      matthew: :matt,
+      mt: :matt,
+
+      mar: :mark,
+      mark: :mark,
+      mr: :mark,
+      mrk: :mark,
+
+      lk: :luke,
+      lke: :luke,
+      lu: :luke,
+      luk: :luke,
+      luke: :luke,
+
+      jhn: :john,
+      jn: :john,
+      joh: :john,
+      john: :john,
+
+      ac: :acts,
+      act: :acts,
+      acts: :acts,
+
+      ro: :rom,
+      rom: :rom,
+      roman: :rom,
+      romans: :rom,
+
+      '1 co'.to_sym => '1cor'.to_sym,
+      '1 cor'.to_sym => '1cor'.to_sym,
+      '1 corin'.to_sym => '1cor'.to_sym,
+      '1 corinth'.to_sym => '1cor'.to_sym,
+      '1 corinthians'.to_sym => '1cor'.to_sym,
+
+      '2 co'.to_sym => '2cor'.to_sym,
+      '2 cor'.to_sym => '2cor'.to_sym,
+      '2 corin'.to_sym => '2cor'.to_sym,
+      '2 corinth'.to_sym => '2cor'.to_sym,
+      '2 corinthians'.to_sym => '2cor'.to_sym,
+
+      ga: :gal,
+      gal: :gal,
+      galat: :gal,
+      galatians: :gal,
+
+      ep: :eph,
+      eph: :eph,
+      ephes: :eph,
+      ephesians: :eph,
+
+      ph: :phil,
+      phi: :phil,
+      phil: :phil,
+      phili: :phil,
+      philip: :phil,
+      philipp: :phil,
+      philippians: :phil,
+      php: :phil,
+
+      co: :col,
+      col: :col,
+      colo: :col,
+      colos: :col,
+      coloss: :col,
+      colossians: :col,
+
+      '1 ti'.to_sym => '1tim'.to_sym,
+      '1 tim'.to_sym => '1tim'.to_sym,
+      '1 timothy'.to_sym => '1tim'.to_sym,
+
+      '1 th'.to_sym => '1thess'.to_sym,
+      '1 the'.to_sym => '1thess'.to_sym,
+      '1 thes'.to_sym => '1thess'.to_sym,
+      '1 thess'.to_sym => '1thess'.to_sym,
+      '1 thessalonians'.to_sym => '1thess'.to_sym,
+
+      '2 th'.to_sym => '2thess'.to_sym,
+      '2 the'.to_sym => '2thess'.to_sym,
+      '2 thes'.to_sym => '2thess'.to_sym,
+      '2 thess'.to_sym => '2thess'.to_sym,
+      '2 thessalonians'.to_sym => '2thess'.to_sym,
+
+      '2 ti'.to_sym => '2tim'.to_sym,
+      '2 tim'.to_sym => '2tim'.to_sym,
+      '2 timothy'.to_sym => '2tim'.to_sym,
+
+      tit: :titus,
+      titu: :titus,
+      titus: :titus,
+
+      phile: :phlm,
+      philem: :phlm,
+      philemon: :phlm,
+      phlm: :phlm,
+      phlmn: :phlm,
+      phm: :phlm,
+      phmn: :phlm,
+
+      he: :heb,
+      heb: :heb,
+      hebr: :heb,
+      hebrews: :heb,
+
+      ja: :jas,
+      jam: :jas,
+      james: :jas,
+      jas: :jas,
+
+      '1 pe'.to_sym => '1pet'.to_sym,
+      '1 pet'.to_sym => '1pet'.to_sym,
+      '1 peter'.to_sym => '1pet'.to_sym,
+
+      '2 pe'.to_sym => '2pet'.to_sym,
+      '2 pet'.to_sym => '2pet'.to_sym,
+      '2 peter'.to_sym => '2pet'.to_sym,
+
+      '1 jn'.to_sym => '1john'.to_sym,
+      '1 jo'.to_sym => '1john'.to_sym,
+      '1 joh'.to_sym => '1john'.to_sym,
+      '1 john'.to_sym => '1john'.to_sym,
+
+      '2 jn'.to_sym => '2john'.to_sym,
+      '2 jo'.to_sym => '2john'.to_sym,
+      '2 joh'.to_sym => '2john'.to_sym,
+      '2 john'.to_sym => '2john'.to_sym,
+
+      '3 jn'.to_sym => '3john'.to_sym,
+      '3 jo'.to_sym => '3john'.to_sym,
+      '3 joh'.to_sym => '3john'.to_sym,
+      '3 john'.to_sym => '3john'.to_sym,
+
+      jude: :jude,
+
+      re: :rev,
+      rev: :rev,
+      revel: :rev,
+      revelation: :rev,
+    }
+
+    def keyify(book_name)
+      TRANSLATIONS[normalize_input(book_name)] ||
+        raise(InvalidReferenceError.new("#{book_name} is not a valid book"))
+    end
+
+    private
+    def normalize_input(book_name)
+      book_name.strip.downcase.gsub(/\s+/, ' ').to_sym
+    end
+
+  end
+
+end

data/lib/bible_passage/invalid_reference_error.rb

@@ -0,0 +1 @@
+class BiblePassage::InvalidReferenceError < ArgumentError;end

data/lib/bible_passage/reference.rb

@@ -0,0 +1,243 @@
+module BiblePassage
+
+  class Reference
+
+    class << self
+
+      def parse(passage, options = {})
+        translator = options.delete(:translator) || BookKeyTranslator.new
+        data_store = options[:data_store] ||= BookDataStore.new
+        match = passage.match(/^\s*(\d?\s*[A-Za-z\s]+)\s*(\d+)?:?(\d+)?-?(\d+)?:?(\d+)?/)
+        book_key = translator.keyify(match[1])
+        if data_store.number_of_chapters(book_key) == 1
+          process_single_chapter_match(book_key, match, options)
+        else
+          process_multi_chapter_match(book_key, match, options)
+        end
+      end
+
+
+      private
+      def process_multi_chapter_match(book_key, match, options)
+        if match[2]
+          from_chapter = match[2].to_i 
+          # has from verse
+          if match[3]
+            from_verse = match[3].to_i
+            if match[5]
+              to_chapter = match[4].to_i
+              to_verse = match[5].to_i
+            else
+              to_verse = match[4].to_i if match[4]
+            end
+          else
+            from_verse = match[3].to_i if match[3]
+            to_chapter = match[4].to_i if match[4]
+          end
+        end
+        new(book_key, from_chapter, from_verse, to_chapter, to_verse, options)
+      end
+
+      def process_single_chapter_match(book_key, match, options)
+        if match[2]
+          from_verse = match[2].to_i
+          to_verse = match[4].to_i if match[4]
+        end
+        if match[0] =~ /:/
+          book_name = options[:data_store].book_name(book_key)
+          msg = "#{book_name} doesn't have any chapters"
+          raise InvalidReferenceError.new(msg)
+        end
+        new(book_key, nil, from_verse, nil, to_verse, options)
+      end
+
+    end
+
+    attr_reader :book_key, :book
+
+    def initialize(book_key, from_chapter = nil, from_verse = nil, 
+                   to_chapter = nil, to_verse = nil, options = {})
+      @data_store = options[:data_store] || BookDataStore.new
+      self.book_key = book_key
+      self.from_chapter = int_param(from_chapter)
+      self.from_verse = int_param(from_verse)
+      self.to_chapter = calculate_to_chapter(to_chapter)
+      self.to_verse = calculate_to_verse(to_verse)
+    end
+
+    def book_key=(key)
+      @book = @data_store.book_name(key)
+      @book_key = key
+    end
+
+    def from_chapter
+      @from_chapter || 1
+    end
+
+    def from_chapter=(val)
+      if val
+        raise InvalidReferenceError.new(
+          "#{book} doesn't have a chapter #{val}") if val < 1 || 
+          val > @data_store.number_of_chapters(book_key)
+        @from_chapter = val
+      end
+    end
+
+    def from_verse
+      @from_verse || 1
+    end
+
+    def from_verse=(val)
+      if val
+        raise InvalidReferenceError.new(
+          "#{book} #{from_chapter} doesn't have a verse #{val}") if val < 1 ||
+          val > @data_store.number_of_verses(book_key, from_chapter)
+        @from_verse = val
+      end
+    end
+
+    def to_chapter
+      @to_chapter || from_chapter
+    end
+
+    def to_chapter=(val)
+      if val
+        raise InvalidReferenceError.new(
+          "to_chapter cannot be before from_chapter") if val < from_chapter
+        raise InvalidReferenceError.new(
+          "#{book} doesn't have a chapter #{val}") if val > 
+          @data_store.number_of_chapters(book_key)
+        @to_chapter = val
+      end
+    end
+
+    def to_verse
+      @to_verse || from_verse
+    end
+
+    def to_verse=(val)
+      if val
+        raise InvalidReferenceError.new(
+          "to_verse cannot be before from_verse") if val < from_verse && 
+          single_chapter_passage?
+        raise InvalidReferenceError.new(
+          "#{book} #{to_chapter} doesn't have a verse #{val}") if val > 
+          @data_store.number_of_verses(book_key, to_chapter)
+        @to_verse = val
+      end
+    end
+
+    def to_s
+      if single_chapter_book?
+        "#{book}#{from_verse_part}#{to_verse_part}"
+      else
+        "#{book}#{from_part}#{to_part}"
+      end
+    end
+
+    def whole_chapters?
+      from_verse == 1 && to_verse_last_in_chapter?
+    end
+
+    def whole_book?
+      from_chapter == 1 && from_verse == 1 && 
+        to_chapter == @data_store.number_of_chapters(book_key) &&
+        to_verse == @data_store.number_of_verses(book_key, to_chapter)
+    end
+
+    def whole_chapter?
+      whole_chapters? && from_chapter == to_chapter
+    end
+
+    private
+    def from_part
+      out = ''
+      unless whole_book?
+        out << ' '
+        out << from_chapter.to_s
+        out << from_verse_part
+      end
+      out
+    end
+
+    def from_verse_part
+      if whole_chapters?
+        ''
+      else
+        out = single_chapter_book? ? ' ' : ':'
+        "#{out}#{from_verse.to_s}"
+      end
+    end
+
+    def to_part
+      out = ''
+      unless whole_book? || single_verse_passage? || whole_chapter?
+        out << '-'
+        unless single_chapter_passage?
+          out << to_chapter_part 
+        end
+        out << to_verse_part
+      end
+      out
+    end
+
+    def to_chapter_part
+      if single_chapter_passage?
+        ''
+      else
+        to_chapter.to_s
+      end
+    end
+
+    def to_verse_part
+      if single_verse_passage? || whole_chapters?
+        ''
+      else
+        out = ''
+        out << '-' if single_chapter_book?
+        out << ':' unless single_chapter_passage?
+        out << to_verse.to_s
+        out
+      end
+    end
+
+
+    def int_param(param)
+      param ? param.to_i : nil
+    end
+
+    def single_chapter_passage?
+      from_chapter == to_chapter
+    end
+
+    def single_verse_passage?
+      single_chapter_passage? && from_verse == to_verse
+    end
+
+    def single_chapter_book?
+      @data_store.number_of_chapters(book_key) == 1
+    end
+    
+    def to_verse_last_in_chapter?
+      to_verse == @data_store.number_of_verses(book_key, to_chapter)
+    end
+
+    def calculate_to_chapter(supplied_to_chapter)
+      int_param(supplied_to_chapter) || begin
+        if @from_chapter
+          @from_chapter
+        else
+          @data_store.number_of_chapters(book_key)
+        end
+      end
+    end
+
+    def calculate_to_verse(supplied_to_verse)
+      int_param(supplied_to_verse) || 
+        @from_verse ||
+          @data_store.number_of_verses(book_key, self.to_chapter)
+    end
+
+  end
+
+end

data/lib/bible_passage.rb

@@ -0,0 +1,5 @@
+require_relative 'bible_passage/reference'
+require_relative 'bible_passage/book_key_translator'
+require_relative 'bible_passage/invalid_reference_error'
+require_relative 'bible_passage/book_data_store'
+