faker 2.2.0 → 3.2.2

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Movies
+    class Hackers < Base
+      class << self
+        ##
+        # Produces a real character name from Hackers.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hackers.character #=> "Dade Murphy"
+        #
+        # @faker.version next
+        def character
+          fetch('hackers.characters')
+        end
+
+        ##
+        # Produces a character hacker "handle" from Hackers.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hackers.handle #=> "Zero Cool"
+        #
+        # @faker.version next
+        def handle
+          fetch('hackers.handles')
+        end
+
+        ##
+        # Produces a quote from Hackers.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hackers.quote #=> "Hack the Planet!"
+        #
+        # @faker.version next
+        def quote
+          fetch('hackers.quotes')
+        end
+      end
+    end
+  end
+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,20 +4,57 @@ 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')
+          fetch('tolkien.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')
+          fetch('tolkien.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')
+          fetch('tolkien.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')
+          fetch('tolkien.hobbit.location')
         end
       end
     end

data/lib/faker/movies/how_to_train_your_dragon.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Movies
+    class HowToTrainYourDragon < Base
+      class << self
+        ##
+        # Produces a character from How To Train Your Dragon.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HowToTrainYourDragon.character #=> "Hiccup"
+        #
+        # @faker.version next
+        def character
+          fetch('how_to_train_your_dragon.characters')
+        end
+
+        ##
+        # Produces a location from How To Train Your Dragon.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HowToTrainYourDragon.location #=> "Berk"
+        #
+        # @faker.version next
+        def location
+          fetch('how_to_train_your_dragon.locations')
+        end
+
+        ##
+        # Produces a dragon from How To Train Your Dragon.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::HowToTrainYourDragon.dragons #=> "Toothless"
+        #
+        # @faker.version next
+        def dragon
+          fetch('how_to_train_your_dragon.dragons')
+        end
+      end
+    end
+  end
+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,16 +4,44 @@ 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')
+          fetch('tolkien.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')
+          fetch('tolkien.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')
+          fetch('tolkien.lord_of_the_rings.quotes')
         end
       end
     end

data/lib/faker/movies/movie.rb

@@ -3,6 +3,28 @@
 module Faker
   class Movie < Base
     class << self
+      ##
+      # Produces a title from a movie.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Movie.title #=> "The Lord of the Rings: The Two Towers"
+      #
+      # @faker.version 2.13.0
+      def title
+        fetch('movie.title')
+      end
+
+      ##
+      # 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/room.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Faker
+  class Movies
+    class TheRoom < Base
+      class << self
+        ##
+        # Produces an actor from The Room (2003).
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Room.actor #=> "Tommy Wiseau"
+        #
+        # @faker.version next
+        def actor
+          fetch('room.actors')
+        end
+
+        ##
+        # Produces a character from The Room (2003).
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Room.character #=> "Johnny"
+        #
+        # @faker.version next
+        def character
+          fetch('room.characters')
+        end
+
+        ##
+        # Produces a location from The Room (2003).
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Room.location #=> "Johnny's Apartment"
+        #
+        # @faker.version next
+        def location
+          fetch('room.locations')
+        end
+
+        ##
+        ##
+        # Produces a quote from The Room (2003).
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Room.quote
+        #     #=> "You're lying, I never hit you. You are tearing me apart, Lisa!"
+        #
+        # @faker.version next
+        def quote
+          fetch('room.quotes')
+        end
+      end
+    end
+  end
+end