votd 2.0.0 → 2.1.0

data/.travis.yml

@@ -9,5 +9,6 @@ notifications:
     recipients:
       - beakr@ninjanizr.com
       - doctorbh@ninjanizr.com
+      - main@seven7.flowdock.com
     on_success: always
     on_failure: always

data/CHANGELOG.md

@@ -1,8 +1,18 @@
 # Changelog
-* March 30, 2010 2.0.0 release
-  * New `copyright` attribute containing any copyright information provided
+* March 31, 2012 (2.1.0)
+  * [Add] `.custom_html` method that takes a block of custom formatted
+    HTML to override the `.to_html` method.
+  * [Add] `.to_text` method that returns a text-formatted version
+    of the VotD.
+    Aliased to `.to_s`.
+  * [Add] `.custom_text` method that takes a block of custom formatted
+    text to override the `.to_text` method.
+  * [Add] `.translation` -> aliased to `.version`.
+    
+* March 30, 2012 2.0.0 release
+  * New `.copyright` attribute containing any copyright information provided
     by the VotD service. This may will cause any existing use of
-    `Votd.BibleGateway.text` to lose copyright data unless you add it.
+    `Votd::BibleGateway.text` to lose copyright data unless you add it.
     (Previously, we were just using the copyright data that Bible Gateway
     appended to the end of the Bible text.)
     Bible Gateway requires that you add this copyright data. 

data/README.md

@@ -48,10 +48,14 @@ To use VotD in your code:
     votd.date        # 2012-03-24
     votd.version     # NIV
     votd.copyright   # Copyright © ...
+
+### Outputting HTML
+
+You can use the built-in formatted HTML:
     
-    votd.to_html     # <p class="votd-text">For by grace you are saved through faith...
+    votd.to_html
     
-Full text of HTML formatted VotD looks like the following
+Which by default looks like the following:
 
     <p class="votd-text">For by grace you are saved through faith... it is not from works, so that no one can boast.</p>
     <p>
@@ -61,6 +65,44 @@ Full text of HTML formatted VotD looks like the following
 
 You can then use the provided CSS classes to style the VotD.
 
+You may also provide custom HTML text by using the `.custom_html` method with a block:
+    
+    votd.custom_html do |votd|
+      "<p>#{votd.reference} - #{votd.text} (#{votd.version})</p>"
+    end
+
+`votd.to_html` now outputs:
+
+    <p>John 3:16 - For God so loved... (KJV)</p>
+
+### Outputting Text
+
+You can use the built-in formatted Text:
+
+    votd.to_text
+    
+Which by default looks like the following:
+
+    For God so loved the world, that he gave his only begotten Son,
+    that whosoever believeth in him should not perish, but have
+    everlasting life. -- John 3:16 (KJV)
+    
+`.to_text` is also aliased to `.to_s`
+    
+You can provide custom Text formatting by using the `.custom_text` method with a block:
+
+    votd.custom_text do |votd|
+      "#{votd.reference}|#{votd.text}|#{votd.version}"
+    end
+    
+Which outputs:
+
+    John 3:16|For God so loved...|(KJV)
+    
+This returns the custom formatted text, or you can call the `.to_text` method
+when ready, and your custom text will be output.
+
+## Command Line
 For command-line usage see [here](https://github.com/doctorbh/votd/wiki/Shell-Tool)
 
 ## Documentation

data/bin/votd

@@ -7,9 +7,15 @@ require 'votd'
 
 votd = Votd::BibleGateway.new
 
-puts "===================================================="
-puts "          VERSE OF THE DAY for #{votd.date.to_s}"
-puts "===================================================="
-puts votd.text
-puts "#{votd.reference} (#{votd.version})"
+def banner(width = 78)
+  width = yield.size
+  puts "=" * width
+  puts yield
+  puts "=" * width
+end
 
+banner do
+  "VERSE OF THE DAY for #{votd.date.to_s}"
+end
+
+puts votd.to_text

data/lib/votd/base.rb

@@ -10,7 +10,7 @@ module Votd
     attr_reader :text
 
     # @example
-    #    votd.reference  # "Ephesians 2:8-9"
+    #   votd.reference  # "Ephesians 2:8-9"
     #
     # @return [String] the scripture reference.
     attr_reader :reference
@@ -22,12 +22,13 @@ module Votd
     attr_reader :date
 
     # @example
-    #     votd.version  # "NIV"
+    #   votd.version  # "NIV"
     # @return [String] the bible translation used for this VotD
     attr_reader :version
+    alias_method :translation, :version
 
     # @example
-    #    votd.copyright # "Brought to you by BibleGateway.com. Copyright (C) . All Rights Reserved."
+    #   votd.copyright # "Brought to you by BibleGateway.com. Copyright (C) . All Rights Reserved."
     # @return [String] any copyright information supplied by VotD provider
     attr_reader :copyright
 
@@ -38,10 +39,12 @@ module Votd
     # Initializes the class and retrieves the verse of the day.
     # @return [Base]
     def initialize
-      @text      = ""
-      @reference = ""
-      @copyright = nil
-      @date      = Date.today
+      @text        = ""
+      @reference   = ""
+      @copyright   = nil
+      @date        = Date.today
+      @custom_html = nil
+      @custom_text = nil
       get_votd
     end
 
@@ -53,16 +56,63 @@ module Votd
     #    </p>
     #
     # This should provide sufficient hooks to style the CSS. If this is not
-    # sufficient, you can build the HTML by hand using the individual data.
+    # sufficient, you can build the HTML by hand using the individual data,
+    # or use the {#custom_html} method to override the HTML format.
     #
     # @return [String] the VotD formatted as HTML
     def to_html
-      html =  "<p class=\"votd-text\">#{@text}</p>\n"
-      html << "<p>\n"
-      html << "<span class=\"votd-reference\"><strong>#{@reference}</strong></span>\n"
-      html << "<span class=\"votd-version\"><em>(#{@version})</em></span>\n"
-      html << "</p>\n"
-      html
+      default_html =  "<p class=\"votd-text\">#{@text}</p>\n"
+      default_html << "<p>\n"
+      default_html << "<span class=\"votd-reference\"><strong>#{@reference}</strong></span>\n"
+      default_html << "<span class=\"votd-version\"><em>(#{@version})</em></span>\n"
+      default_html << "</p>\n"
+      @custom_html ||= default_html
+    end
+
+    # Overrides the {#to_html} method with your own custom HTML. Use a block to specify your
+    # custom HTML.
+    # @example
+    #   votd.custom_html do |votd|
+    #     "<p>#{votd.reference} - #{votd.text} (#{votd.version})</p>"
+    #   end
+    #
+    #   # outputs:
+    #   # <p>John 3:16 - For God so loved... (KJV)</p>
+    #
+    # This returns the custom formatted HTML, or you can call the {#to_html} method
+    # when ready and your custom HTML will be output.
+    #
+    # @return [String] the VotD formatted as custom HTML
+    def custom_html
+      @custom_html = yield(self)
+    end
+
+    # Returns the Verse of the Day formatted as plain text. e.g.
+    #   For God so loved the world... -- John 3:16 (KJV)
+    #
+    # You can override this formatting with the {#custom_text} method.
+    # @return [String] the VotD formatted as plain text
+    def to_text
+      @custom_text ||= "#{@text} -- #{@reference} (#{@version})"
+    end
+    alias_method :to_s, :to_text
+
+    # Overrides the {#to_text} with your own custom text. Use a block to specify
+    # your custom text.
+    # @example
+    #   votd.custom_text do |votd|
+    #     "#{votd.reference}|#{votd.text}|#{votd.version}"
+    #   end
+    #
+    #   # outputs:
+    #   John 3:16|For God so loved...|(KJV)
+    #
+    # This returns the custom formatted text, or you can call the {#to_text} method
+    # when ready, and your custom text will be output.
+    #
+    # @return [String] the VotD formatted as custom text
+    def custom_text
+      @custom_text = yield(self)
     end
 
     protected
@@ -76,4 +126,4 @@ module Votd
     end
 
   end
-end
+end

data/lib/votd/version.rb

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

data/spec/fixtures/base/base.txt

@@ -0,0 +1 @@
+For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not perish, but have everlasting life. -- John 3:16 (KJV)

data/spec/fixtures/base/base_custom.html

@@ -0,0 +1 @@
+<p>John 3:16|For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not perish, but have everlasting life.|KJV</p>

data/spec/fixtures/base/base_custom.txt

@@ -0,0 +1 @@
+John 3:16|For God so loved the world, that he gave his only begotten Son, that whosoever believeth in him should not perish, but have everlasting life.|KJV

data/spec/fixtures/bible_gateway/bible_gateway.txt

@@ -0,0 +1 @@
+If we confess our sins, he is faithful and just and will forgive us our sins and purify us from all unrighteousness. -- 1 John 1:9 (NIV)

data/spec/fixtures/bible_gateway/bible_gateway_custom.html

@@ -0,0 +1 @@
+<p>1 John 1:9|If we confess our sins, he is faithful and just and will forgive us our sins and purify us from all unrighteousness.|NIV</p>

data/spec/fixtures/bible_gateway/bible_gateway_custom.txt

@@ -0,0 +1 @@
+1 John 1:9|If we confess our sins, he is faithful and just and will forgive us our sins and purify us from all unrighteousness.|NIV

data/spec/fixtures/netbible/netbible.txt

@@ -0,0 +1 @@
+For by grace you are saved through faith... it is not from works, so that no one can boast. -- Ephesians 2:8-9 (NETBible)

data/spec/fixtures/netbible/netbible_custom.html

@@ -0,0 +1 @@
+<p>Ephesians 2:8-9|For by grace you are saved through faith... it is not from works, so that no one can boast.|NETBible</p>

data/spec/fixtures/netbible/netbible_custom.txt

@@ -0,0 +1 @@
+Ephesians 2:8-9|For by grace you are saved through faith... it is not from works, so that no one can boast.|NETBible

data/spec/lib/votd/base_spec.rb

@@ -15,9 +15,10 @@ describe "Votd::Base" do
     end
   end
 
-  describe ".version" do
+  describe ".version / .translation" do
     it "returns the default bible version" do
-      votd.version.should == "KJV"
+      votd.translation.should == "KJV"
+      votd.version.should     == "KJV"
     end
   end
 
@@ -35,7 +36,39 @@ describe "Votd::Base" do
 
   describe ".to_html" do
     it "returns a HTML version" do
-      votd.to_html.should == File.read(fixture("base.html"))
+      votd.to_html.should == read_fixture("base/base.html")
     end
   end
-end
+
+  describe ".custom_html" do
+    it "returns custom HTML and overrides the default .to_html formatting" do
+      html_from_block = votd.custom_html do |votd|
+        "<p>#{votd.reference}|#{votd.text}|#{votd.version}</p>"
+      end
+      desired_output = read_fixture("base/base_custom.html")
+      html_from_block.should == desired_output
+      votd.to_html.should    == desired_output
+    end
+  end
+
+  describe ".to_text" do
+    it "returns a text-formatted version" do
+      votd.to_text.should == read_fixture("base/base.txt")
+    end
+
+    it "is aliased to .to_s" do
+      votd.to_s.should == read_fixture("base/base.txt")
+    end
+  end
+
+  describe ".custom_text" do
+    it "overrides the default.to_text formatting" do
+      text_from_block = votd.custom_text do |votd|
+        "#{votd.reference}|#{votd.text}|#{votd.version}"
+      end
+      desired_output = read_fixture("base/base_custom.txt")
+      text_from_block.should == desired_output
+      votd.to_text.should    == desired_output
+    end
+  end
+end

data/spec/lib/votd/bible_gateway_spec.rb

@@ -19,9 +19,10 @@ describe "Votd::BibleGateway" do
     end
   end
 
-  describe ".version" do
+  describe ".version / .translation" do
     it "returns the correct bible version" do
-      votd.version.should == "NIV"
+      votd.version.should     == "NIV"
+      votd.translation.should == "NIV"
     end
   end
 
@@ -39,7 +40,38 @@ describe "Votd::BibleGateway" do
 
   describe ".to_html" do
     it "returns a HTML version" do
-      votd.to_html.should == File.read(fixture("bible_gateway.html"))
+      votd.to_html.should == read_fixture("bible_gateway/bible_gateway.html")
     end
   end
-end
+
+  describe ".custom_html" do
+    it "overrides the default .to_html formatting" do
+      votd.custom_html do |votd|
+        "<p>#{votd.reference}|#{votd.text}|#{votd.version}</p>"
+      end
+      votd.to_html.should == read_fixture("bible_gateway/bible_gateway_custom.html")
+    end
+  end
+
+  describe ".to_text" do
+    it "returns a text-formatted version" do
+      votd.to_text.should == read_fixture("bible_gateway/bible_gateway.txt")
+    end
+
+    it "is aliased to .to_s" do
+      votd.to_s.should == read_fixture("bible_gateway/bible_gateway.txt")
+    end
+  end
+
+  describe ".custom_text" do
+    it "overrides the default.to_text formatting" do
+      text_from_block = votd.custom_text do |votd|
+        "#{votd.reference}|#{votd.text}|#{votd.version}"
+      end
+      desired_output = read_fixture("bible_gateway/bible_gateway_custom.txt")
+      text_from_block.should == desired_output
+      votd.to_text.should    == desired_output
+    end
+  end
+
+end

data/spec/lib/votd/netbible_spec.rb

@@ -20,9 +20,10 @@ describe "Votd::NETBible" do
     end
   end
 
-  describe ".version" do
+  describe ".version / .translation" do
     it "returns the correct bible version" do
-      votd.version.should == "NETBible"
+      votd.version.should     == "NETBible"
+      votd.translation.should == "NETBible"
     end
   end
 
@@ -40,7 +41,38 @@ describe "Votd::NETBible" do
 
   describe ".to_html" do
     it "returns a HTML version" do
-      votd.to_html.should == File.read(fixture("netbible.html"))
+      votd.to_html.should == read_fixture("netbible/netbible.html")
     end
   end
+
+  describe ".custom_html" do
+    it "overrides the default .to_html formatting" do
+      votd.custom_html do |votd|
+        "<p>#{votd.reference}|#{votd.text}|#{votd.version}</p>"
+      end
+      votd.to_html.should == read_fixture("netbible/netbible_custom.html")
+    end
+  end
+
+  describe ".to_text" do
+    it "returns a text-formatted version" do
+      votd.to_text.should == read_fixture("netbible/netbible.txt")
+    end
+
+    it "is aliased to .to_s" do
+      votd.to_s.should == read_fixture("netbible/netbible.txt")
+    end
+  end
+
+  describe ".custom_text" do
+    it "overrides the default.to_text formatting" do
+      text_from_block = votd.custom_text do |votd|
+        "#{votd.reference}|#{votd.text}|#{votd.version}"
+      end
+      desired_output = read_fixture("netbible/netbible_custom.txt")
+      text_from_block.should == desired_output
+      votd.to_text.should    == desired_output
+    end
+  end
+
 end

data/spec/spec_helper.rb

@@ -11,12 +11,16 @@ RSpec.configure do |config|
     File.join(File.dirname(__FILE__), 'fixtures', filename)
   end
 
+  def read_fixture(filename)
+    File.read(fixture(filename))
+  end
+
   # Register Bible Gateway URI
   FakeWeb.register_uri(:get, Votd::BibleGateway::URI,
-                       :body => open(fixture("bible_gateway.rss")))
+                       :body => open(fixture("bible_gateway/bible_gateway.rss")))
 
   # Register NETBible URI
   FakeWeb.register_uri(:get, Votd::NetBible::URI,
-                       :body => open(fixture("netbible.json")))
+                       :body => open(fixture("netbible/netbible.json")))
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: votd
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -183,11 +183,20 @@ files:
 - lib/votd/bible_gateway.rb
 - lib/votd/netbible.rb
 - lib/votd/version.rb
-- spec/fixtures/base.html
-- spec/fixtures/bible_gateway.html
-- spec/fixtures/bible_gateway.rss
-- spec/fixtures/netbible.html
-- spec/fixtures/netbible.json
+- spec/fixtures/base/base.html
+- spec/fixtures/base/base.txt
+- spec/fixtures/base/base_custom.html
+- spec/fixtures/base/base_custom.txt
+- spec/fixtures/bible_gateway/bible_gateway.html
+- spec/fixtures/bible_gateway/bible_gateway.rss
+- spec/fixtures/bible_gateway/bible_gateway.txt
+- spec/fixtures/bible_gateway/bible_gateway_custom.html
+- spec/fixtures/bible_gateway/bible_gateway_custom.txt
+- spec/fixtures/netbible/netbible.html
+- spec/fixtures/netbible/netbible.json
+- spec/fixtures/netbible/netbible.txt
+- spec/fixtures/netbible/netbible_custom.html
+- spec/fixtures/netbible/netbible_custom.txt
 - spec/lib/votd/base_spec.rb
 - spec/lib/votd/bible_gateway_spec.rb
 - spec/lib/votd/netbible_spec.rb
@@ -220,11 +229,20 @@ signing_key:
 specification_version: 3
 summary: Generate a (Bible) Verse of the Day using various web service wrappers
 test_files:
-- spec/fixtures/base.html
-- spec/fixtures/bible_gateway.html
-- spec/fixtures/bible_gateway.rss
-- spec/fixtures/netbible.html
-- spec/fixtures/netbible.json
+- spec/fixtures/base/base.html
+- spec/fixtures/base/base.txt
+- spec/fixtures/base/base_custom.html
+- spec/fixtures/base/base_custom.txt
+- spec/fixtures/bible_gateway/bible_gateway.html
+- spec/fixtures/bible_gateway/bible_gateway.rss
+- spec/fixtures/bible_gateway/bible_gateway.txt
+- spec/fixtures/bible_gateway/bible_gateway_custom.html
+- spec/fixtures/bible_gateway/bible_gateway_custom.txt
+- spec/fixtures/netbible/netbible.html
+- spec/fixtures/netbible/netbible.json
+- spec/fixtures/netbible/netbible.txt
+- spec/fixtures/netbible/netbible_custom.html
+- spec/fixtures/netbible/netbible_custom.txt
 - spec/lib/votd/base_spec.rb
 - spec/lib/votd/bible_gateway_spec.rb
 - spec/lib/votd/netbible_spec.rb