cskit 1.0.1 → 1.1.0

data/lib/cskit/readers/reading.rb

@@ -15,6 +15,13 @@ module CSKit
       def annotated?
         false
       end
+
+      def to_hash
+        {
+          texts: texts,
+          chapter: chapter.to_hash
+        }
+      end
     end
 
     class AnnotatedReading < Reading
@@ -51,4 +58,4 @@ module CSKit
     end
 
   end
-end
+end

data/lib/cskit/readers/science_health_reader.rb

@@ -3,6 +3,7 @@
 module CSKit
   module Readers
     class ScienceHealthReader
+      NUMERALS = %w(vi vii ix x xi xii)
 
       attr_reader :volume
 
@@ -95,7 +96,7 @@ module CSKit
         end
       end
 
-      protected
+      private
 
       def increment(line_number, page_number)
         page = get_page(page_number)
@@ -107,16 +108,15 @@ module CSKit
       end
 
       def next_page_number(page_number)
-        numerals = ["vi", "vii", "ix", "x", "xi", "xii"]
-        if index = numerals.index(page_number)
-          if index == numerals.size - 1
-            "1"
+        if index = NUMERALS.index(page_number)
+          if index == NUMERALS.size - 1
+            '1'
           else
-            numerals[index + 1]
+            NUMERALS[index + 1]
           end
         else
-          if page_number == "497"
-            "501"
+          if page_number == '497'
+            '501'
           else
             (page_number.to_i + 1).to_s
           end

data/lib/cskit/registry.rb

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+
+module CSKit
+  module Registry
+    def family(family, plural_family)
+      extend RegistryFactory.create(family, plural_family)
+    end
+
+    def registry
+      @registry ||= {}
+    end
+  end
+
+  class RegistryFactory
+    class << self
+
+      def create(family, plural_family)
+        Module.new do
+          define_method :"register_#{family}" do |config|
+            register(family, config[:id], config[family].new(config))
+          end
+
+          define_method :"get_#{family}" do |id|
+            get(family, id)
+          end
+
+          define_method :"#{plural_family}" do
+            all(family)
+          end
+
+          define_method :"#{family}_available?" do |id|
+            available?(family, id)
+          end
+
+          private
+
+          def register(family, key, obj)
+            (registry[family.to_sym] ||= {})[key.to_sym] = obj
+          end
+
+          def get(family, key)
+            registry[family.to_sym][key.to_sym] || get_for_family(family, key)
+          end
+
+          def all(family)
+            registry.fetch(family, [])
+          end
+
+          def get_for_family(family, type)
+            found = registry[family.to_sym].find do |key, obj|
+              obj.config[:type] == type
+            end
+
+            found.last if found
+          end
+
+          def available?(family, key)
+            !!registry[family.to_sym][key.to_sym] rescue false
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/cskit/resources/volumes.rb

@@ -2,7 +2,7 @@
 
 module CSKit
   module Volumes
-    autoload :ScienceHealth, "cskit/resources/volumes/science_health"
-    autoload :Bible,         "cskit/resources/volumes/bible"
+    autoload :ScienceHealth, 'cskit/resources/volumes/science_health'
+    autoload :Bible,         'cskit/resources/volumes/bible'
   end
-end
+end

data/lib/cskit/resources/volumes/bible.rb

@@ -6,40 +6,42 @@ module CSKit
 
       Book = Struct.new(:name, :chapters) do
         def to_hash
-          { "name" => name, "chapters" => chapters.map(&:to_hash) }
+          { 'name' => name, 'chapters' => chapters.map(&:to_hash) }
         end
 
         def self.from_hash(hash)
           Book.new(
-            hash["name"],
-            hash["chapters"].map { |chapter_hash| Chapter.from_hash(chapter_hash) }
+            hash['name'],
+            hash['chapters'].map do |chapter_hash|
+              Chapter.from_hash(chapter_hash)
+            end
           )
         end
       end
 
       Chapter = Struct.new(:number, :verses) do
         def to_hash
-          { "number" => number, "verses" => verses.map(&:to_hash) }
+          { 'number' => number, 'verses' => verses.map(&:to_hash) }
         end
 
         def self.from_hash(hash)
           Chapter.new(
-            hash["number"],
-            hash["verses"].map { |verse_hash| Verse.from_hash(verse_hash) }
+            hash['number'],
+            hash['verses'].map { |verse_hash| Verse.from_hash(verse_hash) }
           )
         end
       end
 
       Verse = Struct.new(:text) do
         def to_hash
-          { "text" => text }
+          { 'text' => text }
         end
 
         def self.from_hash(hash)
-          Verse.new(hash["text"])
+          Verse.new(hash['text'])
         end
       end
 
     end
   end
-end
+end

data/lib/cskit/resources/volumes/science_health.rb

@@ -10,13 +10,13 @@ module CSKit
         end
 
         def to_hash
-          { "number" => number, "lines" => lines.map(&:to_hash) }
+          { 'number' => number, 'lines' => lines.map(&:to_hash) }
         end
 
         def self.from_hash(hash)
           Page.new(
-            hash["number"],
-            hash["lines"].map { |line_hash| Line.from_hash(line_hash) }
+            hash['number'],
+            hash['lines'].map { |line_hash| Line.from_hash(line_hash) }
           )
         end
       end
@@ -29,17 +29,18 @@ module CSKit
         alias :paragraph_start? :paragraph_start
 
         def to_hash
-          { "text" => text,
-            "flyout_text" => flyout_text,
-            "paragraph_start" => paragraph_start
+          {
+            'text' => text,
+            'flyout_text' => flyout_text,
+            'paragraph_start' => paragraph_start
           }
         end
 
         def self.from_hash(hash)
           Line.new(
-            hash["text"],
-            hash["flyout_text"],
-            !!hash["paragraph_start"]
+            hash['text'],
+            hash['flyout_text'],
+            !!hash['paragraph_start']
           )
         end
       end

data/lib/cskit/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module CSKit
-  VERSION = "1.0.1"
+  VERSION = '1.1.0'
 end

data/lib/cskit/volume.rb

@@ -30,4 +30,4 @@ module CSKit
     end
 
   end
-end
+end

data/spec/parsers/bible/bible_parser_spec.rb

@@ -0,0 +1,205 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+include CSKit::Parsers::Bible
+
+describe BibleParser do
+  let(:parser) { described_class.new(citation_text) }
+
+  context 'single chapter, single verse' do
+    let(:citation_text) { 'Genesis 1:1' }
+
+    it 'parses correctly' do
+      expect(parser.parse.to_hash).to eq({
+        book: 'Genesis', chapters: [{
+          chapter_number: 1, verses: [{
+            start: 1, finish: 1, starter: nil, terminator: nil
+          }]
+        }]
+      })
+    end
+  end
+
+  context 'single chapter, verse range' do
+    let(:citation_text) { 'Genesis 1:1-5' }
+
+    it 'parses correctly' do
+      expect(parser.parse.to_hash).to eq({
+        book: 'Genesis', chapters: [{
+          chapter_number: 1, verses: [{
+            start: 1, finish: 5, starter: nil, terminator: nil
+          }]
+        }]
+      })
+    end
+  end
+
+  context 'single chapter, verse range, starter fragment' do
+    let(:citation_text) { 'Genesis 1:1-5 God' }
+
+    it 'parses correctly' do
+      expect(parser.parse.to_hash).to eq({
+        book: 'Genesis', chapters: [{
+          chapter_number: 1, verses: [{
+            start: 1, finish: 5, terminator: nil, starter: {
+              fragment: 'God', cardinality: 1
+            }
+          }]
+        }]
+      })
+    end
+  end
+
+  context 'single chapter, verse range, starter fragment with cardinality' do
+    let(:citation_text) { 'Genesis 1:1-5 2nd God' }
+
+    it 'parses correctly' do
+      expect(parser.parse.to_hash).to eq({
+        book: 'Genesis', chapters: [{
+          chapter_number: 1, verses: [{
+            start: 1, finish: 5, terminator: nil, starter: {
+              fragment: 'God', cardinality: 2
+            }
+          }]
+        }]
+      })
+    end
+  end
+
+  context 'single chapter, single verse, starter fragment with cardinality' do
+    let(:citation_text) { 'Genesis 1:1 2nd God' }
+
+    it 'parses correctly' do
+      expect(parser.parse.to_hash).to eq({
+        book: 'Genesis', chapters: [{
+          chapter_number: 1, verses: [{
+            start: 1, finish: 1, terminator: nil, starter: {
+              fragment: 'God', cardinality: 2
+            }
+          }]
+        }]
+      })
+    end
+  end
+
+  context 'single chapter, single verse, starter fragment, terminator fragment' do
+    let(:citation_text) { 'Genesis 1:1 God (to said)' }
+
+    it 'parses correctly' do
+      expect(parser.parse.to_hash).to eq({
+        book: 'Genesis', chapters: [{
+          chapter_number: 1, verses: [{
+            start: 1, finish: 1, terminator: {
+              fragment: 'said', cardinality: 1
+            }, starter: {
+              fragment: 'God', cardinality: 1
+            }
+          }]
+        }]
+      })
+    end
+  end
+
+  context 'single chapter, single verse, starter fragment, terminator fragment with cardinality' do
+    let(:citation_text) { 'Genesis 1:1 God (to 2nd said)' }
+
+    it 'parses correctly' do
+      expect(parser.parse.to_hash).to eq({
+        book: 'Genesis', chapters: [{
+          chapter_number: 1, verses: [{
+            start: 1, finish: 1, terminator: {
+              fragment: 'said', cardinality: 2
+            }, starter: {
+              fragment: 'God', cardinality: 1
+            }
+          }]
+        }]
+      })
+    end
+  end
+
+  context 'single chapter, single verse, starter fragment with cardinality, terminator fragment with cardinality' do
+    let(:citation_text) { 'Genesis 1:1 3rd God (to 2nd said)' }
+
+    it 'parses correctly' do
+      expect(parser.parse.to_hash).to eq({
+        book: 'Genesis', chapters: [{
+          chapter_number: 1, verses: [{
+            start: 1, finish: 1, terminator: {
+              fragment: 'said', cardinality: 2
+            }, starter: {
+              fragment: 'God', cardinality: 3
+            }
+          }]
+        }]
+      })
+    end
+  end
+
+  context 'multiple chapters, single verse' do
+    let(:citation_text) { 'Genesis 1:1; 4:8' }
+
+    it 'parses correctly' do
+      expect(parser.parse.to_hash).to eq({
+        book: 'Genesis', chapters: [{
+          chapter_number: 1, verses: [{
+            start: 1, finish: 1, terminator: nil, starter: nil
+          }]
+        }, {
+          chapter_number: 4, verses: [{
+            start: 8, finish: 8, terminator: nil, starter: nil
+          }]
+        }]
+      })
+    end
+  end
+
+  context 'multiple chapters, single and multiple verses' do
+    let(:citation_text) { 'Genesis 1:1; 4:8, 9-12' }
+
+    it 'parses correctly' do
+      expect(parser.parse.to_hash).to eq({
+        book: 'Genesis', chapters: [{
+          chapter_number: 1, verses: [{
+            start: 1, finish: 1, terminator: nil, starter: nil
+          }]
+        }, {
+          chapter_number: 4, verses: [{
+            start: 8, finish: 8, terminator: nil, starter: nil
+          }, {
+            start: 9, finish: 12, terminator: nil, starter: nil
+          }]
+        }]
+      })
+    end
+  end
+
+  context 'multiple chapters, verses with terminators' do
+    let(:citation_text) { 'Genesis 1:1; 4:8 great (to 2nd ;), 9-12 2nd not (to 3rd ,)' }
+
+    it 'parses correctly' do
+      expect(parser.parse.to_hash).to eq({
+        book: 'Genesis', chapters: [{
+          chapter_number: 1, verses: [{
+            start: 1, finish: 1, terminator: nil, starter: nil
+          }]
+        }, {
+          chapter_number: 4, verses: [{
+            start: 8, finish: 8, terminator: {
+              fragment: ';', cardinality: 2
+            }, starter: {
+              fragment: 'great', cardinality: 1
+            }
+          }, {
+            start: 9, finish: 12, terminator: {
+              fragment: ',', cardinality: 3
+            }, starter: {
+              fragment: 'not', cardinality: 2
+            }
+          }]
+        }]
+      })
+    end
+  end
+end