faker 2.9.0 → 2.12.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/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 next
+        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 next
+        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 next
+        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 next
+        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 next
+        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 next
+        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 next
+        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 next
+        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 next
+        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 next
+        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 next
+        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 next
+        def alignment
+          fetch('dnd.alignments')
+        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 next
+        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 next
+        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 next
+        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 next
+        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 next
+        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 next
+        def actor
+          fetch('departed.actors')
+        end
+
+        ##
+        # Produces a character from The Departed.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Departed.character #=> "Frank Costello"
+        #
+        # @faker.version next
+        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 next
+        def quote
+          fetch('departed.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/music/music.rb

@@ -3,42 +3,128 @@
 module Faker
   class Music < Base
     class << self
+      NOTE_LETTERS = %w[C D E F G A B].freeze
+      ACCIDENTAL_SIGNS = ['b', '#', ''].freeze
+      KEY_TYPES = ['', 'm'].freeze
+      CHORD_TYPES = ['', 'maj', '6', 'maj7', 'm', 'm7', '-7', '7', 'dom7', 'dim', 'dim7', 'm7b5'].freeze
+
+      ##
+      # Produces the name of a key/note, using letter notation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Music.key #=> "A#"
+      #
+      # @faker.version 1.6.4
       def key
         sample(keys) + sample(key_variants)
       end
 
+      ##
+      # Produces the name of a chord, using letter notation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Music.chord #=> "Adim7"
+      #
+      # @faker.version 1.6.4
       def chord
         key + sample(chord_types)
       end
 
+      ##
+      # Produces the name of an instrument.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Music.instrument #=> "Acoustic Guitar"
+      #
+      # @faker.version 1.6.4
       def instrument
         fetch('music.instruments')
       end
 
+      ##
+      # Produces an array of the letter names of musical notes, without accidentals.
+      #
+      # @return [Array<String>]
+      #
+      # @faker.version 1.6.4
       def keys
-        %w[C D E F G A B]
+        NOTE_LETTERS
       end
 
+      ##
+      # Produces an array of accidentals (with "natural" denoted as an empty string).
+      #
+      # @return [Array<String>]
+      #
+      # @faker.version 1.6.4
       def key_variants
-        ['b', '#', '']
+        ACCIDENTAL_SIGNS
       end
 
+      ##
+      # Produces an array of key types (with "major" denoted as an empty string).
+      #
+      # @return [Array<String>]
+      #
+      # @example
+      #   Faker::Music.key_types #=> ['', 'm']
+      #
+      # @faker.version 1.6.4
       def key_types
-        ['', 'm']
+        KEY_TYPES
       end
 
+      ##
+      # Produces an array of types of chords.
+      #
+      # @return [Array<String>]
+      #
+      # @faker.version 1.6.4
       def chord_types
-        ['', 'maj', '6', 'maj7', 'm', 'm7', '-7', '7', 'dom7', 'dim', 'dim7', 'm7b5']
+        CHORD_TYPES
       end
 
+      ##
+      # Produces the name of a band.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Music.band #=> "The Beatles"
+      #
+      # @faker.version 1.9.1
       def band
         fetch('music.bands')
       end
 
+      ##
+      # Produces the name of an album.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Music.album #=> "Sgt. Pepper's Lonely Hearts Club"
+      #
+      # @faker.version 1.9.1
       def album
         fetch('music.albums')
       end
 
+      ##
+      # Produces the name of a musical genre.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Music.genre #=> "Rock"
+      #
+      # @faker.version 1.9.1
       def genre
         fetch('music.genres')
       end