faker 2.10.2 → 2.15.0

data/lib/faker.rb

@@ -2,29 +2,45 @@
 
 mydir = __dir__
 
-begin
-  require 'psych'
-end
-
+require 'psych'
 require 'i18n'
 require 'set' # Fixes a bug in i18n 0.6.11
 
-Dir.glob(File.join(File.dirname(__FILE__), 'helpers', '*.rb')).sort.each { |file| require file }
-
-I18n.load_path += Dir[File.join(mydir, 'locales', '**/*.yml')]
-I18n.reload! if I18n.backend.initialized?
+Dir.glob(File.join(mydir, 'helpers', '*.rb')).sort.each { |file| require file }
 
 module Faker
-  class Config
+  @i18n_loaded = nil
+
+  class << self
+    def load_i18n
+      return if @i18n_loaded
+
+      if I18n.available_locales&.any?
+        # We expect all locale .yml files to have the locale name in its filename
+        I18n.load_path += ::Dir[::File.join(__dir__, 'locales', "{#{I18n.available_locales.join(',')}}.yml")]
+        # Or to be located in a directory with the locale name
+        I18n.load_path += ::Dir[::File.join(__dir__, 'locales', "{#{I18n.available_locales.join(',')}}/*.yml")]
+      else
+        I18n.load_path += ::Dir[::File.join(__dir__, 'locales', '**/*.yml')]
+      end
+
+      I18n.reload! if I18n.backend.initialized?
+      @i18n_loaded = true
+    end
+  end
+
+  module Config
     @locale = nil
     @random = nil
 
     class << self
-      attr_writer :locale
-      attr_writer :random
+      attr_writer :locale, :random
 
       def locale
-        @locale || I18n.locale
+        Faker.load_i18n
+
+        # Because I18n.locale defaults to :en, if we don't have :en in our available_locales, errors will happen
+        @locale || (I18n.available_locales.include?(I18n.locale) ? I18n.locale : I18n.available_locales.first)
       end
 
       def own_locale
@@ -83,13 +99,13 @@ module Faker
       def regexify(reg)
         reg = reg.source if reg.respond_to?(:source) # Handle either a Regexp or a String that looks like a Regexp
         reg
-          .gsub(%r{^\/?\^?}, '').gsub(%r{\$?\/?$}, '') # Ditch the anchors
+          .gsub(%r{^/?\^?}, '').gsub(%r{\$?/?$}, '') # Ditch the anchors
           .gsub(/\{(\d+)\}/, '{\1,\1}').gsub(/\?/, '{0,1}') # All {2} become {2,2} and ? become {0,1}
           .gsub(/(\[[^\]]+\])\{(\d+),(\d+)\}/) { |_match| Regexp.last_match(1) * sample(Array(Range.new(Regexp.last_match(2).to_i, Regexp.last_match(3).to_i))) }                # [12]{1,2} becomes [12] or [12][12]
-          .gsub(/(\([^\)]+\))\{(\d+),(\d+)\}/) { |_match| Regexp.last_match(1) * sample(Array(Range.new(Regexp.last_match(2).to_i, Regexp.last_match(3).to_i))) }                # (12|34){1,2} becomes (12|34) or (12|34)(12|34)
+          .gsub(/(\([^)]+\))\{(\d+),(\d+)\}/) { |_match| Regexp.last_match(1) * sample(Array(Range.new(Regexp.last_match(2).to_i, Regexp.last_match(3).to_i))) }                 # (12|34){1,2} becomes (12|34) or (12|34)(12|34)
           .gsub(/(\\?.)\{(\d+),(\d+)\}/) { |_match| Regexp.last_match(1) * sample(Array(Range.new(Regexp.last_match(2).to_i, Regexp.last_match(3).to_i))) }                      # A{1,2} becomes A or AA or \d{3} becomes \d\d\d
-          .gsub(/\((.*?)\)/) { |match| sample(match.gsub(/[\(\)]/, '').split('|')) } # (this|that) becomes 'this' or 'that'
-          .gsub(/\[([^\]]+)\]/) { |match| match.gsub(/(\w\-\w)/) { |range| sample(Array(Range.new(*range.split('-')))) } } # All A-Z inside of [] become C (or X, or whatever)
+          .gsub(/\((.*?)\)/) { |match| sample(match.gsub(/[()]/, '').split('|')) } # (this|that) becomes 'this' or 'that'
+          .gsub(/\[([^\]]+)\]/) { |match| match.gsub(/(\w-\w)/) { |range| sample(Array(Range.new(*range.split('-')))) } } # All A-Z inside of [] become C (or X, or whatever)
           .gsub(/\[([^\]]+)\]/) { |_match| sample(Regexp.last_match(1).split('')) } # All [ABC] become B (or A or C)
           .gsub('\d') { |_match| sample(Numbers) }
           .gsub('\w') { |_match| sample(Letters) }
@@ -99,7 +115,7 @@ module Faker
       # with an array of values and selecting one of them.
       def fetch(key)
         fetched = sample(translate("faker.#{key}"))
-        if fetched&.match(%r{^\/}) && fetched&.match(%r{\/$}) # A regex
+        if fetched&.match(%r{^/}) && fetched&.match(%r{/$}) # A regex
           regexify(fetched)
         else
           fetched
@@ -111,7 +127,7 @@ module Faker
       def fetch_all(key)
         fetched = translate("faker.#{key}")
         fetched = fetched.last if fetched.size <= 1
-        if !fetched.respond_to?(:sample) && fetched.match(%r{^\/}) && fetched.match(%r{\/$}) # A regex
+        if !fetched.respond_to?(:sample) && fetched.match(%r{^/}) && fetched.match(%r{/$}) # A regex
           regexify(fetched)
         else
           fetched
@@ -123,7 +139,7 @@ module Faker
       # formatted translation: e.g., "#{first_name} #{last_name}".
       def parse(key)
         fetched = fetch(key)
-        parts = fetched.scan(/(\(?)#\{([A-Za-z]+\.)?([^\}]+)\}([^#]+)?/).map do |prefix, kls, meth, etc|
+        parts = fetched.scan(/(\(?)#\{([A-Za-z]+\.)?([^}]+)\}([^#]+)?/).map do |prefix, kls, meth, etc|
           # If the token had a class Prefix (e.g., Name.first_name)
           # grab the constant, otherwise use self
           cls = kls ? Faker.const_get(kls.chop) : self
@@ -132,7 +148,7 @@ module Faker
           # In either case the information will be retained for reconstruction of the string.
           text = prefix
 
-          # If the class has the method, call it, otherwise fetch the transation
+          # If the class has the method, call it, otherwise fetch the translation
           # (e.g., faker.phone_number.area_code)
           text += if cls.respond_to?(meth)
                     cls.send(meth)
@@ -152,6 +168,8 @@ module Faker
       # Call I18n.translate with our configured locale if no
       # locale is specified
       def translate(*args, **opts)
+        Faker.load_i18n
+
         opts[:locale] ||= Faker::Config.locale
         opts[:raise] = true
         I18n.translate(*args, **opts)
@@ -167,12 +185,14 @@ module Faker
       end
 
       # Executes block with given locale set.
-      def with_locale(tmp_locale = nil)
+      def with_locale(tmp_locale = nil, &block)
+        Faker.load_i18n
+
         current_locale = Faker::Config.own_locale
         Faker::Config.locale = tmp_locale
 
         disable_enforce_available_locales do
-          I18n.with_locale(tmp_locale) { yield }
+          I18n.with_locale(tmp_locale, &block)
         end
       ensure
         Faker::Config.locale = current_locale
@@ -217,12 +237,24 @@ module Faker
         end
       end
 
+      # Return unique values from the generator every time.
+      #
+      # @param max_retries [Integer] The max number of retries that should be done before giving up.
+      # @return [self]
       def unique(max_retries = 10_000)
         @unique ||= UniqueGenerator.new(self, max_retries)
       end
 
-      def sample(list)
-        list.respond_to?(:sample) ? list.sample(random: Faker::Config.random) : list
+      def sample(list, num = nil)
+        if list.respond_to?(:sample)
+          if num
+            list.sample(num, random: Faker::Config.random)
+          else
+            list.sample(random: Faker::Config.random)
+          end
+        else
+          list
+        end
       end
 
       def shuffle(list)
@@ -303,4 +335,4 @@ module Faker
 end
 
 # require faker objects
-Dir.glob(File.join(File.dirname(__FILE__), 'faker', '/**/*.rb')).sort.each { |file| require file }
+Dir.glob(File.join(mydir, 'faker', '/**/*.rb')).sort.each { |file| require file }

data/lib/faker/blockchain/aeternity.rb

@@ -14,7 +14,7 @@ module Faker
         #     #=> "ak_zvU8YQLagjcfng7Tg8yCdiZ1rpiWNp1PBn3vtUs44utSvbJVR"
         #
         def address
-          'ak_' + rand_strings
+          "ak_#{rand_strings}"
         end
 
         ##
@@ -27,7 +27,7 @@ module Faker
         #     #=> "th_147nDP22h3pHrLt2qykTH4txUwQh1ccaXp"
         #
         def transaction
-          'th_' + rand_strings(51)
+          "th_#{rand_strings(51)}"
         end
 
         ##
@@ -40,7 +40,7 @@ module Faker
         #     #=> "ct_Hk2JsNeWGEYQEHHQCfcBeGrwbhtYSwFTPdDhW2SvjFYVojyhW"
         #
         def contract
-          'ct_' + rand_strings
+          "ct_#{rand_strings}"
         end
 
         ##
@@ -53,7 +53,7 @@ module Faker
         #     #=> "ok_28QDg7fkF5qiKueSdUvUBtCYPJdmMEoS73CztzXCRAwMGKHKZh"
         #
         def oracle
-          'ok_' + rand_strings(51)
+          "ok_#{rand_strings(51)}"
         end
 
         protected

data/lib/faker/books/dune.rb

@@ -30,6 +30,19 @@ module Faker
           fetch('dune.titles')
         end
 
+        ##
+        # Produces the name of a city from Dune
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.city #=> "Arrakeen"
+        #
+        # @faker.version next
+        def city
+          fetch('dune.cities')
+        end
+
         ##
         # Produces the name of a planet from Dune
         #
@@ -76,7 +89,7 @@ module Faker
             end
           end
 
-          fetch('dune.quotes.' + character)
+          fetch("dune.quotes.#{character}")
         end
 
         ##
@@ -111,7 +124,7 @@ module Faker
             end
           end
 
-          fetch('dune.sayings.' + source)
+          fetch("dune.sayings.#{source}")
         end
       end
     end

data/lib/faker/books/lovecraft.rb

@@ -68,6 +68,7 @@ module Faker
         #
         # @param word_count [Integer] The number of words to have in the sentence
         # @param random_words_to_add [Integer]
+        # @param open_compounds_allowed [Boolean] If true, generated sentence can contain words having additional spaces
         #
         # @return [String]
         #
@@ -80,15 +81,18 @@ module Faker
         # @example
         #   Faker::Books::Lovecraft.sentence(word_count: 3, random_words_to_add: 1)
         #     #=> "Amorphous indescribable tenebrous."
+        # @example
+        #   Faker::Books::Lovecraft.sentence(word_count: 3, random_words_to_add: 0, open_compounds_allowed: true)
+        #     #=> "Effulgence unmentionable gambrel."
         #
         # @faker.version 1.9.3
-        def sentence(legacy_word_count = NOT_GIVEN, legacy_random_words_to_add = NOT_GIVEN, word_count: 4, random_words_to_add: 6)
+        def sentence(legacy_word_count = NOT_GIVEN, legacy_random_words_to_add = NOT_GIVEN, word_count: 4, random_words_to_add: 6, open_compounds_allowed: true)
           warn_for_deprecated_arguments do |keywords|
             keywords << :word_count if legacy_word_count != NOT_GIVEN
             keywords << :random_words_to_add if legacy_random_words_to_add != NOT_GIVEN
           end
 
-          words(number: word_count + rand(random_words_to_add.to_i).to_i, spaces_allowed: true).join(' ').capitalize + '.'
+          "#{words(number: word_count + rand(random_words_to_add.to_i).to_i, spaces_allowed: open_compounds_allowed).join(' ').capitalize}."
         end
 
         ##
@@ -266,9 +270,9 @@ module Faker
 
           paragraph = paragraph(sentence_count: 3)
 
-          paragraph += ' ' + paragraph(sentence_count: 3) while paragraph.length < characters
+          paragraph += " #{paragraph(sentence_count: 3)}" while paragraph.length < characters
 
-          paragraph[0...characters - 1] + '.'
+          "#{paragraph[0...characters - 1]}."
         end
       end
     end

data/lib/faker/default/address.rb

@@ -54,7 +54,7 @@ module Faker
           keywords << :include_secondary if legacy_include_secondary != NOT_GIVEN
         end
 
-        numerify(parse('address.street_address') + (include_secondary ? ' ' + secondary_address : ''))
+        numerify(parse('address.street_address') + (include_secondary ? " #{secondary_address}" : ''))
       end
 
       ##
@@ -102,7 +102,7 @@ module Faker
       # @return [String]
       #
       # @example
-      # Faker::Address.mail_box #=> "PO Box 123"
+      #   Faker::Address.mail_box #=> "PO Box 123"
       #
       # @faker.version 2.9.1
       def mail_box
@@ -133,7 +133,7 @@ module Faker
 
         # provide a zip code that is valid for the state provided
         # see http://www.fincen.gov/forms/files/us_state_territory_zip_codes.pdf
-        bothify(fetch('address.postcode_by_state.' + state_abbreviation))
+        bothify(fetch("address.postcode_by_state.#{state_abbreviation}"))
       end
 
       ##
@@ -247,7 +247,7 @@ module Faker
           keywords << :code if legacy_code != NOT_GIVEN
         end
 
-        fetch('address.country_by_code.' + code)
+        fetch("address.country_by_code.#{code}")
       end
 
       ##
@@ -265,7 +265,7 @@ module Faker
           keywords << :name if legacy_name != NOT_GIVEN
         end
 
-        fetch('address.country_by_name.' + name)
+        fetch("address.country_by_name.#{name}")
       end
 
       ##
@@ -333,6 +333,36 @@ module Faker
       def full_address
         parse('address.full_address')
       end
+
+      ##
+      # Produces Address hash of required fields
+      #
+      # @return [Hash]
+      #
+      # @example
+      #   Faker::Address.full_address_as_hash(:longitude,
+      #                                       :latitude,
+      #                                       :country_name_to_code,
+      #                                       country_name_to_code: {name: 'united_states'})
+      #     #=> {:longitude=>-101.74428917174603, :latitude=>-37.40056749089944, :country_name_to_code=>"US"}
+      #
+      #  Faker::Address.full_address_as_hash(:full_address)
+      #     #=> {:full_address=>"87635 Rice Street, Lake Brentonton, OR 61896-5968"}
+      #
+      #  Faker::Address.full_address_as_hash(:city, :time_zone)
+      #     #=> {:city=>"East Faustina", :time_zone=>"America/Mexico_City"}
+      #
+      #  Faker::Address.full_address_as_hash(:street_address, street_address: {include_secondary: true})
+      #     #=> {:street_address=>"29423 Kenneth Causeway Suite 563"}
+      #
+      # @faker.version 2.13.0
+      def full_address_as_hash(*attrs, **attrs_params)
+        attrs.map!(&:to_sym)
+        attrs_params.transform_keys!(&:to_sym)
+        attrs.map do |attr|
+          { "#{attr}": attrs_params[attr] ? send(attr, **attrs_params[attr]) : send(attr) }
+        end.reduce({}, :merge)
+      end
     end
   end
 end

data/lib/faker/default/bank.rb

@@ -5,6 +5,17 @@ module Faker
     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
@@ -17,6 +28,17 @@ module Faker
         output[0...digits]
       end
 
+      ##
+      # Produces a bank iban number.
+      #
+      # @param country_code [String] Specifies what country prefix is used to generate the iban code.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.iban #=> "GB76DZJM33188515981979"
+      #   Faker::Bank.iban(country_code: "be") #=> "BE6375388567752043"
+      #
+      # @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
@@ -38,22 +60,72 @@ module Faker
         country_code.upcase + iban_checksum(country_code, account) + account
       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)
@@ -68,8 +140,13 @@ 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
+        digit_one_two.sample + state + rand_numstring + rand_numstring + rand_numstring
       end
 
       # Calculates the mandatory checksum in 3rd and 4th characters in IBAN format
@@ -103,7 +180,7 @@ module Faker
         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
+        "#{prefix}-#{numerator}/#{denominator}"
       end
 
       def rand_numstring