faker 2.0.0 → 2.2.1

data/lib/faker/default/avatar.rb

@@ -5,7 +5,30 @@ module Faker
     class << self
       SUPPORTED_FORMATS = %w[png jpg bmp].freeze
 
-      def image(slug: nil, size: '300x300', format: 'png', set: 'set1', bgset: nil)
+      # rubocop:disable Metrics/ParameterLists
+      def image(legacy_slug = NOT_GIVEN, legacy_size = NOT_GIVEN, legacy_format = NOT_GIVEN, legacy_set = NOT_GIVEN, legacy_bgset = NOT_GIVEN, slug: nil, size: '300x300', format: 'png', set: 'set1', bgset: nil)
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_slug != NOT_GIVEN
+          warn_with_uplevel 'Passing `slug` with the 1st argument of `Avatar.image` is deprecated. Use keyword argument like `Avatar.image(slug: ...)` instead.', uplevel: 1
+          slug = legacy_slug
+        end
+        if legacy_size != NOT_GIVEN
+          warn_with_uplevel 'Passing `size` with the 2nd argument of `Avatar.image` is deprecated. Use keyword argument like `Avatar.image(size: ...)` instead.', uplevel: 1
+          size = legacy_size
+        end
+        if legacy_format != NOT_GIVEN
+          warn_with_uplevel 'Passing `format` with the 3rd argument of `Avatar.image` is deprecated. Use keyword argument like `Avatar.image(format: ...)` instead.', uplevel: 1
+          format = legacy_format
+        end
+        if legacy_set != NOT_GIVEN
+          warn_with_uplevel 'Passing `set` with the 4th argument of `Avatar.image` is deprecated. Use keyword argument like `Avatar.image(set: ...)` instead.', uplevel: 1
+          set = legacy_set
+        end
+        if legacy_bgset != NOT_GIVEN
+          warn_with_uplevel 'Passing `bgset` with the 5th argument of `Avatar.image` is deprecated. Use keyword argument like `Avatar.image(bgset: ...)` instead.', uplevel: 1
+          bgset = legacy_bgset
+        end
+
         raise ArgumentError, 'Size should be specified in format 300x300' unless size =~ /^[0-9]+x[0-9]+$/
         raise ArgumentError, "Supported formats are #{SUPPORTED_FORMATS.join(', ')}" unless SUPPORTED_FORMATS.include?(format)
 

data/lib/faker/default/bank.rb

@@ -5,7 +5,12 @@ module Faker
     flexible :bank
 
     class << self
-      def account_number(digits: 10)
+      def account_number(legacy_digits = NOT_GIVEN, digits: 10)
+        if legacy_digits != NOT_GIVEN
+          warn_with_uplevel 'Passing `digits` with the 1st argument of `Bank.account_number` is deprecated. Use keyword argument like `Bank.account_number(digits: ...)` instead.', uplevel: 1
+          digits = legacy_digits
+        end
+
         output = ''
 
         output += rand.to_s[2..-1] while output.length < digits
@@ -13,10 +18,15 @@ module Faker
         output[0...digits]
       end
 
-      def iban(country_code: 'GB')
+      def iban(legacy_country_code = NOT_GIVEN, country_code: 'GB')
         # Each country has it's own format for bank accounts
         # Many of them use letters in certain parts of the account
         # Using regex patterns we can create virtually any type of bank account
+        if legacy_country_code != NOT_GIVEN
+          warn_with_uplevel 'Passing `country_code` with the 1st argument of `Bank.iban` is deprecated. Use keyword argument like `Bank.iban(country_code: ...)` instead.', uplevel: 1
+          country_code = legacy_country_code
+        end
+
         begin
           pattern = fetch("bank.iban_details.#{country_code.downcase}.bban_pattern")
         rescue I18n::MissingTranslationData

data/lib/faker/default/boolean.rb

@@ -3,7 +3,12 @@
 module Faker
   class Boolean < Base
     class << self
-      def boolean(true_ratio: 0.5)
+      def boolean(legacy_true_ratio = NOT_GIVEN, true_ratio: 0.5)
+        if legacy_true_ratio != NOT_GIVEN
+          warn_with_uplevel 'Passing `true_ratio` with the 1st argument of `Boolean.boolean` is deprecated. Use keyword argument like `Boolean.boolean(true_ratio: ...)` instead.', uplevel: 1
+          true_ratio = legacy_true_ratio
+        end
+
         (rand < true_ratio)
       end
     end

data/lib/faker/default/chile_rut.rb

@@ -6,7 +6,16 @@ module Faker
       @last_rut = nil
 
       # Fixed param added for testing a specific RUT and check digit combination.
-      def rut(min_rut: 1, fixed: false)
+      def rut(legacy_min_rut = NOT_GIVEN, legacy_fixed = NOT_GIVEN, min_rut: 1, fixed: false)
+        if legacy_min_rut != NOT_GIVEN
+          warn_with_uplevel 'Passing `min_rut` with the 1st argument of `ChileRut.rut` is deprecated. Use keyword argument like `ChileRut.rut(min_rut: ...)` instead.', uplevel: 1
+          min_rut = legacy_min_rut
+        end
+        if legacy_fixed != NOT_GIVEN
+          warn_with_uplevel 'Passing `fixed` with the 2nd argument of `ChileRut.rut` is deprecated. Use keyword argument like `ChileRut.rut(fixed: ...)` instead.', uplevel: 1
+          fixed = legacy_fixed
+        end
+
         @last_rut = fixed ? min_rut : rand_in_range(min_rut, 99_999_999)
       end
 
@@ -34,7 +43,16 @@ module Faker
         dv
       end
 
-      def full_rut(min_rut: 0, fixed: false)
+      def full_rut(legacy_min_rut = NOT_GIVEN, legacy_fixed = NOT_GIVEN, min_rut: 0, fixed: false)
+        if legacy_min_rut != NOT_GIVEN
+          warn_with_uplevel 'Passing `min_rut` with the 1st argument of `ChileRut.full_rut` is deprecated. Use keyword argument like `ChileRut.full_rut(min_rut: ...)` instead.', uplevel: 1
+          min_rut = legacy_min_rut
+        end
+        if legacy_fixed != NOT_GIVEN
+          warn_with_uplevel 'Passing `fixed` with the 2nd argument of `ChileRut.full_rut` is deprecated. Use keyword argument like `ChileRut.full_rut(fixed: ...)` instead.', uplevel: 1
+          fixed = legacy_fixed
+        end
+
         "#{rut(min_rut: min_rut, fixed: fixed)}-#{dv}"
       end
 

data/lib/faker/default/code.rb

@@ -12,13 +12,23 @@ module Faker
 
       # By default generates 10 sign isbn code in format 123456789-X
       # You can pass 13 to generate new 13 sign code
-      def isbn(base: 10)
+      def isbn(legacy_base = NOT_GIVEN, base: 10)
+        if legacy_base != NOT_GIVEN
+          warn_with_uplevel 'Passing `base` with the 1st argument of `Code.isbn` is deprecated. Use keyword argument like `Code.isbn(base: ...)` instead.', uplevel: 1
+          base = legacy_base
+        end
+
         base == 13 ? generate_base13_isbn : generate_base10_isbn
       end
 
       # By default generates 13 sign ean code in format 1234567890123
       # You can pass 8 to generate ean8 code
-      def ean(base: 13)
+      def ean(legacy_base = NOT_GIVEN, base: 13)
+        if legacy_base != NOT_GIVEN
+          warn_with_uplevel 'Passing `base` with the 1st argument of `Code.ean` is deprecated. Use keyword argument like `Code.ean(base: ...)` instead.', uplevel: 1
+          base = legacy_base
+        end
+
         base == 8 ? generate_base8_ean : generate_base13_ean
       end
 
@@ -30,7 +40,16 @@ module Faker
 
       # By default generates a Singaporean NRIC ID for someone
       # who is born between the age of 18 and 65.
-      def nric(min_age: 18, max_age: 65)
+      def nric(legacy_min_age = NOT_GIVEN, legacy_max_age = NOT_GIVEN, min_age: 18, max_age: 65)
+        if legacy_min_age != NOT_GIVEN
+          warn_with_uplevel 'Passing `min_age` with the 1st argument of `Code.nric` is deprecated. Use keyword argument like `Code.nric(min_age: ...)` instead.', uplevel: 1
+          min_age = legacy_min_age
+        end
+        if legacy_max_age != NOT_GIVEN
+          warn_with_uplevel 'Passing `max_age` with the 2nd argument of `Code.nric` is deprecated. Use keyword argument like `Code.nric(max_age: ...)` instead.', uplevel: 1
+          max_age = legacy_max_age
+        end
+
         birthyear = Date.birthday(min_age: min_age, max_age: max_age).year
         prefix = birthyear < 2000 ? 'S' : 'T'
         values = birthyear.to_s[-2..-1]

data/lib/faker/default/commerce.rb

@@ -7,7 +7,12 @@ module Faker
         fetch('color.name')
       end
 
-      def promotion_code(digits: 6)
+      def promotion_code(legacy_digits = NOT_GIVEN, digits: 6)
+        if legacy_digits != NOT_GIVEN
+          warn_with_uplevel 'Passing `digits` with the 1st argument of `Commerce.promotion_code` is deprecated. Use keyword argument like `Commerce.promotion_code(digits: ...)` instead.', uplevel: 1
+          digits = legacy_digits
+        end
+
         [
           fetch('commerce.promotion_code.adjective'),
           fetch('commerce.promotion_code.noun'),
@@ -15,7 +20,16 @@ module Faker
         ].join
       end
 
-      def department(max: 3, fixed_amount: false)
+      def department(legacy_max = NOT_GIVEN, legacy_fixed_amount = NOT_GIVEN, max: 3, fixed_amount: false)
+        if legacy_max != NOT_GIVEN
+          warn_with_uplevel 'Passing `max` with the 1st argument of `Commerce.department` is deprecated. Use keyword argument like `Commerce.department(max: ...)` instead.', uplevel: 1
+          max = legacy_max
+        end
+        if legacy_fixed_amount != NOT_GIVEN
+          warn_with_uplevel 'Passing `fixed_amount` with the 2nd argument of `Commerce.department` is deprecated. Use keyword argument like `Commerce.department(fixed_amount: ...)` instead.', uplevel: 1
+          fixed_amount = legacy_fixed_amount
+        end
+
         num = max if fixed_amount
         num ||= 1 + rand(max)
 
@@ -34,7 +48,16 @@ module Faker
         fetch('commerce.product_name.material')
       end
 
-      def price(range: 0..100.0, as_string: false)
+      def price(legacy_range = NOT_GIVEN, legacy_as_string = NOT_GIVEN, range: 0..100.0, as_string: false)
+        if legacy_range != NOT_GIVEN
+          warn_with_uplevel 'Passing `range` with the 1st argument of `Commerce.price` is deprecated. Use keyword argument like `Commerce.price(range: ...)` instead.', uplevel: 1
+          range = legacy_range
+        end
+        if legacy_as_string != NOT_GIVEN
+          warn_with_uplevel 'Passing `as_string` with the 2nd argument of `Commerce.price` is deprecated. Use keyword argument like `Commerce.price(as_string: ...)` instead.', uplevel: 1
+          as_string = legacy_as_string
+        end
+
         price = (rand(range) * 100).floor / 100.0
         if as_string
           price_parts = price.to_s.split('.')

data/lib/faker/default/company.rb

@@ -126,7 +126,12 @@ module Faker
       end
 
       # Get a random Polish register of national economy number. More info https://pl.wikipedia.org/wiki/REGON
-      def polish_register_of_national_economy(length: 9)
+      def polish_register_of_national_economy(legacy_length = NOT_GIVEN, length: 9)
+        if legacy_length != NOT_GIVEN
+          warn_with_uplevel 'Passing `length` with the 1st argument of `Company.polish_register_of_national_economy` is deprecated. Use keyword argument like `Company.polish_register_of_national_economy(length: ...)` instead.', uplevel: 1
+          length = legacy_length
+        end
+
         raise ArgumentError, 'Length should be 9 or 14' unless [9, 14].include? length
 
         random_digits = []
@@ -153,7 +158,12 @@ module Faker
         regexify(/IT\d{2,4}\/\d{2,10}/)
       end
 
-      def brazilian_company_number(formatted: false)
+      def brazilian_company_number(legacy_formatted = NOT_GIVEN, formatted: false)
+        if legacy_formatted != NOT_GIVEN
+          warn_with_uplevel 'Passing `formatted` with the 1st argument of `Company.brazilian_company_number` is deprecated. Use keyword argument like `Company.brazilian_company_number(formatted: ...)` instead.', uplevel: 1
+          formatted = legacy_formatted
+        end
+
         digits = Array.new(8) { Faker::Number.digit.to_i } + [0, 0, 0, Faker::Number.non_zero_digit.to_i]
 
         factors = [5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2, 6].cycle

data/lib/faker/default/crypto_coin.rb

@@ -7,15 +7,30 @@ module Faker
       ACRONYM = 1
       URL_LOGO = 2
 
-      def coin_name(coin: coin_array)
+      def coin_name(legacy_coin = NOT_GIVEN, coin: coin_array)
+        if legacy_coin != NOT_GIVEN
+          warn_with_uplevel 'Passing `coin` with the 1st argument of `CryptoCoin.coin_name` is deprecated. Use keyword argument like `CryptoCoin.coin_name(coin: ...)` instead.', uplevel: 1
+          coin = legacy_coin
+        end
+
         coin[COIN_NAME]
       end
 
-      def acronym(coin: coin_array)
+      def acronym(legacy_coin = NOT_GIVEN, coin: coin_array)
+        if legacy_coin != NOT_GIVEN
+          warn_with_uplevel 'Passing `coin` with the 1st argument of `CryptoCoin.acronym` is deprecated. Use keyword argument like `CryptoCoin.acronym(coin: ...)` instead.', uplevel: 1
+          coin = legacy_coin
+        end
+
         coin[ACRONYM]
       end
 
-      def url_logo(coin: coin_array)
+      def url_logo(legacy_coin = NOT_GIVEN, coin: coin_array)
+        if legacy_coin != NOT_GIVEN
+          warn_with_uplevel 'Passing `coin` with the 1st argument of `CryptoCoin.url_logo` is deprecated. Use keyword argument like `CryptoCoin.url_logo(coin: ...)` instead.', uplevel: 1
+          coin = legacy_coin
+        end
+
         coin[URL_LOGO]
       end
 

data/lib/faker/default/date.rb

@@ -3,14 +3,38 @@
 module Faker
   class Date < Base
     class << self
-      def between(from:, to:)
+      def between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from:, to:)
+        if legacy_from != NOT_GIVEN
+          warn_with_uplevel 'Passing `from` with the 1st argument of `Date.between` is deprecated. Use keyword argument like `Date.between(from: ...)` instead.', uplevel: 1
+          from = legacy_from
+        end
+        if legacy_to != NOT_GIVEN
+          warn_with_uplevel 'Passing `to` with the 2nd argument of `Date.between` is deprecated. Use keyword argument like `Date.between(to: ...)` instead.', uplevel: 1
+          to = legacy_to
+        end
+
         from = get_date_object(from)
         to   = get_date_object(to)
 
         Faker::Base.rand_in_range(from, to)
       end
 
-      def between_except(from:, to:, excepted:)
+      # rubocop:disable Metrics/ParameterLists
+      def between_except(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, legacy_excepted = NOT_GIVEN, from:, to:, excepted:)
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_from != NOT_GIVEN
+          warn_with_uplevel 'Passing `from` with the 1st argument of `Date.between_except` is deprecated. Use keyword argument like `Date.between_except(from: ...)` instead.', uplevel: 1
+          from = legacy_from
+        end
+        if legacy_to != NOT_GIVEN
+          warn_with_uplevel 'Passing `to` with the 2nd argument of `Date.between_except` is deprecated. Use keyword argument like `Date.between_except(to: ...)` instead.', uplevel: 1
+          to = legacy_to
+        end
+        if legacy_excepted != NOT_GIVEN
+          warn_with_uplevel 'Passing `excepted` with the 3rd argument of `Date.between_except` is deprecated. Use keyword argument like `Date.between_except(excepted: ...)` instead.', uplevel: 1
+          excepted = legacy_excepted
+        end
+
         raise ArgumentError, 'From date, to date and excepted date must not be the same' if from == to && to == excepted
 
         excepted = get_date_object(excepted)
@@ -21,21 +45,40 @@ module Faker
         end
       end
 
-      def forward(days: 365)
+      def forward(legacy_days = NOT_GIVEN, days: 365)
+        if legacy_days != NOT_GIVEN
+          warn_with_uplevel 'Passing `days` with the 1st argument of `Date.forward` is deprecated. Use keyword argument like `Date.forward(days: ...)` instead.', uplevel: 1
+          days = legacy_days
+        end
+
         from = ::Date.today + 1
         to   = ::Date.today + days
 
         between(from: from, to: to).to_date
       end
 
-      def backward(days: 365)
+      def backward(legacy_days = NOT_GIVEN, days: 365)
+        if legacy_days != NOT_GIVEN
+          warn_with_uplevel 'Passing `days` with the 1st argument of `Date.backward` is deprecated. Use keyword argument like `Date.backward(days: ...)` instead.', uplevel: 1
+          days = legacy_days
+        end
+
         from = ::Date.today - days
         to   = ::Date.today - 1
 
         between(from: from, to: to).to_date
       end
 
-      def birthday(min_age: 18, max_age: 65)
+      def birthday(legacy_min_age = NOT_GIVEN, legacy_max_age = NOT_GIVEN, min_age: 18, max_age: 65)
+        if legacy_min_age != NOT_GIVEN
+          warn_with_uplevel 'Passing `min_age` with the 1st argument of `Date.birthday` is deprecated. Use keyword argument like `Date.birthday(min_age: ...)` instead.', uplevel: 1
+          min_age = legacy_min_age
+        end
+        if legacy_max_age != NOT_GIVEN
+          warn_with_uplevel 'Passing `max_age` with the 2nd argument of `Date.birthday` is deprecated. Use keyword argument like `Date.birthday(max_age: ...)` instead.', uplevel: 1
+          max_age = legacy_max_age
+        end
+
         t = ::Date.today
 
         from = birthday_date(t, max_age)

data/lib/faker/default/demographic.rb

@@ -23,7 +23,12 @@ module Faker
         fetch('demographic.sex')
       end
 
-      def height(unit: :metric)
+      def height(legacy_unit = NOT_GIVEN, unit: :metric)
+        if legacy_unit != NOT_GIVEN
+          warn_with_uplevel 'Passing `unit` with the 1st argument of `Demographic.height` is deprecated. Use keyword argument like `Demographic.height(unit: ...)` instead.', uplevel: 1
+          unit = legacy_unit
+        end
+
         case unit
         when :imperial
           inches = rand_in_range(57, 86)

data/lib/faker/default/driving_licence.rb

@@ -6,10 +6,26 @@ module Faker
     NI_CHANCE = 0.03 # NI Pop is about 3% of total UK population
 
     class << self
-      def british_driving_licence(last_name: Faker::Name.last_name,
-                                  initials: Faker::Name.initials,
-                                  gender: random_gender,
-                                  date_of_birth: Faker::Date.birthday(min_age: 18, max_age: 65))
+      # rubocop:disable Metrics/ParameterLists
+      def british_driving_licence(legacy_last_name = NOT_GIVEN, legacy_initials = NOT_GIVEN, legacy_gender = NOT_GIVEN, legacy_date_of_birth = NOT_GIVEN, last_name: Faker::Name.last_name, initials: Faker::Name.initials, gender: random_gender, date_of_birth: Faker::Date.birthday(min_age: 18, max_age: 65))
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_last_name != NOT_GIVEN
+          warn_with_uplevel 'Passing `last_name` with the 1st argument of `DrivingLicence.british_driving_licence` is deprecated. Use keyword argument like `DrivingLicence.british_driving_licence(last_name: ...)` instead.', uplevel: 1
+          last_name = legacy_last_name
+        end
+        if legacy_initials != NOT_GIVEN
+          warn_with_uplevel 'Passing `initials` with the 2nd argument of `DrivingLicence.british_driving_licence` is deprecated. Use keyword argument like `DrivingLicence.british_driving_licence(initials: ...)` instead.', uplevel: 1
+          initials = legacy_initials
+        end
+        if legacy_gender != NOT_GIVEN
+          warn_with_uplevel 'Passing `gender` with the 3rd argument of `DrivingLicence.british_driving_licence` is deprecated. Use keyword argument like `DrivingLicence.british_driving_licence(gender: ...)` instead.', uplevel: 1
+          gender = legacy_gender
+        end
+        if legacy_date_of_birth != NOT_GIVEN
+          warn_with_uplevel 'Passing `date_of_birth` with the 4th argument of `DrivingLicence.british_driving_licence` is deprecated. Use keyword argument like `DrivingLicence.british_driving_licence(date_of_birth: ...)` instead.', uplevel: 1
+          date_of_birth = legacy_date_of_birth
+        end
+
         [
           gb_licence_padding(last_name, 5),
           gb_licence_year(date_of_birth, gender),

data/lib/faker/default/file.rb

@@ -3,7 +3,22 @@
 module Faker
   class File < Base
     class << self
-      def dir(segment_count: 3, root: nil, directory_separator: '/')
+      # rubocop:disable Metrics/ParameterLists
+      def dir(legacy_segment_count = NOT_GIVEN, legacy_root = NOT_GIVEN, legacy_directory_separator = NOT_GIVEN, segment_count: 3, root: nil, directory_separator: '/')
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_segment_count != NOT_GIVEN
+          warn_with_uplevel 'Passing `segment_count` with the 1st argument of `File.dir` is deprecated. Use keyword argument like `File.dir(segment_count: ...)` instead.', uplevel: 1
+          segment_count = legacy_segment_count
+        end
+        if legacy_root != NOT_GIVEN
+          warn_with_uplevel 'Passing `root` with the 2nd argument of `File.dir` is deprecated. Use keyword argument like `File.dir(root: ...)` instead.', uplevel: 1
+          root = legacy_root
+        end
+        if legacy_directory_separator != NOT_GIVEN
+          warn_with_uplevel 'Passing `directory_separator` with the 3rd argument of `File.dir` is deprecated. Use keyword argument like `File.dir(directory_separator: ...)` instead.', uplevel: 1
+          directory_separator = legacy_directory_separator
+        end
+
         Array
           .new(segment_count) { Faker::Internet.slug }
           .unshift(root)
@@ -20,7 +35,26 @@ module Faker
         fetch('file.mime_type')
       end
 
-      def file_name(dir: nil, name: nil, ext: nil, directory_separator: '/')
+      # rubocop:disable Metrics/ParameterLists
+      def file_name(legacy_dir = NOT_GIVEN, legacy_name = NOT_GIVEN, legacy_ext = NOT_GIVEN, legacy_directory_separator = NOT_GIVEN, dir: nil, name: nil, ext: nil, directory_separator: '/')
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_dir != NOT_GIVEN
+          warn_with_uplevel 'Passing `dir` with the 1st argument of `File.file_name` is deprecated. Use keyword argument like `File.file_name(dir: ...)` instead.', uplevel: 1
+          dir = legacy_dir
+        end
+        if legacy_name != NOT_GIVEN
+          warn_with_uplevel 'Passing `name` with the 2nd argument of `File.file_name` is deprecated. Use keyword argument like `File.file_name(name: ...)` instead.', uplevel: 1
+          name = legacy_name
+        end
+        if legacy_ext != NOT_GIVEN
+          warn_with_uplevel 'Passing `ext` with the 3rd argument of `File.file_name` is deprecated. Use keyword argument like `File.file_name(ext: ...)` instead.', uplevel: 1
+          ext = legacy_ext
+        end
+        if legacy_directory_separator != NOT_GIVEN
+          warn_with_uplevel 'Passing `directory_separator` with the 4th argument of `File.file_name` is deprecated. Use keyword argument like `File.file_name(directory_separator: ...)` instead.', uplevel: 1
+          directory_separator = legacy_directory_separator
+        end
+
         dir ||= dir(segment_count: 1)
         name ||= Faker::Lorem.word.downcase
         ext ||= extension