ffaker 2.10.0 → 2.23.0

data/lib/ffaker/unit.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-require 'ostruct'
+# frozen_string_literal: true
 
 module FFaker
   module Unit
@@ -10,9 +8,10 @@ module FFaker
     TIME_UNITS = [
       { name: 'Years', abbreviation: 'yr' },
       { name: 'Days', abbreviation: 'd' },
-      { name: 'Hours', abbreviation: 'Minutes' },
+      { name: 'Hours', abbreviation: 'h' },
+      { name: 'Minutes', abbreviation: 'm' },
       { name: 'Seconds', abbreviation: 's' },
-      { name: 'Milliseconds', abbreviation: 'msec' }
+      { name: 'Milliseconds', abbreviation: 'ms' }
     ].freeze
     TEMPERATURE_UNITS = [
       { name: 'Kelvin', abbreviation: 'K' },
@@ -21,29 +20,29 @@ module FFaker
     ].freeze
 
     def time_name
-      time.name
+      time[:name]
     end
 
     def time_abbr
-      time.abbreviation
+      time[:abbreviation]
     end
 
     def temperature_name
-      temperature.name
+      temperature[:name]
     end
 
     def temperature_abbr
-      temperature.abbreviation
+      temperature[:abbreviation]
     end
 
     private
 
     def time
-      OpenStruct.new(fetch_sample(TIME_UNITS))
+      fetch_sample(TIME_UNITS)
     end
 
     def temperature
-      OpenStruct.new(fetch_sample(TEMPERATURE_UNITS))
+      fetch_sample(TEMPERATURE_UNITS)
     end
   end
 end

data/lib/ffaker/unit_english.rb

@@ -1,7 +1,4 @@
-# encoding: utf-8
-
-require 'ffaker/unit'
-require 'ostruct'
+# frozen_string_literal: true
 
 module FFaker
   module UnitEnglish
@@ -15,7 +12,7 @@ module FFaker
       { name: 'foot', abbreviation: 'ft' },
       { name: 'yard', abbreviation: 'yd' },
       { name: 'furlong', abbreviation: 'fur' },
-      { name: 'mile', abbreviation: 'm' }
+      { name: 'mile', abbreviation: 'mi' }
     ].freeze
     MASS_UNITS = [
       { name: 'grains', abbreviation: 'gr' },
@@ -36,75 +33,75 @@ module FFaker
       { name: 'cubic yard', abbreviation: 'CY' }
     ].freeze
     AREA_UNITS = [
-      { name: 'square inch', abbreviation: 'sq. in' },
+      { name: 'square inch', abbreviation: 'sq in' },
       { name: 'square foot', abbreviation: 'sq ft' },
       { name: 'square yard', abbreviation: 'sq yd' },
       { name: 'acre', abbreviation: 'ac' },
       { name: 'section', abbreviation: 's' },
       { name: 'square mile', abbreviation: 'sq mi' },
-      { name: 'township', abbreviation: 'Twp' }
+      { name: 'township', abbreviation: 'twp' }
     ].freeze
 
     def mass_name
-      mass.name
+      mass[:name]
     end
 
     def mass_abbr
-      mass.abbreviation
+      mass[:abbreviation]
     end
 
     def length_name
-      length.name
+      length[:name]
     end
 
     def length_abbr
-      length.abbreviation
+      length[:abbreviation]
     end
 
     def liquid_name
-      liquid.name
+      liquid[:name]
     end
 
     def liquid_abbr
-      liquid.abbreviation
+      liquid[:abbreviation]
     end
 
     def volume_name
-      volume.name
+      volume[:name]
     end
 
     def volume_abbr
-      volume.abbreviation
+      volume[:abbreviation]
     end
 
     def area_name
-      area.name
+      area[:name]
     end
 
     def area_abbr
-      area.abbreviation
+      area[:abbreviation]
     end
 
     private
 
     def length
-      OpenStruct.new(fetch_sample(LENGTH_UNITS))
+      fetch_sample(LENGTH_UNITS)
     end
 
     def mass
-      OpenStruct.new(fetch_sample(MASS_UNITS))
+      fetch_sample(MASS_UNITS)
     end
 
     def liquid
-      OpenStruct.new(fetch_sample(LIQUID_UNITS))
+      fetch_sample(LIQUID_UNITS)
     end
 
     def volume
-      OpenStruct.new(fetch_sample(VOLUME_UNITS))
+      fetch_sample(VOLUME_UNITS)
     end
 
     def area
-      OpenStruct.new(fetch_sample(AREA_UNITS))
+      fetch_sample(AREA_UNITS)
     end
   end
 end

data/lib/ffaker/unit_metric.rb

@@ -1,7 +1,4 @@
-# encoding: utf-8
-
-require 'ffaker/unit'
-require 'ostruct'
+# frozen_string_literal: true
 
 module FFaker
   module UnitMetric
@@ -37,65 +34,65 @@ module FFaker
     ].freeze
 
     def mass_name
-      mass.name
+      mass[:name]
     end
 
     def mass_abbr
-      mass.abbreviation
+      mass[:abbreviation]
     end
 
     def length_name
-      length.name
+      length[:name]
     end
 
     def length_abbr
-      length.abbreviation
+      length[:abbreviation]
     end
 
     def liquid_name
-      liquid.name
+      liquid[:name]
     end
 
     def liquid_abbr
-      liquid.abbreviation
+      liquid[:abbreviation]
     end
 
     def volume_name
-      volume.name
+      volume[:name]
     end
 
     def volume_abbr
-      volume.abbreviation
+      volume[:abbreviation]
     end
 
     def area_name
-      area.name
+      area[:name]
     end
 
     def area_abbr
-      area.abbreviation
+      area[:abbreviation]
     end
 
     private
 
     def length
-      OpenStruct.new(fetch_sample(LENGTH_UNITS))
+      fetch_sample(LENGTH_UNITS)
     end
 
     def mass
-      OpenStruct.new(fetch_sample(MASS_UNITS))
+      fetch_sample(MASS_UNITS)
     end
 
     def liquid
-      OpenStruct.new(fetch_sample(LIQUID_UNITS))
+      fetch_sample(LIQUID_UNITS)
     end
 
     def volume
-      OpenStruct.new(fetch_sample(VOLUME_UNITS))
+      fetch_sample(VOLUME_UNITS)
     end
 
     def area
-      OpenStruct.new(fetch_sample(AREA_UNITS))
+      fetch_sample(AREA_UNITS)
     end
   end
 end

data/lib/ffaker/utils/array_utils.rb

@@ -1,4 +1,7 @@
-require 'ffaker/utils/random_utils'
+# frozen_string_literal: true
+
+require_relative 'random_utils'
+
 module FFaker
   module ArrayUtils
     extend RandomUtils
@@ -9,9 +12,9 @@ module FFaker
       freeze_all(array)
     end
 
-    def self.random_pick(array, n)
+    def self.random_pick(array, num)
       warn '[ArrayUtils.random_pick] is deprecated. Please use the ModuleUtils#fetch_sample method'
-      fetch_sample(array, count: n)
+      fetch_sample(array, count: num)
     end
 
     def self.rand(array)
@@ -29,9 +32,9 @@ module FFaker
       array.sort_by { FFaker::Random.rand }
     end
 
-    def random_pick(n)
+    def random_pick(num)
       warn '[ArrayUtils#random_pick] is deprecated. Please use the ModuleUtils#fetch_sample method'
-      ArrayUtils.random_pick(self, n)
+      ArrayUtils.random_pick(self, num)
     end
 
     def rand

data/lib/ffaker/utils/module_utils.rb

@@ -1,6 +1,8 @@
-require 'ffaker/utils/array_utils'
-require 'ffaker/utils/random_utils'
-require 'ffaker/utils/unique_utils'
+# frozen_string_literal: true
+
+require_relative 'array_utils'
+require_relative 'random_utils'
+require_relative 'unique_utils'
 
 module FFaker
   module ModuleUtils
@@ -11,7 +13,7 @@ module FFaker
     end
 
     def const_missing(const_name)
-      if const_name =~ /[a-z]/ # Not a constant, probably a class/module name.
+      if const_name.match?(/[a-z]/) # Not a constant, probably a class/module name.
         super const_name
       else
         mod_name = ancestors.first.to_s.split('::').last
@@ -23,7 +25,7 @@ module FFaker
     end
 
     def underscore(string)
-      string.gsub(/::/, '/')
+      string.gsub('::', '/')
             .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
             .gsub(/([a-z\d])([A-Z])/, '\1_\2')
             .tr('-', '_')
@@ -31,7 +33,26 @@ module FFaker
     end
 
     def unique(max_retries = 10_000)
-      @unique_generator ||= FFaker::UniqueUtils.new(self, max_retries)
+      FFaker::UniqueUtils.add_instance(self, max_retries)
+    end
+
+    # http://en.wikipedia.org/wiki/Luhn_algorithm
+    def luhn_check(number)
+      multiplications = []
+
+      number.chars.each_with_index do |digit, i|
+        multiplications << i.even? ? digit.to_i * 2 : digit.to_i
+      end
+
+      sum = 0
+      multiplications.each do |num|
+        num.to_s.each_byte do |character|
+          sum += character.chr.to_i
+        end
+      end
+
+      control_digit = (sum % 10).zero? ? 0 : (((sum / 10) + 1) * 10) - sum
+      control_digit.to_s
     end
   end
 end

data/lib/ffaker/utils/random_utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FFaker
   # Methods for returning repeatably-random data using the internal
   # Random Number Generator. You should not need to use this directly, it is
@@ -18,6 +20,8 @@ module FFaker
     def fetch_sample(list, options = {})
       if (count = options.delete(:count))
         list.sample(count, random: FFaker::Random)
+      elsif list.is_a?(Range)
+        FFaker::Random.rand(list)
       else
         list.sample(random: FFaker::Random)
       end

data/lib/ffaker/utils/unique_utils.rb

@@ -4,42 +4,53 @@ require 'set'
 
 module FFaker
   class UniqueUtils
-    def initialize(generator, max_retries)
-      @generator = generator
-      @max_retries = max_retries
-      @previous_results = Hash.new { |hash, key| hash[key] = Set.new }
-    end
+    RetryLimitExceeded = Class.new(StandardError)
 
-    def method_missing(name, *arguments)
-      @generator.respond_to?(name) ? add_results_to_hash(name, *arguments) : super
-    end
+    class << self
+      def add_instance(generator, max_retries)
+        instances[generator] ||= FFaker::UniqueUtils.new(generator, max_retries)
+      end
 
-    def respond_to_missing?(method_name, include_private = false)
-      super
-    end
+      def instances
+        Thread.current[:ffaker_unique_utils] ||= {}
+      end
 
-    RetryLimitExceeded = Class.new(StandardError)
+      def clear
+        instances.each_value(&:clear)
+        instances.clear
+      end
+    end
 
-    def clear
-      @previous_results.clear
+    def initialize(generator, max_retries)
+      @generator = generator
+      @max_retries = max_retries
     end
 
-    def self.clear
-      ObjectSpace.each_object(self, &:clear)
+    def clear
+      previous_results.clear
     end
 
     private
 
-    def add_results_to_hash(name, *arguments)
+    def method_missing(name, *args, **kwargs)
       @max_retries.times do
-        result = @generator.send(name, *arguments)
+        result = @generator.public_send(name, *args, **kwargs)
 
-        next if @previous_results[[name, arguments]].include?(result)
+        next if previous_results[[name, args, kwargs]].include?(result)
 
-        @previous_results[[name, arguments]] << result
+        previous_results[[name, args, kwargs]] << result
         return result
       end
-      raise RetryLimitExceeded
+
+      raise RetryLimitExceeded, "Retry limit exceeded for #{name}"
+    end
+
+    def respond_to_missing?(name, *args)
+      @generator.respond_to?(name, *args) || super
+    end
+
+    def previous_results
+      @previous_results ||= Hash.new { |hash, key| hash[key] = Set.new }
     end
   end
 end

data/lib/ffaker/vehicle.rb

@@ -1,16 +1,74 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module Vehicle
+    module VIN
+      extend ModuleUtils
+      extend self
+
+      # https://en.wikibooks.org/wiki/Vehicle_Identification_Numbers_(VIN_codes)/World_Manufacturer_Identifier_(WMI)
+      VALID_WMI_REGIONS = [*'A'..'C', *'J'..'N', 'P', *'R'..'Z', *'1'..'9'].freeze
+
+      VALID_YEAR_CHARS = %w[
+        5 6 7 8 9 A B C D E F G H J K L M N P R S T V W X Y 1 2 3 4 5 6 7 8 9
+      ].freeze # 2005-2039
+
+      # https://en.wikibooks.org/wiki/Vehicle_Identification_Numbers_(VIN_codes)/Check_digit
+      TRANSLITERATION_VALUES = {
+        '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
+      POSITION_WEIGHTS = [8, 7, 6, 5, 4, 3, 2, 10, 0, 9, 8, 7, 6, 5, 4, 3, 2].freeze
+
+      VALID_ALPHA = TRANSLITERATION_VALUES.keys
+      VALID_ALPHANUMERIC = [*VALID_ALPHA, *'1'..'9'].freeze
+
+      # Generate a VIN that is compliant with specifications of US Title 49 Section 565.15
+      # https://www.govinfo.gov/content/pkg/CFR-2019-title49-vol6/xml/CFR-2019-title49-vol6-part565.xml#seqnum565.15
+      #
+      # Position  Meaning
+      # 1-3       Manufacturer ID aka WMI (alpha and digits)
+      # 4-8       Vehicle Description ("For passenger cars ..[position 7].. shall be alphabetic")
+      # 9         Check Digit (0-9 or "X")
+      # 10        Year (see VIN_VALID_YEARS)
+      # 11        Plant of manufacture (alpha and digits)
+      # 12-17     Serial number (digits only)
+      #
+      # I, O and Q are NOT allowed. VIN_VALID_ALPHA has valid alpha characters.
+      def vin
+        generated_vin = [
+          # Manufacturer ID / WMI
+          fetch_sample(VALID_WMI_REGIONS),
+          fetch_sample(VALID_ALPHANUMERIC, count: 2),
+          # Vehicle Description
+          fetch_sample(VALID_ALPHANUMERIC, count: 3),
+          fetch_sample(VALID_ALPHA),
+          fetch_sample(VALID_ALPHANUMERIC),
+          '0', # check digit placeholder
+          fetch_sample(VALID_YEAR_CHARS), # Year of Manufacture
+          fetch_sample(VALID_ALPHANUMERIC), # Plant ID
+          FFaker.numerify('######') # Serial Number
+        ].join
+
+        # Calculate the Check Digit
+        weighted_sum = generated_vin.chars.each_with_index.sum do |char, idx|
+          (TRANSLITERATION_VALUES[char] || char).to_i * POSITION_WEIGHTS[idx]
+        end
+
+        check_digit = weighted_sum % 11
+        check_digit = 'X' if check_digit == 10
+        generated_vin[8] = check_digit.to_s
+
+        generated_vin
+      end
+    end
+
     extend ModuleUtils
     extend self
 
     DRIVETRAINS = %w[4WD 4X4 AWD FWD RWD].freeze
-    YEARS = [*'1900'..(Date.today.year + 1).to_s].freeze
-    COLOR_PREFIXES = k(%w[
-                         beautiful bright calm dangerous dark dull fast magnetic magnificent majestic melodic metallic
-                         mundane mute mysterious new pleasant pretty resonant royal slate soft tranquil vibrant weak
-                       ])
+    YEARS = Array('1900'..(::Time.now.year + 1).to_s).freeze
     TRANSMISSIONS_ABBR = %w[AT MT AM CVT].freeze
     CYLINDERS = %w[2 5 6 8].freeze
 
@@ -26,9 +84,9 @@ module FFaker
       fetch_sample(MAKES_LIST)
     end
 
-    def manufacturer_color(n = 2)
+    def manufacturer_color(count = 2)
       # Take two prefixes because it's more fun than one
-      (fetch_sample(COLOR_PREFIXES, count: n) + [base_color]).join(' ')
+      (fetch_sample(COLOR_PREFIXES, count: count) + [base_color]).join(' ')
     end
     alias mfg_color manufacturer_color
 
@@ -41,7 +99,7 @@ module FFaker
     end
 
     def vin
-      FFaker.bothify('1#???#####?######').upcase
+      VIN.vin
     end
 
     def year

data/lib/ffaker/venue.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module Venue

data/lib/ffaker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FFaker
+  VERSION = '2.23.0'
+end

data/lib/ffaker/youtube.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FFaker
   module Youtube