word-salad 1.0.0

data/README.txt

@@ -0,0 +1,69 @@
+= Word Salad
+
+== DESCRIPTION:
+
+Word Salad is a very simple Ruby library for generating random strings
+of English words based on the Unix dictionary file. The gem does its
+best to figure out where your particular dictionary file is, but on
+some systems may need a little help.
+
+== SYNOPSIS:
+
+Generating random data is helpful for all kinds of testing. You could
+just generate random gobble-dee-gook, but why not generate something
+that looks a bit English-like? If for no other reason, you'll find great
+enjoyment in all of the potential band-names that this gem generates.
+
+WordSalad adds three methods to the <tt>Fixnum</tt> class to do things
+like this:
+
+    require 'rubygems'
+    require 'word_salad'
+
+    3.words ==> ['draw', 'ameliorate', 'bonanza']
+    2.sentences ==> ['Shoot jonesing the make castle.', 'Blue murdered slight bastion.']
+    2.paragraphs ==> ["Brachypterous gastropod pheretrer overeager toploftily denaturalization stokesite demented benzalhydrazine archaeologic. Haverer hypophonous lenticularly brickliner urocele paucipinnate pik unprintably perhalogen. Subglenoid bearish gesticulative staircase gallop vesuvianite pneumatically overyear conterminous dreamish. Nonalliterated galliwasp superconfirmation Comandra entoil millionth parcellize rarefaction Cynoidea. Podolian metamorphosable nativeness integriously protonematoid undoctor stochastically dissatisfactory unchastity.", "Increate unloquacious unsatisfiedly flareboard internuncio beguine equivocation snowshoe Rhynchonellacea. Parochially curliewurly vermix consistorial cond consciencelessness Anaxagorize recoct sempiternally Campanulatae. Scorpionida Castalides homoanisic semipenniform Novemberish assessor preterlethal acrotarsial knoller hartin. Procrastination boatwise canonize differentiate faunlike countermarriage obstinance dilatableness drumloid. Gerate squirr Silvanus Physostigma booting thyroarytenoid diminutival legpuller medisance radiobserver."]
+
+== CUSTOMIZATION
+
+WordSalad relies on the presence of a valid Unix dictionary file. It
+will do it's best to figure out where one is, but doesn't account for
+every platform. If you are one of those special people that has a
+dictionary file in a place WordSalad can't find, you can tell it by
+calling <tt>dictionary_path</tt> attribute setter method.
+
+     require 'rubygems'
+     require 'word_salad'
+
+     WordSalad.dictionary_path = "/my/special/dictionary/path"
+
+== INSTALL:
+
+To install Word Salad, simply:
+
+    sudo gem install word_salad
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Alex Vollmer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/word_salad.rb

@@ -0,0 +1,27 @@
+require "word_salad/core_ext"
+
+class WordSalad
+
+  # The current dictionary path
+  def self.dictionary_path
+    @dictionary_path ||= ["/usr/share/dict/words",
+                        "/usr/share/words"].select do |f|
+      FileTest.exists?(f)
+    end.first
+  end
+
+  # Override the default dictionary path to something special
+  def self.dictionary_path=(path)
+    @dictionary_path = path
+    @size = nil
+  end
+
+  def self.dictionary # :nodoc:
+    open(self.dictionary_path)
+  end
+
+  def self.size  # :nodoc:
+    @size ||= File.size(self.dictionary)
+  end
+
+end

data/lib/word_salad/core_ext.rb

@@ -0,0 +1,42 @@
+class Fixnum
+
+  # Returns +num+ random words from the dictionary.
+  def words
+    dict = WordSalad.dictionary
+    (1..self).to_a.map do |x|
+      dict.seek(rand(WordSalad.size - 1000))
+      b = dict.readchar
+      while b != 10
+        b = dict.readchar
+      end
+
+      dict.readline.strip
+    end
+  end
+
+  alias :word :words
+
+  # Returns +num+ sentences of random words around +size+
+  # number of words.
+  def sentences(size=10)
+    variance = size / 5
+    (1..self).to_a.map do |x|
+      w = (size + (rand(variance) - variance / 2)).words
+      w[0].capitalize!
+      w.join(' ') + '.'
+    end
+  end
+
+  alias :sentence :sentences
+
+  # Returns +num+ paragraphs of around +psize+ sentences,
+  # each around +ssize+ number of words
+  def paragraphs(psize=5, ssize=10)
+    (1..self).to_a.map do |x|
+      psize.sentences.join(' ')
+    end
+  end
+
+  alias :paragraph :paragraphs
+end
+

data/spec/word_salad_spec.rb

@@ -0,0 +1,98 @@
+require "fileutils"
+require "tempfile"
+require "rubygems"
+require "spec"
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require "word_salad"
+
+describe WordSalad do
+  describe "generating random words" do
+    it "should return an array of the right size" do
+      w = 5.words
+      w.should be_kind_of(Array)
+      w.size.should eql(5)
+      w.each do |word|
+        word.should be_kind_of(String)
+      end
+    end
+
+    it "should respond to the singular version too" do
+      w = 1.word
+      w.should be_kind_of(Array)
+      w.size.should == 1
+      w.first.should be_kind_of(String)
+    end
+  end
+
+  describe "generating random sentences" do
+    it "should return an array of sentences" do
+      s = 5.sentences
+      s.should be_kind_of(Array)
+      s.size.should == 5
+      s.each do |sent|
+        sent.should be_kind_of(String)
+        sent.should match(/^[A-Z].*\.$/)
+        sent.split(' ').size.should be_close(10, 2)
+      end
+    end
+
+    it "should respond to the singular version too" do
+      s = 1.sentence
+      s.should be_kind_of(Array)
+      s.size.should == 1
+    end
+  end
+
+  describe "generating random paragraphs" do
+    it "should return an array of paragraphs" do
+      p = 5.paragraphs
+      p.should be_kind_of(Array)
+      p.size.should == 5
+      p.each do |para|
+        para.should be_kind_of(String)
+        s = para.split('.')
+        s.size.should == 5
+        s.each do |sent|
+          sent.split(' ').size.should be_close(10, 2)
+        end
+      end
+    end
+
+    it "should respond to singular version too" do
+      p = 1.paragraph
+      p.should be_kind_of(Array)
+      p.size.should == 1
+    end
+  end
+
+  describe 'overriding the default dictionary path' do
+    before(:each) do
+      @tmpfile = Tempfile.new "word_salad"
+      2000.times { @tmpfile << "alpha\n" }
+      @tmpfile.close
+      WordSalad.dictionary_path = @tmpfile.path
+    end
+
+    it 'should work for words' do
+      w = 5.words
+      w.each { |e| e.should == "alpha" }
+    end
+
+    it 'should work for sentences' do
+      s = 5.sentences
+      s.each do |sent|
+        sent.split(' ').each { |e| e.downcase.should match(/alpha/) }
+      end
+    end
+
+    it 'should work for paragraphs' do
+      p = 5.paragraphs
+      p.each do |para|
+        para.split('.').each do |sent|
+          sent.split(' ').each { |e| e.downcase.should match(/alpha/) }
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: word-salad
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Alex Vollmer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-07 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Word Salad is a very simple Ruby library for generating random strings of English words based on the Unix dictionary file.
+email: alex.vollmer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- lib/word_salad.rb
+- lib/word_salad/core_ext.rb
+- spec/word_salad_spec.rb
+- README.txt
+has_rdoc: true
+homepage: http://github.com/alexvollmer/word_salad
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Generate strings of random English text
+test_files: 
+- spec/word_salad_spec.rb