Skip to content

Commit

Permalink
Add YARD docs for all remaining TV Shows (#1759)
Browse files Browse the repository at this point in the history
* Add YARD docs for Faker::Music::UmphreysMcgee

* Add YARD docs for Buffy the Vampire Slayer.

* Add YARD docs for Aqua Teen Hunger Force.

* Add YARD docs for BoJack Horseman.

* Add YARD docs for Community.

* Add YARD docs for Hey Arnold!

* Add YARD docs for Family Guy.

* Add YARD docs for Friends.

* Add YARD docs for Game of Thrones.

* Add YARD docs for How I Met Your Mother.

* Add YARD docs for Michael Scott.

* Fix some Rubocop warnings.

* Add YARD docs for New Girl.

* Add YARD docs for Parks and Recreation.

* Add YARD docs for Rick and Morty.

* Add YARD docs for RuPaul's Drag Race.

* Add YARD docs for Seinfeld.

* Add YARD docs for Silicon Valley.

* Add YARD docs for The Simpsons

* Add YARD docs for South Park.

* Add YARD docs for Star Trek.

* Add YARD docs for Stargate.

* Add YARD docs for Stranger Things.

* Add YARD docs for The Expanse.

* Add YARD docs for The Fresh Prince of Bel-Air.

* Add YARD docs for The IT Crowd.

* Add YARD docs for The Thick of It.

* Add YARD docs for Twin Peaks.

* Add YARD docs for The Venture Bros.

* Add YARD docs for Dumb and Dumber.

* Fix grammar in Star Trek.
  • Loading branch information
connorshea authored and vbrazo committed Sep 22, 2019
1 parent dcfac66 commit 6ad3be6
Show file tree
Hide file tree
Showing 29 changed files with 827 additions and 0 deletions.
9 changes: 9 additions & 0 deletions lib/faker/music/umphreys_mcgee.rb
Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions lib/faker/tv_shows/aqua_teen_hunger_force.rb
Expand Up @@ -6,6 +6,15 @@ 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
Expand Down
28 changes: 28 additions & 0 deletions lib/faker/tv_shows/bojack_horseman.rb
Expand Up @@ -6,14 +6,42 @@ 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
Expand Down
45 changes: 45 additions & 0 deletions lib/faker/tv_shows/buffy.rb
Expand Up @@ -6,22 +6,67 @@ 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
Expand Down
19 changes: 19 additions & 0 deletions lib/faker/tv_shows/community.rb
Expand Up @@ -6,10 +6,29 @@ 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
Expand Down
28 changes: 28 additions & 0 deletions lib/faker/tv_shows/dumb_and_dumber.rb
Expand Up @@ -6,14 +6,42 @@ class DumbAndDumber < Base
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
Expand Down
28 changes: 28 additions & 0 deletions lib/faker/tv_shows/family_guy.rb
Expand Up @@ -6,14 +6,42 @@ class FamilyGuy < Base
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
Expand Down
27 changes: 27 additions & 0 deletions lib/faker/tv_shows/friends.rb
Expand Up @@ -6,14 +6,41 @@ class Friends < Base
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
Expand Down
46 changes: 46 additions & 0 deletions lib/faker/tv_shows/game_of_thrones.rb
Expand Up @@ -6,22 +6,68 @@ class GameOfThrones < Base
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
Expand Down

0 comments on commit 6ad3be6

Please sign in to comment.