faker 2.6.0

data/lib/faker/default/chile_rut.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Faker
+  class ChileRut < Base
+    class << self
+      @last_rut = nil
+
+      # Fixed param added for testing a specific RUT and check digit combination.
+      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)
+      end
+
+      def dv
+        split_reversed_rut = @last_rut.to_s.reverse.split('')
+        seq = [2, 3, 4, 5, 6, 7]
+        i = 0
+        digit_sum = split_reversed_rut.reduce(0) do |sum, n|
+          partial_result = sum.to_i + (n.to_i * seq[i])
+          i = i == 5 ? 0 : i + 1
+          partial_result
+        end
+        partial_check_digit = 11 - (digit_sum % 11)
+        if partial_check_digit == 11
+          '0'
+        elsif partial_check_digit == 10
+          'k'
+        else
+          partial_check_digit.to_s
+        end
+      end
+
+      # Alias for english speaking devs.
+      def check_digit
+        dv
+      end
+
+      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}"
+      end
+
+      attr_reader :last_rut
+    end
+  end
+end

data/lib/faker/default/chuck_norris.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Faker
+  class ChuckNorris < Base
+    flexible :chuck_norris
+
+    class << self
+      # from: https://github.com/jenkinsci/chucknorris-plugin/blob/master/src/main/java/hudson/plugins/chucknorris/FactGenerator.java
+      def fact
+        fetch('chuck_norris.fact')
+      end
+    end
+  end
+end

data/lib/faker/default/code.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+module Faker
+  class Code < Base
+    flexible :code
+    class << self
+      # Generates a 10 digit NPI (National Provider Identifier
+      # issued to health care providers in the United States)
+      def npi
+        rand(10**10).to_s.rjust(10, '0')
+      end
+
+      # By default generates 10 sign isbn code in format 123456789-X
+      # You can pass 13 to generate new 13 sign code
+      def isbn(legacy_base = NOT_GIVEN, base: 10)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :base if legacy_base != NOT_GIVEN
+        end
+
+        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(legacy_base = NOT_GIVEN, base: 13)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :base if legacy_base != NOT_GIVEN
+        end
+
+        base == 8 ? generate_base8_ean : generate_base13_ean
+      end
+
+      def rut
+        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(legacy_min_age = NOT_GIVEN, legacy_max_age = NOT_GIVEN, min_age: 18, max_age: 65)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :min_age if legacy_min_age != NOT_GIVEN
+          keywords << :max_age if legacy_max_age != NOT_GIVEN
+        end
+
+        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}/)
+        check_alpha = generate_nric_check_alphabet(values, prefix)
+        "#{prefix}#{values}#{check_alpha}"
+      end
+
+      # Generate GSM modem, device or mobile phone 15 digit IMEI number.
+      def imei
+        generate_imei
+      end
+
+      # Retrieves a real Amazon ASIN code list taken from
+      # https://archive.org/details/asin_listing
+      def asin
+        fetch('code.asin')
+      end
+
+      # Generates Social Insurance Number issued in Canada
+      # https://en.wikipedia.org/wiki/Social_Insurance_Number
+      def sin
+        # 1   - province or temporary resident
+        # 2-8 - random numbers
+        # 9   - checksum
+
+        # 1st digit. 8,0 are not used
+        registry = Faker::Base.sample([1, 2, 3, 4, 5, 6, 7, 9]).to_s
+
+        # generate 2nd to 8th
+        partial = Array.new(7) { Faker::Config.random.rand(0..9) }.join
+
+        # Generate 9th digit
+        check_digit = generate_sin_check_digit(registry + partial + '0').to_s
+
+        registry + partial + check_digit
+      end
+
+      private
+
+      # Reporting body identifier
+      RBI = %w[01 10 30 33 35 44 45 49 50 51 52 53 54 86 91 98 99].freeze
+
+      def generate_imei
+        str = Array.new(15, 0)
+        sum = 0
+        t = 0
+        len_offset = 0
+        len = 15
+
+        # Fill in the first two values of the string based with the specified prefix.
+        # Reporting Body Identifier list: http://en.wikipedia.org/wiki/Reporting_Body_Identifier
+        arr = sample(RBI)
+        str[0] = arr[0].to_i
+        str[1] = arr[1].to_i
+        pos = 2
+
+        # Fill all the remaining numbers except for the last one with random values.
+        while pos < (len - 1)
+          str[pos] = rand(0..9)
+          pos += 1
+        end
+
+        # Calculate the Luhn checksum of the values thus far
+        len_offset = (len + 1) % 2
+        (0..(len - 1)).each do |position|
+          if (position + len_offset).odd?
+            t = str[position] * 2
+
+            t -= 9 if t > 9
+
+            sum += t
+          else
+            sum += str[position]
+          end
+        end
+
+        # Choose the last digit so that it causes the entire string to pass the checksum.
+        str[len - 1] = (10 - (sum % 10)) % 10
+
+        # Output the IMEI value.
+        str.join('')
+      end
+
+      def generate_base10_isbn
+        values = regexify(/\d{9}/)
+        remainder = sum(values) { |value, index| (index + 1) * value.to_i } % 11
+        values << "-#{remainder == 10 ? 'X' : remainder}"
+      end
+
+      def generate_base13_isbn
+        values = regexify(/\d{12}/)
+        remainder = sum(values) { |value, index| index.even? ? value.to_i : value.to_i * 3 } % 10
+        values << "-#{((10 - remainder) % 10)}"
+      end
+
+      def sum(values)
+        values.split(//).each_with_index.inject(0) do |sum, (value, index)|
+          sum + yield(value, index)
+        end
+      end
+
+      def generate_base8_ean
+        values = regexify(/\d{7}/)
+        check_digit = 10 - values.split(//).each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT8[i] } % 10
+        values << (check_digit == 10 ? 0 : check_digit).to_s
+      end
+
+      def generate_base13_ean
+        values = regexify(/\d{12}/)
+        check_digit = 10 - values.split(//).each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT13[i] } % 10
+        values << (check_digit == 10 ? 0 : check_digit).to_s
+      end
+
+      EAN_CHECK_DIGIT8 = [3, 1, 3, 1, 3, 1, 3].freeze
+      EAN_CHECK_DIGIT13 = [1, 3, 1, 3, 1, 3, 1, 3, 1, 3, 1, 3].freeze
+
+      def rut_verificator_digit(rut)
+        total = rut.to_s.rjust(8, '0').split(//).zip(%w[3 2 7 6 5 4 3 2]).collect { |a, b| a.to_i * b.to_i }.inject(:+)
+        (11 - total % 11).to_s.gsub(/10/, 'k').gsub(/11/, '0')
+      end
+
+      def generate_nric_check_alphabet(values, prefix)
+        weight = %w[2 7 6 5 4 3 2]
+        total = values.split(//).zip(weight).collect { |a, b| a.to_i * b.to_i }.inject(:+)
+        total += 4 if prefix == 'T'
+        %w[A B C D E F G H I Z J][10 - total % 11]
+      end
+
+      def generate_sin_check_digit(digits)
+        # Fast Luhn checksum code from luhn.js:
+        # https://gist.github.com/ShirtlessKirk/2134376
+
+        len = 9
+        mul = 0
+
+        luhn_arr = [
+          [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
+          [0, 2, 4, 6, 8, 1, 3, 5, 7, 9]
+        ]
+        sum = 0
+
+        while len.positive?
+          len -= 1
+          num = digits[len].to_i
+          sum += luhn_arr[mul][num]
+          mul ^= 1
+        end
+
+        checksum = sum % 10
+        checksum.zero? ? checksum : (10 - checksum)
+      end
+    end
+  end
+end

data/lib/faker/default/coffee.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Faker
+  class Coffee < Base
+    flexible :coffee
+
+    class << self
+      def blend_name
+        parse('coffee.blend_name')
+      end
+
+      def origin
+        country = fetch('coffee.country')
+        region = fetch("coffee.regions.#{search_format(country)}")
+        "#{region}, #{country}"
+      end
+
+      def variety
+        fetch('coffee.variety')
+      end
+
+      def notes
+        parse('coffee.notes')
+      end
+
+      def intensifier
+        fetch('coffee.intensifier')
+      end
+
+      private
+
+      def search_format(key)
+        key.split.length > 1 ? key.split.join('_').downcase : key.downcase
+      end
+    end
+  end
+end

data/lib/faker/default/coin.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Faker
+  class Coin < Base
+    class << self
+      def name
+        fetch('currency.name')
+      end
+
+      def flip
+        fetch('coin.flip')
+      end
+    end
+  end
+end

data/lib/faker/default/color.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Faker
+  class Color < Base
+    class << self
+      def hex_color
+        format('#%06x', (rand * 0xffffff))
+      end
+
+      def color_name
+        fetch('color.name')
+      end
+
+      def single_rgb_color
+        sample((0..255).to_a)
+      end
+
+      def rgb_color
+        Array.new(3) { single_rgb_color }
+      end
+
+      # returns [hue, saturation, lightness]
+      def hsl_color
+        [sample((0..360).to_a), rand.round(2), rand.round(2)]
+      end
+
+      def hsla_color
+        hsl_color << rand.round(1)
+      end
+    end
+  end
+end

data/lib/faker/default/commerce.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Faker
+  class Commerce < Base
+    class << self
+      def color
+        fetch('color.name')
+      end
+
+      def promotion_code(legacy_digits = NOT_GIVEN, digits: 6)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :digits if legacy_digits != NOT_GIVEN
+        end
+
+        [
+          fetch('commerce.promotion_code.adjective'),
+          fetch('commerce.promotion_code.noun'),
+          Faker::Number.number(digits: digits)
+        ].join
+      end
+
+      def department(legacy_max = NOT_GIVEN, legacy_fixed_amount = NOT_GIVEN, max: 3, fixed_amount: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :max if legacy_max != NOT_GIVEN
+          keywords << :fixed_amount if legacy_fixed_amount != NOT_GIVEN
+        end
+
+        num = max if fixed_amount
+        num ||= 1 + rand(max)
+
+        categories = categories(num)
+
+        return merge_categories(categories) if num > 1
+
+        categories[0]
+      end
+
+      def product_name
+        "#{fetch('commerce.product_name.adjective')} #{fetch('commerce.product_name.material')} #{fetch('commerce.product_name.product')}"
+      end
+
+      def material
+        fetch('commerce.product_name.material')
+      end
+
+      def price(legacy_range = NOT_GIVEN, legacy_as_string = NOT_GIVEN, range: 0..100.0, as_string: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :range if legacy_range != NOT_GIVEN
+          keywords << :as_string if legacy_as_string != NOT_GIVEN
+        end
+
+        price = (rand(range) * 100).floor / 100.0
+        if as_string
+          price_parts = price.to_s.split('.')
+          price = price_parts[0] + '.' + price_parts[-1].ljust(2, '0')
+        end
+        price
+      end
+
+      private
+
+      def categories(num)
+        categories = []
+        while categories.length < num
+          category = fetch('commerce.department')
+          categories << category unless categories.include?(category)
+        end
+
+        categories
+      end
+
+      def merge_categories(categories)
+        separator = fetch('separator')
+        comma_separated = categories.slice!(0...-1).join(', ')
+
+        [comma_separated, categories[0]].join(separator)
+      end
+    end
+  end
+end

data/lib/faker/default/company.rb

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+module Faker
+  class Company < Base
+    flexible :company
+
+    class << self
+      def name
+        parse('company.name')
+      end
+
+      def suffix
+        fetch('company.suffix')
+      end
+
+      def industry
+        fetch('company.industry')
+      end
+
+      # Generate a buzzword-laden catch phrase.
+      def catch_phrase
+        translate('faker.company.buzzwords').collect { |list| sample(list) }.join(' ')
+      end
+
+      def buzzword
+        sample(translate('faker.company.buzzwords').flatten)
+      end
+
+      # When a straight answer won't do, BS to the rescue!
+      def bs
+        translate('faker.company.bs').collect { |list| sample(list) }.join(' ')
+      end
+
+      def ein
+        format('%09d', rand(10**9)).gsub(/(\d{2})(\d{7})/, '\\1-\\2')
+      end
+
+      def duns_number
+        format('%09d', rand(10**9)).gsub(/(\d{2})(\d{3})(\d{4})/, '\\1-\\2-\\3')
+      end
+
+      # Get a random company logo url in PNG format.
+      def logo
+        rand_num = rand(1..13)
+        "https://pigment.github.io/fake-logos/logos/medium/color/#{rand_num}.png"
+      end
+
+      def type
+        fetch('company.type')
+      end
+
+      def profession
+        fetch('company.profession')
+      end
+
+      # rubocop:disable Style/AsciiComments
+      # Get a random Spanish organization number. See more here https://es.wikipedia.org/wiki/Número_de_identificación_fiscal
+      # rubocop:enable Style/AsciiComments
+      def spanish_organisation_number
+        # Valid leading character: A, B, C, D, E, F, G, H, J, N, P, Q, R, S, U, V, W
+        # 7 digit numbers
+        letters = %w[A B C D E F G H J N P Q R S U V W]
+        base = [sample(letters), format('%07d', rand(10**7))].join
+        base
+      end
+
+      # Get a random Swedish organization number. See more here https://sv.wikipedia.org/wiki/Organisationsnummer
+      def swedish_organisation_number
+        # Valid leading digit: 1, 2, 3, 5, 6, 7, 8, 9
+        # Valid third digit: >= 2
+        # Last digit is a control digit
+        base = [sample([1, 2, 3, 5, 6, 7, 8, 9]), sample((0..9).to_a), sample((2..9).to_a), format('%06d', rand(10**6))].join
+        base + luhn_algorithm(base).to_s
+      end
+
+      def czech_organisation_number
+        sum = 0
+        base = []
+        [8, 7, 6, 5, 4, 3, 2].each do |weight|
+          base << sample((0..9).to_a)
+          sum += (weight * base.last)
+        end
+        base << (11 - (sum % 11)) % 10
+        base.join
+      end
+
+      # Get a random French SIREN number. See more here https://fr.wikipedia.org/wiki/Syst%C3%A8me_d%27identification_du_r%C3%A9pertoire_des_entreprises
+      def french_siren_number
+        base = (1..8).map { rand(10) }.join
+        base + luhn_algorithm(base).to_s
+      end
+
+      def french_siret_number
+        location = rand(100).to_s.rjust(4, '0')
+        org_no = french_siren_number + location
+        org_no + luhn_algorithm(org_no).to_s
+      end
+
+      # Get a random Norwegian organization number. Info: https://www.brreg.no/om-oss/samfunnsoppdraget-vart/registera-vare/einingsregisteret/organisasjonsnummeret/
+      def norwegian_organisation_number
+        # Valid leading digit: 8, 9
+        mod11_check = nil
+        while mod11_check.nil?
+          base = [sample([8, 9]), format('%07d', rand(10**7))].join
+          mod11_check = mod11(base)
+        end
+        base + mod11_check.to_s
+      end
+
+      def australian_business_number
+        base = format('%09d', rand(10**9))
+        abn = "00#{base}"
+
+        (99 - (abn_checksum(abn) % 89)).to_s + base
+      end
+
+      # Get a random Polish taxpayer identification number More info https://pl.wikipedia.org/wiki/NIP
+      def polish_taxpayer_identification_number
+        result = []
+        weights = [6, 5, 7, 2, 3, 4, 5, 6, 7]
+        loop do
+          result = Array.new(3) { rand(1..9) } + Array.new(7) { rand(10) }
+          break if (weight_sum(result, weights) % 11) == result[9]
+        end
+        result.join('')
+      end
+
+      # Get a random Polish register of national economy number. More info https://pl.wikipedia.org/wiki/REGON
+      def polish_register_of_national_economy(legacy_length = NOT_GIVEN, length: 9)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :length if legacy_length != NOT_GIVEN
+        end
+
+        raise ArgumentError, 'Length should be 9 or 14' unless [9, 14].include? length
+
+        random_digits = []
+        loop do
+          random_digits = Array.new(length) { rand(10) }
+          break if collect_regon_sum(random_digits) == random_digits.last
+        end
+        random_digits.join('')
+      end
+
+      def south_african_pty_ltd_registration_number
+        regexify(/\d{4}\/\d{4,10}\/07/)
+      end
+
+      def south_african_close_corporation_registration_number
+        regexify(/(CK\d{2}|\d{4})\/\d{4,10}\/23/)
+      end
+
+      def south_african_listed_company_registration_number
+        regexify(/\d{4}\/\d{4,10}\/06/)
+      end
+
+      def south_african_trust_registration_number
+        regexify(/IT\d{2,4}\/\d{2,10}/)
+      end
+
+      def brazilian_company_number(legacy_formatted = NOT_GIVEN, formatted: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :formatted if legacy_formatted != NOT_GIVEN
+        end
+
+        digits = Array.new(8) { Faker::Number.digit.to_i } + [0, 0, 0, Faker::Number.non_zero_digit.to_i]
+
+        factors = [5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2, 6].cycle
+
+        2.times do
+          checksum = digits.inject(0) { |acc, digit| acc + digit * factors.next } % 11
+          digits << (checksum < 2 ? 0 : 11 - checksum)
+        end
+
+        number = digits.join
+
+        formatted ? format('%s.%s.%s/%s-%s', *number.scan(/(\d{2})(\d{3})(\d{3})(\d{4})(\d{2})/).flatten) : number
+      end
+
+      def sic_code
+        fetch('company.sic_code')
+      end
+
+      private
+
+      # Mod11 functionality from https://github.com/badmanski/mod11/blob/master/lib/mod11.rb
+      def mod11(number)
+        weight = [2, 3, 4, 5, 6, 7,
+                  2, 3, 4, 5, 6, 7,
+                  2, 3, 4, 5, 6, 7]
+
+        sum = 0
+
+        number.to_s.reverse.chars.each_with_index do |char, i|
+          sum += char.to_i * weight[i]
+        end
+
+        remainder = sum % 11
+
+        case remainder
+        when 0 then remainder
+        when 1 then nil
+        else 11 - remainder
+        end
+      end
+
+      def luhn_algorithm(number)
+        multiplications = []
+
+        number.to_s.reverse.split(//).each_with_index do |digit, i|
+          multiplications << if i.even?
+                               digit.to_i * 2
+                             else
+                               digit.to_i
+                             end
+        end
+
+        sum = 0
+
+        multiplications.each do |num|
+          num.to_s.each_byte do |character|
+            sum += character.chr.to_i
+          end
+        end
+
+        control_digit = if (sum % 10).zero?
+                          0
+                        else
+                          (sum / 10 + 1) * 10 - sum
+                        end
+
+        control_digit
+      end
+
+      def abn_checksum(abn)
+        abn_weights = [10, 1, 3, 5, 7, 9, 11, 13, 15, 17, 19]
+        sum = 0
+
+        abn_weights.each_with_index do |weight, i|
+          sum += weight * abn[i].to_i
+        end
+
+        sum
+      end
+
+      def collect_regon_sum(array)
+        weights = if array.size == 9
+                    [8, 9, 2, 3, 4, 5, 6, 7]
+                  else
+                    [2, 4, 8, 5, 0, 9, 7, 3, 6, 1, 2, 4, 8]
+                  end
+        sum = weight_sum(array, weights) % 11
+        sum == 10 ? 0 : sum
+      end
+
+      def weight_sum(array, weights)
+        sum = 0
+        (0..weights.size - 1).each do |index|
+          sum += (array[index] * weights[index])
+        end
+        sum
+      end
+    end
+  end
+end