faker 1.9.6 → 2.1.2

data/lib/faker/default/bank.rb

@@ -5,7 +5,7 @@ module Faker
     flexible :bank
 
     class << self
-      def account_number(digits = 10)
+      def account_number(digits: 10)
         output = ''
 
         output += rand.to_s[2..-1] while output.length < digits
@@ -13,7 +13,7 @@ module Faker
         output[0...digits]
       end
 
-      def iban(country_code = 'GB')
+      def iban(country_code: 'GB')
         # Each country has it's 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

data/lib/faker/default/boolean.rb

@@ -3,7 +3,7 @@
 module Faker
   class Boolean < Base
     class << self
-      def boolean(true_ratio = 0.5)
+      def boolean(true_ratio: 0.5)
         (rand < true_ratio)
       end
     end

data/lib/faker/default/cannabis.rb

@@ -37,5 +37,9 @@ module Faker
     def self.buzzword
       fetch('cannabis.buzzwords')
     end
+
+    def self.brand
+      fetch('cannabis.brands')
+    end
   end
 end

data/lib/faker/default/chile_rut.rb

@@ -6,7 +6,7 @@ module Faker
       @last_rut = nil
 
       # Fixed param added for testing a specific RUT and check digit combination.
-      def rut(min_rut = 1, fixed = false)
+      def rut(min_rut: 1, fixed: false)
         @last_rut = fixed ? min_rut : rand_in_range(min_rut, 99_999_999)
       end
 
@@ -34,8 +34,8 @@ module Faker
         dv
       end
 
-      def full_rut(min_rut = 0, fixed = false)
-        "#{rut(min_rut, fixed)}-#{dv}"
+      def full_rut(min_rut: 0, fixed: false)
+        "#{rut(min_rut: min_rut, fixed: fixed)}-#{dv}"
       end
 
       attr_reader :last_rut

data/lib/faker/default/code.rb

@@ -12,26 +12,26 @@ module Faker
 
       # By default generates 10 sign isbn code in format 123456789-X
       # You can pass 13 to generate new 13 sign code
-      def isbn(base = 10)
+      def isbn(base: 10)
         base == 13 ? generate_base13_isbn : generate_base10_isbn
       end
 
       # By default generates 13 sign ean code in format 1234567890123
       # You can pass 8 to generate ean8 code
-      def ean(base = 13)
+      def ean(base: 13)
         base == 8 ? generate_base8_ean : generate_base13_ean
       end
 
       def rut
-        value = Number.number(8)
+        value = Number.number(digits: 8).to_s
         vd = rut_verificator_digit(value)
         value << "-#{vd}"
       end
 
       # By default generates a Singaporean NRIC ID for someone
       # who is born between the age of 18 and 65.
-      def nric(min_age = 18, max_age = 65)
-        birthyear = Date.birthday(min_age, max_age).year
+      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}/)

data/lib/faker/default/commerce.rb

@@ -7,15 +7,15 @@ module Faker
         fetch('color.name')
       end
 
-      def promotion_code(digits = 6)
+      def promotion_code(digits: 6)
         [
           fetch('commerce.promotion_code.adjective'),
           fetch('commerce.promotion_code.noun'),
-          Faker::Number.number(digits)
+          Faker::Number.number(digits: digits)
         ].join
       end
 
-      def department(max = 3, fixed_amount = false)
+      def department(max: 3, fixed_amount: false)
         num = max if fixed_amount
         num ||= 1 + rand(max)
 
@@ -34,7 +34,7 @@ module Faker
         fetch('commerce.product_name.material')
       end
 
-      def price(range = 0..100.0, as_string = false)
+      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('.')

data/lib/faker/default/company.rb

@@ -126,7 +126,7 @@ module Faker
       end
 
       # Get a random Polish register of national economy number. More info https://pl.wikipedia.org/wiki/REGON
-      def polish_register_of_national_economy(length = 9)
+      def polish_register_of_national_economy(length: 9)
         raise ArgumentError, 'Length should be 9 or 14' unless [9, 14].include? length
 
         random_digits = []
@@ -198,7 +198,7 @@ module Faker
       def luhn_algorithm(number)
         multiplications = []
 
-        number.reverse.split(//).each_with_index do |digit, i|
+        number.to_s.reverse.split(//).each_with_index do |digit, i|
           multiplications << if i.even?
                                digit.to_i * 2
                              else

data/lib/faker/default/crypto_coin.rb

@@ -7,15 +7,15 @@ module Faker
       ACRONYM = 1
       URL_LOGO = 2
 
-      def coin_name(coin = coin_array)
+      def coin_name(coin: coin_array)
         coin[COIN_NAME]
       end
 
-      def acronym(coin = coin_array)
+      def acronym(coin: coin_array)
         coin[ACRONYM]
       end
 
-      def url_logo(coin = coin_array)
+      def url_logo(coin: coin_array)
         coin[URL_LOGO]
       end
 
@@ -25,7 +25,12 @@ module Faker
 
       def coin_hash
         coin = coin_array
-        { name: coin_name(coin), acronym: acronym(coin), url_logo: url_logo(coin) }
+
+        {
+          name: coin_name(coin: coin),
+          acronym: acronym(coin: coin),
+          url_logo: url_logo(coin: coin)
+        }
       end
     end
   end

data/lib/faker/default/date.rb

@@ -3,45 +3,45 @@
 module Faker
   class Date < Base
     class << self
-      def between(from, to)
+      def between(from:, to:)
         from = get_date_object(from)
         to   = get_date_object(to)
 
         Faker::Base.rand_in_range(from, to)
       end
 
-      def between_except(from, to, excepted)
+      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)
 
         loop do
-          date = between(from, to)
+          date = between(from: from, to: to)
           break date.to_date if date != excepted
         end
       end
 
-      def forward(days = 365)
+      def forward(days: 365)
         from = ::Date.today + 1
         to   = ::Date.today + days
 
-        between(from, to).to_date
+        between(from: from, to: to).to_date
       end
 
-      def backward(days = 365)
+      def backward(days: 365)
         from = ::Date.today - days
         to   = ::Date.today - 1
 
-        between(from, to).to_date
+        between(from: from, to: to).to_date
       end
 
-      def birthday(min_age = 18, max_age = 65)
+      def birthday(min_age: 18, max_age: 65)
         t = ::Date.today
 
         from = birthday_date(t, max_age)
         to   = birthday_date(t, min_age)
 
-        between(from, to).to_date
+        between(from: from, to: to).to_date
       end
 
       private

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,7 +3,7 @@
 module Faker
   class File < Base
     class << self
-      def dir(segment_count = 3, root = nil, directory_separator = '/')
+      def dir(segment_count: 3, root: nil, directory_separator: '/')
         Array
           .new(segment_count) { Faker::Internet.slug }
           .unshift(root)
@@ -20,8 +20,8 @@ module Faker
         fetch('file.mime_type')
       end
 
-      def file_name(dir = nil, name = nil, ext = nil, directory_separator = '/')
-        dir ||= dir(1)
+      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