faker 1.9.6 → 2.7.0

data/lib/faker/tv_shows/dumb_and_dumber.rb

@@ -1,19 +1,47 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     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

data/lib/faker/tv_shows/family_guy.rb

@@ -1,19 +1,47 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     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

data/lib/faker/tv_shows/friends.rb

@@ -1,19 +1,46 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     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

data/lib/faker/tv_shows/game_of_thrones.rb

@@ -1,27 +1,73 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     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

data/lib/faker/tv_shows/hey_arnold.rb

@@ -1,19 +1,46 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     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

data/lib/faker/tv_shows/how_i_met_your_mother.rb

@@ -1,23 +1,60 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     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

data/lib/faker/tv_shows/michael_scott.rb

@@ -1,12 +1,25 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  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

@@ -1,15 +1,34 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     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

data/lib/faker/tv_shows/parks_and_rec.rb

@@ -1,15 +1,33 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     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

data/lib/faker/tv_shows/rick_and_morty.rb

@@ -1,19 +1,47 @@
 # frozen_string_literal: true
 
 module Faker
-  module TvShows
+  class TvShows
     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