faker 2.22.0 → 3.0.0

data/lib/faker/default/phone_number.rb

@@ -123,11 +123,7 @@ module Faker
       #   Faker::PhoneNumber.extension #=> "3764"
       #
       # @faker.version 1.3.0
-      def subscriber_number(legacy_length = NOT_GIVEN, length: 4)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :length if legacy_length != NOT_GIVEN
-        end
-
+      def subscriber_number(length: 4)
         rand.to_s[2..(1 + length)]
       end
 

data/lib/faker/default/placeholdit.rb

@@ -5,8 +5,6 @@ module Faker
     class << self
       SUPPORTED_FORMATS = %w[png jpg gif jpeg].freeze
 
-      # rubocop:disable Metrics/ParameterLists
-
       ##
       # Produces a random placeholder image from https://via.placeholder.com.
       #
@@ -28,15 +26,7 @@ module Faker
       #   Faker::Placeholdit.image(size: '50x50', format: 'jpg', background_color: 'ffffff', text_color: '000', text: 'Some Custom Text') #=> "https://via.placeholder.com/50x50.jpg/ffffff/000?text=Some Custom Text"
       #
       # @faker.version 1.6.0
-      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)
-        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
-
+      def image(size: '300x300', format: 'png', background_color: nil, text_color: nil, text: nil)
         background_color = generate_color if background_color == :random
         text_color = generate_color if text_color == :random
 
@@ -51,7 +41,6 @@ module Faker
         image_url += "?text=#{text}" if text
         image_url
       end
-      # rubocop:enable Metrics/ParameterLists
 
       private
 

data/lib/faker/default/relationship.rb

@@ -14,11 +14,7 @@ module Faker
       #   Faker::Relationship.familial #=> "Grandfather"
       #
       # @faker.version 1.9.2
-      def familial(legacy_connection = NOT_GIVEN, connection: nil)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :connection if legacy_connection != NOT_GIVEN
-        end
-
+      def familial(connection: nil)
         familial_connections = translate('faker.relationship.familial').keys
 
         if connection.nil?

data/lib/faker/default/source.rb

@@ -17,11 +17,7 @@ module Faker
       #     #=> "alert('Hello World!');"
       #
       # @faker.version 1.9.0
-      def hello_world(legacy_lang = NOT_GIVEN, lang: :ruby)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :lang if legacy_lang != NOT_GIVEN
-        end
-
+      def hello_world(lang: :ruby)
         fetch("source.hello_world.#{lang}")
       end
 
@@ -39,13 +35,7 @@ module Faker
       #     #=> "console.log('foo bar');"
       #
       # @faker.version 1.9.0
-      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
+      def print(str: 'some string', lang: :ruby)
         code = fetch("source.print.#{lang}")
         code.gsub('faker_string_to_print', str)
       end
@@ -65,10 +55,7 @@ module Faker
       #   #    }"
       #
       # @faker.version 1.9.0
-      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
+      def print_1_to_10(lang: :ruby)
         fetch("source.print_1_to_10.#{lang}")
       end
     end

data/lib/faker/default/string.rb

@@ -17,11 +17,7 @@ module Faker
       #   Faker::String.random(length: [1, (2..5), [3, 6], nil]) #=> "葓L#ћ"
       #
       # @faker.version 1.9.0
-      def random(legacy_length = NOT_GIVEN, length: 32)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :length if legacy_length != NOT_GIVEN
-        end
-
+      def random(length: 32)
         utf8string select_a length
       end
 

data/lib/faker/default/stripe.rb

@@ -14,11 +14,7 @@ module Faker
       #   Faker::Stripe.valid_card(card_type: "visa_debit") #=> "4000056655665556"
       #
       # @faker.version 1.9.0
-      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
-
+      def valid_card(card_type: nil)
         valid_cards = translate('faker.stripe.valid_cards').keys
 
         if card_type.nil?
@@ -44,11 +40,7 @@ module Faker
       #   Faker::Stripe.valid_token(card_type: "mc_debit") #=> "tok_mastercard_debit"
       #
       # @faker.version 1.9.0
-      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
-
+      def valid_token(card_type: nil)
         valid_tokens = translate('faker.stripe.valid_tokens').keys
 
         if card_type.nil?
@@ -73,11 +65,7 @@ module Faker
       #   Faker::Stripe.invalid_card(card_error: "addressZipFail") #=> "4000000000000010"
       #
       # @faker.version 1.9.0
-      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
-
+      def invalid_card(card_error: nil)
         invalid_cards = translate('faker.stripe.invalid_cards').keys
 
         if card_error.nil?
@@ -130,11 +118,7 @@ module Faker
       #   Faker::Stripe.ccv(card_type: "amex") #=> "1234"
       #
       # @faker.version 1.9.0
-      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
-
+      def ccv(card_type: nil)
         (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,8 +13,6 @@ module Faker
     }.freeze
 
     class << self
-      # rubocop:disable Metrics/ParameterLists
-
       ##
       # Produce a random time between two times.
       #
@@ -37,13 +35,7 @@ module Faker
       #   Faker::Time.between(from: DateTime.now - 1, to: DateTime.now, format: :long) #=> "2018年10月16日(火) 10時48分27秒 -0500"
       #
       # @faker.version 1.5.0
-      def between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, legacy_format = NOT_GIVEN, from:, to:, format: nil)
-        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
-
+      def between(from:, to:, format: nil)
         from = get_time_object(from)
         to = get_time_object(to)
 
@@ -79,14 +71,7 @@ module Faker
       #     #=> "Fri, 19 Oct 2018 15:17:46 -0500"
       #
       # @faker.version 1.0.0
-      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)
-        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
-
+      def between_dates(from:, to:, period: :all, format: nil)
         date = Faker::Date.between(from: from, to: to)
         time = date_with_random_time(date, period)
         time_with_format(time, format)
@@ -107,13 +92,7 @@ module Faker
       #     #=> "October 21, 2018 20:47"
       #
       # @faker.version 1.5.0
-      def forward(legacy_days = NOT_GIVEN, legacy_period = NOT_GIVEN, legacy_format = NOT_GIVEN, days: 365, period: :all, format: nil)
-        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
-
+      def forward(days: 365, period: :all, format: nil)
         time_with_format(date_with_random_time(Faker::Date.forward(days: days), period), format)
       end
 
@@ -132,16 +111,9 @@ module Faker
       #     #=> "14 Oct 07:44"
       #
       # @faker.version 1.5.0
-      def backward(legacy_days = NOT_GIVEN, legacy_period = NOT_GIVEN, legacy_format = NOT_GIVEN, days: 365, period: :all, format: nil)
-        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
-
+      def backward(days: 365, period: :all, format: nil)
         time_with_format(date_with_random_time(Faker::Date.backward(days: days), period), format)
       end
-      # rubocop:enable Metrics/ParameterLists
 
       private
 

data/lib/faker/default/twitter.rb

@@ -16,12 +16,7 @@ module Faker
       #   Faker::Twitter.user(include_email: true) # Simulate an authenticated user with the email permission
       #
       # @faker.version 1.7.3
-      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
-
+      def user(include_status: true, include_email: false)
         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')
@@ -85,12 +80,7 @@ module Faker
       #   Faker::Twitter.status(include_photo: true) # Includes entities for an attached image
       #
       # @faker.version 1.7.3
-      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
-
+      def status(include_user: true, include_photo: false)
         status_id = id
         status = {
           id: status_id,
@@ -161,11 +151,7 @@ module Faker
         }
       end
 
-      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
-
+      def status_entities(include_photo: false)
         entities = {
           hashtags: [],
           symbols: [],

data/lib/faker/default/types.rb

@@ -16,11 +16,7 @@ module Faker
       #   Faker::Types.rb_string #=> "foobar"
       #
       # @faker.version 1.8.6
-      def rb_string(legacy_words = NOT_GIVEN, words: 1)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :words if legacy_words != NOT_GIVEN
-        end
-
+      def rb_string(words: 1)
         resolved_num = resolve(words)
         word_list =
           translate('faker.lorem.words')
@@ -51,12 +47,7 @@ module Faker
       #   Faker::Types.rb_integer #=> 1
       #
       # @faker.version 1.8.6
-      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
-
+      def rb_integer(from: 0, to: 100)
         rand(from..to).to_i
       end
 
@@ -72,12 +63,7 @@ module Faker
       #   Faker::Types.rb_hash(number: 2) #=> {name: "bob", last: "marley"}
       #
       # @faker.version 1.8.6
-      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
-
+      def rb_hash(number: 1, type: -> { random_type })
         {}.tap do |hsh|
           Lorem.words(number: number * 2).uniq.first(number).each do |s|
             value = type.is_a?(Proc) ? type.call : type
@@ -98,11 +84,7 @@ module Faker
       #   Faker::Types.complex_rb_hash(number: 2) #=> {user: {first: "bob", last: "marley"}, son: ["damien", "marley"]}
       #
       # @faker.version 1.8.6
-      def complex_rb_hash(legacy_number = NOT_GIVEN, number: 1)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :number if legacy_number != NOT_GIVEN
-        end
-
+      def complex_rb_hash(number: 1)
         rb_hash(number: number, type: -> { random_complex_type })
       end
 
@@ -117,11 +99,7 @@ module Faker
       #   Faker::Types.rb_array(len: 4) #=> ["a", 1, 2, "bob"]
       #
       # @faker.version 1.8.6
-      def rb_array(legacy_len = NOT_GIVEN, len: 1)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :len if legacy_len != NOT_GIVEN
-        end
-
+      def rb_array(len: 1)
         [].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-HJ-NPR-Z0-9]){3}[A-HJ-NPR-Z0-9]{5}[A-HJ-NPR-Z0-9]{1}[A-HJ-NPR-Z0-9]{1}[A-HJ-NPR-Z0-0]{1}[A-HJ-NPR-Z0-9]{1}\d{5}$/.freeze
+    VIN_REGEX = /^([A-HJ-NPR-Z0-9]){3}[A-HJ-NPR-Z0-9]{5}[A-HJ-NPR-Z0-9]{1}[A-HJ-NPR-Z0-9]{1}[A-HJ-NPR-Z0-9]{1}[A-HJ-NPR-Z0-9]{1}\d{5}$/.freeze
     SG_CHECKSUM_WEIGHTS = [3, 14, 2, 12, 2, 11, 1].freeze
     SG_CHECKSUM_CHARS = 'AYUSPLJGDBZXTRMKHEC'
 
@@ -62,11 +62,7 @@ module Faker
       #   Faker::Vehicle.model(make_of_model: 'Toyota') #=> "Prius"
       #
       # @faker.version 1.6.4
-      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
-
+      def model(make_of_model: '')
         return fetch("vehicle.models_by_make.#{make}") if make_of_model.empty?
 
         fetch("vehicle.models_by_make.#{make_of_model}")
@@ -249,12 +245,7 @@ module Faker
       #   Faker::Vehicle.kilometrage #=> 35378
       #
       # @faker.version 1.6.4
-      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
-
+      def mileage(min: MILEAGE_MIN, max: MILEAGE_MAX)
         rand_in_range(min, max)
       end
 
@@ -271,11 +262,7 @@ module Faker
       #   Faker::Vehicle.license_plate(state_abbreviation: 'FL') #=> "977 UNU"
       #
       # @faker.version 1.6.4
-      def license_plate(legacy_state_abreviation = NOT_GIVEN, state_abbreviation: '')
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :state_abbreviation if legacy_state_abreviation != NOT_GIVEN
-        end
-
+      def license_plate(state_abbreviation: '')
         return regexify(bothify(fetch('vehicle.license_plate'))) if state_abbreviation.empty?
 
         key = "vehicle.license_plate_by_state.#{state_abbreviation}"
@@ -297,6 +284,19 @@ module Faker
         "#{plate_number}#{singapore_checksum(plate_number)}"
       end
 
+      ##
+      # Produces a car version
+      #
+      # @return [String]
+      #
+      # @example
+      #  Faker::Vehicle.version #=> "40 TFSI Premium"
+      #
+      # @faker.version next
+      def version
+        fetch('vehicle.version')
+      end
+
       private
 
       def first_eight(number)
@@ -320,7 +320,7 @@ module Faker
       end
 
       def vin_char_to_number(char)
-        index = VIN_LETTERS.split('').index(char)
+        index = VIN_LETTERS.chars.index(char)
 
         return char.to_i if index.nil?
 
@@ -328,14 +328,14 @@ module Faker
       end
 
       def singapore_checksum(plate_number)
-        padded_alphabets = format('%3s', plate_number[/^[A-Z]+/]).tr(' ', '-').split('')
-        padded_digits = format('%04d', plate_number[/\d+/]).split('').map(&:to_i)
+        padded_alphabets = format('%3s', plate_number[/^[A-Z]+/]).tr(' ', '-').chars
+        padded_digits = format('%04d', plate_number[/\d+/]).chars.map(&:to_i)
         sum = [*padded_alphabets, *padded_digits].each_with_index.reduce(0) do |memo, (char, i)|
           value = char.is_a?(Integer) ? char : char.ord - 64
           memo + (SG_CHECKSUM_WEIGHTS[i] * value)
         end
 
-        SG_CHECKSUM_CHARS.split('')[sum % 19]
+        SG_CHECKSUM_CHARS.chars[sum % 19]
       end
     end
   end

data/lib/faker/default/vulnerability_identifier.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Faker
+  class VulnerabilityIdentifier < Base
+    class << self
+      ##
+      # Produces a Common Vulnerabilities and Exposures (CVE) identifier.
+      #
+      # @param year [Integer] The year-part of the CVE identifier (defaults to the current year)
+      # @return [String]
+      #
+      # @example
+      #   Faker::VulnerabilityIdentifier.cve #=> "CVE-2021-1337"
+      #   Faker::VulnerabilityIdentifier.cve(year: 1999) #=> "CVE-1999-0523"
+      #
+      # @faker.version next
+      def cve(year: ::Date.today.year)
+        index = rand_in_range(1, 99_999).to_s.rjust(4, '0')
+        "CVE-#{year}-#{index}"
+      end
+    end
+  end
+end

data/lib/faker/default/world_cup.rb

@@ -53,11 +53,7 @@ module Faker
       #   Faker::WorldCup.group #=> "Russia"
       #
       # @faker.version 2.13.0
-      def group(legacy_group = NOT_GIVEN, group: 'group_A')
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :group if legacy_group != NOT_GIVEN
-        end
-
+      def group(group: 'group_A')
         fetch("world_cup.groups.#{group}")
       end
 
@@ -73,12 +69,7 @@ module Faker
       #   Faker::WorldCup.roster(country: 'Spain', type: 'forwards') #=> "Diego Costa"
       #
       # @faker.version 2.13.0
-      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
-
+      def roster(country: 'Egypt', type: 'coach')
         fetch("world_cup.rosters.#{country}.#{type}")
       end
     end

data/lib/faker/games/dota.rb

@@ -80,11 +80,7 @@ module Faker
         #   Faker::Games::Dota.quote(hero: 'alchemist') #=> "Better living through alchemy!"
         #
         # @faker.version 1.9.0
-        def quote(legacy_hero = NOT_GIVEN, hero: 'abaddon')
-          warn_for_deprecated_arguments do |keywords|
-            keywords << :hero if legacy_hero != NOT_GIVEN
-          end
-
+        def quote(hero: 'abaddon')
           fetch("games.dota.#{hero}.quote")
         end
       end