haikuable 0.0.2 → 0.1.0

data/README.md

@@ -1,19 +1,27 @@
 # Haikuable
 
 > Garth: "Does anyone else find this weird? I mean, we're looking down on Wayne's basement. Only that's not Wayne's basement. Isn't that weird?"
+>
 > Everyone: "That's weird…"
+>
 > Wayne: "Garth, that was a haiku!"
 
-True to the simplicity and elegance of the Japanese poetic form, haikuable is a very simple gem. It has a single method. It takes a string, and returns a boolean based on whether or not that string is a haiku.
+<cite>[Wayne's World](http://www.imdb.com/title/tt0105793/?ref_=nv_sr_1), 1992</cite>
+
+True to the simplicity and elegance of the [Japanese poetic form](http://en.wikipedia.org/wiki/Haiku), haikuable is a very simple gem. It has a single method. It takes a string, and returns a boolean based on whether or not that string is a haiku.
+
+Currently, `haikuable` only supports the traditional 5, 7, 5 haiku format. If you need configurability, feel free to [file an issue](https://github.com/thenickcox/haikuable).
 
 ## Usage
 
+Require the gem, and call `is_haiku?` on a string.
+
 ```bash
 >> require 'haikuable'
 => true
 >> poem = 'at the age old pond a frog leaps into water a deep resonance'
 => "at the age old pond a frog leaps into water a deep resonance"
->> Haikuable::Checker.new(poem).is_haiku?
+>> poem.is_haiku?
 => true
 ```
 

data/lib/haikuable.rb

@@ -9,6 +9,7 @@ module Haikuable
     def initialize(string)
       @string      = string
       @line_counts = { line1: 0, line2: 0, line3: 0 }
+      raise ArgumentError.new('must be called on a string') unless string.is_a?(String)
     end
 
     def is_haiku?
@@ -43,3 +44,9 @@ module Haikuable
 
   end
 end
+
+class String
+  def is_haiku?
+    Haikuable::Checker.new(self).is_haiku?
+  end
+end

data/lib/haikuable/version.rb

@@ -1,3 +1,3 @@
 module Haikuable
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/lib/haikuable_spec.rb

@@ -4,6 +4,13 @@ describe Haikuable::Checker do
   describe '#is_haiku?' do
     subject { Haikuable::Checker.new(string).is_haiku? }
 
+    context 'not a string' do
+      let(:string) { 7 }
+      it 'raises an error' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+
     context 'not 17 syllables' do
       context 'too few' do
         let(:string) { 'I like cheese' }
@@ -31,4 +38,9 @@ describe Haikuable::Checker do
       it { should be_true }
     end
   end
+
+  context 'string method' do
+    subject { 'puppies and kittens'.is_haiku? }
+    it { should be_false }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haikuable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-26 00:00:00.000000000 Z
+date: 2014-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler