faker 2.2.0 → 3.2.2

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,17 +4,57 @@ 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
+
+        ##
+        # Produces the name of an artifact from Heroes 3.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Heroes.artifact #=> "Armageddon's Blade"
+        #
+        # @faker.version next
+        def artifact
+          fetch('heroes.artifacts')
+        end
       end
     end
   end

data/lib/faker/games/heroes_of_the_storm.rb

@@ -4,18 +4,65 @@ 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
 
+        ##
+        # This method is deprecated. The implementation will be removed in a near future release.
+        # Use `HeroesOfTheStorm.class_name` instead.
+        #
+        # @deprecated Use {#class_name} instead.
         def class
-          fetch('heroes_of_the_storm.classes')
+          warn '`HeroesOfTheStorm.class` is deprecated. Use `HeroesOfTheStorm.class_name` instead.'
+
+          super
+        end
+
+        ##
+        # Produces a class name from Heroes of the Storm.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HeroesOfTheStorm.class_name #=> "Support"
+        #
+        # @faker.version 2.13.0
+        def class_name
+          fetch('heroes_of_the_storm.class_names')
         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/minecraft.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class Minecraft < Base
+      class << self
+        ##
+        # Produces the name of an achievement from Minecraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Minecraft.achievement #=> "Time to Mine!"
+        #
+        # @faker.version next
+        def achievement
+          fetch('games.minecraft.achievement')
+        end
+
+        ##
+        # Produces the name of a biome from Minecraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Minecraft.biome #=> "Jungle"
+        #
+        # @faker.version next
+        def biome
+          fetch('games.minecraft.biome')
+        end
+
+        ##
+        # Produces the name of a block from Minecraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Minecraft.block #=> "Stone"
+        #
+        # @faker.version 2.13.0
+        def block
+          fetch('games.minecraft.blocks')
+        end
+
+        ##
+        # Produces the name of a enchantment from Minecraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Minecraft.enchantment #=> "Fire Protection"
+        #
+        # @faker.version next
+        def enchantment
+          fetch('games.minecraft.enchantment')
+        end
+
+        ##
+        # Produces the name of a game mode from Minecraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Minecraft.game_mode #=> "Survival"
+        #
+        # @faker.version next
+        def game_mode
+          fetch('games.minecraft.game_mode')
+        end
+
+        ##
+        # Produces the name of an item from Minecraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Minecraft.item #=> "Iron Shovel"
+        #
+        # @faker.version 2.13.0
+        def item
+          fetch('games.minecraft.items')
+        end
+
+        ##
+        # Produces the name of a mob from Minecraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Minecraft.mob #=> "Sheep"
+        #
+        # @faker.version 2.13.0
+        def mob
+          fetch('games.minecraft.mobs')
+        end
+
+        ##
+        # Produces the name of a status effect from Minecraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Minecraft.status_effect #=> "Weakness"
+        #
+        # @faker.version next
+        def status_effect
+          fetch('games.minecraft.status_effect')
+        end
+      end
+    end
+  end
+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 character 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/street_fighter.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class StreetFighter < Base
+      class << self
+        ##
+        # Produces the name of a playable character from Street Fighter.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::StreetFighter.character #=> "Ryu"
+        #
+        # @faker.version 2.14.0
+        def character
+          fetch('games.street_fighter.characters')
+        end
+
+        ##
+        # Produces the name of a stage from Street Fighter.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::StreetFighter.stage #=> "Volcanic Rim"
+        #
+        # @faker.version 2.14.0
+        def stage
+          fetch('games.street_fighter.stages')
+        end
+
+        ##
+        # Produces a quote from Street Fighter.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::StreetFighter.quote #=> "Go home and be a family man."
+        #
+        # @faker.version 2.14.0
+        def quote
+          fetch('games.street_fighter.quotes')
+        end
+
+        ##
+        # Produces the name of a move from Street Fighter.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::StreetFighter.move #=> "Shoryuken"
+        #
+        # @faker.version 2.14.0
+        def move
+          fetch('games.street_fighter.moves')
+        end
+      end
+    end
+  end
+end

data/lib/faker/games/super_mario.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class SuperMario < Base
+      class << self
+        ##
+        # Produces the name of a Super Mario character.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::SuperMario.character #=> "Luigi"
+        #
+        # @faker.version next
+        def character
+          fetch('games.super_mario.characters')
+        end
+
+        ##
+        # Produces the name of a Super Mario game.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::SuperMario.game #=> "Super Mario Odyssey"
+        #
+        # @faker.version next
+        def game
+          fetch('games.super_mario.games')
+        end
+
+        ##
+        # Produces the name of a Super Mario location.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::SuperMario.location #=> "Kong City"
+        #
+        # @faker.version next
+        def location
+          fetch('games.super_mario.locations')
+        end
+      end
+    end
+  end
+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