faker 2.13.0 → 3.8.0

data/lib/faker/default/bank.rb

@@ -16,36 +16,27 @@ 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
-
-        output = ''
-
-        output += rand.to_s[2..-1] while output.length < digits
-
-        output[0...digits]
+      def account_number(digits: 10)
+        Array.new(digits) { rand(10) }.join
       end
 
       ##
       # Produces a bank iban number.
       #
-      # @param country_code [String] Specifies what country prefix is used to generate the iban code.
+      # @param country_code [String, nil] Specifies what country prefix is used to generate the iban code. Providing `nil` will use a random country.
       # @return [String]
       #
       # @example
       #   Faker::Bank.iban #=> "GB76DZJM33188515981979"
       #   Faker::Bank.iban(country_code: "be") #=> "BE6375388567752043"
+      #   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
           pattern = fetch("bank.iban_details.#{country_code.downcase}.bban_pattern")
@@ -60,6 +51,19 @@ module Faker
         country_code.upcase + iban_checksum(country_code, account) + account
       end
 
+      ##
+      # Produces the ISO 3166 code of a country that uses the IBAN system.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.iban_country_code #=> "CH"
+      #
+      # @faker.version next
+      def iban_country_code
+        sample(translate('faker.bank.iban_details').keys).to_s.upcase
+      end
+
       ##
       # Produces a bank name.
       #
@@ -129,7 +133,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]) +
@@ -140,27 +144,25 @@ module Faker
       def compile_routing_number
         digit_one_two = %w[00 01 02 03 04 05 06 07 08 09 10 11 12]
         ((21..32).to_a + (61..72).to_a + [80]).each { |x| digit_one_two << x.to_s }
-        routing_num = digit_one_two.sample + rand_numstring + rand_numstring + rand_numstring + rand_numstring + rand_numstring + rand_numstring + rand_numstring
-        routing_num
+        digit_one_two.sample + rand_numstring + rand_numstring + rand_numstring + rand_numstring + rand_numstring + rand_numstring + rand_numstring
       end
 
       def compile_bsb_number
         digit_one_two = %w[01 03 06 08 11 12 73 76 78 30]
         state = (2..7).to_a.map(&:to_s).sample
-        bsb_num = digit_one_two.sample + state + rand_numstring + rand_numstring + rand_numstring
-        bsb_num
+        digit_one_two.sample + state + rand_numstring + rand_numstring + rand_numstring
       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')
@@ -180,9 +182,9 @@ 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
-        prefix + '-' + numerator + '/' + denominator
+        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
 
       def rand_numstring

data/lib/faker/default/barcode.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module Faker
+  class Barcode < Base
+    class << self
+      ##
+      # Returns a EAN 8 or 13 digit format barcode number with check digit
+      #  @return [String]
+      #
+      #  @example
+      #     Faker::Barcode.ean      => "85657526"
+      #     Faker::Barcode.ean(8)   => "30152700"
+      #     Faker::Barcode.ean(13)  => "2115190480285"
+      #
+      # @faker.version 2.14.0
+      def ean(length = 8)
+        generate_barcode("barcode.ean_#{Integer(length)}")
+      end
+
+      ##
+      # Returns a EAN 8 or 13 digit format barcode number with composite string attached with check digit
+      #  @return [String]
+      #
+      #  @example
+      #     Faker::Barcode.ean_with_composite_sumbology      => "41007624|JHOC6649"
+      #     Faker::Barcode.ean_with_composite_sumbology(8)   => "38357961|XUYJ3266"
+      #     Faker::Barcode.ean_with_composite_sumbology(13)  => "9530722443911|CKHWQHID"
+      #
+      # @faker.version 2.14.0
+      def ean_with_composite_symbology(length = 8)
+        "#{ean(length)}|#{bothify(parse('barcode.composite_symbol'))}"
+      end
+
+      ##
+      # Returns a UPC_A format barcode number with check digit
+      #  @return [String]
+      #
+      #  @example
+      #     Faker::Barcode.upc_a      => "766807541831"
+      #
+      # @faker.version 2.14.0
+      def upc_a
+        generate_barcode('barcode.upc_a')
+      end
+
+      ##
+      # Returns a UPC_E format barcode number with check digit
+      #  @return [String]
+      #
+      #  @example
+      #     Faker::Barcode.upc_e      => "03746820"
+      #
+      # @faker.version 2.14.0
+      def upc_e
+        generate_barcode('barcode.upc_e')
+      end
+
+      ##
+      # Returns a UPC_A format barcode number with composite string attached with check digit
+      #  @return [String]
+      #
+      #  @example
+      #     Faker::Barcode.upc_a_with_composite_symbology      => "790670155765|JOVG6208"
+      #
+      # @faker.version 2.14.0
+      def upc_a_with_composite_symbology
+        "#{upc_a}|#{bothify(parse('barcode.composite_symbol'))}"
+      end
+
+      ##
+      # Returns a UPC_E format barcode number with composite string attached with check digit
+      #  @return [String]
+      #
+      #  @example
+      #     Faker::Barcode.upc_e_with_composite_symbology      => "05149247|BKZX9722"
+      #
+      # @faker.version 2.14.0
+      def upc_e_with_composite_symbology
+        "#{upc_e}|#{bothify(parse('barcode.composite_symbol'))}"
+      end
+
+      ##
+      # Returns a ISBN format barcode number with check digit
+      #  @return [String]
+      #
+      #  @example
+      #     Faker::Barcode.isbn      => "9798363807732"
+      #
+      # @faker.version 2.14.0
+      def isbn
+        generate_barcode('barcode.isbn')
+      end
+
+      ##
+      # Returns a ISMN format barcode number with check digit
+      #  @return [String]
+      #
+      #  @example
+      #     Faker::Barcode.ismn      => "9790527672897"
+      #
+      # @faker.version 2.14.0
+      def ismn
+        generate_barcode('barcode.ismn')
+      end
+
+      ##
+      # Returns a ISSN format barcode number with check digit
+      #  @return [String]
+      #
+      #  @example
+      #     Faker::Barcode.issn      => "9775541703338"
+      #
+      # @faker.version 2.14.0
+      def issn
+        generate_barcode('barcode.issn')
+      end
+
+      private
+
+      def generate_barcode(key)
+        barcode = parse(key)
+        check_digit = generate_check_digit(*sum_even_odd(barcode))
+        "#{barcode}#{check_digit}"
+      end
+
+      ##
+      # Returns the sum of even and odd numbers from value passed
+      #
+      # @return [Array]
+      #
+      # @example
+      #   Faker::Barcode.send(:sum_even_odd, 12345)   => [9, 5]
+      #   Faker::Barcode.send(:sum_even_odd, 87465)   => [17, 13]
+      #
+      # @faker.version 2.14.0
+      def sum_even_odd(fake_num)
+        number = fake_num.to_i
+        sum_even, sum_odd = 0, 0, index = 1
+
+        while number != 0
+          index.even? ? sum_even += number % 10 : sum_odd += number % 10
+
+          number /= 10
+          index += 1
+        end
+
+        [sum_odd, sum_even]
+      end
+
+      ##
+      # Generates the check digits from sum passed
+      #
+      # @return [Integer]
+      #
+      # @example
+      #   Faker::Barcode.send(:generate_check_digit, 12, 4)   => 0
+      #   Faker::Barcode.send(:generate_check_digit, 23, 5)   => 6
+      #
+      # @faker.version 2.14.0
+      def generate_check_digit(odd_sum, even_sum)
+        (10 - (odd_sum * 3 + even_sum) % 10) % 10
+      end
+    end
+  end
+end

data/lib/faker/default/beer.rb

@@ -80,7 +80,7 @@ module Faker
       #
       # @faker.version 1.6.2
       def ibu
-        rand(10..100).to_s + ' IBU'
+        "#{rand(10..100)} IBU"
       end
 
       ##
@@ -93,7 +93,7 @@ module Faker
       #
       # @faker.version 1.6.2
       def alcohol
-        rand(2.0..10.0).round(1).to_s + '%'
+        "#{rand(2.0..10.0).round(1)}%"
       end
 
       ##
@@ -106,7 +106,7 @@ module Faker
       #
       # @faker.version 1.6.2
       def blg
-        rand(5.0..20.0).round(1).to_s + '°Blg'
+        "#{rand(5.0..20.0).round(1)}°Blg"
       end
     end
   end

data/lib/faker/default/boolean.rb

@@ -15,10 +15,8 @@ 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) # rubocop:disable Naming/PredicateMethod
         (rand < true_ratio)
       end
     end

data/lib/faker/default/camera.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Faker
+  class Camera < Base
+    class << self
+      ##
+      # Produces a brand of a camera
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Camera.brand #=> "Canon"
+      #
+      # @faker.version next
+      def brand
+        fetch('camera.brand')
+      end
+
+      ##
+      # Produces a model of camera
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Camera.model #=> "450D"
+      #
+      # @faker.version next
+      def model
+        fetch('camera.model')
+      end
+
+      ##
+      # Produces a brand with model
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Camera.brand_with_model #=> "Canon 450D"
+      #
+      # @faker.version next
+      def brand_with_model
+        fetch('camera.brand_with_model')
+      end
+    end
+  end
+end

data/lib/faker/default/cannabis.rb

@@ -2,6 +2,7 @@
 
 module Faker
   class Cannabis < Base
+    ##
     # Produces a random strain.
     #
     # @return [String]
@@ -14,6 +15,7 @@ module Faker
       fetch('cannabis.strains')
     end
 
+    ##
     # Produces a random abbreviation.
     #
     # @return [String]
@@ -26,6 +28,7 @@ module Faker
       fetch('cannabis.cannabinoid_abbreviations')
     end
 
+    ##
     # Produces a random cannabinoid type.
     #
     # @return [String]
@@ -38,6 +41,7 @@ module Faker
       fetch('cannabis.cannabinoids')
     end
 
+    ##
     # Produces a random terpene type.
     #
     # @return [String]
@@ -50,6 +54,7 @@ module Faker
       fetch('cannabis.terpenes')
     end
 
+    ##
     # Produces a random kind of medical use.
     #
     # @return [String]
@@ -62,6 +67,7 @@ module Faker
       fetch('cannabis.medical_uses')
     end
 
+    ##
     # Produces a random health benefit.
     #
     # @return [String]
@@ -74,6 +80,7 @@ module Faker
       fetch('cannabis.health_benefits')
     end
 
+    ##
     # Produces a random category.
     #
     # @return [String]
@@ -86,6 +93,7 @@ module Faker
       fetch('cannabis.categories')
     end
 
+    ##
     # Produces a random type.
     #
     # @return [String]
@@ -98,6 +106,7 @@ module Faker
       fetch('cannabis.types')
     end
 
+    ##
     # Produces a random buzzword.
     #
     # @return [String]
@@ -110,6 +119,7 @@ module Faker
       fetch('cannabis.buzzwords')
     end
 
+    ##
     # Produces a random brand.
     #
     # @return [String]

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|
@@ -46,9 +42,10 @@ module Faker
           partial_result
         end
         partial_check_digit = 11 - (digit_sum % 11)
-        if partial_check_digit == 11
+        case partial_check_digit
+        when 11
           '0'
-        elsif partial_check_digit == 10
+        when 10
           'k'
         else
           partial_check_digit.to_s
@@ -72,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/chuck_norris.rb

@@ -5,6 +5,7 @@ module Faker
     flexible :chuck_norris
 
     class << self
+      ##
       # Produces a Chuck Norris Fact.
       # Original list of facts:
       # https://github.com/jenkinsci/chucknorris-plugin/blob/master/src/main/java/hudson/plugins/chucknorris/FactGenerator.java