random_data 1.2.1 → 1.3.0

data/History.txt

@@ -1,3 +1,17 @@
+== 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:

data/Manifest.txt

@@ -10,6 +10,7 @@ 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/names.rb
 lib/random_data/numbers.rb

data/README.txt

@@ -20,21 +20,35 @@ or get the gem manually from http://rubyforge.org/frs/?group_id=4458
 Random.phone, Random.international_phone, Random.email
 
 === Time/Date Methods
-Random.date
+Random.date, Random.date_between
 
 === Location Methods
-Random.address_line_1, Random.address_line_2, Random.zipcode, Random.state, Random.country, Random.city,
+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.initial, Random.lastname, 
+Random.firstname, Random.initial, Random.lastname
 
 === Text Methods
 Random.alphanumeric, Random.paragraphs
 
-Note that some methods take parameters to bound or limit the amount of data returned.  See RDocs for details.
+=== Grammatical Methods
+Random.grammatical_construct
+
+=== Number Methods
+Random.number, Random.bit, Random.bits
 
+=== Boolean Methods
+Random.boolean
 
-== Examples
+=== Array Extension
+Array.rand
+
+=== 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"
@@ -103,5 +117,8 @@ Note that some methods take parameters to bound or limit the amount of data retu
 == 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) 2007 {Mike Subelsky}[http://subelsky.com/], Baltimore, Maryland, released under the MIT license
+Copyright (c) 2008 {Mike Subelsky}[http://subelsky.com/], Baltimore, Maryland, released under the MIT license.

data/lib/random_data/booleans.rb

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

data/lib/random_data/grammar.rb

@@ -0,0 +1,61 @@
+
+module RandomData
+  
+  # Defines methods for the generation of random data based on a supplied grammar.
+  
+  module Grammar
+  
+    # Returns simple sentences based on a supplied grammar, which must be a hash, the
+    # keys of which are symbols.  The values are either an array of successive values or a grammar 
+    # (i.e, hash with symbols as keys, and hashes or arrays as values.  The arrays contain symbols 
+    # referencing the keys in the present grammar, or strings to be output. The keys are always symbols.
+    #
+    # Example:
+    # Random.grammatical_construct({:story => [:man, " bites ", :dog], :man => { :bob => "Bob"}, :dog => {:a =>"Rex", :b =>"Rover"}}, :story)
+    # => "Bob bites Rover"
+    
+    def grammatical_construct(grammar, what=nil)
+      output = ""
+      if what.nil?
+        case grammar
+        when Hash
+          a_key = grammar.keys.sort_by{rand}[0]
+          output += grammatical_construct(grammar, a_key)
+        when Array
+          grammar.each do |item|
+            output += grammatical_construct(item)
+          end
+        when String
+          output += grammar
+        end
+      else
+        rhs = grammar[what]
+        case rhs
+        when Array
+          rhs.each do |item|
+            case item
+            when Symbol
+              output += grammatical_construct(grammar,item)
+            when String
+              output += item
+            when Hash
+              output += grammatical_construct(item)
+            else
+              raise "#{item.inspect} must be a symbol or string or Hash"
+            end
+          end
+        when Hash
+          output+= grammatical_construct(rhs)
+        when Symbol
+          output += grammatical_construct(rhs)
+        when String
+          output += rhs
+        else
+          raise "#{rhs.inspect} must be a symbol, string, Array or Hash"
+        end
+      end
+      return output
+    end
+
+  end
+end

data/lib/random_data/locations.rb

@@ -9,8 +9,9 @@ module RandomData
                 Linden Maple Oak Pine Rose Walnut Willow)
     people = %w( Adams Franklin Jackson Jefferson Lincoln
                   Madison Washington Wilson)
+    people_uk = %w( Churchill Tyndale Latimer Cranmer )
     places = %w( Highland Hill Park Woodland Sunset Virginia)
-    numbers = %w( 1st 2nd 4th 5th )
+    numbers = %w( 1st 2nd 4th 5th 34th 42nd )
     @@streetnames =  trees + people + places + numbers
                     
     @@street_types = %w(St Ave Rd Blvd Trl Ter Rdg Pl Pkwy Ct Circle)
@@ -25,6 +26,8 @@ module RandomData
       "#{rand(40000)} #{@@streetnames.rand} #{@@street_types.rand}"
     end
 
+    alias :us_address_line_1 :address_line_1
+
     @@line2types = ["Apt", "Bsmt", "Bldg", "Dept", "Fl", "Frnt", "Hngr", "Lbby", "Lot", "Lowr", "Ofc", "Ph", "Pier", "Rear", "Rm", "Side", "Slip", "Spc", "Stop", "Ste", "Trlr", "Unit", "Uppr"]
 
     # Returns the first line of a US maiiling address (street number, street name, street type)
@@ -38,8 +41,25 @@ module RandomData
     end
 
     # Returns a random 5-digit string, not guaranteed to be a legitimate zip code.
+    # Legal zip codes can have leading zeroes and thus they need to be strings.  
+    
     def zipcode
-     rand(89999) + 10000  
+     "%05d" % rand(99999) 
+    end
+
+
+    # Returns a string providing something in the general form of a UK post code.  Like the zip codes, this might
+    # not actually be valid. Doesn't cover London whose codes are like "SE1".
+
+    def uk_post_code
+      post_towns = %w(BM CB CV LE LI LS KT MK NE OX PL YO)
+      # Can't remember any othes at the moment
+      number_1  = rand(100).to_s
+      number_2  = rand(100).to_s
+      # Easier way to do this? 
+      letters = ("AA".."ZZ").to_a.rand
+
+      return "#{post_towns.rand}#{number_1} #{number_2}#{letters}"
     end
 
     # from technoweenie: http://svn.techno-weenie.net/projects/plugins/us_states/lib/us_states.rb
@@ -56,7 +76,7 @@ module RandomData
                    ["Washington", "WA"], ["Wisconsin", "WI"], ["West Virginia", "WV"], ["Wyoming", "WY"]]                    
 
     # Returns a state 2-character abbreviation
-    #Random.state = "IL"
+    # Random.state = "IL"
     
     def state
       @@us_states.rand[1]

data/lib/random_data/numbers.rb

@@ -5,9 +5,27 @@ module RandomData
     #returns a random number within the range
     # Examples
     #
-    #
+    # >> Random.number(5)
+    # => 4
+    # >> Random.number(5)
+    # => 2
+    # >> Random.number(5)
+    # => 1
     def number(n)
       n.is_a?(Range) ? n.to_a.rand : rand(n) 
     end
+
+    # return a random bit, 0 or 1.
+    def bit
+      rand(2)
+    end
+
+    # return an array of n random bits.
+    def bits(n)
+      x = []
+      n.times {x << bit}
+      x
+    end
+
   end
-end
+end

data/lib/random_data/text.rb

@@ -4,7 +4,6 @@ module RandomData
 
     # Methods to create random strings and paragraphs.
     
-
      # Returns a string of random upper- and lowercase alphanumeric characters.  Accepts a size parameters, defaults to 16 characters.
      #
      # >> Random.alphanumeric

data/lib/random_data/version.rb

@@ -1,8 +1,8 @@
 module RandomData #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1
-    MINOR = 2
-    TINY  = 1
+    MINOR = 3
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/random_data.rb

@@ -8,18 +8,32 @@ require 'random_data/locations'
 require 'random_data/names'
 require 'random_data/numbers'
 require 'random_data/text'
+require 'random_data/grammar'
 
 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 with the name methodname.dat, reads the lines from that file, then gives you a random line from that file
-  # Will also search your load path for the file.  Raises an error if it can't find the file.
+  # 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"

data/test/test_random_data.rb

@@ -38,7 +38,11 @@ class TestRandomData < Test::Unit::TestCase
   end
 
   def test_should_return_random_zipcode
-    assert_equal 48408, Random.zipcode    
+    assert_equal "38408", Random.zipcode    
+  end
+
+  def test_should_return_random_uk_post_code
+    assert_equal "BM8 24DB", Random.uk_post_code    
   end
 
   def test_should_return_random_state
@@ -119,9 +123,26 @@ class TestRandomData < Test::Unit::TestCase
     assert_equal 8, Random.number(9)
   end
 
+  def test_should_return_random_bit
+    assert_equal 0, Random.bit
+  end
+
+  def test_should_return_random_bits
+    assert_equal 10, Random.bits(10).size
+    assert_equal [0, 1, 0, 0, 0, 0, 1, 0, 0, 1], Random.bits(10)
+  end
+
   def test_should_return_random_number_within_range
     assert_equal 13, Random.number(5..15)
   end
+
+  def test_should_return_random_grammatical_construct
+    assert_equal "Bob bites Rover",
+      Random::grammatical_construct({:story => [:man, " bites ", :dog],
+                         :man => { :bob => "Bob"},
+                         :dog => {:a =>"Rex", :b =>"Rover"}},
+                         :story)
+  end
   
 end
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: random_data
 version: !ruby/object:Gem::Version 
-  version: 1.2.1
-platform: ""
+  version: 1.3.0
+platform: ruby
 authors: 
 - Mike Subelsky
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2007-11-29 00:00:00 -05:00
+date: 2008-05-25 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -38,6 +38,7 @@ files:
 - 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/names.rb
 - lib/random_data/numbers.rb
@@ -81,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: random-data
-rubygems_version: 0.9.5
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
 summary: A Ruby gem that 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.