faker 1.8.7 → 2.17.0

data/lib/faker/default/alphanumeric.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Faker
+  class Alphanumeric < Base
+    ##
+    # List of characters allowed for alphanumeric strings
+    # @private
+    ALPHANUMS = LLetters + Numbers
+
+    class << self
+      ##
+      # Produces a random string of alphabetic characters (no digits)
+      #
+      # @param number [Integer] The length of the string to generate
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Alphanumeric.alpha(number: 10) #=> "zlvubkrwga"
+      #
+      # @faker.version 1.9.2
+      def alpha(legacy_number = NOT_GIVEN, number: 32)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :number if legacy_number != NOT_GIVEN
+        end
+        char_count = resolve(number)
+        return '' if char_count.to_i < 1
+
+        Array.new(char_count) { sample(self::LLetters) }.join
+      end
+
+      ##
+      # Produces a random string of alphanumeric characters
+      #
+      # @param number [Integer] The number of characters to generate
+      # @param min_alpha [Integer] The minimum number of alphabetic to add to the string
+      # @param min_numeric [Integer] The minimum number of numbers to add to the string
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Alphanumeric.alphanumeric(number: 10) #=> "3yfq2phxtb"
+      # @example
+      #   Faker::Alphanumeric.alphanumeric(number: 10, min_alpha: 3) #=> "3yfq2phxtb"
+      # @example
+      #   Faker::Alphanumeric.alphanumeric(number: 10, min_alpha: 3, min_numeric: 3) #=> "3yfq2phx8b"
+      #
+      # @faker.version 2.1.3
+      def alphanumeric(legacy_number = NOT_GIVEN, number: 32, min_alpha: 0, min_numeric: 0)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :number if legacy_number != NOT_GIVEN
+        end
+        char_count = resolve(number)
+        return '' if char_count.to_i < 1
+        raise ArgumentError, 'min_alpha must be greater than or equal to 0' if min_alpha&.negative?
+        raise ArgumentError, 'min_numeric must be greater than or equal to 0' if min_numeric&.negative?
+
+        return Array.new(char_count) { sample(ALPHANUMS) }.join if min_alpha.zero? && min_numeric.zero?
+
+        raise ArgumentError, 'min_alpha + min_numeric must be <= number' if min_alpha + min_numeric > char_count
+
+        random_count = char_count - min_alpha - min_numeric
+
+        alphas = Array.new(min_alpha) { sample(self::LLetters) }
+        numbers = Array.new(min_numeric) { sample(self::Numbers) }
+        randoms = Array.new(random_count) { sample(ALPHANUMS) }
+
+        combined = alphas + numbers + randoms
+        combined.shuffle.join
+      end
+    end
+  end
+end

data/lib/faker/default/ancient.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Faker
+  class Ancient < Base
+    class << self
+      ##
+      # Produces a god from ancient mythology.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Ancient.god #=> "Zeus"
+      #
+      # @faker.version 1.7.0
+      def god
+        fetch('ancient.god')
+      end
+
+      ##
+      # Produces a primordial from ancient mythology.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Ancient.primordial #=> "Gaia"
+      #
+      # @faker.version 1.7.0
+      def primordial
+        fetch('ancient.primordial')
+      end
+
+      ##
+      # Produces a titan from ancient mythology.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Ancient.titan #=> "Atlas"
+      #
+      # @faker.version 1.7.0
+      def titan
+        fetch('ancient.titan')
+      end
+
+      ##
+      # Produces a hero from ancient mythology.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Ancient.hero #=> "Achilles"
+      #
+      # @faker.version 1.7.0
+      def hero
+        fetch('ancient.hero')
+      end
+    end
+  end
+end

data/lib/faker/default/app.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Faker
+  class App < Base
+    class << self
+      ##
+      # Produces an app name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::App.name #=> "Treeflex"
+      #
+      # @faker.version 1.4.3
+      def name
+        fetch('app.name')
+      end
+
+      ##
+      # Produces a version string.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::App.version #=> "1.85"
+      #
+      # @faker.version 1.4.3
+      def version
+        parse('app.version')
+      end
+
+      ##
+      # Produces the name of an app's author.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::App.author #=> "Daphne Swift"
+      #
+      # @faker.version 1.4.3
+      def author
+        parse('app.author')
+      end
+
+      # rubocop:disable Metrics/ParameterLists
+
+      ##
+      # Produces a String representing a semantic version identifier.
+      #
+      # @param major [Integer, Range] An integer to use or a range to pick the integer from.
+      # @param minor [Integer, Range] An integer to use or a range to pick the integer from.
+      # @param patch [Integer, Range] An integer to use or a range to pick the integer from.
+      # @return [String]
+      #
+      # @example
+      #   Faker::App.semantic_version #=> "3.2.5"
+      # @example
+      #   Faker::App.semantic_version(major: 42) #=> "42.5.2"
+      # @example
+      #   Faker::App.semantic_version(minor: 100..101) #=> "42.100.4"
+      # @example
+      #   Faker::App.semantic_version(patch: 5..6) #=> "7.2.6"
+      #
+      # @faker.version 1.4.3
+      def semantic_version(legacy_major = NOT_GIVEN, legacy_minor = NOT_GIVEN, legacy_patch = NOT_GIVEN, major: 0..9, minor: 0..9, patch: 1..9)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :major if legacy_major != NOT_GIVEN
+          keywords << :minor if legacy_minor != NOT_GIVEN
+          keywords << :patch if legacy_patch != NOT_GIVEN
+        end
+
+        [major, minor, patch].map { |chunk| sample(Array(chunk)) }.join('.')
+      end
+      # rubocop:enable Metrics/ParameterLists
+    end
+  end
+end

data/lib/faker/default/appliance.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Faker
+  class Appliance < Base
+    class << self
+      ##
+      # Produces the name of an appliance brand.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Appliance.brand #=> "Bosch"
+      #
+      # @faker.version 1.9.0
+      def brand
+        fetch('appliance.brand')
+      end
+
+      ##
+      # Produces the name of a type of appliance equipment.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Appliance.equipment #=> "Appliance plug"
+      #
+      # @faker.version 1.9.0
+      def equipment
+        fetch('appliance.equipment')
+      end
+    end
+  end
+end

data/lib/faker/default/artist.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Faker
+  class Artist < Base
+    class << self
+      ##
+      # Produces the name of an artist.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Artist.name #=> "Michelangelo"
+      #
+      # @faker.version 1.8.8
+      def name
+        fetch('artist.names')
+      end
+    end
+  end
+end

data/lib/faker/default/avatar.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Faker
+  class Avatar < Base
+    class << self
+      # @private
+      SUPPORTED_FORMATS = %w[png jpg bmp].freeze
+
+      # rubocop:disable Metrics/ParameterLists
+
+      ##
+      # Produces a URL for an avatar from robohash.org
+      #
+      # @param slug [String, nil]
+      # @param size [String] image size in pixels, in the format of 'AxB'
+      # @param format [String] The image file format
+      # @param set [String] The avatar set to use
+      # @param bgset [String, nil] The background set to use
+      # @return [String] A robohash.org URL
+      #
+      # @example
+      #   Faker::Avatar.image
+      #     #=> "https://robohash.org/sitsequiquia.png?size=300x300&set=set1"
+      # @example
+      #   Faker::Avatar.image(slug: "my-own-slug")
+      #     #=> "https://robohash.org/my-own-slug.png?size=300x300&set=set1"
+      # @example
+      #   Faker::Avatar.image(slug: "my-own-slug", size: "50x50")
+      #     #=> "https://robohash.org/my-own-slug.png?size=50x50&set=set1"
+      # @example
+      #   Faker::Avatar.image(slug: "my-own-slug", size: "50x50", format: "jpg")
+      #     #=> "https://robohash.org/my-own-slug.jpg?size=50x50&set=set1"
+      # @example
+      #   Faker::Avatar.image(slug: "my-own-slug", size: "50x50", format: "bmp")
+      #     #=> "https://robohash.org/my-own-slug.bmp?size=50x50&set=set1"
+      # @example
+      #   Faker::Avatar.image(slug: "my-own-slug", size: "50x50", format: "bmp", set: "set1", bgset: "bg1")
+      #     #=> "https://robohash.org/my-own-slug.bmp?size=50x50&set=set1&bgset=bg1"
+      #
+      # @faker.version 1.4.3
+      def image(legacy_slug = NOT_GIVEN, legacy_size = NOT_GIVEN, legacy_format = NOT_GIVEN, legacy_set = NOT_GIVEN, legacy_bgset = NOT_GIVEN, slug: nil, size: '300x300', format: 'png', set: 'set1', bgset: nil)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :slug if legacy_slug != NOT_GIVEN
+          keywords << :size if legacy_size != NOT_GIVEN
+          keywords << :format if legacy_format != NOT_GIVEN
+          keywords << :set if legacy_set != NOT_GIVEN
+          keywords << :bgset if legacy_bgset != NOT_GIVEN
+        end
+
+        raise ArgumentError, 'Size should be specified in format 300x300' unless size =~ /^[0-9]+x[0-9]+$/
+        raise ArgumentError, "Supported formats are #{SUPPORTED_FORMATS.join(', ')}" unless SUPPORTED_FORMATS.include?(format)
+
+        slug ||= Faker::Lorem.words.join
+        bgset_query = "&bgset=#{bgset}" if bgset
+        "https://robohash.org/#{slug}.#{format}?size=#{size}&set=#{set}#{bgset_query}"
+      end
+      # rubocop:enable Metrics/ParameterLists
+    end
+  end
+end

data/lib/faker/default/bank.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Faker
+  class Bank < Base
+    flexible :bank
+
+    class << self
+      ##
+      # Produces a bank account number.
+      #
+      # @param digits [Integer] Number of digits that the generated account number should have.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.account_number #=> 6738582379
+      #   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]
+      end
+
+      ##
+      # Produces a bank iban number.
+      #
+      # @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')
+        # 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")
+        rescue I18n::MissingTranslationData
+          raise ArgumentError, "Could not find iban details for #{country_code}"
+        end
+
+        # Use Faker::Base.regexify for creating a sample from bank account format regex
+        account = Base.regexify(/#{pattern}/)
+
+        # Add country code and checksum to the generated account to form valid IBAN
+        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.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.name #=> "ABN AMRO CORPORATE FINANCE LIMITED"
+      #
+      # @faker.version 1.7.0
+      def name
+        fetch('bank.name')
+      end
+
+      ##
+      # Produces a routing number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.routing_number #=> "729343831"
+      #
+      # @faker.version 1.9.1
+      def routing_number
+        valid_routing_number
+      end
+
+      ##
+      # Produces a valid routing number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.routing_number #=> "729343831"
+      #
+      # @faker.version 1.9.1
+      def routing_number_with_format
+        compile_fraction(valid_routing_number)
+      end
+
+      ##
+      # Produces a swift / bic number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.swift_bic #=> "AAFMGB21"
+      #
+      # @faker.version 1.7.0
+      def swift_bic
+        fetch('bank.swift_bic')
+      end
+
+      ##
+      # Produces an Australian BSB (Bank-State-Branch) number
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.bsb_number
+      #     #=> "036616"
+      #
+      # @faker.version 2.13.0
+      def bsb_number
+        compile_bsb_number
+      end
+
+      private
+
+      def checksum(num_string)
+        num_array = num_string.split('').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
+
+      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 }
+        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
+        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
+      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
+
+        # Use leftpad to make the size always to 2
+        checksum.to_s.rjust(2, '0')
+      end
+
+      def valid_routing_number
+        routing_number = compile_routing_number
+        checksum = checksum(routing_number)
+        return routing_number if valid_checksum?(routing_number, checksum)
+
+        routing_number[0..7] + checksum.to_s
+      end
+
+      def valid_checksum?(routing_number, checksum)
+        routing_number[8].to_i == checksum
+      end
+
+      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}"
+      end
+
+      def rand_numstring
+        (0..9).to_a.map(&:to_s).sample
+      end
+    end
+  end
+end