From e84eef3f7c3e95da04ad45f7d2c8a88b083cedce Mon Sep 17 00:00:00 2001 From: Connor Shea Date: Sun, 22 Sep 2019 15:42:37 -0600 Subject: [PATCH] Add YARD docs for all remaining TV Shows (#1759) * 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. --- lib/faker/music/umphreys_mcgee.rb | 9 +++ lib/faker/tv_shows/aqua_teen_hunger_force.rb | 9 +++ lib/faker/tv_shows/bojack_horseman.rb | 28 +++++++ lib/faker/tv_shows/buffy.rb | 45 +++++++++++ lib/faker/tv_shows/community.rb | 19 +++++ lib/faker/tv_shows/dumb_and_dumber.rb | 28 +++++++ lib/faker/tv_shows/family_guy.rb | 28 +++++++ lib/faker/tv_shows/friends.rb | 27 +++++++ lib/faker/tv_shows/game_of_thrones.rb | 46 ++++++++++++ lib/faker/tv_shows/hey_arnold.rb | 27 +++++++ lib/faker/tv_shows/how_i_met_your_mother.rb | 37 +++++++++ lib/faker/tv_shows/michael_scott.rb | 13 ++++ lib/faker/tv_shows/new_girl.rb | 19 +++++ lib/faker/tv_shows/parks_and_rec.rb | 18 +++++ lib/faker/tv_shows/rick_and_morty.rb | 28 +++++++ lib/faker/tv_shows/ru_paul.rb | 18 +++++ lib/faker/tv_shows/seinfeld.rb | 28 +++++++ lib/faker/tv_shows/silicon_valley.rb | 75 +++++++++++++++++++ lib/faker/tv_shows/simpsons.rb | 28 +++++++ lib/faker/tv_shows/south_park.rb | 19 +++++ lib/faker/tv_shows/star_trek.rb | 36 +++++++++ lib/faker/tv_shows/stargate.rb | 28 +++++++ lib/faker/tv_shows/stranger_things.rb | 19 +++++ lib/faker/tv_shows/the_expanse.rb | 36 +++++++++ .../tv_shows/the_fresh_prince_of_bel_air.rb | 28 +++++++ lib/faker/tv_shows/the_it_crowd.rb | 37 +++++++++ lib/faker/tv_shows/the_thick_of_it.rb | 28 +++++++ lib/faker/tv_shows/twin_peaks.rb | 28 +++++++ lib/faker/tv_shows/venture_bros.rb | 38 ++++++++++ 29 files changed, 827 insertions(+) diff --git a/lib/faker/music/umphreys_mcgee.rb b/lib/faker/music/umphreys_mcgee.rb index 2bb494d7c6..a336aab4ac 100644 --- a/lib/faker/music/umphreys_mcgee.rb +++ b/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 diff --git a/lib/faker/tv_shows/aqua_teen_hunger_force.rb b/lib/faker/tv_shows/aqua_teen_hunger_force.rb index f7fb962baa..01f120d8a2 100644 --- a/lib/faker/tv_shows/aqua_teen_hunger_force.rb +++ b/lib/faker/tv_shows/aqua_teen_hunger_force.rb @@ -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 diff --git a/lib/faker/tv_shows/bojack_horseman.rb b/lib/faker/tv_shows/bojack_horseman.rb index 63bd0545ca..7539ab5677 100644 --- a/lib/faker/tv_shows/bojack_horseman.rb +++ b/lib/faker/tv_shows/bojack_horseman.rb @@ -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 diff --git a/lib/faker/tv_shows/buffy.rb b/lib/faker/tv_shows/buffy.rb index d6fecf700e..10923ed6ec 100644 --- a/lib/faker/tv_shows/buffy.rb +++ b/lib/faker/tv_shows/buffy.rb @@ -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 diff --git a/lib/faker/tv_shows/community.rb b/lib/faker/tv_shows/community.rb index 74ab2f6072..ebee983011 100644 --- a/lib/faker/tv_shows/community.rb +++ b/lib/faker/tv_shows/community.rb @@ -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 diff --git a/lib/faker/tv_shows/dumb_and_dumber.rb b/lib/faker/tv_shows/dumb_and_dumber.rb index 873e391027..53aec85975 100644 --- a/lib/faker/tv_shows/dumb_and_dumber.rb +++ b/lib/faker/tv_shows/dumb_and_dumber.rb @@ -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 diff --git a/lib/faker/tv_shows/family_guy.rb b/lib/faker/tv_shows/family_guy.rb index d5f3b60ee3..71c94a2196 100644 --- a/lib/faker/tv_shows/family_guy.rb +++ b/lib/faker/tv_shows/family_guy.rb @@ -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 diff --git a/lib/faker/tv_shows/friends.rb b/lib/faker/tv_shows/friends.rb index 96ee256564..13c63ab5f7 100644 --- a/lib/faker/tv_shows/friends.rb +++ b/lib/faker/tv_shows/friends.rb @@ -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 diff --git a/lib/faker/tv_shows/game_of_thrones.rb b/lib/faker/tv_shows/game_of_thrones.rb index 85042a000d..4469772c36 100644 --- a/lib/faker/tv_shows/game_of_thrones.rb +++ b/lib/faker/tv_shows/game_of_thrones.rb @@ -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 diff --git a/lib/faker/tv_shows/hey_arnold.rb b/lib/faker/tv_shows/hey_arnold.rb index 3e0377e8f0..4126a238a2 100644 --- a/lib/faker/tv_shows/hey_arnold.rb +++ b/lib/faker/tv_shows/hey_arnold.rb @@ -6,14 +6,41 @@ class HeyArnold < Base 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 diff --git a/lib/faker/tv_shows/how_i_met_your_mother.rb b/lib/faker/tv_shows/how_i_met_your_mother.rb index 2ed3864dc5..f8a985aec0 100644 --- a/lib/faker/tv_shows/how_i_met_your_mother.rb +++ b/lib/faker/tv_shows/how_i_met_your_mother.rb @@ -6,18 +6,55 @@ class HowIMetYourMother < Base flexible :how_i_met_your_mother class << self + ## + # Produces a character from How I Met Your Mother. + # + # @return [String] + # + # @example + # Faker::TvShows::HowIMetYourMother.character #=> "Barney Stinson" + # + # @faker.version 1.8.0 def character fetch('how_i_met_your_mother.character') end + ## + # Produces a catch phrase from How I Met Your Mother. + # + # @return [String] + # + # @example + # Faker::TvShows::HowIMetYourMother.catch_phrase #=> "Legendary" + # + # @faker.version 1.8.0 def catch_phrase fetch('how_i_met_your_mother.catch_phrase') end + ## + # Produces a high five from How I Met Your Mother. + # + # @return [String] + # + # @example + # Faker::TvShows::HowIMetYourMother.high_five #=> "Relapse Five" + # + # @faker.version 1.8.0 def high_five fetch('how_i_met_your_mother.high_five') end + ## + # Produces a quote from How I Met Your Mother. + # + # @return [String] + # + # @example + # Faker::TvShows::HowIMetYourMother.quote + # #=> "Whenever I'm sad, I stop being sad and be awesome instead." + # + # @faker.version 1.8.0 def quote fetch('how_i_met_your_mother.quote') end diff --git a/lib/faker/tv_shows/michael_scott.rb b/lib/faker/tv_shows/michael_scott.rb index 9e2ff8c042..c5ff88011b 100644 --- a/lib/faker/tv_shows/michael_scott.rb +++ b/lib/faker/tv_shows/michael_scott.rb @@ -4,9 +4,22 @@ module Faker class TvShows class MichaelScott < Base class << self + # rubocop:disable Style/AsciiComments + + ## + # Produces a quote from Michael Scott. + # + # @return [String] + # + # @example + # Faker::TvShows::MichaelScott.quote + # #=> "I am Beyoncé, always." + # + # @faker.version 1.9.0 def quote fetch('michael_scott.quotes') end + # rubocop:enable Style/AsciiComments end end end diff --git a/lib/faker/tv_shows/new_girl.rb b/lib/faker/tv_shows/new_girl.rb index f5824a543b..d417312abb 100644 --- a/lib/faker/tv_shows/new_girl.rb +++ b/lib/faker/tv_shows/new_girl.rb @@ -6,10 +6,29 @@ class NewGirl < Base flexible :new_girl class << self + ## + # Produces a character from New Girl. + # + # @return [String] + # + # @example + # Faker::TvShows::NewGirl.character #=> "Jessica Day" + # + # @faker.version 1.9.0 def character fetch('new_girl.characters') end + ## + # Produces a quote from New Girl. + # + # @return [String] + # + # @example + # Faker::TvShows::NewGirl.quote + # #=> "Are you cooking a frittata in a sauce pan? What is this - prison?" + # + # @faker.version 1.9.0 def quote fetch('new_girl.quotes') end diff --git a/lib/faker/tv_shows/parks_and_rec.rb b/lib/faker/tv_shows/parks_and_rec.rb index cb0ef95463..614813232e 100644 --- a/lib/faker/tv_shows/parks_and_rec.rb +++ b/lib/faker/tv_shows/parks_and_rec.rb @@ -6,10 +6,28 @@ class ParksAndRec < Base flexible :parks_and_rec class << self + ## + # Produces a character from Parks and Recreation. + # + # @return [String] + # + # @example + # Faker::TvShows::ParksAndRec.character #=> "Leslie Knope" + # + # @faker.version 1.9.0 def character fetch('parks_and_rec.characters') end + ## + # Produces a city from Parks and Recreation. + # + # @return [String] + # + # @example + # Faker::TvShows::ParksAndRec.city #=> "Pawnee" + # + # @faker.version 1.9.0 def city fetch('parks_and_rec.cities') end diff --git a/lib/faker/tv_shows/rick_and_morty.rb b/lib/faker/tv_shows/rick_and_morty.rb index 1c292fb8ed..aac1a00479 100644 --- a/lib/faker/tv_shows/rick_and_morty.rb +++ b/lib/faker/tv_shows/rick_and_morty.rb @@ -6,14 +6,42 @@ class RickAndMorty < Base flexible :rick_and_morty class << self + ## + # Produces a character from Rick and Morty. + # + # @return [String] + # + # @example + # Faker::TvShows::RickAndMorty.character #=> "Rick Sanchez" + # + # @faker.version 1.8.0 def character fetch('rick_and_morty.characters') end + ## + # Produces a location from Rick and Morty. + # + # @return [String] + # + # @example + # Faker::TvShows::RickAndMorty.location #=> "Dimension C-132" + # + # @faker.version 1.8.0 def location fetch('rick_and_morty.locations') end + ## + # Produces a quote from Rick and Morty. + # + # @return [String] + # + # @example + # Faker::TvShows::RickAndMorty.quote + # #=> "Ohh yea, you gotta get schwifty." + # + # @faker.version 1.8.0 def quote fetch('rick_and_morty.quotes') end diff --git a/lib/faker/tv_shows/ru_paul.rb b/lib/faker/tv_shows/ru_paul.rb index 7b5bffdb6b..b45b4ead37 100644 --- a/lib/faker/tv_shows/ru_paul.rb +++ b/lib/faker/tv_shows/ru_paul.rb @@ -6,10 +6,28 @@ class RuPaul < Base flexible :rupaul class << self + ## + # Produces a quote from RuPaul's Drag Race. + # + # @return [String] + # + # @example + # Faker::TvShows::RuPaul.quote #=> "That's Funny, Tell Another One." + # + # @faker.version 1.8.0 def quote fetch('rupaul.quotes') end + ## + # Produces a queen from RuPaul's Drag Race. + # + # @return [String] + # + # @example + # Faker::TvShows::RuPaul.queen #=> "Latrice Royale" + # + # @faker.version 1.8.0 def queen fetch('rupaul.queens') end diff --git a/lib/faker/tv_shows/seinfeld.rb b/lib/faker/tv_shows/seinfeld.rb index 07a20e1855..9c7e37a7cc 100644 --- a/lib/faker/tv_shows/seinfeld.rb +++ b/lib/faker/tv_shows/seinfeld.rb @@ -6,14 +6,42 @@ class Seinfeld < Base flexible :seinfeld class << self + ## + # Produces a business from Seinfeld. + # + # @return [String] + # + # @example + # Faker::TvShows::Seinfeld.business #=> "Kruger Industrial Smoothing" + # + # @faker.version 1.9.2 def business fetch('seinfeld.business') end + ## + # Produces a character from Seinfeld. + # + # @return [String] + # + # @example + # Faker::TvShows::Seinfeld.character #=> "George Costanza" + # + # @faker.version 1.8.3 def character fetch('seinfeld.character') end + ## + # Produces a quote from Seinfeld. + # + # @return [String] + # + # @example + # Faker::TvShows::Seinfeld.quote + # #=> "I'm not a lesbian. I hate men, but I'm not a lesbian." + # + # @faker.version 1.8.3 def quote fetch('seinfeld.quote') end diff --git a/lib/faker/tv_shows/silicon_valley.rb b/lib/faker/tv_shows/silicon_valley.rb index 86298fb11a..addf9546bc 100644 --- a/lib/faker/tv_shows/silicon_valley.rb +++ b/lib/faker/tv_shows/silicon_valley.rb @@ -6,34 +6,109 @@ class SiliconValley < Base flexible :silicon_valley class << self + ## + # Produces a character from Silicon Valley. + # + # @return [String] + # + # @example + # Faker::TvShows::SiliconValley.character #=> "Jian Yang" + # + # @faker.version 1.8.5 def character fetch('silicon_valley.characters') end + ## + # Produces a company from Silicon Valley. + # + # @return [String] + # + # @example + # Faker::TvShows::SiliconValley.company #=> "Bachmanity" + # + # @faker.version 1.8.5 def company fetch('silicon_valley.companies') end + ## + # Produces a quote from Silicon Valley. + # + # @return [String] + # + # @example + # Faker::TvShows::SiliconValley.quote + # #=> "I don't want to live in a world where someone else is making the world a better place better than we are." + # + # @faker.version 1.8.5 def quote fetch('silicon_valley.quotes') end + ## + # Produces an app from Silicon Valley. + # + # @return [String] + # + # @example + # Faker::TvShows::SiliconValley.app #=> "Nip Alert" + # + # @faker.version 1.8.5 def app fetch('silicon_valley.apps') end + ## + # Produces an invention from Silicon Valley. + # + # @return [String] + # + # @example + # Faker::TvShows::SiliconValley.invention + # #=> "Tres Comas Tequila" + # + # @faker.version 1.8.5 def invention fetch('silicon_valley.inventions') end + ## + # Produces a motto from Silicon Valley. + # + # @return [String] + # + # @example + # Faker::TvShows::SiliconValley.motto + # #=> "Our products are products, producing unrivaled results" + # + # @faker.version 1.8.5 def motto fetch('silicon_valley.mottos') end + ## + # Produces a URL from Silicon Valley. + # + # @return [String] + # + # @example + # Faker::TvShows::SiliconValley.url #=> "http://www.piedpiper.com" + # + # @faker.version 1.8.5 def url fetch('silicon_valley.urls') end + ## + # Produces an email address from Silicon Valley. + # + # @return [String] + # + # @example + # Faker::TvShows::SiliconValley.email #=> "richard@piedpiper.test" + # + # @faker.version 1.9.0 def email fetch('silicon_valley.email') end diff --git a/lib/faker/tv_shows/simpsons.rb b/lib/faker/tv_shows/simpsons.rb index cd6d58e0a0..b631c41ffa 100644 --- a/lib/faker/tv_shows/simpsons.rb +++ b/lib/faker/tv_shows/simpsons.rb @@ -6,14 +6,42 @@ class Simpsons < Base flexible :simpsons class << self + ## + # Produces a character from The Simpsons. + # + # @return [String] + # + # @example + # Faker::TvShows::Simpsons.character #=> "Charles Montgomery Burns" + # + # @faker.version 1.8.0 def character fetch('simpsons.characters') end + ## + # Produces a location from The Simpsons. + # + # @return [String] + # + # @example + # Faker::TvShows::Simpsons.location #=> "Moe's Tavern" + # + # @faker.version 1.8.0 def location fetch('simpsons.locations') end + ## + # Produces a quote from The Simpsons. + # + # @return [String] + # + # @example + # Faker::TvShows::Simpsons.quote + # #=> "It takes two to lie: one to lie and one to listen." + # + # @faker.version 1.8.0 def quote fetch('simpsons.quotes') end diff --git a/lib/faker/tv_shows/south_park.rb b/lib/faker/tv_shows/south_park.rb index e796b36061..7f4e239849 100644 --- a/lib/faker/tv_shows/south_park.rb +++ b/lib/faker/tv_shows/south_park.rb @@ -6,10 +6,29 @@ class SouthPark < Base flexible :south_park class << self + ## + # Produces a character from South Park. + # + # @return [String] + # + # @example + # Faker::TvShows::SouthPark.character #=> "Mr. Garrison" + # + # @faker.version 1.9.2 def character fetch('south_park.characters') end + ## + # Produces a quote from South Park. + # + # @return [String] + # + # @example + # Faker::TvShows::SouthPark.quote + # #=> "I'm just getting a little cancer Stan." + # + # @faker.version 1.9.2 def quote fetch('south_park.quotes') end diff --git a/lib/faker/tv_shows/star_trek.rb b/lib/faker/tv_shows/star_trek.rb index 9191cb5c25..933c991cf1 100644 --- a/lib/faker/tv_shows/star_trek.rb +++ b/lib/faker/tv_shows/star_trek.rb @@ -6,18 +6,54 @@ class StarTrek < Base flexible :star_trek class << self + ## + # Produces a character from Star Trek. + # + # @return [String] + # + # @example + # Faker::TvShows::StarTrek.character #=> "Spock" + # + # @faker.version 1.8.0 def character fetch('star_trek.character') end + ## + # Produces a location from Star Trek. + # + # @return [String] + # + # @example + # Faker::TvShows::StarTrek.location #=> "Cardassia" + # + # @faker.version 1.8.0 def location fetch('star_trek.location') end + ## + # Produces a species from Star Trek. + # + # @return [String] + # + # @example + # Faker::TvShows::StarTrek.specie #=> "Ferengi" + # + # @faker.version 1.8.0 def specie fetch('star_trek.specie') end + ## + # Produces a villain from Star Trek. + # + # @return [String] + # + # @example + # Faker::TvShows::StarTrek.villain #=> "Khan Noonien Singh" + # + # @faker.version 1.8.0 def villain fetch('star_trek.villain') end diff --git a/lib/faker/tv_shows/stargate.rb b/lib/faker/tv_shows/stargate.rb index 0cec2ab21a..0fe34a3ec1 100644 --- a/lib/faker/tv_shows/stargate.rb +++ b/lib/faker/tv_shows/stargate.rb @@ -6,14 +6,42 @@ class Stargate < Base flexible :stargate class << self + ## + # Produces a character from Stargate. + # + # @return [String] + # + # @example + # Faker::TvShows::Stargate.character #=> "Jack O'Neill" + # + # @faker.version 1.8.5 def character fetch('stargate.characters') end + ## + # Produces a planet from Stargate. + # + # @return [String] + # + # @example + # Faker::TvShows::Stargate.planet #=> "Abydos" + # + # @faker.version 1.8.5 def planet fetch('stargate.planets') end + ## + # Produces a quote from Stargate. + # + # @return [String] + # + # @example + # Faker::TvShows::Stargate.quote + # #=> "General, request permission to beat the crap out of this man." + # + # @faker.version 1.8.5 def quote fetch('stargate.quotes') end diff --git a/lib/faker/tv_shows/stranger_things.rb b/lib/faker/tv_shows/stranger_things.rb index b6cf65229f..2b2febd030 100644 --- a/lib/faker/tv_shows/stranger_things.rb +++ b/lib/faker/tv_shows/stranger_things.rb @@ -6,10 +6,29 @@ class StrangerThings < Base flexible :stranger_things class << self + ## + # Produces a character from Stranger Things. + # + # @return [String] + # + # @example + # Faker::TvShows::StrangerThings.character #=> "six" + # + # @faker.version 1.9.0 def quote fetch('stranger_things.quote') end + ## + # Produces a quote from Stranger Things. + # + # @return [String] + # + # @example + # Faker::TvShows::StrangerThings.quote + # #=> "Friends don't lie." + # + # @faker.version 1.9.0 def character fetch('stranger_things.character') end diff --git a/lib/faker/tv_shows/the_expanse.rb b/lib/faker/tv_shows/the_expanse.rb index dfb3229793..e987ec9186 100644 --- a/lib/faker/tv_shows/the_expanse.rb +++ b/lib/faker/tv_shows/the_expanse.rb @@ -6,18 +6,54 @@ class TheExpanse < Base flexible :the_expanse class << self + ## + # Produces a character from The Expanse. + # + # @return [String] + # + # @example + # Faker::TvShows::TheExpanse.character #=> "Jim Holden" + # + # @faker.version 1.9.2 def character fetch('the_expanse.characters') end + ## + # Produces a quote from The Expanse. + # + # @return [String] + # + # @example + # Faker::TvShows::TheExpanse.quote #=> "I am that guy." + # + # @faker.version 1.9.2 def quote fetch('the_expanse.quotes') end + ## + # Produces a location from The Expanse. + # + # @return [String] + # + # @example + # Faker::TvShows::TheExpanse.location #=> "Ganymede" + # + # @faker.version 1.9.2 def location fetch('the_expanse.locations') end + ## + # Produces a ship from The Expanse. + # + # @return [String] + # + # @example + # Faker::TvShows::TheExpanse.ship #=> "Nauvoo" + # + # @faker.version 1.9.2 def ship fetch('the_expanse.ships') end diff --git a/lib/faker/tv_shows/the_fresh_prince_of_bel_air.rb b/lib/faker/tv_shows/the_fresh_prince_of_bel_air.rb index 5fe089c749..3698a563b0 100644 --- a/lib/faker/tv_shows/the_fresh_prince_of_bel_air.rb +++ b/lib/faker/tv_shows/the_fresh_prince_of_bel_air.rb @@ -6,14 +6,42 @@ class TheFreshPrinceOfBelAir < Base flexible :the_fresh_prince_of_bel_air class << self + ## + # Produces a character from The Fresh Prince of Bel-Air. + # + # @return [String] + # + # @example + # Faker::TvShows::TheFreshPrinceOfBelAir.character #=> "Will Smith" + # + # @faker.version 1.8.3 def character fetch('the_fresh_prince_of_bel_air.characters') end + ## + # Produces a celebrity from The Fresh Prince of Bel-Air. + # + # @return [String] + # + # @example + # Faker::TvShows::TheFreshPrinceOfBelAir.celebrity #=> "Quincy Jones" + # + # @faker.version 1.8.3 def celebrity fetch('the_fresh_prince_of_bel_air.celebrities') end + ## + # Produces a quote from The Fresh Prince of Bel-Air. + # + # @return [String] + # + # @example + # Faker::TvShows::TheFreshPrinceOfBelAir.quote + # #=> "Girl, you look so good, I would marry your brother just to get in your family." + # + # @faker.version 1.8.3 def quote fetch('the_fresh_prince_of_bel_air.quotes') end diff --git a/lib/faker/tv_shows/the_it_crowd.rb b/lib/faker/tv_shows/the_it_crowd.rb index 56602ff90a..32c34b0729 100644 --- a/lib/faker/tv_shows/the_it_crowd.rb +++ b/lib/faker/tv_shows/the_it_crowd.rb @@ -6,18 +6,55 @@ class TheITCrowd < Base flexible :the_it_crowd class << self + ## + # Produces an actor from The IT Crowd. + # + # @return [String] + # + # @example + # Faker::TvShows::TheITCrowd.actor #=> "Chris O'Dowd" + # + # @faker.version 1.9.0 def actor fetch('the_it_crowd.actors') end + ## + # Produces a character from The IT Crowd. + # + # @return [String] + # + # @example + # Faker::TvShows::TheITCrowd.character #=> "Roy Trenneman" + # + # @faker.version 1.9.0 def character fetch('the_it_crowd.characters') end + ## + # Produces an email from The IT Crowd. + # + # @return [String] + # + # @example + # Faker::TvShows::TheITCrowd.email #=> "roy.trenneman@reynholm.test" + # + # @faker.version 1.9.0 def email fetch('the_it_crowd.emails') end + ## + # Produces a quote from The IT Crowd. + # + # @return [String] + # + # @example + # Faker::TvShows::TheITCrowd.quote + # #=> "Hello, IT. Have you tried turning it off and on again?" + # + # @faker.version 1.9.0 def quote fetch('the_it_crowd.quotes') end diff --git a/lib/faker/tv_shows/the_thick_of_it.rb b/lib/faker/tv_shows/the_thick_of_it.rb index cbe984a1ff..c17572cffe 100644 --- a/lib/faker/tv_shows/the_thick_of_it.rb +++ b/lib/faker/tv_shows/the_thick_of_it.rb @@ -6,14 +6,42 @@ class TheThickOfIt < Base flexible :the_thick_of_it class << self + ## + # Produces a character from The Thick of It. + # + # @return [String] + # + # @example + # Faker::TvShows::TheThickOfIt.character #=> "Nicola Murray" + # + # @faker.version 1.8.5 def character fetch('the_thick_of_it.characters') end + ## + # Produces a department from The Thick of It. + # + # @return [String] + # + # @example + # Faker::TvShows::TheThickOfIt.department #=> "Shadow Cabinet" + # + # @faker.version 1.8.5 def department fetch('the_thick_of_it.departments') end + ## + # Produces a position from The Thick of It. + # + # @return [String] + # + # @example + # Faker::TvShows::TheThickOfIt.position + # #=> "Director of Communications" + # + # @faker.version 1.8.5 def position fetch('the_thick_of_it.positions') end diff --git a/lib/faker/tv_shows/twin_peaks.rb b/lib/faker/tv_shows/twin_peaks.rb index fa2f84c2d0..c3f37be6c1 100644 --- a/lib/faker/tv_shows/twin_peaks.rb +++ b/lib/faker/tv_shows/twin_peaks.rb @@ -6,14 +6,42 @@ class TwinPeaks < Base flexible :twin_peaks class << self + ## + # Produces a character from Twin Peaks. + # + # @return [String] + # + # @example + # Faker::TvShows::TwinPeaks.character #=> "Dale Cooper" + # + # @faker.version 1.7.0 def character fetch('twin_peaks.characters') end + ## + # Produces a location from Twin Peaks. + # + # @return [String] + # + # @example + # Faker::TvShows::TwinPeaks.location #=> "Black Lodge" + # + # @faker.version 1.7.0 def location fetch('twin_peaks.locations') end + ## + # Produces a quote from Twin Peaks. + # + # @return [String] + # + # @example + # Faker::TvShows::TwinPeaks.quote + # #=> "The owls are not what they seem." + # + # @faker.version 1.7.0 def quote fetch('twin_peaks.quotes') end diff --git a/lib/faker/tv_shows/venture_bros.rb b/lib/faker/tv_shows/venture_bros.rb index 02a7e09221..4790c8fd79 100644 --- a/lib/faker/tv_shows/venture_bros.rb +++ b/lib/faker/tv_shows/venture_bros.rb @@ -6,18 +6,56 @@ class VentureBros < Base flexible :venture_bros class << self + ## + # Produces a character from The Venture Bros. + # + # @return [String] + # + # @example + # Faker::TvShows::VentureBros.character #=> "Scaramantula" + # + # @faker.version 1.8.3 def character fetch('venture_bros.character') end + ## + # Produces an organization from The Venture Bros. + # + # @return [String] + # + # @example + # Faker::TvShows::VentureBros.organization + # #=> "Guild of Calamitous Intent" + # + # @faker.version 1.8.3 def organization fetch('venture_bros.organization') end + ## + # Produces a vehicle from The Venture Bros. + # + # @return [String] + # + # @example + # Faker::TvShows::VentureBros.vehicle #=> "Monarchmobile" + # + # @faker.version 1.8.3 def vehicle fetch('venture_bros.vehicle') end + ## + # Produces a quote from The Venture Bros. + # + # @return [String] + # + # @example + # Faker::TvShows::VentureBros.quote + # #=> "Revenge, like gazpacho soup, is best served cold, precise, and merciless." + # + # @faker.version 1.8.3 def quote fetch('venture_bros.quote') end