faker 2.13.0 → 3.8.0

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.
       #
@@ -162,10 +175,17 @@ module Faker
       # @faker.version 1.8.5
       #
       # Get a random Spanish organization number. See more here https://es.wikipedia.org/wiki/N%C3%BAmero_de_identificaci%C3%B3n_fiscal
-      def spanish_organisation_number
+      def spanish_organisation_number(organization_type: nil)
         # Valid leading character: A, B, C, D, E, F, G, H, J, N, P, Q, R, S, U, V, W
-        # 7 digit numbers
-        [sample(self::ULetters), format('%07d', rand(10**7))].join
+        # format: 1 digit letter (organization type) + 7 digit numbers + 1 digit control (letter or number based on
+        # organization type)
+        letters = %w[A B C D E F G H J N P Q R S U V W]
+
+        organization_type = sample(letters) unless letters.include?(organization_type)
+        code = format('%07d', rand(10**7))
+        control = spanish_cif_control_digit(organization_type, code)
+
+        [organization_type, code, control].join
       end
 
       ##
@@ -289,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
 
       ##
@@ -302,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 = []
@@ -314,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
 
       ##
@@ -327,7 +343,12 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_pty_ltd_registration_number
-        regexify(/\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
 
       ##
@@ -340,7 +361,18 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_close_corporation_registration_number
-        regexify(/(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
 
       ##
@@ -353,7 +385,12 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_listed_company_registration_number
-        regexify(/\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
 
       ##
@@ -366,7 +403,12 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_trust_registration_number
-        regexify(/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
 
       ##
@@ -378,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
@@ -397,7 +435,18 @@ module Faker
         formatted ? format('%s.%s.%s/%s-%s', *number.scan(/(\d{2})(\d{3})(\d{3})(\d{4})(\d{2})/).flatten) : number
       end
 
+      ##
       # Get a random Russian tax number.
+      # @param region [String] Any region string
+      # @param type [Symbol] Legeal or not, defaults to :legal
+      #
+      # @return [String]
+      # @example
+      #   Faker::Company.russian_tax_number                             #=> "0415584064"
+      #   Faker::Company.russian_tax_number(region: 'AZ')               #=> "AZ50124562"
+      #   Faker::Company.russian_tax_number(region: 'AZ', type: false)  #=> "AZ8802315465"
+      #
+      # @faker.version 1.9.4
       def russian_tax_number(region: nil, type: :legal)
         inn_number(region, type)
       end
@@ -415,6 +464,61 @@ module Faker
         fetch('company.sic_code')
       end
 
+      ##
+      # Get a random Indian Goods and Services Tax (GST) number.
+      # For more on Indian tax number here:
+      # https://simple.wikipedia.org/wiki/GSTIN
+      # @params state code [String] Any state code.
+      #
+      # @return [String]
+      # @example
+      #   Faker::Company.indian_gst_number #=> "15VQPNZ2126J2ZU"
+      #   Faker::Company.indian_gst_number(state_code: "22") #=> "22ZVWEY6632K0ZN"
+      #
+      # @faker.version 3.2.1
+      def indian_gst_number(state_code: nil)
+        # Check if state code is valid
+        state_code_ranges = [('02'..'38'), ['98']]
+        if state_code && !(state_code_ranges[0].include?(state_code) || state_code == '98')
+          raise ArgumentError, 'state code must be in a range of 02 to 38 or 98'
+        end
+
+        PositionalGenerator.new(:string) do |gen|
+          # Generate a state code if not given
+          if state_code
+            gen.lit(state_code, name: :state_code_param)
+          else
+            gen.letter(name: :state_code_param, length: 1, ranges: state_code_ranges)
+          end
+
+          # Construct taxpayer number
+          gen.group(name: :taxpayer_number) do |g_|
+            g_.letter(length: 3, ranges: ['A'..'Z'])
+            g_.letter(length: 1, ranges: [%w[A B C F G H L J P T K]])
+            g_.letter(length: 1, ranges: ['A'..'Z'])
+            g_.int(length: 4, ranges: [0..9999])
+            g_.letter(length: 1, ranges: ['A'..'Z'])
+          end
+
+          gen.int(name: :registration_number, length: 1, ranges: [0..9])
+
+          gen.letter(name: :z_char, length: 1, ranges: [['Z']])
+
+          gen.computed(deps: %i[state_code_param taxpayer_number registration_number]) do |state_code_param, taxpayer_number, registration_number|
+            gst_base = "#{state_code_param}#{taxpayer_number}#{registration_number}"
+            chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'.chars
+            values = gst_base.chars
+            sum = values.map.with_index do |char, index|
+              product = chars.index(char) * (index.odd? ? 2 : 1)
+              (product / chars.length).floor + (product % chars.length)
+            end.reduce(:+)
+
+            checksum = (chars.length - (sum % chars.length)) % chars.length
+            chars[checksum]
+          end
+        end.generate
+      end
+
       private
 
       # Mod11 functionality from https://github.com/badmanski/mod11/blob/master/lib/mod11.rb
@@ -441,7 +545,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
@@ -457,13 +561,11 @@ module Faker
           end
         end
 
-        control_digit = if (sum % 10).zero?
-                          0
-                        else
-                          (sum / 10 + 1) * 10 - sum
-                        end
-
-        control_digit
+        if (sum % 10).zero?
+          0
+        else
+          (sum / 10 + 1) * 10 - sum
+        end
       end
 
       def abn_checksum(abn)
@@ -489,21 +591,26 @@ module Faker
 
       def weight_sum(array, weights)
         sum = 0
-        (0..weights.size - 1).each do |index|
+        (0..(weights.size - 1)).each do |index|
           sum += (array[index] * weights[index])
         end
         sum
       end
 
-      # rubocop:disable Style/AsciiComments
       #
       # For more on Russian tax number algorithm here:
       # https://ru.wikipedia.org/wiki/Идентификационный_номер_налогоплательщика#Вычисление_контрольных_цифр
       #
       # Range of regions:
       # https://ru.wikipedia.org/wiki/Коды_субъектов_Российской_Федерации
+      # region [String] Any region string
+      # @param type [Symbol] Legeal or not, defaults to :legal
       #
-      # rubocop:enable Style/AsciiComments
+      # @return [String]
+      # @example
+      #   Faker::Comnpany.russian_tax_number
+      #   Faker::Comnpany.russian_tax_number(region: 'AZ')
+      #   Faker::Comnpany.russian_tax_number(region: 'AZ', type: false)
       def inn_number(region, type)
         n10 = [2, 4, 10, 3, 5, 9, 4, 6, 8]
         n11 = [7, 2, 4, 10, 3, 5, 9, 4, 6, 8]
@@ -528,6 +635,44 @@ module Faker
           end % 11 % 10
         ).to_s
       end
+
+      def spanish_cif_control_digit(organization_type, code)
+        letters = %w[J A B C D E F G H I]
+
+        control = code.chars.each_with_index.inject(0) do |sum, (value, index)|
+          if (index + 1).even?
+            sum + value.to_i
+          else
+            sum + spanish_b_algorithm(value.to_i)
+          end
+        end
+
+        control = control.to_s[-1].to_i
+        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
+
+      def spanish_b_algorithm(value)
+        result = value.to_i * 2
+
+        return result if result < 10
+
+        result.to_s[0].to_i + result.to_s[1].to_i
+      end
+
+      def calculate_gst_checksum(state_code, taxpayer_number, registration_number)
+        gst_base = "#{state_code}#{taxpayer_number}#{registration_number}"
+        chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'.chars
+        values = gst_base.upcase.chars
+        sum = values.map.with_index do |char, index|
+          product = chars.index(char) * (index.odd? ? 2 : 1)
+          (product / chars.length).floor + (product % chars.length)
+        end.reduce(:+)
+
+        checksum = (chars.length - (sum % chars.length)) % chars.length
+        chars[checksum]
+      end
     end
   end
 end

data/lib/faker/default/crypto.rb

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
 
-require 'digest'
-
 module Faker
   class Crypto < Base
     class << self
+      # Setting the lorem character number lower than the default of
+      # 255 reduces the time complexity of each hash algorithm while
+      # still returning deterministically unique values. See
+      # https://github.com/faker-ruby/faker/pull/2938 for more info.
+      MD5_MIN_NUMBER_OF_CHARACTERS = 25
+      SHA1_MIN_NUMBER_OF_CHARACTERS = 31
+      SHA256_MIN_NUMBER_OF_CHARACTERS = 50
+      SHA512_MIN_NUMBER_OF_CHARACTERS = 100
+
       ##
       # Produces an MD5 hash.
       #
@@ -15,7 +22,7 @@ module Faker
       #
       # @faker.version 1.6.4
       def md5
-        Digest::MD5.hexdigest(Lorem.characters)
+        OpenSSL::Digest::MD5.hexdigest(Lorem.characters(number: MD5_MIN_NUMBER_OF_CHARACTERS))
       end
 
       ##
@@ -28,7 +35,7 @@ module Faker
       #
       # @faker.version 1.6.4
       def sha1
-        Digest::SHA1.hexdigest(Lorem.characters)
+        OpenSSL::Digest::SHA1.hexdigest(Lorem.characters(number: SHA1_MIN_NUMBER_OF_CHARACTERS))
       end
 
       ##
@@ -41,7 +48,20 @@ module Faker
       #
       # @faker.version 1.6.4
       def sha256
-        Digest::SHA256.hexdigest(Lorem.characters)
+        OpenSSL::Digest::SHA256.hexdigest(Lorem.characters(number: SHA256_MIN_NUMBER_OF_CHARACTERS))
+      end
+
+      ##
+      # Produces a SHA512 hash.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Crypto.sha512 #=> "7b9fc82a6642874833d01b74a7b4fae3d15373193b55cfba47327f8f0afdc8d0ea155b58639a03a887009ef997dab8dd8d36767620d430f6e787e5996e26da80"
+      #
+      # @faker.version next
+      def sha512
+        OpenSSL::Digest::SHA512.hexdigest(Lorem.characters(number: SHA512_MIN_NUMBER_OF_CHARACTERS))
       end
     end
   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)