random-word 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 OpenLogic, Peter Williams
+
+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/README.markdown

@@ -0,0 +1,30 @@
+random-word
+====
+
+A random word generator intended for use in test data factories.  This
+library uses a large list (the wordnet corpus) of english words and
+provides an enumerator interface to that corpus that will return the
+words in a random order without repeats.
+
+Contributing to random-word
+----
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Update history
+* Update version (remember to use [semantic versioning][semver])
+* Commit and push
+* Send me a pull request. Bonus points for topic branches.
+
+[semver]:http://semver.org/ 
+
+Copyright
+----
+
+Copyright (c) 2011 OpenLogic, Peter Williams. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "random-word"
+  gem.homepage = "http://github.com/pezra/random-word"
+  gem.license = "MIT"
+  gem.summary = %Q{Pick random words for factory data}
+  gem.description = %Q{A random word generator intended for use in test data factories.  This library uses a large list (the wordnet corpus) of english words and provides an enumerator interface to that corpus that will return the words in a random order without repeats.}
+  gem.email = "pezra@barelyenough.org"
+  gem.authors = ["Peter Williams"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/random-word.rb

@@ -0,0 +1 @@
+require 'random_word'

data/lib/random_word.rb

@@ -0,0 +1,55 @@
+require 'set'
+
+module RandomWord
+  module EachRandomly
+    def each_randomly(&blk)
+      used = Set.new
+      
+      while true
+        idx = next_unused_idx(used)
+        used << idx
+        yield at(idx)
+      end
+
+    rescue OutOfWords
+      # we are done.
+    end
+    
+    private
+    def next_unused_idx(used)
+      idx = rand(length)
+      try = 1
+      while used.include?(idx)
+        raise OutOfWords if try > 1000
+        idx = rand(length)
+        try += 1
+      end 
+      
+      idx
+    end
+    class OutOfWords < Exception; end
+  end
+
+  class << self
+    def enumerator(word_list)
+      word_list.extend EachRandomly
+      Enumerator.new(word_list, :each_randomly)
+    end
+
+
+    def nouns
+      @nouns ||= enumerator(load_word_list("nouns.dat"))
+    end
+
+    def adjs
+      @adjs ||= enumerator(load_word_list("adjs.dat"))
+    end
+
+    protected
+    def load_word_list(name)
+      data_root = Pathname(File.dirname(__FILE__)) + "../data"
+      File.open(data_root + name){|f| Marshal.load(f)}
+    end
+  end
+end
+

data/spec/random-word_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RandomWord" do
+  it "defines the module" do 
+    defined?(RandomWord).should be_true
+  end
+end

data/spec/random_word_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+describe RandomWord, "enumerator" do 
+  subject {RandomWord.enumerator(["aaa", "bbb", "ccc"])}
+
+  it "can get you the next word in it's list" do 
+    subject.next.should be_one_of(["aaa", "bbb", "ccc"])
+  end
+
+  it "raises error when it runs out of words" do 
+    3.times{subject.next}
+
+    lambda{subject.next}.should raise_error(StopIteration)
+  end
+
+  # This test might pass sometimes even if the code it wrong.  It if
+  # ever fails it is a serious issue and this test should be run
+  # multiple times before deciding the issue has been fixed. 
+  it "should only return a word one time" do 
+    already_received = []
+    3.times do
+      (new_word = subject.next).should_not be_one_of(already_received)
+      already_received << new_word
+    end
+  end
+end
+
+describe RandomWord do 
+  it "can return a random noun enumerator" do 
+    RandomWord.nouns.should respond_to(:next)
+  end
+
+  it "can return a random adj enumerator" do 
+    RandomWord.adjs.should respond_to(:next)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'random-word'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/support/matchers.rb

@@ -0,0 +1,6 @@
+RSpec::Matchers.define :be_one_of do |expected|
+  match do |actual|
+    expected.any?{|exp_val| exp_val === actual}
+  end
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: random-word
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Peter Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: A random word generator intended for use in test data factories.  This library uses a large list (the wordnet corpus) of english words and provides an enumerator interface to that corpus that will return the words in a random order without repeats.
+email: pezra@barelyenough.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- data/adjs.dat
+- data/nouns.dat
+- lib/random-word.rb
+- lib/random_word.rb
+- spec/random-word_spec.rb
+- spec/random_word_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers.rb
+homepage: http://github.com/pezra/random-word
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2610495265960102185
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Pick random words for factory data
+test_files: []
+