faker 2.15.1 → 3.4.2

data/lib/faker/default/vehicle.rb

@@ -6,10 +6,9 @@ module Faker
 
     MILEAGE_MIN = 10_000
     MILEAGE_MAX = 90_000
-    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}$/.freeze
+    VIN_KEYSPACE = %w[A B C D E F G H J K L M N P R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9].freeze
+    VIN_TRANSLITERATION = { A: 1, B: 2, C: 3, D: 4, E: 5, F: 6, G: 7, H: 8, J: 1, K: 2, L: 3, M: 4, N: 5, P: 7, R: 9, S: 2, T: 3, U: 4, V: 5, W: 6, X: 7, Y: 8, Z: 9 }.freeze
+    VIN_WEIGHT = [8, 7, 6, 5, 4, 3, 2, 10, 0, 9, 8, 7, 6, 5, 4, 3, 2].freeze
     SG_CHECKSUM_WEIGHTS = [3, 14, 2, 12, 2, 11, 1].freeze
     SG_CHECKSUM_CHARS = 'AYUSPLJGDBZXTRMKHEC'
 
@@ -23,7 +22,25 @@ module Faker
       #
       # @faker.version 1.6.4
       def vin
-        regexify(VIN_REGEX)
+        generate(:string) do |g|
+          g.letter(name: :wmi, ranges: ['100'..'199', '400'..'499', '500'..'599', '700'..'799', '7A0'..'7F9'])
+          g.letter(name: :vds, length: 5, ranges: [VIN_KEYSPACE])
+          g.computed(name: :checksum, deps: %i[wmi vds model_year plant_code vis]) do |wmi, vds, model_year, plant_code, vis|
+            checksum = "#{wmi}#{vds}0#{model_year}#{plant_code}#{vis}".chars.each_with_index.map do |char, i|
+              value = (char =~ /\A\d\z/ ? char.to_i : VIN_TRANSLITERATION[char.to_sym])
+              value * VIN_WEIGHT[i]
+            end.inject(:+) % 11
+
+            if checksum == 10
+              'X'
+            else
+              checksum
+            end
+          end
+          g.letter(name: :model_year, length: 1, ranges: [VIN_KEYSPACE - %w[U Z 0]])
+          g.letter(name: :plant_code, length: 1, ranges: [VIN_KEYSPACE])
+          g.int(name: :vis, length: 6)
+        end
       end
 
       # Produces a random vehicle manufacturer.
@@ -31,12 +48,13 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Vehicle.manufacture #=> "Lamborghini"
+      #   Faker::Vehicle.manufacturer #=> "Lamborghini"
       #
       # @faker.version 1.6.4
-      def manufacture
-        fetch('vehicle.manufacture')
+      def manufacturer
+        fetch('vehicle.manufacturer')
       end
+      alias manufacture manufacturer
 
       ##
       # Produces a random vehicle make.
@@ -62,11 +80,7 @@ module Faker
       #   Faker::Vehicle.model(make_of_model: 'Toyota') #=> "Prius"
       #
       # @faker.version 1.6.4
-      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
-
+      def model(make_of_model: '')
         return fetch("vehicle.models_by_make.#{make}") if make_of_model.empty?
 
         fetch("vehicle.models_by_make.#{make_of_model}")
@@ -249,12 +263,7 @@ module Faker
       #   Faker::Vehicle.kilometrage #=> 35378
       #
       # @faker.version 1.6.4
-      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
-
+      def mileage(min: MILEAGE_MIN, max: MILEAGE_MAX)
         rand_in_range(min, max)
       end
 
@@ -271,11 +280,7 @@ module Faker
       #   Faker::Vehicle.license_plate(state_abbreviation: 'FL') #=> "977 UNU"
       #
       # @faker.version 1.6.4
-      def license_plate(legacy_state_abreviation = NOT_GIVEN, state_abbreviation: '')
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :state_abbreviation if legacy_state_abreviation != NOT_GIVEN
-        end
-
+      def license_plate(state_abbreviation: '')
         return regexify(bothify(fetch('vehicle.license_plate'))) if state_abbreviation.empty?
 
         key = "vehicle.license_plate_by_state.#{state_abbreviation}"
@@ -297,45 +302,30 @@ module Faker
         "#{plate_number}#{singapore_checksum(plate_number)}"
       end
 
-      private
-
-      def first_eight(number)
-        return number[0...8] unless number.nil?
-
-        regexify(VIN_REGEX)
-      end
-      alias last_eight first_eight
-
-      def calculate_vin_check_digit(vin)
-        sum = 0
-
-        vin.each_char.with_index do |c, i|
-          n = vin_char_to_number(c).to_i
-          weight = VIN_WEIGHTS[i].to_i
-          sum += weight * n
-        end
-
-        mod = sum % 11
-        mod == 10 ? 'X' : mod
+      ##
+      # Produces a car version
+      #
+      # @return [String]
+      #
+      # @example
+      #  Faker::Vehicle.version #=> "40 TFSI Premium"
+      #
+      # @faker.version next
+      def version
+        fetch('vehicle.version')
       end
 
-      def vin_char_to_number(char)
-        index = VIN_LETTERS.split('').index(char)
-
-        return char.to_i if index.nil?
-
-        VIN_MAP[index]
-      end
+      private
 
       def singapore_checksum(plate_number)
-        padded_alphabets = format('%3s', plate_number[/^[A-Z]+/]).tr(' ', '-').split('')
-        padded_digits = format('%04d', plate_number[/\d+/]).split('').map(&:to_i)
+        padded_alphabets = format('%3s', plate_number[/^[A-Z]+/]).tr(' ', '-').chars
+        padded_digits = format('%04d', plate_number[/\d+/]).chars.map(&:to_i)
         sum = [*padded_alphabets, *padded_digits].each_with_index.reduce(0) do |memo, (char, i)|
           value = char.is_a?(Integer) ? char : char.ord - 64
           memo + (SG_CHECKSUM_WEIGHTS[i] * value)
         end
 
-        SG_CHECKSUM_CHARS.split('')[sum % 19]
+        SG_CHECKSUM_CHARS.chars[sum % 19]
       end
     end
   end

data/lib/faker/default/vulnerability_identifier.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Faker
+  class VulnerabilityIdentifier < Base
+    class << self
+      ##
+      # Produces a Common Vulnerabilities and Exposures (CVE) identifier.
+      #
+      # @param year [Integer] The year-part of the CVE identifier (defaults to the current year)
+      # @return [String]
+      #
+      # @example
+      #   Faker::VulnerabilityIdentifier.cve #=> "CVE-2021-1337"
+      #   Faker::VulnerabilityIdentifier.cve(year: 1999) #=> "CVE-1999-0523"
+      #
+      # @faker.version next
+      def cve(year: ::Date.today.year)
+        index = rand_in_range(1, 99_999).to_s.rjust(4, '0')
+        "CVE-#{year}-#{index}"
+      end
+    end
+  end
+end

data/lib/faker/default/world_cup.rb

@@ -53,11 +53,7 @@ module Faker
       #   Faker::WorldCup.group #=> "Russia"
       #
       # @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
-        end
-
+      def group(group: 'group_A')
         fetch("world_cup.groups.#{group}")
       end
 
@@ -73,12 +69,7 @@ module Faker
       #   Faker::WorldCup.roster(country: 'Spain', type: 'forwards') #=> "Diego Costa"
       #
       # @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
-          keywords << :type if legacy_type != NOT_GIVEN
-        end
-
+      def roster(country: 'Egypt', type: 'coach')
         fetch("world_cup.rosters.#{country}.#{type}")
       end
     end

data/lib/faker/games/clash_of_clans.rb

@@ -31,7 +31,7 @@ module Faker
         end
 
         ##
-        # Produces the name of a defensive buiding from Clash Of Clans.
+        # Produces the name of a defensive building from Clash Of Clans.
         #
         # @return [String]
         #

data/lib/faker/games/dnd.rb

@@ -43,6 +43,19 @@ module Faker
           fetch('dnd.cities')
         end
 
+        ##
+        # Produces the first name of a character or monster from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.name #=> "Eilonwy"
+        #
+        # @faker.version next
+        def first_name
+          fetch('dnd.name.first_name')
+        end
+
         ##
         # Produces the name of a class from Dungeons and Dragons (PHB).
         #
@@ -69,6 +82,19 @@ module Faker
           fetch('dnd.languages')
         end
 
+        ##
+        # Produces a last name from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.last_name #=> "Leafwhisper"
+        #
+        # @faker.version next
+        def last_name
+          fetch('dnd.name.last_name')
+        end
+
         ##
         # Produces the name of a melee weapon from Dungeons and Dragons.
         #
@@ -95,6 +121,19 @@ module Faker
           fetch('dnd.monsters')
         end
 
+        ##
+        # Produces a full name from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.name #=> "Drakon Blackthorn"
+        #
+        # @faker.version next
+        def name
+          "#{fetch('dnd.name.first_name')} #{fetch('dnd.name.last_name')}"
+        end
+
         ##
         # Produces the name of a race from Dungeons and Dragons (PHB).
         #
@@ -121,14 +160,17 @@ module Faker
           fetch('dnd.ranged_weapons')
         end
 
-        # This method is deprecated. The implementation will be removed in a near future release.
-        # Use `DnD.race` instead.
+        ##
+        # Produces a last name from Dungeons and Dragons.
         #
-        # @deprecated Use {#race} instead.
-        def species
-          warn '`DnD.species` is deprecated. Use `DnD.race` instead.'
-
-          super
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.title_name #=> "Corvus the Cunning"
+        #
+        # @faker.version next
+        def title_name
+          "#{fetch('dnd.name.first_name')} #{fetch('dnd.name.title')}"
         end
       end
     end

data/lib/faker/games/dota.rb

@@ -4,6 +4,19 @@ module Faker
   class Games
     class Dota < Base
       class << self
+        ##
+        # Produces the name of a building from Dota.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.building #=> "Tower"
+        #
+        # @faker.version 1.9.0
+        def building
+          fetch('games.dota.building')
+        end
+
         ##
         # Produces the name of a hero from Dota.
         #
@@ -67,11 +80,7 @@ module Faker
         #   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
-
+        def quote(hero: 'abaddon')
           fetch("games.dota.#{hero}.quote")
         end
       end

data/lib/faker/games/final_fantasy_xiv.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class FinalFantasyXIV < Base
+      class << self
+        ##
+        # Produces the name of a character from FFXIV.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.character #=> "Y'shtola Rhul"
+        #
+        # @faker.version next
+        def character
+          fetch('games.final_fantasy_xiv.characters')
+        end
+
+        ##
+        # Produces a job name from Final Fantasy XIV. Either a battle or non-battle playable job.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.job #=> "Paladin"
+        #
+        # @faker.version next
+        def job
+          fetch('games.final_fantasy_xiv.jobs')
+        end
+
+        # Produces the name of a playable race from Final Fantasy XIV.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.race #=> "Miqo'te"
+        #
+        # @faker.version next
+        def race
+          fetch('games.final_fantasy_xiv.races')
+        end
+
+        ##
+        # Produces a data center from Final Fantasy XIV.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.data_center #=> "Aether"
+        #
+        # @faker.version next
+        def data_center
+          fetch('games.final_fantasy_xiv.data_centers')
+        end
+
+        ##
+        # Produces a geographical zone from Final Fantasy XIV.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::FinalFantasyXIV.zone #=> "Eastern La Noscea"
+        #
+        # @faker.version next
+        def zone
+          fetch('games.final_fantasy_xiv.zones')
+        end
+      end
+    end
+  end
+end

data/lib/faker/games/minecraft.rb

@@ -88,7 +88,7 @@ module Faker
         # @return [String]
         #
         # @example
-        #   Faker::Games::Minecraft.item #=> "Sheep"
+        #   Faker::Games::Minecraft.mob #=> "Sheep"
         #
         # @faker.version 2.13.0
         def mob

data/lib/faker/games/myst.rb

@@ -44,7 +44,7 @@ module Faker
         end
 
         ##
-        # Produces the name of a chracter from Myst.
+        # Produces the name of a character from Myst.
         #
         # @return [String]
         #

data/lib/faker/games/tarkov.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class Tarkov < Base
+      class << self
+        ##
+        # Produces a random location from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.location #=> "Customs"
+        #
+        # @faker.version next
+        def location
+          fetch('tarkov.locations')
+        end
+
+        ##
+        # Produces a random trader from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.trader #=> "Prapor"
+        #
+        # @faker.version next
+        def trader
+          fetch('tarkov.traders')
+        end
+
+        ##
+        # Produces a random item from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.item #=> "Diary"
+        #
+        # @faker.version next
+        def item
+          fetch('tarkov.items')
+        end
+
+        ##
+        # Produces a random weapon from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.weapon #=> "AK-74N"
+        #
+        # @faker.version next
+        def weapon
+          fetch('tarkov.weapons')
+        end
+
+        ##
+        # Produces a random boss from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.boss #=> "Tagilla"
+        #
+        # @faker.version next
+        def boss
+          fetch('tarkov.bosses')
+        end
+
+        ##
+        # Produces a random faction from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.faction #=> "USEC"
+        #
+        # @faker.version next
+        def faction
+          fetch('tarkov.factions')
+        end
+
+        ##
+        # Produces a random quest from a random trader from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.quest #=> "The Key to Success"
+        #
+        # @faker.version next
+        def quest
+          @traders = %w[prapor therapist skier peacekeeper mechanic ragman jaeger fence]
+          fetch("tarkov.quests.#{@traders.sample}")
+        end
+
+        ##
+        # Produces a random quest from Prapor from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.prapor_quest #=> "Easy Job - Part 2
+        #
+        # @faker.version next
+        def prapor_quest
+          fetch('tarkov.quests.prapor')
+        end
+
+        ##
+        # Produces a random quest from Therapist from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.therapist_quest #=> "Supply Plans"
+        #
+        # @faker.version next
+        def therapist_quest
+          fetch('tarkov.quests.therapist')
+        end
+
+        ##
+        # Produces a random quest from Skier from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.skier_quest #=> "Safe Corridor"
+        #
+        # @faker.version next
+        def skier_quest
+          fetch('tarkov.quests.skier')
+        end
+
+        ##
+        # Produces a random quest from Peacekeeper from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.peacekeeper_quest #=> "Overpopulation"
+        #
+        # @faker.version next
+        def peacekeeper_quest
+          fetch('tarkov.quests.peacekeeper')
+        end
+
+        ##
+        # Produces a random quest from Mechanic from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.mechanic_quest #=> "Signal - Part 4"
+        #
+        # @faker.version next
+        def mechanic_quest
+          fetch('tarkov.quests.mechanic')
+        end
+
+        ##
+        # Produces a random quest from Ragman from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.ragman_quest #=> "Hot Delivery"
+        #
+        # @faker.version next
+        def ragman_quest
+          fetch('tarkov.quests.ragman')
+        end
+
+        ##
+        # Produces a random quest from Jaeger from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.jaeger_quest #=> "The Tarkov Shooter - Part 1"
+        #
+        # @faker.version next
+        def jaeger_quest
+          fetch('tarkov.quests.jaeger')
+        end
+
+        ##
+        # Produces a random quest from Fence from Escape from Tarkov.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Tarkov.fence_quest #=> "Compensation for Damage - Wager"
+        #
+        # @faker.version next
+        def fence_quest
+          fetch('tarkov.quests.fence')
+        end
+      end
+    end
+  end
+end