cskit-biblekjv 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGM0MGNmM2NhZDk3MWE4OGQyMGQzMGJiOWRiN2I5NjFhMTc4YzQzNA==
+  data.tar.gz: !binary |-
+    Y2M3ZjFkMzM2MDgzMGI4YWQ1Y2ZhZGI1NjJlZTM2YjJlNDI5OGE0MQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODFlMDVkNTcxYzViYmRmY2Q1YTU5ZjQ2ZDAyMDBhODNjNjg0OWQwNjQ4MWQx
+    OGU3YWZmNDlkZjdkNjdkMWRhZGNjM2NhYmFlYWVlNmJhM2U3MDRjN2ZmMzVm
+    M2JmYWNlMjk0M2ZjZDEzZjJkYzljNDM4MmE2OGFlNTE0ZGMxMzM=
+  data.tar.gz: !binary |-
+    Yjg2YTJkZmE5YTczMTk5YWZlNDliNDE3NzRiMzdiYTE2MzA1ZGU5Y2ExM2Nm
+    OTdmMTg5NGE1N2NjNzAxOTBiNzM5MzliMWQxNTA4NWJhNDAyY2IzMWJlYmY1
+    MjUwNjgxZWM2NWY0Mjg1NjQzMGJjNjEwYWJjYjRmMzMxYThiZDI=

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/Rakefile

@@ -0,0 +1,37 @@
+# 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'
+
+require './lib/cskit-biblekjv'
+
+Bundler::GemHelper.install_tasks
+
+task :update do
+  require 'cskit'
+  require 'cskit-biblekjv/bible_splitter'
+
+  input_file = File.join(File.dirname(__FILE__), "vendor/biblekjv.txt")
+  output_dir = File.join(File.dirname(__FILE__), "resources/bible/kjv")
+  splitter = CSKit::Splitters::BibleSplitter.new(input_file)
+
+  FileUtils.mkdir_p(output_dir)
+
+  splitter.each_chapter do |chapter, book|
+    book_name = book.name.downcase.gsub(" ", "_")
+    book_output_dir = File.join(output_dir, book_name)
+    FileUtils.mkdir_p(book_output_dir)
+
+    File.open(File.join(book_output_dir, "#{chapter.number}.json"), "w+") do |f|
+      puts "Writing #{book.name}, chapter #{chapter.number} ..."
+      f.write(chapter.to_hash.to_json)
+    end
+  end
+end

data/cskit-biblekjv.gemspec

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

data/lib/cskit-biblekjv.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module CSKitBibleKJV
+  def self.resource_dir
+    @resource_dir ||= File.join(File.dirname(File.dirname(__FILE__)), "resources")
+  end
+end

data/lib/cskit-biblekjv/bible_splitter.rb

@@ -0,0 +1,91 @@
+# encoding: UTF-8
+
+include CSKit::Books
+
+module CSKit
+  module Splitters
+    class BibleSplitter
+
+      VERSE_REGEX = /\d{1,3}:\d{1,3}/
+      BOOK_TRIGGERS = [
+        "Jonah",
+        "The Epistle of Paul the Apostle to the Hebrews",
+        "The Third Epistle General of John",
+        "The General Epistle of Jude",
+        "The Revelation of Saint John the Devine"
+      ]
+
+      include Enumerable
+      attr_reader :input_file
+
+      def initialize(input_file)
+        @input_file = input_file
+      end
+
+      def each
+        verse_buffer = ""
+        chapter = Bible::Chapter.new(1, [])
+        book = Bible::Book.new(book_data.first["name"], [chapter])
+        book_count = 1
+
+        File.open(input_file).each_line do |line|
+          if line.strip.empty?
+            if verse_buffer =~ /\A#{VERSE_REGEX}/
+              split_verses(verse_buffer).each do |verse_data|
+                chapter_num, verse_num, text = verse_data
+
+                if chapter_num != chapter.number
+                  yield chapter, book
+                  new_chapter = Bible::Chapter.new(chapter_num, [])
+                end
+
+                if chapter_num > chapter.number
+                  book.chapters << new_chapter
+                  chapter = new_chapter
+                elsif chapter_num != chapter.number
+                  book = Bible::Book.new(book_data[book_count]["name"], [new_chapter])
+                  book_count += 1
+                  chapter = new_chapter
+                end
+
+                chapter.verses << Bible::Verse.new(text.strip)
+              end
+            end
+
+            verse_buffer.clear
+          elsif
+            # Jonah (and Hebrews) is special because Obadiah (the book before Jonah) only has one chapter
+            # and therefore breaks the assumption that all books have more than one chapter, which this
+            # script uses to avoid having to identify book headers. Yes, it's ugly.
+            if BOOK_TRIGGERS.include?(line.strip)
+              yield chapter, book
+              chapter = Bible::Chapter.new(1, [])
+              book = Bible::Book.new(book_data[book_count]["name"], [chapter])
+              book_count += 1
+            end
+          else
+            verse_buffer << "#{line.strip} "
+          end
+        end
+
+        yield chapter, book
+      end
+
+      alias :each_chapter :each
+
+      private
+
+      def book_data
+        @book_data ||= JSON.parse(File.read(File.join(CSKitBibleKJV.resource_dir, "bible", "kjv", "books.json")))
+      end
+
+      def split_verses(text)
+        verses = text.split(/(#{VERSE_REGEX})/)
+        verses[1..-1].each_slice(2).map do |verse_parts|
+          verse_parts.first.split(":").map(&:to_i) + [verse_parts.last]
+        end
+      end
+
+    end
+  end
+end

data/lib/cskit-biblekjv/version.rb

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

data/lib/cskit-biblekjv/volume.rb

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+
+require 'json'
+
+module CSKitBibleKJV
+  class Volume < CSKit::Volume
+
+    def get_book(book_name)
+      if File.directory?(book_resource_path(book_name))
+        CSKit::Volumes::Bible::Book.new(book_name, Dir.glob(File.join(book_resource_path, "**")).map.with_index do |resource_file, index|
+          get_chapter(index + 1, book_name)
+        end)
+      else
+        nil
+      end
+    end
+
+    def get_chapter(chapter_number, book_name)
+      resource_file = File.join(book_resource_path(book_name), "#{chapter_number}.json")
+      chapter_cache[resource_file] ||= CSKit::Volumes::Bible::Chapter.from_hash(JSON.parse(File.read(resource_file)))
+    end
+
+    def unabbreviate_book_name(orig_book_name)
+      book_name = orig_book_name.strip.chomp(".")  # remove trailing period
+      regex = /^#{book_name}\w*/i
+
+      found_book = books.find do |book|
+        book["name"] =~ regex
+      end
+
+      found_book ? found_book["name"] : orig_book_name
+    end
+
+    def books
+      @books ||= JSON.parse(File.read(File.join(resource_path, "books.json")))
+    end
+
+    protected
+
+    def book_resource_path(book_name)
+      File.join(resource_path, book_name)
+    end
+
+    def chapter_cache
+      @chapter_cache ||= {}
+    end
+
+  end
+end

data/lib/cskit/bible/kjv.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+
+require 'cskit'
+require 'cskit-biblekjv'
+require 'cskit-biblekjv/volume'
+
+CSKit.register_volume({
+  :type => :bible,
+  :id => :bible_kjv,
+  :name => "The Holy Bible, King James Version",
+  :author => "",
+  :language => "English",
+  :resource_path => File.join(CSKitBibleKJV.resource_dir, "bible", "kjv"),
+  :volume => CSKitBibleKJV::Volume,
+  :parser => CSKit::Parsers::BibleParser,
+  :reader => CSKit::Readers::BibleReader
+})