faker 2.3.0 → 2.7.0

data/lib/faker/movies/ghostbusters.rb

@@ -4,14 +4,42 @@ module Faker
   class Movies
     class Ghostbusters < Base
       class << self
+        ##
+        # Produces an actor from Ghostbusters.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Ghostbusters.actor #=> "Bill Murray"
+        #
+        # @faker.version 1.9.2
         def actor
           fetch('ghostbusters.actors')
         end
 
+        ##
+        # Produces a character from Ghostbusters.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Ghostbusters.character #=> "Dr. Egon Spengler"
+        #
+        # @faker.version 1.9.2
         def character
           fetch('ghostbusters.characters')
         end
 
+        ##
+        # Produces a quote from Ghostbusters.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Ghostbusters.quote
+        #     #=> "I tried to think of the most harmless thing. Something I loved from my childhood. Something that could never ever possibly destroy us. Mr. Stay Puft!"
+        #
+        # @faker.version 1.9.2
         def quote
           fetch('ghostbusters.quotes')
         end

data/lib/faker/movies/harry_potter.rb

@@ -4,26 +4,80 @@ module Faker
   class Movies
     class HarryPotter < Base
       class << self
+        ##
+        # Produces a character from Harry Potter.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HarryPotter.character #=> "Harry Potter"
+        #
+        # @faker.version 1.7.3
         def character
           fetch('harry_potter.characters')
         end
 
+        ##
+        # Produces a location from Harry Potter.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HarryPotter.location #=> "Hogwarts"
+        #
+        # @faker.version 1.7.3
         def location
           fetch('harry_potter.locations')
         end
 
+        ##
+        # Produces a quote from Harry Potter.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HarryPotter.quote #=> "I solemnly swear that I am up to good."
+        #
+        # @faker.version 1.7.3
         def quote
           fetch('harry_potter.quotes')
         end
 
+        ##
+        # Produces a book from Harry Potter.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HarryPotter.book #=> "Harry Potter and the Chamber of Secrets"
+        #
+        # @faker.version 1.7.3
         def book
           fetch('harry_potter.books')
         end
 
+        ##
+        # Produces a house from Harry Potter.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HarryPotter.house #=> "Gryffindor"
+        #
+        # @faker.version 1.7.3
         def house
           fetch('harry_potter.houses')
         end
 
+        ##
+        # Produces a spell from Harry Potter.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HarryPotter.spell #=> "Reparo"
+        #
+        # @faker.version 1.7.3
         def spell
           fetch('harry_potter.spells')
         end

data/lib/faker/movies/hitchhikers_guide_to_the_galaxy.rb

@@ -4,30 +4,99 @@ module Faker
   class Movies
     class HitchhikersGuideToTheGalaxy < Base
       class << self
+        ##
+        # Produces a character from The Hitchhiker's Guide to the Galaxy.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HitchhikersGuideToTheGalaxy.character #=> "Marvin"
+        #
+        # @faker.version 1.8.0
         def character
           fetch('hitchhikers_guide_to_the_galaxy.characters')
         end
 
+        ##
+        # Produces a location from The Hitchhiker's Guide to the Galaxy.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HitchhikersGuideToTheGalaxy.location
+        #     #=> "Arthur Dent's house"
+        #
+        # @faker.version 1.8.0
         def location
           fetch('hitchhikers_guide_to_the_galaxy.locations')
         end
 
+        ##
+        # Produces a Marvin quote from The Hitchhiker's Guide to the Galaxy.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HitchhikersGuideToTheGalaxy.marvin_quote
+        #     #=> "Life? Don't talk to me about life."
+        #
+        # @faker.version 1.8.0
         def marvin_quote
           fetch('hitchhikers_guide_to_the_galaxy.marvin_quote')
         end
 
+        ##
+        # Produces a planet from The Hitchhiker's Guide to the Galaxy.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HitchhikersGuideToTheGalaxy.planet
+        #     #=> "Magrathea"
+        #
+        # @faker.version 1.8.0
         def planet
           fetch('hitchhikers_guide_to_the_galaxy.planets')
         end
 
+        ##
+        # Produces a quote from The Hitchhiker's Guide to the Galaxy.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HitchhikersGuideToTheGalaxy.quote
+        #     #=> "In the beginning, the Universe was created. This has made a lot of people very angry and been widely regarded as a bad move."
+        #
+        # @faker.version 1.8.0
         def quote
           fetch('hitchhikers_guide_to_the_galaxy.quotes')
         end
 
+        ##
+        # Produces a species from The Hitchhiker's Guide to the Galaxy.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HitchhikersGuideToTheGalaxy.specie
+        #     #=> "Perfectly Normal Beast"
+        #
+        # @faker.version 1.8.0
         def specie
           fetch('hitchhikers_guide_to_the_galaxy.species')
         end
 
+        ##
+        # Produces a starship from The Hitchhiker's Guide to the Galaxy.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HitchhikersGuideToTheGalaxy.starship
+        #     #=> "Vogon Constructor Fleet"
+        #
+        # @faker.version 1.8.0
         def starship
           fetch('hitchhikers_guide_to_the_galaxy.starships')
         end

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,6 +124,20 @@ 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)
           warn_for_deprecated_arguments do |keywords|
             keywords << :character if legacy_character != NOT_GIVEN