faker 3.1.1 → 3.2.1

data/lib/faker/games/dnd.rb

@@ -43,6 +43,19 @@ module Faker
           fetch('dnd.cities')
         end
 
+        ##
+        # Produces the first name of a character or monster from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.name #=> "Eilonwy"
+        #
+        # @faker.version next
+        def first_name
+          fetch('dnd.name.first_name')
+        end
+
         ##
         # Produces the name of a class from Dungeons and Dragons (PHB).
         #
@@ -69,6 +82,19 @@ module Faker
           fetch('dnd.languages')
         end
 
+        ##
+        # Produces a last name from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.last_name #=> "Leafwhisper"
+        #
+        # @faker.version next
+        def last_name
+          fetch('dnd.name.last_name')
+        end
+
         ##
         # Produces the name of a melee weapon from Dungeons and Dragons.
         #
@@ -95,6 +121,19 @@ module Faker
           fetch('dnd.monsters')
         end
 
+        ##
+        # Produces a full name from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.name #=> "Drakon Blackthorn"
+        #
+        # @faker.version next
+        def name
+          "#{fetch('dnd.name.first_name')} #{fetch('dnd.name.last_name')}"
+        end
+
         ##
         # Produces the name of a race from Dungeons and Dragons (PHB).
         #
@@ -121,14 +160,17 @@ module Faker
           fetch('dnd.ranged_weapons')
         end
 
-        # This method is deprecated. The implementation will be removed in a near future release.
-        # Use `DnD.race` instead.
+        ##
+        # Produces a last name from Dungeons and Dragons.
         #
-        # @deprecated Use {#race} instead.
-        def species
-          warn '`DnD.species` is deprecated. Use `DnD.race` instead.'
-
-          super
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.title_name #=> "Corvus the Cunning"
+        #
+        # @faker.version next
+        def title_name
+          "#{fetch('dnd.name.first_name')} #{fetch('dnd.name.title')}"
         end
       end
     end

data/lib/faker/games/final_fantasy_xiv.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class FinalFantasyXIV < Base
+      class << self
+        ##
+        # Produces the name of a character from FFXIV.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.character #=> "Y'shtola Rhul"
+        #
+        # @faker.version next
+        def character
+          fetch('games.final_fantasy_xiv.characters')
+        end
+
+        ##
+        # Produces a job name from Final Fantasy XIV. Either a battle or non-battle playable job.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.job #=> "Paladin"
+        #
+        # @faker.version next
+        def job
+          fetch('games.final_fantasy_xiv.jobs')
+        end
+
+        # Produces the name of a playable race from Final Fantasy XIV.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.race #=> "Miqo'te"
+        #
+        # @faker.version next
+        def race
+          fetch('games.final_fantasy_xiv.races')
+        end
+
+        ##
+        # Produces a data center from Final Fantasy XIV.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.data_center #=> "Aether"
+        #
+        # @faker.version next
+        def data_center
+          fetch('games.final_fantasy_xiv.data_centers')
+        end
+
+        ##
+        # Produces a geographical zone from Final Fantasy XIV.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.zone #=> "Eastern La Noscea"
+        #
+        # @faker.version next
+        def zone
+          fetch('games.final_fantasy_xiv.zones')
+        end
+      end
+    end
+  end
+end

data/lib/faker/movies/avatar.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Faker
+  class Movies
+    class Avatar < Base
+      class << self
+        ##
+        # Produces a character from Avatar.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Avatar.character #=> "Jake Sully"
+        #
+        # @faker.version next
+        def character
+          fetch('avatar.characters')
+        end
+
+        ##
+        # Produces a date from Avatar.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Avatar.date #=> "December 15, 2022"
+        #
+        # @faker.version next
+        def date
+          fetch('avatar.dates')
+        end
+
+        ##
+        # Produces a quote from Avatar.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Avatar.quote
+        #     #=> "If it ain't raining, we ain't training."
+        #
+        # @faker.version next
+        def quote
+          fetch('avatar.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/quotes/quote.rb

@@ -106,6 +106,19 @@ module Faker
       def fortune_cookie
         fetch('quote.fortune_cookie')
       end
+
+      ##
+      # Produces a quote from comedian Mitch Hedberg.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.mitch_hedberg # => "I like Kit-Kats, unless I'm with four or more people."
+      #
+      # @faker.version next
+      def mitch_hedberg
+        fetch('quote.mitch_hedberg')
+      end
     end
   end
 end

data/lib/faker/sports/chess.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Faker
+  class Sports
+    class Chess < Base
+      class << self
+        ##
+        # Produces the name of a chess player name.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Chess.player #=> "Golden State Warriors"
+        #
+        # @faker.version next
+        def player
+          fetch('chess.players')
+        end
+
+        ##
+        # Produces a long (alpha-3) ISO 3166 country code.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Chess.federation #=> "COL"
+        #
+        # @faker.version next
+        def federation
+          Faker::Address.country_code_long
+        end
+
+        def tournament
+          ##
+          # Produces the name of a famous chess tournament name.
+          #
+          # @return [String]
+          #
+          # @example
+          #   Faker::Chess.tournament #=> "Khanty-Mansisyk (Candidates Tournament)"
+          #
+          # @faker.version next
+          fetch('chess.tournaments')
+        end
+
+        def rating(from: 2000, to: 2900)
+          ##
+          # Produces a rating between two provided values. Boundaries are inclusive.
+          #
+          # @param from [Numeric] The lowest number to include.
+          # @param to [Numeric] The highest number to include.
+          # @return [Numeric]
+          #
+          # @example
+          #   Faker::Sports::Chess.rating #=> 2734
+          #   Faker::Sports::Chess.rating(from: 2400, to: 2700) #=> 2580
+          #
+          # @faker.version next
+          Faker::Base.rand_in_range(from, to)
+        end
+
+        ##
+        # Produces the name of a chess opening.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Chess.opening #=> "Giuoco Piano"
+        #
+        # @faker.version next
+        def opening
+          fetch('chess.openings')
+        end
+
+        ##
+        # Produces a chess title.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Chess.title #=> "GM"
+        #
+        # @faker.version next
+        def title
+          fetch('chess.titles')
+        end
+      end
+    end
+  end
+end

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"
@@ -19,8 +19,6 @@ module Faker
         # @faker.version next
         def name(size:, region:)
           fetch("airport.#{region}.#{size}")
-        rescue I18n::MissingTranslationData
-          p 'valid arguments are size && region -> US has size large medium small, EU has size large medium -- united_states || european_union'
         end
 
         ##
@@ -30,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"
@@ -38,8 +36,6 @@ module Faker
         # @faker.version next
         def iata(size:, region:)
           fetch("airport.#{region}.iata_code.#{size}")
-        rescue I18n::MissingTranslationData
-          p 'valid arguments are size && region -> US has size large medium small, EU has size large medium -- united_states || european_union'
         end
       end
     end

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

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

data/lib/faker.rb

@@ -8,18 +8,21 @@ require 'i18n'
 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
+    @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
@@ -49,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.
@@ -85,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