faker 2.0.0 → 3.8.0

data/lib/faker/movies/star_wars.rb

@@ -4,46 +4,140 @@ 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
 
-          rand(0..10).times { sentence += ' ' + sample(wookiee_words) }
+          rand(0..10).times { sentence += " #{sample(wookiee_words)}" }
 
           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(character: nil)
           quoted_characters = translate('faker.star_wars.quotes')
 
@@ -57,42 +151,112 @@ 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)
+          fetch("star_wars.quotes.#{character}")
         end
 
+        ##
+        # Generates numbers array
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.call_numbers  #=> ["Leader", "#"]
+        #
+        # @faker.version 1.6.2
         def call_numbers
           fetch_all('star_wars.call_numbers')
         end
 
+        ##
+        # Returns squadrons array
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.call_squadrons  #=> ["Rogue", "Red", "Gray", "Green", "Blue", "Gold", "Black", "Yellow", "Phoenix"]
+        #
+        # @faker.version 1.6.2
         def call_squadrons
           fetch_all('star_wars.call_squadrons')
         end
 
+        ##
+        # Returns all character names in movie
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.characters
+        #
+        # @faker.version 1.6.2
         def characters
           fetch_all('star_wars.characters')
         end
 
+        ##
+        # Returns droid list
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.droids
+        #
+        # @faker.version 1.6.2
         def droids
           fetch_all('star_wars.droids')
         end
 
+        ##
+        # Lists out all planet names
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.planets
+        #
+        # @faker.version 1.6.2
         def planets
           fetch_all('star_wars.planets')
         end
 
+        ##
+        # Returns name of all species
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.species
+        #
+        # @faker.version 1.6.2
         def species
           fetch_all('star_wars.species')
         end
 
+        ##
+        # Lists out all vehicles
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.vehicles
+        #
+        # @faker.version 1.6.2
         def vehicles
           fetch_all('star_wars.vehicles')
         end
 
+        ##
+        # All wookiee words
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.wookiee_words
+        #
+        # @faker.version 1.6.2
         def wookiee_words
           fetch_all('star_wars.wookiee_words')
         end

data/lib/faker/movies/the_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('the_room.actors')
+        end
+
+        ##
+        # Produces a character from The Room (2003).
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Room.character #=> "Johnny"
+        #
+        # @faker.version next
+        def character
+          fetch('the_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('the_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('the_room.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/movies/tron.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module Faker
+  class Movies
+    class Tron < Base
+      class << self
+        ##
+        # Produces a character from Tron.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Tron.character #=> "Bit"
+        #
+        # @faker.version next
+        def character
+          sample(characters)
+        end
+
+        ##
+        # Produces a game from Tron.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Tron.game #=> "Space Paranoids"
+        #
+        # @faker.version next
+        def game
+          sample(games)
+        end
+
+        ##
+        # Produces a location from Tron.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Tron.location #=> "Flynn's Arcade"
+        #
+        # @faker.version next
+        def location
+          sample(locations)
+        end
+
+        ##
+        # Produces a program from Tron.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Tron.program #=> "Clu"
+        #
+        # @faker.version next
+        def program
+          sample(programs)
+        end
+
+        ##
+        # Produces a quote from Tron.
+        #
+        # @param character [String] The name of a character to derive a quote from.
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Tron.quote #=> "Greetings, Programs!"
+        #
+        # @example
+        #   Faker::Movies::Tron.quote(character: "mcp")
+        #     #=> "End of Line."
+        #
+        # @faker.version next
+        def quote(character: nil)
+          quoted_characters = translate('faker.tron.quotes')
+
+          if character.nil?
+            character = sample(quoted_characters.keys).to_s
+          else
+            character = character.to_s.downcase
+
+            # check alternate spellings, nicknames, titles of characters
+            translate('faker.tron.alternate_character_spellings').each do |k, v|
+              character = k.to_s if v.include?(character)
+            end
+
+            raise ArgumentError, "Character for quotes can be left blank or #{quoted_characters.keys.join(', ')}" unless quoted_characters.key?(character.to_sym)
+          end
+
+          fetch("tron.quotes.#{character}")
+        end
+
+        ##
+        # Produces a tagline from Tron.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Tron.tagline #=> "The Electronic Gladiator"
+        #
+        # @faker.version next
+        def tagline
+          sample(taglines)
+        end
+
+        ##
+        # Produces a user from Tron.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Tron.user #=> "Light Cycle"
+        #
+        # @faker.version next
+        def user
+          sample(users)
+        end
+
+        ##
+        # Produces a vehicle from Tron.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Tron.vehicle #=> "Light Cycle"
+        #
+        # @faker.version next
+        def vehicle
+          sample(vehicles)
+        end
+
+        def characters
+          translate('faker.tron.characters').values.flatten
+        end
+
+        def games
+          fetch_all('tron.games')
+        end
+
+        def locations
+          fetch_all('tron.locations')
+        end
+
+        def programs
+          fetch_all('tron.characters.programs')
+        end
+
+        def taglines
+          fetch_all('tron.taglines')
+        end
+
+        def users
+          fetch_all('tron.characters.users')
+        end
+
+        def vehicles
+          fetch_all('tron.vehicles')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Faker
+  class Movies
+    if Faker::Config.lazy_loading?
+      Faker.lazy_load(self)
+    end
+  end
+end

data/lib/faker/music/bossa_nova.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Faker
+  class Music
+    class BossaNova < Base
+      class << self
+        ##
+        # Produces the name of a bossa nova artist.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::BossaNova.artist #=> "Tom Jobin"
+        #
+        # @faker.version 1.8.3
+        def artist
+          fetch('bossa_nova.artists')
+        end
+
+        ##
+        # Produces a bossa nova song.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::BossaNova.song #=> "Chega de Saudade"
+        #
+        # @faker.version 1.8.3
+        def song
+          fetch('bossa_nova.songs')
+        end
+      end
+    end
+  end
+end

data/lib/faker/music/grateful_dead.rb

@@ -1,15 +1,31 @@
 # frozen_string_literal: true
 
-require_relative 'music'
-
 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/hiphop.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Music
+    class Hiphop < Base
+      class << self
+        ##
+        # Produces the name of a Hip Hop Artist
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Hiphop.artist #=> "Lil Wayne"
+        #
+        # @faker.version next
+        def artist
+          fetch('music.hiphop.artist')
+        end
+
+        ##
+        # Produces the name of a Hip Hop Group
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Hiphop.groups #=> "OVO"
+        #
+        # @faker.version next
+        def groups
+          fetch('music.hiphop.groups')
+        end
+
+        ##
+        # Produces the name of a Hip Hop Subgenre
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::Hiphop.subgeneres #=> "Alternative"
+        #
+        # @faker.version next
+        def subgenres
+          fetch('music.hiphop.subgenres')
+        end
+      end
+    end
+  end
+end