faker 2.15.1 → 3.4.2

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/music/hiphop.rb

@@ -14,7 +14,7 @@ module Faker
         #
         # @faker.version next
         def artist
-          fetch('hiphop.artist')
+          fetch('music.hiphop.artist')
         end
 
         ##
@@ -27,7 +27,7 @@ module Faker
         #
         # @faker.version next
         def groups
-          fetch('hiphop.groups')
+          fetch('music.hiphop.groups')
         end
 
         ##
@@ -40,7 +40,7 @@ module Faker
         #
         # @faker.version next
         def subgenres
-          fetch('hiphop.subgenres')
+          fetch('music.hiphop.subgenres')
         end
       end
     end

data/lib/faker/music/music.rb

@@ -128,6 +128,18 @@ module Faker
       def genre
         fetch('music.genres')
       end
+
+      ##
+      # Produces a name from Lou Bega's Mambo #5
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Music.mambo #=> "Monica"
+      # @faker.version next
+      def mambo_no_5
+        fetch('music.mambo_no_5')
+      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/smashing_pumpkins.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'music'
+
+module Faker
+  class Music
+    class SmashingPumpkins < Base
+      class << self
+        ##
+        # Produces the name of a member of the Smashing Pumpkins (current and former)
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::SmashingPumpkins.musician #=> "Billy Corgan"
+        #
+        # @faker.version next
+        def musician
+          fetch('smashing_pumpkins.musicians')
+        end
+
+        ##
+        # Produces the name of an album by the Smashing Pumpkins.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::SmashingPumpkins.album #=> "Siamese Dream"
+        #
+        # @faker.version next
+        def album
+          fetch('smashing_pumpkins.albums')
+        end
+
+        ##
+        # Produces a random Smashing Pumpkins song lyric.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::SmashingPumpkins.lyric #=> "Despite all my rage, I am still just a rat in a cage"
+        #   Faker::Music::SmashingPumpkins.lyric #=> "Breathin' underwater, and livin' under glass"
+        #
+        # @faker.version next
+        def lyric
+          fetch('smashing_pumpkins.lyric')
+        end
+
+        ##
+        # Produces the name of a song by the Smashing Pumpkins.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::SmashingPumpkins.song #=> "Stand Inside My Love"
+        #
+        # @faker.version next
+        def song
+          fetch('smashing_pumpkins.songs')
+        end
+      end
+    end
+  end
+end

data/lib/faker/quotes/quote.rb

@@ -106,6 +106,19 @@ module Faker
       def fortune_cookie
         fetch('quote.fortune_cookie')
       end
+
+      ##
+      # Produces a quote from comedian Mitch Hedberg.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.mitch_hedberg # => "I like Kit-Kats, unless I'm with four or more people."
+      #
+      # @faker.version next
+      def mitch_hedberg
+        fetch('quote.mitch_hedberg')
+      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

@@ -56,18 +56,52 @@ module Faker
           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

data/lib/faker/religion/bible.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Faker
+  module Religion
+    class Bible < Base
+      flexible :bible
+
+      class << self
+        ##
+        # Returns a random bible character.
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Religion::Bible.character #=> "Jesus"
+        #
+        # @faker.version next
+        def character
+          fetch('bible.character')
+        end
+
+        ##
+        # Returns a random location(city or town) from the bible
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Religion::Bible.location #=> "Nasareth"
+        #
+        # @faker.version next
+        def location
+          fetch('bible.location')
+        end
+
+        ##
+        # Returns a random quote from the location.
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Religion::Bible.quote #=> "Seek first the kingdom of God "
+        #
+        # @faker.version next
+        def quote
+          fetch('bible.quote')
+        end
+      end
+    end
+  end
+end

data/lib/faker/sports/chess.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Faker
+  class Sports
+    class Chess < Base
+      class << self
+        ##
+        # Produces the name of a chess player name.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Chess.player #=> "Golden State Warriors"
+        #
+        # @faker.version next
+        def player
+          fetch('chess.players')
+        end
+
+        ##
+        # Produces a long (alpha-3) ISO 3166 country code.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Chess.federation #=> "COL"
+        #
+        # @faker.version next
+        def federation
+          Faker::Address.country_code_long
+        end
+
+        def tournament
+          ##
+          # Produces the name of a famous chess tournament name.
+          #
+          # @return [String]
+          #
+          # @example
+          #   Faker::Chess.tournament #=> "Khanty-Mansisyk (Candidates Tournament)"
+          #
+          # @faker.version next
+          fetch('chess.tournaments')
+        end
+
+        def rating(from: 2000, to: 2900)
+          ##
+          # Produces a rating between two provided values. Boundaries are inclusive.
+          #
+          # @param from [Numeric] The lowest number to include.
+          # @param to [Numeric] The highest number to include.
+          # @return [Numeric]
+          #
+          # @example
+          #   Faker::Sports::Chess.rating #=> 2734
+          #   Faker::Sports::Chess.rating(from: 2400, to: 2700) #=> 2580
+          #
+          # @faker.version next
+          Faker::Base.rand_in_range(from, to)
+        end
+
+        ##
+        # Produces the name of a chess opening.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Chess.opening #=> "Giuoco Piano"
+        #
+        # @faker.version next
+        def opening
+          fetch('chess.openings')
+        end
+
+        ##
+        # Produces a chess title.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Chess.title #=> "GM"
+        #
+        # @faker.version next
+        def title
+          fetch('chess.titles')
+        end
+      end
+    end
+  end
+end

data/lib/faker/sports/mountaineering.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Faker
+  class Sports
+    class Mountaineering < Base
+      class << self
+        ##
+        # Produces the name of a Mountaineer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Mountaineering.mountaineer #=> "Junko Tabei"
+        #
+        # @faker.version next
+        def mountaineer
+          fetch('mountaineering.mountaineer')
+        end
+      end
+    end
+  end
+end

data/lib/faker/sports/sport.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Faker
+  class Sport < Base
+    class << self
+      ##
+      # Produces a sport from the modern olympics or paralympics, summer or winter.
+      #
+      # @param include_ancient [Boolean] If true, may produce a sport from the ancient olympics
+      # @param include_unusual [Boolean] If true, may produce an unusual (definitely not olympic) sport
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.sport #=> "Football"
+      # @example
+      #   Faker::Sport.sport(include_ancient: true) #=> "Chariot racing"
+      # @example
+      #   Faker::Sport.sport(include_unsual: true) #=> "Flugtag/Birdman"
+      # @example
+      #   Faker::Sport.sport(include_ancient:true, include_unusual: true) #=> "Water polo"
+      #
+      # @faker.version next
+      def sport(include_ancient: false, include_unusual: false)
+        sports = []
+        sports.concat(
+          fetch_all('sport.summer_olympics'),
+          fetch_all('sport.summer_paralympics'),
+          fetch_all('sport.winter_olympics'),
+          fetch_all('sport.winter_paralympics')
+        )
+        sports.concat(fetch_all('sport.ancient_olympics')) if include_ancient
+        sports.concat(fetch_all('sport.unusual')) if include_unusual
+        sample(sports)
+      end
+
+      ##
+      # Produces a sport from the summer olympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.summer_olympics_sport #=> "Archery"
+      #
+      # @faker.version next
+      def summer_olympics_sport
+        fetch('sport.summer_olympics')
+      end
+
+      ##
+      # Produces a sport from the winter olympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.winter_olympics_sport #=> "Bobsleigh"
+      #
+      # @faker.version next
+      def winter_olympics_sport
+        fetch('sport.winter_olympics')
+      end
+
+      ##
+      # Produces a sport from the summer paralympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.summer_paralympics_sport #=> "Wheelchair Basketball"
+      #
+      # @faker.version next
+      def summer_paralympics_sport
+        fetch('sport.summer_paralympics')
+      end
+
+      ##
+      # Produces a sport from the winter paralympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.winter_paralympics_sport #=> "Para Ice Hockey"
+      #
+      # @faker.version next
+      def winter_paralympics_sport
+        fetch('sport.winter_paralympics')
+      end
+
+      ##
+      # Produces an unusual sport.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.unusual_sport #=> "Camel Jumping"
+      #
+      # @faker.version next
+      def unusual_sport
+        fetch('sport.unusual')
+      end
+
+      ##
+      # Produces a sport from the ancient olympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.ancient_olympics_sport #=> "Pankration"
+      #
+      # @faker.version next
+      def ancient_olympics_sport
+        fetch('sport.ancient_olympics')
+      end
+    end
+  end
+end

data/lib/faker/travel/airport.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Faker
+  class Travel
+    class Airport < Base
+      class << self
+        ##
+        # Produces random Airport by name and takes arguments for size and region
+        #
+        # @param size [String] airport size, united_states has large, or medium, or small, european_union has large, or medium
+        #
+        # @param region [String] airport region, currently available -> united_states or european_union
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Travel::Airport.name(size: 'large', region: 'united_states') => "Los Angeles International Airport"
+        #
+        # @faker.version next
+        def name(size:, region:)
+          fetch("airport.#{region}.#{size}")
+        end
+
+        ##
+        # Produces random Airport by IATA code and takes arguments for size and region
+        #
+        # @param size [String] airport size, united_states has large, or medium, or small, european_union has large, or medium
+        #
+        # @param region [String] airport region, currently available -> united_states or european_union
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Travel::Airport.iata(size: 'large', region: 'united_states') => "LAX"
+        #
+        # @faker.version next
+        def iata(size:, region:)
+          fetch("airport.#{region}.iata_code.#{size}")
+        end
+      end
+    end
+  end
+end