ffaker 2.2.0 → 2.3.0

data/lib/ffaker/unit_metric.rb

@@ -11,30 +11,30 @@ module FFaker
     extend self
 
     LENGTH_UNITS = [
-      { name: "millimeters", abbreviation: "mm"},
-      { name: "centimeters", abbreviation: "cm"},
-      {  name: "meters", abbreviation: "m"},
-      { name: "kilometers", abbreviation: "km"}
-    ]
+      { name: 'millimeters', abbreviation: 'mm' },
+      { name: 'centimeters', abbreviation: 'cm' },
+      { name: 'meters', abbreviation: 'm' },
+      { name: 'kilometers', abbreviation: 'km' }
+    ].freeze
     MASS_UNITS = [
-      { name: "gram", abbreviation: "g"},
-      { name: "kilogram", abbreviation: "kg" },
-      { name: "metric ton", abbreviation: "mt"}
-    ]
+      { name: 'gram', abbreviation: 'g' },
+      { name: 'kilogram', abbreviation: 'kg' },
+      { name: 'metric ton', abbreviation: 'mt' }
+    ].freeze
     LIQUID_UNITS = [
-      { name: "milliliters", abbreviation: "ml"},
-      { name: "liters", abbreviation: "L"}
-    ]
+      { name: 'milliliters', abbreviation: 'ml' },
+      { name: 'liters', abbreviation: 'L' }
+    ].freeze
     VOLUME_UNITS = [
-      { name: " cubic centimeters", abbreviation: "cm^3"},
-      { name: "cubic meters", abbreviation: "m^3"}
-    ]
+      { name: ' cubic centimeters', abbreviation: 'cm^3' },
+      { name: 'cubic meters', abbreviation: 'm^3' }
+    ].freeze
     AREA_UNITS = [
-      { name: "centimeters squared", abbreviation: "cm^2"},
-      { name: "meters squared", abbreviation: "m^2"},
-      { name: "hectares", abbreviation: "ha"},
-      { name: "kilometers", abbreviation: "km" }
-    ]
+      { name: 'centimeters squared', abbreviation: 'cm^2' },
+      { name: 'meters squared', abbreviation: 'm^2' },
+      { name: 'hectares', abbreviation: 'ha' },
+      { name: 'kilometers', abbreviation: 'km' }
+    ].freeze
 
     def mass_name
       mass.name
@@ -79,23 +79,23 @@ module FFaker
     private
 
     def length
-      OpenStruct.new LENGTH_UNITS.sample
+      OpenStruct.new(fetch_sample(LENGTH_UNITS))
     end
 
     def mass
-      OpenStruct.new MASS_UNITS.sample
+      OpenStruct.new(fetch_sample(MASS_UNITS))
     end
 
     def liquid
-      OpenStruct.new LIQUID_UNITS.sample
+      OpenStruct.new(fetch_sample(LIQUID_UNITS))
     end
 
     def volume
-      OpenStruct.new VOLUME_UNITS.sample
+      OpenStruct.new(fetch_sample(VOLUME_UNITS))
     end
 
     def area
-      OpenStruct.new AREA_UNITS.sample
+      OpenStruct.new(fetch_sample(AREA_UNITS))
     end
   end
 end

data/lib/ffaker/utils/array_utils.rb

@@ -1,5 +1,8 @@
+require 'ffaker/utils/random_utils'
 module FFaker
   module ArrayUtils
+    extend RandomUtils
+
     def self.const_array(argument)
       array = argument.is_a?(Array) ? argument : argument.to_a
       array.extend ArrayUtils
@@ -7,13 +10,13 @@ module FFaker
     end
 
     def self.random_pick(array, n)
-      warn '[ArrayUtils.random_pick] is deprecated. Please use the Array#sample method'
-      array.sample(n)
+      warn '[ArrayUtils.random_pick] is deprecated. Please use the ModuleUtils#fetch_sample method'
+      fetch_sample(array, count: n)
     end
 
     def self.rand(array)
-      warn '[ArrayUtils.rand] is deprecated. Please use the Array#sample method'
-      array.sample
+      warn '[ArrayUtils.rand] is deprecated. Please use the ModuleUtils#fetch_sample method'
+      fetch_sample(array)
     end
 
     def self.freeze_all(array)
@@ -23,17 +26,17 @@ module FFaker
     end
 
     def self.shuffle(array)
-      array.sort_by{Kernel.rand}
+      array.sort_by { FFaker::Random.rand }
     end
 
     def random_pick(n)
-      warn '[ArrayUtils#random_pick] is deprecated. Please use the Array#sample method'
-      self.sample(n)
+      warn '[ArrayUtils#random_pick] is deprecated. Please use the ModuleUtils#fetch_sample method'
+      ArrayUtils.random_pick(self, n)
     end
 
     def rand
-      warn '[ArrayUtils#rand] is deprecated. Please use the Array#sample method'
-      sample
+      warn '[ArrayUtils#rand] is deprecated. Please use the ModuleUtils#fetch_sample method'
+      ArrayUtils.rand(self)
     end
 
     def freeze_all

data/lib/ffaker/utils/module_utils.rb

@@ -1,7 +1,10 @@
 require 'ffaker/utils/array_utils'
+require 'ffaker/utils/random_utils'
 
 module FFaker
   module ModuleUtils
+    include RandomUtils
+
     def k(arg)
       FFaker::ArrayUtils.const_array(arg)
     end
@@ -10,7 +13,7 @@ module FFaker
       if const_name =~ /[a-z]/ # Not a constant, probably a class/module name.
         super const_name
       else
-        mod_name = ancestors.first.to_s.split("::").last
+        mod_name = ancestors.first.to_s.split('::').last
         data_path = "#{FFaker::BASE_LIB_PATH}/ffaker/data/#{underscore(mod_name)}/#{underscore(const_name.to_s)}"
         data = k File.read(data_path).split("\n")
         const_set const_name, data
@@ -19,11 +22,11 @@ module FFaker
     end
 
     def underscore(string)
-      string.gsub(/::/, '/').
-      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-      gsub(/([a-z\d])([A-Z])/,'\1_\2').
-      tr("-", "_").
-      downcase
+      string.gsub(/::/, '/')
+            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr('-', '_')
+            .downcase
     end
   end
 end

data/lib/ffaker/utils/random_utils.rb

@@ -0,0 +1,33 @@
+module FFaker
+  # Methods for returning repeatably-random data using the internal
+  # Random Number Generator. You should not need to use this directly, it is
+  # automatically included when you `include ModuleUtils` in a FFaker module.
+  module RandomUtils
+    # Returns a randon number from the internal Random Number Generator. Can be
+    # used in place of `rand` or `Kernal.rand`.
+    def rand(max = nil)
+      FFaker::Random.rand(max)
+    end
+
+    # Performs Array#sample on `list` using a the internal Random Number
+    # Generator so that the results are deterministic.
+    #
+    # * Returns one random item from `list`.
+    # * Pass `count: n` in options argument, where `n` is an integer, to
+    # return *n* items from `list`
+    def fetch_sample(list, options = {})
+      if (count = options.delete(:count))
+        list.sample(count, random: FFaker::Random)
+      else
+        list.sample(random: FFaker::Random)
+      end
+    end
+
+    # Performs same action as as `Array#suffle` (returns a randomly-reordered
+    # copy of `list`) except that it uses the internal Random Number Generator
+    # so that the results are deterministic.
+    def shuffle(list)
+      list.shuffle(random: FFaker::Random)
+    end
+  end
+end

data/lib/ffaker/vehicle.rb

@@ -5,39 +5,39 @@ module FFaker
     extend ModuleUtils
     extend self
 
-    DRIVETRAINS = %w(4WD 4X4 AWD FWD RWD)
-    YEARS = [*'1900'.."#{Date.today.year+1}"]
+    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
-    ))
-    TRANSMISSIONS_ABBR = %w(AT MT AM CVT)
-    CYLINDERS = %w(2 5 6 8)
+                         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
+                       ))
+    TRANSMISSIONS_ABBR = %w(AT MT AM CVT).freeze
+    CYLINDERS = %w(2 5 6 8).freeze
 
     def base_color
       FFaker::Color.name
     end
 
     def drivetrain
-      DRIVETRAINS.sample
+      fetch_sample(DRIVETRAINS)
     end
 
     def make
-      MAKES_LIST.sample
+      fetch_sample(MAKES_LIST)
     end
 
-    def manufacturer_color(n=2)
+    def manufacturer_color(n = 2)
       # Take two prefixes because it's more fun than one
-      (COLOR_PREFIXES.sample(n) + [base_color]).join(' ')
+      (fetch_sample(COLOR_PREFIXES, count: n) + [base_color]).join(' ')
     end
-    alias_method :mfg_color, :manufacturer_color
+    alias mfg_color manufacturer_color
 
     def model
-      MODELS_LIST.sample
+      fetch_sample(MODELS_LIST)
     end
 
     def trim
-      TRIMS_LIST.sample
+      fetch_sample(TRIMS_LIST)
     end
 
     def vin
@@ -45,31 +45,31 @@ module FFaker
     end
 
     def year
-      YEARS.sample
+      fetch_sample(YEARS)
     end
 
     def transmission
-      TRANSMISSIONS_LIST.sample
+      fetch_sample(TRANSMISSIONS_LIST)
     end
 
     def transmission_abbr
-      TRANSMISSIONS_ABBR.sample
+      fetch_sample(TRANSMISSIONS_ABBR)
     end
 
     def engine_cylinders
-      CYLINDERS.sample
+      fetch_sample(CYLINDERS)
     end
 
     def engine_displacement
-      DISPLACEMENTS_LIST.sample
+      fetch_sample(DISPLACEMENTS_LIST)
     end
 
     def fuel_type
-      FUEL_TYPES_LIST.sample
+      fetch_sample(FUEL_TYPES_LIST)
     end
 
     def interior_upholstery
-      UPHOLSTERY_LIST.sample
+      fetch_sample(UPHOLSTERY_LIST)
     end
   end
 end

data/lib/ffaker/venue.rb

@@ -6,7 +6,7 @@ module FFaker
     extend self
 
     def name
-      VENUE_LIST.sample
+      fetch_sample(VENUE_LIST)
     end
   end
 end

data/lib/ffaker/youtube.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module FFaker
+  module Youtube
+    extend ModuleUtils
+    extend self
+
+    def url
+      "www.youtube.com/watch?v=#{video_id}"
+    end
+
+    def share_url
+      "youtu.be/#{video_id}"
+    end
+
+    def embed_url
+      "www.youtube.com/embed/#{video_id}"
+    end
+
+    def video_id
+      fetch_sample(VIDEO_IDS)
+    end
+  end
+end

data/scripts/benchmark.rb

@@ -6,7 +6,7 @@ N = 10_000
 def run(name)
   require name
   Benchmark.bm do |rep|
-    rep.report("generating #{ N } names (#{name} #{FFaker::VERSION})") do
+    rep.report("generating #{N} names (#{name} #{FFaker::VERSION})") do
       N.times do
         FFaker::Name.name
       end
@@ -16,5 +16,5 @@ def run(name)
   exit(0)
 end
 
-fork { run("faker") }; Process.wait
-fork { run("ffaker") }; Process.wait
+fork { run('faker') }; Process.wait
+fork { run('ffaker') }; Process.wait

data/scripts/reference.rb

@@ -1,10 +1,10 @@
-$: << File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH << File.dirname(__FILE__) + '/../lib'
 require 'ffaker'
 
 ICONS = {
-  :error => "‼️",
-  :warning => "❗"
-}
+  error: "‼️",
+  warning: "❗"
+}.freeze
 
 # Get a list of sections
 def faker_modules
@@ -13,13 +13,16 @@ def faker_modules
     next unless mod.is_a?(Module)
     next if mod == FFaker::ArrayUtils
     next if mod == FFaker::ModuleUtils
+    next if mod == FFaker::RandomUtils
+    next if mod == FFaker::Random
     mod
   end.compact
 end
 
 # Returns faker methods for a given module
 def faker_methods(mod)
-  methods = mod.methods - Module.methods - [:k, :underscore]
+  methods = mod.methods - Module.methods -
+            [:k, :underscore, :fetch_sample, :rand, :shuffle]
 
   # For Company.name (et al), don't discard :name if it was reimplemented
   methods << :name if mod.send(:name) != mod.to_s
@@ -32,13 +35,13 @@ def warn(msg)
   $warnings << msg if $warnings
 end
 
-def catch_warnings(&blk)
+def catch_warnings
   $warnings = []
   [yield, $warnings]
 end
 
 def escape(str)
-  str.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;').gsub("\n", '')
+  str.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;').delete("\n")
 end
 
 sections = faker_modules.each.map do |mod|
@@ -46,28 +49,28 @@ sections = faker_modules.each.map do |mod|
 
   methods = faker_methods(mod)
   lines << "## #{mod}"
-  lines << ""
-  lines << "| Method | Example |"
-  lines << "| ------ | ------- |"
+  lines << ''
+  lines << '| Method | Example |'
+  lines << '| ------ | ------- |'
 
   methods.sort.each do |meth|
     arity = mod.method(meth).arity
 
     left = "`#{meth}`"
-    right =''
+    right = ''
 
     if arity > 0
-      left = "`#{meth}`(#{arity.times.map{'...'}.join(', ')})"
+      left = "`#{meth}`(#{arity.times.map { '...' }.join(', ')})"
     else
       begin
-        examples, warnings = catch_warnings {
+        examples, warnings = catch_warnings do
           3.times.map { mod.send meth }
-        }
-        if warnings.any?
-          right = "#{ICONS[:warning]} *#{warnings.first}*"
-        else
-          right = "#{escape examples.join(', ')}"
         end
+        right = if warnings.any?
+                  "#{ICONS[:warning]} *#{warnings.first}*"
+                else
+                  (escape examples.join(', ')).to_s
+                end
       rescue => e
         right = "#{ICONS[:error]} #{e.class}: #{e.message}"
       end
@@ -76,14 +79,14 @@ sections = faker_modules.each.map do |mod|
     lines << "| #{left} | #{right} |"
   end
 
-  lines << ""
+  lines << ''
 end
 
-puts "# FFaker reference"
-puts ""
+puts '# FFaker reference'
+puts ''
 faker_modules.each do |mod|
-  name = mod.to_s.downcase.gsub(':', '')
+  name = mod.to_s.downcase.delete(':')
   puts " * [#{mod}](##{name})"
 end
-puts ""
+puts ''
 puts sections.flatten.join("\n")