bible_reference_parser 0.1.1

data/spec/shared/it_tracks_errors_shared.rb

@@ -0,0 +1,90 @@
+# Shared examples for classes including the TracksErrors module
+
+module ItTracksErrors  
+  shared_examples_for "it tracks errors" do |new_instance|          
+    before :each do
+      new_instance.clear_errors
+    end
+    
+    describe "initialization" do                   
+      it "should set the errors attribute to a kind of array" do
+        new_instance.errors.should be_kind_of Array
+      end
+       
+      it "should set the errors attribute to empty" do
+        new_instance.errors.should be_empty
+      end                                                      
+    end
+    
+    describe "The 'add_error' method" do
+      it "should add an error message to the errors collection" do
+        new_instance.add_error "invalid"
+        new_instance.errors.length.should eql 1
+        new_instance.errors.first.should eql "invalid"
+      end
+    end
+    
+    describe "the 'clear_errors?' method" do
+      it "should erase all errors" do
+        new_instance.add_error "invalid"
+        new_instance.clear_errors
+        new_instance.errors.should be_empty
+      end
+    end
+    
+    describe "the 'has_errors?' method" do
+      it "should return whether there are any error messages" do
+        new_instance.has_errors?.should be_false
+        new_instance.add_error "invalid"
+        new_instance.has_errors?.should be_true
+      end
+    end
+     
+    describe "the 'no_errors?' method" do      
+      it "should return whether there are any error messages" do
+        new_instance.no_errors?.should be_true
+        new_instance.add_error "invalid"
+        new_instance.no_errors?.should be_false
+      end                
+    end
+    
+    describe "the 'errors' method" do
+      before :each do        
+        @allows_children = new_instance.respond_to?("children") && new_instance.children
+        new_instance.children.clear_errors if @allows_children
+      end
+      
+      it "should not include child errors if include_child_errors is false" do
+        new_instance.add_error "invalid"
+        new_instance.children.add_error "invalid_child" if @allows_children
+        
+        errors = new_instance.errors(false)
+        errors.count.should eql 1
+        errors.first.should eql "invalid"
+      end
+           
+      it "should include child errors if include_child_errors is true" do
+        new_instance.add_error "invalid"
+        new_instance.children.add_error "invalid_child" if @allows_children
+        
+        errors = new_instance.errors(true)
+        count = @allows_children ? 2 : 1
+        errors.count.should eql count
+        errors.first.should eql "invalid"
+        errors.last.should eql "invalid_child" if @allows_children               
+      end
+ 
+      it "should include child errors if include_child_errors isn't specified" do
+        new_instance.add_error "invalid"
+        new_instance.children.add_error "invalid_child" if @allows_children
+        
+        errors = new_instance.errors(true)
+        count = @allows_children ? 2 : 1
+        errors.count.should eql count
+        errors.first.should eql "invalid"
+        errors.last.should eql "invalid_child" if @allows_children
+      end
+    end
+    
+  end     
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+SimpleCov.start do
+  SimpleCov.root File.expand_path('../../', __FILE__)
+  add_filter "/spec"
+end
+
+require 'rubygems'
+require 'test/unit'
+require 'rspec'      
+require 'bible_reference_parser'
+
+# Load shared example modules 
+Dir["#{File.dirname(__FILE__)}/shared/*.rb"].each {|f| require f}

data/spec/verse_reference_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+
+include BibleReferenceParser
+
+describe VerseReference do
+  
+  it_should_behave_like "it tracks errors", VerseReference.new(1), VerseReference.new(0)
+  
+  describe "initialization" do
+    context "for a valid verse" do
+      it "should convert a string verse number to an integer" do
+        verse = VerseReference.new "10"
+        verse.number.should eql 10      
+      end
+      
+      it "should set the number field" do
+        verse = VerseReference.new 1
+        verse.number.should eql 1
+      end           
+    end
+    
+    context "for an invalid verse" do
+      it "should add an error for a number less than 0" do
+        verse = VerseReference.new -1
+        verse.errors.first.should eql "The verse number '-1' is not valid"
+      end
+
+      it "should add an error for a number equal to 0" do
+        verse = VerseReference.new 0
+        verse.errors.first.should eql "The verse number '0' is not valid"      
+      end
+      
+      it "should add an error if the verse is not valid for a book/chapter" do
+        verse = VerseReference.new 18, BibleMetadata["Matthew"], 3
+        verse.errors.first.should eql "The verse '18' does not exist for Matthew 3"
+      end
+      
+      it "should not set the number field" do
+        verse = VerseReference.new 0
+        verse.number.should be_nil        
+      end     
+    end
+  end
+  
+  describe "the valid_reference? method" do
+    it "should return true if the verse number is valid" do
+      verse = VerseReference.new 1
+      verse.should be_valid_reference
+    end
+    
+    it "should return false if the verse is invalid" do
+      verse = VerseReference.new 0
+      verse.should_not be_valid_reference
+    end
+  end
+  
+  describe "when parsing the verses in a string" do
+   
+    describe "the parse_verses method" do
+      it "should parse single verses" do
+        verses = VerseReference.parse_verses "1, 2,3"
+        verses.length.should eql 3
+        verses[0].number.should eql 1
+        verses[1].number.should eql 2
+        verses[2].number.should eql 3        
+      end
+      
+      it "should parse single verses that has semi-colons instead of commas" do
+        verses = VerseReference.parse_verses "1;2; 3"
+        verses.length.should eql 3
+        verses[0].number.should eql 1
+        verses[1].number.should eql 2
+        verses[2].number.should eql 3
+      end
+      
+      it "should parse a range of verses" do
+        verses = VerseReference.parse_verses "1-5"
+        verses.length.should eql 5
+        verses[0].number.should eql 1
+        verses[1].number.should eql 2
+        verses[2].number.should eql 3
+        verses[3].number.should eql 4
+        verses[4].number.should eql 5      
+      end
+      
+      it "should parse a combination of ranges and single verses" do
+        verses = VerseReference.parse_verses "1, 2, 5-7 ;9,  11, 15-17"
+        verses.length.should eql 10
+        verses[0].number.should eql 1
+        verses[1].number.should eql 2
+        verses[2].number.should eql 5
+        verses[3].number.should eql 6
+        verses[4].number.should eql 7
+        verses[5].number.should eql 9
+        verses[6].number.should eql 11
+        verses[7].number.should eql 15
+        verses[8].number.should eql 16
+        verses[9].number.should eql 17    
+      end
+      
+      it "should parse a string beginning and ending with a range" do
+        verses = VerseReference.parse_verses "1-3, 5, 7-8"
+        verses.length.should eql 6
+        verses[0].number.should eql 1
+        verses[1].number.should eql 2
+        verses[2].number.should eql 3
+        verses[3].number.should eql 5
+        verses[4].number.should eql 7
+        verses[5].number.should eql 8
+      end
+      
+      it "should parse a string beginning and ending with a single verse" do
+        verses = VerseReference.parse_verses "1, 3-4, 7"
+        verses.length.should eql 4
+        verses[0].number.should eql 1
+        verses[1].number.should eql 3
+        verses[2].number.should eql 4
+        verses[3].number.should eql 7        
+      end
+      
+      it "should parse a range that has the same beginning and end" do
+        verses = VerseReference.parse_verses "1, 7-7"
+        verses.length.should eql 2
+        verses[0].number.should eql 1
+        verses[1].number.should eql 7
+      end
+    end
+    
+    describe "the parse_verses_in_reference method" do
+      before :each do
+        @chapter = ChapterReference.new "1", "1, 3-5"
+        @verses = VerseReference.parse_verses_in_reference @chapter      
+      end
+
+      it "should parse the right raw_content" do
+        @verses.first.number.should eql 1
+        @verses.last.number.should eql 5
+      end
+
+      it "should assume all verses for a chapter with nil raw_content and chapter metadata isn't nil" do
+        chapter = ChapterReference.new 1, nil, BibleMetadata["Matthew"]
+        verses = VerseReference.parse_verses_in_reference chapter
+        verses.length.should eql 25                
+      end
+      
+      it "should assume just the first verse for a chapter with nil raw_content and chapter metadata is nil" do
+        chapter = ChapterReference.new 1, nil
+        verses = VerseReference.parse_verses_in_reference chapter
+        verses.length.should eql 1        
+      end
+    end
+    
+    describe "each returned verse" do
+      it "should correctly set the number attribute" do
+        verses = VerseReference.parse_verses "1-3"
+        verses.first.number.should eql 1
+      end
+    end
+    
+    describe "the returned value" do
+      it "should be a reference collection" do
+        verses = VerseReference.parse_verses("1-10, 15")
+        verses.should be_kind_of ReferenceCollection
+      end
+      
+      it "should only contain VerseReference objects" do
+        verses = VerseReference.parse_verses("1-10, 15")
+        verses.each do |verse|
+          verse.should be_kind_of VerseReference
+        end
+      end
+    end
+      
+  end
+
+  describe "the 'clean' method" do
+    it "should return an empty array" do
+      verse = VerseReference.new 1
+      verse.clean.should eql []
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: bible_reference_parser
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Nathan McWilliams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 19
+        version: 2.0.0.beta.19
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 2
+        version: 0.3.2
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: BibleReferenceParser can parse scriptures passages, such as 'Gen. 1:15-18, 21' to the individual books, chapters and verses in the passage. It also provides validation for invalid book names, chapters, and verses.
+email: nathan.mcwilliams@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- bible_reference_parser.gemspec
+- lib/bible_reference_parser.rb
+- lib/bible_reference_parser/metadata/bible_metadata.rb
+- lib/bible_reference_parser/metadata/metadata.yml
+- lib/bible_reference_parser/parser.rb
+- lib/bible_reference_parser/reference/behavior/tracks_errors.rb
+- lib/bible_reference_parser/reference/book_reference.rb
+- lib/bible_reference_parser/reference/chapter_reference.rb
+- lib/bible_reference_parser/reference/reference_collection.rb
+- lib/bible_reference_parser/reference/verse_reference.rb
+- spec/bible_metadata_spec.rb
+- spec/book_reference_spec.rb
+- spec/chapter_reference_spec.rb
+- spec/parser_spec.rb
+- spec/reference_collection_spec.rb
+- spec/shared/it_tracks_errors_shared.rb
+- spec/spec_helper.rb
+- spec/verse_reference_spec.rb
+has_rdoc: true
+homepage: http://github.com/endium/bible_reference_parser
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 4012488893589496210
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Parsing and validation for scripture passages.
+test_files: 
+- spec/bible_metadata_spec.rb
+- spec/book_reference_spec.rb
+- spec/chapter_reference_spec.rb
+- spec/parser_spec.rb
+- spec/reference_collection_spec.rb
+- spec/shared/it_tracks_errors_shared.rb
+- spec/spec_helper.rb
+- spec/verse_reference_spec.rb