faker 2.13.0 → 3.8.0

data/lib/faker/music/pearl_jam.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'music'
-
 module Faker
   class Music
     class PearlJam < Base

data/lib/faker/music/rock_band.rb

@@ -16,6 +16,18 @@ module Faker
         def name
           fetch('rock_band.name')
         end
+
+        # Produces a rock song.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::RockBand.song #=> "Dani California"
+        #
+        # @faker.version next
+        def song
+          fetch('rock_band.song')
+        end
       end
     end
   end

data/lib/faker/music/rush.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'music'
-
 module Faker
   class Music
     class Rush < Base

data/lib/faker/music/smashing_pumpkins.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Faker
+  class Music
+    class SmashingPumpkins < Base
+      class << self
+        ##
+        # Produces the name of a member of the Smashing Pumpkins (current and former)
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::SmashingPumpkins.musician #=> "Billy Corgan"
+        #
+        # @faker.version next
+        def musician
+          fetch('smashing_pumpkins.musicians')
+        end
+
+        ##
+        # Produces the name of an album by the Smashing Pumpkins.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::SmashingPumpkins.album #=> "Siamese Dream"
+        #
+        # @faker.version next
+        def album
+          fetch('smashing_pumpkins.albums')
+        end
+
+        ##
+        # Produces a random Smashing Pumpkins song lyric.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::SmashingPumpkins.lyric #=> "Despite all my rage, I am still just a rat in a cage"
+        #   Faker::Music::SmashingPumpkins.lyric #=> "Breathin' underwater, and livin' under glass"
+        #
+        # @faker.version next
+        def lyric
+          fetch('smashing_pumpkins.lyric')
+        end
+
+        ##
+        # Produces the name of a song by the Smashing Pumpkins.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::SmashingPumpkins.song #=> "Stand Inside My Love"
+        #
+        # @faker.version next
+        def song
+          fetch('smashing_pumpkins.songs')
+        end
+      end
+    end
+  end
+end

data/lib/faker/{music/music.rb → music.rb}

@@ -2,6 +2,10 @@
 
 module Faker
   class Music < Base
+    if Faker::Config.lazy_loading?
+      Faker.lazy_load(self)
+    end
+
     class << self
       NOTE_LETTERS = %w[C D E F G A B].freeze
       ACCIDENTAL_SIGNS = ['b', '#', ''].freeze
@@ -128,6 +132,18 @@ module Faker
       def genre
         fetch('music.genres')
       end
+
+      ##
+      # Produces a name from Lou Bega's Mambo #5
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Music.mambo #=> "Monica"
+      # @faker.version next
+      def mambo_no_5
+        fetch('music.mambo_no_5')
+      end
     end
   end
 end

data/lib/faker/quotes/rajnikanth.rb

@@ -6,6 +6,7 @@ module Faker
       flexible :rajnikanth
 
       class << self
+        ##
         # Produces a Rajnikanth.
         # Original list of jokes:
         # http://www.rajinikanthjokes.com/

data/lib/faker/quotes/shakespeare.rb

@@ -56,18 +56,52 @@ module Faker
           sample(romeo_and_juliet)
         end
 
+        ##
+        # Generates quote from Hamlet
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.hamlet   #=> "A little more than kin, and less than kind."
+        #
+        # @faker.version 1.9.2
         def hamlet
           fetch('shakespeare.hamlet')
         end
 
+        ##
+        # Generates quote from 'As you like it!'
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.as_you_like_it   #=> "How bitter a thing it is to look into happiness through another man's eyes!"
+        #
+        # @faker.version 1.9.2
         def as_you_like_it
           fetch('shakespeare.as_you_like_it')
         end
 
+        ##
+        # Returns quote from 'King Rechard III'
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare  #=> "The king's name is a tower of strength."
         def king_richard_iii
           fetch('shakespeare.king_richard_iii')
         end
 
+        ##
+        # Quote from 'Romeo and Juliet'
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.romeo_and_juliet  #=> "Wisely and slow; they stumble that run fast."
+        #
+        # @faker.version 1.9.2
         def romeo_and_juliet
           fetch('shakespeare.romeo_and_juliet')
         end

data/lib/faker/quotes.rb

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

data/lib/faker/religion/bible.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Faker
+  class Religion
+    class Bible < Base
+      flexible :bible
+
+      class << self
+        ##
+        # Returns a random bible character.
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Religion::Bible.character #=> "Jesus"
+        #
+        # @faker.version next
+        def character
+          fetch('bible.character')
+        end
+
+        ##
+        # Returns a random location(city or town) from the bible
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Religion::Bible.location #=> "Nasareth"
+        #
+        # @faker.version next
+        def location
+          fetch('bible.location')
+        end
+
+        ##
+        # Returns a random quote from the location.
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Religion::Bible.quote #=> "Seek first the kingdom of God "
+        #
+        # @faker.version next
+        def quote
+          fetch('bible.quote')
+        end
+      end
+    end
+  end
+end

data/lib/faker/religion.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Faker
+  class Religion
+    if Faker::Config.lazy_loading?
+      Faker.lazy_load(self)
+    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/sports/mountaineering.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Faker
+  class Sports
+    class Mountaineering < Base
+      class << self
+        ##
+        # Produces the name of a Mountaineer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Mountaineering.mountaineer #=> "Junko Tabei"
+        #
+        # @faker.version next
+        def mountaineer
+          fetch('mountaineering.mountaineer')
+        end
+      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/sports.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Faker
+  class Sports
+    if Faker::Config.lazy_loading?
+      Faker.lazy_load(self)
+    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/travel.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Faker
+  class Travel
+    if Faker::Config.lazy_loading?
+      Faker.lazy_load(self)
+    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/buffy.rb

@@ -33,16 +33,16 @@ 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.celebrity #=> "John Ritter"
+        #   Faker::TvShows::Buffy.actor #=> "John Ritter"
         #
-        # @faker.version 1.9.2
-        def celebrity
-          fetch('buffy.celebrities')
+        # @faker.version next
+        def actor
+          fetch('buffy.actors')
         end
 
         ##