faker 1.9.6 → 2.7.0

data/lib/faker/music/rock_band.rb

@@ -4,6 +4,15 @@ module Faker
   class Music
     class RockBand < Base
       class << self
+        ##
+        # Produces the name of a rock band.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::RockBand.name #=> "Led Zeppelin"
+        #
+        # @faker.version 1.7.0
         def name
           fetch('rock_band.name')
         end

data/lib/faker/music/umphreys_mcgee.rb

@@ -4,6 +4,15 @@ module Faker
   class Music
     class UmphreysMcgee < Base
       class << self
+        ##
+        # Produces the name of a song by Umphrey's McGee.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::UmphreysMcgee.song #=> "Dump City"
+        #
+        # @faker.version 1.8.3
         def song
           fetch('umphreys_mcgee.song')
         end

data/lib/faker/sports/basketball.rb

@@ -4,18 +4,54 @@ module Faker
   class Sports
     class Basketball < Base
       class << self
+        ##
+        # Produces the name of a basketball team.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Basketball.team #=> "Golden State Warriors"
+        #
+        # @faker.version 1.9.4
         def team
           fetch('basketball.teams')
         end
 
+        ##
+        # Produces the name of a basketball player.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Basketball.player #=> "LeBron James"
+        #
+        # @faker.version 1.9.4
         def player
           fetch('basketball.players')
         end
 
+        ##
+        # Produces the name of a basketball coach.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Basketball.coach #=> "Gregg Popovich"
+        #
+        # @faker.version 1.9.4
         def coach
           fetch('basketball.coaches')
         end
 
+        ##
+        # Produces a position in basketball.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Basketball.position #=> "Point Guard"
+        #
+        # @faker.version 1.9.4
         def position
           fetch('basketball.positions')
         end

data/lib/faker/sports/football.rb

@@ -4,22 +4,67 @@ module Faker
   class Sports
     class Football < Base
       class << self
+        ##
+        # Produces the name of a football team.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Football.team #=> "Manchester United"
+        #
+        # @faker.version 1.9.0
         def team
           fetch('football.teams')
         end
 
+        ##
+        # Produces the name of a football player.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Football.player #=> "Lionel Messi"
+        #
+        # @faker.version 1.9.0
         def player
           fetch('football.players')
         end
 
+        ##
+        # Produces the name of a football coach.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Football.coach #=> "Jose Mourinho"
+        #
+        # @faker.version 1.9.0
         def coach
           fetch('football.coaches')
         end
 
+        ##
+        # Produces a football competition.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Football.competition #=> "FIFA World Cup"
+        #
+        # @faker.version 1.9.0
         def competition
           fetch('football.competitions')
         end
 
+        ##
+        # Produces a position in football.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Football.position #=> "Defensive Midfielder"
+        #
+        # @faker.version 1.9.2
         def position
           fetch('football.positions')
         end

data/lib/faker/tv_shows/aqua_teen_hunger_force.rb

@@ -1,11 +1,20 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     class AquaTeenHungerForce < Base
       flexible :aqua_teen_hunger_force
 
       class << self
+        ##
+        # Produces a character from Aqua Teen Hunger Force.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::AquaTeenHungerForce.character #=> "Master Shake"
+        #
+        # @faker.version 1.8.5
         def character
           fetch('aqua_teen_hunger_force.character')
         end

data/lib/faker/tv_shows/bojack_horseman.rb

@@ -1,19 +1,47 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     class BojackHorseman < Base
       flexible :bojack_horseman
 
       class << self
+        ##
+        # Produces a character from BoJack Horseman.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BojackHorseman.character #=> "BoJack Horseman"
+        #
+        # @faker.version 1.9.0
         def character
           fetch('bojack_horseman.characters')
         end
 
+        ##
+        # Produces a tongue twister from BoJack Horseman.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BojackHorseman.tongue_twister #=> "Did you steal a meal from Neal McBeal the Navy Seal?"
+        #
+        # @faker.version 1.9.0
         def tongue_twister
           fetch('bojack_horseman.tongue_twisters')
         end
 
+        ##
+        # Produces a quote from BoJack Horseman.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BojackHorseman.quote
+        #     #=> "Not understanding that you're a horrible person doesn't make you less of a horrible person."
+        #
+        # @faker.version 1.9.0
         def quote
           fetch('bojack_horseman.quotes')
         end

data/lib/faker/tv_shows/breaking_bad.rb

@@ -1,15 +1,33 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     class BreakingBad < Base
       flexible :breaking_bad
 
       class << self
+        ##
+        # Produces the name of a character from Breaking Bad.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BreakingBad.character #=> "Walter White"
+        #
+        # @faker.version 1.8.8
         def character
           fetch('breaking_bad.character')
         end
 
+        ##
+        # Produces the name of an episode from Breaking Bad.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BreakingBad.episode #=> "Fly"
+        #
+        # @faker.version 1.8.8
         def episode
           fetch('breaking_bad.episode')
         end

data/lib/faker/tv_shows/buffy.rb

@@ -1,27 +1,72 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     class Buffy < Base
       flexible :buffy
 
       class << self
+        ##
+        # Produces a character from Buffy the Vampire Slayer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Buffy.character #=> "Buffy Summers"
+        #
+        # @faker.version 1.9.2
         def character
           fetch('buffy.characters')
         end
 
+        ##
+        # Produces a quote from Buffy the Vampire Slayer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Buffy.quote #=> "If the apocalypse comes, beep me."
+        #
+        # @faker.version 1.9.2
         def quote
           fetch('buffy.quotes')
         end
 
+        ##
+        # Produces a celebrity from Buffy the Vampire Slayer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Buffy.celebrity #=> "John Ritter"
+        #
+        # @faker.version 1.9.2
         def celebrity
           fetch('buffy.celebrities')
         end
 
+        ##
+        # Produces a big bad from Buffy the Vampire Slayer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Buffy.big_bad #=> "Glory"
+        #
+        # @faker.version 1.9.2
         def big_bad
           fetch('buffy.big_bads')
         end
 
+        ##
+        # Produces an episode from Buffy the Vampire Slayer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Buffy.episode #=> "Once More, with Feeling"
+        #
+        # @faker.version 1.9.2
         def episode
           fetch('buffy.episodes')
         end

data/lib/faker/tv_shows/community.rb

@@ -1,15 +1,34 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     class Community < Base
       flexible :community
 
       class << self
+        ##
+        # Produces a character from Community.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Community.characters #=> "Jeff Winger"
+        #
+        # @faker.version 1.9.0
         def characters
           fetch('community.characters')
         end
 
+        ##
+        # Produces a quote from Community.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Community.quotes
+        #     #=> "I fear a political career could shine a negative light on my drug dealing."
+        #
+        # @faker.version 1.9.0
         def quotes
           fetch('community.quotes')
         end

data/lib/faker/tv_shows/dr_who.rb

@@ -1,35 +1,111 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     class DrWho < Base
       flexible :dr_who
 
       class << self
+        ##
+        # Produces a character from Doctor Who.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::DrWho.character #=> "Captain Jack Harkness"
+        #
+        # @faker.version 1.8.0
         def character
           fetch('dr_who.character')
         end
 
+        ##
+        # Produces an iteration of The Doctor from Doctor Who.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::DrWho.the_doctor #=> "Ninth Doctor"
+        #
+        # @faker.version 1.8.0
         def the_doctor
           fetch('dr_who.the_doctors')
         end
 
+        ##
+        # Produces an actor from Doctor Who.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::DrWho.actor #=> "Matt Smith"
+        #
+        # @faker.version 1.9.0
         def actor
           fetch('dr_who.actors')
         end
 
+        ##
+        # Produces a catch phrase from Doctor Who.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::DrWho.catch_phrase #=> "Fantastic!"
+        #
+        # @faker.version 1.8.0
         def catch_phrase
           fetch('dr_who.catch_phrases')
         end
 
+        ##
+        # Produces a quote from Doctor Who.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::DrWho.quote #=> "Lots of planets have a north!"
+        #
+        # @faker.version 1.8.0
         def quote
           fetch('dr_who.quotes')
         end
 
-        def villian
-          fetch('dr_who.villians')
+        ##
+        # Produces a villain from Doctor Who.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::DrWho.villain #=> "The Master"
+        #
+        # @faker.version next
+        def villain
+          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.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::DrWho.specie #=> "Dalek"
+        #
+        # @faker.version 1.8.0
         def specie
           fetch('dr_who.species')
         end