random_phrase 0.0.2 → 0.1.0

data/.rvmrc

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory.
+# For more info, see: http://beginrescueend.com/
+
+ruby_gemset_name="ruby-1.9.2-p180@random_phrase"
+ruby_name="ruby-1.9.2-p180"
+
+echo "RVM: Using ${ruby_gemset_name} for this project."
+# Ensure we have the right ruby installed to use this project.
+if rvm list strings | grep -q "${ruby_name}" ; then
+
+  # Load or create the specified environment
+  #   We attempt to load the desired environment directly from the environment
+  #   file. This is very fast and efficient compared to running through the entire
+  #   CLI and selector. If you want feedback on which environment was used then
+  #   insert the word 'use' after --create as this triggers verbose mode.
+  if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+    && -s "${rvm_path:-$HOME/.rvm}/environments/${ruby_gemset_name}" ]] ; then
+    \. "${rvm_path:-$HOME/.rvm}/environments/${ruby_gemset_name}"
+  else
+    # If the environment file has not yet been created, use the RVM CLI to select.
+    if ! rvm --create  "${ruby_gemset_name}"
+    then
+      echo "RVM: Failed to create environment '$environment_id'."
+    fi
+    
+  fi
+
+  # Ensure that Bundler is installed, install it if it is not.
+  bundler_installed=`gem list bundler | grep bundler`
+  if [ -z "$bundler_installed" ]; then
+    gem install bundler
+  fi
+
+  # Bundle while reducing excess noise.
+  #   We generate bin stubs so that we don't need to use
+  #   'bundle exec' before gem executables. You should add
+  #   './bin' to your path so that you can run 'rake', 'cucumber'
+  #   etc from the Gemfile with ease.
+  #   See http://yehudakatz.com/2011/05/30/gem-versioning-and-bundler-doing-it-right/
+  echo "RVM: Ensuring your bundle is up to date."
+  bundle install | grep -v 'Using' | grep -v 'complete' | sed '/^$/d'
+
+else
+
+  # Notify the user to install the desired interpreter before proceeding.
+  echo "RVM: ${ruby_name} was not found, please run 'rvm install ${ruby_name}' and then cd back into the project directory."
+
+fi

data/lib/random_phrase.rb

@@ -1,15 +1,40 @@
 require "random_phrase/version"
 require "random_phrase/dictionary"
-require "random_phrase/core_ext/array"
 
 module RandomPhrase
 
-	def self.phrase(word_count = 1)
-		phrase = []
-		word_count.times do 
-			phrase << RandomPhrase::Dictionary.words.pick
+	class << self
+		def dictionary=(dictionary)
+			@@dictionary = dictionary
+		end
+
+		def dictionary
+			@@dictionary ||= RandomPhrase::Dictionary.new
+		end
+
+		def phrase(*args)
+			options = args.extract_options!
+			word_patterns = []
+			
+			unless args.empty?
+				if args.first.respond_to?(:times)
+					word_count = args.first
+				elsif args.first.kind_of?(Regexp)
+					word_patterns = args.first.source.split(/(?:\s|\\\\s)/)
+					word_count = word_patterns.count
+				elsif args.first.respond_to?(:to_s)
+					word_count = args.first.to_s.split(/\s/).count
+				end
+			end
+			
+			word_count ||= 1
+			phrase = []
+			word_count.times do |i|
+				options.merge!(:pattern => Regexp.compile(word_patterns[i])) unless word_patterns.empty?
+				phrase << dictionary.words(options).sample
+			end
+			phrase.join(" ")
 		end
-		phrase.join(" ")
 	end
 
 end

data/lib/random_phrase/config/words

@@ -3,4 +3,24 @@ how
 well
 this
 gem
-works
+works
+a
+ah
+are
+aunt
+angst
+apples
+aspects
+audience
+amplitude
+auspicious
+i
+in
+ink
+ides
+inset
+ignore
+ideally
+implicit
+illicitly
+introspect

data/lib/random_phrase/dictionary.rb

@@ -1,14 +1,38 @@
-module RandomPhrase::Dictionary
-  def self.load
-    if File.exists?("config/words")
-			File.read("config/words").split
-		else
-			"flowing hill".split
-		end
-  end
+require "active_support/core_ext/array/extract_options"
 
-	def self.words
-		@@dictionary ||= self.load
+class RandomPhrase::Dictionary
+	attr_accessor :loader
+	
+	module DefaultLoader
+	  def self.load
+	    if File.exists?("config/words")
+				File.read("config/words").split
+			else
+				"flowing river down brightly sparkling in the sun may I dip my toes".split
+			end
+	  end		
 	end
 	
+	def initialize(loader = nil)
+		loader = Proc.new {loader} unless loader.nil? || loader.kind_of?(Proc)
+		self.loader = loader ||= Proc.new { DefaultLoader.load }
+	end
+	
+
+	def words(*args)
+		options = args.extract_options!
+	
+		@dictionary ||= loader.call().group_by {|word| word.length}
+		result = @dictionary.values.flatten
+		if options.key?(:length)
+			result = @dictionary.fetch(options[:length], [])
+		end
+		
+		if options.key?(:pattern)
+			result = result.select { |w| w =~ Regexp.try_convert(options[:pattern]) }
+		end
+		
+		result.flatten
+	end
+
 end

data/lib/random_phrase/version.rb

@@ -1,3 +1,3 @@
 module RandomPhrase
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/random_phrase.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["yosem.sweet@suite101.com"]
   s.homepage    = "https://github.com/yosemsweet/random_phrase"
   s.summary     = %q{Generate a simple random phrase}
-  s.description = %q{This gem provides random phrase functionality and extends Array with a random .pick}
+  s.description = %q{This gem provides the ability to generate a random phrase from a customizable word list via word length and regexp matching.}
 
   s.rubyforge_project = "random_phrase"
 
@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+	s.add_dependency "activesupport", "~>3"
+	s.add_development_dependency "require_all"
+	s.add_development_dependency "ruby-debug19"
+	s.add_development_dependency "rspec", "~>2"
 end

data/spec/lib/dictionary_spec.rb

@@ -1,20 +1,58 @@
 require "spec_helper"
 
 describe RandomPhrase::Dictionary do
-	context "module methods" do
-		context "::load" do
-			it "should respond to load" do
-				RandomPhrase::Dictionary.should respond_to(:load)
+	context "class methods" do
+		
+		context "::new" do
+			it "returns a dictionary object" do
+				RandomPhrase::Dictionary.new.should be_kind_of(RandomPhrase::Dictionary)
+			end
+
+			it "can be passed a block that defines the implementation of #load" do
+				load_static = Proc.new { ["a","b","c","d"]}
+				RandomPhrase::Dictionary.new(load_static).words.should == ["a","b","c","d"]
 			end
 		end
-		
-		context "::word" do
+	end
+	
+	context "object methods" do	
+		context "#words" do
 			it "should respond to words" do
-				RandomPhrase::Dictionary.should respond_to(:words)
+				RandomPhrase::Dictionary.new.should respond_to(:words)
 			end
 			
 			it "should return an array" do
-				RandomPhrase::Dictionary.words.should be_kind_of(Array)
+				RandomPhrase::Dictionary.new.words.should be_kind_of(Array)
+			end
+			
+			it "should accept optional arguments" do
+				RandomPhrase::Dictionary.new.words.should be_kind_of(Array)
+				RandomPhrase::Dictionary.new.words(:length => 3).should be_kind_of(Array)
+				RandomPhrase::Dictionary.new.words(:length => 3, :pattern => /abc/).should be_kind_of(Array)
+			end
+			
+			context "passing in length" do
+				it "should return only words with length characters" do
+					dictionary = RandomPhrase::Dictionary.new(Proc.new {["a", "a"*2, "a"*3, "a"*4, "a"]})
+					dictionary.words(:length => 1).each { |w| w.length.should == 1}
+					dictionary.words(:length => 2).each { |w| w.length.should == 2}
+					dictionary.words(:length => 3).each { |w| w.length.should == 3}
+					dictionary.words(:length => 4).each { |w| w.length.should == 4}
+					
+					dictionary.words(:length => 1).length.should == 2
+					dictionary.words(:length => 2).length.should == 1
+					dictionary.words(:length => 3).length.should == 1
+					dictionary.words(:length => 4).length.should == 1
+				end
+			end
+			
+			context "passing in pattern" do
+				it "should return only words matching the pattern" do
+					dictionary = RandomPhrase::Dictionary.new(Proc.new {["a", "a"*2, "a"*3, "a"*4, "b"]})
+					dictionary.words(:pattern => /b/).each { |w| w.should =~ /b/}
+					dictionary.words(:pattern => /a/).each { |w| w.should =~ /a/}
+					dictionary.words(:pattern => /a{3}/).each { |w| w.should =~ /a{3}/}
+				end
 			end
 		end
 	end

data/spec/lib/random_phrase_spec.rb

@@ -1,7 +1,25 @@
 require "spec_helper"
 
 describe RandomPhrase do
-	context "module methods" do
+	
+	context "::dictionary" do
+		it "should have a dictionary accessor attribute" do
+			RandomPhrase.should respond_to(:dictionary=)
+			RandomPhrase.should respond_to(:dictionary)
+		end
+		
+		it "should only return words from its dictionary" do
+			dictionary = RandomPhrase::Dictionary.new(Proc.new {["a", "b", "c"]})
+			RandomPhrase.dictionary= dictionary
+			RandomPhrase.phrase().split.each { |word| dictionary.words.should include(word) }
+		end
+		
+		after(:all) do
+			RandomPhrase.dictionary= nil
+		end
+	end
+
+	context "::phrase" do
 		it "should respond to phrase an optional word count" do
 			RandomPhrase.should respond_to(:phrase)
 			RandomPhrase.should respond_to(:phrase).with(1)
@@ -24,5 +42,45 @@ describe RandomPhrase do
 		it "should return different phrases on successive calls" do
 			RandomPhrase.phrase.should_not == RandomPhrase.phrase
 		end
+		
+		context "with options" do
+			context ":length =>" do
+				it "should only return words of the specified length" do
+					RandomPhrase.dictionary= RandomPhrase::Dictionary.new(Proc.new {["aaa", "bbbb", "cc", "ddd", "ee"]})
+					RandomPhrase.phrase(2, :length => 3).split.each {|word| word.length.should == 3}
+				end
+				after(:all) do
+					RandomPhrase.dictionary= nil
+				end
+			end
+			
+			context ":pattern =>" do
+				before(:all) do
+					RandomPhrase.dictionary= nil
+				end
+				
+				context "single word patterns" do
+					it "should return a phrase matching the pattern" do
+						RandomPhrase.dictionary= RandomPhrase::Dictionary.new(Proc.new {["aed", "bed", "cat", "a", "foeder"]})
+						pattern = /[a-zA-Z]+ed/
+						phrase = RandomPhrase.phrase(pattern)
+						pattern.match(phrase).should_not be_nil
+					end
+				end
+				
+				context "multi-word patterns" do
+					it "should return a phrase matching the pattern" do
+						RandomPhrase.dictionary= RandomPhrase::Dictionary.new(Proc.new {["aed", "bed", "cat", "a", "foeder"]})
+						pattern = /\w+ [a-zA-Z]+ed/
+						phrase = RandomPhrase.phrase(pattern)
+						pattern.match(phrase).should_not be_nil
+					end
+				end
+				
+				after(:all) do
+					RandomPhrase.dictionary= nil
+				end
+			end
+		end
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: random_phrase
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-30 00:00:00.000000000 -07:00
-default_executable: 
+date: 2011-10-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2153086480 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: &2161656640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2161656640
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: &2161656220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,9 +32,31 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153086480
-description: This gem provides random phrase functionality and extends Array with
-  a random .pick
+  version_requirements: *2161656220
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &2161655760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2161655760
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2161655260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: *2161655260
+description: This gem provides the ability to generate a random phrase from a customizable
+  word list via word length and regexp matching.
 email:
 - yosem.sweet@suite101.com
 executables: []
@@ -32,19 +64,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
 - Gemfile
 - Rakefile
 - lib/random_phrase.rb
 - lib/random_phrase/config/words
-- lib/random_phrase/core_ext/array.rb
 - lib/random_phrase/dictionary.rb
 - lib/random_phrase/version.rb
 - random_phrase.gemspec
-- spec/lib/core_ext/array_spec.rb
 - spec/lib/dictionary_spec.rb
 - spec/lib/random_phrase_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/yosemsweet/random_phrase
 licenses: []
 post_install_message: 
@@ -65,12 +95,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: random_phrase
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Generate a simple random phrase
 test_files:
-- spec/lib/core_ext/array_spec.rb
 - spec/lib/dictionary_spec.rb
 - spec/lib/random_phrase_spec.rb
 - spec/spec_helper.rb

data/lib/random_phrase/core_ext/array.rb

@@ -1,5 +0,0 @@
-class Array
-  def pick
-    at Kernel.rand(size)
-  end
-end

data/spec/lib/core_ext/array_spec.rb

@@ -1,15 +0,0 @@
-require "spec_helper"
-
-describe Array do
-	context "#pick" do
-		it "should respond to pick" do
-			[].should respond_to(:pick)
-		end
-		
-		it "should return a random element" do
-			a = [1,2,3,4,5,6,7,8,9,10]
-			a.pick.should_not == a.pick
-			a.find_index(a.pick).should_not be_nil
-		end
-	end		
-end