faker 2.1.2 → 2.6.0

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

data/lib/faker/tv_shows/simpsons.rb

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

data/lib/faker/tv_shows/south_park.rb

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

data/lib/faker/tv_shows/star_trek.rb

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

data/lib/faker/tv_shows/stargate.rb

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

data/lib/faker/tv_shows/stranger_things.rb

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

data/lib/faker/tv_shows/the_expanse.rb

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

data/lib/faker/tv_shows/the_fresh_prince_of_bel_air.rb

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

data/lib/faker/tv_shows/the_it_crowd.rb

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