faker 3.0.0 → 3.5.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-HJ-NPR-Z0-9]){3}[A-HJ-NPR-Z0-9]{5}[A-HJ-NPR-Z0-9]{1}[A-HJ-NPR-Z0-9]{1}[A-HJ-NPR-Z0-9]{1}[A-HJ-NPR-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.
@@ -299,34 +317,6 @@ module Faker
 
       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
-      end
-
-      def vin_char_to_number(char)
-        index = VIN_LETTERS.chars.index(char)
-
-        return char.to_i if index.nil?
-
-        VIN_MAP[index]
-      end
-
       def singapore_checksum(plate_number)
         padded_alphabets = format('%3s', plate_number[/^[A-Z]+/]).tr(' ', '-').chars
         padded_digits = format('%04d', plate_number[/\d+/]).chars.map(&:to_i)

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/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/heroes_of_the_storm.rb

@@ -17,17 +17,6 @@ module Faker
           fetch('heroes_of_the_storm.battlegrounds')
         end
 
-        ##
-        # 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.
         #

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/japanese_media/cowboy_bebop.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Faker
+  class JapaneseMedia
+    class CowboyBebop < Base
+      class << self
+        ##
+        # Produces a character from Cowboy Bebop.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::CowboyBebop.character #=> "Spike Spiegel"
+        #
+        # @faker.version next
+        def character
+          fetch('cowboy_bebop.character')
+        end
+
+        ##
+        # Produces an episode from Cowboy Bebop.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::CowboyBebop.episode #=> "Honky Tonk Women"
+        #
+        # @faker.version next
+        def episode
+          fetch('cowboy_bebop.episode')
+        end
+
+        ##
+        # Produces a song title from Cowboy Bebop.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::CowboyBebop.songs #=> "Live in Baghdad"
+        #
+        # @faker.version next
+        def song
+          fetch('cowboy_bebop.song')
+        end
+
+        ##
+        # Produces a quote from Cowboy Bebop.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::CowboyBebop.quote #=> "Bang!!!"
+        #
+        # @faker.version next
+        def quote
+          fetch('cowboy_bebop.quote')
+        end
+      end
+    end
+  end
+end

data/lib/faker/japanese_media/fullmetal_alchemist_brotherhood.rb

@@ -2,45 +2,45 @@
 
 module Faker
   class JapaneseMedia
-    class FmaBrotherhood < Base
+    class FullmetalAlchemistBrotherhood < Base
       class << self
         ##
-        # Produces a character from FmaBrotherhood.
+        # Produces a character from FullmetalAlchemistBrotherhood.
         #
         # @return [String]
         #
         # @example
-        #   Faker::JapaneseMedia::FmaBrotherhood.character #=> "Edward Elric"
+        #   Faker::JapaneseMedia::FullmetalAlchemistBrotherhood.character #=> "Edward Elric"
         #
         # @faker.version next
         def character
-          fetch('fma_brotherhood.characters')
+          fetch('fullmetal_alchemist_brotherhood.characters')
         end
 
         ##
-        # Produces a cities from FmaBrotherhood.
+        # Produces a cities from FullmetalAlchemistBrotherhood.
         #
         # @return [String]
         #
         # @example
-        #   Faker::JapaneseMedia::FmaBrotherhood.city #=> "Central City"
+        #   Faker::JapaneseMedia::FullmetalAlchemistBrotherhood.city #=> "Central City"
         #
         # @faker.version next
         def city
-          fetch('fma_brotherhood.cities')
+          fetch('fullmetal_alchemist_brotherhood.cities')
         end
 
         ##
-        # Produces a country from FmaBrotherhood.
+        # Produces a country from FullmetalAlchemistBrotherhood.
         #
         # @return [String]
         #
         # @example
-        #   Faker::JapaneseMedia::FmaBrotherhood.country #=> "Xing"
+        #   Faker::JapaneseMedia::FullmetalAlchemistBrotherhood.country #=> "Xing"
         #
         # @faker.version next
         def country
-          fetch('fma_brotherhood.countries')
+          fetch('fullmetal_alchemist_brotherhood.countries')
         end
       end
     end

data/lib/faker/locations/australia.rb

@@ -1,46 +1,48 @@
 # frozen_string_literal: true
 
 module Faker
-  class Australia < Base
-    class << self
-      ##
-      # Produces a location in Australia
-      #
-      # @return [String]
-      #
-      # @example
-      #   Faker::Australia.location
-      #    #=> "Sydney"
-      #
-      # @faker.version next
-      def location
-        fetch('australia.locations')
-      end
+  class Locations
+    class Australia < Base
+      class << self
+        ##
+        # Produces a location in Australia
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Locations::Australia.location
+        #    #=> "Sydney"
+        #
+        # @faker.version next
+        def location
+          fetch('locations.australia.locations')
+        end
 
-      # Produces an Australian animal
-      #
-      # @return [String]
-      #
-      # @example
-      #   Faker::Australia.animal
-      #    #=> "Dingo"
-      #
-      # @faker.version next
-      def animal
-        fetch('australia.animals')
-      end
+        # Produces an Australian animal
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Locations::Australia.animal
+        #    #=> "Dingo"
+        #
+        # @faker.version next
+        def animal
+          fetch('locations.australia.animals')
+        end
 
-      # Produces an Australian State or Territory
-      #
-      # @return [String]
-      #
-      # @example
-      #   Faker::Australia.state
-      #    #=> "New South Wales"
-      #
-      # @faker.version next
-      def state
-        fetch('australia.states')
+        # Produces an Australian State or Territory
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Locations::Australia.state
+        #    #=> "New South Wales"
+        #
+        # @faker.version next
+        def state
+          fetch('locations.australia.states')
+        end
       end
     end
   end

data/lib/faker/movies/avatar.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Faker
+  class Movies
+    class Avatar < Base
+      class << self
+        ##
+        # Produces a character from Avatar.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Avatar.character #=> "Jake Sully"
+        #
+        # @faker.version next
+        def character
+          fetch('avatar.characters')
+        end
+
+        ##
+        # Produces a date from Avatar.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Avatar.date #=> "December 15, 2022"
+        #
+        # @faker.version next
+        def date
+          fetch('avatar.dates')
+        end
+
+        ##
+        # Produces a quote from Avatar.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Avatar.quote
+        #     #=> "If it ain't raining, we ain't training."
+        #
+        # @faker.version next
+        def quote
+          fetch('avatar.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/movies/star_wars.rb

@@ -204,7 +204,7 @@ module Faker
         # @example
         #   Faker::Movies::StarWars.droids
         #
-        # @faker.versionn 1.6.2
+        # @faker.version 1.6.2
         def droids
           fetch_all('star_wars.droids')
         end

data/lib/faker/movies/{room.rb → the_room.rb}

@@ -14,7 +14,7 @@ module Faker
         #
         # @faker.version next
         def actor
-          fetch('room.actors')
+          fetch('the_room.actors')
         end
 
         ##
@@ -27,7 +27,7 @@ module Faker
         #
         # @faker.version next
         def character
-          fetch('room.characters')
+          fetch('the_room.characters')
         end
 
         ##
@@ -40,7 +40,7 @@ module Faker
         #
         # @faker.version next
         def location
-          fetch('room.locations')
+          fetch('the_room.locations')
         end
 
         ##
@@ -55,7 +55,7 @@ module Faker
         #
         # @faker.version next
         def quote
-          fetch('room.quotes')
+          fetch('the_room.quotes')
         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