faker 2.1.2 → 2.4.0

data/lib/faker/games/super_smash_bros.rb

@@ -4,10 +4,28 @@ module Faker
   class Games
     class SuperSmashBros < Base
       class << self
+        ##
+        # Produces the name of a fighter from the Smash Bros games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::SuperSmashBros.fighter #=> "Mario"
+        #
+        # @faker.version 1.9.2
         def fighter
           fetch('games.super_smash_bros.fighter')
         end
 
+        ##
+        # Produces the name of a stage from the Smash Bros games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::SuperSmashBros.stage #=> "Final Destination"
+        #
+        # @faker.version 1.9.2
         def stage
           fetch('games.super_smash_bros.stage')
         end

data/lib/faker/games/witcher.rb

@@ -4,26 +4,80 @@ module Faker
   class Games
     class Witcher < Base
       class << self
+        ##
+        # Produces the name of a character from The Witcher.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Witcher.character #=> "Triss Merigold"
+        #
+        # @faker.version 1.8.3
         def character
           fetch('games.witcher.characters')
         end
 
+        ##
+        # Produces the name of a witcher from The Witcher.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Witcher.witcher #=> "Geralt of Rivia"
+        #
+        # @faker.version 1.8.3
         def witcher
           fetch('games.witcher.witchers')
         end
 
+        ##
+        # Produces the name of a school from The Witcher.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Witcher.school #=> "Wolf"
+        #
+        # @faker.version 1.8.3
         def school
           fetch('games.witcher.schools')
         end
 
+        ##
+        # Produces the name of a location from The Witcher.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Witcher.location #=> "Novigrad"
+        #
+        # @faker.version 1.8.3
         def location
           fetch('games.witcher.locations')
         end
 
+        ##
+        # Produces a quote from The Witcher.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Witcher.quote #=> "No Lollygagin'!"
+        #
+        # @faker.version 1.8.3
         def quote
           fetch('games.witcher.quotes')
         end
 
+        ##
+        # Produces the name of a monster from The Witcher.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Witcher.monster #=> "Katakan"
+        #
+        # @faker.version 1.8.3
         def monster
           fetch('games.witcher.monsters')
         end

data/lib/faker/games/world_of_warcraft.rb

@@ -4,10 +4,28 @@ module Faker
   class Games
     class WorldOfWarcraft < Base
       class << self
+        ##
+        # Produces the name of a hero from World of Warcraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::WorldOfWarcraft.hero #=> "Uther the Lightbringer"
+        #
+        # @faker.version 1.9.2
         def hero
           fetch('games.world_of_warcraft.hero')
         end
 
+        ##
+        # Produces a quote from World of Warcraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::WorldOfWarcraft.quote #=> "These are dark times indeed."
+        #
+        # @faker.version 1.9.2
         def quote
           fetch('games.world_of_warcraft.quotes')
         end

data/lib/faker/games/zelda.rb

@@ -5,18 +5,54 @@ module Faker
     class Zelda < Base
       flexible :space
       class << self
+        ##
+        # Produces the name of a Legend of Zelda game.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Zelda.game #=> "Breath of the Wild"
+        #
+        # @faker.version 1.7.3
         def game
           fetch('games.zelda.games')
         end
 
+        ##
+        # Produces the name of a character from the Legend of Zelda games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Zelda.character #=> "Link"
+        #
+        # @faker.version 1.7.3
         def character
           fetch('games.zelda.characters')
         end
 
+        ##
+        # Produces the name of a character from the Legend of Zelda games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Zelda.location #=> "Hyrule Castle"
+        #
+        # @faker.version 1.7.3
         def location
           fetch('games.zelda.locations')
         end
 
+        ##
+        # Produces the name of an item from the Legend of Zelda games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Zelda.item #=> "Boomerang"
+        #
+        # @faker.version 1.7.3
         def item
           fetch('games.zelda.items')
         end

data/lib/faker/japanese_media/dragon_ball.rb

@@ -4,6 +4,15 @@ module Faker
   class JapaneseMedia
     class DragonBall < Base
       class << self
+        ##
+        # Produces the name of a character from Dragon Ball.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DragonBall.character #=> "Goku"
+        #
+        # @faker.version 1.8.0
         def character
           fetch('dragon_ball.characters')
         end

data/lib/faker/japanese_media/sword_art_online.rb

@@ -4,18 +4,54 @@ module Faker
   class JapaneseMedia
     class SwordArtOnline < Base
       class << self
+        ##
+        # Produces the real name of a character from Sword Art Online.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::SwordArtOnline.real_name #=> "Kirigaya Kazuto"
+        #
+        # @faker.version 1.9.0
         def real_name
           fetch('sword_art_online.real_name')
         end
 
+        ##
+        # Produces the in-game name of a character from Sword Art Online.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::SwordArtOnline.game_name #=> "Silica"
+        #
+        # @faker.version 1.9.0
         def game_name
           fetch('sword_art_online.game_name')
         end
 
+        ##
+        # Produces the name of a location from Sword Art Online.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::SwordArtOnline.location #=> "Ruby Palace"
+        #
+        # @faker.version 1.9.0
         def location
           fetch('sword_art_online.location')
         end
 
+        ##
+        # Produces the name of an item from Sword Art Online.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::SwordArtOnline.item #=> "Blackwyrm Coat"
+        #
+        # @faker.version 1.9.0
         def item
           fetch('sword_art_online.item')
         end

data/lib/faker/movies/hobbit.rb

@@ -4,18 +4,55 @@ module Faker
   class Movies
     class Hobbit < Base
       class << self
+        ##
+        # Produces the name of a character from The Hobbit.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hobbit.character #=> "Gandalf the Grey"
+        #
+        # @faker.version 1.8.0
         def character
           fetch('hobbit.character')
         end
 
+        ##
+        # Produces the name of one of the 13 dwarves from the Company, or Gandalf or Bilbo.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hobbit.thorins_company #=> "Thorin Oakenshield"
+        #
+        # @faker.version 1.8.0
         def thorins_company
           fetch('hobbit.thorins_company')
         end
 
+        ##
+        # Produces a quote from The Hobbit.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hobbit.quote
+        #     #=> "Never laugh at live dragons, Bilbo you fool!"
+        #
+        # @faker.version 1.8.0
         def quote
           fetch('hobbit.quote')
         end
 
+        ##
+        # Produces the name of a location from The Hobbit.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hobbit.location #=> "The Shire"
+        #
+        # @faker.version 1.8.0
         def location
           fetch('hobbit.location')
         end

data/lib/faker/movies/movie.rb

@@ -3,6 +3,15 @@
 module Faker
   class Movie < Base
     class << self
+      ##
+      # Produces a quote from a movie.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Movie.quote #=> "Bumble bee tuna"
+      #
+      # @faker.version 1.8.1
       def quote
         fetch('movie.quote')
       end

data/lib/faker/movies/star_wars.rb

@@ -44,7 +44,11 @@ module Faker
           sentence + sample(['.', '?', '!'])
         end
 
-        def quote(character: nil)
+        def quote(legacy_character = NOT_GIVEN, character: nil)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :character if legacy_character != NOT_GIVEN
+          end
+
           quoted_characters = translate('faker.star_wars.quotes')
 
           if character.nil?
@@ -57,9 +61,7 @@ module Faker
               character = k.to_s if v.include?(character)
             end
 
-            unless quoted_characters.key?(character.to_sym)
-              raise ArgumentError, "Character for quotes can be left blank or #{quoted_characters.keys.join(', ')}"
-            end
+            raise ArgumentError, "Character for quotes can be left blank or #{quoted_characters.keys.join(', ')}" unless quoted_characters.key?(character.to_sym)
           end
 
           fetch('star_wars.quotes.' + character)

data/lib/faker/music/grateful_dead.rb

@@ -6,10 +6,28 @@ module Faker
   class Music
     class GratefulDead < Base
       class << self
+        ##
+        # Produces the name of a member of The Grateful Dead.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::GratefulDead.player #=> "Jerry Garcia"
+        #
+        # @faker.version 1.9.2
         def player
           fetch('grateful_dead.players')
         end
 
+        ##
+        # Produces the name of a song by The Grateful Dead.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::GratefulDead.song #=> "Cassidy"
+        #
+        # @faker.version 1.9.2
         def song
           fetch('grateful_dead.songs')
         end

data/lib/faker/music/phish.rb

@@ -4,6 +4,15 @@ module Faker
   class Music
     class Phish < Base
       class << self
+        ##
+        # Produces the name of a song by Phish.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Phish.song #=> "Tweezer"
+        #
+        # @faker.version 1.9.2
         def song
           fetch('phish.song')
         end

data/lib/faker/music/rock_band.rb

@@ -4,6 +4,15 @@ module Faker
   class Music
     class RockBand < Base
       class << self
+        ##
+        # Produces the name of a rock band.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::RockBand.name #=> "Led Zeppelin"
+        #
+        # @faker.version 1.7.0
         def name
           fetch('rock_band.name')
         end

data/lib/faker/tv_shows/breaking_bad.rb

@@ -6,10 +6,28 @@ module Faker
       flexible :breaking_bad
 
       class << self
+        ##
+        # Produces the name of a character from Breaking Bad.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BreakingBad.character #=> "Walter White"
+        #
+        # @faker.version 1.8.8
         def character
           fetch('breaking_bad.character')
         end
 
+        ##
+        # Produces the name of an episode from Breaking Bad.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BreakingBad.episode #=> "Fly"
+        #
+        # @faker.version 1.8.8
         def episode
           fetch('breaking_bad.episode')
         end