faker 2.2.0 → 2.5.0

data/lib/faker/movies/hobbit.rb

@@ -4,18 +4,55 @@ module Faker
   class Movies
     class Hobbit < Base
       class << self
+        ##
+        # Produces the name of a character from The Hobbit.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hobbit.character #=> "Gandalf the Grey"
+        #
+        # @faker.version 1.8.0
         def character
           fetch('hobbit.character')
         end
 
+        ##
+        # Produces the name of one of the 13 dwarves from the Company, or Gandalf or Bilbo.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hobbit.thorins_company #=> "Thorin Oakenshield"
+        #
+        # @faker.version 1.8.0
         def thorins_company
           fetch('hobbit.thorins_company')
         end
 
+        ##
+        # Produces a quote from The Hobbit.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hobbit.quote
+        #     #=> "Never laugh at live dragons, Bilbo you fool!"
+        #
+        # @faker.version 1.8.0
         def quote
           fetch('hobbit.quote')
         end
 
+        ##
+        # Produces the name of a location from The Hobbit.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hobbit.location #=> "The Shire"
+        #
+        # @faker.version 1.8.0
         def location
           fetch('hobbit.location')
         end

data/lib/faker/movies/lebowski.rb

@@ -4,14 +4,41 @@ module Faker
   class Movies
     class Lebowski < Base
       class << self
+        ##
+        # Produces an actor from The Big Lebowski.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Lebowski.actor #=> "John Goodman"
+        #
+        # @faker.version 1.8.8
         def actor
           fetch('lebowski.actors')
         end
 
+        ##
+        # Produces a character from The Big Lebowski.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Lebowski.character #=> "Jackie Treehorn"
+        #
+        # @faker.version 1.8.8
         def character
           fetch('lebowski.characters')
         end
 
+        ##
+        # Produces a quote from The Big Lebowski.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Lebowski.quote #=> "Forget it, Donny, you're out of your element!"
+        #
+        # @faker.version 1.8.8
         def quote
           fetch('lebowski.quotes')
         end

data/lib/faker/movies/lord_of_the_rings.rb

@@ -4,14 +4,42 @@ module Faker
   class Movies
     class LordOfTheRings < Base
       class << self
+        ##
+        # Produces a character from Lord of the Rings.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::LordOfTheRings.character #=> "Legolas"
+        #
+        # @faker.version 1.7.0
         def character
           fetch('lord_of_the_rings.characters')
         end
 
+        ##
+        # Produces a location from Lord of the Rings.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::LordOfTheRings.location #=> "Helm's Deep"
+        #
+        # @faker.version 1.7.0
         def location
           fetch('lord_of_the_rings.locations')
         end
 
+        ##
+        # Produces a quote from Lord of the Rings.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::LordOfTheRings.quote
+        #     #=> "I wish the Ring had never come to me. I wish none of this had happened."
+        #
+        # @faker.version 1.9.0
         def quote
           fetch('lord_of_the_rings.quotes')
         end

data/lib/faker/movies/movie.rb

@@ -3,6 +3,15 @@
 module Faker
   class Movie < Base
     class << self
+      ##
+      # Produces a quote from a movie.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Movie.quote #=> "Bumble bee tuna"
+      #
+      # @faker.version 1.8.1
       def quote
         fetch('movie.quote')
       end

data/lib/faker/movies/princess_bride.rb

@@ -4,10 +4,29 @@ module Faker
   class Movies
     class PrincessBride < Base
       class << self
+        ##
+        # Produces a character from The Princess Bride.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::PrincessBride.character #=> "Dread Pirate Roberts"
+        #
+        # @faker.version 1.9.0
         def character
           fetch('princess_bride.characters')
         end
 
+        ##
+        # Produces a quote from The Princess Bride.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::PrincessBride.quote
+        #     #=> "Hello. My name is Inigo Montoya. You killed my father. Prepare to die!"
+        #
+        # @faker.version 1.9.0
         def quote
           fetch('princess_bride.quotes')
         end

data/lib/faker/movies/star_wars.rb

@@ -4,38 +4,118 @@ module Faker
   class Movies
     class StarWars < Base
       class << self
+        ##
+        # Produces a call squadron from Star Wars.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::StarWars.call_squadron #=> "Green"
+        #
+        # @faker.version 1.6.2
         def call_squadron
           sample(call_squadrons)
         end
 
+        ##
+        # Produces a call sign from Star Wars.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::StarWars.call_sign #=> "Grey 5"
+        #
+        # @faker.version 1.6.2
         def call_sign
           numerify(parse('star_wars.call_sign'))
         end
 
+        ##
+        # Produces a call number from Star Wars.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::StarWars.call_number #=> "Leader"
+        #
+        # @faker.version 1.6.2
         def call_number
           sample(call_numbers)
         end
 
+        ##
+        # Produces a character from Star Wars.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::StarWars.character #=> "Anakin Skywalker"
+        #
+        # @faker.version 1.6.2
         def character
           sample(characters)
         end
 
+        ##
+        # Produces a droid from Star Wars.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::StarWars.droid #=> "C-3PO"
+        #
+        # @faker.version 1.6.2
         def droid
           sample(droids)
         end
 
+        ##
+        # Produces a planet from Star Wars.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::StarWars.planet #=> "Tatooine"
+        #
+        # @faker.version 1.6.2
         def planet
           sample(planets)
         end
 
+        ##
+        # Produces a species from Star Wars.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::StarWars.specie #=> "Gungan"
+        #
+        # @faker.version 1.6.2
         def specie
           sample(species)
         end
 
+        ##
+        # Produces a vehicle from Star Wars.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::StarWars.vehicle #=> "Sandcrawler"
+        #
+        # @faker.version 1.6.2
         def vehicle
           sample(vehicles)
         end
 
+        # Produces a wookiee sentence from Star Wars.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::StarWars.wookiee_sentence #=> "Yrroonn ru ooma roo ahuma ur roooarrgh hnn-rowr."
+        #
+        # @faker.version 1.6.2
         def wookiee_sentence
           sentence = sample(wookiee_words).capitalize
 
@@ -44,10 +124,23 @@ module Faker
           sentence + sample(['.', '?', '!'])
         end
 
+        ##
+        # Produces a quote from Star Wars.
+        #
+        # @param character [String] The name of a character to derive a quote from.
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::StarWars.quote #=> "Aren't you a little short for a Stormtrooper?"
+        #
+        # @example
+        #   Faker::Movies::StarWars.quote(character: "leia_organa")
+        #     #=> "Aren't you a little short for a Stormtrooper?"
+        #
+        # @faker.version 1.6.2
         def quote(legacy_character = NOT_GIVEN, character: nil)
-          if legacy_character != NOT_GIVEN
-            warn_with_uplevel 'Passing `character` with the 1st argument of `StarWars.quote` is deprecated. Use keyword argument like `StarWars.quote(character: ...)` instead.', uplevel: 1
-            character = legacy_character
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :character if legacy_character != NOT_GIVEN
           end
 
           quoted_characters = translate('faker.star_wars.quotes')
@@ -62,9 +155,7 @@ module Faker
               character = k.to_s if v.include?(character)
             end
 
-            unless quoted_characters.key?(character.to_sym)
-              raise ArgumentError, "Character for quotes can be left blank or #{quoted_characters.keys.join(', ')}"
-            end
+            raise ArgumentError, "Character for quotes can be left blank or #{quoted_characters.keys.join(', ')}" unless quoted_characters.key?(character.to_sym)
           end
 
           fetch('star_wars.quotes.' + character)

data/lib/faker/movies/v_for_vendetta.rb

@@ -4,14 +4,43 @@ module Faker
   class Movies
     class VForVendetta < Base
       class << self
+        ##
+        # Produces a character from V For Vendetta.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::VForVendetta.character #=> "V"
+        #
+        # @faker.version 1.8.5
         def character
           fetch('v_for_vendetta.characters')
         end
 
+        ##
+        # Produces a speech from V For Vendetta.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::VForVendetta.speech
+        #     #=> "Remember, remember, the Fifth of November, the Gunpowder Treason and Plot. I know of no reason why the Gunpowder Treason should ever be forgot..."
+        #
+        # @faker.version 1.8.5
         def speech
           fetch('v_for_vendetta.speeches')
         end
 
+        ##
+        # Produces a quote from V For Vendetta.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::VForVendetta.quote
+        #     #=> "People should not be afraid of their governments. Governments should be afraid of their people."
+        #
+        # @faker.version 1.8.5
         def quote
           fetch('v_for_vendetta.quotes')
         end

data/lib/faker/music/grateful_dead.rb

@@ -6,10 +6,28 @@ module Faker
   class Music
     class GratefulDead < Base
       class << self
+        ##
+        # Produces the name of a member of The Grateful Dead.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::GratefulDead.player #=> "Jerry Garcia"
+        #
+        # @faker.version 1.9.2
         def player
           fetch('grateful_dead.players')
         end
 
+        ##
+        # Produces the name of a song by The Grateful Dead.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::GratefulDead.song #=> "Cassidy"
+        #
+        # @faker.version 1.9.2
         def song
           fetch('grateful_dead.songs')
         end

data/lib/faker/music/phish.rb

@@ -4,6 +4,15 @@ module Faker
   class Music
     class Phish < Base
       class << self
+        ##
+        # Produces the name of a song by Phish.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Phish.song #=> "Tweezer"
+        #
+        # @faker.version 1.9.2
         def song
           fetch('phish.song')
         end

data/lib/faker/music/rock_band.rb

@@ -4,6 +4,15 @@ module Faker
   class Music
     class RockBand < Base
       class << self
+        ##
+        # Produces the name of a rock band.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::RockBand.name #=> "Led Zeppelin"
+        #
+        # @faker.version 1.7.0
         def name
           fetch('rock_band.name')
         end