faker 2.11.0 → 2.12.0

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/pearl_jam.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'music'
+
+module Faker
+  class Music
+    class PearlJam < Base
+      class << self
+        ##
+        # Produces the name of a member of Pearl Jam (current and former)
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::PearlJam.musician #=> "Eddie Vedder"
+        #
+        # @faker.version next
+        def musician
+          fetch('pearl_jam.musicians')
+        end
+
+        ##
+        # Produces the name of an album by Pearl Jam.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::PearlJam.album #=> "Ten"
+        #
+        # @faker.version next
+        def album
+          fetch('pearl_jam.albums')
+        end
+
+        ##
+        # Produces the name of a song by Pearl Jam.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::PearlJam.song #=> "Even Flow"
+        #
+        # @faker.version next
+        def song
+          fetch('pearl_jam.songs')
+        end
+      end
+    end
+  end
+end

data/lib/faker/music/phish.rb

@@ -4,6 +4,32 @@ module Faker
   class Music
     class Phish < Base
       class << self
+        ##
+        # Produces the name of a album by Phish.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Phish.album #=> "Fuego"
+        #
+        # @faker.version next
+        def album
+          fetch('phish.albums')
+        end
+
+        ##
+        # Produces the name of a musician in Phish.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Phish.musician #=> "Trey Anastasio"
+        #
+        # @faker.version next
+        def musician
+          fetch('phish.musicians')
+        end
+
         ##
         # Produces the name of a song by Phish.
         #
@@ -14,7 +40,7 @@ module Faker
         #
         # @faker.version 1.9.2
         def song
-          fetch('phish.song')
+          fetch('phish.songs')
         end
       end
     end

data/lib/faker/music/show.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Faker
+  class Show < Base
+    class << self
+      ##
+      # Produces the name of a musical for an older audience
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Alphanumeric.alpha
+      #     #=> "West Side Story"
+      #
+      # @faker.version next
+      def adult_musical
+        fetch('show.adult_musical')
+      end
+
+      ##
+      # Produces the name of a musical for a younger audience
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Alphanumeric.alpha
+      #     #=> "Into the Woods JR."
+      #
+      # @faker.version next
+      def kids_musical
+        fetch('show.kids_musical')
+      end
+
+      ##
+      # Produces the name of a play
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Alphanumeric.alpha
+      #     #=> "Death of a Salesman"
+      #
+      # @faker.version next
+      def play
+        fetch('show.play')
+      end
+    end
+  end
+end

data/lib/faker/quotes/quote.rb

@@ -3,27 +3,80 @@
 module Faker
   class Quote < Base
     class << self
+      ##
+      # Produces a famous last words quote.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.famous_last_words #=> "My vocabulary did this to me. Your love will let you go on..."
+      #
+      # @faker.version 1.9.0
       def famous_last_words
         fetch('quote.famous_last_words')
       end
 
+      ##
+      # Produces a quote from Matz.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.matz #=> "You want to enjoy life, don't you? If you get your job done quickly and your job is fun, that's good isn't it? That's the purpose of life, partly. Your life is better."
+      #
+      # @faker.version 1.9.0
       def matz
         fetch('quote.matz')
       end
 
+      ##
+      # Produces a quote about the most interesting man in the world.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.most_interesting_man_in_the_world #=> "He can speak Russian... in French"
+      #
+      # @faker.version 1.9.0
       def most_interesting_man_in_the_world
         fetch('quote.most_interesting_man_in_the_world')
       end
 
+      ##
+      # Produces a Robin quote.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.robin #=> "Holy Razors Edge"
+      #
+      # @faker.version 1.9.0
       def robin
         fetch('quote.robin')
       end
 
+      ##
+      # Produces a singular siegler quote.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.singular_siegler #=> "Texas!"
+      #
+      # @faker.version 1.9.0
       def singular_siegler
         fetch('quote.singular_siegler')
       end
 
-      # from: http://morecoolquotes.com/famous-yoda-quotes/
+      ##
+      # Produces a quote from Yoda.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.yoda #=> "Use your feelings, Obi-Wan, and find him you will."
+      #
+      # @faker.version 1.9.0
       def yoda
         fetch('quote.yoda')
       end

data/lib/faker/quotes/shakespeare.rb

@@ -4,18 +4,54 @@ module Faker
   class Quotes
     class Shakespeare < Base
       class << self
+        ##
+        # Produces a Shakespeare quote from Hamlet.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.hamlet_quote # => "To be, or not to be: that is the question."
+        #
+        # @faker.version 1.9.2
         def hamlet_quote
           sample(hamlet)
         end
 
+        ##
+        # Produces a Shakespeare quote from As You Like It.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.as_you_like_it_quote # => "Can one desire too much of a good thing?."
+        #
+        # @faker.version 1.9.2
         def as_you_like_it_quote
           sample(as_you_like_it)
         end
 
+        ##
+        # Produces a Shakespeare quote from King Richard III.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.king_richard_iii_quote # => "Now is the winter of our discontent."
+        #
+        # @faker.version 1.9.2
         def king_richard_iii_quote
           sample(king_richard_iii)
         end
 
+        ##
+        # Produces a Shakespeare quote from Romeo And Juliet.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.romeo_and_juliet_quote # => "O Romeo, Romeo! wherefore art thou Romeo?."
+        #
+        # @faker.version 1.9.2
         def romeo_and_juliet_quote
           sample(romeo_and_juliet)
         end