faker 2.11.0 → 2.17.0

data/lib/faker/quotes/shakespeare.rb

@@ -4,34 +4,104 @@ module Faker
   class Quotes
     class Shakespeare < Base
       class << self
+        ##
+        # Produces a Shakespeare quote from Hamlet.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.hamlet_quote # => "To be, or not to be: that is the question."
+        #
+        # @faker.version 1.9.2
         def hamlet_quote
           sample(hamlet)
         end
 
+        ##
+        # Produces a Shakespeare quote from As You Like It.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.as_you_like_it_quote # => "Can one desire too much of a good thing?."
+        #
+        # @faker.version 1.9.2
         def as_you_like_it_quote
           sample(as_you_like_it)
         end
 
+        ##
+        # Produces a Shakespeare quote from King Richard III.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.king_richard_iii_quote # => "Now is the winter of our discontent."
+        #
+        # @faker.version 1.9.2
         def king_richard_iii_quote
           sample(king_richard_iii)
         end
 
+        ##
+        # Produces a Shakespeare quote from Romeo And Juliet.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.romeo_and_juliet_quote # => "O Romeo, Romeo! wherefore art thou Romeo?."
+        #
+        # @faker.version 1.9.2
         def romeo_and_juliet_quote
           sample(romeo_and_juliet)
         end
 
+        ##
+        # Generates quote from Hamlet
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.hamlet   #=> "A little more than kin, and less than kind."
+        #
+        # @faker.version 1.9.2
         def hamlet
           fetch('shakespeare.hamlet')
         end
 
+        ##
+        # Generates quote from 'As you like it!'
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.as_you_like_it   #=> "How bitter a thing it is to look into happiness through another man's eyes!"
+        #
+        # @faker.version 1.9.2
         def as_you_like_it
           fetch('shakespeare.as_you_like_it')
         end
 
+        ##
+        # Returns quote from 'King Rechard III'
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare  #=> "The king's name is a tower of strength."
         def king_richard_iii
           fetch('shakespeare.king_richard_iii')
         end
 
+        ##
+        # Quote from 'Romeo and Juliet'
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.romeo_and_juliet  #=> "Wisely and slow; they stumble that run fast."
+        #
+        # @faker.version 1.9.2
         def romeo_and_juliet
           fetch('shakespeare.romeo_and_juliet')
         end

data/lib/faker/sports/volleyball.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Faker
+  class Sports
+    class Volleyball < Base
+      class << self
+        ##
+        # Produces the name of a volleyball team.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Volleyball.team #=> "Leo Shoes Modena"
+        #
+        # @faker.version next
+        def team
+          fetch('volleyball.team')
+        end
+
+        ##
+        # Produces the name of a volleyball player.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Volleyball.player #=> "Saeid Marouf"
+        #
+        # @faker.version next
+        def player
+          fetch('volleyball.player')
+        end
+
+        ##
+        # Produces the name of a volleyball coach.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Volleyball.coach #=> "Russ Rose"
+        #
+        # @faker.version next
+        def coach
+          fetch('volleyball.coach')
+        end
+
+        ##
+        # Produces a position in volleyball.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Volleyball.position #=> "Middle blocker"
+        #
+        # @faker.version next
+        def position
+          fetch('volleyball.position')
+        end
+
+        ##
+        # Produces a formation in volleyball.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Volleyball.formation #=> "4-2"
+        #
+        # @faker.version next
+        def formation
+          fetch('volleyball.formation')
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/aqua_teen_hunger_force.rb

@@ -18,6 +18,19 @@ module Faker
         def character
           fetch('aqua_teen_hunger_force.character')
         end
+
+        ##
+        # Produces a perl of great ATHF wisdom
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::AquaTeenHungerForce.quote #=> "Friendship ain't about trust. Friendship's about nunchucks."
+        #
+        # @faker.version 2.13.0
+        def quote
+          fetch('aqua_teen_hunger_force.quote')
+        end
       end
     end
   end

data/lib/faker/tv_shows/big_bang_theory.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class BigBangTheory < Base
+      flexible :big_bang_theory
+
+      class << self
+        ##
+        # Produces a character from Big Bang Theory
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BigBangTheory.character #=> "Sheldon Cooper"
+        #
+        # @faker.version 2.13.0
+        def character
+          fetch('big_bang_theory.characters')
+        end
+
+        ##
+        # Produces a quote from Bing Bang Theory
+        #
+        # @return [String]
+        #
+        # @example
+        #  Faker::TvShows::BigBangTheory.quote #=> "I'm not crazy. My mother had me tested."
+        #
+        # @faker.version 2.13.0
+        def quote
+          fetch('big_bang_theory.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/buffy.rb

@@ -33,17 +33,30 @@ module Faker
         end
 
         ##
-        # Produces a celebrity from Buffy the Vampire Slayer.
+        # Produces a actor from Buffy the Vampire Slayer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Buffy.actor #=> "John Ritter"
+        #
+        # @faker.version next
+        def actor
+          fetch('buffy.actors')
+        end
+
+        ##
+        # Produces a actor from Buffy the Vampire Slayer.
         #
         # @return [String]
         #
         # @example
         #   Faker::TvShows::Buffy.celebrity #=> "John Ritter"
         #
+        # @deprecated Use the `actor` method instead.
+        #
         # @faker.version 1.9.2
-        def celebrity
-          fetch('buffy.celebrities')
-        end
+        alias celebrity actor
 
         ##
         # Produces a big bad from Buffy the Vampire Slayer.

data/lib/faker/tv_shows/dr_who.rb

@@ -79,7 +79,7 @@ module Faker
         # @example
         #   Faker::TvShows::DrWho.villain #=> "The Master"
         #
-        # @faker.version next
+        # @faker.version 2.13.0
         def villain
           fetch('dr_who.villains')
         end

data/lib/faker/tv_shows/final_space.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class FinalSpace < Base
+      flexible :final_space
+
+      class << self
+        ##
+        # Produces a character from Final Space.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::FinalSpace.character #=> "Gary Goodspeed"
+        #
+        # @faker.version next
+        def character
+          fetch('final_space.characters')
+        end
+
+        ##
+        # Produces a vehicle from Final Space.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::FinalSpace.vehicle #=> "Imperium Cruiser"
+        #
+        # @faker.version next
+        def vehicle
+          fetch('final_space.vehicles')
+        end
+
+        ##
+        # Produces a quote from Final Space.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::FinalSpace.quote
+        #     #=> "It's an alien on my face! It's an alien on my...It's a space alien!"
+        #
+        # @faker.version next
+        def quote
+          fetch('final_space.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/futurama.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class Futurama < Base
+      flexible :futurama
+
+      class << self
+        ##
+        # Produces a character from Futurama.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Futurama.character #=> "Amy Wong"
+        #
+        # @faker.version 2.13.0
+        def character
+          fetch('futurama.characters')
+        end
+
+        ##
+        # Produces a location from Futurama.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Futurama.location #=> "Wormulon"
+        #
+        # @faker.version 2.13.0
+        def location
+          fetch('futurama.locations')
+        end
+
+        ##
+        # Produces a quote from Futurama.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Futurama.quote
+        #     #=> "Ugh, it's like a party in my mouth & everyone's throwing up."
+        #
+        # @faker.version 2.13.0
+        def quote
+          fetch('futurama.quotes')
+        end
+
+        ##
+        # Produces a catchphrase from Hermes Conrad.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Futurama.hermes_catchphrase
+        #     #=> "Great foo of bar!"
+        #
+        # @faker.version 2.13.0
+        def hermes_catchphrase
+          fetch('futurama.hermes_catchphrases')
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/simpsons.rb

@@ -45,6 +45,20 @@ module Faker
         def quote
           fetch('simpsons.quotes')
         end
+
+        ##
+        # Produces an episode title from The Simpsons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Simpsons.episode_title
+        #     #=> "Two Cars in Every Garage and Three Eyes on Every Fish"
+        #
+        # @faker.version 2.13.0
+        def episode_title
+          fetch('simpsons.episode_titles')
+        end
       end
     end
   end

data/lib/faker/tv_shows/suits.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class Suits < Base
+      flexible :suits
+
+      class << self
+        ##
+        # Produces a character from Suits.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::Suits.character #=> "Harvey Specter"
+        #
+        # @faker.version 2.13.0
+        def character
+          fetch('suits.characters')
+        end
+
+        ##
+        # Produces a quote from Suits.
+        #
+        # @return [String]
+        #
+        # @example
+        #  Faker::TvShows::Suits.quote #=> "Don't play the odds, play the man."
+        #
+        # @faker.version 2.13.0
+        def quote
+          fetch('suits.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/the_fresh_prince_of_bel_air.rb

@@ -20,17 +20,30 @@ module Faker
         end
 
         ##
-        # Produces a celebrity from The Fresh Prince of Bel-Air.
+        # Produces a actor from The Fresh Prince of Bel-Air.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::TheFreshPrinceOfBelAir.actor #=> "Quincy Jones"
+        #
+        # @faker.version next
+        def actor
+          fetch('the_fresh_prince_of_bel_air.actors')
+        end
+
+        ##
+        # Produces a actor from The Fresh Prince of Bel-Air.
         #
         # @return [String]
         #
         # @example
         #   Faker::TvShows::TheFreshPrinceOfBelAir.celebrity #=> "Quincy Jones"
         #
+        # @deprecated Use the `actor` method instead.
+        #
         # @faker.version 1.8.3
-        def celebrity
-          fetch('the_fresh_prince_of_bel_air.celebrities')
-        end
+        alias celebrity actor
 
         ##
         # Produces a quote from The Fresh Prince of Bel-Air.

data/lib/faker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Faker #:nodoc:
-  VERSION = '2.11.0'
+  VERSION = '2.17.0'
 end

data/lib/faker.rb

@@ -2,29 +2,26 @@
 
 mydir = __dir__
 
-begin
-  require 'psych'
-end
-
+require 'psych'
 require 'i18n'
 require 'set' # Fixes a bug in i18n 0.6.11
 
-Dir.glob(File.join(File.dirname(__FILE__), 'helpers', '*.rb')).sort.each { |file| require file }
+Dir.glob(File.join(mydir, 'helpers', '*.rb')).sort.each { |file| require file }
 
 I18n.load_path += Dir[File.join(mydir, 'locales', '**/*.yml')]
 I18n.reload! if I18n.backend.initialized?
 
 module Faker
-  class Config
+  module Config
     @locale = nil
     @random = nil
 
     class << self
-      attr_writer :locale
-      attr_writer :random
+      attr_writer :locale, :random
 
       def locale
-        @locale || I18n.locale
+        # Because I18n.locale defaults to :en, if we don't have :en in our available_locales, errors will happen
+        @locale || (I18n.available_locales.include?(I18n.locale) ? I18n.locale : I18n.available_locales.first)
       end
 
       def own_locale
@@ -32,7 +29,7 @@ module Faker
       end
 
       def random
-        @random || Random::DEFAULT
+        @random || Random.new
       end
     end
   end
@@ -83,13 +80,13 @@ module Faker
       def regexify(reg)
         reg = reg.source if reg.respond_to?(:source) # Handle either a Regexp or a String that looks like a Regexp
         reg
-          .gsub(%r{^\/?\^?}, '').gsub(%r{\$?\/?$}, '') # Ditch the anchors
+          .gsub(%r{^/?\^?}, '').gsub(%r{\$?/?$}, '') # Ditch the anchors
           .gsub(/\{(\d+)\}/, '{\1,\1}').gsub(/\?/, '{0,1}') # All {2} become {2,2} and ? become {0,1}
           .gsub(/(\[[^\]]+\])\{(\d+),(\d+)\}/) { |_match| Regexp.last_match(1) * sample(Array(Range.new(Regexp.last_match(2).to_i, Regexp.last_match(3).to_i))) }                # [12]{1,2} becomes [12] or [12][12]
-          .gsub(/(\([^\)]+\))\{(\d+),(\d+)\}/) { |_match| Regexp.last_match(1) * sample(Array(Range.new(Regexp.last_match(2).to_i, Regexp.last_match(3).to_i))) }                # (12|34){1,2} becomes (12|34) or (12|34)(12|34)
+          .gsub(/(\([^)]+\))\{(\d+),(\d+)\}/) { |_match| Regexp.last_match(1) * sample(Array(Range.new(Regexp.last_match(2).to_i, Regexp.last_match(3).to_i))) }                 # (12|34){1,2} becomes (12|34) or (12|34)(12|34)
           .gsub(/(\\?.)\{(\d+),(\d+)\}/) { |_match| Regexp.last_match(1) * sample(Array(Range.new(Regexp.last_match(2).to_i, Regexp.last_match(3).to_i))) }                      # A{1,2} becomes A or AA or \d{3} becomes \d\d\d
-          .gsub(/\((.*?)\)/) { |match| sample(match.gsub(/[\(\)]/, '').split('|')) } # (this|that) becomes 'this' or 'that'
-          .gsub(/\[([^\]]+)\]/) { |match| match.gsub(/(\w\-\w)/) { |range| sample(Array(Range.new(*range.split('-')))) } } # All A-Z inside of [] become C (or X, or whatever)
+          .gsub(/\((.*?)\)/) { |match| sample(match.gsub(/[()]/, '').split('|')) } # (this|that) becomes 'this' or 'that'
+          .gsub(/\[([^\]]+)\]/) { |match| match.gsub(/(\w-\w)/) { |range| sample(Array(Range.new(*range.split('-')))) } } # All A-Z inside of [] become C (or X, or whatever)
           .gsub(/\[([^\]]+)\]/) { |_match| sample(Regexp.last_match(1).split('')) } # All [ABC] become B (or A or C)
           .gsub('\d') { |_match| sample(Numbers) }
           .gsub('\w') { |_match| sample(Letters) }
@@ -99,7 +96,7 @@ module Faker
       # with an array of values and selecting one of them.
       def fetch(key)
         fetched = sample(translate("faker.#{key}"))
-        if fetched&.match(%r{^\/}) && fetched&.match(%r{\/$}) # A regex
+        if fetched&.match(%r{^/}) && fetched&.match(%r{/$}) # A regex
           regexify(fetched)
         else
           fetched
@@ -111,7 +108,7 @@ module Faker
       def fetch_all(key)
         fetched = translate("faker.#{key}")
         fetched = fetched.last if fetched.size <= 1
-        if !fetched.respond_to?(:sample) && fetched.match(%r{^\/}) && fetched.match(%r{\/$}) # A regex
+        if !fetched.respond_to?(:sample) && fetched.match(%r{^/}) && fetched.match(%r{/$}) # A regex
           regexify(fetched)
         else
           fetched
@@ -123,7 +120,7 @@ module Faker
       # formatted translation: e.g., "#{first_name} #{last_name}".
       def parse(key)
         fetched = fetch(key)
-        parts = fetched.scan(/(\(?)#\{([A-Za-z]+\.)?([^\}]+)\}([^#]+)?/).map do |prefix, kls, meth, etc|
+        parts = fetched.scan(/(\(?)#\{([A-Za-z]+\.)?([^}]+)\}([^#]+)?/).map do |prefix, kls, meth, etc|
           # If the token had a class Prefix (e.g., Name.first_name)
           # grab the constant, otherwise use self
           cls = kls ? Faker.const_get(kls.chop) : self
@@ -132,7 +129,7 @@ module Faker
           # In either case the information will be retained for reconstruction of the string.
           text = prefix
 
-          # If the class has the method, call it, otherwise fetch the transation
+          # If the class has the method, call it, otherwise fetch the translation
           # (e.g., faker.phone_number.area_code)
           text += if cls.respond_to?(meth)
                     cls.send(meth)
@@ -167,12 +164,12 @@ module Faker
       end
 
       # Executes block with given locale set.
-      def with_locale(tmp_locale = nil)
+      def with_locale(tmp_locale = nil, &block)
         current_locale = Faker::Config.own_locale
         Faker::Config.locale = tmp_locale
 
         disable_enforce_available_locales do
-          I18n.with_locale(tmp_locale) { yield }
+          I18n.with_locale(tmp_locale, &block)
         end
       ensure
         Faker::Config.locale = current_locale
@@ -225,8 +222,16 @@ module Faker
         @unique ||= UniqueGenerator.new(self, max_retries)
       end
 
-      def sample(list)
-        list.respond_to?(:sample) ? list.sample(random: Faker::Config.random) : list
+      def sample(list, num = nil)
+        if list.respond_to?(:sample)
+          if num
+            list.sample(num, random: Faker::Config.random)
+          else
+            list.sample(random: Faker::Config.random)
+          end
+        else
+          list
+        end
       end
 
       def shuffle(list)
@@ -307,4 +312,4 @@ module Faker
 end
 
 # require faker objects
-Dir.glob(File.join(File.dirname(__FILE__), 'faker', '/**/*.rb')).sort.each { |file| require file }
+Dir.glob(File.join(mydir, 'faker', '/**/*.rb')).sort.each { |file| require file }

data/lib/helpers/base58.rb

@@ -7,7 +7,7 @@ module Faker
       base = alphabet.size
 
       lv = 0
-      str.split('').reverse.each_with_index { |v, i| lv += v.unpack('C')[0] * 256**i }
+      str.split('').reverse.each_with_index { |v, i| lv += v.unpack1('C') * 256**i }
 
       ret = +''
       while lv.positive?