ffaker 2.0.0 → 2.1.0

data/lib/ffaker/utils/array_utils.rb

@@ -7,8 +7,8 @@ module FFaker
     end
 
     def self.random_pick(array, n)
-      indexes = (0...array.length).sort_by{Kernel.rand}[0...n]
-      indexes.map { |n| array[n].dup }
+      warn '[ArrayUtils.random_pick] is deprecated. Please use the Array#sample method'
+      array.sample(n)
     end
 
     def self.rand(array)
@@ -27,7 +27,8 @@ module FFaker
     end
 
     def random_pick(n)
-      ArrayUtils.random_pick(self, n)
+      warn '[ArrayUtils#random_pick] is deprecated. Please use the Array#sample method'
+      self.sample(n)
     end
 
     def rand

data/lib/ffaker/vehicle.rb

@@ -26,7 +26,7 @@ module FFaker
 
     def manufacturer_color(n=2)
       # Take two prefixes because it's more fun than one
-      [COLOR_PREFIXES.random_pick(n), self.base_color].flatten.join(' ')
+      (COLOR_PREFIXES.sample(n) + [base_color]).join(' ')
     end
     alias_method :mfg_color, :manufacturer_color
 

data/scripts/reference.rb

@@ -0,0 +1,89 @@
+$: << File.dirname(__FILE__) + '/../lib'
+require 'ffaker'
+
+ICONS = {
+  :error => "‼️",
+  :warning => "❗"
+}
+
+# Get a list of sections
+def faker_modules
+  FFaker.constants.map do |const|
+    mod = FFaker.const_get(const)
+    next unless mod.is_a?(Module)
+    next if mod == FFaker::ArrayUtils
+    next if mod == FFaker::ModuleUtils
+    mod
+  end.compact
+end
+
+# Returns faker methods for a given module
+def faker_methods(mod)
+  methods = mod.methods - Module.methods - [:k, :underscore]
+
+  # For Company.name (et al), don't discard :name if it was reimplemented
+  methods << :name if mod.send(:name) != mod.to_s
+  methods
+end
+
+# Catch deprecation warnings.
+# This `#warn` overrides Kernel#warn
+def warn(msg)
+  $warnings << msg if $warnings
+end
+
+def catch_warnings(&blk)
+  $warnings = []
+  [yield, $warnings]
+end
+
+def escape(str)
+  str.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;').gsub("\n", '')
+end
+
+sections = faker_modules.each.map do |mod|
+  lines = []
+
+  methods = faker_methods(mod)
+  lines << "## #{mod}"
+  lines << ""
+  lines << "| Method | Example |"
+  lines << "| ------ | ------- |"
+
+  methods.sort.each do |meth|
+    arity = mod.method(meth).arity
+
+    left = "`#{meth}`"
+    right =''
+
+    if arity > 0
+      left = "`#{meth}`(#{arity.times.map{'...'}.join(', ')})"
+    else
+      begin
+        examples, warnings = catch_warnings {
+          3.times.map { mod.send meth }
+        }
+        if warnings.any?
+          right = "#{ICONS[:warning]} *#{warnings.first}*"
+        else
+          right = "#{escape examples.join(', ')}"
+        end
+      rescue => e
+        right = "#{ICONS[:error]} #{e.class}: #{e.message}"
+      end
+    end
+
+    lines << "| #{left} | #{right} |"
+  end
+
+  lines << ""
+end
+
+puts "# FFaker reference"
+puts ""
+faker_modules.each do |mod|
+  name = mod.to_s.downcase.gsub(':', '')
+  puts " * [#{mod}](##{name})"
+end
+puts ""
+puts sections.flatten.join("\n")

data/test/test_address_ca.rb

@@ -4,18 +4,20 @@ require 'helper'
 
 class TestAddressCA < Test::Unit::TestCase
   def test_province
-    assert_match /[ a-z]/, FFaker::AddressCA.province
+    assert_match(/\A[ a-z]+\z/i, FFaker::AddressCA.province)
   end
 
   def test_province_abbr
-    assert_match /[A-Z][A-Z]/, FFaker::AddressCA.province_abbr
+    assert_match(/\A[A-Z]{2}\z/, FFaker::AddressCA.province_abbr)
   end
 
   def test_city
-    assert FFaker::AddressCA::CITY.include?(FFaker::AddressCA.city)
+    assert_include(FFaker::AddressCA::CITY, FFaker::AddressCA.city)
   end
 
   def test_postal_code
-    assert_match /[A-Z]\d[A-Z]\W\d[A-Z]\d/, FFaker::AddressCA.postal_code
+    assert_match(
+      /\A[A-CEGHJK-NPR-TVXY]\d[A-CEGHJK-NPR-TV-Z] \d[A-CEGHJK-NPR-TV-Z]\d\z/,
+      FFaker::AddressCA.postal_code)
   end
 end

data/test/test_array_utils.rb

@@ -22,12 +22,12 @@ class TestArrayUtils < Test::Unit::TestCase
     assert set == @elems
   end
 
-   def test_provides_a_way_of_getting_n_random_elements
-    assert_equal @array.random_pick(3).sort, @array.sort
+  def test_provides_a_way_of_getting_n_random_elements
+    assert_equal @array.sample(3).sort, @array.sort
 
     1.upto(3) do |n|
       1000.times do
-        new_arr = @array.random_pick(n)
+        new_arr = @array.sample(n)
         assert_equal n, new_arr.length
         new_arr.each do |e|
           assert @elems.include? e

data/test/test_avatar.rb

@@ -0,0 +1,50 @@
+require 'helper'
+
+class TestAvatar < Test::Unit::TestCase
+  def setup
+    @tester = FFaker::Avatar
+  end
+
+  def test_avatar
+    assert_match(/\Ahttp:\/\/robohash\.org\/.+\.png\?size=300x300\z/,
+                 @tester.image)
+  end
+
+  def test_avatar_with_param
+    assert_equal('http://robohash.org/faker.png?size=300x300',
+                 @tester.image('faker'))
+  end
+
+  def test_avatar_with_correct_size
+    assert_equal('http://robohash.org/faker.png?size=150x320',
+                 @tester.image('faker', '150x320'))
+  end
+
+  def test_avatar_with_incorrect_size
+    assert_raise ArgumentError do
+      @tester.image(nil, '150x320z')
+    end
+  end
+
+  def test_avatar_with_supported_format
+    assert_equal('http://robohash.org/faker.jpg?size=300x300',
+                 @tester.image('faker', '300x300', 'jpg'))
+  end
+
+  def test_avatar_with_incorrect_format
+    assert_raise ArgumentError do
+      @tester.image(nil, '300x300', 'wrong_format')
+    end
+  end
+
+  def test_avatar_with_correct_background
+    assert_equal('http://robohash.org/faker.png?size=300x300&bgset=bg1',
+                 @tester.image('faker', '300x300', 'png', '1'))
+  end
+
+  def test_avatar_with_incorrect_background
+    assert_raise ArgumentError do
+      @tester.image('faker', '300x300', 'png', 'not_a_number')
+    end
+  end
+end

data/test/test_company.rb

@@ -3,21 +3,23 @@
 require 'helper'
 
 class TestCompany < Test::Unit::TestCase
+  def setup
+    @tester = FFaker::Company
+  end
+
   def test_bs
-    assert_match /[ a-z]+/, FFaker::Company.bs
-    assert_match /\s/, FFaker::Company.bs
+    assert_match(/\A[ \w'\/-]+\z/, @tester.bs)
   end
 
   def test_catch_phrase
-    assert_match /[ a-z]+/, FFaker::Company.catch_phrase
-    assert_match /\s/, FFaker::Company.catch_phrase
+    assert_match(/\A[ \w'\/-]+\z/, @tester.catch_phrase)
   end
 
   def test_name
-    assert_match /[ a-z]+/, FFaker::Company.name
+    assert_match(/\A[ \w,'-]+\z/, @tester.name)
   end
 
   def test_suffix
-    assert_match /[ a-z]+/i, FFaker::Company.suffix
+    assert_include @tester::SUFFIXES, @tester.suffix
   end
 end

data/test/test_identification.rb

@@ -9,19 +9,20 @@ class TestFakerIdentification < Test::Unit::TestCase
 
   def test_drivers_license
     ###-###-##-###-#
-    assert_match /[A-Z]\d{3}-\d{3}-\d{2}-\d{3}-\d{1}/, @tester.drivers_license
+    drivers_license_regex = /\A[A-Z]\d{3}-\d{3}-\d{2}-\d{3}-\d{1}\z/
+    assert_match drivers_license_regex, @tester.drivers_license
   end
 
   def test_ssn
-    assert_match /\d{3}-\d{2}-\d{4}/, @tester.ssn
+    assert_match(/\A\d{3}-\d{2}-\d{4}\z/, @tester.ssn)
   end
 
   def test_gender
-    assert_match /(Male|Female)/, @tester.gender
+    assert_match(/\A(Male|Female)\z/, @tester.gender)
   end
 
   def test_ethnicity
-    ethnicity_regex = /(African American|Asian\/Pacific Islander|Caucasian|Hispanic|Native American|Multiracial|Other|Prefer not to respond)/
+    ethnicity_regex = /\A(African American|Asian\/Pacific Islander|Caucasian|Hispanic|Native American|Multiracial|Other|Prefer not to respond)\z/
     assert_match ethnicity_regex, @tester.ethnicity
   end
 end

data/test/test_identification_kr.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require 'helper'
+
+class TestFakerIdentificationKr < Test::Unit::TestCase
+  def setup
+    @tester = FFaker::IdentificationKr
+  end
+
+  def test_rrn
+    assert_match(/\A\d{6}-\d{7}\z/, @tester.rrn)
+  end
+end

data/test/test_internet.rb

@@ -81,6 +81,10 @@ class TestFakerInternet < Test::Unit::TestCase
     assert @tester.password(1, 3).length < 4
   end
 
+  def test_password_fixed_length
+    assert @tester.password(20, 20).length == 20
+  end
+
   def test_password_strange_argument
     assert @tester.password(10, 2).length > 9
     assert @tester.password(3, 1).length > 2

data/test/test_job.rb

@@ -8,7 +8,6 @@ class TestFakerJob < Test::Unit::TestCase
   end
 
   def test_title
-    assert @tester.title.match(/(\w+\.? ?){2,3}/)
+    assert_match(/\A(\w+\.? ?){2,3}\z/, @tester.title)
   end
 end
-

data/test/test_job_cn.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+
+require 'helper'
+
+class TestFakerJobCN < Test::Unit::TestCase
+  def setup
+    @tester = FFaker::JobCN
+  end
+
+  def test_title
+    assert @tester.title.length >= 1
+  end
+
+  def test_nouns
+    assert_kind_of Array, @tester::JOB_NOUNS
+  end
+end

data/test/test_job_fr.rb

@@ -8,15 +8,12 @@ class TestFakerJobFr < Test::Unit::TestCase
   end
 
   def test_title
-    assert @tester.title.match(/(\w+\.? ?){2,3}/)
+    assert_match(/\A([a-zàâçéèêëîïôûùüÿñæœ]+\.? ?){2,}\z/, @tester.title)
   end
 
-
   def test_prefix
-    assert @tester::JOB_PREFIXES.is_a?(Array)
-    assert @tester::JOB_ADJECTIVES.is_a?(Array)
-    assert @tester::JOB_NOUNS.is_a?(Array)
+    assert_kind_of Array, @tester::JOB_PREFIXES
+    assert_kind_of Array, @tester::JOB_ADJECTIVES
+    assert_kind_of Array, @tester::JOB_NOUNS
   end
 end
-
-

data/test/test_job_ja.rb

@@ -12,6 +12,6 @@ class TestFakerJobJA < Test::Unit::TestCase
   end
 
   def test_nouns
-    assert @tester::JOB_NOUNS.is_a?(Array)
+    assert_kind_of Array, @tester::JOB_NOUNS
   end
 end

data/test/test_job_kr.rb

@@ -12,6 +12,6 @@ class TestFakerJobKR < Test::Unit::TestCase
   end
 
   def test_nouns
-    assert @tester::JOB_NOUNS.is_a?(Array)
+    assert_kind_of Array, @tester::JOB_NOUNS
   end
 end

data/test/test_locale.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'helper'
+
+class TestLocale < Test::Unit::TestCase
+  def test_code
+    assert_match /./, FFaker::Locale.code
+  end
+
+  def test_language
+    assert_match /./, FFaker::Locale.language
+  end
+
+  def test_language_with_args
+    assert_match 'French', FFaker::Locale.language('FR')
+  end
+
+  def test_code_with_args
+    assert_match 'FR', FFaker::Locale.code('French')
+  end
+end

data/test/test_lorem_kr.rb

@@ -17,7 +17,7 @@ class TestLoremKR < Test::Unit::TestCase
   def test_sentence
     assert_match KOREAN_SENTENCE_MATCHER, @tester.sentence
     assert_nothing_thrown do
-      100.times { FFaker::Lorem.sentence 0 }
+      100.times { @tester.sentence 0 }
     end
   end
 

data/test/test_movie.rb

@@ -3,7 +3,15 @@
 require 'helper'
 
 class TestMovie < Test::Unit::TestCase
+  def setup
+    @tester = FFaker::Movie
+  end
+
   def test_title
     assert_match /[ a-z]+/, FFaker::Movie.title
   end
+
+  def test_rating
+    assert FFaker::Movie::RATINGS.include? @tester.rating
+  end
 end

data/test/test_name.rb

@@ -8,14 +8,14 @@ class TestFakerName < Test::Unit::TestCase
   end
 
   def test_name
-    assert @tester.name.match(/(\w+\.? ?){2,3}/)
+    assert_match(/(\w+\.? ?){2,3}/, @tester.name)
   end
 
   def test_prefix
-    assert @tester.prefix.match(/[A-Z][a-z]+\.?/)
+    assert_match(/[A-Z][a-z]+\.?/, @tester.prefix)
   end
 
   def test_suffix
-    assert @tester.suffix.match(/[A-Z][a-z]*\.?/)
+    assert_match(/[A-Z][a-z]*\.?/, @tester.suffix)
   end
 end

data/test/test_name_br.rb

@@ -8,25 +8,24 @@ class TestFakerNameBR < Test::Unit::TestCase
   end
 
   def test_name
-    assert_match /[[:alpha:]]+ [[:alpha:]]+/, @tester.name
+    assert_match(/\A[[:alpha:]]+ [[:alpha:]]+\z/, @tester.name)
   end
 
   def test_name_with_prefix
-    prefixes = @tester::PREFIXES
-    parts = @tester.name_with_prefix.split(/\s+/)
-    assert prefixes.include?(parts.first)
-    assert(parts[1].length > 0)
+    prefix, name = @tester.name_with_prefix.split(/\s+/)
+    assert_include(@tester::PREFIXES, prefix)
+    assert(name.length > 0)
   end
 
   def test_first_name
-    assert @tester::FIRST_NAMES.include? @tester.first_name
+    assert_include(@tester::FIRST_NAMES, @tester.first_name)
   end
 
   def test_last_name
-    assert @tester::LAST_NAMES.include? @tester.last_name
+    assert_include(@tester::LAST_NAMES, @tester.last_name)
   end
 
   def test_prefix
-    assert @tester::PREFIXES.include? @tester.prefix
+    assert_include(@tester::PREFIXES, @tester.prefix)
   end
 end