jjulian-random_data 1.5.0

data/History.txt

@@ -0,0 +1,63 @@
+== 1.5.0 2008-11-06
+* 2 major enhancement:
+  * Totally cleaned up and reconfigured hoe using newgem 1.0's conventions
+  * Added Markov model text generator (courtesy of Hugh Sasse)
+
+* 1 minor enhancement:
+  * Added roulette method to Array (courtesy of Hugh Sasse)
+
+* 1 minor fix:
+  * Fixed newline bug in the name generator (courtesy of Harold Gimenez)
+
+== 1.3.1 2008-06-06
+
+* 2 minor enhancements:
+  * Added added more last and firstnames (courtesy of Hugh Sasse)
+  * Added firstname_male and firstname_female (courtesy of Hugh Sasse)
+
+== 1.3.0 2008-05-25
+
+All these enhancements are from Hugh Sasse.  Thanks Hugh!
+
+* 4 major enhancements:
+  * Added RandomData::Grammar, which lets you create simple random sentences (see rdocs)
+  * Added Random.bit and Random.bits
+  * Added Random.grammatical_construct
+  * Fixed up rdocs which had gotten out of date
+
+* 2 minor enhancements:
+  * Added Random.uk_post_code
+  * Zipcodes should strings, not integers
+
+== 1.2.1 2007-11-29
+
+* 1 minor fix:
+  * Updated gem manifest
+
+== 1.2.0 2007-11-29
+
+Thanks to Paul Barry and Hugh Sasse for some awesome patches!
+
+* 1 major enhancement:
+  * Added method_missing to Random class, which looks for a method_name.dat and fetches a random line for you (see docs for details) (Hugh Sasse)
+  * added Random.date_between method to get a date between 2 given dates (Paul Barry)
+  * added Random.boolean method to get a random true or false (Paul Barry)
+  * added Random.number to get a random number less than a number or within a given range (Paul Barry)
+
+* 1 minor enhancement:
+  * enhanced Random.date method to handle a Range as well as a Fixnum, which allows you to get a date guaranteed to be in the past (Paul Barry)
+
+* 1 minor fix:
+  * Location sources organized into more understandable categories, for easier future expansion (Hugh Sasse)
+  * Fixed path of require statements in random_data.rb (Paul Barry)
+  * make initial never return nil, because if it returns nil then ContactInfo#email can thrown and error because it tries to call nil. (Paul Barry)
+  
+== 1.0.1 2007-09-17
+
+* 1 minor fix:
+  * Not creating the Random class properly by extending it (vs. including modules)
+
+== 1.0.0 2007-09-17
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Mike Subelsky, subelsky.com
+
+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/Manifest.txt

@@ -0,0 +1,24 @@
+History.txt
+License.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/random_data.rb
+lib/random_data/array_randomizer.rb
+lib/random_data/booleans.rb
+lib/random_data/contact_info.rb
+lib/random_data/dates.rb
+lib/random_data/grammar.rb
+lib/random_data/locations.rb
+lib/random_data/markov.rb
+lib/random_data/names.rb
+lib/random_data/numbers.rb
+lib/random_data/text.rb
+lib/random_data/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+test/henry_v_prolog.txt
+test/test_helper.rb
+test/test_random_data.rb

data/README.rdoc

@@ -0,0 +1,130 @@
+= random_data
+
+This gem provides a Random singleton class with a series of methods for generating random test data including names, mailing addresses, dates, phone numbers, e-mail addresses, and text.  Instead of:
+
+<tt>foo.name = "John Doe"</tt>
+
+You get:
+
+<tt>foo.name = "#{Random.firstname} #{Random.initial} #{Random.lastname}"</tt>
+
+== Installation
+
+<tt>sudo gem install random_data</tt>
+
+or get the gem manually from http://rubyforge.org/frs/?group_id=4458
+
+== Methods
+
+=== Contact Methods
+Random.phone, Random.international_phone, Random.email
+
+=== Time/Date Methods
+Random.date, Random.date_between
+
+=== Location Methods
+Random.address_line_1, Random.address_line_2, Random.zipcode, Random.uk_post_code, Random.state, Random.state_full, Random.country, Random.city
+	
+=== Name Methods
+Random.firstname, Random.firstname_male, Random.firstname_female, Random.initial, Random.lastname
+
+=== Text Methods
+Random.alphanumeric, Random.paragraphs
+
+=== Grammatical Methods
+Random.grammatical_construct
+
+=== Number Methods
+Random.number, Random.bit, Random.bits
+
+=== Boolean Methods
+Random.boolean
+
+=== Markov Generator Methods
+Random.MarkovGenerator.new 
+Random.MarkovGenerator.insert
+Random.MarkovGenerator.generate
+
+=== Array Extension
+Array.rand
+Array.roulette
+
+=== Choose From File Methods
+Random implements a method_missing helper that will choose a line at random from a file in your load path.  See Random::method_missing for details.
+
+Note that some methods take parameters to bound or limit the amount of data returned.  See RDocs for details.
+
+== Examples of Some Methods
+
+	>>Random.alphanumeric
+	=> "cfbutm3vYfhZXil0"
+
+	>> Random.alphanumeric(5)
+	=> "XYVyn"
+
+	>> Random.paragraphs
+	=> "Ulysses, fighting evil and tyranny with all his power and with all of his might. Ulysses, fighting evil and tyranny with all his power and with all 
+	of his might. \n\nHe's got style, a groovy style, and a car that just won't stop. \n\n"
+
+	>> Random.paragraphs(3)
+	=> "Excepteur sint occaecat cupidatat non proident  sunt in culpa qui officia deserunt mollit anim id est laborum. Down the road that's where I'll always be. 
+	He's got style, a groovy style, and a car that just won't stop. I've gotten burned over Cheryl Tiegs and blown up for Raquel Welch, but when I end up in the 
+	hay it's only hay  hey hey. Hey there where ya goin, not exactly knowin'. \n\nLorem ipsum dolor sit amet  consectetur adipisicing elit sed do eiusmod tempor 
+	incididunt ut labore et dolore magna aliqua. I might jump an open drawbridge or Tarzan from a vine, beause I'm the unknown stuntman that makes Eastwood look so 
+	fine. He just keeps on movin' and ladies keep improvin'. Rolling  down to Dallas - who is providin my palace?. Every stop I make I make a new friend; Can't 
+	stay for long just turn around and I'm gone again. \n\nAlways fighting all the evil forces bringing peace and justice to all. \n\n"
+
+	>> Random.firstname
+	=> "Thomas"
+
+	>> Random.initial
+	=> "E"
+
+	>> Random.lastname
+	=> "Robinson"
+
+	>> Random.date
+	=> Sun, 09 Sep 2007
+
+	(Returns an actual date object, shown here in its to_s form)
+	
+	>> Random.date(1000)
+	=> Sun, 26 Nov 2006
+
+	>> Random.email
+	=> "zrodriguez@example.com"
+
+	>> Random.phone
+	=> "564-103-8353"
+
+	>> Random.international_phone
+	=> "011-24-37-9704"
+
+	>> Random.address_line_1
+	=> "38367 Adams Rd"
+
+	>> Random.address_line_2
+	=> "Lot 247"
+
+	>> Random.zipcode
+	=> 22904
+
+	(Note that the zipcodes are totally random and may not be real zipcodes)
+
+	>> Random.state
+	=> "MD"
+
+	>> Random.state_full
+	=> "New Mexico"
+
+	>> Random.country
+	=> "Philippines"
+
+== Contact
+Let me know if you have patches, comments, or suggestions: mailto:mike@subelsky.com
+
+== Special Thanks
+Major thanks to Hugh Sasse and {Paul Barry}[http://paulbarry.com/] for their contributions.
+
+== Copyright
+Copyright (c) 2008 {Mike Subelsky}[http://subelsky.com/], Baltimore, Maryland, released under the MIT license.

data/Rakefile

@@ -0,0 +1,32 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/random_data'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('random_data', RandomData::VERSION) do |p|
+  p.developer('Mike Subelsky', 'mike@subelsky.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = "random-data"
+  p.description = "A Ruby gem that provides a Random class with a series of methods for generating random test data including names, mailing addresses, dates, phone numbers, e-mail addresses, and text."
+  p.summary = "A Ruby gem that provides a Random class with a series of methods for generating random test data including names, mailing addresses, dates, phone numbers, e-mail addresses, and text."
+  p.email = 'random_data@mikeshop.net'
+  # p.remote_rdoc_dir = 'random-data'
+
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/random_data.rb

@@ -0,0 +1,63 @@
+dir = "#{File.dirname(__FILE__)}/random_data"
+
+require "#{dir}/array_randomizer"
+require "#{dir}/booleans"
+require "#{dir}/contact_info"
+require "#{dir}/dates"
+require "#{dir}/locations"
+require "#{dir}/names"
+require "#{dir}/numbers"
+require "#{dir}/text"
+require "#{dir}/markov"
+require "#{dir}/grammar"
+require "#{dir}/version"
+
+class Random
+  extend RandomData::Booleans
+  extend RandomData::ContactInfo
+  extend RandomData::Dates
+  extend RandomData::Grammar
+  extend RandomData::Locations
+  extend RandomData::Names
+  extend RandomData::Numbers
+  extend RandomData::Text
+
+  # Looks for a file in the load path with the name methodname.dat, reads the lines from that file, then gives you a random line from that file.
+  # Raises an error if it can't find the file.  For example, given a file named "horse.dat" in your load path:
+  # >> Random.horse
+  # => "Stallion"
+  # >> Random.horse
+  # => "Pony"
+  # >> Random.horse
+  # => "Mare"
+  # >> Random.horse
+  # => "Clydesdale"
+  # >> Random.horse
+  # => "Stallion"
+  # >> Random.horse
+  # => "Mare"
+  
+  def self.method_missing(methodname)
+    thing = "#{methodname}.dat"
+    filename = find_path(thing)
+
+    if filename.nil?
+      super
+    else
+      array = []
+      File.open(filename, 'r') { |f| array = f.read.split(/[\r\n]+/) }
+      return array.rand
+    end
+  end
+  
+  private
+  
+  def self.find_path(filename)
+    $:.each do |path|
+      new_path = File.join(path,filename)
+      return new_path if File.exist?(new_path)
+    end    
+    return nil
+  end
+  
+end

data/lib/random_data/array_randomizer.rb

@@ -0,0 +1,65 @@
+# Extends the Array class with a function used to randomly choose elements.  Note that if you are using Rails, ActiveSupport recently was updated to include a similar
+# function.  This code checks for the presence of that method and does not try to replace it.  They work the same though so no worries.
+
+module RandomData
+  module ArrayRandomizer
+  
+    # Randomly chooses an element from an array
+    # >> [1,2,3].rand = 3 
+    # [].rand = nil
+
+    def rand
+      return self[Kernel.rand(self.size)]
+    end
+
+    # Takes an array of non-negative weights
+    # and returns the index selected by a 
+    # roulette wheel weighted according to those
+    # weights.
+    # If a block is given then k is used to determine
+    # how many times the block is called.  In this
+    # case nil is returned.
+    def roulette(k=1)
+      wheel = []
+      weight = 0
+      # Create the cumulative array.
+      self.each do |x|
+        raise "Illegal negative weight #{x}" if x < 0
+        wheel.push(weight += x)
+      end
+      # print "wheel is #{wheel.inspect}\n";
+      # print "weight is #{weight.inspect}\n";
+      raise "Array had all zero weights" if weight.zero?
+      wheel.push(weight + 1) #Add extra element
+      if block_given?
+        k.times do 
+          r = Kernel.rand() # so we don't pick up that from array.
+          # print "r is #{r.inspect}\n";
+          roll = weight.to_f * r
+          # print "roll is #{roll.inspect}\n";
+          0.upto(self.size - 1) do |i|
+            if wheel[i+1] > roll
+              yield i 
+              break
+            end # if
+          end # upto
+        end # if block_given?
+        return nil
+      else
+        r = Kernel.rand() # so we don't pick up that from array.
+        # print "r is #{r.inspect}\n";
+        roll = weight.to_f * r
+        # print "roll is #{roll.inspect}\n";
+        0.upto(self.size - 1) do |i|
+          return i if wheel[i+1] > roll
+        end
+      end
+    end
+
+  end
+
+end
+
+unless Array.respond_to?(:rand)
+  Array.send :include, RandomData::ArrayRandomizer
+end

data/lib/random_data/booleans.rb

@@ -0,0 +1,10 @@
+module RandomData
+  
+  module Booleans
+    #Returns true or false randomly
+    def boolean
+      rand(2) == 1 ? true : false
+    end
+  end
+  
+end

data/lib/random_data/contact_info.rb

@@ -0,0 +1,24 @@
+module RandomData
+  # Methods for randomly generating contact data like phone numbers and e-mail addresses
+  
+  module ContactInfo
+
+   # Returns a randomly-generated string of digits that roughly resembles a US telephone number.  Not guaranteed to be a valid area code.
+   def phone
+     "#{rand(900) + 100}-#{rand(900)+100}-#{rand(10000)+1000}"
+   end
+
+   # Returns a randomly-generated string of digits that roughly resembles an international telephone number as dialed from the US.  
+   # Not guaranteed to be a valid number but just good enough to get some sample data going.
+   
+   def international_phone
+    "011-#{rand(100) + 1}-#{rand(100)+10}-#{rand(10000)+1000}"
+   end
+
+   # Returns an e-mail address of the form "{first_initial}{last_name}@{domain}"
+   def email 
+    domains = %w(yahoo.com gmail.com privacy.net webmail.com msn.com hotmail.com example.com privacy.net)
+    "#{(initial + lastname).downcase}\@#{domains.rand}"  
+   end
+ end
+end

data/lib/random_data/dates.rb

@@ -0,0 +1,47 @@
+require 'date'
+
+module RandomData
+  
+  # Defines methods for random date generation
+  
+  module Dates
+  
+    # Returns a date within a specified range of days.  If dayrange is an Integer, then the date
+    # returned will be plus or minus half what you specify.  The default is ten days, so by default 
+    # you will get a date within plus or minus five days of today.
+    #
+    # If dayrange is a Range, then you will get a date the falls between that range
+    #
+    # Example:
+    #
+    # Random.date # => a Date +/- 5 days of today
+    # Random.date(20) # => a Date +/- 10 days of today
+    # Random.date(-60..-30) # => a Date between 60 days ago and 30 days ago  
+    #
+    def date(dayrange=10)
+      if dayrange.is_a?(Range)
+        offset = rand(dayrange.max-dayrange.min) + dayrange.min
+      else
+        offset = rand(dayrange*2) - dayrange
+      end
+      Date.today + offset
+    end
+    
+    # Returns a date within the specified Range. The Range can be Date or String objects.
+    #
+    #Example:
+    # min = Date.parse('1966-11-15')
+    # max = Date.parse('1990-01-01')
+    # Random.date(min..max) # => a Date between 11/15/1996 and 1/1/1990
+    # Random.date('1966-11-15'..'1990-01-01') # => a Date between 11/15/1996 and 1/1/1990
+    #
+    def date_between(range)
+      min_date = range.min.is_a?(Date) ? range.min : Date.parse(range.min)
+      max_date = range.max.is_a?(Date) ? range.max : Date.parse(range.max)
+
+      diff = (max_date - min_date).to_i
+      min_date + rand(diff)
+    end
+
+  end
+end