randomperson 0.0.17 → 0.0.19

data/lib/randomperson/Names/SwedishMaleFirst.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: UTF-8
 
 module RandomPerson
   module Names

data/lib/randomperson/Names/ThaiFemaleFirst.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: UTF-8
 
 module RandomPerson
   module Names

data/lib/randomperson/Names/ThaiFirst.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: UTF-8
 
 module RandomPerson
   module Names

data/lib/randomperson/Names/ThaiLast.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: UTF-8
 
 module RandomPerson
   module Names

data/lib/randomperson/Names/ThaiMaleFirst.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: UTF-8
 
 module RandomPerson
   module Names

data/lib/randomperson/Names/ThaiRomanisedFemaleFirst.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: UTF-8
 
 module RandomPerson
   module Names

data/lib/randomperson/Names/ThaiRomanisedLast.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: UTF-8
 
 module RandomPerson
   module Names

data/lib/randomperson/Names/ThaiRomanisedMaleFirst.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: UTF-8
 
 module RandomPerson
   module Names

data/lib/randomperson/Names/WelshFemaleFirst.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: UTF-8
 
 module RandomPerson
   module Names

data/lib/randomperson/Names/WelshLast.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: UTF-8
 
 module RandomPerson
   module Names

data/lib/randomperson/Names/WelshMaleFirst.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: UTF-8
 
 module RandomPerson
   module Names

data/lib/randomperson/Names/WelshPrefix.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: UTF-8
 
 module RandomPerson
   module Names

data/lib/randomperson/{Choice.rb → choice.rb}

@@ -1,6 +1,7 @@
 module RandomPerson
 
   class Choice
+    require 'set'
     
     attr_accessor :malefirst, :femalefirst, :last, :gender_ratio, :age_lower, :age_upper, :prefix, :suffix #,:age_ratio
     
@@ -10,7 +11,10 @@ module RandomPerson
     
 
     @@available_classes = Set.new
-    
+
+    # Initialize the class with the parameters for the population you want.
+    # @example 
+    #   choice = RandomPerson::Choice.new( {gender_ratio: [3,5] , age_lower:16, age_upper:35 } )
     def initialize( h={} )
       @gender_ratio = h[:gender_ratio] || [1,1] #default
       @age_lower = h[:age_lower] || 0

data/lib/randomperson/{Generator.rb → generator.rb}

@@ -1,15 +1,24 @@
 module RandomPerson
 
   class Generator
-  
+    
+    require_relative './choice.rb'
+    require_relative './person.rb'
+    
     attr_reader :generators
    
+    # Sets up a list of generators
+    # @example 
+    #   g = RandomPerson::Generator.new
     def initialize
       @generators = [ ] 
     end
 
     
-    #build a choice generator
+    # Build a choice generator
+    # @param [RandomPerson::Choice] choice A Choice object.
+    # @example 
+    #   g.make_generator choice
     def make_generator( choice )
     f = -> {
         g = Generator.pick_gender( choice.gender_ratio )
@@ -50,6 +59,15 @@ module RandomPerson
         return new_ratio
       end 
       
+      # Takes a ratio and uses this to randomly select either a male or a female. To get only males or only females, pass in a 0 for either gender to make sure of getting the other gender for definite.
+      # @example To only get males:
+      #   pick_gender( [1,0] )
+      # @example To only get females:
+      #   pick_gender( [0,1] )
+      # @example To be likely to get 2 females to every male:
+      #   pick_gender( [1,2] )
+      # @param [optional,Array<Integer,Integer>] ratio The ratio of males to females expressed in an array, e.g. [1,1] is (a chance of) one male for every female, [1,2] is one male to two females. The default is [1,1].
+      # @return [String] Returns a 'f' for female or an 'm' for male.
       def pick_gender( ratio=[1,1] ) #male first
         if ratio.length == 2
           return 'f' if ratio.first == 0

data/lib/randomperson/person.rb

@@ -0,0 +1,27 @@
+module RandomPerson
+  
+  # Your general person
+  class Person
+  
+    attr_accessor :gender, :age, :dob, :first, :last, :prefix, :suffix
+    
+    ## @param [optional,Hash] h A hash of the person's attributes
+    # @option h [String] :gender nil Gender, 'm' for male or 'f' for female
+    # @option h [Integer] :age nil Age
+    # @option h [Time] :dob nil Date of birth
+    # @option h [String] :first nil First name
+    # @option h [String] :last nil Last name
+    # @option h [String] :prefix nil Prefix e.g. Mr
+    # @option h [String] :suffix nil Suffix e.g. PhD
+    def initialize( h={} )
+        @gender = h[:gender] || nil
+        @age = h[:age] || nil
+        @dob = h[:dob] || nil
+        @first = h[:first] || nil
+        @last = h[:last] || nil
+        @prefix = h[:prefix] || nil
+        @suffix = h[:suffix] || nil
+    end
+    
+  end
+end

data/lib/randomperson/version.rb

@@ -0,0 +1,3 @@
+module RandomPerson
+  VERSION = "0.0.19"
+end

data/lib/randomperson.rb

@@ -1,17 +1,23 @@
-#require all the scaffolding
+# encoding: UTF-8
+module RandomPerson
 
-require 'set'
-require 'date'
+  #require all the scaffolding
+  
+  require 'set'
+  require 'date'
+  
+  require_relative './randomperson/version.rb'
+  require_relative './randomperson/ext/Array.rb'
+  require_relative './randomperson/ext/Date.rb'
+  require_relative './randomperson/ext/Enumerable.rb'
+  require_relative './randomperson/ext/Hash.rb'
+  require_relative './randomperson/ext/Kernel.rb'
+  require_relative './randomperson/ext/Set.rb'
+  
+  require_relative './randomperson/choice.rb'
+  require_relative './randomperson/generator.rb'
+  require_relative './randomperson/name.rb'
+  require_relative './randomperson/person.rb'
+  #require_relative './randomperson/ratio.rb'
 
-require_relative 'randomperson/ext/Array.rb'
-require_relative 'randomperson/ext/Date.rb'
-require_relative 'randomperson/ext/Enumerable.rb'
-require_relative 'randomperson/ext/Hash.rb'
-require_relative 'randomperson/ext/Kernel.rb'
-require_relative 'randomperson/ext/Set.rb'
-
-require_relative 'randomperson/choice.rb'
-require_relative 'randomperson/generator.rb'
-require_relative 'randomperson/name.rb'
-require_relative 'randomperson/person.rb'
-#require_relative 'randomperson/ratio.rb'
+end

data/randomperson.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib/', __FILE__)
 $:.unshift lib unless $:.include?(lib)
-
+require 'randomperson/version'
 
 Gem::Specification.new do |s|
   s.name           = "randomperson"
@@ -9,16 +9,16 @@ Gem::Specification.new do |s|
   s.description = <<-EOF
     RandomPerson is a port to Ruby of Perl's Data::RandomPerson. Use it to generate random persons given various parameters, such as country, age and gender ratio.
   EOF
-  s.version        = "0.0.17"
+  s.version        = RandomPerson::VERSION 
   s.platform       = Gem::Platform::RUBY
-  s.require_paths  << 'ext'
+  s.require_path   = 'lib'
   s.required_ruby_version    = ">= 1.9.1"
   s.author         = "Iain Barnett"
-  s.files          = ['Rakefile', 'randomperson.gemspec']
-  s.files          += Dir['lib/**/*.rb']
+  s.files 	   = `git ls-files`.split("\n") 
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.homepage       = "http://github.com/yb66/RandomPerson"
   s.email          = "iainspeed @nospam@ gmail.com"
-  s.test_files     = Dir.glob('test/*.t')
   s.signing_key    = ENV['HOME'] + '/.ssh/gem-private_key.pem'
   s.cert_chain     = [ENV['HOME'] + '/.ssh/gem-public_cert.pem']
 end

data/spec/choice_spec.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require_relative "../lib/randomperson/choice.rb"
+
+
+module RandomPerson
+  
+  describe Choice do
+    
+    it "should not blow up on instatiation" do
+      Choice.new.should_not == nil
+    end
+  end # Choice
+end # RandomPerson

data/spec/generator_spec.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require_relative "../lib/randomperson/generator.rb"
+
+
+module RandomPerson
+  
+  describe Generator do
+    
+    it "should not blow up on instatiation" do
+      Generator.new.should_not == nil
+    end
+  end # Generator
+end # RandomPerson

data/spec/name_spec.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require_relative "../lib/randomperson/name.rb"
+
+
+module RandomPerson
+  
+  describe Name do
+    
+    it "should not blow up on instatiation" do
+      Name.new.should_not == nil
+    end
+  end # Name
+end # RandomPerson

data/test/test_Choice.rb

@@ -0,0 +1,140 @@
+require 'test/unit'
+require 'set'
+require_relative '../lib/randomperson/ext/Set.rb'
+require_relative '../lib/randomperson/ext/Enumerable.rb'
+require_relative '../lib/randomperson/ext/Kernel.rb'
+require_relative '../lib/randomperson/Name.rb'
+require_relative '../lib/randomperson/Names/AmericanFemaleFirst.rb'
+require_relative '../lib/randomperson/Names/AmericanMaleFirst.rb'
+require_relative '../lib/randomperson/Names/AmericanLast.rb'
+require_relative '../lib/randomperson/Names/BritishPrefix.rb'
+require_relative '../lib/randomperson/Names/BritishSuffix.rb'
+require_relative '../lib/randomperson/choice.rb'
+
+
+
+class TestTask < Test::Unit::TestCase
+  
+  def test_construction
+    #default choice
+    choice = RandomPerson::Choice.new
+    assert_not_nil choice
+    assert_equal [1,1] , choice.gender_ratio
+    assert_equal 0, choice.age_lower
+    assert_equal 100, choice.age_upper
+    
+    
+    choice2 = RandomPerson::Choice.new( gender_ratio:[2,1] )
+    assert_not_nil choice2
+    assert_equal [2,1] , choice2.gender_ratio
+    assert_equal 0, choice2.age_lower
+    assert_equal 100, choice2.age_upper
+    
+    
+    choice3 = RandomPerson::Choice.new( age_lower: 20 )
+    assert_not_nil choice3
+    assert_equal [1,1] , choice3.gender_ratio
+    assert_equal 20, choice3.age_lower
+    assert_equal 100, choice3.age_upper
+    
+    
+    choice4 = RandomPerson::Choice.new( age_upper: 50 )
+    assert_not_nil choice4
+    assert_equal [1,1] , choice4.gender_ratio
+    assert_equal 0, choice4.age_lower
+    assert_equal 50, choice4.age_upper
+    
+    
+    choice5 = RandomPerson::Choice.new( gender_ratio:[10,1], age_upper: 105 )
+    assert_not_nil choice5
+    assert_equal [10,1] , choice5.gender_ratio
+    assert_equal 0, choice5.age_lower
+    assert_equal 105, choice5.age_upper
+  end
+  
+  def test_reset_names
+    
+    choice = RandomPerson::Choice.new
+    choice.add_American
+    choice.add_British
+    
+    assert_not_nil choice.malefirst
+    assert_not_nil choice.femalefirst
+    assert_not_nil choice.last
+    assert_not_nil choice.prefix
+    assert_not_nil choice.suffix
+    
+    choice.reset_names
+    
+    assert_nil choice.malefirst
+    assert_nil choice.femalefirst
+    assert_nil choice.last
+    assert_nil choice.prefix
+    assert_nil choice.suffix
+   
+  end
+
+  #this is a test for method_missing add_NAME method
+  def test_add_NAME
+  
+    choice = RandomPerson::Choice.new
+    assert_nil choice.malefirst
+    assert_nil choice.femalefirst
+    assert_nil choice.last
+    assert_nil choice.prefix
+    assert_nil choice.suffix
+    
+    choice.add_American
+    choice.add_British
+    
+    assert_not_nil choice.malefirst
+    assert_not_nil choice.femalefirst
+    assert_not_nil choice.last
+    assert_not_nil choice.prefix
+    assert_not_nil choice.suffix
+    
+    assert_instance_of RandomPerson::Names::AmericanMaleFirst, choice.malefirst
+    assert_instance_of RandomPerson::Names::AmericanFemaleFirst, choice.femalefirst
+    assert_instance_of RandomPerson::Names::AmericanLast, choice.last
+    assert_instance_of RandomPerson::Names::BritishPrefix, choice.prefix
+    assert_instance_of RandomPerson::Names::BritishSuffix, choice.suffix
+  end
+  
+  def test_load_names
+    choice = RandomPerson::Choice.new
+    assert_not_nil choice.available_classes
+    
+    len = choice.available_classes.length
+    
+    
+    assert_not_equal 0, len
+    
+    choice2 = RandomPerson::Choice.new( gender_ratio:[10,1], age_lower: 25, age_upper: 105 )
+    
+    assert_not_nil choice2.available_classes #just for the helluvit
+    
+    assert_equal len, choice.available_classes.length
+    assert_equal len, choice2.available_classes.length
+    
+  end
+  
+  
+  def test_reset_parameters
+    choice = RandomPerson::Choice.new
+    choice.reset_parameters
+    
+    assert_nil choice.gender_ratio
+    assert_nil choice.age_lower
+    assert_nil choice.age_upper
+    
+    
+    choice2 = RandomPerson::Choice.new( gender_ratio:[10,1], age_lower: 25, age_upper: 105 )
+    choice2.reset_parameters
+    
+    assert_nil choice2.gender_ratio
+    assert_nil choice2.age_lower
+    assert_nil choice2.age_upper
+  end
+
+
+end

data/test/test_Generator.rb

@@ -0,0 +1,111 @@
+require 'test/unit'
+require 'date'
+require_relative '../lib/randomperson/ext/Date.rb'
+require_relative '../lib/randomperson/generator.rb'
+
+require 'set'
+require_relative '../lib/randomperson/ext/Set.rb'
+require_relative '../lib/randomperson/ext/Enumerable.rb'
+require_relative '../lib/randomperson/ext/Kernel.rb'
+require_relative '../lib/randomperson/Name.rb'
+require_relative '../lib/randomperson/Names/AmericanFemaleFirst.rb'
+require_relative '../lib/randomperson/Names/AmericanMaleFirst.rb'
+require_relative '../lib/randomperson/Names/AmericanLast.rb'
+require_relative '../lib/randomperson/Names/BritishPrefix.rb'
+require_relative '../lib/randomperson/Names/BritishSuffix.rb'
+require_relative '../lib/randomperson/choice.rb'
+
+require_relative '../lib/randomperson/ext/Array.rb'
+require_relative '../lib/randomperson/ext/Hash.rb'
+require_relative '../lib/randomperson/person.rb'
+
+
+class TestTask < Test::Unit::TestCase
+
+#   def setup
+#     g = RandomPerson::Generator.new
+#   end
+
+  # def teardown
+  # end
+  
+
+
+  def test_make_generator
+    
+    choice = RandomPerson::Choice.new
+    choice.add_American
+    choice.add_British
+    
+    g = RandomPerson::Generator.new
+    
+    assert g.generators.empty?
+    
+    g.make_generator choice
+    
+    assert_not_nil g.generators
+    assert_equal 1, g.generators.length
+    
+    assert_instance_of RandomPerson::Person, g.generators[0].call
+    
+    people = [ ]
+    
+    10000.times { people << g.generators[0].call }
+    
+    assert_nil people.uniq!
+    
+  end
+
+  def test_ratiod
+    assert_kind_of Array, RandomPerson::Generator.ratiod( [1,1] ) 
+    assert_kind_of Range, RandomPerson::Generator.ratiod([1,1]).first
+    assert_equal 25, RandomPerson::Generator.ratiod([1,3]).first.end
+  end
+
+  def test_pick_gender
+    assert_not_nil RandomPerson::Generator.pick_gender()
+    assert_equal( RandomPerson::Generator.pick_gender([1,0]), 'm' )
+    assert_equal( RandomPerson::Generator.pick_gender([0,1]), 'f' )
+    
+    assert_equal( RandomPerson::Generator.pick_gender([10,0]), 'm' )
+    assert_equal( RandomPerson::Generator.pick_gender([0,10]), 'f' )
+  end
+  
+  def test_reset
+#     choice = RandomPerson::Choice.new
+#     choice2 = RandomPerson::Choice.new
+    g = RandomPerson::Generator.new
+#     g.make_generator choice
+#     g.make_generator choice2
+#     assert_equal( 2, g.generators.length )
+#     g.reset
+#     assert_equal( 2, g.generators.length )
+#     assert( g.generators.empty? )
+  end
+  
+  def test_pick_age
+    n = 2000
+    while n > 0
+      r1 = rand(100)
+      r2 = rand(100) + r1
+      age = RandomPerson::Generator.pick_age(r1, r2)
+      assert_not_nil age 
+      assert( r2 >= age && age >= r1, "age #{age} r1 #{r1} r2 #{r2}" ) 
+      n = n - 1
+    end
+  end
+  
+  def test_pick_dob
+    n = 1000
+    while n > 0
+      r1 = rand(100)
+      dob = RandomPerson::Generator.pick_dob(r1)
+      assert_not_nil dob 
+      assert_kind_of Time, dob
+      assert_equal Time.now.year - r1, dob.year
+      n = n - 1
+    end
+  end
+  
+  
+end