ffaker 2.21.0 → 2.23.0

data/Rakefile

@@ -23,6 +23,10 @@ module Test
   end
 end
 
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
 #############################################################################
 #
 # Helper functions
@@ -34,7 +38,7 @@ def name
 end
 
 def version
-  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line = File.read("lib/#{name}/version.rb")[/^\s*VERSION\s*=\s*.*/]
   line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
 end
 
@@ -50,10 +54,6 @@ def gem_file
   "#{name}-#{version}.gem"
 end
 
-def replace_header(head, header_name)
-  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{Regexp.last_match(1)}#{send(header_name)}'" }
-end
-
 #############################################################################
 #
 # Standard tasks
@@ -84,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
@@ -102,51 +97,25 @@ task release: :build do
   sh "gem push pkg/#{name}-#{version}.gem"
 end
 
-task build: %i[gemspec reference] do
+task build: %i[validate reference] do
   sh 'mkdir -p pkg'
-  sh "gem build #{gemspec_file}"
-  sh "mv #{gem_file} pkg"
-end
-
-task gemspec: :validate do
-  # read spec file and split out manifest section
-  spec = File.read(gemspec_file)
-  head, manifest, tail = spec.split("  # = MANIFEST =\n")
-
-  # replace name version and date
-  replace_header(head, :name)
-  replace_header(head, :version)
-  replace_header(head, :date)
-
-  # determine file list from git ls-files
-  files = `git ls-files`
-          .split("\n")
-          .sort
-          .reject { |file| file =~ /^\./ }
-          .reject { |file| file =~ /^(rdoc|pkg)/ }
-          .map { |file| "    #{file}" }
-          .join("\n")
-
-  # piece file back together and write
-  manifest = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
-  File.open(gemspec_file, 'w') { |io| io.write(spec) }
-  puts "Updated #{gemspec_file}"
+  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?
-    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
-    exit!
-  end
-  unless Dir['VERSION*'].empty?
-    puts 'A `VERSION` file at root level violates Gem best practices.'
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir. Found:"
+    libfiles.each do |libfile|
+      puts "- #{libfile}"
+    end
+
     exit!
   end
 end
 
 desc 'Creates REFERENCE.md'
 task :reference do
-  system 'ruby ./scripts/reference.rb > REFERENCE.md'
+  system 'ruby -Ilib ./scripts/reference.rb > REFERENCE.md'
 end

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'irb'
+
+require_relative '../lib/ffaker'
+
+IRB.start

data/ffaker.gemspec

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
 
-require_relative 'lib/version'
+require_relative 'lib/ffaker/version'
 
 Gem::Specification.new do |s|
-  s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
-  s.rubygems_version = '1.3.5'
 
   s.name              = 'ffaker'
   s.version           = FFaker::VERSION
-  s.required_ruby_version = '>= 2.5'
+  s.required_ruby_version = '>= 3.0'
 
   s.license = 'MIT'
 
@@ -28,27 +26,15 @@ Gem::Specification.new do |s|
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = %w[README.md LICENSE Changelog.md]
 
-  # = MANIFEST =
-  s.files = %w[
-    Changelog.md
-    Gemfile
-    LICENSE
-    RANDOM.md
-    README.md
-    REFERENCE.md
-    Rakefile
-    ffaker.gemspec
-  ] + Dir['lib/**/*', 'scripts/*']
-  # = MANIFEST =
-
-  s.test_files = Dir['test/**/*']
+  s.files = `git ls-files`
+            .split("\n")
+            .sort
+            .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'
+    '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/address_ua.rb

@@ -49,7 +49,7 @@ module FFaker
       if allow_first_zero
         FFaker.numerify(masks_arr)
       else
-        fetch_sample(masks_arr).sub(/#/) { rand(1..9).to_s }.gsub(/#/) { rand(0..9).to_s }
+        fetch_sample(masks_arr).sub('#') { rand(1..9).to_s }.gsub('#') { rand(0..9).to_s }
       end
     end
   end

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,16 +30,24 @@ 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)
-      'https://orly-appstore.herokuapp.com/generate?'\
-        "title=#{CGI.escape(name)}&"\
-        "top_text=#{CGI.escape(top_text)}&"\
-        "author=#{CGI.escape(book_author)}&"\
-        "image_code=#{Random.rand(1..40)}&"\
+      'https://orly-appstore.herokuapp.com/generate?' \
+        "title=#{CGI.escape(name)}&" \
+        "top_text=#{CGI.escape(top_text)}&" \
+        "author=#{CGI.escape(book_author)}&" \
+        "image_code=#{Random.rand(1..40)}&" \
         "theme=#{Random.rand(1..16)}"
     end
 

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

@@ -5,7 +5,7 @@ module FFaker
     extend ModuleUtils
     extend self
 
-    SUFFIXES = %w[Inc and\ Sons LLC Group].freeze
+    SUFFIXES = ['Inc', 'and Sons', 'LLC', 'Group'].freeze
     POSITION_PREFIXES = %w[Executive Assistant General Associate].freeze
     POSITIONS = %w[President Manager Director Secretary Consultant].freeze
 
@@ -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

@@ -5,13 +5,13 @@ module FFaker
     extend ModuleUtils
     extend self
 
-    SUFFIXES = %w[SA et\ fils SARL Groupe].freeze
+    SUFFIXES = ['SA', 'et fils', 'SARL', 'Groupe'].freeze
 
     def name
       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/data/address_de/state

@@ -11,5 +11,6 @@ Nordrhein-Westfalen
 Rheinland-Pfalz
 Saarland
 Sachsen
+Sachsen-Anhalt
 Schleswig-Holstein
 Thueringen