faker 2.11.0 → 3.4.2

data/lib/faker/sports/sport.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Faker
+  class Sport < Base
+    class << self
+      ##
+      # Produces a sport from the modern olympics or paralympics, summer or winter.
+      #
+      # @param include_ancient [Boolean] If true, may produce a sport from the ancient olympics
+      # @param include_unusual [Boolean] If true, may produce an unusual (definitely not olympic) sport
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.sport #=> "Football"
+      # @example
+      #   Faker::Sport.sport(include_ancient: true) #=> "Chariot racing"
+      # @example
+      #   Faker::Sport.sport(include_unsual: true) #=> "Flugtag/Birdman"
+      # @example
+      #   Faker::Sport.sport(include_ancient:true, include_unusual: true) #=> "Water polo"
+      #
+      # @faker.version next
+      def sport(include_ancient: false, include_unusual: false)
+        sports = []
+        sports.concat(
+          fetch_all('sport.summer_olympics'),
+          fetch_all('sport.summer_paralympics'),
+          fetch_all('sport.winter_olympics'),
+          fetch_all('sport.winter_paralympics')
+        )
+        sports.concat(fetch_all('sport.ancient_olympics')) if include_ancient
+        sports.concat(fetch_all('sport.unusual')) if include_unusual
+        sample(sports)
+      end
+
+      ##
+      # Produces a sport from the summer olympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.summer_olympics_sport #=> "Archery"
+      #
+      # @faker.version next
+      def summer_olympics_sport
+        fetch('sport.summer_olympics')
+      end
+
+      ##
+      # Produces a sport from the winter olympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.winter_olympics_sport #=> "Bobsleigh"
+      #
+      # @faker.version next
+      def winter_olympics_sport
+        fetch('sport.winter_olympics')
+      end
+
+      ##
+      # Produces a sport from the summer paralympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.summer_paralympics_sport #=> "Wheelchair Basketball"
+      #
+      # @faker.version next
+      def summer_paralympics_sport
+        fetch('sport.summer_paralympics')
+      end
+
+      ##
+      # Produces a sport from the winter paralympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.winter_paralympics_sport #=> "Para Ice Hockey"
+      #
+      # @faker.version next
+      def winter_paralympics_sport
+        fetch('sport.winter_paralympics')
+      end
+
+      ##
+      # Produces an unusual sport.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.unusual_sport #=> "Camel Jumping"
+      #
+      # @faker.version next
+      def unusual_sport
+        fetch('sport.unusual')
+      end
+
+      ##
+      # Produces a sport from the ancient olympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.ancient_olympics_sport #=> "Pankration"
+      #
+      # @faker.version next
+      def ancient_olympics_sport
+        fetch('sport.ancient_olympics')
+      end
+    end
+  end
+end

data/lib/faker/sports/volleyball.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Faker
+  class Sports
+    class Volleyball < Base
+      class << self
+        ##
+        # Produces the name of a volleyball team.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Volleyball.team #=> "Leo Shoes Modena"
+        #
+        # @faker.version next
+        def team
+          fetch('volleyball.team')
+        end
+
+        ##
+        # Produces the name of a volleyball player.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Volleyball.player #=> "Saeid Marouf"
+        #
+        # @faker.version next
+        def player
+          fetch('volleyball.player')
+        end
+
+        ##
+        # Produces the name of a volleyball coach.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Volleyball.coach #=> "Russ Rose"
+        #
+        # @faker.version next
+        def coach
+          fetch('volleyball.coach')
+        end
+
+        ##
+        # Produces a position in volleyball.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Volleyball.position #=> "Middle blocker"
+        #
+        # @faker.version next
+        def position
+          fetch('volleyball.position')
+        end
+
+        ##
+        # Produces a formation in volleyball.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Volleyball.formation #=> "4-2"
+        #
+        # @faker.version next
+        def formation
+          fetch('volleyball.formation')
+        end
+      end
+    end
+  end
+end

data/lib/faker/travel/airport.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Faker
+  class Travel
+    class Airport < Base
+      class << self
+        ##
+        # Produces random Airport by name and takes arguments for size and region
+        #
+        # @param size [String] airport size, united_states has large, or medium, or small, european_union has large, or medium
+        #
+        # @param region [String] airport region, currently available -> united_states or european_union
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Travel::Airport.name(size: 'large', region: 'united_states') => "Los Angeles International Airport"
+        #
+        # @faker.version next
+        def name(size:, region:)
+          fetch("airport.#{region}.#{size}")
+        end
+
+        ##
+        # Produces random Airport by IATA code and takes arguments for size and region
+        #
+        # @param size [String] airport size, united_states has large, or medium, or small, european_union has large, or medium
+        #
+        # @param region [String] airport region, currently available -> united_states or european_union
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Travel::Airport.iata(size: 'large', region: 'united_states') => "LAX"
+        #
+        # @faker.version next
+        def iata(size:, region:)
+          fetch("airport.#{region}.iata_code.#{size}")
+        end
+      end
+    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/aqua_teen_hunger_force.rb

@@ -18,6 +18,19 @@ module Faker
         def character
           fetch('aqua_teen_hunger_force.character')
         end
+
+        ##
+        # Produces a perl of great ATHF wisdom
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::AquaTeenHungerForce.quote #=> "Friendship ain't about trust. Friendship's about nunchucks."
+        #
+        # @faker.version 2.13.0
+        def quote
+          fetch('aqua_teen_hunger_force.quote')
+        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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class BigBangTheory < Base
+      flexible :big_bang_theory
+
+      class << self
+        ##
+        # Produces a character from Big Bang Theory
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BigBangTheory.character #=> "Sheldon Cooper"
+        #
+        # @faker.version 2.13.0
+        def character
+          fetch('big_bang_theory.characters')
+        end
+
+        ##
+        # Produces a quote from Bing Bang Theory
+        #
+        # @return [String]
+        #
+        # @example
+        #  Faker::TvShows::BigBangTheory.quote #=> "I'm not crazy. My mother had me tested."
+        #
+        # @faker.version 2.13.0
+        def quote
+          fetch('big_bang_theory.quotes')
+        end
+      end
+    end
+  end
+end

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

@@ -33,17 +33,30 @@ module Faker
         end
 
         ##
-        # Produces a celebrity from Buffy the Vampire Slayer.
+        # Produces a actor from Buffy the Vampire Slayer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Buffy.actor #=> "John Ritter"
+        #
+        # @faker.version next
+        def actor
+          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
-        def celebrity
-          fetch('buffy.celebrities')
-        end
+        alias celebrity actor
 
         ##
         # Produces a big bad from Buffy the Vampire Slayer.

data/lib/faker/tv_shows/dr_who.rb

@@ -79,7 +79,7 @@ module Faker
         # @example
         #   Faker::TvShows::DrWho.villain #=> "The Master"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def villain
           fetch('dr_who.villains')
         end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class Futurama < Base
+      flexible :futurama
+
+      class << self
+        ##
+        # Produces a character from Futurama.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Futurama.character #=> "Amy Wong"
+        #
+        # @faker.version 2.13.0
+        def character
+          fetch('futurama.characters')
+        end
+
+        ##
+        # Produces a location from Futurama.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Futurama.location #=> "Wormulon"
+        #
+        # @faker.version 2.13.0
+        def location
+          fetch('futurama.locations')
+        end
+
+        ##
+        # Produces a quote from Futurama.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Futurama.quote
+        #     #=> "Ugh, it's like a party in my mouth & everyone's throwing up."
+        #
+        # @faker.version 2.13.0
+        def quote
+          fetch('futurama.quotes')
+        end
+
+        ##
+        # Produces a catchphrase from Hermes Conrad.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Futurama.hermes_catchphrase
+        #     #=> "Great foo of bar!"
+        #
+        # @faker.version 2.13.0
+        def hermes_catchphrase
+          fetch('futurama.hermes_catchphrases')
+        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/simpsons.rb

@@ -45,6 +45,20 @@ module Faker
         def quote
           fetch('simpsons.quotes')
         end
+
+        ##
+        # Produces an episode title from The Simpsons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Simpsons.episode_title
+        #     #=> "Two Cars in Every Garage and Three Eyes on Every Fish"
+        #
+        # @faker.version 2.13.0
+        def episode_title
+          fetch('simpsons.episode_titles')
+        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