ffaker 2.16.0 → 2.20.0

data/lib/ffaker/unit_english.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'ffaker/unit'
-require 'ostruct'
-
 module FFaker
   module UnitEnglish
     include FFaker::Unit
@@ -15,7 +12,7 @@ module FFaker
       { name: 'foot', abbreviation: 'ft' },
       { name: 'yard', abbreviation: 'yd' },
       { name: 'furlong', abbreviation: 'fur' },
-      { name: 'mile', abbreviation: 'm' }
+      { name: 'mile', abbreviation: 'mi' }
     ].freeze
     MASS_UNITS = [
       { name: 'grains', abbreviation: 'gr' },
@@ -36,75 +33,75 @@ module FFaker
       { name: 'cubic yard', abbreviation: 'CY' }
     ].freeze
     AREA_UNITS = [
-      { name: 'square inch', abbreviation: 'sq. in' },
+      { name: 'square inch', abbreviation: 'sq in' },
       { name: 'square foot', abbreviation: 'sq ft' },
       { name: 'square yard', abbreviation: 'sq yd' },
       { name: 'acre', abbreviation: 'ac' },
       { name: 'section', abbreviation: 's' },
       { name: 'square mile', abbreviation: 'sq mi' },
-      { name: 'township', abbreviation: 'Twp' }
+      { name: 'township', abbreviation: 'twp' }
     ].freeze
 
     def mass_name
-      mass.name
+      mass[:name]
     end
 
     def mass_abbr
-      mass.abbreviation
+      mass[:abbreviation]
     end
 
     def length_name
-      length.name
+      length[:name]
     end
 
     def length_abbr
-      length.abbreviation
+      length[:abbreviation]
     end
 
     def liquid_name
-      liquid.name
+      liquid[:name]
     end
 
     def liquid_abbr
-      liquid.abbreviation
+      liquid[:abbreviation]
     end
 
     def volume_name
-      volume.name
+      volume[:name]
     end
 
     def volume_abbr
-      volume.abbreviation
+      volume[:abbreviation]
     end
 
     def area_name
-      area.name
+      area[:name]
     end
 
     def area_abbr
-      area.abbreviation
+      area[:abbreviation]
     end
 
     private
 
     def length
-      OpenStruct.new(fetch_sample(LENGTH_UNITS))
+      fetch_sample(LENGTH_UNITS)
     end
 
     def mass
-      OpenStruct.new(fetch_sample(MASS_UNITS))
+      fetch_sample(MASS_UNITS)
     end
 
     def liquid
-      OpenStruct.new(fetch_sample(LIQUID_UNITS))
+      fetch_sample(LIQUID_UNITS)
     end
 
     def volume
-      OpenStruct.new(fetch_sample(VOLUME_UNITS))
+      fetch_sample(VOLUME_UNITS)
     end
 
     def area
-      OpenStruct.new(fetch_sample(AREA_UNITS))
+      fetch_sample(AREA_UNITS)
     end
   end
 end

data/lib/ffaker/unit_metric.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'ffaker/unit'
-require 'ostruct'
-
 module FFaker
   module UnitMetric
     include FFaker::Unit
@@ -37,65 +34,65 @@ module FFaker
     ].freeze
 
     def mass_name
-      mass.name
+      mass[:name]
     end
 
     def mass_abbr
-      mass.abbreviation
+      mass[:abbreviation]
     end
 
     def length_name
-      length.name
+      length[:name]
     end
 
     def length_abbr
-      length.abbreviation
+      length[:abbreviation]
     end
 
     def liquid_name
-      liquid.name
+      liquid[:name]
     end
 
     def liquid_abbr
-      liquid.abbreviation
+      liquid[:abbreviation]
     end
 
     def volume_name
-      volume.name
+      volume[:name]
     end
 
     def volume_abbr
-      volume.abbreviation
+      volume[:abbreviation]
     end
 
     def area_name
-      area.name
+      area[:name]
     end
 
     def area_abbr
-      area.abbreviation
+      area[:abbreviation]
     end
 
     private
 
     def length
-      OpenStruct.new(fetch_sample(LENGTH_UNITS))
+      fetch_sample(LENGTH_UNITS)
     end
 
     def mass
-      OpenStruct.new(fetch_sample(MASS_UNITS))
+      fetch_sample(MASS_UNITS)
     end
 
     def liquid
-      OpenStruct.new(fetch_sample(LIQUID_UNITS))
+      fetch_sample(LIQUID_UNITS)
     end
 
     def volume
-      OpenStruct.new(fetch_sample(VOLUME_UNITS))
+      fetch_sample(VOLUME_UNITS)
     end
 
     def area
-      OpenStruct.new(fetch_sample(AREA_UNITS))
+      fetch_sample(AREA_UNITS)
     end
   end
 end

data/lib/ffaker/utils/array_utils.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ffaker/utils/random_utils'
+require_relative 'random_utils'
 
 module FFaker
   module ArrayUtils

data/lib/ffaker/utils/module_utils.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'ffaker/utils/array_utils'
-require 'ffaker/utils/random_utils'
-require 'ffaker/utils/unique_utils'
+require_relative 'array_utils'
+require_relative 'random_utils'
+require_relative 'unique_utils'
 
 module FFaker
   module ModuleUtils
@@ -35,5 +35,25 @@ module FFaker
     def unique(max_retries = 10_000)
       @unique_generator ||= FFaker::UniqueUtils.new(self, max_retries)
     end
+
+    # http://en.wikipedia.org/wiki/Luhn_algorithm
+    def luhn_check(number)
+      multiplications = []
+
+      number.split(//).each_with_index do |digit, i|
+        multiplications << i.even? ? digit.to_i * 2 : digit.to_i
+      end
+
+      sum = 0
+      multiplications.each do |num|
+        num.to_s.each_byte do |character|
+          sum += character.chr.to_i
+        end
+      end
+
+      control_digit = (sum % 10).zero? ? 0 : (sum / 10 + 1) * 10 - sum
+      control_digit.to_s
+    end
+
   end
 end

data/lib/ffaker/vehicle.rb

@@ -6,7 +6,7 @@ module FFaker
     extend self
 
     DRIVETRAINS = %w[4WD 4X4 AWD FWD RWD].freeze
-    YEARS = [*'1900'..(::Time.now.year + 1).to_s].freeze
+    YEARS = Array('1900'..(::Time.now.year + 1).to_s).freeze
     TRANSMISSIONS_ABBR = %w[AT MT AM CVT].freeze
     CYLINDERS = %w[2 5 6 8].freeze
 

data/lib/ffaker.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module FFaker
-  require 'ffaker/utils/array_utils'
-  require 'ffaker/utils/module_utils'
+  require_relative 'ffaker/utils/array_utils'
+  require_relative 'ffaker/utils/module_utils'
 
   extend ModuleUtils
 
   BASE_LIB_PATH = File.expand_path(__dir__)
 
-  LETTERS = [*'a'..'z'].freeze
+  LETTERS = Array('a'..'z').freeze
 
   HEX = %w[0 1 2 3 4 5 6 7 8 9 A B C D E F].freeze
 
@@ -43,6 +43,7 @@ module FFaker
   autoload :AddressGR, 'ffaker/address_gr'
   autoload :AddressID, 'ffaker/address_id'
   autoload :AddressIN, 'ffaker/address_in'
+  autoload :AddressIT, 'ffaker/address_it'
   autoload :AddressJA, 'ffaker/address_ja'
   autoload :AddressKR, 'ffaker/address_kr'
   autoload :AddressMX, 'ffaker/address_mx'
@@ -73,25 +74,31 @@ module FFaker
   autoload :ColorUA, 'ffaker/color_ua'
   autoload :Company, 'ffaker/company'
   autoload :CompanyCN, 'ffaker/company_cn'
+  autoload :CompanyFR, 'ffaker/company_fr'
   autoload :CompanyIT, 'ffaker/company_it'
   autoload :CompanyJA, 'ffaker/company_ja'
   autoload :CompanySE, 'ffaker/company_se'
   autoload :Conference, 'ffaker/conference'
-  autoload :CoursesFR, 'ffaker/courses'
+  autoload :CoursesFR, 'ffaker/courses_fr'
   autoload :Currency, 'ffaker/currency'
   autoload :DizzleIpsum, 'ffaker/dizzle_ipsum'
   autoload :Education, 'ffaker/education'
   autoload :EducationCN, 'ffaker/education_cn'
   autoload :Filesystem, 'ffaker/filesystem'
   autoload :Food, 'ffaker/food'
+  autoload :FoodPL, 'ffaker/food_pl'
+  autoload :FreedomIpsum, 'ffaker/freedom_ipsum'
+  autoload :Game, 'ffaker/game'
   autoload :Gender, 'ffaker/gender'
   autoload :GenderBR, 'ffaker/gender_br'
   autoload :GenderCN, 'ffaker/gender_cn'
   autoload :GenderID, 'ffaker/gender_id'
+  autoload :GenderIT, 'ffaker/gender_it'
   autoload :GenderJA, 'ffaker/gender_ja'
   autoload :GenderJP, 'ffaker/gender_jp'
   autoload :GenderKR, 'ffaker/gender_kr'
   autoload :GenderPL, 'ffaker/gender_pl'
+  autoload :GenderRU, 'ffaker/gender_ru'
   autoload :Geolocation, 'ffaker/geolocation'
   autoload :Guid, 'ffaker/guid'
   autoload :HealthcareIpsum, 'ffaker/healthcare_ipsum'
@@ -104,6 +111,7 @@ module FFaker
   autoload :IdentificationESCL, 'ffaker/identification_es_cl'
   autoload :IdentificationESCO, 'ffaker/identification_es_co'
   autoload :IdentificationIN, 'ffaker/identification_in'
+  autoload :IdentificationIT, 'ffaker/identification_it'
   autoload :IdentificationKr, 'ffaker/identification_kr'
   autoload :IdentificationMX, 'ffaker/identification_mx'
   autoload :IdentificationPL, 'ffaker/identification_pl'
@@ -115,15 +123,18 @@ module FFaker
   autoload :JobBR, 'ffaker/job_br'
   autoload :JobCN, 'ffaker/job_cn'
   autoload :JobFR, 'ffaker/job_fr'
+  autoload :JobIT, 'ffaker/job_it'
   autoload :JobJA, 'ffaker/job_ja'
   autoload :JobKR, 'ffaker/job_kr'
   autoload :JobVN, 'ffaker/job_vn'
   autoload :Locale, 'ffaker/locale'
   autoload :Lorem, 'ffaker/lorem'
   autoload :LoremAR, 'ffaker/lorem_ar'
+  autoload :LoremBR, 'ffaker/lorem_br'
   autoload :LoremCN, 'ffaker/lorem_cn'
   autoload :LoremFR, 'ffaker/lorem_fr'
   autoload :LoremIE, 'ffaker/lorem_ie'
+  autoload :LoremIT, 'ffaker/lorem_it'
   autoload :LoremJA, 'ffaker/lorem_ja'
   autoload :LoremKR, 'ffaker/lorem_kr'
   autoload :LoremPL, 'ffaker/lorem_pl'
@@ -162,6 +173,7 @@ module FFaker
   autoload :NameUA, 'ffaker/name_ua'
   autoload :NameVN, 'ffaker/name_vn'
   autoload :NatoAlphabet, 'ffaker/nato_alphabet'
+  autoload :Number, 'ffaker/number'
   autoload :PhoneNumber, 'ffaker/phone_number'
   autoload :PhoneNumberAU, 'ffaker/phone_number_au'
   autoload :PhoneNumberBR, 'ffaker/phone_number_br'
@@ -172,6 +184,7 @@ module FFaker
   autoload :PhoneNumberFR, 'ffaker/phone_number_fr'
   autoload :PhoneNumberID, 'ffaker/phone_number_id'
   autoload :PhoneNumberIT, 'ffaker/phone_number_it'
+  autoload :PhoneNumberJA, 'ffaker/phone_number_ja'
   autoload :PhoneNumberKR, 'ffaker/phone_number_kr'
   autoload :PhoneNumberMX, 'ffaker/phone_number_mx'
   autoload :PhoneNumberNL, 'ffaker/phone_number_nl'
@@ -188,6 +201,7 @@ module FFaker
   autoload :Sport, 'ffaker/sport'
   autoload :SportPL, 'ffaker/sport_pl'
   autoload :SportUS, 'ffaker/sport_us'
+  autoload :SportRU, 'ffaker/sport_ru'
   autoload :SSN, 'ffaker/ssn'
   autoload :SSNMX, 'ffaker/ssn_mx'
   autoload :SSNSE, 'ffaker/ssn_se'
@@ -197,6 +211,7 @@ module FFaker
   autoload :Unit, 'ffaker/unit'
   autoload :UnitEnglish, 'ffaker/unit_english'
   autoload :UnitMetric, 'ffaker/unit_metric'
+  autoload :VERSION, 'version'
   autoload :Vehicle, 'ffaker/vehicle'
   autoload :Venue, 'ffaker/venue'
   autoload :Youtube, 'ffaker/youtube'

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FFaker
-  VERSION = '2.16.0'
+  VERSION = '2.20.0'
 end

data/scripts/profiling.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.dirname(__FILE__) + '/../lib/faker'
+require_relative '../lib/faker'
 
 N = 1_000_000
 

data/scripts/reference.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-$LOAD_PATH << File.dirname(__FILE__) + '/../lib'
-require 'ffaker'
+require_relative '../lib/ffaker'
 
 ICONS = {
   error: '‼️',
@@ -25,7 +24,7 @@ end
 # Returns faker methods for a given module
 def faker_methods(mod)
   methods = mod.methods - Module.methods -
-            %i[k underscore fetch_sample rand shuffle unique]
+            %i[k underscore fetch_sample rand shuffle unique luhn_check]
 
   # For Company.name (et al), don't discard :name if it was reimplemented
   methods << :name if mod.send(:name) != mod.to_s

data/test/helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'test/unit'
-require 'ffaker'
+require_relative '../lib/ffaker'
 
 # Helpers for checking if a method is deterministic -- e.g., that the Random
 # results are repeatable given the same random seed.
@@ -45,9 +45,9 @@ module DeterministicHelper
     end
   end
 
-  def assert_between(got, from, to, exclude_end: false)
-    assert_greater_than_or_equal_to got, from
-    public_send "assert_less_than#{'_or_equal_to' unless exclude_end}", got, to
+  def assert_between(got, range)
+    assert_greater_than_or_equal_to got, range.begin
+    public_send "assert_less_than#{'_or_equal_to' unless range.exclude_end?}", got, range.end
   end
 
   def assert_random(original_block, *args)

data/test/test_address.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddress < Test::Unit::TestCase
   include DeterministicHelper

data/test/test_address_au.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressAU < Test::Unit::TestCase
   include DeterministicHelper
@@ -33,7 +33,7 @@ class TestAddressAU < Test::Unit::TestCase
   end
 
   def test_full_address
-    assert_match(/[\, a-z]/, FFaker::AddressAU.full_address)
+    assert_match(/[, a-z]/, FFaker::AddressAU.full_address)
   end
 
   def test_au_suburb_with_states
@@ -60,7 +60,7 @@ class TestAddressAU < Test::Unit::TestCase
 
   def test_full_address_with_states
     FFaker::AddressAU::STATE_ABBR.each do |st_abbr|
-      assert_match(/[\, a-z]/, FFaker::AddressAU.full_address(st_abbr))
+      assert_match(/[, a-z]/, FFaker::AddressAU.full_address(st_abbr))
       assert_deterministic { FFaker::AddressAU.full_address(st_abbr) }
     end
   end

data/test/test_address_br.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressBR < Test::Unit::TestCase
   include DeterministicHelper
@@ -32,6 +32,6 @@ class TestAddressBR < Test::Unit::TestCase
 
   def test_street
     prefixes = FFaker::AddressBR::STREET_PREFIX
-    assert_match(/(#{prefixes.join('|')})( [\p{Alpha}]+){1,2}/, FFaker::AddressBR.street)
+    assert_match(/(#{prefixes.join('|')})( \p{Alpha}+){1,2}/, FFaker::AddressBR.street)
   end
 end

data/test/test_address_ca.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressCA < Test::Unit::TestCase
   include DeterministicHelper

data/test/test_address_ch.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressCHCH < Test::Unit::TestCase
   include DeterministicHelper

data/test/test_address_ch_de.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressCHDE < Test::Unit::TestCase
   include DeterministicHelper

data/test/test_address_ch_fr.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressCHFR < Test::Unit::TestCase
   include DeterministicHelper

data/test/test_address_ch_it.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressCHIT < Test::Unit::TestCase
   include DeterministicHelper

data/test/test_address_da.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressDA < Test::Unit::TestCase
   include DeterministicHelper

data/test/test_address_de.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressDE < Test::Unit::TestCase
   include DeterministicHelper

data/test/test_address_fi.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressFI < Test::Unit::TestCase
   include DeterministicHelper
 
-  ALPHA = /\A[\p{Alpha}]+/.freeze
+  ALPHA = /\A\p{Alpha}+/.freeze
   DIGIT = /\d{1}/.freeze
 
   assert_methods_are_deterministic(
@@ -30,7 +30,7 @@ class TestAddressFI < Test::Unit::TestCase
     assert_match(ALPHA, address)
     assert_match(DIGIT, address)
     assert_match(/SUOMI/, address)
-    assert_match(/[\, a-z]/, address)
+    assert_match(/[, a-z]/, address)
   end
 
   def test_fi_zip_code_frozen

data/test/test_address_fr.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressFR < Test::Unit::TestCase
   include DeterministicHelper

data/test/test_address_gr.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressGR < Test::Unit::TestCase
   include DeterministicHelper

data/test/test_address_id.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressID < Test::Unit::TestCase
   include DeterministicHelper
@@ -33,7 +33,7 @@ class TestAddressID < Test::Unit::TestCase
   def test_street
     prefixes = FFaker::AddressID::STREET_PREFIX
     common_street_names = FFaker::AddressID::COMMON_STREET_NAMES
-    regex = /\A(#{prefixes.join('|')})\.(\s(#{common_street_names.join('|')}))\,\sNo\.\s\d+\z/
+    regex = /\A(#{prefixes.join('|')})\.(\s(#{common_street_names.join('|')})),\sNo\.\s\d+\z/
     assert_match(regex, FFaker::AddressID.street)
   end
 end

data/test/test_address_in.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressININ < Test::Unit::TestCase
   include DeterministicHelper

data/test/test_address_it.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+class TestAddressIT < Test::Unit::TestCase
+  include DeterministicHelper
+
+  assert_methods_are_deterministic(
+    FFaker::AddressIT,
+    :city, :full_address, :street_address, :postal_code, :region
+  )
+end

data/test/test_address_ja.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressJA < Test::Unit::TestCase
   include DeterministicHelper
@@ -13,7 +13,7 @@ class TestAddressJA < Test::Unit::TestCase
   )
 
   def test_postal_code
-    assert_match(/^\d{3}\-\d{4}$/, FFaker::AddressJA.postal_code)
+    assert_match(/^\d{3}-\d{4}$/, FFaker::AddressJA.postal_code)
   end
 
   def test_land_number

data/test/test_address_kr.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressKR < Test::Unit::TestCase
   include DeterministicHelper

data/test/test_address_mx.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'helper'
+require_relative 'helper'
 
 class TestAddressMX < Test::Unit::TestCase
   include DeterministicHelper