faker 2.4.0 → 2.8.1

data/lib/faker/tv_shows/buffy.rb

@@ -6,22 +6,67 @@ module Faker
       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

@@ -6,10 +6,29 @@ module Faker
       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

@@ -6,30 +6,106 @@ module Faker
       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

data/lib/faker/tv_shows/dumb_and_dumber.rb

@@ -6,14 +6,42 @@ module Faker
       flexible :dumb_and_dumber
 
       class << self
+        ##
+        # Produces an actor from Dumb and Dumber.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::DumbAndDumber.actor #=> "Jim Carrey"
+        #
+        # @faker.version 1.8.5
         def actor
           fetch('dumb_and_dumber.actors')
         end
 
+        ##
+        # Produces a character from Dumb and Dumber.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::DumbAndDumber.character #=> "Harry Dunne"
+        #
+        # @faker.version 1.8.5
         def character
           fetch('dumb_and_dumber.characters')
         end
 
+        ##
+        # Produces a quote from Dumb and Dumber.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::DumbAndDumber.quote
+        #     #=> "Why you going to the airport? Flying somewhere?"
+        #
+        # @faker.version 1.8.5
         def quote
           fetch('dumb_and_dumber.quotes')
         end

data/lib/faker/tv_shows/family_guy.rb

@@ -6,14 +6,42 @@ module Faker
       flexible :family_guy
 
       class << self
+        ##
+        # Produces a character from Family Guy.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::FamilyGuy.character #=> "Peter Griffin"
+        #
+        # @faker.version 1.8.0
         def character
           fetch('family_guy.character')
         end
 
+        ##
+        # Produces a location from Family Guy.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::FamilyGuy.location #=> "James Woods High"
+        #
+        # @faker.version 1.8.0
         def location
           fetch('family_guy.location')
         end
 
+        ##
+        # Produces a quote from Family Guy.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::FamilyGuy.quote
+        #     #=> "It's Peanut Butter Jelly Time."
+        #
+        # @faker.version 1.8.0
         def quote
           fetch('family_guy.quote')
         end

data/lib/faker/tv_shows/friends.rb

@@ -6,14 +6,41 @@ module Faker
       flexible :friends
 
       class << self
+        ##
+        # Produces a character from Friends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Friends.character #=> "Rachel Green"
+        #
+        # @faker.version 1.7.3
         def character
           fetch('friends.characters')
         end
 
+        ##
+        # Produces a location from Friends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Friends.location #=> "Central Perk"
+        #
+        # @faker.version 1.7.3
         def location
           fetch('friends.locations')
         end
 
+        ##
+        # Produces a quote from Friends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Friends.quote #=> "We were on a break!"
+        #
+        # @faker.version 1.7.3
         def quote
           fetch('friends.quotes')
         end

data/lib/faker/tv_shows/game_of_thrones.rb

@@ -6,22 +6,68 @@ module Faker
       flexible :game_of_thrones
 
       class << self
+        ##
+        # Produces a character from Game of Thrones.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::GameOfThrones.character #=> "Tyrion Lannister"
+        #
+        # @faker.version 1.6.6
         def character
           fetch('game_of_thrones.characters')
         end
 
+        ##
+        # Produces a house from Game of Thrones.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::GameOfThrones.house #=> "Stark"
+        #
+        # @faker.version 1.6.6
         def house
           fetch('game_of_thrones.houses')
         end
 
+        ##
+        # Produces a city from Game of Thrones.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::GameOfThrones.city #=> "Lannisport"
+        #
+        # @faker.version 1.6.6
         def city
           fetch('game_of_thrones.cities')
         end
 
+        ##
+        # Produces a quote from Game of Thrones.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::GameOfThrones.quote
+        #     #=> "Never forget who you are. The rest of the world won't. Wear it like an armor and it can never be used against you."
+        #
+        # @faker.version 1.6.6
         def quote
           fetch('game_of_thrones.quotes')
         end
 
+        ##
+        # Produces a dragon from Game of Thrones.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::GameOfThrones.dragon #=> "Drogon"
+        #
+        # @faker.version 1.6.6
         def dragon
           fetch('game_of_thrones.dragons')
         end

data/lib/faker/tv_shows/hey_arnold.rb

@@ -6,14 +6,41 @@ module Faker
       flexible :hey_arnold
 
       class << self
+        ##
+        # Produces a character from Hey Arnold!
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::HeyArnold.character #=> "Arnold"
+        #
+        # @faker.version 1.8.0
         def character
           fetch('hey_arnold.characters')
         end
 
+        ##
+        # Produces a location from Hey Arnold!
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::HeyArnold.location #=> "Big Bob's Beeper Emporium"
+        #
+        # @faker.version 1.8.0
         def location
           fetch('hey_arnold.locations')
         end
 
+        ##
+        # Produces a quote from Hey Arnold!
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::HeyArnold.quote #=> "Stoop Kid's afraid to leave his stoop!"
+        #
+        # @faker.version 1.8.0
         def quote
           fetch('hey_arnold.quotes')
         end