cskit 1.0.0

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

@@ -0,0 +1,117 @@
+# encoding: UTF-8
+
+module CSKit
+  module Formatters
+    module Bible
+      class BiblePlainTextFormatter < CSKit::Formatters::Formatter
+
+        def format_readings(readings)
+          join_readings(readings) do |reading|
+            format_reading(reading)
+          end
+        end
+
+        def format_annotated_readings(readings, annotation_formatter)
+          join_readings(readings) do |reading|
+            format_annotated_reading(reading, annotation_formatter)
+          end
+        end
+
+        def join(texts)
+          texts.join(separator)
+        end
+
+        protected
+
+        def join_readings(readings)
+          join(
+            readings.map do |reading|
+              join(yield(reading))
+            end
+          )
+        end
+
+        def format_annotated_reading(reading, annotation_formatter)
+          reading.texts.each_with_index.map do |text, index|
+            starter_pos = starter_position(text, reading.verse.starter)
+            terminator_pos = terminator_position(text, reading.verse.terminator)
+
+            annotated_str = CSKit::AnnotatedString.new(text, reading.annotations_at(index))
+            annotated_str.delete(terminator_pos + 1, text.length - (terminator_pos + 1)) if terminator_pos
+            annotated_str.delete(0, starter_pos) if starter_pos
+            
+            text = annotated_str.render do |snippet, annotation|
+              annotation_formatter.format_annotation(annotation, snippet)
+            end
+
+            verse_number = reading.verse.start + index
+            attach_verse_number(verse_number, text)
+          end
+        end
+
+        def format_reading(reading)
+          reading.texts.each_with_index.map do |text, index|
+            if index == 0
+              pos = starter_position(text, reading.verse.starter)
+              text = format_starter(pos ? text[pos..-1].strip : text.strip, pos)
+            end
+
+            if index == reading.texts.size - 1
+              pos = terminator_position(text, reading.verse.terminator)
+              text = format_terminator(pos ? text[0..pos] : text, pos)
+            end
+
+            verse_number = reading.verse.start + index
+            attach_verse_number(verse_number, text)
+          end
+        end
+
+        def attach_verse_number(verse_number, text)
+          include_verse_number? ? "#{verse_number} #{text}" : text
+        end
+
+        def starter_position(text, starter)
+          if starter
+            regex = /\s+#{starter.fragment}([\s,\.\-_\?\!\.;:]|$)/
+            find_position(text, regex, starter.cardinality)
+          end
+        end
+
+        def format_starter(text, pos)
+          pos ? "..." + text : text
+        end
+
+        def terminator_position(text, terminator)
+          if terminator
+            regex = /#{Regexp.escape(terminator.fragment)}/
+            find_position(text, regex, terminator.cardinality)
+          end
+        end
+
+        def format_terminator(text, pos)
+          text
+        end
+
+        def find_position(text, regex, cardinality)
+          (0...cardinality).inject(-1) do |last_index, _|
+            return nil unless last_index
+            text.index(regex, last_index + 1)
+          end
+        end
+
+        def separator
+          options[:separator] || " "
+        end
+
+        def include_verse_number?
+          if options[:include_verse_number].nil?
+            true  # default
+          else
+            !!options[:include_verse_number]
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/cskit/formatters/bible.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+module CSKit
+  module Formatters
+    module Bible
+
+      autoload :BiblePlainTextFormatter, "cskit/formatters/bible/bible_plain_text_formatter"
+      autoload :BibleHtmlFormatter,      "cskit/formatters/bible/bible_html_formatter"
+
+    end
+  end
+end

data/lib/cskit/formatters/science_health/science_health_html_formatter.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+
+module CSKit
+  module Formatters
+    module ScienceHealth
+      class ScienceHealthHtmlFormatter < ScienceHealthPlainTextFormatter
+
+        # _word_
+        ITALICS_REGEX = /_([a-zA-Z0-9\-\.,\"\'\?]+)_/
+
+        protected
+
+        def format_lines(lines, citation_line)
+          detect_italics(super)
+        end
+
+        def detect_italics(lines)
+          lines.map do |line|
+            line.gsub(ITALICS_REGEX) do |match|
+              "<em>#{$1}</em>"
+            end
+          end
+        end
+
+        def separator
+          options[:separator] || "<br />"
+        end
+
+      end
+    end
+  end
+end

data/lib/cskit/formatters/science_health/science_health_plain_text_formatter.rb

@@ -0,0 +1,73 @@
+# encoding: UTF-8
+
+module CSKit
+  module Formatters
+    module ScienceHealth
+      class ScienceHealthPlainTextFormatter < CSKit::Formatters::Formatter
+
+        # semicolon, question mark, or period
+        SENTENCE_TERMINATOR_REGEX = /[;\?\.]/
+
+        # either a period + space, quotes, or start of line followed by the first capital letter or number.
+        SENTENCE_START_REGEX = /(\.\s+|\.\"\s+|\.\'\s+|^)[A-Z0-9\"\']/
+
+        def format_readings(readings)
+          join(
+            readings.map do |reading|
+              format_lines(reading.texts, reading.citation)
+            end
+          )
+        end
+
+        def join(texts)
+          texts.join(separator)
+        end
+
+        protected
+
+        def format_lines(lines, citation_line)
+          lines.each_with_index.map do |line, line_index|
+            line_text = line.text
+
+            line_text = if line_index == 0
+              if citation_line.start_fragment
+                index = line_text.index(citation_line.start_fragment)
+                index ? line_text[index..-1] : line_text
+              else
+                matches = line_text.match(SENTENCE_START_REGEX)
+                if matches && matches.length == 2
+                  offset = matches.offset(1)
+                  spaces = " " * offset.first  # indent to match physical position in S&H book
+                  spaces + line_text[matches.offset(1).last..-1]
+                else
+                  line_text
+                end
+              end
+            else
+              line_text
+            end
+
+            line_text = if line_index == (lines.size - 1)
+              index = line_text.index(SENTENCE_TERMINATOR_REGEX)
+              index ? line_text[0..index] : line_text
+            else
+              line_text
+            end
+
+            # indent start of paragraph
+            if line.paragraph_start?
+              "   #{line_text}"
+            else
+              line_text
+            end
+          end
+        end
+
+        def separator
+          options[:separator] || "\n"
+        end
+
+      end
+    end
+  end
+end

data/lib/cskit/formatters/science_health.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+module CSKit
+  module Formatters
+    module ScienceHealth
+
+      autoload :ScienceHealthPlainTextFormatter, "cskit/formatters/science_health/science_health_plain_text_formatter"
+      autoload :ScienceHealthHtmlFormatter,      "cskit/formatters/science_health/science_health_html_formatter"
+
+    end
+  end
+end

data/lib/cskit/formatters.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+module CSKit
+  module Formatters
+
+    autoload :Bible,         "cskit/formatters/bible"
+    autoload :ScienceHealth, "cskit/formatters/science_health"
+
+
+    class Formatter
+      attr_reader :options
+
+      def initialize(options = {})
+        @options = options
+      end
+    end
+
+  end
+end

data/lib/cskit/lesson/lesson.rb

@@ -0,0 +1,72 @@
+# encoding: UTF-8
+
+require 'json'
+
+module CSKit
+  module Lesson
+    class Lesson
+
+      attr_reader :sections
+
+      class << self
+        def from_file(file)
+          ext = File.extname(file)[1..-1]
+          send(:"from_#{ext}", File.read(file))
+        end
+
+        def from_json(data)
+          sections = JSON.parse(data).map do |section_data|
+            Section.new(
+              section_data["section"],
+              section_data["readings"].inject({}) do |ret, (k, v)|
+                ret[k.to_sym] = v; ret
+              end
+            )
+          end
+
+          new(sections)
+        end
+      end
+
+      def initialize(sections)
+        @sections = sections
+      end
+
+      def each_reading(volumes)
+        sections.each do |section|
+          volumes.each do |volume|
+            section.each_reading_group_for(volume) do |readings, citation|
+              yield section, citation, volume, readings
+            end
+          end
+        end
+      end
+
+      def each_formatted_reading(formatters)
+        each_reading(formatters.keys) do |section, citation, volume, readings|
+          formatter = formatters[volume]
+          yield section, citation, volume, formatter.format_readings(readings)
+        end
+      end
+
+      def each_formatted_section(formatters)
+        last_section = nil
+        current_texts = nil
+
+        each_formatted_reading(formatters) do |section, citation, volume, text|
+          if section.name != (last_section.name rescue nil)
+            yield section, current_texts if current_texts
+            current_texts = {}
+          end
+
+          last_section = section
+          formatter = formatters[volume]
+          current_texts[volume] = formatter.join([current_texts[volume], text])
+        end
+
+        yield last_section, current_texts if current_texts
+      end
+
+    end
+  end
+end

data/lib/cskit/lesson/section.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+module CSKit
+  module Lesson
+    class Section
+
+      attr_reader :name, :citation_texts
+
+      def initialize(name, citation_texts)
+        @name = name
+        @citation_texts = citation_texts
+      end
+
+      def each_reading_group_for(volume_name)
+        volume_name = volume_name.to_sym
+        volume = CSKit.get_volume(volume_name)
+
+        (citation_texts[volume_name] || []).each do |citation_text|
+          citation = volume.parse_citation(citation_text)
+          yield volume.readings_for(citation), citation
+        end
+      end
+
+    end
+  end
+end

data/lib/cskit/lesson.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+module CSKit
+  module Lesson
+
+    autoload :Lesson,  "cskit/lesson/lesson"
+    autoload :Section, "cskit/lesson/section"
+
+  end
+end