faker 2.1.2 → 2.6.0

data/lib/faker/default/vehicle.rb

@@ -9,7 +9,7 @@ module Faker
     VIN_LETTERS = 'ABCDEFGHJKLMNPRSTUVWXYZ'
     VIN_MAP = '0123456789X'
     VIN_WEIGHTS = '8765432X098765432'
-    VIN_REGEX = /^[A-Z0-9]{3}[A-Z0-9]{5}[A-Z0-9]{1}[A-Z0-9]{1}[A-Z0-0]{1}[A-Z0-9]{1}\d{5}$/
+    VIN_REGEX = /^[A-Z0-9]{3}[A-Z0-9]{5}[A-Z0-9]{1}[A-Z0-9]{1}[A-Z0-0]{1}[A-Z0-9]{1}\d{5}$/.freeze
     SG_CHECKSUM_WEIGHTS = [3, 14, 2, 12, 2, 11, 1].freeze
     SG_CHECKSUM_CHARS = 'AYUSPLJGDBZXTRMKHEC'
 
@@ -26,7 +26,11 @@ module Faker
         fetch('vehicle.makes')
       end
 
-      def model(make_of_model: '')
+      def model(legacy_make_of_model = NOT_GIVEN, make_of_model: '')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :make_of_model if legacy_make_of_model != NOT_GIVEN
+        end
+
         return fetch("vehicle.models_by_make.#{make}") if make_of_model.empty?
 
         fetch("vehicle.models_by_make.#{make_of_model}")
@@ -85,13 +89,22 @@ module Faker
         Faker::Time.backward(days: rand_in_range(365, 5475), period: :all, format: '%Y').to_i
       end
 
-      def mileage(min: MILEAGE_MIN, max: MILEAGE_MAX)
+      def mileage(legacy_min = NOT_GIVEN, legacy_max = NOT_GIVEN, min: MILEAGE_MIN, max: MILEAGE_MAX)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :min if legacy_min != NOT_GIVEN
+          keywords << :max if legacy_max != NOT_GIVEN
+        end
+
         rand_in_range(min, max)
       end
 
       alias kilometrage mileage
 
-      def license_plate(state_abreviation: '')
+      def license_plate(legacy_state_abreviation = NOT_GIVEN, state_abreviation: '')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :state_abreviation if legacy_state_abreviation != NOT_GIVEN
+        end
+
         return regexify(bothify(fetch('vehicle.license_plate'))) if state_abreviation.empty?
 
         key = 'vehicle.license_plate_by_state.' + state_abreviation

data/lib/faker/default/world_cup.rb

@@ -3,23 +3,82 @@
 module Faker
   class WorldCup < Base
     class << self
+      ##
+      # Produces a national team name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::WorldCup.team #=> "Iran"
+      #
+      # @faker.version 1.9.0
       def team
         fetch('world_cup.teams')
       end
 
+      ##
+      # Produces a city name hosting the World Cup match.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::WorldCup.city #=> "Moscow"
+      #
+      # @faker.version next
       def city
         fetch('world_cup.cities')
       end
 
+      ##
+      # Produces the name of a stadium that has hosted a World Cup match.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::WorldCup.stadium #=> "Rostov Arena"
+      #
+      # @faker.version next
       def stadium
         fetch('world_cup.stadiums')
       end
 
-      def group(group: 'group_A')
+      ##
+      # Produces a random national team name from a group. See below examples
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::WorldCup.group(group: 'group_B') #=> "Spain"
+      # @example
+      #   Faker::WorldCup.group #=> "Russia"
+      #
+      # @faker.version next
+      def group(legacy_group = NOT_GIVEN, group: 'group_A')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :group if legacy_group != NOT_GIVEN
+        end
+
         fetch("world_cup.groups.#{group}")
       end
 
-      def roster(country: 'Egypt', type: 'coach')
+      ##
+      # Produces a random name from national team roster. See below examples.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::WorldCup.roster #=> "Hector Cuper"
+      #
+      # @example
+      #   Faker::WorldCup.roster(country: 'Spain', type: 'forwards') #=> "Diego Costa"
+      #
+      # @faker.version next
+      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
+          keywords << :type if legacy_type != NOT_GIVEN
+        end
+
         fetch("world_cup.rosters.#{country}.#{type}")
       end
     end

data/lib/faker/games/dota.rb

@@ -4,23 +4,74 @@ module Faker
   class Games
     class Dota < Base
       class << self
+        ##
+        # Produces the name of a hero from Dota.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.hero #=> "Abaddon"
+        #
+        # @faker.version 1.9.0
         def hero
           fetch('games.dota.hero')
         end
 
+        ##
+        # Produces the name of an item from Dota.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.item #=> "Armlet of Mordiggian"
+        #
+        # @faker.version 1.9.0
         def item
           fetch('games.dota.item')
         end
 
+        ##
+        # Produces the name of a professional Dota team.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.team #=> "Evil Geniuses"
+        #
+        # @faker.version 1.9.0
         def team
           fetch('games.dota.team')
         end
 
+        ##
+        # Produces the name of a professional Dota player.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.player #=> "Dendi"
+        #
+        # @faker.version 1.9.0
         def player
           fetch('games.dota.player')
         end
 
-        def quote(hero: 'abaddon')
+        ##
+        # Produces the name of a hero from Dota.
+        #
+        # @param hero [String] The name of a Dota hero.
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.quote #=> "You have called death upon yourself."
+        #   Faker::Games::Dota.quote(hero: 'alchemist') #=> "Better living through alchemy!"
+        #
+        # @faker.version 1.9.0
+        def quote(legacy_hero = NOT_GIVEN, hero: 'abaddon')
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :hero if legacy_hero != NOT_GIVEN
+          end
+
           fetch("games.dota.#{hero}.quote")
         end
       end

data/lib/faker/games/elder_scrolls.rb

@@ -4,34 +4,106 @@ module Faker
   class Games
     class ElderScrolls < Base
       class << self
+        ##
+        # Produces the name of a race from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.race #=> "Argonian"
+        #
+        # @faker.version 1.9.2
         def race
           fetch('games.elder_scrolls.race')
         end
 
+        ##
+        # Produces the name of a city from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.city #=> "Whiterun"
+        #
+        # @faker.version 1.9.2
         def city
           fetch('games.elder_scrolls.city')
         end
 
+        ##
+        # Produces the name of a creature from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.creature #=> "Frost Troll"
+        #
+        # @faker.version 1.9.2
         def creature
           fetch('games.elder_scrolls.creature')
         end
 
+        ##
+        # Produces the name of a region from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.region #=> "Cyrodiil"
+        #
+        # @faker.version 1.9.2
         def region
           fetch('games.elder_scrolls.region')
         end
 
+        ##
+        # Produces the name of a dragon from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.dragon #=> "Blood Dragon"
+        #
+        # @faker.version 1.9.2
         def dragon
           fetch('games.elder_scrolls.dragon')
         end
 
+        ##
+        # Produces a randomly generated name from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.name #=> "Balgruuf The Old"
+        #
+        # @faker.version 1.9.2
         def name
           "#{fetch('games.elder_scrolls.first_name')} #{fetch('games.elder_scrolls.last_name')}"
         end
 
+        ##
+        # Produces a first name from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.first_name #=> "Balgruuf"
+        #
+        # @faker.version 1.9.2
         def first_name
           fetch('games.elder_scrolls.first_name')
         end
 
+        ##
+        # Produces a last name from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.last_name #=> "The Old"
+        #
+        # @faker.version 1.9.2
         def last_name
           fetch('games.elder_scrolls.last_name')
         end

data/lib/faker/games/fallout.rb

@@ -4,18 +4,55 @@ module Faker
   class Games
     class Fallout < Base
       class << self
+        ##
+        # Produces the name of a character from the Fallout games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Fallout.character #=> "Liberty Prime"
+        #
+        # @faker.version 1.9.2
         def character
           fetch('games.fallout.characters')
         end
 
+        ##
+        # Produces the name of a faction from the Fallout games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Fallout.faction #=> "Brotherhood of Steel"
+        #
+        # @faker.version 1.9.2
         def faction
           fetch('games.fallout.factions')
         end
 
+        ##
+        # Produces the name of a location from the Fallout games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Fallout.location #=> "New Vegas"
+        #
+        # @faker.version 1.9.2
         def location
           fetch('games.fallout.locations')
         end
 
+        ##
+        # Produces a quote from the Fallout games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Fallout.quote
+        #     #=> "Democracy is non-negotiable"
+        #
+        # @faker.version 1.9.2
         def quote
           fetch('games.fallout.quotes')
         end

data/lib/faker/games/game.rb

@@ -5,14 +5,41 @@ module Faker
     flexible :game
 
     class << self
+      ##
+      # Produces the name of a video game.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Game.title #=> "Half-Life 2"
+      #
+      # @faker.version 1.9.4
       def title
         fetch('game.title')
       end
 
+      ##
+      # Produces the name of a video game genre.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Game.genre #=> "Real-time strategy"
+      #
+      # @faker.version 1.9.4
       def genre
         fetch('game.genre')
       end
 
+      ##
+      # Produces the name of a video game console or platform.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Game.platform #=> "Nintendo Switch"
+      #
+      # @faker.version 1.9.4
       def platform
         fetch('game.platform')
       end

data/lib/faker/games/half_life.rb

@@ -4,14 +4,41 @@ module Faker
   class Games
     class HalfLife < Base
       class << self
+        ##
+        # Produces the name of a character from the Half-Life games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HalfLife.character #=> "Gordon Freeman"
+        #
+        # @faker.version 1.9.2
         def character
           fetch('games.half_life.character')
         end
 
+        ##
+        # Produces the name of an enemy from the Half-Life games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HalfLife.enemy #=> "Headcrab"
+        #
+        # @faker.version 1.9.2
         def enemy
           fetch('games.half_life.enemy')
         end
 
+        ##
+        # Produces the name of a location from the Half-Life games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HalfLife.location #=> "Black Mesa Research Facility"
+        #
+        # @faker.version 1.9.2
         def location
           fetch('games.half_life.location')
         end