faker 2.20.0 → 3.2.1

data/lib/faker/default/address.rb

@@ -18,11 +18,7 @@ module Faker
       #     #=> "Northfort, California"
       #
       # @faker.version 0.3.0
-      def city(legacy_options = NOT_GIVEN, options: {})
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :options if legacy_options != NOT_GIVEN
-        end
-
+      def city(options: {})
         parse(options[:with_state] ? 'address.city_with_state' : 'address.city')
       end
 
@@ -49,11 +45,7 @@ module Faker
       #   Faker::Address.street_address #=> "282 Kevin Brook"
       #
       # @faker.version 0.3.0
-      def street_address(legacy_include_secondary = NOT_GIVEN, include_secondary: false)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :include_secondary if legacy_include_secondary != NOT_GIVEN
-        end
-
+      def street_address(include_secondary: false)
         numerify(parse('address.street_address') + (include_secondary ? " #{secondary_address}" : ''))
       end
 
@@ -121,11 +113,7 @@ module Faker
       #   Faker::Address.zip_code(state_abbreviation: 'CO') #=> "80011"
       #
       # @faker.version 0.3.0
-      def zip_code(legacy_state_abbreviation = NOT_GIVEN, state_abbreviation: '')
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :state_abbreviation if legacy_state_abbreviation != NOT_GIVEN
-        end
-
+      def zip_code(state_abbreviation: '')
         if state_abbreviation.empty?
           letterified_string = letterify(fetch('address.postcode'))
           return numerify(letterified_string, leading_zero: true)
@@ -242,11 +230,7 @@ module Faker
       #   Faker::Address.country_by_code(code: 'NL') #=> "Netherlands"
       #
       # @faker.version 1.9.2
-      def country_by_code(legacy_code = NOT_GIVEN, code: 'US')
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :code if legacy_code != NOT_GIVEN
-        end
-
+      def country_by_code(code: 'US')
         fetch("address.country_by_code.#{code}")
       end
 
@@ -260,11 +244,7 @@ module Faker
       #   Faker::Address.country_name_to_code(name: 'united_states') #=> "US"
       #
       # @faker.version 1.9.2
-      def country_name_to_code(legacy_name = NOT_GIVEN, name: 'united_states')
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :name if legacy_name != NOT_GIVEN
-        end
-
+      def country_name_to_code(name: 'united_states')
         fetch("address.country_by_name.#{name}")
       end
 

data/lib/faker/default/alphanumeric.rb

@@ -19,10 +19,7 @@ module Faker
       #   Faker::Alphanumeric.alpha(number: 10) #=> "zlvubkrwga"
       #
       # @faker.version 1.9.2
-      def alpha(legacy_number = NOT_GIVEN, number: 32)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :number if legacy_number != NOT_GIVEN
-        end
+      def alpha(number: 32)
         char_count = resolve(number)
         return '' if char_count.to_i < 1
 
@@ -46,10 +43,7 @@ module Faker
       #   Faker::Alphanumeric.alphanumeric(number: 10, min_alpha: 3, min_numeric: 3) #=> "3yfq2phx8b"
       #
       # @faker.version 2.1.3
-      def alphanumeric(legacy_number = NOT_GIVEN, number: 32, min_alpha: 0, min_numeric: 0)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :number if legacy_number != NOT_GIVEN
-        end
+      def alphanumeric(number: 32, min_alpha: 0, min_numeric: 0)
         char_count = resolve(number)
         return '' if char_count.to_i < 1
         raise ArgumentError, 'min_alpha must be greater than or equal to 0' if min_alpha&.negative?

data/lib/faker/default/app.rb

@@ -42,8 +42,6 @@ module Faker
         parse('app.author')
       end
 
-      # rubocop:disable Metrics/ParameterLists
-
       ##
       # Produces a String representing a semantic version identifier.
       #
@@ -62,16 +60,9 @@ module Faker
       #   Faker::App.semantic_version(patch: 5..6) #=> "7.2.6"
       #
       # @faker.version 1.4.3
-      def semantic_version(legacy_major = NOT_GIVEN, legacy_minor = NOT_GIVEN, legacy_patch = NOT_GIVEN, major: 0..9, minor: 0..9, patch: 1..9)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :major if legacy_major != NOT_GIVEN
-          keywords << :minor if legacy_minor != NOT_GIVEN
-          keywords << :patch if legacy_patch != NOT_GIVEN
-        end
-
+      def semantic_version(major: 0..9, minor: 0..9, patch: 1..9)
         [major, minor, patch].map { |chunk| sample(Array(chunk)) }.join('.')
       end
-      # rubocop:enable Metrics/ParameterLists
     end
   end
 end

data/lib/faker/default/avatar.rb

@@ -6,8 +6,6 @@ module Faker
       # @private
       SUPPORTED_FORMATS = %w[png jpg bmp].freeze
 
-      # rubocop:disable Metrics/ParameterLists
-
       ##
       # Produces a URL for an avatar from robohash.org
       #
@@ -38,15 +36,7 @@ module Faker
       #     #=> "https://robohash.org/my-own-slug.bmp?size=50x50&set=set1&bgset=bg1"
       #
       # @faker.version 1.4.3
-      def image(legacy_slug = NOT_GIVEN, legacy_size = NOT_GIVEN, legacy_format = NOT_GIVEN, legacy_set = NOT_GIVEN, legacy_bgset = NOT_GIVEN, slug: nil, size: '300x300', format: 'png', set: 'set1', bgset: nil)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :slug if legacy_slug != NOT_GIVEN
-          keywords << :size if legacy_size != NOT_GIVEN
-          keywords << :format if legacy_format != NOT_GIVEN
-          keywords << :set if legacy_set != NOT_GIVEN
-          keywords << :bgset if legacy_bgset != NOT_GIVEN
-        end
-
+      def image(slug: nil, size: '300x300', format: 'png', set: 'set1', bgset: nil)
         raise ArgumentError, 'Size should be specified in format 300x300' unless size =~ /^[0-9]+x[0-9]+$/
         raise ArgumentError, "Supported formats are #{SUPPORTED_FORMATS.join(', ')}" unless SUPPORTED_FORMATS.include?(format)
 
@@ -54,7 +44,6 @@ module Faker
         bgset_query = "&bgset=#{bgset}" if bgset
         "https://robohash.org/#{slug}.#{format}?size=#{size}&set=#{set}#{bgset_query}"
       end
-      # rubocop:enable Metrics/ParameterLists
     end
   end
 end

data/lib/faker/default/bank.rb

@@ -16,14 +16,10 @@ module Faker
       #   Faker::Bank.account_number(digits: 13) #=> 673858237902
       #
       # @faker.version 1.9.1
-      def account_number(legacy_digits = NOT_GIVEN, digits: 10)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :digits if legacy_digits != NOT_GIVEN
-        end
-
+      def account_number(digits: 10)
         output = ''
 
-        output += rand.to_s[2..-1] while output.length < digits
+        output += rand.to_s[2..] while output.length < digits
 
         output[0...digits]
       end
@@ -40,14 +36,10 @@ module Faker
       #   Faker::Bank.iban(country_code: nil) #=> "DE45186738071857270067"
       #
       # @faker.version 1.7.0
-      def iban(legacy_country_code = NOT_GIVEN, country_code: 'GB')
+      def iban(country_code: 'GB')
         # Each country has its 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
-
         country_code ||= iban_country_code
 
         begin
@@ -145,7 +137,7 @@ module Faker
       private
 
       def checksum(num_string)
-        num_array = num_string.split('').map(&:to_i)
+        num_array = num_string.chars.map(&:to_i)
         (
           7 * (num_array[0] + num_array[3] + num_array[6]) +
             3 * (num_array[1] + num_array[4] + num_array[7]) +
@@ -166,15 +158,15 @@ module Faker
       end
 
       # Calculates the mandatory checksum in 3rd and 4th characters in IBAN format
-      # source: https://en.wikipedia.org/wiki/International_Bank_Account_Number#Validating_the_IBAN
+      # source: https://en.wikipedia.org/wiki/International_Bank_Account_Number#Generating_IBAN_check_digits
       def iban_checksum(country_code, account)
         # Converts letters to numbers according the iban rules, A=10..Z=35
         account_to_number = "#{account}#{country_code}00".upcase.chars.map do |d|
           d =~ /[A-Z]/ ? (d.ord - 55).to_s : d
         end.join.to_i
 
-        # This is answer to (iban_to_num + checksum) % 97 == 1
-        checksum = (1 - account_to_number) % 97
+        # This is the correct answer to (iban_to_num + checksum) % 97 == 1
+        checksum = 98 - (account_to_number % 97)
 
         # Use leftpad to make the size always to 2
         checksum.to_s.rjust(2, '0')
@@ -194,8 +186,8 @@ module Faker
 
       def compile_fraction(routing_num)
         prefix = (1..50).to_a.map(&:to_s).sample
-        numerator = routing_num.split('')[5..8].join.to_i.to_s
-        denominator = routing_num.split('')[0..4].join.to_i.to_s
+        numerator = routing_num.chars[5..8].join.to_i.to_s
+        denominator = routing_num.chars[0..4].join.to_i.to_s
         "#{prefix}-#{numerator}/#{denominator}"
       end
 

data/lib/faker/default/boolean.rb

@@ -15,10 +15,7 @@ module Faker
       #   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
+      def boolean(true_ratio: 0.5)
         (rand < true_ratio)
       end
     end

data/lib/faker/default/chile_rut.rb

@@ -8,23 +8,19 @@ module Faker
       ##
       # Produces a random Chilean RUT (Rol Unico Tributario, ID with 8 digits).
       #
-      # @param min_rut [Integer] Specifies the minimum value of the rut.
-      # @param fixed [Boolean] Determines if the rut is fixed (returns the min_rut value).
+      # @param min_rut [Integer] Specifies the minimum value of the RUT.
+      # @param max_rut [Integer] Specifies the maximum value of the RUT.
+      # @param fixed [Boolean] Determines if the RUT is fixed (returns the min_rut value).
       # @return [Number]
       #
       # @example
       #   Faker::ChileRut.rut #=> 11235813
-      #   Faker::ChileRut.rut(min_rut: 20890156) #=> 31853211
-      #   Faker::ChileRut.rut(min_rut: 20890156, fixed: true) #=> 20890156
+      #   Faker::ChileRut.rut(min_rut: 10_000_000, max_rut: 30_000_000) #=> 21853211
+      #   Faker::ChileRut.rut(min_rut: 20_890_156, fixed: true) #=> 20890156
       #
-      # @faker.version 1.9.2
-      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)
+      # @faker.version next
+      def rut(min_rut: 1, max_rut: 99_999_999, fixed: false)
+        @last_rut = fixed ? min_rut : rand_in_range(min_rut, max_rut)
       end
 
       ##
@@ -37,7 +33,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def dv
-        split_reversed_rut = @last_rut.to_s.reverse.split('')
+        split_reversed_rut = @last_rut.to_s.reverse.chars
         seq = [2, 3, 4, 5, 6, 7]
         i = 0
         digit_sum = split_reversed_rut.reduce(0) do |sum, n|
@@ -73,26 +69,30 @@ module Faker
       ##
       # Produces a random Chilean RUT (Rol Unico Tributario, ID with 8 digits) with a dv (digito verificador, check-digit).
       #
-      # @param min_rut [Integer] Specifies the minimum value of the rut.
-      # @param fixed [Boolean] Determines if the rut is fixed (returns the min_rut value).
+      # @param min_rut [Integer] Specifies the minimum value of the RUT.
+      # @param max_rut [Integer] Specifies the maximum value of the RUT.
+      # @param fixed [Boolean] Determines if the RUT is fixed (returns the min_rut value).
       # @return [String]
       #
       # @example
       #   Faker::ChileRut.full_rut #=> "30686957-4"
-      #   Faker::ChileRut.full_rut(min_rut: 20890156) #=> "30686957-4"
-      #   Faker::ChileRut.full_rut(min_rut: 30686957, fixed: true) #=> "30686957-4"
+      #   Faker::ChileRut.full_rut(min_rut: 10_000_000, max_rut: 30_000_000) #=> "20686957-4"
+      #   Faker::ChileRut.full_rut(min_rut: 30_686_957, fixed: true) #=> "30686957-4"
       #
-      # @faker.version 1.9.2
-      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}"
+      # @faker.version next
+      def full_rut(min_rut: 1, max_rut: 99_999_999, fixed: false, formatted: false)
+        this_rut = rut(min_rut: min_rut, max_rut: max_rut, fixed: fixed)
+        this_rut = format_rut(this_rut) if formatted
+        "#{this_rut}-#{dv}"
       end
 
       attr_reader :last_rut
+
+      private
+
+      def format_rut(rut)
+        rut.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1.').reverse
+      end
     end
   end
 end

data/lib/faker/default/code.rb

@@ -5,7 +5,7 @@ module Faker
     flexible :code
     class << self
       ##
-      # Produces a random NPI (National Provider Identifer) code.
+      # Produces a random NPI (National Provider Identifier) code.
       #
       # @return [String]
       #
@@ -29,11 +29,7 @@ module Faker
       #   Faker::Code.isbn #=> "170366802-2"
       #
       # @faker.version 2.2.0
-      def isbn(legacy_base = NOT_GIVEN, base: 10)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :base if legacy_base != NOT_GIVEN
-        end
-
+      def isbn(base: 10)
         case base
         when 10 then generate_base10_isbn
         when 13 then generate_base13_isbn
@@ -53,11 +49,7 @@ module Faker
       #   Faker::Code.ean #=> "9941880131907"
       #
       # @faker.version 2.2.0
-      def ean(legacy_base = NOT_GIVEN, base: 13)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :base if legacy_base != NOT_GIVEN
-        end
-
+      def ean(base: 13)
         case base
         when 8 then generate_base8_ean
         when 13 then generate_base13_ean
@@ -99,18 +91,25 @@ module Faker
       #   Faker::Code.nric #=> "S6372958B"
       #
       # @faker.version 2.2.0
-      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
-
+      def nric(min_age: 18, max_age: 65)
         birthyear = Date.birthday(min_age: min_age, max_age: max_age).year
-        prefix = birthyear < 2000 ? 'S' : 'T'
-        values = birthyear.to_s[-2..-1]
-        values << regexify(/\d{5}/)
-        check_alpha = generate_nric_check_alphabet(values, prefix)
-        "#{prefix}#{values}#{check_alpha}"
+
+        generate(:string) do |g|
+          g.computed(name: :prefix) do
+            if birthyear < 2000
+              'S'
+            else
+              'T'
+            end
+          end
+          g.computed(name: :yy) do
+            birthyear.to_s[-2..]
+          end
+          g.int(name: :values, length: 5)
+          g.computed(name: :check, deps: %i[prefix yy values]) do |prefix, yy, values|
+            generate_nric_check_alphabet("#{yy}#{values}", prefix)
+          end
+        end
       end
 
       ##
@@ -206,50 +205,80 @@ module Faker
         str[len - 1] = (10 - (sum % 10)) % 10
 
         # Output the IMEI value.
-        str.join('')
+        str.join
       end
 
       def generate_base10_isbn
-        values = regexify(/\d{9}/)
-        remainder = sum(values) { |value, index| (index + 1) * value.to_i } % 11
-        values << "-#{remainder == 10 ? 'X' : remainder}"
+        generate(:string) do |g|
+          g.int(name: :values, length: 9)
+          g.lit('-')
+          g.computed(name: :checksum, deps: [:values]) do |values|
+            remainder = sum(values.to_s) { |value, offset| (offset + 1) * value.to_i } % 11
+            if remainder == 10
+              'X'
+            else
+              remainder.to_s
+            end
+          end
+        end
       end
 
       def generate_base13_isbn
-        values = regexify(/\d{12}/)
-        remainder = sum(values) { |value, index| index.even? ? value.to_i : value.to_i * 3 } % 10
-        values << "-#{(10 - remainder) % 10}"
+        generate(:string) do |g|
+          g.int(name: :values, length: 12)
+          g.lit('-')
+          g.computed(name: :checksum, deps: [:values]) do |values|
+            remainder = sum(values.to_s) { |value, offset| offset.even? ? value.to_i : value.to_i * 3 } % 10
+            (10 - remainder) % 10
+          end
+        end
       end
 
       def sum(values)
-        values.split(//).each_with_index.inject(0) do |sum, (value, index)|
+        values.chars.each_with_index.inject(0) do |sum, (value, index)|
           sum + yield(value, index)
         end
       end
 
       def generate_base8_ean
-        values = regexify(/\d{7}/)
-        check_digit = 10 - values.split(//).each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT8[i] } % 10
-        values << (check_digit == 10 ? 0 : check_digit).to_s
+        generate(:string) do |g|
+          g.int(name: :values, length: 7)
+          g.computed(name: :checksum, deps: [:values]) do |values|
+            check_digit = 10 - values.to_s.chars.each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT8[i] } % 10
+            if check_digit == 10
+              0
+            else
+              check_digit
+            end
+          end
+        end
       end
 
       def generate_base13_ean
-        values = regexify(/\d{12}/)
-        check_digit = 10 - values.split(//).each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT13[i] } % 10
-        values << (check_digit == 10 ? 0 : check_digit).to_s
+        generate(:string) do |g|
+          g.int(name: :values, length: 12)
+          g.computed(name: :checksum, deps: [:values]) do |values|
+            check_digit = 10 - values.to_s.chars.each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT13[i] } % 10
+            if check_digit == 10
+              0
+            else
+              check_digit
+            end
+          end
+        end
       end
 
       EAN_CHECK_DIGIT8 = [3, 1, 3, 1, 3, 1, 3].freeze
       EAN_CHECK_DIGIT13 = [1, 3, 1, 3, 1, 3, 1, 3, 1, 3, 1, 3].freeze
 
       def rut_verificator_digit(rut)
-        total = rut.to_s.rjust(8, '0').split(//).zip(%w[3 2 7 6 5 4 3 2]).collect { |a, b| a.to_i * b.to_i }.inject(:+)
-        (11 - total % 11).to_s.gsub(/10/, 'k').gsub(/11/, '0')
+        total = rut.to_s.rjust(8, '0').chars.zip(%w[3 2 7 6 5 4 3 2]).collect { |a, b| a.to_i * b.to_i }.inject(:+)
+        (11 - total % 11).to_s.gsub('10', 'k').gsub('11', '0')
       end
 
       def generate_nric_check_alphabet(values, prefix)
         weight = %w[2 7 6 5 4 3 2]
-        total = values.split(//).zip(weight).collect { |a, b| a.to_i * b.to_i }.inject(:+)
+        total = values.chars.zip(weight).collect { |a, b| a.to_i * b.to_i }.inject(:+)
         total += 4 if prefix == 'T'
         %w[A B C D E F G H I Z J][10 - total % 11]
       end

data/lib/faker/default/color.rb

@@ -3,17 +3,34 @@
 module Faker
   class Color < Base
     class << self
+      LIGHTNESS_LOOKUP = {
+        light: 0.8,
+        dark: 0.2
+      }.freeze
       ##
       # Produces a hex color code.
+      # Clients are able to specify the hue, saturation, or lightness of the required color.
+      # Alternatively a client can simply specify that they need a light or dark color.
+      #
+      # @param args [Hash, Symbol] Allows the client to specify what color should be return
       #
       # @return [String]
       #
       # @example
       #   Faker::Color.hex_color #=> "#31a785"
+      # @example
+      #   Faker::Color.hex_color(hue: 118, saturation: 1, lightness: 0.53) #=> "#048700"
+      # @example
+      #   Faker::Color.hex_color(:light) #=> "#FFEE99"
+      # @example
+      #   Faker::Color.hex_color(:dark) #=> "#665500"
       #
-      # @faker.version 1.5.0
-      def hex_color
-        format('#%06x', (rand * 0xffffff))
+      # @faker.version next
+      def hex_color(args = nil)
+        hsl_hash = {}
+        hsl_hash = { lightness: LIGHTNESS_LOOKUP[args] } if %i[dark light].include?(args)
+        hsl_hash = args if args.is_a?(Hash)
+        hsl_to_hex(hsl_color(**hsl_hash))
       end
 
       ##
@@ -51,14 +68,28 @@ module Faker
       # Produces an array of floats representing an HSL color.
       # The array is in the form of `[hue, saturation, lightness]`.
       #
+      # @param hue [FLoat] Optional value to use for hue
+      # @param saturation [Float] Optional value to use for saturation
+      # @param lightness [Float] Optional value to use for lightness
       # @return [Array(Float, Float, Float)]
       #
       # @example
       #   Faker::Color.hsl_color #=> [69.87, 0.66, 0.3]
+      # @example
+      #   Faker::Color.hsl_color(hue: 70, saturation: 0.5, lightness: 0.8) #=> [70, 0.5, 0.8]
+      # @example
+      #   Faker::Color.hsl_color(hue: 70) #=> [70, 0.66, 0.6]
+      # @example
+      #   Faker::Color.hsl_color(saturation: 0.2) #=> [54, 0.2, 0.3]
+      # @example
+      #   Faker::Color.hsl_color(lightness: 0.6) #=> [69.87, 0.66, 0.6]
       #
-      # @faker.version 1.5.0
-      def hsl_color
-        [sample((0..360).to_a), rand.round(2), rand.round(2)]
+      # @faker.version next
+      def hsl_color(hue: nil, saturation: nil, lightness: nil)
+        valid_hue = hue || sample((0..360).to_a)
+        valid_saturation = saturation&.clamp(0, 1) || rand.round(2)
+        valid_lightness = lightness&.clamp(0, 1) || rand.round(2)
+        [valid_hue, valid_saturation, valid_lightness]
       end
 
       ##
@@ -74,6 +105,46 @@ module Faker
       def hsla_color
         hsl_color << rand.round(1)
       end
+
+      private
+
+      ##
+      # Produces a hex code representation of an HSL color
+      #
+      # @param a_hsl_color [Array(Float, Float, Float)] The array that represents the HSL color
+      #
+      # @return [String]
+      #
+      # @example
+      #   hsl_to_hex([50, 100,80]) #=> #FFEE99
+      #
+      # @see https://en.wikipedia.org/wiki/HSL_and_HSV#HSL_to_RGB
+      # @see https://github.com/jpmckinney/color-generator/blob/master/lib/color-generator.rb
+      #
+      def hsl_to_hex(a_hsl_color)
+        h, s, l = a_hsl_color
+        c = (1 - (2 * l - 1).abs) * s
+        h_prime = h / 60
+        x = c * (1 - (h_prime % 2 - 1).abs)
+        m = l - 0.5 * c
+
+        rgb = case h_prime.to_i
+              when 0 # 0 <= H' < 1
+                [c, x, 0]
+              when 1 # 1 <= H' < 2
+                [x, c, 0]
+              when 2 # 2 <= H' < 3
+                [0, c, x]
+              when 3 # 3 <= H' < 4
+                [0, x, c]
+              when 4 # 4 <= H' < 5
+                [x, 0, c]
+              else # 5 <= H' < 6
+                [c, 0, x]
+              end.map { |value| ((value + m) * 255).round }
+
+        format('#%02x%02x%02x', rgb[0], rgb[1], rgb[2])
+      end
     end
   end
 end

data/lib/faker/default/commerce.rb

@@ -27,11 +27,7 @@ module Faker
       #   Faker::Commerce.promotion_code(digits: 2) #=> "AmazingPrice57"
       #
       # @faker.version 1.7.0
-      def promotion_code(legacy_digits = NOT_GIVEN, digits: 6)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :digits if legacy_digits != NOT_GIVEN
-        end
-
+      def promotion_code(digits: 6)
         [
           fetch('commerce.promotion_code.adjective'),
           fetch('commerce.promotion_code.noun'),
@@ -52,12 +48,7 @@ module Faker
       #   Faker::Commerce.department(max: 2, fixed_amount: true) #=> "Books & Tools"
       #
       # @faker.version 1.2.0
-      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
-
+      def department(max: 3, fixed_amount: false)
         num = max if fixed_amount
         num ||= 1 + rand(max)
 
@@ -112,12 +103,7 @@ module Faker
       #   Faker::Commerce.price(range: 0..10.0, as_string: true) #=> "2.18"
       #
       # @faker.version 1.2.0
-      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
-
+      def price(range: 0..100.0, as_string: false)
         price = (rand(range) * 100).floor / 100.0
         if as_string
           price_parts = price.to_s.split('.')