faker 2.10.0 → 2.13.0

data/lib/faker/default/verb.rb

@@ -3,22 +3,67 @@
 module Faker
   class Verb < Base
     class << self
+      ##
+      # Produces the base form of a random verb.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verb.base #=> "hurt"
+      #
+      # @faker.version 1.9.0
       def base
         fetch('verbs.base')
       end
 
+      ##
+      # Produces a random verb in past tense.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verb.past #=> "completed"
+      #
+      # @faker.version 1.9.0
       def past
         fetch('verbs.past')
       end
 
+      ##
+      # Produces a random verb in past participle.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verb.past_participle #=> "digested"
+      #
+      # @faker.version 1.9.0
       def past_participle
         fetch('verbs.past_participle')
       end
 
+      ##
+      # Produces a random verb in simple present.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verb.simple_present #=> "climbs"
+      #
+      # @faker.version 1.9.0
       def simple_present
         fetch('verbs.simple_present')
       end
 
+      ##
+      # Produces a random verb in the .ing form.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verb.ing_form #=> "causing"
+      #
+      # @faker.version 1.9.0
       def ing_form
         fetch('verbs.ing_form')
       end

data/lib/faker/default/world_cup.rb

@@ -24,7 +24,7 @@ module Faker
       # @example
       #   Faker::WorldCup.city #=> "Moscow"
       #
-      # @faker.version next
+      # @faker.version 2.13.0
       def city
         fetch('world_cup.cities')
       end
@@ -37,7 +37,7 @@ module Faker
       # @example
       #   Faker::WorldCup.stadium #=> "Rostov Arena"
       #
-      # @faker.version next
+      # @faker.version 2.13.0
       def stadium
         fetch('world_cup.stadiums')
       end
@@ -52,7 +52,7 @@ module Faker
       # @example
       #   Faker::WorldCup.group #=> "Russia"
       #
-      # @faker.version next
+      # @faker.version 2.13.0
       def group(legacy_group = NOT_GIVEN, group: 'group_A')
         warn_for_deprecated_arguments do |keywords|
           keywords << :group if legacy_group != NOT_GIVEN
@@ -72,7 +72,7 @@ module Faker
       # @example
       #   Faker::WorldCup.roster(country: 'Spain', type: 'forwards') #=> "Diego Costa"
       #
-      # @faker.version next
+      # @faker.version 2.13.0
       def roster(legacy_country = NOT_GIVEN, legacy_type = NOT_GIVEN, country: 'Egypt', type: 'coach')
         warn_for_deprecated_arguments do |keywords|
           keywords << :country if legacy_country != NOT_GIVEN

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.character #=> "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,61 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class DnD < Base
+      class << self
+        ##
+        # Produces the name of a race from Dungeons and Dragons (PHB).
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.race #=> "Dwarf"
+        #
+        # @faker.version 2.13.0
+        def species
+          fetch('dnd.species')
+        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 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 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
+      end
+    end
+  end
+end

data/lib/faker/games/heroes_of_the_storm.rb

@@ -18,16 +18,27 @@ module Faker
         end
 
         ##
-        # Produces a class from Heroes of the Storm.
+        # 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
+          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 #=> "Support"
+        #   Faker::Games::HeroesOfTheStorm.class_name #=> "Support"
         #
-        # @faker.version 1.9.2
-        def class
-          fetch('heroes_of_the_storm.classes')
+        # @faker.version 2.13.0
+        def class_name
+          fetch('heroes_of_the_storm.class_names')
         end
 
         ##

data/lib/faker/games/minecraft.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class Minecraft < Base
+      class << self
+        ##
+        # 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 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.item #=> "Sheep"
+        #
+        # @faker.version 2.13.0
+        def mob
+          fetch('games.minecraft.mobs')
+        end
+      end
+    end
+  end
+end

data/lib/faker/games/warhammer_fantasy.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class WarhammerFantasy < Base
+      class << self
+        ##
+        # Produces the name of a hero from the Warhammer Fantasy setting.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::WarhammerFantasy.hero #=> "Sigmar Heldenhammer"
+        #
+        # @faker.version 2.13.0
+        def hero
+          fetch('games.warhammer_fantasy.heros')
+        end
+
+        ##
+        # Produces a quote from the Warhammer Fantasy setting.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::WarhammerFantasy.quote #=> "The softest part of a castle is the belly of the man inside."
+        #
+        # @faker.version 2.13.0
+        def quote
+          fetch('games.warhammer_fantasy.quotes')
+        end
+
+        ##
+        # Produces a location from the Warhammer Fantasy setting.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::WarhammerFantasy.location #=> "Lustria"
+        #
+        # @faker.version 2.13.0
+        def location
+          fetch('games.warhammer_fantasy.locations')
+        end
+
+        ##
+        # Produces a faction from the Warhammer Fantasy setting.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::WarhammerFantasy.faction #=> "Bretonnia"
+        #
+        # @faker.version 2.13.0
+        def faction
+          fetch('games.warhammer_fantasy.factions')
+        end
+
+        ##
+        # Produces a creature from the Warhammer Fantasy setting.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::WarhammerFantasy.creature #=> "Hydra"
+        #
+        # @faker.version 2.13.0
+        def creature
+          fetch('games.warhammer_fantasy.creatures')
+        end
+      end
+    end
+  end
+end

data/lib/faker/movies/departed.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Faker
+  class Movies
+    class Departed < Base
+      class << self
+        ##
+        # Produces an actor from The Departed.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Departed.actor #=> "Matt Damon"
+        #
+        # @faker.version 2.13.0
+        def actor
+          fetch('departed.actors')
+        end
+
+        ##
+        # Produces a character from The Departed.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Departed.character #=> "Frank Costello"
+        #
+        # @faker.version 2.13.0
+        def character
+          fetch('departed.characters')
+        end
+
+        ##
+        # Produces a quote from The Departed.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Departed.quote
+        #     #=> "I'm the guy who does his job. You must be the other guy"
+        #
+        # @faker.version 2.13.0
+        def quote
+          fetch('departed.quotes')
+        end
+      end
+    end
+  end
+end