faker 2.1.0 → 2.2.2

data/lib/faker/default/placeholdit.rb

@@ -5,7 +5,17 @@ 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
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :size if legacy_size != NOT_GIVEN
+          keywords << :format if legacy_format != NOT_GIVEN
+          keywords << :background_color if legacy_background_color != NOT_GIVEN
+          keywords << :text_color if legacy_text_color != NOT_GIVEN
+          keywords << :text if legacy_text != NOT_GIVEN
+        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,11 @@ module Faker
     flexible :relationship
 
     class << self
-      def familial(connection: nil)
+      def familial(legacy_connection = NOT_GIVEN, connection: nil)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :connection if legacy_connection != NOT_GIVEN
+        end
+
         familial_connections = translate('faker.relationship.familial').keys
 
         if connection.nil?

data/lib/faker/default/source.rb

@@ -3,16 +3,31 @@
 module Faker
   class Source < Base
     class << self
-      def hello_world(lang: :ruby)
+      def hello_world(legacy_lang = NOT_GIVEN, lang: :ruby)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :lang if legacy_lang != NOT_GIVEN
+        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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :str if legacy_str != NOT_GIVEN
+        end
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :lang if legacy_lang != NOT_GIVEN
+        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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :lang if legacy_lang != NOT_GIVEN
+        end
+
         fetch("source.print_1_to_10.#{lang}")
       end
     end

data/lib/faker/default/string.rb

@@ -3,7 +3,11 @@
 module Faker
   class String < Base
     class << self
-      def random(length: 32)
+      def random(legacy_length = NOT_GIVEN, length: 32)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :length if legacy_length != NOT_GIVEN
+        end
+
         utf8string select_a length
       end
 

data/lib/faker/default/stripe.rb

@@ -3,7 +3,11 @@
 module Faker
   class Stripe < Base
     class << self
-      def valid_card(card_type: nil)
+      def valid_card(legacy_card_type = NOT_GIVEN, card_type: nil)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :card_type if legacy_card_type != NOT_GIVEN
+        end
+
         valid_cards = translate('faker.stripe.valid_cards').keys
 
         if card_type.nil?
@@ -18,7 +22,11 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :card_type if legacy_card_type != NOT_GIVEN
+        end
+
         valid_tokens = translate('faker.stripe.valid_tokens').keys
 
         if card_type.nil?
@@ -33,7 +41,11 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :card_error if legacy_card_error != NOT_GIVEN
+        end
+
         invalid_cards = translate('faker.stripe.invalid_cards').keys
 
         if card_error.nil?
@@ -57,7 +69,11 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :card_type if legacy_card_type != NOT_GIVEN
+        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,15 @@ 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
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :from if legacy_from != NOT_GIVEN
+          keywords << :to if legacy_to != NOT_GIVEN
+          keywords << :format if legacy_format != NOT_GIVEN
+        end
+
         from = get_time_object(from)
         to = get_time_object(to)
 
@@ -21,17 +29,42 @@ 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
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :from if legacy_from != NOT_GIVEN
+          keywords << :to if legacy_to != NOT_GIVEN
+          keywords << :period if legacy_period != NOT_GIVEN
+          keywords << :format if legacy_format != NOT_GIVEN
+        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
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :days if legacy_days != NOT_GIVEN
+          keywords << :period if legacy_period != NOT_GIVEN
+          keywords << :format if legacy_format != NOT_GIVEN
+        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
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :days if legacy_days != NOT_GIVEN
+          keywords << :period if legacy_period != NOT_GIVEN
+          keywords << :format if legacy_format != NOT_GIVEN
+        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,12 @@
 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :include_status if legacy_include_status != NOT_GIVEN
+          keywords << :include_email if legacy_include_email != NOT_GIVEN
+        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')
@@ -15,7 +20,7 @@ module Faker
           default_profile_image: Faker::Boolean.boolean(true_ratio: 0.1),
           default_profile: Faker::Boolean.boolean(true_ratio: 0.1),
           description: Faker::Lorem.sentence,
-          entities:  user_entities,
+          entities: user_entities,
           favourites_count: Faker::Number.between(to: 1, from: 100_000),
           follow_request_sent: false,
           followers_count: Faker::Number.between(to: 1, from: 10_000_000),
@@ -54,7 +59,12 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :include_user if legacy_include_user != NOT_GIVEN
+          keywords << :include_photo if legacy_include_photo != NOT_GIVEN
+        end
+
         status_id = id
         status = {
           id: status_id,
@@ -62,7 +72,7 @@ module Faker
           contributors: nil,
           coordinates: nil,
           created_at: created_at,
-          entities:  status_entities(include_photo: include_photo),
+          entities: status_entities(include_photo: include_photo),
           favorite_count: Faker::Number.between(to: 1, from: 10_000),
           favorited: false,
           geo: nil,
@@ -76,7 +86,7 @@ module Faker
           place: nil,
           possibly_sensitive: Faker::Boolean.boolean(true_ratio: 0.1),
           retweet_count: Faker::Number.between(to: 1, from: 10_000),
-          retweeted_status:  nil,
+          retweeted_status: nil,
           retweeted: false,
           source: "<a href=\"#{Faker::Internet.url(host: 'example.com')}\" rel=\"nofollow\">#{Faker::Company.name}</a>",
           text: Faker::Lorem.sentence,
@@ -107,21 +117,25 @@ module Faker
 
       def user_entities
         {
-          url:  {
+          url: {
             urls: []
           },
-          description:  {
+          description: {
             urls: []
           }
         }
       end
 
-      def status_entities(include_photo: false)
+      def status_entities(legacy_include_photo = NOT_GIVEN, include_photo: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :include_photo if legacy_include_photo != NOT_GIVEN
+        end
+
         entities = {
-          hashtags:  [],
-          symbols:  [],
-          user_mentions:  [],
-          urls:  []
+          hashtags: [],
+          symbols: [],
+          user_mentions: [],
+          urls: []
         }
         entities[:media] = [photo_entity] if include_photo
         entities
@@ -135,7 +149,7 @@ module Faker
         {
           id: media_id,
           id_str: media_id.to_s,
-          indices:  [
+          indices: [
             103,
             126
           ],
@@ -145,23 +159,23 @@ module Faker
           display_url: 'example.com',
           expanded_url: Faker::Internet.url(host: 'example.com'),
           type: 'photo',
-          sizes:  {
-            medium:  {
+          sizes: {
+            medium: {
               w: 1064,
               h: 600,
               resize: 'fit'
             },
-            large:  {
+            large: {
               w: 1064,
               h: 600,
               resize: 'fit'
             },
-            small:  {
+            small: {
               w: 680,
               h: 383,
               resize: 'fit'
             },
-            thumb:  {
+            thumb: {
               w: 150,
               h: 150,
               resize: 'crop'

data/lib/faker/default/types.rb

@@ -7,7 +7,11 @@ module Faker
     COMPLEX_TYPES = %i[hash array].freeze
 
     class << self
-      def rb_string(words: 1)
+      def rb_string(legacy_words = NOT_GIVEN, words: 1)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :words if legacy_words != NOT_GIVEN
+        end
+
         resolved_num = resolve(words)
         word_list =
           translate('faker.lorem.words')
@@ -20,11 +24,21 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :from if legacy_from != NOT_GIVEN
+          keywords << :to if legacy_to != NOT_GIVEN
+        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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :number if legacy_number != NOT_GIVEN
+          keywords << :type if legacy_type != NOT_GIVEN
+        end
+
         {}.tap do |hsh|
           Lorem.words(number: number * 2).uniq.first(number).each do |s|
             hsh.merge!(s.to_sym => type)
@@ -32,11 +46,19 @@ module Faker
         end
       end
 
-      def complex_rb_hash(number: 1)
+      def complex_rb_hash(legacy_number = NOT_GIVEN, number: 1)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :number if legacy_number != NOT_GIVEN
+        end
+
         rb_hash(number: number, type: random_complex_type)
       end
 
-      def rb_array(len: 1)
+      def rb_array(legacy_len = NOT_GIVEN, len: 1)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :len if legacy_len != NOT_GIVEN
+        end
+
         [].tap do |ar|
           len.times do
             ar.push random_type

data/lib/faker/default/vehicle.rb

@@ -9,7 +9,7 @@ module Faker
     VIN_LETTERS = 'ABCDEFGHJKLMNPRSTUVWXYZ'
     VIN_MAP = '0123456789X'
     VIN_WEIGHTS = '8765432X098765432'
-    VIN_REGEX = /^[A-Z0-9]{3}[A-Z0-9]{5}[A-Z0-9]{1}[A-Z0-9]{1}[A-Z0-0]{1}[A-Z0-9]{1}\d{5}$/
+    VIN_REGEX = /^[A-Z0-9]{3}[A-Z0-9]{5}[A-Z0-9]{1}[A-Z0-9]{1}[A-Z0-0]{1}[A-Z0-9]{1}\d{5}$/.freeze
     SG_CHECKSUM_WEIGHTS = [3, 14, 2, 12, 2, 11, 1].freeze
     SG_CHECKSUM_CHARS = 'AYUSPLJGDBZXTRMKHEC'
 
@@ -26,7 +26,11 @@ module Faker
         fetch('vehicle.makes')
       end
 
-      def model(make_of_model: '')
+      def model(legacy_make_of_model = NOT_GIVEN, make_of_model: '')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :make_of_model if legacy_make_of_model != NOT_GIVEN
+        end
+
         return fetch("vehicle.models_by_make.#{make}") if make_of_model.empty?
 
         fetch("vehicle.models_by_make.#{make_of_model}")
@@ -85,13 +89,22 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :min if legacy_min != NOT_GIVEN
+          keywords << :max if legacy_max != NOT_GIVEN
+        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: '')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :state_abreviation if legacy_state_abreviation != NOT_GIVEN
+        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,20 @@ module Faker
         fetch('world_cup.stadiums')
       end
 
-      def group(group: 'group_A')
+      def group(legacy_group = NOT_GIVEN, group: 'group_A')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :group if legacy_group != NOT_GIVEN
+        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')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :country if legacy_country != NOT_GIVEN
+          keywords << :type if legacy_type != NOT_GIVEN
+        end
+
         fetch("world_cup.rosters.#{country}.#{type}")
       end
     end

data/lib/faker/games/dota.rb

@@ -20,7 +20,11 @@ module Faker
           fetch('games.dota.player')
         end
 
-        def quote(hero: 'abaddon')
+        def quote(legacy_hero = NOT_GIVEN, hero: 'abaddon')
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :hero if legacy_hero != NOT_GIVEN
+          end
+
           fetch("games.dota.#{hero}.quote")
         end
       end