faker 2.15.1 → 3.4.2

data/lib/faker/travel/train_station.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Faker
+  class Travel
+    class TrainStation < Base
+      class << self
+        ##
+        # Produces random Train Station by name and takes optional arguments for region and type
+        #
+        # @param region [String] Train station region: germany, spain, united_kingdom, united_states
+        #
+        # @param type [String] Train station type: metro, railway
+        #
+        # @return [String]
+        #
+        # @examples
+        # Faker::Travel::TrainStation.name(region: 'united_kingdom', type: 'metro') => "Brockley"
+        # Faker::Travel::TrainStation.name(type: 'railway') => "Düsseldorf Hauptbahnhof"
+        # Faker::Travel::TrainStation.name(region: 'spain') => "Santa Eulàlia"
+        #
+        # @faker.version next
+        def name(region: nil, type: nil)
+          region, type = fill_missing_inputs_with_samples(region, type)
+          fetch("train_station.#{region}.#{type}")
+        end
+
+        private
+
+        def fill_missing_inputs_with_samples(region, type)
+          regions = %w[germany spain united_kingdom united_states]
+          types = %w[metro railway]
+
+          if region.nil? && type.nil?
+            region = sample(regions)
+            type = sample(types)
+          elsif region.nil?
+            validate_arguments(type, types, 'type')
+            region = sample(regions)
+          elsif type.nil?
+            validate_arguments(region, regions, 'region')
+            type = sample(types)
+          end
+          [region, type]
+        end
+
+        def validate_arguments(argument, correct_values, argument_name)
+          return if correct_values.include?(argument)
+
+          raise ArgumentError, "'#{argument}' not found, #{argument_name} can be blank, or one of the following, as strings: #{correct_values.join(', ')}"
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/archer.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class Archer < Base
+      flexible :archer
+
+      class << self
+        ##
+        # Produces a character from Archer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Archer.character #=> "Sterling Archer"
+        #
+        # @faker.version next
+        def character
+          fetch('archer.characters')
+        end
+
+        ##
+        # Produces a location from Archer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Archer.location #=> "The Tuntmore Towers"
+        #
+        # @faker.version next
+        def location
+          fetch('archer.locations')
+        end
+
+        ##
+        # Produces a quote from Archer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Archer.quote
+        #     #=> "You're not my supervisor!"
+        #
+        # @faker.version next
+        def quote
+          fetch('archer.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/big_bang_theory.rb

@@ -25,7 +25,7 @@ module Faker
         # @return [String]
         #
         # @example
-        # Faker::TvShows::BigBangTheory.quote #=> "I'm not crazy. My mother had me tested."
+        #  Faker::TvShows::BigBangTheory.quote #=> "I'm not crazy. My mother had me tested."
         #
         # @faker.version 2.13.0
         def quote

data/lib/faker/tv_shows/brooklyn_nine_nine.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class BrooklynNineNine < Base
+      flexible :brooklyn_nine_nine
+
+      class << self
+        ##
+        # Produces a character from Brooklyn Nine Nine.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BrooklynNineNine.character #=> "Jake Peralta"
+        #
+        # @faker.version next
+        def character
+          fetch('brooklyn_nine_nine.characters')
+        end
+
+        ##
+        # Produces a quote from Brooklyn Nine Nine.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BrooklynNineNine.quote
+        #     #=> "Cool, cool, cool, cool, cool. No doubt, no doubt, no doubt."
+        #
+        # @faker.version next
+        def quote
+          fetch('brooklyn_nine_nine.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_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/version.rb

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

data/lib/faker.rb

@@ -4,32 +4,37 @@ 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 }
 
 I18n.load_path += Dir[File.join(mydir, 'locales', '**/*.yml')]
-I18n.reload! if I18n.backend.initialized?
 
 module Faker
   module Config
-    @locale = nil
-    @random = nil
+    @default_locale = nil
 
     class << self
-      attr_writer :locale, :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
     end
   end
@@ -41,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.
@@ -81,13 +92,13 @@ module Faker
         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+)\}/, '{\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(/\[([^\]]+)\]/) { |_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
@@ -185,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
@@ -255,58 +266,6 @@ module Faker
       ensure
         I18n.enforce_available_locales = old_enforce_available_locales
       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
-
-          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
-        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
-      end
     end
   end
 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.unpack1('C') * 256**i }
+      str.chars.reverse.each_with_index { |v, i| lv += v.unpack1('C') * 256**i }
 
       ret = +''
       while lv.positive?

data/lib/helpers/deprecator.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Based on Rails ActiveSupport Deprecator
+# https://github.com/rails/rails/blob/6f0d1ad14b92b9f5906e44740fce8b4f1c7075dc/activesupport/lib/active_support/deprecation/constant_accessor.rb
+
+# rubocop:disable Style/ClassVars
+module Faker
+  module Deprecator
+    def self.included(base)
+      extension = Module.new do
+        def const_missing(missing_const_name)
+          if class_variable_defined?(:@@_deprecated_constants) && (replacement = class_variable_get(:@@_deprecated_constants)[missing_const_name.to_s])
+            unless Faker::Deprecator.skip_warning?
+              $stdout.puts("DEPRECATION WARNING: #{name}::#{replacement[:old_generator]} is deprecated. Use #{replacement[:new_constant]} instead.")
+            end
+
+            return replacement[:new_constant]
+          end
+
+          super
+        end
+
+        def deprecate_generator(old_generator_name, new_generator_constant)
+          class_variable_set(:@@_deprecated_constants, {}) unless class_variable_defined?(:@@_deprecated_constants)
+          class_variable_get(:@@_deprecated_constants)[old_generator_name] = { new_constant: new_generator_constant, old_generator: old_generator_name }
+        end
+      end
+
+      base.singleton_class.prepend extension
+    end
+
+    def self.skip_warning
+      original = Faker::Deprecator.skip
+      Faker::Deprecator.skip = true
+      yield
+    ensure
+      Faker::Deprecator.skip = original
+    end
+
+    def self.skip_warning?
+      skip == true
+    end
+
+    def self.skip
+      @skip ||= false
+    end
+
+    def self.skip=(value)
+      @skip = value
+    end
+  end
+end
+# rubocop:enable Style/ClassVars