faker 2.13.0 → 3.8.0

data/lib/faker/tv_shows/dr_who.rb

@@ -84,19 +84,6 @@ module Faker
           fetch('dr_who.villains')
         end
 
-        ##
-        # Produces a villain from Doctor Who.
-        #
-        # @return [String]
-        #
-        # @example
-        #   Faker::TvShows::DrWho.villian #=> "The Master"
-        #
-        # @deprecated Use the correctly-spelled `villain` method instead.
-        #
-        # @faker.version 1.8.0
-        alias villian villain
-
         ##
         # Produces a species from Doctor Who.
         #

data/lib/faker/tv_shows/final_space.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class FinalSpace < Base
+      flexible :final_space
+
+      class << self
+        ##
+        # Produces a character from Final Space.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::FinalSpace.character #=> "Gary Goodspeed"
+        #
+        # @faker.version next
+        def character
+          fetch('final_space.characters')
+        end
+
+        ##
+        # Produces a vehicle from Final Space.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::FinalSpace.vehicle #=> "Imperium Cruiser"
+        #
+        # @faker.version next
+        def vehicle
+          fetch('final_space.vehicles')
+        end
+
+        ##
+        # Produces a quote from Final Space.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::FinalSpace.quote
+        #     #=> "It's an alien on my face! It's an alien on my...It's a space alien!"
+        #
+        # @faker.version next
+        def quote
+          fetch('final_space.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/michael_scott.rb

@@ -4,8 +4,6 @@ module Faker
   class TvShows
     class MichaelScott < Base
       class << self
-        # rubocop:disable Style/AsciiComments
-
         ##
         # Produces a quote from Michael Scott.
         #
@@ -19,7 +17,6 @@ module Faker
         def quote
           fetch('michael_scott.quotes')
         end
-        # rubocop:enable Style/AsciiComments
       end
     end
   end

data/lib/faker/tv_shows/south_park.rb

@@ -32,6 +32,21 @@ module Faker
         def quote
           fetch('south_park.quotes')
         end
+
+        ##
+        # Produces an episode name from South Park.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::SouthPark.episode_name
+        #     #=> "Make Love, Not Warcraft"
+        #
+        # @faker.version next
+
+        def episode_name
+          fetch('south_park.episodes')
+        end
       end
     end
   end

data/lib/faker/tv_shows/spongebob.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class Spongebob < Base
+      flexible :spongebob
+
+      class << self
+        ##
+        # Produces a character from Spongebob.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Spongebob.character #=> "Patrick"
+        #
+        # @faker.version next
+        def character
+          fetch('spongebob.characters')
+        end
+
+        ##
+        # Produces a quote from Spongebob.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Spongebob.quote #=> "I'm ready! I'm ready!"
+        #
+        # @faker.version next
+        def quote
+          fetch('spongebob.quotes')
+        end
+
+        ##
+        # Produces an episode from Spongebob.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Spongebob.episode #=> "Reef Blower"
+        #
+        # @faker.version next
+        def episode
+          fetch('spongebob.episodes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/suits.rb

@@ -25,7 +25,7 @@ module Faker
         # @return [String]
         #
         # @example
-        # Faker::TvShows::Suits.quote #=> "Don't play the odds, play the man."
+        #  Faker::TvShows::Suits.quote #=> "Don't play the odds, play the man."
         #
         # @faker.version 2.13.0
         def quote

data/lib/faker/tv_shows/supernatural.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class Supernatural < Base
+      class << self
+        ##
+        # Produces the name of a character from Supernatural.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Supernatural.character #=> "Dean Winchester"
+        #
+        # @faker.version next
+        def character
+          fetch('supernatural.character')
+        end
+
+        ##
+        # Produces the name of a hunted creature.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Supernatural.creature #=> "Demon"
+        #
+        # @faker.version next
+        def creature
+          fetch('supernatural.creature')
+        end
+
+        ##
+        # Produces the name of a weapon used by the hunters.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Supernatural.weapon #=> "Colt"
+        #
+        # @faker.version next
+        def weapon
+          fetch('supernatural.weapon')
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/the_fresh_prince_of_bel_air.rb

@@ -20,16 +20,16 @@ module Faker
         end
 
         ##
-        # Produces a celebrity from The Fresh Prince of Bel-Air.
+        # Produces a actor from The Fresh Prince of Bel-Air.
         #
         # @return [String]
         #
         # @example
-        #   Faker::TvShows::TheFreshPrinceOfBelAir.celebrity #=> "Quincy Jones"
+        #   Faker::TvShows::TheFreshPrinceOfBelAir.actor #=> "Quincy Jones"
         #
-        # @faker.version 1.8.3
-        def celebrity
-          fetch('the_fresh_prince_of_bel_air.celebrities')
+        # @faker.version next
+        def actor
+          fetch('the_fresh_prince_of_bel_air.actors')
         end
 
         ##

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.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    if Faker::Config.lazy_loading?
+      Faker.lazy_load(self)
+    end
+  end
+end

data/lib/faker/version.rb

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

data/lib/faker.rb

@@ -4,33 +4,51 @@ mydir = __dir__
 
 require 'psych'
 require 'i18n'
-require 'set' # Fixes a bug in i18n 0.6.11
 
-Dir.glob(File.join(mydir, 'helpers', '*.rb')).sort.each { |file| require file }
+autoload(:OpenSSL, 'openssl')
+
+Dir.glob(File.join(mydir, 'helpers', '*.rb')).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
         # 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)
+        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
+
+      def lazy_loading?
+        if ENV.key?('FAKER_LAZY_LOAD') && !ENV['FAKER_LAZY_LOAD'].nil?
+          %w[true TRUE 1].include?(ENV.fetch('FAKER_LAZY_LOAD', nil))
+        else
+          Thread.current[:faker_lazy_loading] == true
+        end
+      end
+
+      def lazy_loading=(value)
+        Thread.current[:faker_lazy_loading] = value
       end
     end
   end
@@ -42,23 +60,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, &)
+        PositionalGenerator.new(as_type, &).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.
@@ -81,14 +105,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(/(\[[^\]]+\])\{(\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))) }                      # 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(%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))) }                       # 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).chars) }                                                                                                  # All [ABC] become B (or A or C)
           .gsub('\d') { |_match| sample(Numbers) }
           .gsub('\w') { |_match| sample(Letters) }
       end
@@ -97,7 +121,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
@@ -109,7 +133,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
@@ -121,7 +145,8 @@ 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
@@ -165,12 +190,12 @@ module Faker
       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
@@ -185,10 +210,10 @@ module Faker
       #   name:
       #     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
+      def method_missing(mth, *args, &)
+        super unless flexible_key
 
-        if (translation = translate("faker.#{@flexible_key}.#{mth}"))
+        if (translation = translate("faker.#{flexible_key}.#{mth}"))
           sample(translation)
         else
           super
@@ -239,6 +264,10 @@ module Faker
         list.shuffle(random: Faker::Config.random)
       end
 
+      def shuffle!(list)
+        list.shuffle!(random: Faker::Config.random)
+      end
+
       def rand(max = nil)
         if max.nil?
           Faker::Config.random.rand
@@ -256,61 +285,49 @@ module Faker
       ensure
         I18n.enforce_available_locales = old_enforce_available_locales
       end
+    end
+  end
 
-      private
-
-      def warn_for_deprecated_arguments
-        keywords = []
-        yield(keywords)
-
-        return if keywords.empty?
-
-        method_name = caller.first.match(/`(?<method_name>.*)'/)[:method_name]
-
-        keywords.each.with_index(1) do |keyword, index|
-          i = case index
-              when 1 then '1st'
-              when 2 then '2nd'
-              when 3 then '3rd'
-              else "#{index}th"
-              end
+  if Faker::Config.lazy_loading?
+    def self.load_path(*constants)
+      constants.map do |class_name|
+        class_name
+          .to_s
+          .gsub('::', '/')
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr('-', '_')
+          .downcase
+      end.join('/')
+    end
 
-          warn_with_uplevel(<<~MSG, uplevel: 5)
-            Passing `#{keyword}` with the #{i} argument of `#{method_name}` is deprecated. Use keyword argument like `#{method_name}(#{keyword}: ...)` instead.
-          MSG
+    def self.lazy_load(klass)
+      def klass.const_missing(class_name)
+        load_path = case class_name
+                    when :DnD
+                      Faker.load_path('faker/games/dnd')
+                    else
+                      Faker.load_path(name, class_name)
+                    end
+
+        begin
+          require(load_path)
+        rescue LoadError
+          require(load_path.gsub('faker/', 'faker/default/'))
         end
 
-        warn(<<~MSG)
-
-          To automatically update from positional arguments to keyword arguments,
-          install rubocop-faker and run:
-
-          rubocop \\
-            --require rubocop-faker \\
-            --only Faker/DeprecatedArguments \\
-            --auto-correct
-
-        MSG
-      end
-
-      # 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
+        const_get(class_name)
       end
     end
+
+    lazy_load(self)
   end
 end
 
-# require faker objects
-Dir.glob(File.join(mydir, 'faker', '/**/*.rb')).sort.each { |file| require file }
+unless Faker::Config.lazy_loading?
+  rb_files = []
+  rb_files << File.join(mydir, 'faker', '*.rb')
+  rb_files << File.join(mydir, 'faker', '/**/*.rb')
+
+  Dir.glob(rb_files).each { |file| require file }
+end

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') * 256**i }
+      str.chars.reverse.each_with_index { |v, i| lv += v.unpack1('C') * 256**i }
 
       ret = +''
       while lv.positive?