faker 2.1.2 → 2.2.0

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

data/lib/faker/default/time.rb

@@ -13,7 +13,22 @@ module Faker
     }.freeze
 
     class << self
-      def between(from:, to:, format: nil)
+      # rubocop:disable Metrics/ParameterLists
+      def between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, legacy_format = NOT_GIVEN, from:, to:, format: nil)
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_from != NOT_GIVEN
+          warn_with_uplevel 'Passing `from` with the 1st argument of `Time.between` is deprecated. Use keyword argument like `Time.between(from: ...)` instead.', uplevel: 1
+          from = legacy_from
+        end
+        if legacy_to != NOT_GIVEN
+          warn_with_uplevel 'Passing `to` with the 2nd argument of `Time.between` is deprecated. Use keyword argument like `Time.between(to: ...)` instead.', uplevel: 1
+          to = legacy_to
+        end
+        if legacy_format != NOT_GIVEN
+          warn_with_uplevel 'Passing `format` with the 3rd argument of `Time.between` is deprecated. Use keyword argument like `Time.between(format: ...)` instead.', uplevel: 1
+          format = legacy_format
+        end
+
         from = get_time_object(from)
         to = get_time_object(to)
 
@@ -21,17 +36,66 @@ module Faker
         time_with_format(time, format)
       end
 
-      def between_dates(from:, to:, period: :all, format: nil)
+      # rubocop:disable Metrics/ParameterLists
+      def between_dates(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, legacy_period = NOT_GIVEN, legacy_format = NOT_GIVEN, from:, to:, period: :all, format: nil)
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_from != NOT_GIVEN
+          warn_with_uplevel 'Passing `from` with the 1st argument of `Time.between_dates` is deprecated. Use keyword argument like `Time.between_dates(from: ...)` instead.', uplevel: 1
+          from = legacy_from
+        end
+        if legacy_to != NOT_GIVEN
+          warn_with_uplevel 'Passing `to` with the 2nd argument of `Time.between_dates` is deprecated. Use keyword argument like `Time.between_dates(to: ...)` instead.', uplevel: 1
+          to = legacy_to
+        end
+        if legacy_period != NOT_GIVEN
+          warn_with_uplevel 'Passing `period` with the 3rd argument of `Time.between_dates` is deprecated. Use keyword argument like `Time.between_dates(period: ...)` instead.', uplevel: 1
+          period = legacy_period
+        end
+        if legacy_format != NOT_GIVEN
+          warn_with_uplevel 'Passing `format` with the 4th argument of `Time.between_dates` is deprecated. Use keyword argument like `Time.between_dates(format: ...)` instead.', uplevel: 1
+          format = legacy_format
+        end
+
         date = Faker::Date.between(from: from, to: to)
         time = date_with_random_time(date, period)
         time_with_format(time, format)
       end
 
-      def forward(days: 365, period: :all, format: nil)
+      # rubocop:disable Metrics/ParameterLists
+      def forward(legacy_days = NOT_GIVEN, legacy_period = NOT_GIVEN, legacy_format = NOT_GIVEN, days: 365, period: :all, format: nil)
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_days != NOT_GIVEN
+          warn_with_uplevel 'Passing `days` with the 1st argument of `Time.forward` is deprecated. Use keyword argument like `Time.forward(days: ...)` instead.', uplevel: 1
+          days = legacy_days
+        end
+        if legacy_period != NOT_GIVEN
+          warn_with_uplevel 'Passing `period` with the 2nd argument of `Time.forward` is deprecated. Use keyword argument like `Time.forward(period: ...)` instead.', uplevel: 1
+          period = legacy_period
+        end
+        if legacy_format != NOT_GIVEN
+          warn_with_uplevel 'Passing `format` with the 3rd argument of `Time.forward` is deprecated. Use keyword argument like `Time.forward(format: ...)` instead.', uplevel: 1
+          format = legacy_format
+        end
+
         time_with_format(date_with_random_time(Faker::Date.forward(days: days), period), format)
       end
 
-      def backward(days: 365, period: :all, format: nil)
+      # rubocop:disable Metrics/ParameterLists
+      def backward(legacy_days = NOT_GIVEN, legacy_period = NOT_GIVEN, legacy_format = NOT_GIVEN, days: 365, period: :all, format: nil)
+        # rubocop:enable Metrics/ParameterLists
+        if legacy_days != NOT_GIVEN
+          warn_with_uplevel 'Passing `days` with the 1st argument of `Time.backward` is deprecated. Use keyword argument like `Time.backward(days: ...)` instead.', uplevel: 1
+          days = legacy_days
+        end
+        if legacy_period != NOT_GIVEN
+          warn_with_uplevel 'Passing `period` with the 2nd argument of `Time.backward` is deprecated. Use keyword argument like `Time.backward(period: ...)` instead.', uplevel: 1
+          period = legacy_period
+        end
+        if legacy_format != NOT_GIVEN
+          warn_with_uplevel 'Passing `format` with the 3rd argument of `Time.backward` is deprecated. Use keyword argument like `Time.backward(format: ...)` instead.', uplevel: 1
+          format = legacy_format
+        end
+
         time_with_format(date_with_random_time(Faker::Date.backward(days: days), period), format)
       end
 

data/lib/faker/default/twitter.rb

@@ -3,7 +3,16 @@
 module Faker
   class Twitter < Base
     class << self
-      def user(include_status: true, include_email: false)
+      def user(legacy_include_status = NOT_GIVEN, legacy_include_email = NOT_GIVEN, include_status: true, include_email: false)
+        if legacy_include_status != NOT_GIVEN
+          warn_with_uplevel 'Passing `include_status` with the 1st argument of `Twitter.user` is deprecated. Use keyword argument like `Twitter.user(include_status: ...)` instead.', uplevel: 1
+          include_status = legacy_include_status
+        end
+        if legacy_include_email != NOT_GIVEN
+          warn_with_uplevel 'Passing `include_email` with the 2nd argument of `Twitter.user` is deprecated. Use keyword argument like `Twitter.user(include_email: ...)` instead.', uplevel: 1
+          include_email = legacy_include_email
+        end
+
         user_id = id
         background_image_url = Faker::LoremPixel.image(size: '600x400') # TODO: Make the dimensions change
         profile_image_url = Faker::Avatar.image(slug: user_id, size: '48x48')
@@ -54,7 +63,16 @@ module Faker
         user
       end
 
-      def status(include_user: true, include_photo: false)
+      def status(legacy_include_user = NOT_GIVEN, legacy_include_photo = NOT_GIVEN, include_user: true, include_photo: false)
+        if legacy_include_user != NOT_GIVEN
+          warn_with_uplevel 'Passing `include_user` with the 1st argument of `Twitter.status` is deprecated. Use keyword argument like `Twitter.status(include_user: ...)` instead.', uplevel: 1
+          include_user = legacy_include_user
+        end
+        if legacy_include_photo != NOT_GIVEN
+          warn_with_uplevel 'Passing `include_photo` with the 2nd argument of `Twitter.status` is deprecated. Use keyword argument like `Twitter.status(include_photo: ...)` instead.', uplevel: 1
+          include_photo = legacy_include_photo
+        end
+
         status_id = id
         status = {
           id: status_id,
@@ -116,7 +134,12 @@ module Faker
         }
       end
 
-      def status_entities(include_photo: false)
+      def status_entities(legacy_include_photo = NOT_GIVEN, include_photo: false)
+        if legacy_include_photo != NOT_GIVEN
+          warn_with_uplevel 'Passing `include_photo` with the 1st argument of `Twitter.status_entities` is deprecated. Use keyword argument like `Twitter.status_entities(include_photo: ...)` instead.', uplevel: 1
+          include_photo = legacy_include_photo
+        end
+
         entities = {
           hashtags:  [],
           symbols:  [],

data/lib/faker/default/types.rb

@@ -7,7 +7,12 @@ module Faker
     COMPLEX_TYPES = %i[hash array].freeze
 
     class << self
-      def rb_string(words: 1)
+      def rb_string(legacy_words = NOT_GIVEN, words: 1)
+        if legacy_words != NOT_GIVEN
+          warn_with_uplevel 'Passing `words` with the 1st argument of `Types.rb_string` is deprecated. Use keyword argument like `Types.rb_string(words: ...)` instead.', uplevel: 1
+          words = legacy_words
+        end
+
         resolved_num = resolve(words)
         word_list =
           translate('faker.lorem.words')
@@ -20,11 +25,29 @@ module Faker
         sample(CHARACTERS)
       end
 
-      def rb_integer(from: 0, to: 100)
+      def rb_integer(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 0, to: 100)
+        if legacy_from != NOT_GIVEN
+          warn_with_uplevel 'Passing `from` with the 1st argument of `Types.rb_integer` is deprecated. Use keyword argument like `Types.rb_integer(from: ...)` instead.', uplevel: 1
+          from = legacy_from
+        end
+        if legacy_to != NOT_GIVEN
+          warn_with_uplevel 'Passing `to` with the 2nd argument of `Types.rb_integer` is deprecated. Use keyword argument like `Types.rb_integer(to: ...)` instead.', uplevel: 1
+          to = legacy_to
+        end
+
         rand(from..to).to_i
       end
 
-      def rb_hash(number: 1, type: random_type)
+      def rb_hash(legacy_number = NOT_GIVEN, legacy_type = NOT_GIVEN, number: 1, type: random_type)
+        if legacy_number != NOT_GIVEN
+          warn_with_uplevel 'Passing `number` with the 1st argument of `Types.rb_hash` is deprecated. Use keyword argument like `Types.rb_hash(number: ...)` instead.', uplevel: 1
+          number = legacy_number
+        end
+        if legacy_type != NOT_GIVEN
+          warn_with_uplevel 'Passing `type` with the 2nd argument of `Types.rb_hash` is deprecated. Use keyword argument like `Types.rb_hash(type: ...)` instead.', uplevel: 1
+          type = legacy_type
+        end
+
         {}.tap do |hsh|
           Lorem.words(number: number * 2).uniq.first(number).each do |s|
             hsh.merge!(s.to_sym => type)
@@ -32,11 +55,21 @@ module Faker
         end
       end
 
-      def complex_rb_hash(number: 1)
+      def complex_rb_hash(legacy_number = NOT_GIVEN, number: 1)
+        if legacy_number != NOT_GIVEN
+          warn_with_uplevel 'Passing `number` with the 1st argument of `Types.complex_rb_hash` is deprecated. Use keyword argument like `Types.complex_rb_hash(number: ...)` instead.', uplevel: 1
+          number = legacy_number
+        end
+
         rb_hash(number: number, type: random_complex_type)
       end
 
-      def rb_array(len: 1)
+      def rb_array(legacy_len = NOT_GIVEN, len: 1)
+        if legacy_len != NOT_GIVEN
+          warn_with_uplevel 'Passing `len` with the 1st argument of `Types.rb_array` is deprecated. Use keyword argument like `Types.rb_array(len: ...)` instead.', uplevel: 1
+          len = legacy_len
+        end
+
         [].tap do |ar|
           len.times do
             ar.push random_type

data/lib/faker/default/vehicle.rb

@@ -26,7 +26,12 @@ module Faker
         fetch('vehicle.makes')
       end
 
-      def model(make_of_model: '')
+      def model(legacy_make_of_model = NOT_GIVEN, make_of_model: '')
+        if legacy_make_of_model != NOT_GIVEN
+          warn_with_uplevel 'Passing `make_of_model` with the 1st argument of `Vehicle.model` is deprecated. Use keyword argument like `Vehicle.model(make_of_model: ...)` instead.', uplevel: 1
+          make_of_model = legacy_make_of_model
+        end
+
         return fetch("vehicle.models_by_make.#{make}") if make_of_model.empty?
 
         fetch("vehicle.models_by_make.#{make_of_model}")
@@ -85,13 +90,27 @@ module Faker
         Faker::Time.backward(days: rand_in_range(365, 5475), period: :all, format: '%Y').to_i
       end
 
-      def mileage(min: MILEAGE_MIN, max: MILEAGE_MAX)
+      def mileage(legacy_min = NOT_GIVEN, legacy_max = NOT_GIVEN, min: MILEAGE_MIN, max: MILEAGE_MAX)
+        if legacy_min != NOT_GIVEN
+          warn_with_uplevel 'Passing `min` with the 1st argument of `Vehicle.mileage` is deprecated. Use keyword argument like `Vehicle.mileage(min: ...)` instead.', uplevel: 1
+          min = legacy_min
+        end
+        if legacy_max != NOT_GIVEN
+          warn_with_uplevel 'Passing `max` with the 2nd argument of `Vehicle.mileage` is deprecated. Use keyword argument like `Vehicle.mileage(max: ...)` instead.', uplevel: 1
+          max = legacy_max
+        end
+
         rand_in_range(min, max)
       end
 
       alias kilometrage mileage
 
-      def license_plate(state_abreviation: '')
+      def license_plate(legacy_state_abreviation = NOT_GIVEN, state_abreviation: '')
+        if legacy_state_abreviation != NOT_GIVEN
+          warn_with_uplevel 'Passing `state_abreviation` with the 1st argument of `Vehicle.license_plate` is deprecated. Use keyword argument like `Vehicle.license_plate(state_abreviation: ...)` instead.', uplevel: 1
+          state_abreviation = legacy_state_abreviation
+        end
+
         return regexify(bothify(fetch('vehicle.license_plate'))) if state_abreviation.empty?
 
         key = 'vehicle.license_plate_by_state.' + state_abreviation

data/lib/faker/default/world_cup.rb

@@ -15,11 +15,25 @@ module Faker
         fetch('world_cup.stadiums')
       end
 
-      def group(group: 'group_A')
+      def group(legacy_group = NOT_GIVEN, group: 'group_A')
+        if legacy_group != NOT_GIVEN
+          warn_with_uplevel 'Passing `group` with the 1st argument of `WorldCup.group` is deprecated. Use keyword argument like `WorldCup.group(group: ...)` instead.', uplevel: 1
+          group = legacy_group
+        end
+
         fetch("world_cup.groups.#{group}")
       end
 
-      def roster(country: 'Egypt', type: 'coach')
+      def roster(legacy_country = NOT_GIVEN, legacy_type = NOT_GIVEN, country: 'Egypt', type: 'coach')
+        if legacy_country != NOT_GIVEN
+          warn_with_uplevel 'Passing `country` with the 1st argument of `WorldCup.roster` is deprecated. Use keyword argument like `WorldCup.roster(country: ...)` instead.', uplevel: 1
+          country = legacy_country
+        end
+        if legacy_type != NOT_GIVEN
+          warn_with_uplevel 'Passing `type` with the 2nd argument of `WorldCup.roster` is deprecated. Use keyword argument like `WorldCup.roster(type: ...)` instead.', uplevel: 1
+          type = legacy_type
+        end
+
         fetch("world_cup.rosters.#{country}.#{type}")
       end
     end