faker 2.1.2 → 2.4.0

data/lib/faker/games/game.rb

@@ -5,14 +5,41 @@ module Faker
     flexible :game
 
     class << self
+      ##
+      # Produces the name of a video game.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Game.title #=> "Half-Life 2"
+      #
+      # @faker.version 1.9.4
       def title
         fetch('game.title')
       end
 
+      ##
+      # Produces the name of a video game genre.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Game.genre #=> "Real-time strategy"
+      #
+      # @faker.version 1.9.4
       def genre
         fetch('game.genre')
       end
 
+      ##
+      # Produces the name of a video game console or platform.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Game.platform #=> "Nintendo Switch"
+      #
+      # @faker.version 1.9.4
       def platform
         fetch('game.platform')
       end

data/lib/faker/games/half_life.rb

@@ -4,14 +4,41 @@ module Faker
   class Games
     class HalfLife < Base
       class << self
+        ##
+        # Produces the name of a character from the Half-Life games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HalfLife.character #=> "Gordon Freeman"
+        #
+        # @faker.version 1.9.2
         def character
           fetch('games.half_life.character')
         end
 
+        ##
+        # Produces the name of an enemy from the Half-Life games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HalfLife.enemy #=> "Headcrab"
+        #
+        # @faker.version 1.9.2
         def enemy
           fetch('games.half_life.enemy')
         end
 
+        ##
+        # Produces the name of a location from the Half-Life games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HalfLife.location #=> "Black Mesa Research Facility"
+        #
+        # @faker.version 1.9.2
         def location
           fetch('games.half_life.location')
         end

data/lib/faker/games/heroes.rb

@@ -4,14 +4,41 @@ module Faker
   class Games
     class Heroes < Base
       class << self
+        ##
+        # Produces the name of a hero from Heroes 3.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Heroes.name #=> "Christian"
+        #
+        # @faker.version 1.9.2
         def name
           fetch('heroes.names')
         end
 
+        ##
+        # Produces the name of a specialty from Heroes 3.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Heroes.specialty #=> "Ballista"
+        #
+        # @faker.version 1.9.2
         def specialty
           fetch('heroes.specialties')
         end
 
+        ##
+        # Produces the name of a class from Heroes 3.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Heroes.klass #=> "Knight"
+        #
+        # @faker.version 1.9.2
         def klass
           fetch('heroes.klasses')
         end

data/lib/faker/games/heroes_of_the_storm.rb

@@ -4,18 +4,54 @@ module Faker
   class Games
     class HeroesOfTheStorm < Base
       class << self
+        ##
+        # Produces a battleground from Heroes of the Storm.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HeroesOfTheStorm.battleground #=> "Towers of Doom"
+        #
+        # @faker.version 1.9.2
         def battleground
           fetch('heroes_of_the_storm.battlegrounds')
         end
 
+        ##
+        # Produces a class from Heroes of the Storm.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HeroesOfTheStorm.class #=> "Support"
+        #
+        # @faker.version 1.9.2
         def class
           fetch('heroes_of_the_storm.classes')
         end
 
+        ##
+        # Produces a hero from Heroes of the Storm.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HeroesOfTheStorm.hero #=> "Illidan"
+        #
+        # @faker.version 1.9.2
         def hero
           fetch('heroes_of_the_storm.heroes')
         end
 
+        ##
+        # Produces a quote from Heroes of the Storm.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HeroesOfTheStorm.quote #=> "MEAT!!!"
+        #
+        # @faker.version 1.9.2
         def quote
           fetch('heroes_of_the_storm.quotes')
         end

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