faker 3.2.0 → 3.5.2

data/lib/faker/travel/airport.rb

@@ -11,7 +11,7 @@ module Faker
         #
         # @param region [String] airport region, currently available -> united_states or european_union
         #
-        # @retrun [String]
+        # @return [String]
         #
         # @example
         # Faker::Travel::Airport.name(size: 'large', region: 'united_states') => "Los Angeles International Airport"
@@ -28,7 +28,7 @@ module Faker
         #
         # @param region [String] airport region, currently available -> united_states or european_union
         #
-        # @retrun [String]
+        # @return [String]
         #
         # @example
         # Faker::Travel::Airport.iata(size: 'large', region: 'united_states') => "LAX"

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

@@ -45,19 +45,6 @@ module Faker
           fetch('buffy.actors')
         end
 
-        ##
-        # Produces a actor from Buffy the Vampire Slayer.
-        #
-        # @return [String]
-        #
-        # @example
-        #   Faker::TvShows::Buffy.celebrity #=> "John Ritter"
-        #
-        # @deprecated Use the `actor` method instead.
-        #
-        # @faker.version 1.9.2
-        alias celebrity actor
-
         ##
         # Produces a big bad from Buffy the Vampire Slayer.
         #

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

@@ -32,19 +32,6 @@ module Faker
           fetch('the_fresh_prince_of_bel_air.actors')
         end
 
-        ##
-        # Produces a actor from The Fresh Prince of Bel-Air.
-        #
-        # @return [String]
-        #
-        # @example
-        #   Faker::TvShows::TheFreshPrinceOfBelAir.celebrity #=> "Quincy Jones"
-        #
-        # @deprecated Use the `actor` method instead.
-        #
-        # @faker.version 1.8.3
-        alias celebrity actor
-
         ##
         # Produces a quote from The Fresh Prince of Bel-Air.
         #

data/lib/faker/version.rb

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

data/lib/faker.rb

@@ -5,20 +5,24 @@ mydir = __dir__
 require 'psych'
 require 'i18n'
 
-Dir.glob(File.join(mydir, 'helpers', '*.rb')).sort.each { |file| require file }
+Dir.glob(File.join(mydir, 'helpers', '*.rb')).each { |file| require file }
 
 I18n.load_path += Dir[File.join(mydir, 'locales', '**/*.yml')]
 
 module Faker
   module Config
+    @default_locale = nil
+
     class << self
+      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
-        Thread.current[:faker_config_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
@@ -48,19 +52,23 @@ module Faker
 
       ## 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.
@@ -84,7 +92,7 @@ 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
@@ -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
@@ -241,6 +249,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
@@ -263,4 +275,4 @@ module Faker
 end
 
 # require faker objects
-Dir.glob(File.join(mydir, 'faker', '/**/*.rb')).sort.each { |file| require file }
+Dir.glob(File.join(mydir, 'faker', '/**/*.rb')).each { |file| require file }

data/lib/helpers/deprecator.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+# Based on Rails ActiveSupport Deprecator
+# https://github.com/rails/rails/blob/main/activesupport/lib/active_support/deprecation/constant_accessor.rb
+
+# rubocop:disable Style/ClassVars
+module Faker
+  # Provides a way to rename generators, including their namespaces, with a deprecation cycle in which
+  # both the old and new names work, but using the old one prints a deprecation message.
+  #
+  # Deprecator provides a deprecate_generator method to be used when
+  # renaming a generator. For example, let's say we want to change the following Generator's
+  # name to <tt>Faker::NewGenerator</tt>:
+  #
+  #   module Faker
+  #     class Generator
+  #       def self.generate
+  #         "be kind"
+  #       end
+  #     end
+  #   end
+  #
+  # To rename it, you need to do the update the name and declare the deprecation by
+  # including the <tt>Deprecator</tt> module and using the deprecate_generator method:
+  #
+  #   module Faker
+  #     class NewGenerator
+  #       def self.generate
+  #         "be kind"
+  #       end
+  #     end
+  #
+  #     include Deprecator
+  #     deprecate_generator('DeprecatedGenerator', NewGenerator)
+  #   end
+  #
+  # The first argument is a constant name (no colons) as a string. It is the name of
+  # the constant you want to deprecate.
+  #
+  # The second argument is the constant path of the replacement (no colons) as a constant.
+  #
+  # For this to work, a +const_missing+ hook is installed. When users
+  # reference the deprecated constant, the callback prints the
+  # message and constantizes the replacement.
+  #
+  # With that in place, references to <tt>Faker::Deprecator</tt> still work, they
+  # evaluate to <tt>Faker::NewGenerator</tt> now, and trigger a deprecation warning:
+  #
+  #   Faker::Generator.generate
+  #   # DEPRECATION WARNING: Faker::Generator is deprecated. Use Faker::NewGenerator instead
+  #   # "be kind"
+  #
+  # For testing the deprecations, we provide <tt>assert_deprecated</tt>
+  # and <tt>assert_not_deprecated</tt> matchers.
+  #
+  # There's also a <tt>Faker::Deprecator.skip_warning</tt> helper to silence
+  # the deprecation messages in the *test* output. Use it for generators that have lots of tests
+  # to avoid too many noise when running the tests.
+  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?
+              deprecated_message = "#{name}::#{replacement[:old_generator]} is deprecated."
+              replacement_message = "Use #{replacement[:new_constant]} instead."
+              $stdout.puts("DEPRECATION WARNING: #{deprecated_message} #{replacement_message}")
+            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
+
+    # Silence deprecation warnings within the block.
+    #
+    #   Faker::Generator.generate
+    #   # => DEPRECATION WARNING: Faker::Generator is deprecated. Use Faker::NewGenerator instead.
+    #
+    #   Faker::Deprecator.skip_warning do
+    #     Faker::Generator.generate
+    #   end
+    #   # => nil
+    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