faker 2.10.2 → 2.15.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/fantasy/tolkien.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Faker
+  class Fantasy
+    class Tolkien < Base
+      flexible :tolkien
+
+      class << self
+        ##
+        # Produces a character from Tolkien's legendarium
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Fantasy::Tolkien.character
+        #    #=> "Goldberry"
+        #
+        # @faker.version next
+        def character
+          fetch('tolkien.characters')
+        end
+
+        ##
+        # Produces a location from Tolkien's legendarium
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Fantasy::Tolkien.location
+        #    #=> "Helm's Deep"
+        #
+        # @faker.version next
+        def location
+          fetch('tolkien.locations')
+        end
+
+        ##
+        # Produces a race from Tolkien's legendarium
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Fantasy::Tolkien.race
+        #     #=> "Uruk-hai"
+        #
+        # @faker.version next
+        def race
+          fetch('tolkien.races')
+        end
+
+        ##
+        # Produces the name of a poem from Tolkien's legendarium
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Fantasy::Tolkien.poem
+        #     #=> "Chip the glasses and crack the plates"
+        #
+        # @faker.version next
+        def poem
+          fetch('tolkien.poems')
+        end
+      end
+    end
+  end
+end

data/lib/faker/games/clash_of_clans.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class ClashOfClans < Base
+      class << self
+        ##
+        # Produces the name of a troop from Clash of Clans.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ClashOfClans.troop #=> "Barbarian"
+        #
+        # @faker.version next
+        def troop
+          fetch('games.clash_of_clans.troops')
+        end
+
+        ##
+        # Produces the name of a rank from Clash Of Clans.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ClashOfClans.rank #=> "Legend"
+        #
+        # @faker.version next
+        def rank
+          fetch('games.clash_of_clans.ranks')
+        end
+
+        ##
+        # Produces the name of a defensive buiding from Clash Of Clans.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ClashOfClans.defensive_building #=> "Cannon"
+        #
+        # @faker.version next
+        def defensive_building
+          fetch('games.clash_of_clans.defensive_buildings')
+        end
+      end
+    end
+  end
+end

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,136 @@
+# 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 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 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 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
+
+        # This method is deprecated. The implementation will be removed in a near future release.
+        # Use `DnD.race` instead.
+        #
+        # @deprecated Use {#race} instead.
+        def species
+          warn '`DnD.species` is deprecated. Use `DnD.race` instead.'
+
+          super
+        end
+      end
+    end
+  end
+end