ffaker 2.22.0 → 2.23.0

data/Rakefile

@@ -23,6 +23,10 @@ module Test
   end
 end
 
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
 #############################################################################
 #
 # Helper functions
@@ -80,14 +84,9 @@ rescue LoadError
   end
 end
 
-#############################################################################
-#
-# Packaging tasks
-#
-#############################################################################
-
+desc 'Packaging tasks'
 task release: :build do
-  unless `git branch` =~ /^\* main$/
+  unless `git branch`.match?(/^\* main$/)
     puts 'You must be on the main branch to release!'
     exit!
   end
@@ -103,6 +102,7 @@ task build: %i[validate reference] do
   sh "gem build #{gemspec_file} --output=pkg/#{gem_file}"
 end
 
+desc 'Validate library files'
 task :validate do
   libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
   unless libfiles.empty?

data/ffaker.gemspec

@@ -29,16 +29,12 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`
             .split("\n")
             .sort
-            .reject { |file| file =~ /^\./ }
-            .reject { |file| file =~ /^(rdoc|pkg)/ }
+            .grep_v(/^\./)
+            .grep_v(/^(rdoc|pkg)/)
 
   s.metadata = {
     'changelog_uri' => 'https://github.com/ffaker/ffaker/blob/main/Changelog.md',
     'documentation_uri' => 'https://github.com/ffaker/ffaker/blob/main/REFERENCE.md',
     'rubygems_mfa_required' => 'true'
   }
-
-  s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'test-unit'
 end

data/lib/ffaker/address.rb

@@ -36,10 +36,10 @@ module FFaker
 
     def city
       case rand(0..3)
-      when 0 then format('%s %s%s', city_prefix, Name.first_name, city_suffix)
-      when 1 then format('%s %s', city_prefix, Name.first_name)
-      when 2 then format('%s%s', Name.first_name, city_suffix)
-      when 3 then format('%s%s', Name.last_name, city_suffix)
+      when 0 then "#{city_prefix} #{Name.first_name}#{city_suffix}"
+      when 1 then "#{city_prefix} #{Name.first_name}"
+      when 2 then "#{Name.first_name}#{city_suffix}"
+      when 3 then "#{Name.last_name}#{city_suffix}"
       end
     end
 

data/lib/ffaker/address_fr.rb

@@ -14,11 +14,9 @@ module FFaker
     POSTAL_CODE_FORMATS = ['#####', '97###', '2A###', '2B###'].freeze
 
     def street_address
-      FFaker.numerify(fetch_sample(NUM)) +
-        fetch_sample(MOD) +
-        fetch_sample(SEP) +
-        fetch_sample(TYPE) + ' ' +
-        FFaker::NameFR.name
+      <<~TEXT.chomp
+        #{FFaker.numerify(fetch_sample(NUM))}#{fetch_sample(MOD)}#{fetch_sample(SEP)}#{fetch_sample(TYPE)} #{FFaker::NameFR.name}
+      TEXT
     end
 
     def postal_code

data/lib/ffaker/address_it.rb

@@ -11,10 +11,7 @@ module FFaker
     POSTAL_CODE_FORMATS = ['#####'].freeze
 
     def street_address
-      FFaker.numerify(fetch_sample(NUM)) +
-        fetch_sample(SEP) +
-        fetch_sample(TYPE) + ' ' +
-        FFaker::NameIT.name
+      "#{FFaker.numerify(fetch_sample(NUM))}#{fetch_sample(SEP)}#{fetch_sample(TYPE)} #{FFaker::NameIT.name}"
     end
 
     def postal_code

data/lib/ffaker/avatar.rb

@@ -7,16 +7,24 @@ module FFaker
 
     SUPPORTED_FORMATS = %w[png jpg bmp].freeze
 
-    def image(slug = nil, size = '300x300', format = 'png', bgset = nil)
+    def image(*args, slug: nil, size: '300x300', format: 'png', bgset: nil)
+      if args.any?
+        warn "Positional arguments for Avatar##{__method__} are deprecated. Please use keyword arguments."
+        slug = args[0]
+        size = args[1] if args.size > 1
+        format = args[2] if args.size > 2
+        bgset = args[3] if args.size > 3
+      end
+
       check_passed_params(size, format, bgset)
       slug ||= FFaker::Lorem.words.join
-      "https://robohash.org/#{slug}.#{format}?size=#{size}#{'&bgset=bg' + bgset.to_s if bgset}"
+      "https://robohash.org/#{slug}.#{format}?size=#{size}#{"&bgset=bg#{bgset}" if bgset}"
     end
 
     private
 
     def check_passed_params(size, format, bgset)
-      invalid_size_error unless size =~ /^[0-9]+x[0-9]+$/
+      invalid_size_error unless size.match?(/^[0-9]+x[0-9]+$/)
       invalid_format_error unless SUPPORTED_FORMATS.include?(format)
       invalid_background_number unless bgset.nil? || (1..2).cover?(bgset.to_i)
     end

data/lib/ffaker/bank.rb

@@ -110,7 +110,7 @@ module FFaker
     end
 
     def check_country_existence(country_code)
-      return if COUNTRIES.keys.include?(country_code.upcase)
+      return if COUNTRIES.key?(country_code.upcase)
 
       raise ArgumentError, "Unexpected country code: '#{country_code}'"
     end

data/lib/ffaker/bank_us.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module FFaker
+  module BankUS
+    extend ModuleUtils
+    extend self
+
+    def account_number(min_digits: 9, max_digits: 17)
+      FFaker.numerify('#' * rand(min_digits..max_digits))
+    end
+
+    def routing_number
+      partial_routing_number = FFaker.numerify('########')
+      ninth_digit = generate_ninth_digit(partial_routing_number)
+
+      "#{partial_routing_number}#{ninth_digit}"
+    end
+
+    private
+
+    def generate_ninth_digit(num_string)
+      # This leverages the `Modules 10, Straight Summation` used for routing_numbers
+      # See http://www.sxlist.com/techref/ecommerce/bank/routingnumber/index.htm
+      # for more details
+      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])) +
+          (9 * (num_array[2] + num_array[5]))
+      ) % 10
+    end
+  end
+end

data/lib/ffaker/book.rb

@@ -30,8 +30,16 @@ module FFaker
       FFaker::Lorem.paragraph(sentence_count)
     end
 
-    def cover(slug = nil, size = '300x300', format = 'png', bgset = nil)
-      FFaker::Avatar.image(slug, size, format, bgset)
+    def cover(*args, slug: nil, size: '300x300', format: 'png', bgset: nil)
+      if args.any?
+        warn "Positional arguments for Book##{__method__} are deprecated. Please use keyword arguments."
+        slug = args[0]
+        size = args[1] if args.size > 1
+        format = args[2] if args.size > 2
+        bgset = args[3] if args.size > 3
+      end
+
+      FFaker::Avatar.image(slug: slug, size: size, format: format, bgset: bgset)
     end
 
     def orly_cover(name = title, book_author = author, top_text = genre)

data/lib/ffaker/cheesy_lingo.rb

@@ -23,11 +23,11 @@ module FFaker
     end
 
     def sentence
-      [
+      "#{[
         fetch_sample(CHEESY_PHRASES).capitalize,
         fetch_sample(CHEESY_PHRASES),
         fetch_sample(CHEESY_PHRASES)
-      ].join + '.'
+      ].join}."
     end
 
     def paragraph(number_of_phrases = 10)

data/lib/ffaker/code.rb

@@ -17,7 +17,7 @@ module FFaker
                       .chars
                       .inject(0) { |sum, digit| sum + digit.to_i }
 
-      npi_checksum = (10 - ((24 + summed_digits) % 10)).to_s.chars.last
+      npi_checksum = (10 - ((24 + summed_digits) % 10)).to_s[-1]
 
       base_npi + npi_checksum
     end

data/lib/ffaker/company.rb

@@ -13,7 +13,7 @@ module FFaker
       case rand(0..2)
       when 0 then "#{Name.last_name} #{suffix}"
       when 1 then "#{Name.last_name}-#{Name.last_name}"
-      when 2 then format('%s, %s and %s', Name.last_name, Name.last_name, Name.last_name)
+      when 2 then "#{Name.last_name}, #{Name.last_name} and #{Name.last_name}"
       end
     end
 

data/lib/ffaker/company_fr.rb

@@ -11,7 +11,7 @@ module FFaker
       case rand(0..2)
       when 0 then "#{NameFR.last_name} #{suffix}"
       when 1 then "#{NameFR.last_name}-#{NameFR.last_name}"
-      when 2 then format('%s, %s and %s', NameFR.last_name, NameFR.last_name, NameFR.last_name)
+      when 2 then "#{NameFR.last_name}, #{NameFR.last_name} and #{NameFR.last_name}"
       end
     end
 

data/lib/ffaker/crypto.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module FFaker
+  module Crypto
+    extend ModuleUtils
+    extend self
+
+    def sha256
+      OpenSSL::Digest::SHA256.hexdigest(Lorem.characters)
+    end
+  end
+end

data/lib/ffaker/date.rb

@@ -27,5 +27,14 @@ module FFaker
 
       between(from, to)
     end
+
+    # Random birthday date (maximum age between 18 and 65)
+    # Keyword arguments: min_age, max_age
+    def birthday(min_age: 18, max_age: 65)
+      from = ::Date.today.prev_year(max_age + 1).next_day
+      to = ::Date.today.prev_year(min_age)
+
+      between(from, to)
+    end
   end
 end

data/lib/ffaker/filesystem.rb

@@ -17,8 +17,18 @@ module FFaker
       Lorem.words.join(directory_separator)
     end
 
-    def file_name(dir = directory, name = Lorem.word.downcase,
-                  ext = extension, directory_separator = File::SEPARATOR)
+    def file_name(
+      *args,
+      dir: directory, name: Lorem.word.downcase, ext: extension, directory_separator: File::SEPARATOR
+    )
+      if args.any?
+        warn "Positional arguments for Filesystem##{__method__} are deprecated. Please use keyword arguments."
+        dir = args[0]
+        name = args[1] if args.size > 1
+        ext = args[2] if args.size > 2
+        directory_separator = args[3] if args.size > 3
+      end
+
       "#{dir}#{directory_separator}#{name}.#{ext}"
     end
   end

data/lib/ffaker/identification_br.rb

@@ -17,11 +17,7 @@ module FFaker
 
     def pretty_cpf
       cpf_numbers = cpf
-      format('%s.%s.%s-%s',
-             cpf_numbers[0..2],
-             cpf_numbers[3..5],
-             cpf_numbers[6..8],
-             cpf_numbers[9..10])
+      "#{cpf_numbers[0..2]}.#{cpf_numbers[3..5]}.#{cpf_numbers[6..8]}-#{cpf_numbers[9..10]}"
     end
 
     def cnpj
@@ -32,12 +28,7 @@ module FFaker
 
     def pretty_cnpj
       cnpj_numbers = cnpj.to_s.rjust(14, '0')
-      format('%s.%s.%s/%s-%s',
-             cnpj_numbers[0..1],
-             cnpj_numbers[2..4],
-             cnpj_numbers[5..7],
-             cnpj_numbers[8..11],
-             cnpj_numbers[12..14])
+      "#{cnpj_numbers[0..1]}.#{cnpj_numbers[2..4]}.#{cnpj_numbers[5..7]}/#{cnpj_numbers[8..11]}-#{cnpj_numbers[12..14]}"
     end
 
     def rg

data/lib/ffaker/identification_ec.rb

@@ -20,7 +20,7 @@ module FFaker
 
     def last_digit(digits)
       mod = digits_sum(digits) % 10
-      10 - mod if mod > 0
+      10 - mod if mod.positive?
     end
 
     def digits_sum(digits)

data/lib/ffaker/identification_es_cl.rb

@@ -20,7 +20,7 @@ module FFaker
     private
 
     def dv(rut)
-      total = rut.to_s.rjust(8, '0').split('').zip(%w[3 2 7 6 5 4 3 2]).sum do |a, b|
+      total = rut.to_s.rjust(8, '0').chars.zip(%w[3 2 7 6 5 4 3 2]).sum do |a, b|
         a.to_i * b.to_i
       end
       (11 - (total % 11)).to_s.gsub('10', 'k').gsub('11', '0')

data/lib/ffaker/identification_kr.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module FFaker
-  module IdentificationKr
+  module IdentificationKR
     extend ModuleUtils
     extend self
 
@@ -11,8 +11,15 @@ module FFaker
       birth = fetch_sample(::Date.new(1970, 1, 1)..::Date.new(1999, 12, 31)).strftime('%y%d%m')
       sex = fetch_sample([1, 2])
       loc = FFaker.numerify("#{fetch_sample(Array('00'..'95'))}###")
-      a, b, c, d, e, f, g, h, i, j, k, l = "#{birth}#{sex}#{loc}".split('').map(&:to_i)
-      checksum = (11 - (((2 * a) + (3 * b) + (4 * c) + (5 * d) + (6 * e) + (7 * f) + (8 * g) + (9 * h) + (2 * i) + (3 * j) + (4 * k) + (5 * l)) % 11)) % 10
+      a, b, c, d, e, f, g, h, i, j, k, l = "#{birth}#{sex}#{loc}".chars.map(&:to_i)
+      checksum = (
+        11 - (
+          (
+            (2 * a) + (3 * b) + (4 * c) + (5 * d) + (6 * e) + (7 * f) + (8 * g) + (9 * h) +
+              (2 * i) + (3 * j) + (4 * k) + (5 * l)
+          ) % 11
+        )
+      ) % 10
       "#{birth}-#{sex}#{loc}#{checksum}"
     end
   end

data/lib/ffaker/identification_pl.rb

@@ -63,14 +63,14 @@ module FFaker
     end
 
     def pesel_checksum(date, serial_number)
-      pesel_digits = "#{date}#{serial_number}".split('').map(&:to_i)
+      pesel_digits = "#{date}#{serial_number}".chars.map(&:to_i)
       a, b, c, d, e, f, g, h, i, j = pesel_digits
       ((a * 9) + (b * 7) + (c * 3) + d + (e * 9) + (f * 7) + (g * 3) + h + (i * 9) + (j * 7)) % 10
     end
 
     def identity_card_checksum(letter_part, number_part)
       a, b, c = letter_part.codepoints.map { |codepoints| codepoints - 55 }
-      d, e, f, g, h = number_part.split('').map(&:to_i)
+      d, e, f, g, h = number_part.chars.map(&:to_i)
       ((a * 7) + (b * 3) + c + (7 * d) + (3 * e) + f + (7 * g) + (3 * h)) % 10
     end
   end

data/lib/ffaker/image.rb

@@ -11,7 +11,18 @@ module FFaker
 
     SUPPORTED_FORMATS = %w[png jpg jpeg gif].freeze
 
-    def url(size = '300x300', format = 'png', bg_color = :random, text_color = :random, text = nil)
+    ## `*args` for old format support, it will be removed with deprecation
+    # rubocop:disable Metrics/ParameterLists
+    def url(*args, size: '300x300', format: 'png', bg_color: :random, text_color: :random, text: nil)
+      if args.any?
+        warn "Positional arguments for Image##{__method__} are deprecated. Please use keyword arguments."
+        size = args[0]
+        format = args[1] if args.size > 1
+        bg_color = args[2] if args.size > 2
+        text_color = args[3] if args.size > 3
+        text = args[4] if args.size > 4
+      end
+
       check_size!(size)
       check_format!(format)
 
@@ -21,20 +32,33 @@ module FFaker
 
       "https://dummyimage.com/#{size}/#{bg_color}/#{text_color}.#{format}?text=#{text}"
     end
+    # rubocop:enable Metrics/ParameterLists
+
+    ## `*args` for old format support, it will be removed with deprecation
+    # rubocop:disable Metrics/ParameterLists
+    def file(*args, size: '300x300', format: 'png', bg_color: :random, text_color: :random, text: nil)
+      if args.any?
+        warn "Positional arguments for Image##{__method__} are deprecated. Please use keyword arguments."
+        size = args[0]
+        format = args[1] if args.size > 1
+        bg_color = args[2] if args.size > 2
+        text_color = args[3] if args.size > 3
+        text = args[4] if args.size > 4
+      end
 
-    def file(size = '300x300', format = 'png', bg_color = :random, text_color = :random, text = nil)
-      uri = URI.parse(url(size, format, bg_color, text_color, text))
+      uri = URI.parse(url(size: size, format: format, bg_color: bg_color, text_color: text_color, text: text))
       file = Tempfile.new('ffaker_image')
       file.binmode
       file << uri.open.read
       file.close
       File.new(file.path)
     end
+    # rubocop:enable Metrics/ParameterLists
 
     private
 
     def check_size!(size)
-      return true if size =~ /\A\d+x\d+\z/
+      return true if size.match?(/\A\d+x\d+\z/)
 
       raise ArgumentError, 'Size should be specified in format 300x300'
     end

data/lib/ffaker/lorem_ja.rb

@@ -30,7 +30,7 @@ module FFaker
     end
 
     def paragraph(sentence_count = 3)
-      sentences(sentence_count).join('、') + '、' + fetch_sample(SENTENCES_END) + '。'
+      "#{sentences(sentence_count).join('、')}、#{fetch_sample(SENTENCES_END)}。"
     end
 
     def paragraphs(count = 3)

data/lib/ffaker/lorem_ru.rb

@@ -50,7 +50,7 @@ module FFaker
       if CAPITAL_CHARS.include?(string[0])
         string
       else
-        CAPITAL_CHARS[CHARS.index(string[0])] + string[1..-1]
+        CAPITAL_CHARS[CHARS.index(string[0])] + string[1..]
       end
     end
   end

data/lib/ffaker/movie.rb

@@ -37,7 +37,7 @@ module FFaker
     end
 
     def maybe_adj_or_adv
-      fetch_sample(ADJ_AND_ADV) + ' ' if rand(0..1) == 1
+      "#{fetch_sample(ADJ_AND_ADV)} " if rand(0..1) == 1
     end
 
     def simple_title

data/lib/ffaker/name_fr.rb

@@ -25,9 +25,10 @@ module FFaker
 
     def name
       case rand(0..9)
-      when 7 then "#{first_name} #{prefix} #{last_name}"
-      when 5 then "#{first_name} #{prefix} #{last_name}"
-      else        "#{first_name} #{last_name}"
+      when 5, 7
+        "#{first_name} #{prefix} #{last_name}"
+      else
+        "#{first_name} #{last_name}"
       end
     end
   end

data/lib/ffaker/number.rb

@@ -15,6 +15,10 @@ module FFaker
       FFaker.numerify("#{whole_part_pattern}.#{fractional_part_pattern}").to_f
     end
 
+    def between(from: 1.00, to: 5000.00)
+      fetch_sample(from..to)
+    end
+
     private
 
     def generate_pattern(digits)

data/lib/ffaker/phone_number_de.rb

@@ -7,15 +7,15 @@ module FFaker
 
     # Mobile prefixes are in the 015x, 016x, 017x ranges
     def mobile_prefix(leading_zero = true)
-      mobile_prefix = '1' + rand(5..7).to_s + rand(0..9).to_s
-      mobile_prefix = '0' + mobile_prefix if leading_zero
+      mobile_prefix = "1#{rand(5..7)}#{rand(0..9)}"
+      mobile_prefix = "0#{mobile_prefix}" if leading_zero
       mobile_prefix
     end
 
     # Region prefixes are in range 02..09 with length of 3 to 5 digits
     def region_prefix(leading_zero = true)
       region_prefix = rand(2..9).to_s + FFaker.numerify('#' * rand(1..3)).to_s
-      region_prefix = '0' + region_prefix if leading_zero
+      region_prefix = "0#{region_prefix}" if leading_zero
       region_prefix
     end
 

data/lib/ffaker/skill.rb

@@ -14,7 +14,7 @@ module FFaker
     end
 
     def specialty
-      format('%s %s', fetch_sample(SPECIALTY_START), fetch_sample(SPECIALTY_END))
+      "#{fetch_sample(SPECIALTY_START)} #{fetch_sample(SPECIALTY_END)}"
     end
 
     def specialties(num = 3)

data/lib/ffaker/ssn.rb

@@ -15,8 +15,10 @@ module FFaker
       second_group = rand(1..99)
       third_group  = rand(1..9999)
 
-      group_numbers = [first_group, second_group, third_group]
-      format('%.3d-%.2d-%.4d', *group_numbers)
+      format(
+        '%<first_group>.3d-%<second_group>.2d-%<third_group>.4d',
+        first_group: first_group, second_group: second_group, third_group: third_group
+      )
     end
   end
 end

data/lib/ffaker/string.rb

@@ -21,7 +21,7 @@ module FFaker
       @last_token = nil
 
       # Drop surrounding /'s and split into characters
-      tokens = exp.inspect[1...-1].split('')
+      tokens = exp.inspect[1...-1].chars
       result << process_token(tokens) until tokens.empty?
 
       result

data/lib/ffaker/utils/module_utils.rb

@@ -13,7 +13,7 @@ module FFaker
     end
 
     def const_missing(const_name)
-      if const_name =~ /[a-z]/ # Not a constant, probably a class/module name.
+      if const_name.match?(/[a-z]/) # Not a constant, probably a class/module name.
         super const_name
       else
         mod_name = ancestors.first.to_s.split('::').last
@@ -40,7 +40,7 @@ module FFaker
     def luhn_check(number)
       multiplications = []
 
-      number.split('').each_with_index do |digit, i|
+      number.chars.each_with_index do |digit, i|
         multiplications << i.even? ? digit.to_i * 2 : digit.to_i
       end
 

data/lib/ffaker/utils/unique_utils.rb

@@ -16,7 +16,7 @@ module FFaker
       end
 
       def clear
-        instances.values.each(&:clear)
+        instances.each_value(&:clear)
         instances.clear
       end
     end
@@ -32,19 +32,23 @@ module FFaker
 
     private
 
-    def method_missing(name, *arguments)
+    def method_missing(name, *args, **kwargs)
       @max_retries.times do
-        result = @generator.public_send(name, *arguments)
+        result = @generator.public_send(name, *args, **kwargs)
 
-        next if previous_results[[name, arguments]].include?(result)
+        next if previous_results[[name, args, kwargs]].include?(result)
 
-        previous_results[[name, arguments]] << result
+        previous_results[[name, args, kwargs]] << result
         return result
       end
 
       raise RetryLimitExceeded, "Retry limit exceeded for #{name}"
     end
 
+    def respond_to_missing?(name, *args)
+      @generator.respond_to?(name, *args) || super
+    end
+
     def previous_results
       @previous_results ||= Hash.new { |hash, key| hash[key] = Set.new }
     end

data/lib/ffaker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FFaker
-  VERSION = '2.22.0'
+  VERSION = '2.23.0'
 end