random-word 1.3.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5dfad3232b235871bbe1e413c1a4009d65417324
+  data.tar.gz: f72d97cf5b9cf3b4225715de1239be97c39a5006
+SHA512:
+  metadata.gz: f4c7ac7f3150ccd28caa11341ceaa952cebbbd9725c6d2a568aedea14ddac466ea4fe91bb17efa2d963a63270ea80c58d88d48837cb8b389bd8f5973d898a7c6
+  data.tar.gz: da1e4846c7675849cbb19ccdafda6b07ecc7cfbc8a8a14051c17f184fa83daa0d174e7d0c1c7edba511a2df96c6ecf6c5ac7af1dd92c6644c9b69a8324a5f1ca

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Your rspec options are your business
+.rspec
+
+# rspec failure tracking
+.rspec_status
+
+.idea/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -1,17 +1,4 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source 'https://rubygems.org'
 
-# 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"
-  gem "machinist", ">=2.0.0.beta2"
-  gem "activesupport"
-  gem "i18n"
-end
+# Specify your gem's dependencies in random-word.gemspec
+gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 OpenLogic, Peter Williams
+Copyright (c) 2011 OpenLogic, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,5 +1,7 @@
 random-word
 ====
+[![Build Status](https://travis-ci.org/openlogic/random-word.svg?branch=master)](https://travis-ci.org/openlogic/random-word)
+[![Coverage Status](https://coveralls.io/repos/github/openlogic/random-word/badge.svg?branch=master)](https://coveralls.io/github/openlogic/random-word?branch=master)
 
 A random word generator intended for use in test data factories.  This
 library uses a large list (the wordnet corpus) of english words and
@@ -12,31 +14,24 @@ Usage
 You can get a random word any where you need one. Just request the
 next of which ever word flavor you prefer.
 
-    RandomWord.adjs.next  #=> "pugnacious"
-    RandomWord.nouns.next #=> "audience"
+```ruby
+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
+```ruby
+Factory.define(:user) do |u|
+  u.name { "#{RandomWord.adjs.next} User" }
+  u.email { "#{name.gsub(/ +/, '.')}@example.com" }
+end
 
-    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
+Factory(:user) #=> ...
+```
 
 Exclusion
 ----
@@ -44,12 +39,24 @@ 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'
+```ruby
+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+/`.
 
+Constraining word length
+----
+
+You can constrain the length of words provided by the `nouns` and `adjs` iterators like so:
+
+```ruby
+RandomWord.nouns(not_longer_than: 56).next
+RandomWord.adjs(not_shorter_than: 3).next
+RandomWord.adjs(not_shorter_than: 16, not_longer_than: 672).next
+```
 
 Contributing to random-word
 ----
@@ -70,6 +77,6 @@ Contributing to random-word
 Copyright
 ----
 
-Copyright (c) 2011 OpenLogic, Peter Williams. See LICENSE.txt for
+Copyright (c) 2011 OpenLogic, Inc. See LICENSE.txt for
 further details.
 

data/Rakefile

@@ -1,42 +1,6 @@
-# encoding: utf-8
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-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
+RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
-
-require 'yard'
-YARD::Rake::YardocTask.new

data/lib/random-word.rb

@@ -1,2 +1 @@
 require 'random_word'
-require 'random_word/machinist' if defined?(Machinist)

data/lib/random_word.rb

@@ -9,23 +9,40 @@ require 'pathname'
 module RandomWord
   module EachRandomly
     attr_accessor :random_word_exclude_list
+    attr_accessor :min_length
+    attr_accessor :max_length
 
     def each_randomly(&blk)
       used = Set.new
-      exclude_list = Array(@random_word_exclude_list)
-      while true
+      skipped = Set.new
+      loop do
         idx = next_unused_idx(used)
         used << idx
         word = at(idx)
-        next if exclude_list.any?{|r| r === word }
+        if excluded?(word)
+          skipped << idx
+          next
+        end
         yield word
+        used.subtract(skipped)
+        skipped.clear
       end
 
     rescue OutOfWords
       # we are done.
     end
 
+    def set_constraints(opts = {})
+      @min_length = opts[:not_shorter_than] || 1
+      @max_length = opts[:not_longer_than] || Float::INFINITY
+    end
+
+    def self.extended(mod)
+      mod.set_constraints
+    end
+
     private
+
     def next_unused_idx(used)
       idx = rand(length)
       try = 1
@@ -37,22 +54,34 @@ module RandomWord
 
       idx
     end
+
+    def excluded?(word)
+      exclude_list = Array(@random_word_exclude_list)
+      exclude_list.any? {|r| r === word} || word.length < min_length || (!(max_length.nil?) && word.length > max_length)
+    end
+
     class OutOfWords < Exception; end
   end
 
   class << self
+    attr_accessor :word_list
+
     def exclude_list
       @exclude_list ||= []
     end
 
     # @return [Enumerator] Random noun enumerator
-    def nouns
+    def nouns(opts = {})
       @nouns ||= enumerator(load_word_list("nouns.dat"), exclude_list)
+      word_list.set_constraints(opts)
+      @nouns
     end
 
     # @return [Enumerator] Random adjective enumerator
-    def adjs
+    def adjs(opts = {})
       @adjs ||= enumerator(load_word_list("adjs.dat"), exclude_list)
+      word_list.set_constraints(opts)
+      @adjs
     end
 
     # @return [Enumerator] Random phrase enumerator
@@ -69,6 +98,7 @@ module RandomWord
     # Create a random, non-repeating enumerator for a list of words
     # (or anything really).
     def enumerator(word_list, list_of_regexs_or_strings_to_exclude = [])
+      @word_list = word_list
       word_list.extend EachRandomly
       word_list.random_word_exclude_list = list_of_regexs_or_strings_to_exclude
       word_list.enum_for(:each_randomly)

data/lib/random_word/version.rb

@@ -0,0 +1,3 @@
+module RandomWord
+  VERSION = '2.0.0'.freeze
+end

data/random-word.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'random_word/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'random-word'
+  spec.version       = RandomWord::VERSION
+  spec.authors       = ['Peter Williams', 'Todd Thomas']
+  spec.email         = ['pezra@barelyenough.org', 'todd.thomas@openlogic.com']
+
+  spec.summary       = %q{Pick random words for factory data}
+  spec.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.}
+  spec.homepage      = 'https://github.com/openlogic/random-word'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'machinist', '~>2.0'
+end

metadata

@@ -1,161 +1,134 @@
 --- !ruby/object:Gem::Specification
 name: random-word
 version: !ruby/object:Gem::Version
-  version: 1.3.0
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Peter Williams
+- Todd Thomas
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2012-01-12 00:00:00.000000000 -07:00
-default_executable: 
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2155118380 !ruby/object:Gem::Requirement
-    none: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '1.14'
   type: :development
   prerelease: false
-  version_requirements: *2155118380
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &2155117900 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: *2155117900
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &2155117420 !ruby/object:Gem::Requirement
-    none: false
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155117420
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &2155116940 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.2
-  type: :development
-  prerelease: false
-  version_requirements: *2155116940
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &2155116460 !ruby/object:Gem::Requirement
-    none: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
-  version_requirements: *2155116460
-- !ruby/object:Gem::Dependency
-  name: machinist
-  requirement: &2155115980 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
-  type: :development
-  prerelease: false
-  version_requirements: *2155115980
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &2155115500 !ruby/object:Gem::Requirement
-    none: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2155115500
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: &2155115020 !ruby/object:Gem::Requirement
-    none: false
+  name: machinist
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *2155115020
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 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
+email:
+- pezra@barelyenough.org
+- todd.thomas@openlogic.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.markdown
+extra_rdoc_files: []
 files:
-- .document
-- .rspec
+- ".document"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - HISTORY.markdown
 - LICENSE.txt
 - README.markdown
 - Rakefile
-- VERSION
 - data/adjs.dat
 - data/nouns.dat
 - lib/random-word.rb
 - lib/random_word.rb
-- lib/random_word/machinist.rb
-- spec/random-word_spec.rb
-- spec/random_word/machinist_spec.rb
-- spec/random_word_spec.rb
-- spec/spec_helper.rb
-- spec/support/matchers.rb
-has_rdoc: true
-homepage: http://github.com/pezra/random-word
+- lib/random_word/version.rb
+- random-word.gemspec
+homepage: https://github.com/openlogic/random-word
 licenses:
 - MIT
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2056485225028355172
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 2.6.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Pick random words for factory data
 test_files: []

data/VERSION

@@ -1 +0,0 @@
-1.3.0

data/lib/random_word/machinist.rb

@@ -1,27 +0,0 @@
-module RandomWord
-  module Machinist
-    # The serial word for the object being manufactured.
-    def serial_word
-      @serial_word ||= RandomWord.adjs.next
-    end
-    alias_method :sw, :serial_word
-
-    # The serial adjective for the object being manufactured.
-    def serial_adj
-      serial_word
-    end
-
-    # The serial noun for the object being manufactured.
-    def serial_noun
-      @serial_noun ||= RandomWord.nouns.next
-    end
-
-  end
-end
-
-begin
-  require 'machinist/lathe'
-  Machinist::Lathe.send(:include, RandomWord::Machinist)
-rescue LoadError, NameError
-  # Machinist is not available
-end

data/spec/random-word_spec.rb

@@ -1,7 +0,0 @@
-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/machinist_spec.rb

@@ -1,38 +0,0 @@
-require File.expand_path("../spec_helper", File.dirname(__FILE__))
-require 'machinist/machinable'
-require 'machinist/blueprint'
-require 'machinist/lathe'
-require 'random_word/machinist'
-
-describe RandomWord::Machinist do
-  let(:klass){ Class.new(Struct.new(:name,:role)) do
-      extend Machinist::Machinable
-    end
-  }
-
-  it "allows the use of #sw in blue prints" do
-    klass.blueprint do
-      name {sw}
-    end
-    klass.make.name.should_not be_nil
-  end
-
-  it "allows the use of #serial_word in blue prints" do
-    klass.blueprint do
-      name {serial_word}
-    end
-    klass.make.name.should_not be_nil
-  end
-
-  it "return same word for each call to serial_word" do
-    klass.blueprint do
-      name {serial_word}
-      role {serial_word}
-    end
-
-    klass.make.tap do |obj|
-      obj.name.should == obj.role
-    end
-  end
-
-end

data/spec/random_word_spec.rb

@@ -1,92 +0,0 @@
-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 its 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
-
-  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)
-      already_received << new_word
-    end
-  end
-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
-
-  it "can return a random adj enumerator" do 
-    RandomWord.adjs.should respond_to(:next)
-  end
-
-  it "can return a random phrase enumerator" 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
-

data/spec/spec_helper.rb

@@ -1,12 +0,0 @@
-$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

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