alexvollmer-word_salad 0.9.0

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.9.0 / 2008-09-09
+
+* Happy Birthday Word Salad!

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/word_salad.rb
+spec/word_salad_spec.rb

data/README.txt

@@ -0,0 +1,58 @@
+= 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 gems 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.
+
+    require 'rubygems'
+    require 'word_salad'
+
+    include WordSalad
+
+    words(3) ==> ['draw', 'ameliorate', 'bonanza']
+    sentences(2) ==> ['Shoot jonesing the make castle.', 'Blue murdered slight bastion.']
+    paragraphs(2) ==> []
+
+WordSalad is a module, so including it in your class will activate
+WordSalad's latent, random-generation super-powers in your class.
+
+== 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/Rakefile

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/word_salad.rb'
+
+Hoe.new('WordSalad', WordSalad::VERSION) do |p|
+  # p.rubyforge_name = 'WordSaladx' # if different than lowercase project name
+  p.name = 'word_salad'
+  p.developer('Alex Vollmer', 'alex.vollmer@gmail.com')
+  p.description = p.paragraphs_of('README.txt', 3..3).join("\n\n")
+  p.summary = 'Generate strings of random English text'
+  p.url = 'http://livollmers.net'
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_dev_deps << ["rspec", ">=1.1.1"]
+end
+
+require "spec/rake/spectask"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+# vim: syntax=Ruby

data/lib/word_salad.rb

@@ -0,0 +1,51 @@
+module WordSalad
+  VERSION = '0.9.0'
+
+  # Returns +num+ random words from the dictionary.
+  def words(num)
+    unless @dict
+	if FileTest.exists?("/usr/share/dict/words")
+        @dict = open("/usr/share/dict/words")
+	elsif FileTest.exists?("/usr/share/words")
+	  @dict = open("/usr/share/words")
+      else
+        raise "No dictionary file found!"
+      end
+      @size = File.size(@dict)
+    end
+
+    (1..num).to_a.map do |x|
+      @dict.seek(rand(@size - 1000))
+      b = @dict.readchar
+      while b != 10
+        b = @dict.readchar
+      end
+
+      @dict.readline.strip
+    end
+  end
+
+  # Returns +num+ sentences of random words around +size+
+  # number of words.
+  def sentences(num, size=10)
+    variance = size / 5
+    (1..num).to_a.map do |x|
+      w = words(size + (rand(variance) - variance / 2))
+      w[0].capitalize!
+      w.join(' ') + '.'
+    end
+  end
+
+  # Returns +num+ paragraphs of around +psize+ sentences,
+  # each around +ssize+ number of words
+  def paragraphs(num, psize=5, ssize=10)
+    (1..num).to_a.map do |x|
+      sentences(psize).join(' ')
+    end
+  end
+
+  protected
+  def dictionary
+    # TODO: figure out all the places dictionary files go
+  end
+end

data/spec/word_salad_spec.rb

@@ -0,0 +1,47 @@
+require "rubygems"
+require "spec"
+require File.join(File.dirname(__FILE__), "../lib/word_salad")
+
+include WordSalad
+
+describe WordSalad do
+  describe "generating random words" do
+    it "should return an array of the right size" do
+      w = words(5)
+      w.should be_kind_of(Array)
+      w.size.should eql(5)
+      w.each do |word|
+        word.should be_kind_of(String)
+      end
+    end
+  end
+
+  describe "generating random sentences" do
+    it "should return an array of sentences" do
+      s = sentences(5)
+      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
+  end
+
+  describe "generating random paragraphs" do
+    it "should return an array of paragraphs" do
+      p = paragraphs(5)
+      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
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: alexvollmer-word_salad
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Alex Vollmer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: "== SYNOPSIS:"
+email: 
+- alex.vollmer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/word_salad.rb
+- spec/word_salad_spec.rb
+has_rdoc: true
+homepage: http://livollmers.net
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: wordsalad
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Generate strings of random English text
+test_files: []
+