faker 2.2.0 → 3.2.2

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

data/lib/faker/tv_shows/simpsons.rb

@@ -6,17 +6,59 @@ 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
+
+        ##
+        # Produces an episode title from The Simpsons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Simpsons.episode_title
+        #     #=> "Two Cars in Every Garage and Three Eyes on Every Fish"
+        #
+        # @faker.version 2.13.0
+        def episode_title
+          fetch('simpsons.episode_titles')
+        end
       end
     end
   end

data/lib/faker/tv_shows/south_park.rb

@@ -6,13 +6,47 @@ 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
+
+        ##
+        # Produces an episode name from South Park.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::SouthPark.episode_name
+        #     #=> "Make Love, Not Warcraft"
+        #
+        # @faker.version next
+
+        def episode_name
+          fetch('south_park.episodes')
+        end
       end
     end
   end

data/lib/faker/tv_shows/spongebob.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class Spongebob < Base
+      flexible :spongebob
+
+      class << self
+        ##
+        # Produces a character from Spongebob.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Spongebob.character #=> "Patrick"
+        #
+        # @faker.version next
+        def character
+          fetch('spongebob.characters')
+        end
+
+        ##
+        # Produces a quote from Spongebob.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Spongebob.quote #=> "I'm ready! I'm ready!"
+        #
+        # @faker.version next
+        def quote
+          fetch('spongebob.quotes')
+        end
+
+        ##
+        # Produces an episode from Spongebob.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Spongebob.episode #=> "Reef Blower"
+        #
+        # @faker.version next
+        def episode
+          fetch('spongebob.episodes')
+        end
+      end
+    end
+  end
+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/suits.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class Suits < Base
+      flexible :suits
+
+      class << self
+        ##
+        # Produces a character from Suits.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Suits.character #=> "Harvey Specter"
+        #
+        # @faker.version 2.13.0
+        def character
+          fetch('suits.characters')
+        end
+
+        ##
+        # Produces a quote from Suits.
+        #
+        # @return [String]
+        #
+        # @example
+        #  Faker::TvShows::Suits.quote #=> "Don't play the odds, play the man."
+        #
+        # @faker.version 2.13.0
+        def quote
+          fetch('suits.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/supernatural.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class Supernatural < Base
+      class << self
+        ##
+        # Produces the name of a character from Supernatural.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Supernatural.character #=> "Dean Winchester"
+        #
+        # @faker.version next
+        def character
+          fetch('supernatural.character')
+        end
+
+        ##
+        # Produces the name of a hunted creature.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Supernatural.creature #=> "Demon"
+        #
+        # @faker.version next
+        def creature
+          fetch('supernatural.creature')
+        end
+
+        ##
+        # Produces the name of a weapon used by the hunters.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Supernatural.weapon #=> "Colt"
+        #
+        # @faker.version next
+        def weapon
+          fetch('supernatural.weapon')
+        end
+      end
+    end
+  end
+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,55 @@ 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
 
-        def celebrity
-          fetch('the_fresh_prince_of_bel_air.celebrities')
+        ##
+        # Produces a actor from The Fresh Prince of Bel-Air.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::TheFreshPrinceOfBelAir.actor #=> "Quincy Jones"
+        #
+        # @faker.version next
+        def actor
+          fetch('the_fresh_prince_of_bel_air.actors')
         end
 
+        ##
+        # Produces a actor from The Fresh Prince of Bel-Air.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::TheFreshPrinceOfBelAir.celebrity #=> "Quincy Jones"
+        #
+        # @deprecated Use the `actor` method instead.
+        #
+        # @faker.version 1.8.3
+        alias celebrity actor
+
+        ##
+        # 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