class SafeDb::Coordinates
Coordinates
point to either a book, or a book/chapter or a book/chapter/verse location. The location pointed to may or may not exist and even if they do they may not be accessible if they exist within a book that (as of yet) we have not logged into.
Public Class Methods
new( coordinates_str )
click to toggle source
Initialize coordinates to a location within a book and/or chapter and/or verse.
@param coordinates_str [String]
this parameter should be a book/chapter/verse separated by forward slashes.
# File lib/model/coordinates.rb, line 17 def initialize( coordinates_str ) KeyError.not_new( coordinates_str, self ) @coords_list = @coords_list.split( "/" ) bcv_error_msg = "Invalid / separated book chapter and verse coordinates ~> #{@coords_list}" raise ArgumentError.new( bcv_error_msg ) unless @coords_list.length() == 3 @book_name = @coords_list[ 0 ].strip() @chapter_name = @coords_list[ 1 ].strip() @verse_name = @coords_list[ 2 ].strip() log.info(x) { "Initializing a book chapter and verse coordinate within book [#{@book_name}]." } end
Public Instance Methods
exists?()
click to toggle source
Do the (book, chapter or verse) that our said coordinates point to exist.
# File lib/model/coordinates.rb, line 35 def exists?() end
is_book?()
click to toggle source
Do our coordinates point to any currently logged in book.
# File lib/model/coordinates.rb, line 52 def is_book?() end
is_chapter?()
click to toggle source
Do our coordinates point to an existing chapter within the currently logged in book.
# File lib/model/coordinates.rb, line 47 def is_chapter?() end
is_verse?()
click to toggle source
Do our coordinates point to an existing verse in a chapter within the current logged in book.
# File lib/model/coordinates.rb, line 41 def is_verse?() end