faker 2.11.0 → 2.18.0

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 2.13.0
+        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 2.13.0
+        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 2.13.0
+        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 2.13.0
+        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 2.13.0
+        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/prince.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Faker
+  class Music
+    class Prince < Base
+      class << self
+        ##
+        # Produces a random Prince song.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Prince.song #=> "Raspberry Beret"
+        #   Faker::Music::Prince.song #=> "Starfish And Coffee"
+        #
+        # @faker.version 2.13.0
+        def song
+          fetch('prince.song')
+        end
+
+        ##
+        # Produces a random Prince song lyric.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Prince.lyric #=> "Dearly beloved, we are gathered here today to get through this thing called life."
+        #   Faker::Music::Prince.lyric #=> "You were so hard to find, the beautiful ones, they hurt you every time."
+        #
+        # @faker.version 2.13.0
+        def lyric
+          fetch('prince.lyric')
+        end
+
+        ##
+        # Produces a random Prince album.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Prince.album #=> "The Gold Experience"
+        #   Faker::Music::Prince.album #=> "Purple Rain"
+        #
+        # @faker.version 2.13.0
+        def album
+          fetch('prince.album')
+        end
+
+        ##
+        # Produces a random Prince-associated band.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Prince.band #=> "The New Power Generation"
+        #
+        # @faker.version 2.13.0
+        def band
+          fetch('prince.band')
+        end
+      end
+    end
+  end
+end

data/lib/faker/music/rock_band.rb

@@ -16,6 +16,18 @@ module Faker
         def name
           fetch('rock_band.name')
         end
+
+        # Produces a rock song.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::RockBand.song #=> "Dani California"
+        #
+        # @faker.version next
+        def song
+          fetch('rock_band.song')
+        end
       end
     end
   end

data/lib/faker/music/rush.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'music'
+
+module Faker
+  class Music
+    class Rush < Base
+      class << self
+        ##
+        # Produces the name of a member of Rush
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Rush.player #=> "Geddy Lee"
+        #
+        # @faker.version 2.13.0
+        def player
+          fetch('rush.players')
+        end
+
+        ##
+        # Produces the name of an album by Rush
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Rush.album #=> "Hold Your Fire"
+        #
+        # @faker.version 2.13.0
+        def album
+          fetch('rush.albums')
+        end
+      end
+    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 2.13.0
+      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 2.13.0
+      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 2.13.0
+      def play
+        fetch('show.play')
+      end
+    end
+  end
+end

data/lib/faker/quotes/quote.rb

@@ -3,30 +3,109 @@
 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 Deep Thoughts by Jack Handey.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.jack_handey # => "I hope life isn't a big joke, because I don't get it."
+      #
+      # @faker.version next
+      def jack_handey
+        fetch('quote.jack_handey')
+      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
+
+      ##
+      # Produces a quote from a fortune cookie.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.fortune_cookie #=> "This cookie senses that you are superstitious; it is an inclination that is bad for your mental health."
+      #
+      # @faker.version next
+      def fortune_cookie
+        fetch('quote.fortune_cookie')
+      end
     end
   end
 end

data/lib/faker/quotes/rajnikanth.rb

@@ -6,6 +6,7 @@ module Faker
       flexible :rajnikanth
 
       class << self
+        ##
         # Produces a Rajnikanth.
         # Original list of jokes:
         # http://www.rajinikanthjokes.com/

data/lib/faker/quotes/shakespeare.rb

@@ -4,34 +4,104 @@ 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
 
+        ##
+        # Generates quote from Hamlet
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.hamlet   #=> "A little more than kin, and less than kind."
+        #
+        # @faker.version 1.9.2
         def hamlet
           fetch('shakespeare.hamlet')
         end
 
+        ##
+        # Generates quote from 'As you like it!'
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.as_you_like_it   #=> "How bitter a thing it is to look into happiness through another man's eyes!"
+        #
+        # @faker.version 1.9.2
         def as_you_like_it
           fetch('shakespeare.as_you_like_it')
         end
 
+        ##
+        # Returns quote from 'King Rechard III'
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare  #=> "The king's name is a tower of strength."
         def king_richard_iii
           fetch('shakespeare.king_richard_iii')
         end
 
+        ##
+        # Quote from 'Romeo and Juliet'
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.romeo_and_juliet  #=> "Wisely and slow; they stumble that run fast."
+        #
+        # @faker.version 1.9.2
         def romeo_and_juliet
           fetch('shakespeare.romeo_and_juliet')
         end