bible_passage 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf622f06c1242c67eb2a34b5b929088b01586962
-  data.tar.gz: 4de690f1b893d68634dea13519dfd0e6ba1af922
+  metadata.gz: 951cee3c9b5418a1f865574e2d5418a7f05c91ba
+  data.tar.gz: 20ecf5a12df90d42d8f0e6a331b15cc2826c990e
 SHA512:
-  metadata.gz: 82873b7450db0f14a4ef53f4e50aca713aa862dfc180db355cdc17e0a53dc53717b534c8a543124fb41d67c2e6f3980a2166f74ce1783a3528497aa00d5cfded
-  data.tar.gz: b5b91cdfd1f165ecfab92d120c9982ef8128deabb673c31951de5eca99590f1fb9d0d527ff18bcdfff10c8a9bad982f566a422418ef8279587c0ffba3fbaf717
+  metadata.gz: a1acfc1b1023053dd8694229b80f3751ab7bdb7442abef06ea604428f08b770efc70cc04c742d5d2c1320201b1583040d43fd56333dda70cc68abf7cacd72d09
+  data.tar.gz: 50c1014d263df724b2163d1b1d8fc3656f69508baf53fd744ef3840ec41369c1b8447a925afda782cddee0fde4898c0665a84a25c104bd0e5fa997305564b629

data/bible_passage.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'bible_passage'
   s.summary     = 'A simple library for parsing and rendering bible passages'
-  s.version     = '0.1.1'
+  s.version     = '0.2.0'
   s.authors     = ["Si Wilkins"]
   s.email       = 'si.wilkins@gmail.com'
   s.homepage    = 'https://github.com/siwilkins/bible_passage'

data/lib/bible_passage/book_key_translator.rb

@@ -331,9 +331,13 @@ module BiblePassage
       revelation: :rev,
     }
 
-    def keyify(book_name)
-      TRANSLATIONS[normalize_input(book_name)] ||
+    def keyify(book_name, raise_errors = true)
+      translation = TRANSLATIONS[normalize_input(book_name)]
+      if translation
+        return translation
+      elsif raise_errors
         raise(InvalidReferenceError.new("#{book_name} is not a valid book"))
+      end
     end
 
     private

data/lib/bible_passage/invalid_reference.rb

@@ -0,0 +1,13 @@
+class BiblePassage::InvalidReference < BiblePassage::Reference
+
+  attr_reader :error
+
+  def initialize(message)
+    @error = message
+  end
+
+  def valid?
+    false
+  end
+
+end

data/lib/bible_passage/reference.rb

@@ -2,6 +2,8 @@ module BiblePassage
 
   class Reference
 
+    attr_reader :error
+
     class << self
 
       # Parsing methods are currently very complex and long.
@@ -10,11 +12,19 @@ module BiblePassage
       ##
       # The main method used for parsing passage strings
       def parse(passage, options = {})
+        options = {raise_errors: true}.merge(options)
         translator = options.delete(:translator) || BookKeyTranslator.new
         data_store = options[:data_store] ||= BookDataStore.new
         match = match_passage_format(passage)
-        raise InvalidReferenceError.new("#{passage} is not a valid reference") if !match
-        book_key = translator.keyify(match[1])
+        if !match
+          message = "#{passage} is not a valid reference"
+          if options[:raise_errors]
+            raise InvalidReferenceError.new(message)
+          else
+            return InvalidReference.new(message)
+          end
+        end
+        book_key = translator.keyify(match[1], options[:raise_errors]) || (return InvalidReference.new("#{match[1]} is not a valid book"))
         if data_store.number_of_chapters(book_key) == 1
           ref = process_single_chapter_match(book_key, match, options)
         else
@@ -63,6 +73,7 @@ module BiblePassage
       end
 
       private
+
       def match_passage_format(passage)
         passage.match(/^\s*(\d?\s*[A-Za-z\s]+)\s*(\d+)?:?(\d+)?\s*-?\s*(\d+)?:?(\d+)?\s*(,.+)?/)
       end
@@ -99,7 +110,11 @@ module BiblePassage
         if match[0] =~ /:/
           book_name = options[:data_store].book_name(book_key)
           msg = "#{book_name} doesn't have any chapters"
-          raise InvalidReferenceError.new(msg)
+          if options[:raise_errors]
+            raise InvalidReferenceError.new(msg)
+          else
+            return InvalidReference.new(msg)
+          end
         end
         new(book_key, nil, from_verse, nil, to_verse, options)
       end
@@ -112,6 +127,7 @@ module BiblePassage
 
     def initialize(book_key, from_chapter = nil, from_verse = nil, 
                    to_chapter = nil, to_verse = nil, options = {})
+      @raise_errors = options.has_key?(:raise_errors) ? options[:raise_errors] : true
       @data_store = options[:data_store] || BookDataStore.new
       self.book_key = book_key
       self.from_chapter = int_param(from_chapter)
@@ -135,9 +151,10 @@ module BiblePassage
 
     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)
+        if val < 1 || val > @data_store.number_of_chapters(book_key)
+          @error = "#{book} doesn't have a chapter #{val}"
+          raise InvalidReferenceError.new(@error) if @raise_errors
+        end
         @inherit_book_key = true
         @from_chapter = val
       end
@@ -148,10 +165,11 @@ module BiblePassage
     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)
+      if val && valid?
+        if val > @data_store.number_of_verses(book_key, from_chapter) || val < 1
+          @error = "#{book} #{from_chapter} doesn't have a verse #{val}"
+          raise InvalidReferenceError.new(@error) if @raise_errors
+        end
         @inherit_chapter = true
         @from_verse = val
       end
@@ -163,11 +181,14 @@ module BiblePassage
 
     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)
+        if val < from_chapter
+          @error = "to_chapter cannot be before from_chapter"
+          raise InvalidReferenceError.new(@error) if @raise_errors
+        end
+        if val > @data_store.number_of_chapters(book_key)
+          @error = "#{book} doesn't have a chapter #{val}"
+          raise InvalidReferenceError.new(@error) if @raise_errors
+        end
         @to_chapter = val
       end
     end
@@ -177,13 +198,15 @@ module BiblePassage
     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)
+      if val && valid?
+        if val < from_verse && single_chapter_passage?
+          @error = "to_verse cannot be before from_verse"
+          raise InvalidReferenceError.new(@error) if @raise_errors
+        end
+        if val > @data_store.number_of_verses(book_key, to_chapter)
+          @error = "#{book} #{to_chapter} doesn't have a verse #{val}"
+          raise InvalidReferenceError.new(@error) if @raise_errors
+        end
         @to_verse = val
       end
     end
@@ -230,6 +253,10 @@ module BiblePassage
       out
     end
 
+    def valid?
+      @error.nil?
+    end
+
     private
     def from_part
       out = ''

data/lib/bible_passage.rb

@@ -2,4 +2,4 @@ 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'
-
+require_relative 'bible_passage/invalid_reference'

data/spec/bible_passage/invalid_reference_spec.rb

@@ -0,0 +1,19 @@
+require_relative '../spec_helper'
+
+describe BiblePassage::InvalidReference do
+
+  let(:reference) { BiblePassage::InvalidReference.new("An error") }
+
+  it "is a Reference" do
+    expect(reference.is_a?(BiblePassage::Reference)).to eq(true)
+  end
+
+  it "is invalid" do
+    expect(reference.valid?).to eq(false)
+  end
+
+  it "returns the supplied message" do
+    expect(reference.error).to eq("An error")
+  end
+
+end

data/spec/bible_passage/reference_spec.rb

@@ -40,13 +40,13 @@ describe BiblePassage::Reference do
     context "book_key" do
 
       it "returns a book_key" do
-        allow(translator).to receive(:keyify).with("book name").
+        allow(translator).to receive(:keyify).with("book name", true).
           and_return :gen
         expect(reference.book_key).to eq(:gen)
       end
 
       it "returns another book_key" do
-        allow(translator).to receive(:keyify).with("book name").
+        allow(translator).to receive(:keyify).with("book name", true).
           and_return :ex
         expect(reference.book_key).to eq(:ex)
       end
@@ -300,40 +300,76 @@ describe BiblePassage::Reference do
           BiblePassage::InvalidReferenceError, "Genosis is not a valid book")
       end
 
+      it "returns an invalid reference when non-existent book and false are passed in for raise_errors" do
+        expect(BiblePassage::Reference.parse("Genosis", raise_errors: false).valid?).to eq(false)
+      end
+
+      it "returns valid? false when non-existent book and raise_errors:false are passed in" do
+        expect(BiblePassage::Reference.parse("Genosis", raise_errors: false).valid?).to eq(false)
+      end
+
     end
 
     context "new" do
 
       def self.it_errors(msg, book_key, from_chapter, from_verse, to_chapter,
                          to_verse, error_msg)
-        it msg do
+        it "errors #{msg}" do
           expect { BiblePassage::Reference.new(book_key, from_chapter, 
             from_verse, to_chapter, to_verse) }.
             to raise_error(BiblePassage::InvalidReferenceError, error_msg)
         end
       end
 
+      def self.it_returns_invalid_reference(msg, book_key, from_chapter, from_verse, to_chapter, to_verse, error_msg)
+        it "returns an invalid reference #{msg}" do
+          ref = BiblePassage::Reference.new(book_key, from_chapter, from_verse, to_chapter, to_verse, raise_errors: false)
+          expect(ref.valid?).to eq(false)
+          expect(ref.error).to eq(error_msg)
+        end
+      end
+
       it_errors "when from_chapter is less than 1", :gen, 0, nil, nil, nil,
                 "Genesis doesn't have a chapter 0"
+      
+      it_returns_invalid_reference "when from_chapter is less than 1", :gen, 0, 1, 1, 1, "Genesis doesn't have a chapter 0"
 
       it_errors "when from_chapter is greater than number of chapters in book",
         :gen, 51, nil, nil, nil, "Genesis doesn't have a chapter 51"
 
+      it_returns_invalid_reference  "when from_chapter is greater than number of chapters in book",
+        :gen, 51, 1, 51, 1, "Genesis doesn't have a chapter 51"
+
       it_errors "when from_verse is less than 1", :gen, 1, 0, nil, nil,
         "Genesis 1 doesn't have a verse 0"
 
+      it_returns_invalid_reference "when from_verse is less than 1", :gen, 1, 0, 1, 1,
+        "Genesis 1 doesn't have a verse 0"
+
       it_errors "when from_verse is greater than number of verses in chapter",
         :gen, 1, 32, nil, nil, "Genesis 1 doesn't have a verse 32"
 
+      it_returns_invalid_reference "when from_verse is greater than number of verses in chapter",
+        :gen, 1, 32, 1, 32, "Genesis 1 doesn't have a verse 32"
+
       it_errors "when to_chapter is less than from_chapter", :gen, 2, nil, 1,
         nil, "to_chapter cannot be before from_chapter"
 
+      it_returns_invalid_reference "when to_chapter is less than from_chapter", :gen, 2, 1, 1,
+        1, "to_chapter cannot be before from_chapter"
+
       it_errors "when to_chapter is greater than number of chapters is book",
         :gen, 2, nil, 51, nil, "Genesis doesn't have a chapter 51"
 
+      it_returns_invalid_reference "when to_chapter is greater than number of chapters is book",
+        :gen, 2, 1, 51, 1, "Genesis doesn't have a chapter 51"
+
       it_errors "when to_verse is less than from_verse and in same chapter",
         :gen, 2, 2, 2, 1, "to_verse cannot be before from_verse"
 
+      it_returns_invalid_reference "when to_verse is less than from_verse and in same chapter",
+        :gen, 2, 2, 2, 1, "to_verse cannot be before from_verse"
+
       it "doesn't error when to_verse is less than from_verse but spans 
         chapters" do
         expect { BiblePassage::Reference.new(:gen, 2, 2, 3, 1) }.
@@ -343,6 +379,9 @@ describe BiblePassage::Reference do
       it_errors "when to_verse is greater than number of verses in chapter",
         :gen, 1, 1, 1, 32, "Genesis 1 doesn't have a verse 32"
 
+      it_returns_invalid_reference "when to_verse is greater than number of verses in chapter",
+        :gen, 1, 1, 1, 32, "Genesis 1 doesn't have a verse 32"
+
       it "errors when a chapter is supplied to .parse for a single-chapter
         book" do
         expect { BiblePassage::Reference.parse("Jude 2:3-4") }.to raise_error(
@@ -350,11 +389,23 @@ describe BiblePassage::Reference do
           "Jude doesn't have any chapters")
       end
 
+      it "returns an invalid reference when a chapter and parse_errors: false are supplied to .parse for a single-chapter book" do
+        expect(BiblePassage::Reference.parse("Jude 2:3-4", raise_errors: false).valid?).to eq(false)
+      end
+
       it "errors when no book is supplied to parse" do
         expect { BiblePassage::Reference.parse('2') }.to raise_error(
           BiblePassage::InvalidReferenceError, "2 is not a valid reference")
       end
 
+      it "returns an invalid reference when no book and raise_errors: false is supplied to parse" do
+        expect(BiblePassage::Reference.parse('2', raise_errors: false).valid?).to eq(false)
+      end
+
+      it "returns true for valid? when it is valid" do
+        expect(BiblePassage::Reference.new(:gen, 1, 1).valid?).to eq(true)
+      end
+
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bible_passage
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Si Wilkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2014-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -83,10 +83,12 @@ files:
 - lib/bible_passage.rb
 - lib/bible_passage/book_data_store.rb
 - lib/bible_passage/book_key_translator.rb
+- lib/bible_passage/invalid_reference.rb
 - lib/bible_passage/invalid_reference_error.rb
 - lib/bible_passage/reference.rb
 - spec/bible_passage/book_data_store_spec.rb
 - spec/bible_passage/book_key_translator_spec.rb
+- spec/bible_passage/invalid_reference_spec.rb
 - spec/bible_passage/reference_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/siwilkins/bible_passage