faker 2.1.2 → 2.3.0

data/lib/faker/default/bank.rb

@@ -5,7 +5,11 @@ module Faker
     flexible :bank
 
     class << self
-      def account_number(digits: 10)
+      def account_number(legacy_digits = NOT_GIVEN, digits: 10)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :digits if legacy_digits != NOT_GIVEN
+        end
+
         output = ''
 
         output += rand.to_s[2..-1] while output.length < digits
@@ -13,10 +17,14 @@ 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
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :country_code if legacy_country_code != NOT_GIVEN
+        end
+
         begin
           pattern = fetch("bank.iban_details.#{country_code.downcase}.bban_pattern")
         rescue I18n::MissingTranslationData

data/lib/faker/default/boolean.rb

@@ -3,7 +3,22 @@
 module Faker
   class Boolean < Base
     class << self
-      def boolean(true_ratio: 0.5)
+      ##
+      # Produces a boolean
+      #
+      # @param true_ratio [Float] The likelihood (as a float, out of 1.0) for the method to return `true`.
+      # @return [Boolean]
+      #
+      # @example
+      #   Faker::Boolean.boolean #=> true
+      # @example
+      #   Faker::Boolean.boolean(true_ratio: 0.2) #=> false
+      #
+      # @faker.version 1.6.2
+      def boolean(legacy_true_ratio = NOT_GIVEN, true_ratio: 0.5)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :true_ratio if legacy_true_ratio != NOT_GIVEN
+        end
         (rand < true_ratio)
       end
     end

data/lib/faker/default/chile_rut.rb

@@ -6,7 +6,12 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :min_rut if legacy_min_rut != NOT_GIVEN
+          keywords << :fixed if legacy_fixed != NOT_GIVEN
+        end
+
         @last_rut = fixed ? min_rut : rand_in_range(min_rut, 99_999_999)
       end
 
@@ -34,7 +39,12 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :min_rut if legacy_min_rut != NOT_GIVEN
+          keywords << :fixed if legacy_fixed != NOT_GIVEN
+        end
+
         "#{rut(min_rut: min_rut, fixed: fixed)}-#{dv}"
       end
 

data/lib/faker/default/code.rb

@@ -12,13 +12,21 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :base if legacy_base != NOT_GIVEN
+        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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :base if legacy_base != NOT_GIVEN
+        end
+
         base == 8 ? generate_base8_ean : generate_base13_ean
       end
 
@@ -30,7 +38,12 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :min_age if legacy_min_age != NOT_GIVEN
+          keywords << :max_age if legacy_max_age != NOT_GIVEN
+        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,11 @@ module Faker
         fetch('color.name')
       end
 
-      def promotion_code(digits: 6)
+      def promotion_code(legacy_digits = NOT_GIVEN, digits: 6)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :digits if legacy_digits != NOT_GIVEN
+        end
+
         [
           fetch('commerce.promotion_code.adjective'),
           fetch('commerce.promotion_code.noun'),
@@ -15,7 +19,12 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :max if legacy_max != NOT_GIVEN
+          keywords << :fixed_amount if legacy_fixed_amount != NOT_GIVEN
+        end
+
         num = max if fixed_amount
         num ||= 1 + rand(max)
 
@@ -34,7 +43,12 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :range if legacy_range != NOT_GIVEN
+          keywords << :as_string if legacy_as_string != NOT_GIVEN
+        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,11 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :length if legacy_length != NOT_GIVEN
+        end
+
         raise ArgumentError, 'Length should be 9 or 14' unless [9, 14].include? length
 
         random_digits = []
@@ -153,7 +157,11 @@ 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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :formatted if legacy_formatted != NOT_GIVEN
+        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,27 @@ module Faker
       ACRONYM = 1
       URL_LOGO = 2
 
-      def coin_name(coin: coin_array)
+      def coin_name(legacy_coin = NOT_GIVEN, coin: coin_array)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :coin if legacy_coin != NOT_GIVEN
+        end
+
         coin[COIN_NAME]
       end
 
-      def acronym(coin: coin_array)
+      def acronym(legacy_coin = NOT_GIVEN, coin: coin_array)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :coin if legacy_coin != NOT_GIVEN
+        end
+
         coin[ACRONYM]
       end
 
-      def url_logo(coin: coin_array)
+      def url_logo(legacy_coin = NOT_GIVEN, coin: coin_array)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :coin if legacy_coin != NOT_GIVEN
+        end
+
         coin[URL_LOGO]
       end
 

data/lib/faker/default/date.rb

@@ -3,14 +3,31 @@
 module Faker
   class Date < Base
     class << self
-      def between(from:, to:)
+      def between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from:, to:)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :from if legacy_from != NOT_GIVEN
+          keywords << :to if legacy_to != NOT_GIVEN
+        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
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :from if legacy_from != NOT_GIVEN
+        end
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :to if legacy_to != NOT_GIVEN
+        end
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :excepted if legacy_excepted != NOT_GIVEN
+        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 +38,36 @@ module Faker
         end
       end
 
-      def forward(days: 365)
+      def forward(legacy_days = NOT_GIVEN, days: 365)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :days if legacy_days != NOT_GIVEN
+        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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :days if legacy_days != NOT_GIVEN
+        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)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :min_age if legacy_min_age != NOT_GIVEN
+        end
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :max_age if legacy_max_age != NOT_GIVEN
+        end
+
         t = ::Date.today
 
         from = birthday_date(t, max_age)

data/lib/faker/default/demographic.rb

@@ -23,7 +23,11 @@ module Faker
         fetch('demographic.sex')
       end
 
-      def height(unit: :metric)
+      def height(legacy_unit = NOT_GIVEN, unit: :metric)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :unit if legacy_unit != NOT_GIVEN
+        end
+
         case unit
         when :imperial
           inches = rand_in_range(57, 86)

data/lib/faker/default/driving_licence.rb

@@ -6,10 +6,16 @@ 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
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :last_name if legacy_last_name != NOT_GIVEN
+          keywords << :initials if legacy_initials != NOT_GIVEN
+          keywords << :gender if legacy_gender != NOT_GIVEN
+          keywords << :date_of_birth if legacy_date_of_birth != NOT_GIVEN
+        end
+
         [
           gb_licence_padding(last_name, 5),
           gb_licence_year(date_of_birth, gender),

data/lib/faker/default/file.rb

@@ -3,7 +3,15 @@
 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
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :segment_count if legacy_segment_count != NOT_GIVEN
+          keywords << :root if legacy_root != NOT_GIVEN
+          keywords << :directory_separator if legacy_directory_separator != NOT_GIVEN
+        end
+
         Array
           .new(segment_count) { Faker::Internet.slug }
           .unshift(root)
@@ -20,7 +28,16 @@ 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
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :dir if legacy_dir != NOT_GIVEN
+          keywords << :name if legacy_name != NOT_GIVEN
+          keywords << :ext if legacy_ext != NOT_GIVEN
+          keywords << :directory_separator if legacy_directory_separator != NOT_GIVEN
+        end
+
         dir ||= dir(segment_count: 1)
         name ||= Faker::Lorem.word.downcase
         ext ||= extension

data/lib/faker/default/fillmurray.rb

@@ -3,7 +3,15 @@
 module Faker
   class Fillmurray < Base
     class << self
-      def image(grayscale: false, width: 200, height: 200)
+      # rubocop:disable Metrics/ParameterLists
+      def image(legacy_grayscale = NOT_GIVEN, legacy_width = NOT_GIVEN, legacy_height = NOT_GIVEN, grayscale: false, width: 200, height: 200)
+        # rubocop:enable Metrics/ParameterLists
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :grayscale if legacy_grayscale != NOT_GIVEN
+          keywords << :width if legacy_width != NOT_GIVEN
+          keywords << :height if legacy_height != NOT_GIVEN
+        end
+
         raise ArgumentError, 'Width should be a number' unless width.to_s =~ /^\d+$/
         raise ArgumentError, 'Height should be a number' unless height.to_s =~ /^\d+$/
         raise ArgumentError, 'Grayscale should be a boolean' unless [true, false].include?(grayscale)

data/lib/faker/default/finance.rb

@@ -26,7 +26,11 @@ module Faker
         template.gsub('L', luhn_digit.to_s)
       end
 
-      def vat_number(country: 'BR')
+      def vat_number(legacy_country = NOT_GIVEN, country: 'BR')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :country if legacy_country != NOT_GIVEN
+        end
+
         numerify(fetch("finance.vat_number.#{country}"))
       rescue I18n::MissingTranslationData
         raise ArgumentError, "Could not find vat number for #{country}"

data/lib/faker/default/gender.rb

@@ -3,10 +3,28 @@
 module Faker
   class Gender < Base
     class << self
+      ##
+      # Produces the name of a gender identity.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Gender.type #=> "Non-binary"
+      #
+      # @faker.version 1.9.0
       def type
         fetch('gender.types')
       end
 
+      ##
+      # Produces either 'Male' or 'Female'.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Gender.binary_type #=> "Female"
+      #
+      # @faker.version 1.9.0
       def binary_type
         fetch('gender.binary_types')
       end

data/lib/faker/default/hacker.rb

@@ -1,35 +1,93 @@
 # frozen_string_literal: true
 
-# Port of http://shinytoylabs.com/jargon/
 module Faker
+  # Port of http://shinytoylabs.com/jargon/
+  # Are you having trouble writing tech-savvy dialogue for your latest screenplay?
+  # Worry not! Hollywood-grade technical talk is ready to fill out any form where you need to look smart.
   class Hacker < Base
     flexible :hacker
 
     class << self
+      ##
+      # Produces something smart.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hacker.say_something_smart
+      #     #=> "Try to compress the SQL interface, maybe it will program the back-end hard drive!"
+      #
+      # @faker.version 1.4.0
       def say_something_smart
         sample(phrases)
       end
 
+      ##
+      # Short technical abbreviations.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hacker.abbreviation #=> "RAM"
+      #
+      # @faker.version 1.4.0
       def abbreviation
         fetch('hacker.abbreviation')
       end
 
+      ##
+      # Hacker-centric adjectives.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hacker.adjective #=> "open-source"
+      #
+      # @faker.version 1.4.0
       def adjective
         fetch('hacker.adjective')
       end
 
+      ##
+      # Only the best hacker-related nouns.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hacker.noun #=> "bandwidth"
+      #
+      # @faker.version 1.4.0
       def noun
         fetch('hacker.noun')
       end
 
+      ##
+      # Actions that hackers take.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hacker.verb #=> "bypass"
+      #
+      # @faker.version 1.4.0
       def verb
         fetch('hacker.verb')
       end
 
+      ##
+      # Produces a verb that ends with '-ing'.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hacker.ingverb #=> "synthesizing"
+      #
+      # @faker.version 1.4.0
       def ingverb
         fetch('hacker.ingverb')
       end
 
+      # @private
       def phrases
         ["If we #{verb} the #{noun}, we can get to the #{abbreviation} #{noun} through the #{adjective} #{abbreviation} #{noun}!",
          "We need to #{verb} the #{adjective} #{abbreviation} #{noun}!",