faker 2.4.0 → 2.5.0

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

data/lib/faker/tv_shows/how_i_met_your_mother.rb

@@ -6,18 +6,55 @@ module Faker
       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

data/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

data/lib/faker/tv_shows/new_girl.rb

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

data/lib/faker/tv_shows/parks_and_rec.rb

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

data/lib/faker/tv_shows/rick_and_morty.rb

@@ -6,14 +6,42 @@ module Faker
       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

data/lib/faker/tv_shows/ru_paul.rb

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

data/lib/faker/tv_shows/seinfeld.rb

@@ -6,14 +6,42 @@ module Faker
       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

data/lib/faker/tv_shows/silicon_valley.rb

@@ -6,34 +6,109 @@ module Faker
       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