faker 2.1.2 → 2.4.0

data/lib/faker/default/twitter.rb

@@ -3,7 +3,12 @@
 module Faker
   class Twitter < Base
     class << self
-      def user(include_status: true, include_email: false)
+      def user(legacy_include_status = NOT_GIVEN, legacy_include_email = NOT_GIVEN, include_status: true, include_email: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :include_status if legacy_include_status != NOT_GIVEN
+          keywords << :include_email if legacy_include_email != NOT_GIVEN
+        end
+
         user_id = id
         background_image_url = Faker::LoremPixel.image(size: '600x400') # TODO: Make the dimensions change
         profile_image_url = Faker::Avatar.image(slug: user_id, size: '48x48')
@@ -15,7 +20,7 @@ module Faker
           default_profile_image: Faker::Boolean.boolean(true_ratio: 0.1),
           default_profile: Faker::Boolean.boolean(true_ratio: 0.1),
           description: Faker::Lorem.sentence,
-          entities:  user_entities,
+          entities: user_entities,
           favourites_count: Faker::Number.between(to: 1, from: 100_000),
           follow_request_sent: false,
           followers_count: Faker::Number.between(to: 1, from: 10_000_000),
@@ -54,7 +59,12 @@ module Faker
         user
       end
 
-      def status(include_user: true, include_photo: false)
+      def status(legacy_include_user = NOT_GIVEN, legacy_include_photo = NOT_GIVEN, include_user: true, include_photo: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :include_user if legacy_include_user != NOT_GIVEN
+          keywords << :include_photo if legacy_include_photo != NOT_GIVEN
+        end
+
         status_id = id
         status = {
           id: status_id,
@@ -62,7 +72,7 @@ module Faker
           contributors: nil,
           coordinates: nil,
           created_at: created_at,
-          entities:  status_entities(include_photo: include_photo),
+          entities: status_entities(include_photo: include_photo),
           favorite_count: Faker::Number.between(to: 1, from: 10_000),
           favorited: false,
           geo: nil,
@@ -76,7 +86,7 @@ module Faker
           place: nil,
           possibly_sensitive: Faker::Boolean.boolean(true_ratio: 0.1),
           retweet_count: Faker::Number.between(to: 1, from: 10_000),
-          retweeted_status:  nil,
+          retweeted_status: nil,
           retweeted: false,
           source: "<a href=\"#{Faker::Internet.url(host: 'example.com')}\" rel=\"nofollow\">#{Faker::Company.name}</a>",
           text: Faker::Lorem.sentence,
@@ -107,21 +117,25 @@ module Faker
 
       def user_entities
         {
-          url:  {
+          url: {
             urls: []
           },
-          description:  {
+          description: {
             urls: []
           }
         }
       end
 
-      def status_entities(include_photo: false)
+      def status_entities(legacy_include_photo = NOT_GIVEN, include_photo: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :include_photo if legacy_include_photo != NOT_GIVEN
+        end
+
         entities = {
-          hashtags:  [],
-          symbols:  [],
-          user_mentions:  [],
-          urls:  []
+          hashtags: [],
+          symbols: [],
+          user_mentions: [],
+          urls: []
         }
         entities[:media] = [photo_entity] if include_photo
         entities
@@ -135,7 +149,7 @@ module Faker
         {
           id: media_id,
           id_str: media_id.to_s,
-          indices:  [
+          indices: [
             103,
             126
           ],
@@ -145,23 +159,23 @@ module Faker
           display_url: 'example.com',
           expanded_url: Faker::Internet.url(host: 'example.com'),
           type: 'photo',
-          sizes:  {
-            medium:  {
+          sizes: {
+            medium: {
               w: 1064,
               h: 600,
               resize: 'fit'
             },
-            large:  {
+            large: {
               w: 1064,
               h: 600,
               resize: 'fit'
             },
-            small:  {
+            small: {
               w: 680,
               h: 383,
               resize: 'fit'
             },
-            thumb:  {
+            thumb: {
               w: 150,
               h: 150,
               resize: 'crop'

data/lib/faker/default/types.rb

@@ -7,7 +7,11 @@ module Faker
     COMPLEX_TYPES = %i[hash array].freeze
 
     class << self
-      def rb_string(words: 1)
+      def rb_string(legacy_words = NOT_GIVEN, words: 1)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :words if legacy_words != NOT_GIVEN
+        end
+
         resolved_num = resolve(words)
         word_list =
           translate('faker.lorem.words')
@@ -20,11 +24,21 @@ module Faker
         sample(CHARACTERS)
       end
 
-      def rb_integer(from: 0, to: 100)
+      def rb_integer(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 0, to: 100)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :from if legacy_from != NOT_GIVEN
+          keywords << :to if legacy_to != NOT_GIVEN
+        end
+
         rand(from..to).to_i
       end
 
-      def rb_hash(number: 1, type: random_type)
+      def rb_hash(legacy_number = NOT_GIVEN, legacy_type = NOT_GIVEN, number: 1, type: random_type)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :number if legacy_number != NOT_GIVEN
+          keywords << :type if legacy_type != NOT_GIVEN
+        end
+
         {}.tap do |hsh|
           Lorem.words(number: number * 2).uniq.first(number).each do |s|
             hsh.merge!(s.to_sym => type)
@@ -32,11 +46,19 @@ module Faker
         end
       end
 
-      def complex_rb_hash(number: 1)
+      def complex_rb_hash(legacy_number = NOT_GIVEN, number: 1)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :number if legacy_number != NOT_GIVEN
+        end
+
         rb_hash(number: number, type: random_complex_type)
       end
 
-      def rb_array(len: 1)
+      def rb_array(legacy_len = NOT_GIVEN, len: 1)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :len if legacy_len != NOT_GIVEN
+        end
+
         [].tap do |ar|
           len.times do
             ar.push random_type

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

@@ -15,11 +15,20 @@ module Faker
         fetch('world_cup.stadiums')
       end
 
-      def group(group: 'group_A')
+      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')
+      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