scriptura 0.0.2 → 0.0.3

data/lib/scriptura/scripture.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module Scriptura
   module Scripture
     def self.old_testament_books
@@ -23,5 +25,15 @@ module Scriptura
     def self.book_names
       books.map(&:name)
     end
+
+    def self.metadata
+      @metadata ||= begin
+        YAML.load_file('lib/scriptura/metadata.yml')
+      end
+    end
+
+    def self.find_book_hash attribute, value
+      metadata.values.find { |book| book[attribute.to_s] == value }
+    end
   end
 end

data/lib/scriptura/scripture_book.rb

@@ -1,21 +1,26 @@
+require 'scriptura/scripture'
+
 module Scriptura
   class ScriptureBook
+    attr_reader :book_number
+    alias_method :number, :book_number
+
     def initialize(number)
-      raise ArgumentError, 'book number cannot be converted to an integer' unless number.respond_to?(:to_i)
-      raise 'book number should be within 1-66' unless (1..66).cover?(number.to_i)
-      @number = number.to_i
+      fail ArgumentError, 'book number cannot be converted to an integer' unless number.respond_to?(:to_i)
+      fail DoesNotExist, 'Book number should be within 1-66' unless (1..66).cover?(number.to_i)
+      @book_number = number.to_i
     end
 
-    def self.find_by_name name
-      hash = METADATA.find{|book| book['name'] == name}
-      raise "Book by the name #{name} was not found! Check if there was a spelling error.. or try initializing it with a book number" if hash.nil?
-      self.new(hash['number'])
+    def self.find_by_name(name)
+      hash = Scripture.find_book_hash(:name, name)
+      fail "Book by the name #{name} was not found! Check if there was a spelling error.. or try initializing it with a book number" if hash.nil?
+      new(hash['number'])
     end
 
-    def self.find string_id
-      hash = METADATA.find{|book| book['string_id'] == string_id}
-      raise "Book by the string_id #{string_id} was not found! Check if there was a spelling error.. or try initializing it with a book number" if hash.nil?
-      self.new(hash['number'])
+    def self.find(string_id)
+      hash = Scripture.find_book_hash(:string_id, string_id)
+      fail "Book by the string_id #{string_id} was not found! Check if there was a spelling error.. or try initializing it with a book number" if hash.nil?
+      new(hash['number'])
     end
 
     def name
@@ -30,16 +35,12 @@ module Scriptura
       book_hash['chapters'].count
     end
 
-    def number
-      book_hash['number']
-    end
-
     def first_chapter
-      @first_chapter ||= ScriptureChapter.new(self.number, 1)
+      @first_chapter ||= ScriptureChapter.new(number, 1)
     end
 
     def last_chapter
-      @last_chapter ||= ScriptureChapter.new(self.number, self.number_of_chapters)
+      @last_chapter ||= ScriptureChapter.new(number, number_of_chapters)
     end
 
     def first_chapter_number
@@ -57,11 +58,22 @@ module Scriptura
     def string_id
       book_hash['string_id']
     end
-    
+
+    def to_s
+      name
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ScriptureBook)
+      book_number == other.book_number
+    end
+
     private
 
     def book_hash
-      @book_hash ||= METADATA.find{|book| book['number'] == @number.to_i}
+      @book_hash ||= Scripture.metadata[@book_number.to_i]
     end
+
+    class DoesNotExist < StandardError; end
   end
 end

data/lib/scriptura/scripture_chapter.rb

@@ -1,17 +1,17 @@
+require 'scriptura/scripture_book'
+
 module Scriptura
   class ScriptureChapter
-    attr_accessor :scripture_book
+    attr_reader :scripture_book
+    attr_reader :chapter_number
+    alias_method :number, :chapter_number
 
-    def initialize book_number, chapter_number
+    def initialize(book_number, chapter_number)
       @scripture_book = ScriptureBook.new(book_number)
-      raise ArgumentError, 'chapter number cannot be converted to an integer' unless chapter_number.respond_to?(:to_i)
-      raise 'book number should be within 1-66' unless (1..66).cover?(book_number.to_i)
-      @number = chapter_number.to_i
-      raise 'chapter does not exist' if chapter_hash.nil?
-    end
-
-    def number
-      chapter_hash['number']
+      fail ArgumentError, 'chapter number cannot be converted to an integer' unless chapter_number.respond_to?(:to_i)
+      fail 'book number should be within 1-66' unless (1..66).cover?(book_number.to_i)
+      @chapter_number = chapter_number.to_i
+      fail DoesNotExist, 'chapter does not exist' if chapter_hash.nil?
     end
 
     def number_of_verses
@@ -19,11 +19,11 @@ module Scriptura
     end
 
     def first_verse
-      @first_verse = ScriptureVerse.new(scripture_book.number, self.number, 1)
+      @first_verse = ScriptureVerse.new(scripture_book.number, number, 1)
     end
 
     def last_verse
-      @first_verse = ScriptureVerse.new(scripture_book.number, self.number, self.number_of_verses)
+      @first_verse = ScriptureVerse.new(scripture_book.number, number, number_of_verses)
     end
 
     def first_verse_number
@@ -34,10 +34,22 @@ module Scriptura
       last_verse.number
     end
 
+    def to_s
+      "#{scripture_book} #{@chapter_number}"
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ScriptureChapter)
+      scripture_book == other.scripture_book &&
+        chapter_number == other.chapter_number
+    end
+
     private
 
     def chapter_hash
-      @chapter_hash ||= @scripture_book.to_hash['chapters'].find{|chapter| chapter['number'] == @number.to_i}
+      @chapter_hash ||= @scripture_book.to_hash['chapters'][@chapter_number.to_i]
     end
+
+    class DoesNotExist < StandardError; end
   end
 end

data/lib/scriptura/scripture_reference.rb

@@ -1,55 +1,53 @@
+require 'scriptura/scripture_verse'
+
 module Scriptura
   class ScriptureReference
-    attr_accessor :start_verse
-    attr_accessor :end_verse
+    attr_reader :start_verse
+    attr_reader :end_verse
 
-    def initialize start_verse, end_verse
+    def initialize(start_verse, end_verse)
       @start_verse = start_verse
       @end_verse = end_verse
     end
 
     def within_same_book?
-      start_verse.scripture_book.number == end_verse.scripture_book.number
+      start_verse.scripture_book == end_verse.scripture_book
     end
 
     def within_same_chapter?
-      within_same_book? && 
-      start_verse.scripture_chapter.number == end_verse.scripture_chapter.number
+      start_verse.scripture_chapter == end_verse.scripture_chapter
     end
-    
+
     def spans_entire_book?
-      within_same_book? && 
-      start_verse.scripture_chapter.number == start_verse.scripture_book.first_chapter.number && 
-      start_verse.number == start_verse.scripture_chapter.first_verse.number &&
-      end_verse.scripture_chapter.number == end_verse.scripture_book.last_chapter.number && 
-      end_verse.number == end_verse.scripture_chapter.last_verse.number
+      scripture_book = start_verse.scripture_book
+      start_verse == scripture_book.first_chapter.first_verse &&
+        end_verse == scripture_book.last_chapter.last_verse
     end
 
     def spans_entire_chapter?
-      within_same_chapter? && 
-      start_verse.number == start_verse.scripture_chapter.first_verse.number &&
-      end_verse.number == end_verse.scripture_chapter.last_verse.number 
+      scripture_chapter = start_verse.scripture_chapter
+      start_verse == scripture_chapter.first_verse &&
+        end_verse == scripture_chapter.last_verse
     end
 
     def spans_single_verse?
-      within_same_chapter? &&
-      start_verse.number == end_verse.number
+      start_verse == end_verse
     end
 
     def to_s
-      case 
-      when self.spans_entire_book?
-        start_verse.scripture_book.name
-      when self.spans_entire_chapter?
-        "#{start_verse.scripture_book.name} #{start_verse.scripture_chapter.number}"
-      when self.spans_single_verse?
-        "#{start_verse.scripture_book.name} #{start_verse.scripture_chapter.number}:#{start_verse.number}"
+      case
+      when spans_entire_book?
+        start_verse.scripture_book.to_s
+      when spans_entire_chapter?
+        start_verse.scripture_chapter.to_s
+      when spans_single_verse?
+        start_verse.to_s
       when within_same_chapter?
-        "#{start_verse.scripture_book.name} #{start_verse.scripture_chapter.number}:#{start_verse.number}-#{end_verse.number}"
+        "#{start_verse}-#{end_verse.number}"
       when within_same_book?
-        "#{start_verse.scripture_book.name} #{start_verse.scripture_chapter.number}:#{start_verse.number} - #{end_verse.scripture_chapter.number}:#{end_verse.number}"
+        "#{start_verse} - #{end_verse.scripture_chapter.number}:#{end_verse.number}"
       else
-        "#{start_verse.scripture_book.name} #{start_verse.scripture_chapter.number}:#{start_verse.number} - #{end_verse.scripture_book.name} #{end_verse.scripture_chapter.number}:#{end_verse.number}"
+        "#{start_verse} - #{end_verse}"
       end
     end
   end

data/lib/scriptura/scripture_verse.rb

@@ -1,37 +1,50 @@
+require 'scriptura/scripture_chapter'
+
 module Scriptura
   class ScriptureVerse
-    attr_accessor :scripture_chapter
-    attr_accessor :number
+    attr_reader :scripture_book
+    attr_reader :scripture_chapter
+    attr_reader :verse_number
+    alias_method :number, :verse_number
 
-    def initialize *args
+    def initialize(*args)
       case
       when args.count == 1 && args[0].is_a?(Fixnum)
-        raise ArgumentError, 'normalized value of scripture verse cannot be converted to an integer' unless args[0].respond_to?(:to_i)
-        book_number, chapter_number, verse_number = de_normalize(args[0]) 
-      when args.count == 3 
+        fail ArgumentError, 'normalized value of scripture verse cannot be converted to an integer' unless args[0].respond_to?(:to_i)
+        book_number, chapter_number, verse_number = de_normalize(args[0])
+      when args.count == 3
         book_number, chapter_number, verse_number = args
       end
       @scripture_chapter = ScriptureChapter.new(book_number, chapter_number)
-      raise ArgumentError, 'verse number cannot be converted to an integer' unless verse_number.respond_to?(:to_i)
-      raise 'verse number does not exist' unless (1..@scripture_chapter.number_of_verses).cover? verse_number.to_i
-      @number = verse_number.to_i
+      @scripture_book = @scripture_chapter.scripture_book
+      fail ArgumentError, 'verse number cannot be converted to an integer' unless verse_number.respond_to?(:to_i)
+      fail DoesNotExist, 'verse number does not exist' unless (1..@scripture_chapter.number_of_verses).cover? verse_number.to_i
+      @verse_number = verse_number.to_i
     end
 
-    def scripture_book
-      @scripture_chapter.scripture_book
+    def normalize
+      scripture_book.number * 1_000_000 + scripture_chapter.number * 1000 + @verse_number
     end
 
-    def normalize
-      scripture_book.number * 1000000 + scripture_chapter.number * 1000 + @number
+    def to_s
+      "#{scripture_chapter}:#{number}"
+    end
+
+    def ==(other)
+      return false unless other.is_a?(ScriptureVerse)
+      scripture_book == other.scripture_book &&
+        scripture_chapter == other.scripture_chapter &&
+        verse_number == other.verse_number
     end
 
-    private 
+    private
 
-    def de_normalize number
-      quotient, verse_number = number.divmod(1000) 
-      book_number, chapter_number = quotient.divmod(1000) 
+    def de_normalize(number)
+      quotient, verse_number = number.divmod(1000)
+      book_number, chapter_number = quotient.divmod(1000)
       [book_number, chapter_number, verse_number]
     end
 
+    class DoesNotExist < StandardError; end
   end
 end

data/lib/scriptura/version.rb

@@ -0,0 +1,5 @@
+module Scriptura
+  module Version
+    STRING = '0.0.3'
+  end
+end

metadata

@@ -1,46 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: scriptura
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Gagan Awhad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This is a ruby library that provides operations related with meta information
-  about the Bible
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby library that attempts to provide an intuitive API for operations
+  on meta information about the Bible
 email:
 - gagan.a.awhad@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/scriptura/data.rb
+- LICENSE
+- README.md
+- lib/scriptura.rb
+- lib/scriptura/metadata.yml
 - lib/scriptura/scripture.rb
 - lib/scriptura/scripture_book.rb
 - lib/scriptura/scripture_chapter.rb
 - lib/scriptura/scripture_reference.rb
 - lib/scriptura/scripture_verse.rb
-- lib/scriptura.rb
-- README.md
-- LICENSE
+- lib/scriptura/version.rb
 homepage: https://www.github.com/gaganawhad/scriptura
 licenses: []
 metadata: {}
@@ -50,20 +93,19 @@ 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.0.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: This is a ruby library that provides operations related with meta information
-  about the Bible
+summary: A ruby library that attempts to provide an intuitive API for operations on
+  meta information about the Bible
 test_files: []
-has_rdoc: