votd 2.1.2 → 2.1.3

data/.travis.yml

@@ -7,7 +7,6 @@ rvm:
 notifications:
   email:
     recipients:
-      - beakr@ninjanizr.com
       - doctorbh@ninjanizr.com
       - main@seven7.flowdock.com
     on_success: always

data/CHANGELOG.md

@@ -1,9 +1,19 @@
 Changelog
 =========
 
-Current Iteration
+2.1.3
 -----------------
 
+*April 5, 2012*
+
+* Reorganized Helper modules (used internally only)
+* Minor bug fixes
+
+2.1.2
+-----------------
+
+*April 4, 2012*
+
 * Added custom exception type `Votd::VotdError`
 * Added `Votd::Helper` module to provide common helper methods to all modules
 * Cleaned up command-line version to wrap text properly
@@ -16,7 +26,7 @@ Current Iteration
 2.1.1
 -----
 
-*March 31, 2010*
+*March 31, 2012*
 
 * VotD will now return a default scripture of John 3:16 in KJV if there's
   any error enountered when accessing the VotD from the source server.

data/bin/votd

@@ -4,8 +4,9 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'votd'
+require 'votd/helper/command_line'
 
-include Votd::Helper
+include Votd::Helper::CommandLine
 
 votd = Votd::BibleGateway.new
 #votd = Votd::NetBible.new
@@ -20,4 +21,4 @@ puts word_wrap(votd.to_text, LINE_WIDTH)
 if votd.copyright
   puts "\n"
   puts banner(LINE_WIDTH) { word_wrap(votd.copyright, LINE_WIDTH) }
-end
+end

data/lib/votd/base.rb

@@ -1,3 +1,5 @@
+require 'votd/helper/text'
+
 module Votd
   # This is the base class that all Votd lookup modules inherit from.
   # It provides default values for the Votd in the event of lookup failure.
@@ -146,33 +148,5 @@ module Votd
       @copyright = nil
     end
 
-    # Removes HTML tags from the given text
-    # @param [String] text the text you want to strip HTML tags from
-    # @return [String]
-    def strip_html_tags(text)
-      text.gsub(/<\/?[^>]*>/, '')
-    end
-
-    # Prepends '...' if first letter is not a capital letter
-    # @param [String] the text to process
-    # @return [String]
-    def clean_verse_start(text)
-      text.sub(/^([a-z])/, '...\1')
-    end
-
-    # Appends '...' if verse ends abruptly
-    # @param [String] the text to process
-    # @return [String]
-    def clean_verse_end(text)
-      case text
-      when /[a-zA=Z]$/         # no ending "."
-        text << '...'
-      when /[,;]$/
-        text.sub!(/,$/, '...') # ends with "," or ";"
-      else
-        text
-      end
-      text
-    end
   end
 end

data/lib/votd/bible_gateway.rb

@@ -1,4 +1,5 @@
 require 'feedzirra'
+require 'votd/helper/text'
 
 module Votd
   # Retrieves a Verse of the Day from biblegateway.com using a variety
@@ -53,18 +54,18 @@ module Votd
     # @return [String]
     def clean_text(text)
       text = strip_html_quote_entities(text)
-      text = strip_html_tags(text)
+      text = Helper::Text.strip_html_tags(text)
       text = strip_copyright_text(text)
       text.strip!
-      text = clean_verse_start(text)
-      text = clean_verse_end(text)
+      text = Helper::Text.clean_verse_start(text)
+      text = Helper::Text.clean_verse_end(text)
     end
 
     # Extracts copyright tag from the Bible text
     # @return [String]
     def get_copyright(text)
       text = strip_html_quote_entities(text)
-      text = strip_html_tags(text)
+      text = Helper::Text.strip_html_tags(text)
       text.match(@regex_copyright_text)[1]
     end
 

data/lib/votd/helper/command_line.rb

@@ -0,0 +1,38 @@
+module Votd
+  module Helper
+    # This module contains helper methods that support the
+    # command-line application
+    module CommandLine
+      extend self
+      # Generates a text banner suitable for displaying from a command-line
+      # utility, for example. Use with a block.
+      # @example
+      #   banner(20) { "My Banner" }
+      #
+      #   ->
+      #   ====================
+      #   My Banner
+      #   ====================
+      # @param [Integer] line_width number of columns for width
+      # @return [String] the banner text
+      def banner(line_width=40)
+        banner_text = "=" * line_width
+        banner_text << "\n"
+        banner_text << yield.center(line_width)
+        banner_text << "\n"
+        banner_text << "=" * line_width
+        banner_text
+      end
+
+      # Word-wraps text to the specified column width.
+      # @param [String] text the text to be wrapped
+      # @param [Integer] line_width column width
+      # @return [String] wrapped text
+      def word_wrap(text, line_width=40)
+        text.split("\n").collect do |line|
+          line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
+        end * "\n"
+      end
+    end
+  end
+end

data/lib/votd/helper/helper.rb

@@ -0,0 +1,6 @@
+module Votd
+  # This module provides various helper methods used throughout the
+  # codebase.
+  module Helper
+  end
+end

data/lib/votd/helper/text.rb

@@ -0,0 +1,38 @@
+module Votd
+  module Helper
+    # This module contains helper methods that support the
+    # VotD text parsing.
+    module Text
+      extend self
+      # Removes HTML tags from the given text
+      # @param [String] text the text you want to strip HTML tags from
+      # @return [String]
+      def strip_html_tags(text)
+        text.gsub(/<\/?[^>]*>/, '')
+      end
+      
+      # Prepends '...' if first letter is not a capital letter
+      # @param [String] the text to process
+      # @return [String]
+      def clean_verse_start(text)
+        text.sub(/^([a-z])/, '...\1')
+      end
+
+      # Appends '...' if verse ends abruptly
+      # @param [String] the text to process
+      # @return [String]
+      def clean_verse_end(text)
+        case text
+        when /[a-zA-Z]$/         # no ending "."
+          text << '...'
+        when /[,;]$/
+          text.sub!(/[,;]$/, '...') # ends with "," or ";"
+        else
+          text
+        end
+        text
+      end
+
+    end
+  end
+end

data/lib/votd/netbible.rb

@@ -1,3 +1,5 @@
+require 'votd/helper/text'
+
 module Votd
   # Retrieves a Verse of the Day from http://bible.org using the NETBible
   # translation.
@@ -37,7 +39,8 @@ module Votd
       @reference = "#{bookname} #{chapter}:#{verse_numbers.join("-")}"
 
       # build the text
-      text = strip_html_tags(verses.join(" "))
+      #text = strip_html_tags(verses.join(" "))
+      text = Helper::Text.strip_html_tags(verses.join(" "))
       text = clean_verse_start(text)
       text = clean_verse_end(text)
 

data/lib/votd/version.rb

@@ -1,4 +1,4 @@
 module Votd
   # Gem version number
-  VERSION = "2.1.2"
+  VERSION = "2.1.3"
 end

data/lib/votd.rb

@@ -7,8 +7,8 @@ require "httparty"
 module Votd
 end
 
+require "votd/helper/text"
 require "votd/version"
-require "votd/helper"
 require "votd/votd_error"
 require "votd/base"
 require "votd/bible_gateway"

data/spec/lib/votd/{helper_spec.rb → helper/command_line_spec.rb}

@@ -1,8 +1,9 @@
 require 'spec_helper'
+require 'votd/helper/command_line'
 
-include Votd::Helper
+include Votd::Helper::CommandLine
 
-describe Votd::Helper do
+describe Votd::Helper::CommandLine do
   describe "#banner" do
     it "prints a banner wrapped at the correct location" do
       banner(6){ "foo" }.should == "======\n foo  \n======"
@@ -14,6 +15,5 @@ describe Votd::Helper do
       text = "The quick brown fox jumps over the lazy dog."
       word_wrap(text, 20).should == "The quick brown fox\njumps over the lazy\ndog."
     end
-
   end
-end
+end

data/spec/lib/votd/helper/helper_spec.rb

@@ -0,0 +1,3 @@
+require 'spec_helper'
+describe Votd::Helper do
+end

data/spec/lib/votd/helper/text_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+include Votd::Helper::Text
+
+describe Votd::Helper::Text do
+  describe ".strip_html_tags" do
+    it "removes HTML tags from a given string" do
+      text = %q[<p>The <span name="foo">quick</span> brown fox.</p><br />]
+      strip_html_tags(text).should == "The quick brown fox."
+    end
+  end
+
+  describe ".clean_verse_start" do
+    it "prepends '...' if the first letter is not a capital letter" do
+      text = "for God so loved"
+      clean_verse_start(text).should == "...for God so loved"
+    end
+  end
+
+  describe ".clean_verse_end" do
+    it "appends '...' if the verse ends without a period" do
+      text = "For God so loved"
+      clean_verse_end(text).should == "For God so loved..."
+    end
+
+    it "appends '...' if the verse ends in a ',' or ';'" do
+      ["loved,", "loved;"].each do |text| 
+        clean_verse_end(text).should == "loved..."
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: votd
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-04 00:00:00.000000000 Z
+date: 2012-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -181,7 +181,9 @@ files:
 - lib/votd.rb
 - lib/votd/base.rb
 - lib/votd/bible_gateway.rb
-- lib/votd/helper.rb
+- lib/votd/helper/command_line.rb
+- lib/votd/helper/helper.rb
+- lib/votd/helper/text.rb
 - lib/votd/netbible.rb
 - lib/votd/version.rb
 - lib/votd/votd_error.rb
@@ -204,7 +206,9 @@ files:
 - spec/fixtures/netbible/netbible_with_partial.json
 - spec/lib/votd/base_spec.rb
 - spec/lib/votd/bible_gateway_spec.rb
-- spec/lib/votd/helper_spec.rb
+- spec/lib/votd/helper/command_line_spec.rb
+- spec/lib/votd/helper/helper_spec.rb
+- spec/lib/votd/helper/text_spec.rb
 - spec/lib/votd/netbible_spec.rb
 - spec/lib/votd/version_spec.rb
 - spec/lib/votd/votd_error_spec.rb
@@ -256,7 +260,9 @@ test_files:
 - spec/fixtures/netbible/netbible_with_partial.json
 - spec/lib/votd/base_spec.rb
 - spec/lib/votd/bible_gateway_spec.rb
-- spec/lib/votd/helper_spec.rb
+- spec/lib/votd/helper/command_line_spec.rb
+- spec/lib/votd/helper/helper_spec.rb
+- spec/lib/votd/helper/text_spec.rb
 - spec/lib/votd/netbible_spec.rb
 - spec/lib/votd/version_spec.rb
 - spec/lib/votd/votd_error_spec.rb

data/lib/votd/helper.rb

@@ -1,36 +0,0 @@
-module Votd
-  # This module provides various helper methods used throughout the
-  # codebase.
-  module Helper
-    # Generates a text banner suitable for displaying from a command-line
-    # utility, for example. Use with a block.
-    # @example
-    #   banner(20) { "My Banner" }
-    #
-    #   ->
-    #   ====================
-    #   My Banner
-    #   ====================
-    # @param [Integer] line_width number of columns for width
-    # @return [String] the banner text
-    def banner(line_width=40)
-      banner_text = "=" * line_width
-      banner_text << "\n"
-      banner_text << yield.center(line_width)
-      banner_text << "\n"
-      banner_text << "=" * line_width
-      banner_text
-    end
-
-    # Word-wraps text to the specified column width.
-    # @param [String] text the text to be wrapped
-    # @param [Integer] line_width column width
-    # @return [String] wrapped text
-    def word_wrap(text, line_width=40)
-      text.split("\n").collect do |line|
-        line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
-      end * "\n"
-    end
-
-  end
-end