faker 2.1.0 → 2.2.1

data/lib/faker/default/name.rb

@@ -46,7 +46,12 @@ module Faker
         fetch('name.suffix')
       end
 
-      def initials(number: 3)
+      def initials(legacy_number = NOT_GIVEN, number: 3)
+        if legacy_number != NOT_GIVEN
+          warn_with_uplevel 'Passing `number` with the 1st argument of `Name.initials` is deprecated. Use keyword argument like `Name.initials(number: ...)` instead.', uplevel: 1
+          number = legacy_number
+        end
+
         (0...number).map { rand(65..90).chr }.join
       end
     end

data/lib/faker/default/nhs.rb

@@ -15,7 +15,12 @@ module Faker
                                                            .join('')
       end
 
-      def check_digit(number: 0)
+      def check_digit(legacy_number = NOT_GIVEN, number: 0)
+        if legacy_number != NOT_GIVEN
+          warn_with_uplevel 'Passing `number` with the 1st argument of `NationalHealthService.check_digit` is deprecated. Use keyword argument like `NationalHealthService.check_digit(number: ...)` instead.', uplevel: 1
+          number = legacy_number
+        end
+
         sum = 0
         number.to_s.chars.each_with_index do |digit, idx|
           position = idx + 1

data/lib/faker/default/number.rb

@@ -3,19 +3,34 @@
 module Faker
   class Number < Base
     class << self
-      def number(digits: 10)
+      def number(legacy_digits = NOT_GIVEN, digits: 10)
+        if legacy_digits != NOT_GIVEN
+          warn_with_uplevel 'Passing `digits` with the 1st argument of `Number.number` is deprecated. Use keyword argument like `Number.number(digits: ...)` instead.', uplevel: 1
+          digits = legacy_digits
+        end
+
         return if digits < 1
-        return 0 if digits == 1
+        return rand(0..9).round if digits == 1
 
         # Ensure the first digit is not zero
         ([non_zero_digit] + generate(digits - 1)).join.to_i
       end
 
-      def leading_zero_number(digits: 10)
+      def leading_zero_number(legacy_digits = NOT_GIVEN, digits: 10)
+        if legacy_digits != NOT_GIVEN
+          warn_with_uplevel 'Passing `digits` with the 1st argument of `Number.leading_zero_number` is deprecated. Use keyword argument like `Number.leading_zero_number(digits: ...)` instead.', uplevel: 1
+          digits = legacy_digits
+        end
+
         '0' + (2..digits).collect { digit }.join
       end
 
-      def decimal_part(digits: 10)
+      def decimal_part(legacy_digits = NOT_GIVEN, digits: 10)
+        if legacy_digits != NOT_GIVEN
+          warn_with_uplevel 'Passing `digits` with the 1st argument of `Number.decimal_part` is deprecated. Use keyword argument like `Number.decimal_part(digits: ...)` instead.', uplevel: 1
+          digits = legacy_digits
+        end
+
         num = ''
         if digits > 1
           num = non_zero_digit
@@ -24,7 +39,16 @@ module Faker
         leading_zero_number(digits: digits) + num.to_s
       end
 
-      def decimal(l_digits: 5, r_digits: 2)
+      def decimal(legacy_l_digits = NOT_GIVEN, legacy_r_digits = NOT_GIVEN, l_digits: 5, r_digits: 2)
+        if legacy_l_digits != NOT_GIVEN
+          warn_with_uplevel 'Passing `l_digits` with the 1st argument of `Number.decimal` is deprecated. Use keyword argument like `Number.decimal(l_digits: ...)` instead.', uplevel: 1
+          l_digits = legacy_l_digits
+        end
+        if legacy_r_digits != NOT_GIVEN
+          warn_with_uplevel 'Passing `r_digits` with the 2nd argument of `Number.decimal` is deprecated. Use keyword argument like `Number.decimal(r_digits: ...)` instead.', uplevel: 1
+          r_digits = legacy_r_digits
+        end
+
         l_d = number(digits: l_digits)
         r_d = if r_digits == 1
                 generate(r_digits)
@@ -44,34 +68,80 @@ module Faker
         rand(10)
       end
 
-      def hexadecimal(digits: 6)
+      def hexadecimal(legacy_digits = NOT_GIVEN, digits: 6)
+        if legacy_digits != NOT_GIVEN
+          warn_with_uplevel 'Passing `digits` with the 1st argument of `Number.hexadecimal` is deprecated. Use keyword argument like `Number.hexadecimal(digits: ...)` instead.', uplevel: 1
+          digits = legacy_digits
+        end
+
         hex = ''
         digits.times { hex += rand(15).to_s(16) }
         hex
       end
 
-      def normal(mean: 1, standard_deviation: 1)
+      def normal(legacy_mean = NOT_GIVEN, legacy_standard_deviation = NOT_GIVEN, mean: 1, standard_deviation: 1)
+        if legacy_mean != NOT_GIVEN
+          warn_with_uplevel 'Passing `mean` with the 1st argument of `Number.normal` is deprecated. Use keyword argument like `Number.normal(mean: ...)` instead.', uplevel: 1
+          mean = legacy_mean
+        end
+        if legacy_standard_deviation != NOT_GIVEN
+          warn_with_uplevel 'Passing `standard_deviation` with the 2nd argument of `Number.normal` is deprecated. Use keyword argument like `Number.normal(standard_deviation: ...)` instead.', uplevel: 1
+          standard_deviation = legacy_standard_deviation
+        end
+
         theta = 2 * Math::PI * rand
         rho = Math.sqrt(-2 * Math.log(1 - rand))
         scale = standard_deviation * rho
         mean + scale * Math.cos(theta)
       end
 
-      def between(from: 1.00, to: 5000.00)
+      def between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 1.00, to: 5000.00)
+        if legacy_from != NOT_GIVEN
+          warn_with_uplevel 'Passing `from` with the 1st argument of `Number.between` is deprecated. Use keyword argument like `Number.between(from: ...)` instead.', uplevel: 1
+          from = legacy_from
+        end
+        if legacy_to != NOT_GIVEN
+          warn_with_uplevel 'Passing `to` with the 2nd argument of `Number.between` is deprecated. Use keyword argument like `Number.between(to: ...)` instead.', uplevel: 1
+          to = legacy_to
+        end
+
         Faker::Base.rand_in_range(from, to)
       end
 
-      def within(range: 1.00..5000.00)
+      def within(legacy_range = NOT_GIVEN, range: 1.00..5000.00)
+        if legacy_range != NOT_GIVEN
+          warn_with_uplevel 'Passing `range` with the 1st argument of `Number.within` is deprecated. Use keyword argument like `Number.within(range: ...)` instead.', uplevel: 1
+          range = legacy_range
+        end
+
         between(from: range.min, to: range.max)
       end
 
-      def positive(from: 1.00, to: 5000.00)
+      def positive(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 1.00, to: 5000.00)
+        if legacy_from != NOT_GIVEN
+          warn_with_uplevel 'Passing `from` with the 1st argument of `Number.positive` is deprecated. Use keyword argument like `Number.positive(from: ...)` instead.', uplevel: 1
+          from = legacy_from
+        end
+        if legacy_to != NOT_GIVEN
+          warn_with_uplevel 'Passing `to` with the 2nd argument of `Number.positive` is deprecated. Use keyword argument like `Number.positive(to: ...)` instead.', uplevel: 1
+          to = legacy_to
+        end
+
         random_number = between(from: from, to: to)
 
         greater_than_zero(random_number)
       end
 
-      def negative(from: -5000.00, to: -1.00)
+      def negative(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: -5000.00, to: -1.00)
+        if legacy_from != NOT_GIVEN
+          warn_with_uplevel 'Passing `from` with the 1st argument of `Number.negative` is deprecated. Use keyword argument like `Number.negative(from: ...)` instead.', uplevel: 1
+          from = legacy_from
+        end
+        if legacy_to != NOT_GIVEN
+          warn_with_uplevel 'Passing `to` with the 2nd argument of `Number.negative` is deprecated. Use keyword argument like `Number.negative(to: ...)` instead.', uplevel: 1
+          to = legacy_to
+        end
+
         random_number = between(from: from, to: to)
 
         less_than_zero(random_number)

data/lib/faker/default/omniauth.rb

@@ -15,7 +15,22 @@ module Faker
     end
 
     class << self
-      def google(name: nil, email: nil, uid: Number.number(digits: 9).to_s)
+      # rubocop:disable Metrics/ParameterLists
+      def google(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 9).to_s)
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_name != NOT_GIVEN
+          warn_with_uplevel 'Passing `name` with the 1st argument of `Omniauth.google` is deprecated. Use keyword argument like `Omniauth.google(name: ...)` instead.', uplevel: 1
+          name = legacy_name
+        end
+        if legacy_email != NOT_GIVEN
+          warn_with_uplevel 'Passing `email` with the 2nd argument of `Omniauth.google` is deprecated. Use keyword argument like `Omniauth.google(email: ...)` instead.', uplevel: 1
+          email = legacy_email
+        end
+        if legacy_uid != NOT_GIVEN
+          warn_with_uplevel 'Passing `uid` with the 3rd argument of `Omniauth.google` is deprecated. Use keyword argument like `Omniauth.google(uid: ...)` instead.', uplevel: 1
+          uid = legacy_uid
+        end
+
         auth = Omniauth.new(name: name, email: email)
         {
           provider: 'google_oauth2',
@@ -64,7 +79,26 @@ module Faker
         }
       end
 
-      def facebook(name: nil, email: nil, username: nil, uid: Number.number(digits: 7).to_s)
+      # rubocop:disable Metrics/ParameterLists
+      def facebook(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_username = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, username: nil, uid: Number.number(digits: 7).to_s)
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_name != NOT_GIVEN
+          warn_with_uplevel 'Passing `name` with the 1st argument of `Omniauth.facebook` is deprecated. Use keyword argument like `Omniauth.facebook(name: ...)` instead.', uplevel: 1
+          name = legacy_name
+        end
+        if legacy_email != NOT_GIVEN
+          warn_with_uplevel 'Passing `email` with the 2nd argument of `Omniauth.facebook` is deprecated. Use keyword argument like `Omniauth.facebook(email: ...)` instead.', uplevel: 1
+          email = legacy_email
+        end
+        if legacy_username != NOT_GIVEN
+          warn_with_uplevel 'Passing `username` with the 3rd argument of `Omniauth.facebook` is deprecated. Use keyword argument like `Omniauth.facebook(username: ...)` instead.', uplevel: 1
+          username = legacy_username
+        end
+        if legacy_uid != NOT_GIVEN
+          warn_with_uplevel 'Passing `uid` with the 4th argument of `Omniauth.facebook` is deprecated. Use keyword argument like `Omniauth.facebook(uid: ...)` instead.', uplevel: 1
+          uid = legacy_uid
+        end
+
         auth = Omniauth.new(name: name, email: email)
         username ||= "#{auth.first_name.downcase[0]}#{auth.last_name.downcase}"
         {
@@ -106,7 +140,22 @@ module Faker
         }
       end
 
-      def twitter(name: nil, nickname: nil, uid: Number.number(digits: 6).to_s)
+      # rubocop:disable Metrics/ParameterLists
+      def twitter(legacy_name = NOT_GIVEN, legacy_nickname = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, nickname: nil, uid: Number.number(digits: 6).to_s)
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_name != NOT_GIVEN
+          warn_with_uplevel 'Passing `name` with the 1st argument of `Omniauth.twitter` is deprecated. Use keyword argument like `Omniauth.twitter(name: ...)` instead.', uplevel: 1
+          name = legacy_name
+        end
+        if legacy_nickname != NOT_GIVEN
+          warn_with_uplevel 'Passing `nickname` with the 2nd argument of `Omniauth.twitter` is deprecated. Use keyword argument like `Omniauth.twitter(nickname: ...)` instead.', uplevel: 1
+          nickname = legacy_nickname
+        end
+        if legacy_uid != NOT_GIVEN
+          warn_with_uplevel 'Passing `uid` with the 3rd argument of `Omniauth.twitter` is deprecated. Use keyword argument like `Omniauth.twitter(uid: ...)` instead.', uplevel: 1
+          uid = legacy_uid
+        end
+
         auth = Omniauth.new(name: name)
         nickname ||= auth.name.downcase.delete(' ')
         location = city_state
@@ -179,7 +228,22 @@ module Faker
         }
       end
 
-      def linkedin(name: nil, email: nil, uid: Number.number(digits: 6).to_s)
+      # rubocop:disable Metrics/ParameterLists
+      def linkedin(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 6).to_s)
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_name != NOT_GIVEN
+          warn_with_uplevel 'Passing `name` with the 1st argument of `Omniauth.linkedin` is deprecated. Use keyword argument like `Omniauth.linkedin(name: ...)` instead.', uplevel: 1
+          name = legacy_name
+        end
+        if legacy_email != NOT_GIVEN
+          warn_with_uplevel 'Passing `email` with the 2nd argument of `Omniauth.linkedin` is deprecated. Use keyword argument like `Omniauth.linkedin(email: ...)` instead.', uplevel: 1
+          email = legacy_email
+        end
+        if legacy_uid != NOT_GIVEN
+          warn_with_uplevel 'Passing `uid` with the 3rd argument of `Omniauth.linkedin` is deprecated. Use keyword argument like `Omniauth.linkedin(uid: ...)` instead.', uplevel: 1
+          uid = legacy_uid
+        end
+
         auth = Omniauth.new(name: name, email: email)
         first_name = auth.first_name.downcase
         last_name = auth.last_name.downcase
@@ -242,7 +306,22 @@ module Faker
         }
       end
 
-      def github(name: nil, email: nil, uid: Number.number(digits: 8).to_s)
+      # rubocop:disable Metrics/ParameterLists
+      def github(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 8).to_s)
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_name != NOT_GIVEN
+          warn_with_uplevel 'Passing `name` with the 1st argument of `Omniauth.github` is deprecated. Use keyword argument like `Omniauth.github(name: ...)` instead.', uplevel: 1
+          name = legacy_name
+        end
+        if legacy_email != NOT_GIVEN
+          warn_with_uplevel 'Passing `email` with the 2nd argument of `Omniauth.github` is deprecated. Use keyword argument like `Omniauth.github(email: ...)` instead.', uplevel: 1
+          email = legacy_email
+        end
+        if legacy_uid != NOT_GIVEN
+          warn_with_uplevel 'Passing `uid` with the 3rd argument of `Omniauth.github` is deprecated. Use keyword argument like `Omniauth.github(uid: ...)` instead.', uplevel: 1
+          uid = legacy_uid
+        end
+
         auth = Omniauth.new(name: name, email: email)
         login = auth.name.downcase.tr(' ', '-')
         html_url = "https://github.com/#{login}"

data/lib/faker/default/phone_number.rb

@@ -40,7 +40,12 @@ module Faker
       # US and Canada only
       # Can be used for both extensions and last four digits of phone number.
       # Since extensions can be of variable length, this method taks a length parameter
-      def subscriber_number(length: 4)
+      def subscriber_number(legacy_length = NOT_GIVEN, length: 4)
+        if legacy_length != NOT_GIVEN
+          warn_with_uplevel 'Passing `length` with the 1st argument of `PhoneNumber.subscriber_number` is deprecated. Use keyword argument like `PhoneNumber.subscriber_number(length: ...)` instead.', uplevel: 1
+          length = legacy_length
+        end
+
         rand.to_s[2..(1 + length)]
       end
 

data/lib/faker/default/placeholdit.rb

@@ -5,7 +5,30 @@ module Faker
     class << self
       SUPPORTED_FORMATS = %w[png jpg gif jpeg].freeze
 
-      def image(size: '300x300', format: 'png', background_color: nil, text_color: nil, text: nil)
+      # rubocop:disable Metrics/ParameterLists
+      def image(legacy_size = NOT_GIVEN, legacy_format = NOT_GIVEN, legacy_background_color = NOT_GIVEN, legacy_text_color = NOT_GIVEN, legacy_text = NOT_GIVEN, size: '300x300', format: 'png', background_color: nil, text_color: nil, text: nil)
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_size != NOT_GIVEN
+          warn_with_uplevel 'Passing `size` with the 1st argument of `Placeholdit.image` is deprecated. Use keyword argument like `Placeholdit.image(size: ...)` instead.', uplevel: 1
+          size = legacy_size
+        end
+        if legacy_format != NOT_GIVEN
+          warn_with_uplevel 'Passing `format` with the 2nd argument of `Placeholdit.image` is deprecated. Use keyword argument like `Placeholdit.image(format: ...)` instead.', uplevel: 1
+          format = legacy_format
+        end
+        if legacy_background_color != NOT_GIVEN
+          warn_with_uplevel 'Passing `background_color` with the 3rd argument of `Placeholdit.image` is deprecated. Use keyword argument like `Placeholdit.image(background_color: ...)` instead.', uplevel: 1
+          background_color = legacy_background_color
+        end
+        if legacy_text_color != NOT_GIVEN
+          warn_with_uplevel 'Passing `text_color` with the 4th argument of `Placeholdit.image` is deprecated. Use keyword argument like `Placeholdit.image(text_color: ...)` instead.', uplevel: 1
+          text_color = legacy_text_color
+        end
+        if legacy_text != NOT_GIVEN
+          warn_with_uplevel 'Passing `text` with the 5th argument of `Placeholdit.image` is deprecated. Use keyword argument like `Placeholdit.image(text: ...)` instead.', uplevel: 1
+          text = legacy_text
+        end
+
         background_color = generate_color if background_color == :random
         text_color = generate_color if text_color == :random
 

data/lib/faker/default/relationship.rb

@@ -5,7 +5,12 @@ module Faker
     flexible :relationship
 
     class << self
-      def familial(connection: nil)
+      def familial(legacy_connection = NOT_GIVEN, connection: nil)
+        if legacy_connection != NOT_GIVEN
+          warn_with_uplevel 'Passing `connection` with the 1st argument of `Relationship.familial` is deprecated. Use keyword argument like `Relationship.familial(connection: ...)` instead.', uplevel: 1
+          connection = legacy_connection
+        end
+
         familial_connections = translate('faker.relationship.familial').keys
 
         if connection.nil?

data/lib/faker/default/source.rb

@@ -3,16 +3,35 @@
 module Faker
   class Source < Base
     class << self
-      def hello_world(lang: :ruby)
+      def hello_world(legacy_lang = NOT_GIVEN, lang: :ruby)
+        if legacy_lang != NOT_GIVEN
+          warn_with_uplevel 'Passing `lang` with the 1st argument of `Source.hello_world` is deprecated. Use keyword argument like `Source.hello_world(lang: ...)` instead.', uplevel: 1
+          lang = legacy_lang
+        end
+
         fetch("source.hello_world.#{lang}")
       end
 
-      def print(str: 'some string', lang: :ruby)
+      def print(legacy_str = NOT_GIVEN, legacy_lang = NOT_GIVEN, str: 'some string', lang: :ruby)
+        if legacy_str != NOT_GIVEN
+          warn_with_uplevel 'Passing `str` with the 1st argument of `Source.print` is deprecated. Use keyword argument like `Source.print(str: ...)` instead.', uplevel: 1
+          str = legacy_str
+        end
+        if legacy_lang != NOT_GIVEN
+          warn_with_uplevel 'Passing `lang` with the 2nd argument of `Source.print` is deprecated. Use keyword argument like `Source.print(lang: ...)` instead.', uplevel: 1
+          lang = legacy_lang
+        end
+
         code = fetch("source.print.#{lang}")
         code.gsub('faker_string_to_print', str)
       end
 
-      def print_1_to_10(lang: :ruby)
+      def print_1_to_10(legacy_lang = NOT_GIVEN, lang: :ruby)
+        if legacy_lang != NOT_GIVEN
+          warn_with_uplevel 'Passing `lang` with the 1st argument of `Source.print_1_to_10` is deprecated. Use keyword argument like `Source.print_1_to_10(lang: ...)` instead.', uplevel: 1
+          lang = legacy_lang
+        end
+
         fetch("source.print_1_to_10.#{lang}")
       end
     end

data/lib/faker/default/string.rb

@@ -3,7 +3,12 @@
 module Faker
   class String < Base
     class << self
-      def random(length: 32)
+      def random(legacy_length = NOT_GIVEN, length: 32)
+        if legacy_length != NOT_GIVEN
+          warn_with_uplevel 'Passing `length` with the 1st argument of `String.random` is deprecated. Use keyword argument like `String.random(length: ...)` instead.', uplevel: 1
+          length = legacy_length
+        end
+
         utf8string select_a length
       end
 

data/lib/faker/default/stripe.rb

@@ -3,7 +3,12 @@
 module Faker
   class Stripe < Base
     class << self
-      def valid_card(card_type: nil)
+      def valid_card(legacy_card_type = NOT_GIVEN, card_type: nil)
+        if legacy_card_type != NOT_GIVEN
+          warn_with_uplevel 'Passing `card_type` with the 1st argument of `Stripe.valid_card` is deprecated. Use keyword argument like `Stripe.valid_card(card_type: ...)` instead.', uplevel: 1
+          card_type = legacy_card_type
+        end
+
         valid_cards = translate('faker.stripe.valid_cards').keys
 
         if card_type.nil?
@@ -18,7 +23,12 @@ module Faker
         fetch('stripe.valid_cards.' + card_type)
       end
 
-      def valid_token(card_type: nil)
+      def valid_token(legacy_card_type = NOT_GIVEN, card_type: nil)
+        if legacy_card_type != NOT_GIVEN
+          warn_with_uplevel 'Passing `card_type` with the 1st argument of `Stripe.valid_token` is deprecated. Use keyword argument like `Stripe.valid_token(card_type: ...)` instead.', uplevel: 1
+          card_type = legacy_card_type
+        end
+
         valid_tokens = translate('faker.stripe.valid_tokens').keys
 
         if card_type.nil?
@@ -33,7 +43,12 @@ module Faker
         fetch('stripe.valid_tokens.' + card_type)
       end
 
-      def invalid_card(card_error: nil)
+      def invalid_card(legacy_card_error = NOT_GIVEN, card_error: nil)
+        if legacy_card_error != NOT_GIVEN
+          warn_with_uplevel 'Passing `card_error` with the 1st argument of `Stripe.invalid_card` is deprecated. Use keyword argument like `Stripe.invalid_card(card_error: ...)` instead.', uplevel: 1
+          card_error = legacy_card_error
+        end
+
         invalid_cards = translate('faker.stripe.invalid_cards').keys
 
         if card_error.nil?
@@ -57,7 +72,12 @@ module Faker
         rand_in_range(start_year, start_year + 5).to_s
       end
 
-      def ccv(card_type: nil)
+      def ccv(legacy_card_type = NOT_GIVEN, card_type: nil)
+        if legacy_card_type != NOT_GIVEN
+          warn_with_uplevel 'Passing `card_type` with the 1st argument of `Stripe.ccv` is deprecated. Use keyword argument like `Stripe.ccv(card_type: ...)` instead.', uplevel: 1
+          card_type = legacy_card_type
+        end
+
         (card_type.to_s == 'amex' ? rand_in_range(1000, 9999) : rand_in_range(100, 999)).to_s
       end
     end