faker 2.2.0 → 3.2.2

data/lib/faker/games/control.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class Control < Base
+      class << self
+        ##
+        # Produces the name of a character from Control.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.character #=> "Jesse Faden"
+        #
+        # @faker.version 2.13.0
+        def character
+          fetch('games.control.character')
+        end
+
+        ##
+        # Produces the name of a location from Control.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.location #=> "Dimensional Research"
+        #
+        # @faker.version 2.13.0
+        def location
+          fetch('games.control.location')
+        end
+
+        ##
+        # Produces the name of an Object of Power (OoP)
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.object_of_power #=> "Hotline"
+        #
+        # @faker.version 2.13.0
+        def object_of_power
+          fetch('games.control.object_of_power')
+        end
+
+        ##
+        # Produces the name of an Altered Item
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.altered_item #=> "Rubber Duck"
+        #
+        # @faker.version 2.13.0
+        def altered_item
+          fetch('games.control.altered_item')
+        end
+
+        ##
+        # Produces the location of an Altered World Event (AWE)
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.altered_world_event #=> "Ordinary, Wisconsin"
+        #
+        # @faker.version 2.13.0
+        def altered_world_event
+          fetch('games.control.altered_world_event')
+        end
+
+        ##
+        # Produces a line from the Hiss incantation
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.hiss #=> "Push the fingers through the surface into the wet."
+        #
+        # @faker.version 2.13.0
+        def hiss
+          fetch('games.control.hiss')
+        end
+
+        ##
+        # < Produces a line/quote/message from The Board >
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.the_board #=> "< You/We wield the Gun/You. The Board appoints you. Congratulations, Director. >"
+        #
+        # @faker.version 2.13.0
+        def the_board
+          fetch('games.control.the_board')
+        end
+
+        ##
+        # Produces a quote from Control
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.quote #=> "He never liked fridge duty"
+        #
+        # @faker.version 2.13.0
+        def quote
+          fetch('games.control.quote')
+        end
+      end
+    end
+  end
+end

data/lib/faker/games/dnd.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class DnD < Base
+      class << self
+        ##
+        # Produces the name of an alignment from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.alignment #=> "Lawful Neutral"
+        #
+        # @faker.version 2.13.0
+        def alignment
+          fetch('dnd.alignments')
+        end
+
+        ##
+        # Produces the name of a background from Dungeons and Dragons (PHB).
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.background #=> "Urchin"
+        #
+        # @faker.version 2.13.0
+        def background
+          fetch('dnd.backgrounds')
+        end
+
+        ##
+        # Produces the name of a city from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.city #=> "Earthfast"
+        #
+        # @faker.version 2.14.0
+        def city
+          fetch('dnd.cities')
+        end
+
+        ##
+        # Produces the first name of a character or monster from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.name #=> "Eilonwy"
+        #
+        # @faker.version next
+        def first_name
+          fetch('dnd.name.first_name')
+        end
+
+        ##
+        # Produces the name of a class from Dungeons and Dragons (PHB).
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.klass #=> "Warlock"
+        #
+        # @faker.version 2.13.0
+        def klass
+          fetch('dnd.klasses')
+        end
+
+        ##
+        # Produces the name of a language from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.language #=> "Gnomish"
+        #
+        # @faker.version 2.14.0
+        def language
+          fetch('dnd.languages')
+        end
+
+        ##
+        # Produces a last name from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.last_name #=> "Leafwhisper"
+        #
+        # @faker.version next
+        def last_name
+          fetch('dnd.name.last_name')
+        end
+
+        ##
+        # Produces the name of a melee weapon from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.melee_weapon #=> "Handaxe"
+        #
+        # @faker.version 2.14.0
+        def melee_weapon
+          fetch('dnd.melee_weapons')
+        end
+
+        ##
+        # Produces the name of a monster from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.monster #=> "Manticore"
+        #
+        # @faker.version 2.14.0
+        def monster
+          fetch('dnd.monsters')
+        end
+
+        ##
+        # Produces a full name from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.name #=> "Drakon Blackthorn"
+        #
+        # @faker.version next
+        def name
+          "#{fetch('dnd.name.first_name')} #{fetch('dnd.name.last_name')}"
+        end
+
+        ##
+        # Produces the name of a race from Dungeons and Dragons (PHB).
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.races #=> "Dwarf"
+        #
+        # @faker.version 2.14.0
+        def race
+          fetch('dnd.races')
+        end
+
+        ##
+        # Produces the name of a ranged weapon from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.ranged_weapon #=> "Shortbow"
+        #
+        # @faker.version 2.14.0
+        def ranged_weapon
+          fetch('dnd.ranged_weapons')
+        end
+
+        ##
+        # Produces a last name from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.title_name #=> "Corvus the Cunning"
+        #
+        # @faker.version next
+        def title_name
+          "#{fetch('dnd.name.first_name')} #{fetch('dnd.name.title')}"
+        end
+      end
+    end
+  end
+end

data/lib/faker/games/dota.rb

@@ -4,28 +4,83 @@ module Faker
   class Games
     class Dota < Base
       class << self
+        ##
+        # Produces the name of a building from Dota.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.building #=> "Tower"
+        #
+        # @faker.version 1.9.0
+        def building
+          fetch('games.dota.building')
+        end
+
+        ##
+        # Produces the name of a hero from Dota.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.hero #=> "Abaddon"
+        #
+        # @faker.version 1.9.0
         def hero
           fetch('games.dota.hero')
         end
 
+        ##
+        # Produces the name of an item from Dota.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.item #=> "Armlet of Mordiggian"
+        #
+        # @faker.version 1.9.0
         def item
           fetch('games.dota.item')
         end
 
+        ##
+        # Produces the name of a professional Dota team.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.team #=> "Evil Geniuses"
+        #
+        # @faker.version 1.9.0
         def team
           fetch('games.dota.team')
         end
 
+        ##
+        # Produces the name of a professional Dota player.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.player #=> "Dendi"
+        #
+        # @faker.version 1.9.0
         def player
           fetch('games.dota.player')
         end
 
-        def quote(legacy_hero = NOT_GIVEN, hero: 'abaddon')
-          if legacy_hero != NOT_GIVEN
-            warn_with_uplevel 'Passing `hero` with the 1st argument of `Dota.quote` is deprecated. Use keyword argument like `Dota.quote(hero: ...)` instead.', uplevel: 1
-            hero = legacy_hero
-          end
-
+        ##
+        # Produces the name of a hero from Dota.
+        #
+        # @param hero [String] The name of a Dota hero.
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.quote #=> "You have called death upon yourself."
+        #   Faker::Games::Dota.quote(hero: 'alchemist') #=> "Better living through alchemy!"
+        #
+        # @faker.version 1.9.0
+        def quote(hero: 'abaddon')
           fetch("games.dota.#{hero}.quote")
         end
       end

data/lib/faker/games/elder_scrolls.rb

@@ -4,37 +4,135 @@ module Faker
   class Games
     class ElderScrolls < Base
       class << self
+        ##
+        # Produces the name of a race from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.race #=> "Argonian"
+        #
+        # @faker.version 1.9.2
         def race
           fetch('games.elder_scrolls.race')
         end
 
+        ##
+        # Produces the name of a city from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.city #=> "Whiterun"
+        #
+        # @faker.version 1.9.2
         def city
           fetch('games.elder_scrolls.city')
         end
 
+        ##
+        # Produces the name of a creature from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.creature #=> "Frost Troll"
+        #
+        # @faker.version 1.9.2
         def creature
           fetch('games.elder_scrolls.creature')
         end
 
+        ##
+        # Produces the name of a region from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.region #=> "Cyrodiil"
+        #
+        # @faker.version 1.9.2
         def region
           fetch('games.elder_scrolls.region')
         end
 
+        ##
+        # Produces the name of a dragon from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.dragon #=> "Blood Dragon"
+        #
+        # @faker.version 1.9.2
         def dragon
           fetch('games.elder_scrolls.dragon')
         end
 
+        ##
+        # Produces a randomly generated name from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.name #=> "Balgruuf The Old"
+        #
+        # @faker.version 1.9.2
         def name
           "#{fetch('games.elder_scrolls.first_name')} #{fetch('games.elder_scrolls.last_name')}"
         end
 
+        ##
+        # Produces a first name from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.first_name #=> "Balgruuf"
+        #
+        # @faker.version 1.9.2
         def first_name
           fetch('games.elder_scrolls.first_name')
         end
 
+        ##
+        # Produces a last name from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.last_name #=> "The Old"
+        #
+        # @faker.version 1.9.2
         def last_name
           fetch('games.elder_scrolls.last_name')
         end
+
+        ##
+        # Produces a weapon from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.weapon #=> "Elven Bow"
+        #
+        # @faker.version next
+        def weapon
+          fetch('games.elder_scrolls.weapon')
+        end
+
+        ##
+        # Produces a weapon from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.jewelry #=> "Silver Ruby Ring"
+        #
+        # @faker.version next
+        def jewelry
+          fetch('games.elder_scrolls.jewelry')
+        end
       end
     end
   end

data/lib/faker/games/fallout.rb

@@ -4,18 +4,55 @@ module Faker
   class Games
     class Fallout < Base
       class << self
+        ##
+        # Produces the name of a character from the Fallout games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Fallout.character #=> "Liberty Prime"
+        #
+        # @faker.version 1.9.2
         def character
           fetch('games.fallout.characters')
         end
 
+        ##
+        # Produces the name of a faction from the Fallout games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Fallout.faction #=> "Brotherhood of Steel"
+        #
+        # @faker.version 1.9.2
         def faction
           fetch('games.fallout.factions')
         end
 
+        ##
+        # Produces the name of a location from the Fallout games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Fallout.location #=> "New Vegas"
+        #
+        # @faker.version 1.9.2
         def location
           fetch('games.fallout.locations')
         end
 
+        ##
+        # Produces a quote from the Fallout games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Fallout.quote
+        #     #=> "Democracy is non-negotiable"
+        #
+        # @faker.version 1.9.2
         def quote
           fetch('games.fallout.quotes')
         end

data/lib/faker/games/final_fantasy_xiv.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class FinalFantasyXIV < Base
+      class << self
+        ##
+        # Produces the name of a character from FFXIV.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.character #=> "Y'shtola Rhul"
+        #
+        # @faker.version next
+        def character
+          fetch('games.final_fantasy_xiv.characters')
+        end
+
+        ##
+        # Produces a job name from Final Fantasy XIV. Either a battle or non-battle playable job.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.job #=> "Paladin"
+        #
+        # @faker.version next
+        def job
+          fetch('games.final_fantasy_xiv.jobs')
+        end
+
+        # Produces the name of a playable race from Final Fantasy XIV.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.race #=> "Miqo'te"
+        #
+        # @faker.version next
+        def race
+          fetch('games.final_fantasy_xiv.races')
+        end
+
+        ##
+        # Produces a data center from Final Fantasy XIV.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.data_center #=> "Aether"
+        #
+        # @faker.version next
+        def data_center
+          fetch('games.final_fantasy_xiv.data_centers')
+        end
+
+        ##
+        # Produces a geographical zone from Final Fantasy XIV.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.zone #=> "Eastern La Noscea"
+        #
+        # @faker.version next
+        def zone
+          fetch('games.final_fantasy_xiv.zones')
+        end
+      end
+    end
+  end
+end

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