cskit 1.0.0

data/lib/cskit/readers/reading.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+
+module CSKit
+  module Readers
+
+    Reading = Struct.new(:texts, :citation, :chapter, :verse) do
+      def params
+        @params || {}
+      end
+
+      def to_annotated_reading
+        AnnotatedReading.new(texts, citation, chapter, verse)
+      end
+
+      def annotated?
+        false
+      end
+    end
+
+    class AnnotatedReading < Reading
+      def add_annotation(text_index, annotation)
+        if idx = index(text_index, annotation)
+          annotations[text_index].delete_at(idx)
+        end
+
+        (annotations[text_index] ||= []) << annotation
+      end
+
+      def annotations_at(index)
+        annotations[index]
+      end
+
+      def annotations
+        @annotations ||= {}
+      end
+
+      def annotated?
+        true
+      end
+
+      private
+
+      def index(text_index, annotation_to_find)
+        (annotations[text_index] || []).each_with_index do |annotation, index|
+          if annotation.start == annotation_to_find.start && annotation.finish == annotation_to_find.finish
+            return index
+          end
+        end
+        nil
+      end
+    end
+
+  end
+end

data/lib/cskit/readers/science_health_reader.rb

@@ -0,0 +1,97 @@
+# encoding: UTF-8
+
+module CSKit
+  module Readers
+    class ScienceHealthReader
+
+      attr_reader :volume
+
+      def initialize(volume)
+        @volume = volume
+      end
+
+      def get_page(page_number)
+        volume.get_page(page_number)
+      end
+
+      def get_line(line_number, page_number)
+        get_page(page_number).lines[line_number - 1]
+      end
+
+      # be careful - this will go all the way to the end of the book unless you break
+      def each_line(line_number, page_number)
+        while page = get_page(page_number)
+          yield get_line(line_number, page_number), line_number, page_number
+
+          line_number, page_number = if (line_number + 1) > page.lines.size
+            [1, next_page_number(page_number)]
+          else
+            [line_number + 1, page_number]
+          end
+        end
+      end
+
+      def get_paragraph(page_number, line_number)
+        first_line = true
+        lines = []
+
+        each_line(line_number, page_number) do |line, line_number, page_number|
+          if first_line
+            lines << line
+          else
+            if line.paragraph_start? && !first_line
+              break
+            else
+              lines << line
+            end
+          end
+
+          first_line = false
+        end
+
+        lines
+      end
+
+      def get_line_range(range, page_number)
+        lines = []
+        each_line(range.first, page_number) do |line, line_number, page_number|
+          lines << line
+          break if line_number == range.last
+        end
+        lines
+      end
+
+      def readings_for(citation)
+        citation.lines.map do |citation_line|
+          lines = if citation_line.finish
+            get_line_range(citation_line.start..citation_line.finish, citation.page)
+          else
+            if citation_line.only?
+              [get_line(citation_line.start, citation.page)]
+            else
+              get_paragraph(citation.page, citation_line.start)
+            end
+          end
+
+          Reading.new(lines, citation_line)
+        end
+      end
+
+      protected
+
+      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"
+          else
+            numerals[index + 1]
+          end
+        else
+          (page_number.to_i + 1).to_s
+        end
+      end
+
+    end
+  end
+end

data/lib/cskit/readers.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+
+module CSKit
+  module Readers
+    autoload :ScienceHealthReader, "cskit/readers/science_health_reader"
+    autoload :BibleReader,         "cskit/readers/bible_reader"
+    autoload :Reading,             "cskit/readers/reading"
+  end
+end

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

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+
+module CSKit
+  module Volumes
+    module Bible
+
+      Book = Struct.new(:name, :chapters) do
+        def 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) }
+          )
+        end
+      end
+
+      Chapter = Struct.new(:number, :verses) do
+        def 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) }
+          )
+        end
+      end
+
+      Verse = Struct.new(:text) do
+        def to_hash
+          { "text" => text }
+        end
+
+        def self.from_hash(hash)
+          Verse.new(hash["text"])
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+
+module CSKit
+  module Volumes
+    module ScienceHealth
+
+      Page = Struct.new(:number, :lines) do
+        def preface?
+          !!(number =~ /vi{1,3}|xi{1,2}|i{0,1}x/)
+        end
+
+        def 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) }
+          )
+        end
+      end
+
+      Line = Struct.new(:text, :flyout_text, :paragraph_start) do
+        def has_flyout?
+          !!flyout_text
+        end
+
+        alias :paragraph_start? :paragraph_start
+
+        def to_hash
+          { "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"]
+          )
+        end
+      end
+
+    end
+  end
+end

data/lib/cskit/resources/volumes.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+
+module CSKit
+  module Volumes
+    autoload :ScienceHealth, "cskit/resources/volumes/science_health"
+    autoload :Bible,         "cskit/resources/volumes/bible"
+  end
+end

data/lib/cskit/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+module CSKit
+  VERSION = "1.0.0"
+end

data/lib/cskit/volume.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+module CSKit
+  class Volume
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def parse_citation(citation_text)
+      parser.parse(citation_text).to_object
+    end
+
+    def readings_for(citation)
+      reader.readings_for(citation)
+    end
+
+    def parser
+      @parser ||= config[:parser].new
+    end
+
+    def reader
+      @reader ||= config[:reader].new(self)
+    end
+
+    def resource_path
+      config[:resource_path]
+    end
+
+  end
+end

data/lib/cskit.rb

@@ -0,0 +1,73 @@
+# encoding: UTF-8
+
+require 'cskit/formatters'
+require 'cskit/lesson'
+require 'cskit/parsers'
+require 'cskit/readers'
+require 'cskit/volume'
+require 'cskit/resources/volumes'
+
+require 'treetop'
+require 'json'
+
+module CSKit
+
+  autoload :Annotator,       "cskit/annotator"
+  autoload :Annotation,      "cskit/annotator"
+  autoload :AnnotatedString, "cskit/annotated_string"
+
+  class << self
+
+    def register_volume(config)
+      register(:volume, config[:id], config[:volume].new(config))
+    end
+
+    def register_annotator(config)
+      register(:annotator, config[:id], config[:annotator].new(config))
+    end
+
+    def get_volume(volume_id)
+      get(:volume, volume_id)
+    end
+
+    def get_annotator(annotator_id)
+      get(:annotator, annotator_id)
+    end
+
+    def volume_available?(volume_id)
+      available?(:volume, volume_id)
+    end
+
+    def annotator_available?(annotator_id)
+      available?(:annotator, annotator_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_type(family, key)
+    end
+
+    def get_for_type(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
+
+    def registry
+      @registry ||= {}
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: cskit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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: treetop
+  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: rake
+  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'
+description: Christian Science citation library for Ruby.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cskit/annotated_string.rb
+- lib/cskit/annotator.rb
+- lib/cskit/formatters/bible/bible_html_formatter.rb
+- lib/cskit/formatters/bible/bible_plain_text_formatter.rb
+- lib/cskit/formatters/bible.rb
+- lib/cskit/formatters/science_health/science_health_html_formatter.rb
+- lib/cskit/formatters/science_health/science_health_plain_text_formatter.rb
+- lib/cskit/formatters/science_health.rb
+- lib/cskit/formatters.rb
+- lib/cskit/lesson/lesson.rb
+- lib/cskit/lesson/section.rb
+- lib/cskit/lesson.rb
+- lib/cskit/parsers/bible/bible.rb
+- lib/cskit/parsers/bible/bible.treetop
+- lib/cskit/parsers/bible/nodes.rb
+- lib/cskit/parsers/bible/objects.rb
+- lib/cskit/parsers/science_health/nodes.rb
+- lib/cskit/parsers/science_health/objects.rb
+- lib/cskit/parsers/science_health/science_health.rb
+- lib/cskit/parsers/science_health/science_health.treetop
+- lib/cskit/parsers.rb
+- lib/cskit/readers/bible_reader.rb
+- lib/cskit/readers/reading.rb
+- lib/cskit/readers/science_health_reader.rb
+- lib/cskit/readers.rb
+- lib/cskit/resources/volumes/bible.rb
+- lib/cskit/resources/volumes/science_health.rb
+- lib/cskit/resources/volumes.rb
+- lib/cskit/version.rb
+- lib/cskit/volume.rb
+- lib/cskit.rb
+- Gemfile
+- History.txt
+- LICENSE
+- README.md
+- Rakefile
+- cskit.gemspec
+homepage: http://github.com/camertron
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Christian Science citation library for Ruby.
+test_files: []