random-word 1.2.0 → 1.3.0

data/HISTORY.markdown

@@ -1,3 +1,7 @@
+1.3
+----
+ * Added exclude patterns. This makes it easy to prevent words with certain patterns from being returned.
+
 1.2
 ----
  * random phrase enumerator

data/README.markdown

@@ -6,30 +6,51 @@ 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.
 
-Examples
+Usage
 ----
 
-### General use
+You can get a random word any where you need one. Just request the
+next of which ever word flavor you prefer.
 
-    Random.adjs.next  #=> "pugnacious"
-    Random.nouns.next #=> "audience"
+    RandomWord.adjs.next  #=> "pugnacious"
+    RandomWord.nouns.next #=> "audience"
     
 ### Factory Girl
 
+This library was first developed to use in factories. It can be used
+with Factory Girl like this.
+
     Factory.define(:user) do |u|
       u.name  "#{RandomWord.adjs.next} User"
       u.email {|u| "#{u.name.gsub(/ +/, '.')}@example.com"
     end
 
-    Factory(:user) #=> 
+    Factory(:user) #=> ...
 
 ### Machinist
 
+
+For Machinist a `#sw` (short for serial word) method is provided. It works exactly like `#sn`
+but it returns a string instead of a number.
+
     User.blueprint do 
       name  { "#{sw.capitalize} User" }
       email { "#{sw}.user@example.com" }
     end
 
+Exclusion
+----
+
+Words may be excluded by pattern, or exact match. To do this just add
+an object that responds to `#===` to the exclude list.
+
+    RandomWord.exclude_list << /fo+/
+    RandomWord.exclude_list << 'bar'
+
+This will prevent the return of the exact string `"bar"` and any word
+which matches the regex `/fo+/`.
+
+
 Contributing to random-word
 ----
  

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/lib/random_word.rb

@@ -8,13 +8,17 @@ require 'pathname'
 #
 module RandomWord
   module EachRandomly
+    attr_accessor :random_word_exclude_list
+
     def each_randomly(&blk)
       used = Set.new
-
+      exclude_list = Array(@random_word_exclude_list)
       while true
         idx = next_unused_idx(used)
         used << idx
-        yield at(idx)
+        word = at(idx)
+        next if exclude_list.any?{|r| r === word }
+        yield word
       end
 
     rescue OutOfWords
@@ -37,15 +41,18 @@ module RandomWord
   end
 
   class << self
+    def exclude_list
+      @exclude_list ||= []
+    end
 
     # @return [Enumerator] Random noun enumerator
     def nouns
-      @nouns ||= enumerator(load_word_list("nouns.dat"))
+      @nouns ||= enumerator(load_word_list("nouns.dat"), exclude_list)
     end
 
     # @return [Enumerator] Random adjective enumerator
     def adjs
-      @adjs ||= enumerator(load_word_list("adjs.dat"))
+      @adjs ||= enumerator(load_word_list("adjs.dat"), exclude_list)
     end
 
     # @return [Enumerator] Random phrase enumerator
@@ -61,9 +68,10 @@ module RandomWord
 
     # Create a random, non-repeating enumerator for a list of words
     # (or anything really).
-    def enumerator(word_list)
+    def enumerator(word_list, list_of_regexs_or_strings_to_exclude = [])
       word_list.extend EachRandomly
-      Enumerator.new(word_list, :each_randomly)
+      word_list.random_word_exclude_list = list_of_regexs_or_strings_to_exclude
+      word_list.enum_for(:each_randomly)
     end
 
     protected

data/spec/random_word_spec.rb

@@ -3,7 +3,7 @@ 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 
+  it "can get you the next word in its list" do
     subject.next.should be_one_of(["aaa", "bbb", "ccc"])
   end
 
@@ -13,10 +13,7 @@ describe RandomWord, "enumerator" do
     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 
+  it "make sure each word is only returned once" do 
     already_received = []
     3.times do
       (new_word = subject.next).should_not be_one_of(already_received)
@@ -26,6 +23,10 @@ describe RandomWord, "enumerator" do
 end
 
 describe RandomWord do 
+  after(:all) do
+    RandomWord.instance_eval{ @nouns, @adjs = nil, nil } # reset rspec effects
+  end
+
   it "can return a random noun enumerator" do 
     RandomWord.nouns.should respond_to(:next)
   end
@@ -38,3 +39,54 @@ describe RandomWord do
     RandomWord.phrases.next.should be_a(String)
   end
 end
+
+describe RandomWord, "#exclude" do
+  let(:word_list) { ["aaa","ccc","c", "cab", "abc", "ace", "dad"] }
+
+  [
+    {:name => "normal words", :exclude => "ccc", :expected => Set.new(["aaa","c", "cab", "abc", "ace", "dad"])},
+    {:name => "regex", :exclude => /c/, :expected => Set.new(["aaa", "dad"])},
+    {:name => "list", :exclude => [/c/,/d/], :expected => Set.new(["aaa"])},
+  ].each do |rec|
+    it "will not return an excluded #{rec[:name]}" do
+      subject = RandomWord.enumerator(word_list, rec[:exclude])
+
+      received_words = []
+      loop do
+        received_words << subject.next
+      end rescue StopIteration
+
+      Set.new(received_words).should == rec[:expected]
+    end
+  end
+
+end
+
+describe "RandomWord#nouns", "with exclusions" do
+
+  subject{ RandomWord.nouns }
+
+  before(:each) do
+    RandomWord.should_receive(:load_word_list).and_return(["aaa","bbb", "ccc"])
+  end
+
+  after(:each) do
+    RandomWord.exclude_list.clear
+    RandomWord.instance_eval{ @nouns, @adjs = nil, nil } # reset rspec effects
+  end
+
+  it "will not return an excluded word" do
+    RandomWord.exclude_list << "ccc"
+
+    received_words = []
+    loop do
+      received_words << subject.next
+    end
+
+    received_words.should_not include "ccc"
+    received_words.should include "aaa"
+    received_words.should include "bbb"
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: random-word
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-02 00:00:00.000000000 -06:00
+date: 2012-01-12 00:00:00.000000000 -07:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2158885620 !ruby/object:Gem::Requirement
+  requirement: &2155118380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2158885620
+  version_requirements: *2155118380
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2158885140 !ruby/object:Gem::Requirement
+  requirement: &2155117900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2158885140
+  version_requirements: *2155117900
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2158884660 !ruby/object:Gem::Requirement
+  requirement: &2155117420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2158884660
+  version_requirements: *2155117420
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2158884180 !ruby/object:Gem::Requirement
+  requirement: &2155116940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *2158884180
+  version_requirements: *2155116940
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2158883700 !ruby/object:Gem::Requirement
+  requirement: &2155116460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2158883700
+  version_requirements: *2155116460
 - !ruby/object:Gem::Dependency
   name: machinist
-  requirement: &2158883220 !ruby/object:Gem::Requirement
+  requirement: &2155115980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: 2.0.0.beta2
   type: :development
   prerelease: false
-  version_requirements: *2158883220
+  version_requirements: *2155115980
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2158882740 !ruby/object:Gem::Requirement
+  requirement: &2155115500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2158882740
+  version_requirements: *2155115500
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2158882260 !ruby/object:Gem::Requirement
+  requirement: &2155115020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,7 +99,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2158882260
+  version_requirements: *2155115020
 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
@@ -145,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -256185191954845220
+      hash: 2056485225028355172
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: