faker 2.2.0 → 3.2.2

data/lib/faker/tv_shows/the_office.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class TheOffice < Base
+      flexible :the_office
+
+      class << self
+        ##
+        # Produces a character from The Office.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::TheOffice.character #=> "Michael Scott"
+        #
+        # @faker.version next
+        def character
+          fetch('the_office.characters')
+        end
+
+        ##
+        # Produces a quote from The Office.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::TheOffice.quote #=> "Identity theft is not a joke, Jim! Millions of families suffer every year."
+        #
+        # @faker.version next
+        def quote
+          fetch('the_office.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/the_thick_of_it.rb

@@ -6,14 +6,42 @@ module Faker
       flexible :the_thick_of_it
 
       class << self
+        ##
+        # Produces a character from The Thick of It.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::TheThickOfIt.character #=> "Nicola Murray"
+        #
+        # @faker.version 1.8.5
         def character
           fetch('the_thick_of_it.characters')
         end
 
+        ##
+        # Produces a department from The Thick of It.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::TheThickOfIt.department #=> "Shadow Cabinet"
+        #
+        # @faker.version 1.8.5
         def department
           fetch('the_thick_of_it.departments')
         end
 
+        ##
+        # Produces a position from The Thick of It.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::TheThickOfIt.position
+        #     #=> "Director of Communications"
+        #
+        # @faker.version 1.8.5
         def position
           fetch('the_thick_of_it.positions')
         end

data/lib/faker/tv_shows/twin_peaks.rb

@@ -6,14 +6,42 @@ module Faker
       flexible :twin_peaks
 
       class << self
+        ##
+        # Produces a character from Twin Peaks.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::TwinPeaks.character #=> "Dale Cooper"
+        #
+        # @faker.version 1.7.0
         def character
           fetch('twin_peaks.characters')
         end
 
+        ##
+        # Produces a location from Twin Peaks.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::TwinPeaks.location #=> "Black Lodge"
+        #
+        # @faker.version 1.7.0
         def location
           fetch('twin_peaks.locations')
         end
 
+        ##
+        # Produces a quote from Twin Peaks.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::TwinPeaks.quote
+        #     #=> "The owls are not what they seem."
+        #
+        # @faker.version 1.7.0
         def quote
           fetch('twin_peaks.quotes')
         end

data/lib/faker/tv_shows/venture_bros.rb

@@ -6,18 +6,56 @@ module Faker
       flexible :venture_bros
 
       class << self
+        ##
+        # Produces a character from The Venture Bros.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::VentureBros.character #=> "Scaramantula"
+        #
+        # @faker.version 1.8.3
         def character
           fetch('venture_bros.character')
         end
 
+        ##
+        # Produces an organization from The Venture Bros.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::VentureBros.organization
+        #     #=> "Guild of Calamitous Intent"
+        #
+        # @faker.version 1.8.3
         def organization
           fetch('venture_bros.organization')
         end
 
+        ##
+        # Produces a vehicle from The Venture Bros.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::VentureBros.vehicle #=> "Monarchmobile"
+        #
+        # @faker.version 1.8.3
         def vehicle
           fetch('venture_bros.vehicle')
         end
 
+        ##
+        # Produces a quote from The Venture Bros.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::VentureBros.quote
+        #     #=> "Revenge, like gazpacho soup, is best served cold, precise, and merciless."
+        #
+        # @faker.version 1.8.3
         def quote
           fetch('venture_bros.quote')
         end

data/lib/faker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Faker #:nodoc:
-  VERSION = '2.2.0'
+module Faker # :nodoc:
+  VERSION = '3.2.2'
 end

data/lib/faker.rb

@@ -2,37 +2,39 @@
 
 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 }
+Dir.glob(File.join(mydir, 'helpers', '*.rb')).sort.each { |file| require file }
 
 I18n.load_path += Dir[File.join(mydir, 'locales', '**/*.yml')]
-I18n.reload! if I18n.backend.initialized?
 
 module Faker
-  class Config
-    @locale = nil
-    @random = nil
+  module Config
+    @default_locale = nil
 
     class << self
-      attr_writer :locale
-      attr_writer :random
+      attr_writer :default_locale
+
+      def locale=(new_locale)
+        Thread.current[:faker_config_locale] = new_locale
+      end
 
       def locale
-        @locale || I18n.locale
+        # Because I18n.locale defaults to :en, if we don't have :en in our available_locales, errors will happen
+        Thread.current[:faker_config_locale] || @default_locale || (I18n.available_locales.include?(I18n.locale) ? I18n.locale : I18n.available_locales.first)
       end
 
       def own_locale
-        @locale
+        Thread.current[:faker_config_locale]
+      end
+
+      def random=(new_random)
+        Thread.current[:faker_config_random] = new_random
       end
 
       def random
-        @random || Random::DEFAULT
+        Thread.current[:faker_config_random] || Random
       end
     end
   end
@@ -44,23 +46,29 @@ module Faker
     Letters = ULetters + LLetters
 
     class << self
+      attr_reader :flexible_key
+
       NOT_GIVEN = Object.new
 
       ## by default numerify results do not start with a zero
       def numerify(number_string, leading_zero: false)
-        return number_string.gsub(/#/) { rand(10).to_s } if leading_zero
+        return number_string.gsub('#') { rand(10).to_s } if leading_zero
 
-        number_string.sub(/#/) { rand(1..9).to_s }.gsub(/#/) { rand(10).to_s }
+        number_string.sub('#') { rand(1..9).to_s }.gsub('#') { rand(10).to_s }
       end
 
       def letterify(letter_string)
-        letter_string.gsub(/\?/) { sample(ULetters) }
+        letter_string.gsub('?') { sample(ULetters) }
       end
 
       def bothify(string)
         letterify(numerify(string))
       end
 
+      def generate(as_type, &block)
+        PositionalGenerator.new(as_type, &block).generate
+      end
+
       # Given a regular expression, attempt to generate a string
       # that would match it.  This is a rather simple implementation,
       # so don't be shocked if it blows up on you in a spectacular fashion.
@@ -83,14 +91,14 @@ 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(/\{(\d+)\}/, '{\1,\1}').gsub(/\?/, '{0,1}') # All {2} become {2,2} and ? become {0,1}
+          .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(Regexp.last_match(1).split('')) } # All [ABC] become B (or A or C)
+          .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).chars) } # All [ABC] become B (or A or C)
           .gsub('\d') { |_match| sample(Numbers) }
           .gsub('\w') { |_match| sample(Letters) }
       end
@@ -99,7 +107,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 +119,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 +131,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 +140,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)
@@ -151,30 +159,28 @@ module Faker
 
       # Call I18n.translate with our configured locale if no
       # locale is specified
-      def translate(*args)
-        opts = args.last.is_a?(Hash) ? args.pop : {}
+      def translate(*args, **opts)
         opts[:locale] ||= Faker::Config.locale
         opts[:raise] = true
-        I18n.translate(*args.push(opts))
+        I18n.translate(*args, **opts)
       rescue I18n::MissingTranslationData
-        opts = args.last.is_a?(Hash) ? args.pop : {}
         opts[:locale] = :en
 
         # Super-simple fallback -- fallback to en if the
         # translation was missing.  If the translation isn't
         # in en either, then it will raise again.
         disable_enforce_available_locales do
-          I18n.translate(*args.push(opts))
+          I18n.translate(*args, **opts)
         end
       end
 
       # Executes block with given locale set.
-      def with_locale(tmp_locale = nil)
+      def with_locale(tmp_locale = nil, &block)
         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
@@ -190,9 +196,9 @@ module Faker
       #     girls_name: ["Alice", "Cheryl", "Tatiana"]
       # Then you can call Faker::Name.girls_name and it will act like #first_name
       def method_missing(mth, *args, &block)
-        super unless @flexible_key
+        super unless flexible_key
 
-        if (translation = translate("faker.#{@flexible_key}.#{mth}"))
+        if (translation = translate("faker.#{flexible_key}.#{mth}"))
           sample(translation)
         else
           super
@@ -219,12 +225,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)
@@ -248,27 +266,9 @@ module Faker
       ensure
         I18n.enforce_available_locales = old_enforce_available_locales
       end
-
-      private
-
-      # Workaround for emulating `warn '...', uplevel: 1` in Ruby 2.4 or lower.
-      def warn_with_uplevel(message, uplevel: 1)
-        at = parse_caller(caller[uplevel]).join(':')
-        warn "#{at}: #{message}"
-      end
-
-      def parse_caller(at)
-        # rubocop:disable Style/GuardClause
-        if /^(.+?):(\d+)(?::in `.*')?/ =~ at
-          file = Regexp.last_match(1)
-          line = Regexp.last_match(2).to_i
-          [file, line]
-        end
-        # rubocop:enable Style/GuardClause
-      end
     end
   end
 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/helpers/base58.rb

@@ -7,7 +7,7 @@ module Faker
       base = alphabet.size
 
       lv = 0
-      str.split('').reverse.each_with_index { |v, i| lv += v.unpack('C')[0] * 256**i }
+      str.chars.reverse.each_with_index { |v, i| lv += v.unpack1('C') * 256**i }
 
       ret = +''
       while lv.positive?

data/lib/helpers/char.rb

@@ -5,7 +5,7 @@ module Faker
     def self.prepare(string)
       result = romanize_cyrillic string
       result = fix_umlauts result
-      result.gsub(/\W/, '').downcase
+      result.gsub(/[^\w-]/, '').downcase
     end
 
     def self.fix_umlauts(string)
@@ -15,6 +15,7 @@ module Faker
         when 'ö' then 'oe'
         when 'ü' then 'ue'
         when 'ß' then 'ss'
+        else match.downcase
         end
       end
     end
@@ -23,19 +24,16 @@ module Faker
       if Faker::Config.locale == 'uk'
         # Based on conventions abopted by BGN/PCGN for Ukrainian
         uk_chars = {
-          'а' => 'a',  'б' => 'b',  'в' => 'v',  'г' => 'h',  'ґ' => 'g',  'д' => 'd',
-          'е' => 'e',  'є' => 'ye', 'ж' => 'zh', 'з' => 'z',  'и' => 'y',  'і' => 'i',
-          'ї' => 'yi', 'й' => 'y',  'к' => 'k',  'л' => 'l',  'м' => 'm',  'н' => 'n',
-          'о' => 'o',  'п' => 'p',  'р' => 'r',  'с' => 's',  'т' => 't',  'у' => 'u',
-          'ф' => 'f',  'х' => 'kh', 'ц' => 'ts', 'ч' => 'ch', 'ш' => 'sh', 'щ' => 'shch',
-          'ю' => 'yu', 'я' => 'ya',
-          'А' => 'a',  'Б' => 'b',  'В' => 'v',  'Г' => 'h',  'Ґ' => 'g',  'Д' => 'd',
-          'Е' => 'e',  'Є' => 'ye', 'Ж' => 'zh', 'З' => 'z',  'И' => 'y',  'І' => 'i',
-          'Ї' => 'yi', 'Й' => 'y',  'К' => 'k',  'Л' => 'l',  'М' => 'm',  'Н' => 'n',
-          'О' => 'o',  'П' => 'p',  'Р' => 'r',  'С' => 's',  'Т' => 't',  'У' => 'u',
-          'Ф' => 'f',  'Х' => 'kh', 'Ц' => 'ts', 'Ч' => 'ch', 'Ш' => 'sh', 'Щ' => 'shch',
-          'Ю' => 'yu', 'Я' => 'ya',
-          'ь' => '' # Ignore symbol, because its standard presentation is not allowed in URLs
+          'а' => 'a', 'б' => 'b', 'в' => 'v', 'г' => 'h', 'ґ' => 'g', 'д' => 'd', 'е' => 'e',
+          'є' => 'ye', 'ж' => 'zh', 'з' => 'z', 'и' => 'y', 'і' => 'i', 'ї' => 'yi', 'й' => 'y',
+          'к' => 'k',  'л' => 'l', 'м' => 'm', 'н' => 'n', 'о' => 'o', 'п' => 'p', 'р' => 'r',
+          'с' => 's', 'т' => 't', 'у' => 'u', 'ф' => 'f', 'х' => 'kh', 'ц' => 'ts', 'ч' => 'ch',
+          'ш' => 'sh', 'щ' => 'shch', 'ю' => 'yu', 'я' => 'ya', 'А' => 'a', 'Б' => 'b', 'В' => 'v',
+          'Г' => 'h', 'Ґ' => 'g', 'Д' => 'd', 'Е' => 'e', 'Є' => 'ye', 'Ж' => 'zh', 'З' => 'z',
+          'И' => 'y', 'І' => 'i', 'Ї' => 'yi', 'Й' => 'y', 'К' => 'k', 'Л' => 'l', 'М' => 'm',
+          'Н' => 'n', 'О' => 'o', 'П' => 'p', 'Р' => 'r', 'С' => 's', 'Т' => 't', 'У' => 'u',
+          'Ф' => 'f', 'Х' => 'kh', 'Ц' => 'ts', 'Ч' => 'ch', 'Ш' => 'sh', 'Щ' => 'shch', 'Ю' => 'yu',
+          'Я' => 'ya', 'ь' => '' # Ignore symbol, because its standard presentation is not allowed in URLs
         }
         return string.gsub(/[а-яА-ЯіїєґІЇЄҐ]/, uk_chars)
       end
@@ -44,22 +42,19 @@ module Faker
         # Based on conventions abopted by BGN/PCGN for Russian
         ru_chars = {
           'а' => 'a', 'б' => 'b', 'в' => 'v', 'г' => 'h', 'д' => 'd', 'е' => 'e',
-          'ё' => 'ye', 'ж' => 'zh', 'з' => 'z',    'и' => 'i',  'й' => 'y',  'к' => 'k',
-          'л' => 'l',  'м' => 'm',  'н' => 'n',    'о' => 'o',  'п' => 'p',  'р' => 'r',
-          'с' => 's',  'т' => 't',  'у' => 'u',    'ф' => 'f',  'х' => 'kh', 'ц' => 'ts',
-          'ч' => 'ch', 'ш' => 'sh', 'щ' => 'shch', 'ы' => 'у',  'э' => 'e',  'ю' => 'yu',
-          'я' => 'ya',
-          'А' => 'a',  'Б' => 'b',  'В' => 'v',    'Г' => 'h',  'Д' => 'd',  'Е' => 'e',
-          'Ё' => 'ye', 'Ж' => 'zh', 'З' => 'z',    'И' => 'i',  'Й' => 'y',  'К' => 'k',
-          'Л' => 'l',  'М' => 'm',  'Н' => 'n',    'О' => 'o',  'П' => 'p',  'Р' => 'r',
-          'С' => 's',  'Т' => 't',  'У' => 'u',    'Ф' => 'f',  'Х' => 'kh', 'Ц' => 'ts',
-          'Ч' => 'ch', 'Ш' => 'sh', 'Щ' => 'shch', 'Ы' => 'у',  'Э' => 'e',  'Ю' => 'yu',
-          'Я' => 'ya',
-          'ь' => '', 'ъ' => '' # Ignore symbols, because its standard presentation is not allowed in URLs
+          'ё' => 'ye', 'ж' => 'zh', 'з' => 'z', 'и' => 'i', 'й' => 'y', 'к' => 'k',
+          'л' => 'l',  'м' => 'm',  'н' => 'n',  'о' => 'o', 'п' => 'p', 'р' => 'r',
+          'с' => 's',  'т' => 't',  'у' => 'u',  'ф' => 'f', 'х' => 'kh', 'ц' => 'ts',
+          'ч' => 'ch', 'ш' => 'sh', 'щ' => 'shch', 'ы' => 'у', 'э' => 'e', 'ю' => 'yu',
+          'я' => 'ya', 'А' => 'a',  'Б' => 'b', 'В' => 'v', 'Г' => 'h', 'Д' => 'd',
+          'Е' => 'e', 'Ё' => 'ye', 'Ж' => 'zh', 'З' => 'z', 'И' => 'i', 'Й' => 'y',
+          'К' => 'k', 'Л' => 'l', 'М' => 'm', 'Н' => 'n', 'О' => 'o', 'П' => 'p', 'Р' => 'r',
+          'С' => 's',  'Т' => 't',  'У' => 'u', 'Ф' => 'f', 'Х' => 'kh', 'Ц' => 'ts',
+          'Ч' => 'ch', 'Ш' => 'sh', 'Щ' => 'shch', 'Ы' => 'у', 'Э' => 'e', 'Ю' => 'yu',
+          'Я' => 'ya', 'ь' => '', 'ъ' => '' # Ignore symbols, because its standard presentation is not allowed in URLs
         }
         return string.gsub(/[а-яА-Я]/, ru_chars)
       end
-
       string
     end
   end