wordy 0.1.0 → 1.0.0

data/.travis.yml

@@ -1,4 +1,5 @@
 rvm:
   - 1.9.2
+  - 1.9.3
 
 script: "ruby -Ilib -Itest test/test_wordy.rb"

data/README.md

@@ -1,12 +1,18 @@
 # Wordy [![Build Status](https://secure.travis-ci.org/citrus/wordy.png)](http://travis-ci.org/citrus/wordy)
 
-Wordy speaks lorem ipsum. You can ask Wordy for a paragraphs, sentences or words.
+### Wordy speaks lorem ipsum. You can ask Wordy for paragraphs, sentences or words. 
+
+Wordy was written to help us create sample data in our applications. Yes, there are already a ton of gems (17 as of 2011/11/5) that show up when [searching](http://rubygems.org/search?utf8=✓&query=lorem+ipsum) for 'lorem ipsum' on [rubygems](http://rubygems.org/)... so why another? 
+
+I guess the short answer is I wasn't happy with some of the other solutions. Many had poor documentation or methods and modules that I didn't need. I just wanted simple.
+
+That's what Wordy delivers... simplicity. There are no runtime dependencies, monkey patches or unnecessary methods. Just [45 lines](https://github.com/citrus/wordy/blob/master/lib/wordy.rb) of the basics.
 
 
 Usage
 -----
 
-Using wordy is simple. Here's the rundown:
+Using wordy is easy. Here's the rundown in [irb](http://en.wikipedia.org/wiki/Interactive_Ruby_Shell):
 
     $ require 'wordy'
      => true 
@@ -18,7 +24,7 @@ Using wordy is simple. Here's the rundown:
      => ["nobis", "laborum", "commodi"] 
 
     $ Wordy.sentence
-     => "Libero necessitatibus dolore et dicta." 
+     => "Libero necessitatibus dolore et dicta."
 
     $ Wordy.sentences
      => ["Error omnis possimus autem magni quae natus exercitationem sit fuga recusandae maiores odit.", "Perspiciatis sed nisi neque pariatur voluptas quia repudiandae quas consequatur dolore.", "Magni nam quae quas enim est qui.", "Fuga aut vitae soluta sit et laborum est est illo sequi.", "Veritatis velit exercitationem nihil sed perferendis iusto ut voluptate consequatur cum molestiae.", "Fugit exercitationem velit dolorem vel qui delectus atque officia."] 
@@ -31,7 +37,70 @@ Using wordy is simple. Here's the rundown:
 
     $ Wordy.body
      => "Aperiam ea voluptatem nostrum qui fuga et molestias quibusdam consequuntur non sed qui culpa. Incidunt minima similique repellendus distinctio debitis blanditiis ratione architecto.\n\nAliquid non excepturi voluptatem nobis laudantium. Corrupti ut aut autem sed quia ducimus eligendi eum maxime voluptas suscipit.\n\nDolor fuga est voluptas cupiditate vel quaerat consequuntur velit corrupti. Unde quod quia est nihil est nisi quo officiis nobis. Est similique ea dolorum natus. Odio voluptate facere cupiditate quo autem quod doloremque expedita delectus cum accusamus consequuntur ut.\n\nDignissimos quia blanditiis sit quis voluptates et optio maiores tenetur quia. Non aperiam quos eligendi voluptas est animi voluptatum sequi impedit. Impedit repudiandae officiis magni quia qui explicabo voluptas saepe delectus illo aliquid qui. Sunt minus sint quam omnis sed blanditiis." 
-  
+
+
+That's it!
+
+
+### Taking it farther
+
+Let's get fancy. But let's keep it simple.
+
+If I were building an app that had, say, user accounts, it might make sense to create a seed helper like the module below.
+
+    require 'wordy'
+    
+    module Seeder
+    
+      include Wordy
+      extend self
+      
+      def username
+        Wordy.words(3).join("-")
+      end
+      
+      def email
+        [ Seeder.username, "@", Seeder.username, "-", rand(100), ".com" ].join 
+      end
+      
+      def domain
+        [ Seeder.username, ".com" ].join 
+      end
+      
+      def url
+        [ "http://", Seeder.domain ].join 
+      end
+      
+    end
+
+    
+This will allow me to do the following:
+
+    $ require 'seeder'
+     => true 
+    
+    $ Seeder.username
+     => "commodi-placeat-nobis" 
+    
+    $ Seeder.email
+     => "animi-facilis-dolores@eum-sed-est-56.com" 
+    
+    $ Seeder.domain
+     => "qui-accusamus-voluptatum.com" 
+    
+    $ Seeder.url
+     => "http://est-omnis-voluptatibus.com" 
+
+
+All of the original methods will also be available to the Seeder module:
+
+    $ Seeder.words
+     => ["est", "fugiat", "possimus", "non", "labore", "magnam"]
+
+
+You can use a helper module like Seeder in any app and put it anywhere. In rails, I like to keep it in `db/seeder.rb`.
+
+
  
 Installation
 ------------
@@ -42,7 +111,7 @@ As usual, just use the `gem install` command:
     
 Or add wordy as a gem in your Gemfile:
 
-    gem 'wordy', '~> 0.1.0' 
+    gem 'wordy', '~> 0.2.0' 
 
 Then run `bundle install`
 
@@ -50,7 +119,7 @@ Then run `bundle install`
 Requirements
 ------------
 
-Wordy has zero dependencies! All it requires is Ruby >= 1.9.
+Other than rake and bundler for development, Wordy has zero gem dependencies! All it requires is Ruby >= 1.9.2.
 
 
 Testing
@@ -58,7 +127,8 @@ Testing
 
 Testing is done with minitest. Run the tests with:
 
-    ruby -Ilib -Itest test/test_wordy.rb
+    rake
+    
 
 
 License

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new
+
+task :default => [ :test ]

data/lib/wordy/version.rb

@@ -1,3 +1,3 @@
 module Wordy
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/test/test_wordy.rb

@@ -11,32 +11,84 @@ class TestWordy < MiniTest::Unit::TestCase
     assert_equal Array, Wordy::WORDS.class
   end
 
-  def test_single_word
+  def test_single_word_has_no_spaces
     refute_match /\s/, Wordy.word
   end
-
+  
+  def test_single_word_is_string
+    assert_equal String, Wordy.word.class
+  end
+  
+  def test_single_word_is_not_blank
+    assert 1 < Wordy.word.length
+  end
+  
+  def test_single_word_is_random
+    assert Wordy.word != Wordy.word
+  end
+  
   def test_words
     assert_equal Array, Wordy.words.class
   end
+  
+  def test_words_contain_strings
+    assert_equal String, Wordy.words.first.class
+  end
+  
+  def test_words_are_random
+    assert Wordy.words != Wordy.words
+  end
 
-  def test_sentance
+  def test_sentence
     assert_match /^[A-Z].*\.$/, Wordy.sentence
   end
-
+  
+  def test_sentence_has_length
+    assert 5 < Wordy.sentence.length
+  end
+  
+  def test_sentence_is_random
+    assert Wordy.sentence != Wordy.sentence
+  end
+  
   def test_sentences
     assert_equal Array, Wordy.sentences.class
   end
+
+  def test_sentences_contain_strings
+    assert_equal String, Wordy.sentences.first.class
+  end
+  
+  def test_sentences_are_random
+    assert Wordy.sentences != Wordy.sentences
+  end
   
   def test_paragraph
     assert_match /^([A-Z][a-z\s]+\.\s?){2,}$/, Wordy.paragraph
   end
   
+  def test_paragraph_is_random
+    assert Wordy.paragraph != Wordy.paragraph
+  end
+  
   def test_paragraphs
     assert_equal Array, Wordy.paragraphs.class
   end
   
+  def test_paragraphs_contain_strings
+    assert_equal String, Wordy.paragraphs.first.class
+  end
+  
+  def test_paragraphs_are_random
+    assert Wordy.paragraphs != Wordy.paragraphs
+  end
+  
   def test_body
     assert_match /^([A-Z][a-z\s]+\.\s?){2,}$/, Wordy.body
   end
   
+  def test_body_is_random
+    assert Wordy.body != Wordy.body
+  end
+  
 end

data/wordy.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Spencer Steffen"]
   s.email       = ["spencer@citrusme.com"]
   s.homepage    = "https://github.com/citrus/wordy"
-  s.summary     = %q{Wordy speaks lorem ipsum. You can ask Wordy for a paragraphs, sentences or words.}
-  s.description = %q{Wordy speaks lorem ipsum. You can ask Wordy for a paragraphs, sentences or words. Please see readme for more information.}
+  s.summary     = %q{Written to help us create sample data for our applications, Wordy speaks in lorem ipsum. You can ask Wordy for paragraphs, sentences or words.}
+  s.description = %q{Written to help us create sample data for our applications, Wordy speaks in lorem ipsum. You can ask Wordy for paragraphs, sentences or words. Please see documentation for more information.}
 
   s.rubyforge_project = "wordy"
 
@@ -21,4 +21,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_development_dependency("bundler", ">= 0")
+  s.add_development_dependency("rake",    ">= 0")
+  
 end

metadata

@@ -2,7 +2,7 @@
 name: wordy
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Spencer Steffen
@@ -10,10 +10,31 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-07 00:00:00 Z
-dependencies: []
-
-description: Wordy speaks lorem ipsum. You can ask Wordy for a paragraphs, sentences or words. Please see readme for more information.
+date: 2011-11-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Written to help us create sample data for our applications, Wordy speaks in lorem ipsum. You can ask Wordy for paragraphs, sentences or words. Please see documentation for more information.
 email: 
 - spencer@citrusme.com
 executables: []
@@ -59,6 +80,6 @@ rubyforge_project: wordy
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Wordy speaks lorem ipsum. You can ask Wordy for a paragraphs, sentences or words.
+summary: Written to help us create sample data for our applications, Wordy speaks in lorem ipsum. You can ask Wordy for paragraphs, sentences or words.
 test_files: 
 - test/test_wordy.rb