faker 2.12.0 → 2.13.0

data/lib/faker/default/omniauth.rb

@@ -15,6 +15,16 @@ module Faker
     end
 
     class << self
+      ##
+      # Generate a mock Omniauth response from Google.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-google.
+      #
+      # @faker.version 1.8.0
       # rubocop:disable Metrics/ParameterLists
       def google(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 9).to_s)
         # rubocop:enable Metrics/ParameterLists
@@ -72,6 +82,17 @@ module Faker
         }
       end
 
+      ##
+      # Generate a mock Omniauth response from Facebook.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param username [String] A specific username to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-facebook.
+      #
+      # @faker.version 1.8.0
       # rubocop:disable Metrics/ParameterLists
       def facebook(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_username = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, username: nil, uid: Number.number(digits: 7).to_s)
         # rubocop:enable Metrics/ParameterLists
@@ -123,6 +144,16 @@ module Faker
         }
       end
 
+      ##
+      # Generate a mock Omniauth response from Twitter.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param nickname [String] A specific nickname to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-twitter.
+      #
+      # @faker.version 1.8.0
       # rubocop:disable Metrics/ParameterLists
       def twitter(legacy_name = NOT_GIVEN, legacy_nickname = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, nickname: nil, uid: Number.number(digits: 6).to_s)
         # rubocop:enable Metrics/ParameterLists
@@ -204,6 +235,16 @@ module Faker
         }
       end
 
+      ##
+      # Generate a mock Omniauth response from LinkedIn.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-linkedin.
+      #
+      # @faker.version 1.8.0
       # rubocop:disable Metrics/ParameterLists
       def linkedin(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 6).to_s)
         # rubocop:enable Metrics/ParameterLists
@@ -275,6 +316,16 @@ module Faker
         }
       end
 
+      ##
+      # Generate a mock Omniauth response from Github.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-github.
+      #
+      # @faker.version 1.8.0
       # rubocop:disable Metrics/ParameterLists
       def github(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 8).to_s)
         # rubocop:enable Metrics/ParameterLists
@@ -342,13 +393,15 @@ module Faker
       end
 
       ##
-      # Generate a mock Omniauth response from Apple
+      # Generate a mock Omniauth response from Apple.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
       #
-      # @param name [String] A specific name to return in the response
-      # @param email [String] A specific email to return in the response
-      # @param uid [String] A specific UID to return in the response
+      # @return [Hash] An auth hash in the format provided by omniauth-apple.
       #
-      # @return [Hash] An auth hash in the format provided by omniauth-apple
+      # @faker.version 2.3.0
       def apple(name: nil, email: nil, uid: nil)
         uid ||= "#{Number.number(digits: 6)}.#{Number.hexadecimal(digits: 32)}.#{Number.number(digits: 4)}"
         auth = Omniauth.new(name: name, email: email)

data/lib/faker/default/world_cup.rb

@@ -24,7 +24,7 @@ module Faker
       # @example
       #   Faker::WorldCup.city #=> "Moscow"
       #
-      # @faker.version next
+      # @faker.version 2.13.0
       def city
         fetch('world_cup.cities')
       end
@@ -37,7 +37,7 @@ module Faker
       # @example
       #   Faker::WorldCup.stadium #=> "Rostov Arena"
       #
-      # @faker.version next
+      # @faker.version 2.13.0
       def stadium
         fetch('world_cup.stadiums')
       end
@@ -52,7 +52,7 @@ module Faker
       # @example
       #   Faker::WorldCup.group #=> "Russia"
       #
-      # @faker.version next
+      # @faker.version 2.13.0
       def group(legacy_group = NOT_GIVEN, group: 'group_A')
         warn_for_deprecated_arguments do |keywords|
           keywords << :group if legacy_group != NOT_GIVEN
@@ -72,7 +72,7 @@ module Faker
       # @example
       #   Faker::WorldCup.roster(country: 'Spain', type: 'forwards') #=> "Diego Costa"
       #
-      # @faker.version next
+      # @faker.version 2.13.0
       def roster(legacy_country = NOT_GIVEN, legacy_type = NOT_GIVEN, country: 'Egypt', type: 'coach')
         warn_for_deprecated_arguments do |keywords|
           keywords << :country if legacy_country != NOT_GIVEN

data/lib/faker/games/control.rb

@@ -12,7 +12,7 @@ module Faker
         # @example
         #   Faker::Games::Control.character #=> "Jesse Faden"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def character
           fetch('games.control.character')
         end
@@ -25,7 +25,7 @@ module Faker
         # @example
         #   Faker::Games::Control.character #=> "Dimensional Research"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def location
           fetch('games.control.location')
         end
@@ -38,7 +38,7 @@ module Faker
         # @example
         #   Faker::Games::Control.object_of_power #=> "Hotline"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def object_of_power
           fetch('games.control.object_of_power')
         end
@@ -51,7 +51,7 @@ module Faker
         # @example
         #   Faker::Games::Control.altered_item #=> "Rubber Duck"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def altered_item
           fetch('games.control.altered_item')
         end
@@ -64,7 +64,7 @@ module Faker
         # @example
         #   Faker::Games::Control.altered_world_event #=> "Ordinary, Wisconsin"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def altered_world_event
           fetch('games.control.altered_world_event')
         end
@@ -77,7 +77,7 @@ module Faker
         # @example
         #   Faker::Games::Control.hiss #=> "Push the fingers through the surface into the wet."
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def hiss
           fetch('games.control.hiss')
         end
@@ -90,7 +90,7 @@ module Faker
         # @example
         #   Faker::Games::Control.the_board #=> "< You/We wield the Gun/You. The Board appoints you. Congratulations, Director. >"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def the_board
           fetch('games.control.the_board')
         end
@@ -103,7 +103,7 @@ module Faker
         # @example
         #   Faker::Games::Control.quote #=> "He never liked fridge duty"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def quote
           fetch('games.control.quote')
         end

data/lib/faker/games/dnd.rb

@@ -12,7 +12,7 @@ module Faker
         # @example
         #   Faker::Games::DnD.race #=> "Dwarf"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def species
           fetch('dnd.species')
         end
@@ -25,7 +25,7 @@ module Faker
         # @example
         #   Faker::Games::DnD.klass #=> "Warlock"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def klass
           fetch('dnd.klasses')
         end
@@ -38,7 +38,7 @@ module Faker
         # @example
         #   Faker::Games::DnD.background #=> "Urchin"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def background
           fetch('dnd.backgrounds')
         end
@@ -51,7 +51,7 @@ module Faker
         # @example
         #   Faker::Games::DnD.alignment #=> "Lawful Neutral"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def alignment
           fetch('dnd.alignments')
         end

data/lib/faker/games/heroes_of_the_storm.rb

@@ -18,16 +18,27 @@ module Faker
         end
 
         ##
-        # Produces a class from Heroes of the Storm.
+        # This method is deprecated. The implementation will be removed in a near future release.
+        # Use `HeroesOfTheStorm.class_name` instead.
+        #
+        # @deprecated Use {#class_name} instead.
+        def class
+          warn '`HeroesOfTheStorm.class` is deprecated. Use `HeroesOfTheStorm.class_name` instead.'
+
+          super
+        end
+
+        ##
+        # Produces a class name from Heroes of the Storm.
         #
         # @return [String]
         #
         # @example
-        #   Faker::Games::HeroesOfTheStorm.class #=> "Support"
+        #   Faker::Games::HeroesOfTheStorm.class_name #=> "Support"
         #
-        # @faker.version 1.9.2
-        def class
-          fetch('heroes_of_the_storm.classes')
+        # @faker.version 2.13.0
+        def class_name
+          fetch('heroes_of_the_storm.class_names')
         end
 
         ##

data/lib/faker/games/minecraft.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class Minecraft < Base
+      class << self
+        ##
+        # Produces the name of a block from Minecraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Minecraft.block #=> "Stone"
+        #
+        # @faker.version 2.13.0
+        def block
+          fetch('games.minecraft.blocks')
+        end
+
+        ##
+        # Produces the name of an item from Minecraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Minecraft.item #=> "Iron Shovel"
+        #
+        # @faker.version 2.13.0
+        def item
+          fetch('games.minecraft.items')
+        end
+
+        ##
+        # Produces the name of a mob from Minecraft.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Minecraft.item #=> "Sheep"
+        #
+        # @faker.version 2.13.0
+        def mob
+          fetch('games.minecraft.mobs')
+        end
+      end
+    end
+  end
+end

data/lib/faker/games/warhammer_fantasy.rb

@@ -12,7 +12,7 @@ module Faker
         # @example
         #   Faker::Games::WarhammerFantasy.hero #=> "Sigmar Heldenhammer"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def hero
           fetch('games.warhammer_fantasy.heros')
         end
@@ -25,7 +25,7 @@ module Faker
         # @example
         #   Faker::Games::WarhammerFantasy.quote #=> "The softest part of a castle is the belly of the man inside."
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def quote
           fetch('games.warhammer_fantasy.quotes')
         end
@@ -38,7 +38,7 @@ module Faker
         # @example
         #   Faker::Games::WarhammerFantasy.location #=> "Lustria"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def location
           fetch('games.warhammer_fantasy.locations')
         end
@@ -51,7 +51,7 @@ module Faker
         # @example
         #   Faker::Games::WarhammerFantasy.faction #=> "Bretonnia"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def faction
           fetch('games.warhammer_fantasy.factions')
         end
@@ -64,7 +64,7 @@ module Faker
         # @example
         #   Faker::Games::WarhammerFantasy.creature #=> "Hydra"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def creature
           fetch('games.warhammer_fantasy.creatures')
         end

data/lib/faker/movies/departed.rb

@@ -12,7 +12,7 @@ module Faker
         # @example
         #   Faker::Movies::Departed.actor #=> "Matt Damon"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def actor
           fetch('departed.actors')
         end
@@ -25,7 +25,7 @@ module Faker
         # @example
         #   Faker::Movies::Departed.character #=> "Frank Costello"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def character
           fetch('departed.characters')
         end
@@ -39,7 +39,7 @@ module Faker
         #   Faker::Movies::Departed.quote
         #     #=> "I'm the guy who does his job. You must be the other guy"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def quote
           fetch('departed.quotes')
         end

data/lib/faker/movies/movie.rb

@@ -3,6 +3,19 @@
 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.
       #

data/lib/faker/music/pearl_jam.rb

@@ -14,7 +14,7 @@ module Faker
         # @example
         #   Faker::Music::PearlJam.musician #=> "Eddie Vedder"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def musician
           fetch('pearl_jam.musicians')
         end
@@ -27,7 +27,7 @@ module Faker
         # @example
         #   Faker::Music::PearlJam.album #=> "Ten"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def album
           fetch('pearl_jam.albums')
         end
@@ -40,7 +40,7 @@ module Faker
         # @example
         #   Faker::Music::PearlJam.song #=> "Even Flow"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def song
           fetch('pearl_jam.songs')
         end

data/lib/faker/music/phish.rb

@@ -12,7 +12,7 @@ module Faker
         # @example
         #   Faker::Music::Phish.album #=> "Fuego"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def album
           fetch('phish.albums')
         end
@@ -25,7 +25,7 @@ module Faker
         # @example
         #   Faker::Music::Phish.musician #=> "Trey Anastasio"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def musician
           fetch('phish.musicians')
         end