faker 2.2.2 → 2.7.0

data/lib/faker/games/league_of_legends.rb

@@ -4,26 +4,80 @@ module Faker
   class Games
     class LeagueOfLegends < Base
       class << self
+        ##
+        # Produces the name of a champion from League of Legends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::LeagueOfLegends.champion #=> "Jarvan IV"
+        #
+        # @faker.version 1.8.0
         def champion
           fetch('games.league_of_legends.champion')
         end
 
+        ##
+        # Produces a location from League of Legends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::LeagueOfLegends.location #=> "Demacia"
+        #
+        # @faker.version 1.8.0
         def location
           fetch('games.league_of_legends.location')
         end
 
+        ##
+        # Produces a quote from League of Legends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::LeagueOfLegends.quote #=> "Purge the unjust."
+        #
+        # @faker.version 1.8.0
         def quote
           fetch('games.league_of_legends.quote')
         end
 
+        ##
+        # Produces a summoner spell from League of Legends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::LeagueOfLegends.summoner_spell #=> "Flash"
+        #
+        # @faker.version 1.8.0
         def summoner_spell
           fetch('games.league_of_legends.summoner_spell')
         end
 
+        ##
+        # Produces a mastery from League of Legends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::LeagueOfLegends.masteries #=> "Double Edged Sword"
+        #
+        # @faker.version 1.8.0
         def masteries
           fetch('games.league_of_legends.masteries')
         end
 
+        ##
+        # Produces a rank from League of Legends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::LeagueOfLegends.rank #=> "Bronze V"
+        #
+        # @faker.version 1.8.0
         def rank
           fetch('games.league_of_legends.rank')
         end

data/lib/faker/games/myst.rb

@@ -4,22 +4,67 @@ module Faker
   class Games
     class Myst < Base
       class << self
+        ##
+        # Produces the name of a game from the Myst series.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Myst.game #=> "Myst III: Exile"
+        #
+        # @faker.version 1.9.0
         def game
           fetch('games.myst.games')
         end
 
+        ##
+        # Produces the name of a creature from Myst.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Myst.creature #=> "squee"
+        #
+        # @faker.version 1.9.0
         def creature
           fetch('games.myst.creatures')
         end
 
+        ##
+        # Produces the name of an age from Myst.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Myst.age #=> "Relto"
+        #
+        # @faker.version 1.9.0
         def age
           fetch('games.myst.ages')
         end
 
+        ##
+        # Produces the name of a chracter from Myst.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Myst.character #=> "Gehn"
+        #
+        # @faker.version 1.9.0
         def character
           fetch('games.myst.characters')
         end
 
+        ##
+        # Produces a quote from Myst.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Myst.quote #=> "I realized, the moment I fell into the fissure, that the Book would not be destroyed as I had planned."
+        #
+        # @faker.version 1.9.0
         def quote
           fetch('games.myst.quotes')
         end

data/lib/faker/games/overwatch.rb

@@ -4,14 +4,41 @@ module Faker
   class Games
     class Overwatch < Base
       class << self
+        ##
+        # Produces the name of a hero from Overwatch.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Overwatch.hero #=> "Tracer"
+        #
+        # @faker.version 1.8.0
         def hero
           fetch('games.overwatch.heroes')
         end
 
+        ##
+        # Produces the name of a location from Overwatch.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Overwatch.location #=> "Numbani"
+        #
+        # @faker.version 1.8.0
         def location
           fetch('games.overwatch.locations')
         end
 
+        ##
+        # Produces a quote from Overwatch.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Overwatch.quote #=> "It's high noon"
+        #
+        # @faker.version 1.8.0
         def quote
           fetch('games.overwatch.quotes')
         end

data/lib/faker/games/pokemon.rb

@@ -4,14 +4,41 @@ module Faker
   class Games
     class Pokemon < Base
       class << self
+        ##
+        # Produces the name of a Pokemon.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Pokemon.name #=> "Pikachu"
+        #
+        # @faker.version 1.7.0
         def name
           fetch('games.pokemon.names')
         end
 
+        ##
+        # Produces a location from Pokemon.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Pokemon.location #=> "Pallet Town"
+        #
+        # @faker.version 1.7.0
         def location
           fetch('games.pokemon.locations')
         end
 
+        ##
+        # Produces a move from Pokemon.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Pokemon.move #=> "Thunder Shock"
+        #
+        # @faker.version 1.7.0
         def move
           fetch('games.pokemon.moves')
         end

data/lib/faker/games/sonic_the_hedgehog.rb

@@ -4,14 +4,41 @@ module Faker
   class Games
     class SonicTheHedgehog < Base
       class << self
+        ##
+        # Produces the name of a character from Sonic the Hedgehog.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::SonicTheHedgehog.character #=> "Sonic the Hedgehog"
+        #
+        # @faker.version 1.9.2
         def character
           fetch('games.sonic_the_hedgehog.character')
         end
 
+        ##
+        # Produces the name of a zone from Sonic the Hedgehog.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::SonicTheHedgehog.zone #=> "Green Hill Zone"
+        #
+        # @faker.version 1.9.2
         def zone
           fetch('games.sonic_the_hedgehog.zone')
         end
 
+        ##
+        # Produces the name of a game from the Sonic the Hedgehog series.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::SonicTheHedgehog.game #=> "Waku Waku Sonic Patrol Car"
+        #
+        # @faker.version 1.9.2
         def game
           fetch('games.sonic_the_hedgehog.game')
         end

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

@@ -3,20 +3,56 @@
 module Faker
   class Games
     class Zelda < Base
-      flexible :space
+      flexible :zelda
       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