cskit 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjI2YTAyZWQ5ZDVlMTQ0OGVmMDFmODEzMjAxNjExMjJlODMyNjk3MA==
+  data.tar.gz: !binary |-
+    OTExOGU2MjJjNTUyZWVkMDVlMzEzNGIyMjMwZGJkODYxOTRmYjIxNQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Nzc4MDcyZWE1ZWU5ODg4MTJlNzJhYjU5NmQ2MTYwMWI4YTVlM2RiMjZmYTY5
+    MmU5YTFhNjM5NzM4YTYxNWRiNDk5NmIxNWNhMzU4N2JmYzUxMGQxYTZlYjE2
+    Mjc4MDhkZWUzODI5ZmI4N2Q1ZTk2NzdiNWUyNTlhNDJlOGJkN2E=
+  data.tar.gz: !binary |-
+    YzdmOGI5YmFkZjc0OTYzYmVmODJlNzEwYzI5MTkwYTdmYjQ4N2I0OGQ2NTI5
+    YTNkY2JjZDEzYjNjZjEwZGNiMzMyZDllMmI5NzQ4MTI2YTBjNjAzYWFmODg5
+    NzYyZWYwNWY5MjNhNDZjYmE1MjRlZDFjMjU4ZDQ5MThkOWNhNjU=

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "pry"
+  gem "pry-nav"
+end

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0
+
+* Birthday!

data/LICENSE

@@ -0,0 +1,177 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,246 @@
+## cskit-rb
+
+CSKit is a citation parsing and retrieval toolkit for various Christian Science textual resources.  It features a pluggable architecture, meaning all the textual data is stored in separate gems.
+
+## Available Textual Resources
+
+1. King James Bible ([cskit-biblekjv-rb](https://github.com/camertron/cskit-biblekjv-rb))
+2. Science and Health with Key to the Scriptures ([cskit-shkts-rb](https://github.com/camertron/cskit-shkts-rb))
+3. Christian Science Hymnal ([cskit-hymnal-rb](https://github.com/camertron/cskit-hymnal-rb))
+
+## Installation
+
+`gem install cskit`, `gem install cskit-shkts`, etc
+
+or, with bundler:
+
+```ruby
+gem 'cskit-rb', '~> 1.0.0'
+gem 'cskit-shkts-rb', '~> 1.0.0'
+```
+
+## Usage
+
+```ruby
+# base CSKit library
+require 'cskit'
+
+# will make data available from cskit-shkts-rb
+require 'cskit/science_health'
+```
+
+### Basics
+
+Requiring one of the textual resource gems (eg. `require 'cskit/science_health'`) will make the resource available as a `Volume`.  `Volume`s provide access to a single textual resource and expose, among other things, a citation parser and a text reader.  Use each `Volume`'s `parse_citation` and `readings_for` methods to parse citations and retrieve text.  You can learn more about these specific components below.
+
+You can ask CSKit which textual resources are currently available via the `available_volumes` method:
+
+```ruby
+require 'cskit/science_health'
+require 'cskit/bible/kjv'
+
+CSKit.available_volumes                   # { :science_health => ..., :bible_kjv => ... }
+CSKit.volume_available?(:science_health)  # true
+CSKit.volume_available?(:blarg)           # false
+```
+
+Get volume objects directly by using the `get_volume` method.  Note that CSKit can find volumes by their type as well as by their name.  These two statements are equivalent because on failing to find `:bible` by name, CSKit will fallback to the last registered volume of the type "bible".
+
+```ruby
+CSKit.get_volume(:bible_kjv)
+CSKit.get_volume(:bible)
+```
+
+#### Definitions
+
+CSKit uses vocabulary that helps consistently describe the objects in the system.  Here are a few definitions that may be helpful to you as you spelunk this documentation and the source code:
+
+1. **Volume**: A textual resource.  This should probably have been named "book", but "book of the bible" introduces ambiguity, so "volume" it is.
+2. **Citation**: References text in a volume.  Parsers generate citation objects, and citation objects are passed to readers.
+3. **Parser**: Converts a citation string into a citation object so it can be used to retrieve text.
+4. **Reader**: An interface for retrieving text from a volume.
+5. **Lesson**: A collection of citations divided into sections.  Each section contains a number of citations and their corresponding volumes.  Analogous to the weekly Christian Science Bible Lesson.
+6. **Section**: A group of citations, possibly refrencing multiple volumes.
+7. **Formatter**: Logic for rendering readings.
+8. **Reading**: Text for a single citation.  Made up of multiple texts.
+9. **Text**: A single unit of text, eg. line, verse, etc.
+
+### Lessons
+
+CSKit features a `Lesson` class that is capable of reading in a JSON file and assembling text from a series of volumes for a group of citations (i.e. the weekly Bible Lesson):
+
+```ruby
+include CSKit::Lesson
+lesson = Lesson.from_file("/path/to/love.json")
+```
+
+You can iterate over the readings in each section using the `each_reading`, `each_formatted_reading`, and `each_formatted_section` methods.  Here are examples for each:
+
+`each_reading` iterates over each reading in each section for the given volumes.  Formatting the text in each reading is up to you - this function returns the raw text only.
+
+```ruby
+lesson.each_reading(:bible, :science_health) do |section, citation, volume, readings|
+  if volume == :bible
+    readings.each do |reading|
+      puts reading.texts.join(" ")
+    end
+  end
+end
+```
+
+`each_formatted_reading` iterates over each section, handing you the formatted text for each group of readings.  More on formatters later.
+
+```ruby
+include CSKit::Formatters::ScienceHealth
+include CSKit::Formatters::Bible
+
+formatters = {
+  :science_health => ScienceHealthPlainTextFormatter.new
+  :bible          => BiblePlainTextFormatter.new
+}
+
+lesson.each_formatted_reading(formatters) do |section, citation, volume, text|
+  if volume == :bible
+    puts "Bible: #{text}"
+  end
+end
+```
+
+`each_formatted_section` is similar to `each_formatted_reading` but hands you a hash of formatted reading groups by volume instead of yielding each reading group one at a time.
+
+```ruby
+lesson.each_formatted_section(formatters) do |section, text_by_volume|
+  puts text_by_volume[:bible]
+end
+```
+
+#### File Format
+
+Here's an example JSON file for a lesson. Note that each volume name (eg. "bible", "science_health") must match an available volume (see above).
+
+```
+[
+  {
+    "section": "1",
+    "readings": {
+      "bible": [
+        "Gen. 12:1-3 the (to :)",
+        "Gen. 17:1, 2, 5",
+        "Gen. 22:17 in (to 1st ;), 18",
+        "Ps. 91:14"
+      ],
+      "science_health": [
+        "275:12-17",
+        "579:10-14",
+        "507:6-7",
+        "140:8-12",
+        "264:15"
+      ]
+    }
+  },
+
+  { ... }
+]
+```
+
+### Parsing Citations
+
+CSKit contains a number of parsers that can transform a citation string into a citation object.  For example, the `BibleParser` can read and interpret "Gen. 12:1-3 the (to :)" like so:
+
+```ruby
+include CSKit::Parsers
+
+parser = BibleParser.new
+citation = parser.parse("Gen. 12:1-3 the (to :)").to_object
+
+citation.book                     # "Gen."
+citation.chapter_list             # [#<Chapter .. >, #<Chapter .. >, ...]
+citation.chapter_list.first.tap do |chapter|
+  chapter.chapter_number          # 12
+  chapter.verse_list              # [#<Verse ..>, ...]
+  chapter.verse_list.first.tap do |verse|
+    verse.start                   # 1
+    verse.finish                  # 3
+    verse.starter.fragment        # "and in"
+    verse.terminator.fragment     # ":"
+    verse.terminator.cardinality  # 1
+  end
+end
+```
+
+In addition, each volume provides a thin wrapper around the appropriate parser object, so you don't have to create one manually:
+
+```ruby
+volume = CSKit.get_volume(:bible)
+volume.parse_citation("Gen. 12:1-3 the (to :)")  # returns a citation object
+```
+
+### Retrieving Citations
+
+Once you have a citation object, you'll likely want to fetch text - the responsibility of a reader.  Readers take in citations and return an array of `Reading` objects:
+
+```ruby
+include CSKit::Readers
+
+reader = BibleReader.new(volume)
+reader.get_book("Genesis")         # #<Book .. >
+reader.get_chapter(12, "Genesis"), # #<Chapter .. >
+
+reader.readings_for(citation)      # [#<Reading .. >, ... ]
+```
+
+In addition, each volume provides a thin wrapper around the appropriate reader object, so you don't have to create one manually:
+
+```ruby
+volume.readings_for(citation)  # [#<Reading .. >, ... ]
+```
+
+### Formatting Text
+
+Now that you have text in the form of `Reading` objects, you might want to format it for display - the responsibility of a formatter.  Currently, CSKit contains two formatters, one for the Bible and another for Science and Health.  Both of these format `Reading` objects as plain text.  If you'd like to apply a different style of formatting (eg. HTML), you'll need to create your own class.
+
+Here's a formatting example for the Bible citation we've been using:
+
+```ruby
+include CSKit::Formatters::Bible
+
+readings = reader.readings_for(citation)
+
+# these options are actually the defaults, shown here for demonstration purposes
+formatter = BiblePlainTextFormatter.new(
+  :include_verse_number => true,
+  :separator => " "
+)
+
+formatter.format_readings(readings)
+```
+
+The formatted output (carriage returns added manually for Github display reasons):
+
+```
+1 ...the LORD had said unto Abram, Get thee out of thy country, and from thy kindred,
+and from thy father's house, unto a land that I will shew thee: 2 And I will make of thee
+a great nation, and I will bless thee, and make thy name great; and thou shalt be a
+blessing: 3 And I will bless them that bless thee, and curse him that curseth thee:
+```
+
+For Science and Health, use the `ScienceHealthPlainTextFormatter` class.
+
+## Requirements
+
+CSKit needs to parse JSON, so it depends on the json gem.
+
+## Running Tests
+
+`bundle exec rake` will run the test suite, although at the current time there are no tests :(
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron
+
+## Links
+* Project Gutenberg: [http://gutenberg.org/](http://gutenberg.org/)
+
+## License
+
+Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+# Copyright 2012 Twitter, Inc
+# http://www.apache.org/licenses/LICENSE-2.0
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+
+require 'bundler'
+require 'digest'
+
+require 'rubygems/package_task'
+
+Bundler::GemHelper.install_tasks
+
+namespace :parsers do
+  task :compile do
+    base_path = File.dirname(__FILE__)
+    parser_paths = [
+      "lib/cskit/parsers/bible/bible.treetop",
+      "lib/cskit/parsers/science_health/science_health.treetop"
+    ]
+
+    parser_paths.each do |parser_path|
+      full_path = File.join(base_path, parser_path)
+      puts "Compiling #{full_path}"
+      `bundle exec tt #{full_path}`
+    end
+  end
+end

data/cskit.gemspec

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'cskit/version'
+
+Gem::Specification.new do |s|
+  s.name     = "cskit"
+  s.version  = ::CSKit::VERSION
+  s.authors  = ["Cameron Dutro"]
+  s.email    = ["camertron@gmail.com"]
+  s.homepage = "http://github.com/camertron"
+
+  s.description = s.summary = "Christian Science citation library for Ruby."
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.add_dependency 'json'
+  s.add_dependency 'treetop'
+
+  s.add_development_dependency 'rake'
+
+  s.require_path = 'lib'
+  s.files = Dir["{lib,spec,resources}/**/*", "Gemfile", "History.txt", "LICENSE", "README.md", "Rakefile", "cskit.gemspec"]
+end

data/lib/cskit/annotated_string.rb

@@ -0,0 +1,73 @@
+# encoding: UTF-8
+
+module CSKit
+  class AnnotatedString
+
+    attr_reader :string
+    attr_reader :annotations
+
+    def initialize(string, annotations = [])
+      @string = string
+      @annotations = annotations
+    end
+
+    def add_annotation(annotation)
+      annotations << annotation
+    end
+
+    def render
+      each_chunk.map do |text, annotation|
+        if annotation
+          yield text, annotation
+        else
+          text
+        end
+      end.join
+    end
+
+    def delete(pos, length)
+      new_length = string.length - length
+
+      annotations.reject! do |annotation|
+        reject = annotation.start >= new_length || annotation.finish >= new_length
+
+        if annotation.start >= pos
+          annotation.start -= length
+          annotation.finish -= length
+        end
+
+        reject || (annotation.start < 0 || annotation.finish < 0)
+      end
+
+      @string = @string[0...pos] + @string[(pos + length)..-1]
+    end
+
+    private
+
+    def each_chunk(&block)
+      enum = Enumerator.new do |yielder|
+        last = 0
+        sorted_annotations.each do |annotation|
+          starter = string[last...annotation.start]
+          yielder.yield(starter, nil) unless starter.empty?
+
+          middle = string[annotation.start..annotation.finish]
+          yielder.yield(middle, annotation)
+          last = annotation.finish + 1
+        end
+
+        terminator = string[last..-1]
+        yielder.yield(terminator, nil) unless terminator.empty?
+      end
+
+      block_given? ? enum.each(&block) : enum
+    end
+
+    def sorted_annotations
+      annotations.sort do |a, b|
+        a.start <=> b.start
+      end
+    end
+
+  end
+end

data/lib/cskit/annotator.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+module CSKit
+  class Annotator
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+  end
+
+  Annotation = Struct.new(:start, :finish, :data)
+
+end

data/lib/cskit/formatters/bible/bible_html_formatter.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+
+module CSKit
+  module Formatters
+    module Bible
+      class BibleHtmlFormatter < BiblePlainTextFormatter
+
+        protected
+
+        def format_verse_texts(texts, verse)
+          texts.each_with_index.map do |text, index|
+            if index == 0
+              pos = starter_position(text, verse.starter)
+              text = format_starter(text, pos)
+            end
+
+            if index == texts.size - 1
+              pos = terminator_position(text, verse.terminator)
+              text = format_terminator(text, pos)
+            end
+
+            verse_number = verse.start + index
+            verse_number = wrap_verse_number(verse_number)
+            text = wrap_text(text)
+
+            include_verse_number? ? "#{verse_number} #{text}" : text
+          end
+        end
+
+        def wrap_text(text)
+          "<span class='cskit-verse-text>#{text}</span>"
+        end
+
+        def wrap_verse_number(verse_number)
+          "<span class='cskit-verse-number'>#{verse_number}</span>"
+        end
+
+      end
+    end
+  end
+end