bible_ref 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dea4f491ea3eb6ab3423ef43ffb28bfbf476c90c
+  data.tar.gz: 99173e007d6f7525a4e33bdd31539ac0752bcb02
+SHA512:
+  metadata.gz: 935df69f67503f12b49b4d9e86db595d4bbc14509f82de795c2a03209d4231f2c92a5bd1145b0bedc954d7a40aef7a1fadbf22e780db6cf7314a04fea5f92156
+  data.tar.gz: 58c8b85919fad6da9072b2a1da22d402513a0888057285c321c51229f18e7d3067e4dfd806554e79dab8233b4b43c268f3064028a7ddddb614cf0b0f53e17ea0

data/README.md

@@ -0,0 +1,29 @@
+# BibleRef
+
+Turn "John 3:16" into:
+
+```ruby
+[
+  [{ book: 'JHN', chapter: 3, verse: 16 },
+   { book: 'JHN', chapter: 3, verse: 16 }]
+]
+```
+
+...and turn "Romans 12:1,3-4 & 13:2-4,7-8" into:
+
+```ruby
+[
+  [{ book: 'ROM', chapter: 12, verse: 1 },
+   { book: 'ROM', chapter: 12, verse: 1 }],
+  [{ book: 'ROM', chapter: 12, verse: 3 },
+   { book: 'ROM', chapter: 12, verse: 4 }],
+  [{ book: 'ROM', chapter: 13, verse: 2 },
+   { book: 'ROM', chapter: 13, verse: 4 }],
+  [{ book: 'ROM', chapter: 13, verse: 7 },
+   { book: 'ROM', chapter: 13, verse: 8 }]
+]
+```
+
+## Copyright
+
+Copyright [Tim Morgan](http://timmorgan.org). See LICENSE.

data/lib/bible_ref/book.rb

@@ -0,0 +1,118 @@
+module BibleRef
+
+  class UnknownCanon < StandardError; end
+
+  class Book
+
+    CANONS = {
+      protestant: %w(
+        GEN EXO LEV NUM DEU JOS JDG RUT 1SA 2SA 1KI 2KI 1CH 2CH EZR NEH EST JOB PSA PRO ECC SNG ISA JER LAM EZK DAN HOS JOL AMO OBA JON MIC NAM HAB ZEP HAG ZEC MAL
+        MAT MRK LUK JHN ACT ROM 1CO 2CO GAL EPH PHP COL 1TH 2TH 1TI 2TI TIT PHM HEB JAS 1PE 2PE 1JN 2JN 3JN JUD REV
+      )
+    }
+
+    BOOKS = {
+      'GEN' => /^gen/,
+      'EXO' => /^ex/,
+      'LEV' => /^le?v/,
+      'NUM' => /^nu/,
+      'DEU' => /^de?ut/,
+      'JOS' => /^jos/,
+      'JDG' => /^ju?dg/,
+      'RUT' => /^ru/,
+      '1SA' => /^1 sa?m/,
+      '2SA' => /^2 sa?m/,
+      '1KI' => /^1 (king|kgs)/,
+      '2KI' => /^2 (king|kgs)/,
+      '1CH' => /^1 chr/,
+      '2CH' => /^2 chr/,
+      'EZR' => /^ez/,
+      'NEH' => /^ne/,
+      'EST' => /^est/,
+      'JOB' => /^jo?b/,
+      'PSA' => /^ps/,
+      'PRO' => /^pro?v/,
+      'ECC' => /^ecc/,
+      'SNG' => /^so?ng|^sol|^sg$/,
+      'ISA' => /^isa/,
+      'JER' => /^jer/,
+      'LAM' => /^lam/,
+      'EZK' => /^ez/,
+      'DAN' => /^dan/,
+      'HOS' => /^hos/,
+      'JOL' => /^joel/,
+      'AMO' => /^amo/,
+      'OBA' => /^ob/,
+      'JON' => /^jona/,
+      'MIC' => /^mi/,
+      'NAM' => /^nah/,
+      'HAB' => /^hab/,
+      'ZEP' => /^zep/,
+      'HAG' => /^hag/,
+      'ZEC' => /^zec/,
+      'MAL' => /^mal/,
+      'TOB' => /^tob/,
+      'JDT' => /^jud/,
+      'ESG' => /^est.*greek/,
+      'WIS' => /^wisdom/,
+      'SIR' => /^sir/,
+      'BAR' => /^bar/,
+      'LJE' => /^jeremy/,
+      'S3Y' => /^3 holy/,
+      'SUS' => /^sus/,
+      'BEL' => /^bel/,
+      '1MA' => /^1 mac/,
+      '2MA' => /^2 mac/,
+      '1ES' => /^1 esd/,
+      'MAN' => /^prayer/,
+      'PS2' => /^psalm 151/,
+      '3MA' => /^3 mac/,
+      '2ES' => /^2 esd/,
+      '4MA' => /^4 mac/,
+      'MAT' => /^mat/,
+      'MRK' => /^ma?rk/,
+      'LUK' => /^lu?k/,
+      'JHN' => /^john|^jn/,
+      'ACT' => /^act/,
+      'ROM' => /^rom/,
+      '1CO' => /^1 cor/,
+      '2CO' => /^2 cor/,
+      'GAL' => /^gal/,
+      'EPH' => /^eph/,
+      'PHP' => /^phil/,
+      'COL' => /^col/,
+      '1TH' => /^1 the?s/,
+      '2TH' => /^2 the?s/,
+      '1TI' => /^1 tim/,
+      '2TI' => /^2 tim/,
+      'TIT' => /^tit/,
+      'PHM' => /^phi?l/,
+      'HEB' => /^heb/,
+      'JAS' => /^jam/,
+      '1PE' => /^1 pet/,
+      '2PE' => /^2 pet/,
+      '1JN' => /^1 jo?h?n/,
+      '2JN' => /^2 jo?h?n/,
+      '3JN' => /^3 jo?h?n/,
+      'JUD' => /^jud/,
+      'REV' => /^re?v/
+    }
+
+    def initialize(book, canon=:protestant)
+      @canon = canon
+      unless CANONS[@canon]
+        raise UnknownCanon.new("#{canon} is not known. Canons this library support are: #{CANONS.join(', ')}")
+      end
+      @book = book
+    end
+
+    def id
+      CANONS[@canon].each do |book|
+        match = BOOKS[book]
+        return book if @book.downcase =~ match
+      end
+      nil
+    end
+
+  end
+end

data/lib/bible_ref/parser.rb

@@ -0,0 +1,39 @@
+require 'parslet'
+
+module BibleRef
+  class Parser < Parslet::Parser
+    rule(:refs) do
+      (
+        (ref_range | ref) >>
+        (
+          separator >>
+          (ref_range | verse_range | ref | verse)
+        ).repeat
+      ).as(:refs)
+    end
+
+    rule(:ref_range)   { (ref.as(:from) >> str("-") >> (ref | verse).as(:to)).as(:range) }
+    rule(:verse_range) { (verse.as(:from) >> str("-") >> verse.as(:to)).as(:range) }
+
+    rule(:ref)         { (chapter >> str(":") >> verse) }
+
+    rule(:chapters)    { (chapter >> (match("[-,]") >> chapter).repeat).as(:refs) }
+    rule(:chapter)     { num.as(:chapter) }
+    rule(:verse)       { num.as(:verse) }
+
+    rule(:word)        { (match("[0-9]").maybe >> match("[A-Za-z ]").repeat(1)).as(:word) }
+    rule(:separator)   { (str(",") >> space.maybe) | (space.maybe >> str("&") >> space.maybe) }
+    rule(:num)         { match("[0-9]").repeat(1).as(:num) }
+    rule(:space)       { str(" ").repeat(1) }
+
+    rule(:reference)   { word.as(:book) >> space.maybe >> (refs | chapters) }
+
+    root(:reference)
+  end
+
+  class ParserTransform < Parslet::Transform
+    rule(word: simple(:w)) { w.to_s.strip }
+
+    rule(num: simple(:n)) { n.to_i }
+  end
+end

data/lib/bible_ref/reference.rb

@@ -0,0 +1,61 @@
+require_relative './book'
+require_relative './parser'
+
+module BibleRef
+  class Reference
+
+    attr_reader :book
+    attr_reader :reference
+
+    def initialize(reference)
+      @reference = reference
+      @details = parse
+    end
+
+    def ranges
+      return nil unless valid?
+      @chapter = nil
+      [@details[:refs]].flatten.map do |ref|
+        normalize_range(ref) || normalize_ref(ref)
+      end
+    end
+
+    def book
+      @book ||= Book.new(@details[:book]).id
+    end
+
+    def valid?
+      @details and book
+    end
+
+    private
+
+    def parse
+      begin
+        parsed = Parser.new.parse(@reference)
+      rescue Parslet::ParseFailed
+        nil
+      else
+        ParserTransform.new.apply(parsed)
+      end
+    end
+
+    def normalize_range(ref)
+      return unless range = ref[:range]
+      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])
+      ]
+    end
+
+    def normalize_ref(ref)
+      @chapter = ref[:chapter] if ref[:chapter]
+      (1..2).map do
+        { book: @book, chapter: @chapter }.merge(ref)
+      end
+    end
+
+  end
+end

data/lib/bible_ref/version.rb

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

data/lib/bible_ref.rb

@@ -0,0 +1 @@
+require_relative 'bible_ref/reference'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: bible_ref
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Bible reference parser returns normalized sets of ranges, ideal for querying
+  a database or XML data source such as WEB in USFX.
+email: tim@timmorgan.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/bible_ref.rb
+- lib/bible_ref/book.rb
+- lib/bible_ref/parser.rb
+- lib/bible_ref/reference.rb
+- lib/bible_ref/version.rb
+homepage: https://github.com/seven1m/bible_ref
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Bible reference parser
+test_files: []