faker 1.9.3 → 2.1.2

data/lib/faker/default/demographic.rb

@@ -23,7 +23,7 @@ module Faker
         fetch('demographic.sex')
       end
 
-      def height(unit = :metric)
+      def height(unit: :metric)
         case unit
         when :imperial
           inches = rand_in_range(57, 86)

data/lib/faker/default/device.rb

@@ -4,7 +4,7 @@ module Faker
   class Device < Base
     class << self
       def build_number
-        Faker::Number.between(1, 500)
+        Faker::Number.between(from: 1, to: 500)
       end
 
       def manufacturer
@@ -24,7 +24,7 @@ module Faker
       end
 
       def version
-        Faker::Number.between(1, 1000)
+        Faker::Number.between(from: 1, to: 1000)
       end
     end
   end

data/lib/faker/default/driving_licence.rb

@@ -9,7 +9,7 @@ module Faker
       def british_driving_licence(last_name: Faker::Name.last_name,
                                   initials: Faker::Name.initials,
                                   gender: random_gender,
-                                  date_of_birth: Faker::Date.birthday(18, 65))
+                                  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),
@@ -19,7 +19,7 @@ module Faker
       end
 
       def northern_irish_driving_licence
-        Faker::Number.number(8)
+        Faker::Number.number(digits: 8).to_s
       end
 
       def uk_driving_licence(*args)

data/lib/faker/default/educator.rb

@@ -5,8 +5,6 @@ module Faker
     flexible :educator
 
     class << self
-      extend Gem::Deprecate
-
       def university
         "#{parse('educator.name')} #{fetch('educator.tertiary.type')}"
       end
@@ -16,7 +14,6 @@ module Faker
       end
 
       alias course degree
-      deprecate :course, :course_name, 2018, 10
 
       def subject
         fetch('educator.tertiary.degree.subject')

data/lib/faker/default/file.rb

@@ -3,6 +3,15 @@
 module Faker
   class File < Base
     class << self
+      def dir(segment_count: 3, root: nil, directory_separator: '/')
+        Array
+          .new(segment_count) { Faker::Internet.slug }
+          .unshift(root)
+          .compact
+          .join(directory_separator)
+          .squeeze(directory_separator)
+      end
+
       def extension
         fetch('file.extension')
       end
@@ -11,8 +20,8 @@ module Faker
         fetch('file.mime_type')
       end
 
-      def file_name(dir = nil, name = nil, ext = nil, directory_separator = '/')
-        dir ||= Faker::Internet.slug
+      def file_name(dir: nil, name: nil, ext: nil, directory_separator: '/')
+        dir ||= dir(segment_count: 1)
         name ||= Faker::Lorem.word.downcase
         ext ||= extension
 

data/lib/faker/default/fillmurray.rb

@@ -3,12 +3,12 @@
 module Faker
   class Fillmurray < Base
     class << self
-      def image(grayscale = false, width = 200, height = 200)
+      def image(grayscale: false, width: 200, height: 200)
         raise ArgumentError, 'Width should be a number' unless width.to_s =~ /^\d+$/
         raise ArgumentError, 'Height should be a number' unless height.to_s =~ /^\d+$/
         raise ArgumentError, 'Grayscale should be a boolean' unless [true, false].include?(grayscale)
 
-        grayscale == true ? "https://fillmurray.com/g/#{width}/#{height}" : "https://fillmurray.com/#{width}/#{height}"
+        "https://www.fillmurray.com#{'/g' if grayscale == true}/#{width}/#{height}"
       end
     end
   end

data/lib/faker/default/finance.rb

@@ -26,7 +26,7 @@ module Faker
         template.gsub('L', luhn_digit.to_s)
       end
 
-      def vat_number(country = 'BR')
+      def vat_number(country: 'BR')
         numerify(fetch("finance.vat_number.#{country}"))
       rescue I18n::MissingTranslationData
         raise ArgumentError, "Could not find vat number for #{country}"

data/lib/faker/default/hipster.rb

@@ -8,8 +8,8 @@ module Faker
         random_word =~ /\s/ ? word : random_word
       end
 
-      def words(num = 3, supplemental = false, spaces_allowed = false)
-        resolved_num = resolve(num)
+      def words(number: 3, supplemental: false, spaces_allowed: false)
+        resolved_num = resolve(number)
         word_list = (
           translate('faker.hipster.words') +
           (supplemental ? translate('faker.lorem.words') : [])
@@ -22,36 +22,36 @@ module Faker
         words.each_with_index { |w, i| words[i] = word if w =~ /\s/ }
       end
 
-      def sentence(word_count = 4, supplemental = false, random_words_to_add = 6)
-        words(word_count + rand(random_words_to_add.to_i).to_i, supplemental, true).join(' ').capitalize + '.'
+      def sentence(word_count: 4, supplemental: false, random_words_to_add: 6)
+        words(number: word_count + rand(random_words_to_add.to_i).to_i, supplemental: supplemental, spaces_allowed: true).join(' ').capitalize + '.'
       end
 
-      def sentences(sentence_count = 3, supplemental = false)
+      def sentences(number: 3, supplemental: false)
         [].tap do |sentences|
-          1.upto(resolve(sentence_count)) do
-            sentences << sentence(3, supplemental)
+          1.upto(resolve(number)) do
+            sentences << sentence(word_count: 3, supplemental: supplemental)
           end
         end
       end
 
-      def paragraph(sentence_count = 3, supplemental = false, random_sentences_to_add = 3)
-        sentences(resolve(sentence_count) + rand(random_sentences_to_add.to_i).to_i, supplemental).join(' ')
+      def paragraph(sentence_count: 3, supplemental: false, random_sentences_to_add: 3)
+        sentences(number: resolve(sentence_count) + rand(random_sentences_to_add.to_i).to_i, supplemental: supplemental).join(' ')
       end
 
-      def paragraphs(paragraph_count = 3, supplemental = false)
+      def paragraphs(number: 3, supplemental: false)
         [].tap do |paragraphs|
-          1.upto(resolve(paragraph_count)) do
-            paragraphs << paragraph(3, supplemental)
+          1.upto(resolve(number)) do
+            paragraphs << paragraph(sentence_count: 3, supplemental: supplemental)
           end
         end
       end
 
-      def paragraph_by_chars(chars = 256, supplemental = false)
-        paragraph = paragraph(3, supplemental)
+      def paragraph_by_chars(characters: 256, supplemental: false)
+        paragraph = paragraph(sentence_count: 3, supplemental: supplemental)
 
-        paragraph += ' ' + paragraph(3, supplemental) while paragraph.length < chars
+        paragraph += ' ' + paragraph(sentence_count: 3, supplemental: supplemental) while paragraph.length < characters
 
-        paragraph[0...chars - 1] + '.'
+        paragraph[0...characters - 1] + '.'
       end
     end
   end

data/lib/faker/default/id_number.rb

@@ -12,6 +12,9 @@ module Faker
     ].freeze
     ZA_RACE_DIGIT = '8'
     ZA_CITIZENSHIP_DIGITS = %w[0 1].freeze
+    BRAZILIAN_ID_FORMAT = /(\d{1,2})(\d{3})(\d{3})([\dX])/
+    BRAZILIAN_ID_FROM = 10_000_000
+    BRAZILIAN_ID_TO = 99_999_999
 
     class << self
       def valid
@@ -29,7 +32,7 @@ module Faker
       end
 
       def spanish_citizen_number
-        num = Faker::Number.number(8)
+        num = Faker::Number.number(digits: 8)
         mod = num.to_i % 23
         check = CHECKS[mod]
         "#{num}-#{check}"
@@ -37,7 +40,7 @@ module Faker
 
       def spanish_foreign_citizen_number
         code = 'XYZ'
-        digits = Faker::Number.number(7)
+        digits = Faker::Number.number(digits: 7)
         prefix = code[rand(code.length)]
         prefix_val = 'XYZ'.index(prefix).to_s
         mod = "#{prefix_val}#{digits}".to_i % 23
@@ -48,7 +51,7 @@ module Faker
       def valid_south_african_id_number
         id_number = [
           Faker::Date.birthday.strftime('%y%m%d'),
-          Faker::Number.number(4),
+          Faker::Number.number(digits: 4),
           ZA_CITIZENSHIP_DIGITS.sample(random: Faker::Config.random),
           ZA_RACE_DIGIT
         ].join
@@ -60,14 +63,14 @@ module Faker
 
       def invalid_south_african_id_number
         invalid_date_of_birth = [
-          Faker::Number.number(2),
-          Faker::Number.between(13, 99),
-          Faker::Number.between(32, 99)
+          Faker::Number.number(digits: 2),
+          Faker::Number.between(from: 13, to: 99),
+          Faker::Number.between(from: 32, to: 99)
         ].map(&:to_s).join
 
         id_number = [
           invalid_date_of_birth,
-          Faker::Number.number(4),
+          Faker::Number.number(digits: 4),
           ZA_CITIZENSHIP_DIGITS.sample(random: Faker::Config.random),
           ZA_RACE_DIGIT
         ].join
@@ -76,13 +79,24 @@ module Faker
       end
 
       def brazilian_citizen_number(formatted: false)
-        digits = Faker::Number.leading_zero_number(9) until digits&.match(/(\d)((?!\1)\d)+/)
+        digits = Faker::Number.leading_zero_number(digits: 9) until digits&.match(/(\d)((?!\1)\d)+/)
         first_digit = brazilian_citizen_number_checksum_digit(digits)
         second_digit = brazilian_citizen_number_checksum_digit(digits + first_digit)
         number = [digits, first_digit, second_digit].join
         formatted ? format('%s.%s.%s-%s', *number.scan(/\d{2,3}/).flatten) : number
       end
 
+      alias brazilian_cpf brazilian_citizen_number
+
+      def brazilian_id(formatted: false)
+        digits = Faker::Number.between(to: BRAZILIAN_ID_FROM, from: BRAZILIAN_ID_TO).to_s
+        check_digit = brazilian_id_checksum_digit(digits)
+        number = [digits, check_digit].join
+        formatted ? format('%s.%s.%s-%s', *number.scan(BRAZILIAN_ID_FORMAT).flatten) : number
+      end
+
+      alias brazilian_rg brazilian_id
+
       private
 
       def south_african_id_checksum_digit(id_number)
@@ -104,13 +118,36 @@ module Faker
       end
 
       def brazilian_citizen_number_checksum_digit(digits)
-        digit_sum = digits.chars.each_with_index.inject(0) do |acc, (digit, i)|
+        checksum = brazilian_document_checksum(digits)
+        brazilian_document_digit(checksum)
+      end
+
+      def brazilian_id_checksum_digit(digits)
+        checksum = brazilian_document_checksum(digits)
+        brazilian_document_digit(checksum, id: true)
+      end
+
+      def brazilian_document_checksum(digits)
+        digits.chars.each_with_index.inject(0) do |acc, (digit, i)|
           acc + digit.to_i * (digits.size + 1 - i)
         end * 10
-        remainder = digit_sum % 11
+      end
+
+      def brazilian_document_digit(checksum, id = false)
+        remainder = checksum % 11
+        id ? brazilian_id_digit(remainder) : brazilian_citizen_number_digit(remainder)
+      end
+
+      def brazilian_citizen_number_digit(remainder)
         remainder == 10 ? '0' : remainder.to_s
       end
 
+      def brazilian_id_digit(remainder)
+        subtraction = 11 - remainder.to_i
+        digits = { 10 => 'X', 11 => '0' }
+        digits.include?(subtraction) ? digits[subtraction] : subtraction.to_s
+      end
+
       def _translate(key)
         parse("id_number.#{key}")
       end

data/lib/faker/default/internet.rb

@@ -3,23 +3,23 @@
 module Faker
   class Internet < Base
     class << self
-      def email(name = nil, *separators)
+      def email(name: nil, separators: nil)
         if separators
-          [username(name, separators), domain_name].join('@')
+          [username(specifier: name, separators: separators), domain_name].join('@')
         else
-          [username(name), domain_name].join('@')
+          [username(specifier: name), domain_name].join('@')
         end
       end
 
-      def free_email(name = nil)
-        [username(name), fetch('internet.free_email')].join('@')
+      def free_email(name: nil)
+        [username(specifier: name), fetch('internet.free_email')].join('@')
       end
 
-      def safe_email(name = nil)
-        [username(name), 'example.' + sample(%w[org com net])].join('@')
+      def safe_email(name: nil)
+        [username(specifier: name), 'example.' + sample(%w[org com net])].join('@')
       end
 
-      def username(specifier = nil, separators = %w[. _])
+      def username(specifier: nil, separators: %w[. _])
         with_locale(:en) do
           return shuffle(specifier.scan(/[[:word:]]+/)).join(sample(separators)).downcase if specifier.respond_to?(:scan)
 
@@ -30,7 +30,7 @@ module Faker
             tries = 0 # Don't try forever in case we get something like 1_000_000.
             result = nil
             loop do
-              result = username(nil, separators)
+              result = username(specifier: nil, separators: separators)
               tries += 1
               break unless result.length < specifier && tries < 7
             end
@@ -39,7 +39,7 @@ module Faker
             tries = 0
             result = nil
             loop do
-              result = username(specifier.min, separators)
+              result = username(specifier: specifier.min, separators: separators)
               tries += 1
               break unless !specifier.include?(result.length) && tries < 7
             end
@@ -55,12 +55,13 @@ module Faker
         end
       end
 
-      def password(min_length = 8, max_length = 16, mix_case = true, special_chars = false)
-        temp = Lorem.characters(min_length)
+      def password(min_length: 8, max_length: 16, mix_case: true, special_characters: false)
+        temp = Lorem.characters(number: min_length)
         diff_length = max_length - min_length
+
         if diff_length.positive?
           diff_rand = rand(diff_length + 1)
-          temp += Lorem.characters(diff_rand)
+          temp += Lorem.characters(number: diff_rand)
         end
 
         if mix_case
@@ -69,7 +70,7 @@ module Faker
           end
         end
 
-        if special_chars
+        if special_characters
           chars = %w[! @ # $ % ^ & *]
           rand(1..min_length).times do |i|
             temp[i] = chars[rand(chars.length)]
@@ -79,11 +80,15 @@ module Faker
         temp
       end
 
-      def domain_name
-        with_locale(:en) { [Char.prepare(domain_word), domain_suffix].join('.') }
+      def domain_name(subdomain: false)
+        with_locale(:en) do
+          domain_elements = [Char.prepare(domain_word), domain_suffix]
+          domain_elements.unshift(Char.prepare(domain_word)) if subdomain
+          domain_elements.join('.')
+        end
       end
 
-      def fix_umlauts(string = '')
+      def fix_umlauts(string: '')
         Char.fix_umlauts(string)
       end
 
@@ -95,7 +100,7 @@ module Faker
         fetch('internet.domain_suffix')
       end
 
-      def mac_address(prefix = '')
+      def mac_address(prefix: '')
         prefix_digits = prefix.split(':').map { |d| d.to_i(16) }
         address_digits = Array.new((6 - prefix_digits.size)) { rand(256) }
         (prefix_digits + address_digits).map { |d| format('%02x', d) }.join(':')
@@ -169,25 +174,33 @@ module Faker
         "#{ip_v6_address}/#{rand(1..127)}"
       end
 
-      def url(host = domain_name, path = "/#{username}", scheme = 'http')
+      def url(host: domain_name, path: "/#{username}", scheme: 'http')
         "#{scheme}://#{host}#{path}"
       end
 
-      def slug(words = nil, glue = nil)
+      def slug(words: nil, glue: nil)
         glue ||= sample(%w[- _])
-        (words || Faker::Lorem.words(2).join(' ')).delete(',.').gsub(' ', glue).downcase
+        (words || Faker::Lorem.words(number: 2).join(' ')).delete(',.').gsub(' ', glue).downcase
       end
 
       def device_token
         shuffle(rand(16**64).to_s(16).rjust(64, '0').chars.to_a).join
       end
 
-      def user_agent(vendor = nil)
+      def user_agent(vendor: nil)
         agent_hash = translate('faker.internet.user_agent')
         agents = vendor.respond_to?(:to_sym) && agent_hash[vendor.to_sym] || agent_hash[sample(agent_hash.keys)]
         sample(agents)
       end
 
+      def uuid
+        # borrowed from: https://github.com/ruby/ruby/blob/d48783bb0236db505fe1205d1d9822309de53a36/lib/securerandom.rb#L250
+        ary = Faker::Config.random.bytes(16).unpack('NnnnnN')
+        ary[2] = (ary[2] & 0x0fff) | 0x4000
+        ary[3] = (ary[3] & 0x3fff) | 0x8000
+        '%08x-%04x-%04x-%04x-%04x%08x' % ary # rubocop:disable Style/FormatString
+      end
+
       alias user_name username
     end
   end

data/lib/faker/default/invoice.rb

@@ -6,13 +6,13 @@ module Faker
 
     class << self
       # Generate random amount between values with 2 decimals
-      def amount_between(from = 0, to = 0)
+      def amount_between(from: 0, to: 0)
         Faker::Base.rand_in_range(from, to).round(2)
       end
 
       # International bank slip reference https://en.wikipedia.org/wiki/Creditor_Reference
       # ref is optional so that we can create unit tests
-      def creditor_reference(ref = '')
+      def creditor_reference(ref: '')
         ref = reference if ref.empty?
 
         'RF' + iban_checksum('RF', ref) + ref
@@ -20,7 +20,7 @@ module Faker
 
       # Payment references have some rules in certain countries
       # ref is optional so that we can create unit tests
-      def reference(ref = '')
+      def reference(ref: '')
         pattern = fetch('invoice.reference.pattern')
 
         ref = Base.regexify(/#{pattern}/) if ref.empty?