faker 2.20.0 → 3.2.1

data/lib/faker/default/company.rb

@@ -151,6 +151,19 @@ module Faker
         fetch('company.profession')
       end
 
+      ##
+      # Produces a company department.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Company.department #=> "Information Technology"
+      #
+      # @faker.version next
+      def department
+        fetch('company.department')
+      end
+
       ##
       # Produces a company spanish organisation number.
       #
@@ -296,7 +309,7 @@ module Faker
           result = Array.new(3) { rand(1..9) } + Array.new(7) { rand(10) }
           break if (weight_sum(result, weights) % 11) == result[9]
         end
-        result.join('')
+        result.join
       end
 
       ##
@@ -309,11 +322,7 @@ module Faker
       #
       # @faker.version 1.9.1
       # Get a random Polish register of national economy number. More info https://pl.wikipedia.org/wiki/REGON
-      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
-
+      def polish_register_of_national_economy(length: 9)
         raise ArgumentError, 'Length should be 9 or 14' unless [9, 14].include? length
 
         random_digits = []
@@ -321,7 +330,7 @@ module Faker
           random_digits = Array.new(length) { rand(10) }
           break if collect_regon_sum(random_digits) == random_digits.last
         end
-        random_digits.join('')
+        random_digits.join
       end
 
       ##
@@ -334,7 +343,12 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_pty_ltd_registration_number
-        regexify(%r{\d{4}/\d{4,10}/07})
+        generate(:string) do |g|
+          g.int(length: 4)
+          g.lit('/')
+          g.int(ranges: [1000..9_999_999_999])
+          g.lit('/07')
+        end
       end
 
       ##
@@ -347,7 +361,18 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_close_corporation_registration_number
-        regexify(%r{(CK\d{2}|\d{4})/\d{4,10}/23})
+        generate(:string) do |g|
+          g.oneof do |one|
+            one.group do |g_|
+              g_.lit('CK')
+              g_.int(length: 2)
+            end
+            one.int(length: 4)
+          end
+          g.lit('/')
+          g.int(ranges: [1000..9_999_999_999])
+          g.lit('/23')
+        end
       end
 
       ##
@@ -360,7 +385,12 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_listed_company_registration_number
-        regexify(%r{\d{4}/\d{4,10}/06})
+        generate(:string) do |g|
+          g.int(length: 4)
+          g.lit('/')
+          g.int(ranges: [1000..9_999_999_999])
+          g.lit('/06')
+        end
       end
 
       ##
@@ -373,7 +403,12 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_trust_registration_number
-        regexify(%r{IT\d{2,4}/\d{2,10}})
+        generate(:string) do |g|
+          g.lit('IT')
+          g.int(ranges: [10..9999])
+          g.lit('/')
+          g.int(ranges: [10..9_999_999_999])
+        end
       end
 
       ##
@@ -385,11 +420,7 @@ module Faker
       #   Faker::Company.brazilian_company_number #=> "37205322000500"
       #
       # @faker.version 1.9.2
-      def brazilian_company_number(legacy_formatted = NOT_GIVEN, formatted: false)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :formatted if legacy_formatted != NOT_GIVEN
-        end
-
+      def brazilian_company_number(formatted: false)
         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
@@ -459,7 +490,7 @@ module Faker
       def luhn_algorithm(number)
         multiplications = []
 
-        number.to_s.reverse.split(//).each_with_index do |digit, i|
+        number.to_s.reverse.chars.each_with_index do |digit, i|
           multiplications << if i.even?
                                digit.to_i * 2
                              else
@@ -553,7 +584,7 @@ module Faker
       def spanish_cif_control_digit(organization_type, code)
         letters = %w[J A B C D E F G H I]
 
-        control = code.split('').each_with_index.inject(0) do |sum, (value, index)|
+        control = code.chars.each_with_index.inject(0) do |sum, (value, index)|
           if (index + 1).even?
             sum + value.to_i
           else
@@ -562,7 +593,7 @@ module Faker
         end
 
         control = control.to_s[-1].to_i
-        control = control.zero? ? control : 10 - control
+        control = 10 - control unless control.zero?
 
         %w[A B C D E F G H J U V].include?(organization_type) ? control : letters[control]
       end

data/lib/faker/default/crypto_coin.rb

@@ -16,11 +16,7 @@ module Faker
       #   Faker::CryptoCoin.coin_name #=> "Bitcoin"
       #
       # @faker.version 1.9.2
-      def coin_name(legacy_coin = NOT_GIVEN, coin: coin_array)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :coin if legacy_coin != NOT_GIVEN
-        end
-
+      def coin_name(coin: coin_array)
         coin[COIN_NAME]
       end
 
@@ -33,11 +29,7 @@ module Faker
       #   Faker::CryptoCoin.acronym #=> "BTC"
       #
       # @faker.version 1.9.2
-      def acronym(legacy_coin = NOT_GIVEN, coin: coin_array)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :coin if legacy_coin != NOT_GIVEN
-        end
-
+      def acronym(coin: coin_array)
         coin[ACRONYM]
       end
 
@@ -50,11 +42,7 @@ module Faker
       #   Faker::CryptoCoin.url_logo #=> "https://i.imgur.com/EFz61Ei.png"
       #
       # @faker.version 1.9.2
-      def url_logo(legacy_coin = NOT_GIVEN, coin: coin_array)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :coin if legacy_coin != NOT_GIVEN
-        end
-
+      def url_logo(coin: coin_array)
         coin[URL_LOGO]
       end
 

data/lib/faker/default/date.rb

@@ -2,6 +2,8 @@
 
 module Faker
   class Date < Base
+    DAYS_OF_WEEK = %i[sunday monday tuesday wednesday thursday friday saturday].freeze
+
     class << self
       ##
       # Produce a random date between two dates.
@@ -17,20 +19,13 @@ module Faker
       #   Faker::Date.between(from: 2.days.ago, to: Date.today) #=> #<Date: 2014-09-24>
       #
       # @faker.version 1.0.0
-      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
-
+      def between(from:, to:)
         from = get_date_object(from)
         to   = get_date_object(to)
 
         Faker::Base.rand_in_range(from, to)
       end
 
-      # rubocop:disable Metrics/ParameterLists
-
       ##
       # Produce a random date between two dates.
       #
@@ -46,17 +41,7 @@ module Faker
       #   Faker::Date.between_except(from: 1.year.ago, to: 1.year.from_now, excepted: Date.today) #=> #<Date: 2014-10-03>
       #
       # @faker.version 1.6.2
-      def between_except(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, legacy_excepted = NOT_GIVEN, from:, to:, excepted:)
-        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
-
+      def between_except(from:, to:, excepted:)
         raise ArgumentError, 'From date, to date and excepted date must not be the same' if from == to && to == excepted
 
         excepted = get_date_object(excepted)
@@ -66,27 +51,30 @@ module Faker
           break date.to_date if date != excepted
         end
       end
-      # rubocop:enable Metrics/ParameterLists
 
       ##
       # Produce a random date in the future (up to N days).
       #
+      # @param from [Integer] The start of the usable forward date range.
       # @param days [Integer] The maximum number of days to go into the future.
       # @return [Date]
       #
-      # @example
+      # @example if used with or without Rails (Active Support)
       #   Faker::Date.forward(days: 23) #=> #<Date: 2014-10-03>
       #
+      # @example if used with Rails (Active Support)
+      #  Faker::Date.forward(from: Date.current, days: 17) #=> #<Date: 2022-06-22>
+      #
+      # @example if used with or without Rails (Active Support)
+      #   Faker::Date.forward(from: '2022-06-03', days: 10) #=> #<Date: 2022-10-13>
+      #
       # @faker.version 1.0.0
-      def forward(legacy_days = NOT_GIVEN, days: 365)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :days if legacy_days != NOT_GIVEN
-        end
+      def forward(from: ::Date.today, days: 365)
+        start_date = get_date_object(from)
+        since = start_date + 1
+        to = start_date + days
 
-        from = ::Date.today + 1
-        to   = ::Date.today + days
-
-        between(from: from, to: to).to_date
+        between(from: since, to: to).to_date
       end
 
       ##
@@ -99,11 +87,7 @@ module Faker
       #   Faker::Date.backward(days: 14) #=> #<Date: 2019-09-12>
       #
       # @faker.version 1.0.0
-      def backward(legacy_days = NOT_GIVEN, days: 365)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :days if legacy_days != NOT_GIVEN
-        end
-
+      def backward(days: 365)
         from = ::Date.today - days
         to   = ::Date.today - 1
 
@@ -121,14 +105,7 @@ module Faker
       #   Faker::Date.birthday(min_age: 18, max_age: 65) #=> #<Date: 1986-03-28>
       #
       # @faker.version 1.4.3
-      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
-
+      def birthday(min_age: 18, max_age: 65)
         t = ::Date.today
 
         from = birthday_date(t, max_age)
@@ -161,6 +138,52 @@ module Faker
         between(from: from, to: to).to_date
       end
 
+      ##
+      # Produce a random date at given day(s) of the week between two dates.
+      #
+      # @param day [Symbol, Array<Symbol>] # The day(s) of the week. See {DAYS_OF_WEEK}.
+      # @param from [Date, String] The start of the usable date range.
+      # @param to [Date, String] The end of the usable date range.
+      # @return [Date]
+      #
+      # @example if used with or without Rails (Active Support)
+      #   Faker::Date.on_day_of_week_between(day: :tuesday, from: '2023-01-01', to: '2023-02-01') #=> #<Date: 2032-01-10>
+      #
+      # @example if used with Rails (Active Support)
+      #   Faker::Date.on_day_of_week_between(day: [:saturday, :sunday], from: 1.month.ago, to: Date.today) #=> #<Date: 2014-09-24>
+      #
+      # @faker.version next
+      def on_day_of_week_between(day:, from:, to:)
+        days = [day].flatten
+        raise ArgumentError, 'Day of week cannot be empty' if days.empty?
+
+        # Convert given days of the week to numbers used by `Date#wday` method
+        numeric_weekdays = days.map do |d|
+          DAYS_OF_WEEK.index(d.to_sym.downcase) || raise(ArgumentError, "#{d} is not a valid day of the week")
+        end
+
+        from = get_date_object(from)
+        to   = get_date_object(to)
+        date = Faker::Base.rand_in_range(from, to)
+
+        # If the initial date is not on one of the wanted days of the week...
+        unless numeric_weekdays.include? date.wday
+          # ...pick a date nearby that is on one of the wanted days of the week instead
+          date += sample(numeric_weekdays) - date.wday
+
+          # Move date 1 week earlier or later if the adjusted date is now outside the date range
+          date += 7 if date < from
+          date -= 7 if date > to
+
+          if date > to || date < from
+            raise ArgumentError,
+                  "There is no #{DAYS_OF_WEEK[date.wday].capitalize} between #{from} and #{to}. Increase the from/to date range or choose a different day of the week."
+          end
+        end
+
+        date
+      end
+
       private
 
       def birthday_date(date, age)

data/lib/faker/default/demographic.rb

@@ -80,11 +80,7 @@ module Faker
       #   Faker::Demographic.height(unit: :imperial) #=> "6 ft, 2 in"
       #
       # @faker.version 1.7.3
-      def height(legacy_unit = NOT_GIVEN, unit: :metric)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :unit if legacy_unit != NOT_GIVEN
-        end
-
+      def height(unit: :metric)
         case unit
         when :imperial
           inches = rand_in_range(57, 86)

data/lib/faker/default/driving_licence.rb

@@ -6,8 +6,6 @@ module Faker
     NI_CHANCE = 0.03 # NI Pop is about 3% of total UK population
 
     class << self
-      # rubocop:disable Metrics/ParameterLists
-
       ##
       # Produces a random British driving licence number.
       #
@@ -25,14 +23,7 @@ module Faker
       #                                                 date_of_birth: Date.parse("1986-10-24")) #=> "OCARR815246J91HT"
       #
       # @faker.version 1.9.2
-      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))
-        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
-
+      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))
         [
           gb_licence_padding(last_name, 5),
           gb_licence_year(date_of_birth, gender),
@@ -40,7 +31,6 @@ module Faker
           gb_licence_checksum
         ].join
       end
-      # rubocop:enable Metrics/ParameterLists
 
       ##
       # Produces a random Northern Irish licence number.
@@ -108,17 +98,28 @@ module Faker
       end
 
       def gb_licence_year(dob, gender)
-        decade = (dob.year / 10) % 10
-        year = dob.year % 10
-        month = gender == :female ? dob.month + 50 : dob.month
-        # Rubocop's preferred formatting is pretty gory
-        # rubocop:disable Style/FormatString
-        "#{decade}#{'%02d' % month}#{'%02d' % dob.day}#{year}"
-        # rubocop:enable Style/FormatString
+        generate(:string) do |g|
+          g.computed do
+            (dob.year / 10) % 10
+          end
+          g.computed do
+            gender_marker = gender == :female ? 50 : 0
+            format('%02d', (dob.month + gender_marker))
+          end
+          g.computed do
+            format('%02d', dob.day)
+          end
+          g.computed do
+            dob.year % 10
+          end
+        end
       end
 
       def gb_licence_checksum
-        regexify(/[0-9][A-Z][A-Z]/)
+        generate(:string) do |g|
+          g.int
+          g.letter(ranges: ['A'..'Z'], length: 2)
+        end
       end
     end
   end

data/lib/faker/default/drone.rb

@@ -147,7 +147,7 @@ module Faker
       end
 
       ##
-      # Returns operating temprature for drone in Fahrenheit
+      # Returns operating temperature for drone in Fahrenheit
       #
       # @return [String]
       #

data/lib/faker/default/file.rb

@@ -3,8 +3,6 @@
 module Faker
   class File < Base
     class << self
-      # rubocop:disable Metrics/ParameterLists
-
       ##
       # Produces a random directory name.
       #
@@ -20,13 +18,7 @@ module Faker
       #   Faker::File.dir(segment_count: 3, root: nil, directory_separator: '\\') #=> "aut-ullam\\quia_quisquam\\ut-eos"
       #
       # @faker.version 1.6.4
-      def dir(legacy_segment_count = NOT_GIVEN, legacy_root = NOT_GIVEN, legacy_directory_separator = NOT_GIVEN, segment_count: 3, root: nil, directory_separator: ::File::Separator)
-        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
-
+      def dir(segment_count: 3, root: nil, directory_separator: ::File::Separator)
         Array
           .new(segment_count) { Faker::Internet.slug }
           .unshift(root)
@@ -34,7 +26,6 @@ module Faker
           .join(directory_separator)
           .squeeze(directory_separator)
       end
-      # rubocop:enable Metrics/ParameterLists
 
       ##
       # Produces a random file extension.
@@ -57,13 +48,11 @@ module Faker
       # @example
       #   Faker::File.mime_type #=> "application/pdf"
       #
-      # @faker.version 1.6.4
-      def mime_type
-        fetch('file.mime_type')
+      # @faker.version next
+      def mime_type(media_type: nil)
+        media_type ? fetch("file.mime_type.#{media_type}") : sample(sample(translate('faker.file.mime_type').values))
       end
 
-      # rubocop:disable Metrics/ParameterLists
-
       ##
       # Produces a random file name.
       #
@@ -80,21 +69,13 @@ module Faker
       #   Faker::File.file_name(dir: 'foo/bar', name: 'baz', ext: 'mp3', directory_separator: '\\') #=> "foo/bar\\baz.mp3"
       #
       # @faker.version 1.6.4
-      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: ::File::Separator)
-        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
-
+      def file_name(dir: nil, name: nil, ext: nil, directory_separator: ::File::Separator)
         dir ||= dir(segment_count: 1)
         name ||= Faker::Lorem.word.downcase
         ext ||= extension
 
         [dir, name].join(directory_separator) + ".#{ext}"
       end
-      # rubocop:enable Metrics/ParameterLists
     end
   end
 end

data/lib/faker/default/finance.rb

@@ -28,9 +28,9 @@ module Faker
 
         # calculate the luhn checksum digit
         multiplier = 1
-        luhn_sum = template.gsub(/[^0-9]/, '').split('').reverse.map(&:to_i).inject(0) do |sum, digit|
+        luhn_sum = template.gsub(/[^0-9]/, '').chars.reverse.map(&:to_i).inject(0) do |sum, digit|
           multiplier = (multiplier == 2 ? 1 : 2)
-          sum + (digit * multiplier).to_s.split('').map(&:to_i).inject(0) { |digit_sum, cur| digit_sum + cur }
+          sum + (digit * multiplier).to_s.chars.map(&:to_i).inject(0) { |digit_sum, cur| digit_sum + cur }
         end
 
         # the sum plus whatever the last digit is must be a multiple of 10. So, the
@@ -52,11 +52,7 @@ module Faker
       #   Faker::Finance.vat_number('ZA') #=> "ZA79494416181"
       #
       # @faker.version 1.9.2
-      def vat_number(legacy_country = NOT_GIVEN, country: 'BR')
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :country if legacy_country != NOT_GIVEN
-        end
-
+      def vat_number(country: 'BR')
         numerify(fetch("finance.vat_number.#{country}"))
       rescue I18n::MissingTranslationData
         raise ArgumentError, "Could not find vat number for #{country}"
@@ -97,6 +93,20 @@ module Faker
       def stock_market
         fetch('finance.stock_market')
       end
+
+      ##
+      # Returns a random condominium fiscal code.
+      #
+      # @param country [String] Two capital letter country code to use for the vat number.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Finance.condominium_fiscal_code #=> "012345678"
+      #
+      # @faker.version next
+      def condominium_fiscal_code(country: 'IT')
+        numerify(fetch("finance.condominium_fiscal_code.#{country}"))
+      end
     end
   end
 end

data/lib/faker/default/food.rb

@@ -5,6 +5,19 @@ module Faker
     flexible :food
 
     class << self
+      ##
+      # Retrieves an allergen.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.allergen #=> "Peanuts"
+      #
+      # @faker.version next
+      def allergen
+        fetch('food.allergens')
+      end
+
       ##
       # Retrieves a typical dish from each country.
       #
@@ -97,7 +110,7 @@ module Faker
       end
 
       ##
-      # Retrieves metric mesurements
+      # Retrieves metric measurements
       #
       # @return [String]
       #