faker 3.0.0 → 3.5.2

data/lib/faker/default/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Faker
   class Json < Base
     require 'json'
@@ -71,7 +73,7 @@ module Faker
         options[:value] = "Faker::#{options[:value]}"
 
         hash = JSON.parse(json)
-        hash.each do |key, _|
+        hash.each_key do |key|
           add_hash_to_bottom(hash, [key], width, options)
         end
         JSON.generate(hash)
@@ -93,7 +95,7 @@ module Faker
       def add_hash_to_bottom(hash, key_array, width, options)
         key_string = build_keys_from_array(key_array)
         if eval("hash#{key_string}").is_a?(::Hash)
-          eval("hash#{key_string}").each do |key, _|
+          eval("hash#{key_string}").each_key do |key|
             key_array << key
             add_hash_to_bottom(hash, key_array, width, options)
           end
@@ -104,17 +106,20 @@ module Faker
       end
 
       def add_hash(key_array, hash, width, options)
-        string_to_eval = 'hash'
+        string_to_eval = 'hash'.dup
+
         key_array.length.times do |index|
           string_to_eval << "['#{key_array[index]}']"
         end
         string_to_eval << " = #{build_shallow_hash(width, options)}"
         eval(string_to_eval)
+
         hash
       end
 
       def build_keys_from_array(key_array)
-        key_string = ''
+        key_string = ''.dup
+
         key_array.each do |value|
           key_string << "['#{value}']"
         end

data/lib/faker/default/lorem.rb

@@ -10,10 +10,13 @@ module Faker
       #
       # @example
       #   Faker::Lorem.word   #=> "soluto"
+      #   Faker::Lorem.word(exclude_words: 'error') #=> "nisi"
+      #   Faker::Lorem.word(exclude_words: 'id, error') #=> "et"
+      #   Faker::Lorem.word(exclude_words: ['id', 'error']) #=> "consequatur"
       #
       # @faker.version 2.1.3
-      def word
-        sample(translate('faker.lorem.words'))
+      def word(exclude_words: nil)
+        words(number: 1, exclude_words: exclude_words).first
       end
 
       ##
@@ -28,16 +31,21 @@ module Faker
       #   Faker::Lorem.words                                    #=> ["hic", "quia", "nihil"]
       #   Faker::Lorem.words(number: 4)                         #=> ["est", "temporibus", "et", "quaerat"]
       #   Faker::Lorem.words(number: 4, supplemental: true)    #=> ["nisi", "sit", "allatus", "consequatur"]
+      #   Faker::Lorem.words(number: 4, supplemental: true, exclude_words: 'sit') #=> ["nisi", "allatus", "consequatur", "aut"]
       #
       # @faker.version 2.1.3
-      def words(number: 3, supplemental: false)
+      def words(number: 3, supplemental: false, exclude_words: nil)
         resolved_num = resolve(number)
         word_list = (
           translate('faker.lorem.words') +
           (supplemental ? translate('faker.lorem.supplemental') : [])
         )
+        if exclude_words
+          exclude_words = exclude_words.split(', ') if exclude_words.instance_of?(::String)
+          word_list -= exclude_words
+        end
         word_list *= ((resolved_num / word_list.length) + 1)
-        shuffle(word_list)[0, resolved_num]
+        sample(word_list, resolved_num)
       end
 
       ##
@@ -103,8 +111,8 @@ module Faker
       #   Faker::Lorem.sentence(word_count: 5, supplemental: true, random_words_to_add:2)   #=> "Crinis quo cruentus velit animi vomer."
       #
       # @faker.version 2.1.3
-      def sentence(word_count: 4, supplemental: false, random_words_to_add: 0)
-        words(number: word_count + rand(random_words_to_add.to_i), supplemental: supplemental).join(locale_space).capitalize + locale_period
+      def sentence(word_count: 4, supplemental: false, random_words_to_add: 0, exclude_words: nil)
+        words(number: word_count + rand(random_words_to_add.to_i), supplemental: supplemental, exclude_words: exclude_words).join(locale_space).capitalize + locale_period
       end
 
       ##
@@ -121,8 +129,8 @@ module Faker
       #   Faker::Lorem.sentences(number: 2, supplemental: true)   #=> ["Cito cena ad.", "Solvo animus allatus."]
       #
       # @faker.version 2.1.3
-      def sentences(number: 3, supplemental: false)
-        1.upto(resolve(number)).collect { sentence(word_count: 3, supplemental: supplemental) }
+      def sentences(number: 3, supplemental: false, exclude_words: nil)
+        1.upto(resolve(number)).collect { sentence(word_count: 3, supplemental: supplemental, exclude_words: exclude_words) }
       end
 
       ##
@@ -145,8 +153,8 @@ module Faker
       #     #=> "Texo tantillus tamisium. Tribuo amissio tamisium. Facere aut canis."
       #
       # @faker.version 2.1.3
-      def paragraph(sentence_count: 3, supplemental: false, random_sentences_to_add: 0)
-        sentences(number: resolve(sentence_count) + rand(random_sentences_to_add.to_i), supplemental: supplemental).join(locale_space)
+      def paragraph(sentence_count: 3, supplemental: false, random_sentences_to_add: 0, exclude_words: nil)
+        sentences(number: resolve(sentence_count) + rand(random_sentences_to_add.to_i), supplemental: supplemental, exclude_words: exclude_words).join(locale_space)
       end
 
       ##
@@ -163,8 +171,8 @@ module Faker
       #   Faker::Lorem.paragraphs(number:2, supplemental: true)
       #
       # @faker.version 2.1.3
-      def paragraphs(number: 3, supplemental: false)
-        1.upto(resolve(number)).collect { paragraph(sentence_count: 3, supplemental: supplemental) }
+      def paragraphs(number: 3, supplemental: false, exclude_words: nil)
+        1.upto(resolve(number)).collect { paragraph(sentence_count: 3, supplemental: supplemental, exclude_words: exclude_words) }
       end
 
       ##
@@ -205,8 +213,8 @@ module Faker
       #   Faker::Lorem.question(word_count: 2, supplemental: true, random_words_to_add: 2)    #=> "Depulso uter ut?"
       #
       # @faker.version 2.1.3
-      def question(word_count: 4, supplemental: false, random_words_to_add: 0)
-        words(number: word_count + rand(random_words_to_add), supplemental: supplemental).join(' ').capitalize + locale_question_mark
+      def question(word_count: 4, supplemental: false, random_words_to_add: 0, exclude_words: nil)
+        words(number: word_count + rand(random_words_to_add), supplemental: supplemental, exclude_words: exclude_words).join(' ').capitalize + locale_question_mark
       end
 
       ##
@@ -223,8 +231,8 @@ module Faker
       #   Faker::Lorem.questions(number: 2, supplemental: true)   #=> ["Acceptus subito cetera?", "Aro sulum cubicularis?"]
       #
       # @faker.version 2.1.3
-      def questions(number: 3, supplemental: false)
-        1.upto(resolve(number)).collect { question(word_count: 3, supplemental: supplemental) }
+      def questions(number: 3, supplemental: false, exclude_words: nil)
+        1.upto(resolve(number)).collect { question(word_count: 3, supplemental: supplemental, exclude_words: exclude_words) }
       end
 
       private

data/lib/faker/default/marketing.rb

@@ -6,7 +6,7 @@ module Faker
 
     class << self
       ##
-      # Produces the name of a video game console or platform.
+      # Produces a few marketing buzzwords.
       #
       # @return [String]
       #

data/lib/faker/default/measurement.rb

@@ -9,7 +9,7 @@ module Faker
       ##
       # Produces a random height measurement.
       #
-      # @param amount [Integer] Speficies the random height value.
+      # @param amount [Integer] Specifies the random height value.
       # @return [String]
       #
       # @example
@@ -26,7 +26,7 @@ module Faker
       ##
       # Produces a random length measurement.
       #
-      # @param amount [Integer] Speficies the random length value.
+      # @param amount [Integer] Specifies the random length value.
       # @return [String]
       #
       # @example
@@ -41,7 +41,7 @@ module Faker
       ##
       # Produces a random volume measurement.
       #
-      # @param amount [Integer] Speficies the random volume value.
+      # @param amount [Integer] Specifies the random volume value.
       # @return [String]
       #
       # @example
@@ -56,7 +56,7 @@ module Faker
       ##
       # Produces a random weight measurement.
       #
-      # @param amount [Integer] Speficies the random weight value.
+      # @param amount [Integer] Specifies the random weight value.
       # @return [String]
       #
       # @example
@@ -71,7 +71,7 @@ module Faker
       ##
       # Produces a random metric height measurement.
       #
-      # @param amount [Integer] Speficies the random height value.
+      # @param amount [Integer] Specifies the random height value.
       # @return [String]
       #
       # @example
@@ -86,7 +86,7 @@ module Faker
       ##
       # Produces a random metric length measurement.
       #
-      # @param amount [Integer] Speficies the random length value.
+      # @param amount [Integer] Specifies the random length value.
       # @return [String]
       #
       # @example
@@ -101,7 +101,7 @@ module Faker
       ##
       # Produces a random metric volume measurement.
       #
-      # @param amount [Integer] Speficies the random volume value.
+      # @param amount [Integer] Specifies the random volume value.
       # @return [String]
       #
       # @example
@@ -116,7 +116,7 @@ module Faker
       ##
       # Produces a random metric weight measurement.
       #
-      # @param amount [Integer] Speficies the random weight value.
+      # @param amount [Integer] Specifies the random weight value.
       # @return [String]
       #
       # @example

data/lib/faker/default/{nhs.rb → national_health_service.rb}

@@ -6,24 +6,28 @@ module Faker
       ##
       # Produces a random British NHS number.
       #
+      # The NHS sets aside a range of numbers from 999 000 0000 to 999 999 9999
+      # for test purposes.
+      #
       # @return [String]
       #
       # @example
-      #   Faker::NationalHealthService.british_number #=> "403 958 5577"
+      #   Faker::NationalHealthService.british_number #=> "999 464 0232"
       #
       # @faker.version 1.9.2
       def british_number
-        base_number = rand(400_000_001...499_999_999)
+        base_number = rand(999_000_001...999_999_999)
         # If the check digit is equivalent to 10, the number is invalid.
         # See https://en.wikipedia.org/wiki/NHS_number
         base_number -= 1 if check_digit(number: base_number) == 10
-        "#{base_number}#{check_digit(number: base_number)}".to_s
-                                                           .chars
+        "#{base_number}#{check_digit(number: base_number)}".chars
                                                            .insert(3, ' ')
                                                            .insert(7, ' ')
                                                            .join
       end
 
+      private
+
       ##
       # Produces a random British NHS number's check digit.
       #

data/lib/faker/default/number.rb

@@ -114,7 +114,7 @@ module Faker
       # @faker.version 1.0.0
       def hexadecimal(digits: 6)
         hex = ''
-        digits.times { hex += rand(15).to_s(16) }
+        digits.times { hex += rand(16).to_s(16) }
         hex
       end
 

data/lib/faker/default/omniauth.rb

@@ -12,7 +12,7 @@ module Faker
       super()
 
       @name = name || "#{Name.first_name} #{Name.last_name}"
-      @email = email || Internet.safe_email(name: self.name)
+      @email = email || Internet.email(name: self.name)
       @first_name, @last_name = self.name.split
     end
 
@@ -444,11 +444,11 @@ module Faker
       private
 
       def gender
-        shuffle(%w[male female]).pop
+        sample(%w[male female])
       end
 
       def timezone
-        shuffle((-12..12).to_a).pop
+        sample((-12..12).to_a)
       end
 
       def image
@@ -460,11 +460,11 @@ module Faker
       end
 
       def random_number_from_range(range)
-        shuffle(range.to_a).pop
+        sample(range.to_a)
       end
 
       def random_boolean
-        shuffle([true, false]).pop
+        sample([true, false])
       end
     end
   end

data/lib/faker/default/phone_number.rb

@@ -4,12 +4,14 @@ module Faker
   class PhoneNumber < Base
     class << self
       ##
-      # Produces a random phone number in a random format (may or may not have a country code, extension and can have different dividers).
+      # Produces a phone number in a random format without the country code and it can have different dividers.
       #
       # @return [String]
       #
       # @example
-      #   Faker::PhoneNumber.phone_number #=> "397.693.1309 x4321"
+      #   Faker::PhoneNumber.phone_number #=> "(504) 113-1705"
+      #   Faker::PhoneNumber.phone_number #=> "662.291.7201"
+      #   Faker::PhoneNumber.phone_number #=> "9415283713"
       #
       # @faker.version 0.3.0
       def phone_number
@@ -17,12 +19,14 @@ module Faker
       end
 
       ##
-      # Produces a random cell phone number in a random format (may or may not have a country code and can have different dividers).
+      # Produces a random cell phone number in a random format without the country code and it can have different dividers.
       #
       # @return [String]
       #
       # @example
-      #   Faker::PhoneNumber.cell_phone #=> "(186)285-7925"
+      #   Faker::PhoneNumber.cell_phone #=> "(836) 115-8995"
+      #   Faker::PhoneNumber.cell_phone #=> "382-597-5739"
+      #   Faker::PhoneNumber.cell_phone #=> "316.828.1822"
       #
       # @faker.version 1.0.0
       def cell_phone
@@ -36,10 +40,12 @@ module Faker
       #
       # @example
       #   Faker::PhoneNumber.country_code #=> "+20"
+      #   Faker::PhoneNumber.country_code #=> "+39"
+      #   Faker::PhoneNumber.country_code #=> "+852"
       #
       # @faker.version 1.9.2
       def country_code
-        "+#{fetch('country_code')}"
+        "+#{fetch('phone_number.country_code')}"
       end
 
       ##
@@ -48,7 +54,9 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::PhoneNumber.phone_number_with_country_code #=> "+95 1-672-173-8153"
+      #   Faker::PhoneNumber.phone_number_with_country_code #=> "+55 466-746-6882"
+      #   Faker::PhoneNumber.phone_number_with_country_code #=> "+81 3718219558"
+      #   Faker::PhoneNumber.phone_number_with_country_code #=> "+49 140 957 9846"
       #
       # @faker.version 1.9.2
       def phone_number_with_country_code
@@ -61,7 +69,9 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::PhoneNumber.cell_phone_with_country_code #=> "+974 (190) 987-9034"
+      #   Faker::PhoneNumber.cell_phone_with_country_code #=> "+852 (190) 987-9034"
+      #   Faker::PhoneNumber.cell_phone_with_country_code #=> "+64 (820) 583-6474"
+      #   Faker::PhoneNumber.cell_phone_with_country_code #=> "+1 591.871.7985"
       #
       # @faker.version 1.9.2
       def cell_phone_with_country_code
@@ -69,12 +79,14 @@ module Faker
       end
 
       ##
-      # Produces a random phone number in e164 format.
+      # Produces a random phone number in e164 format, i.e., without any dividers.
       #
       # @return [String]
       #
       # @example
-      #   Faker::PhoneNumber.cell_phone_in_e164 #=> "+944937040625"
+      #   Faker::PhoneNumber.cell_phone_in_e164 #=> "+542024834991"
+      #   Faker::PhoneNumber.cell_phone_in_e164 #=> "+8522846847703"
+      #   Faker::PhoneNumber.cell_phone_in_e164 #=> "+649477546575"
       #
       # @faker.version 1.9.2
       def cell_phone_in_e164
@@ -82,49 +94,56 @@ module Faker
       end
 
       ##
-      # Produces a random US or Canada-based area code.
+      # Produces a random area code.
       #
       # @return [String]
       #
       # @example
       #   Faker::PhoneNumber.area_code #=> "201"
+      #   Faker::PhoneNumber.area_code #=> "613"
+      #   Faker::PhoneNumber.area_code #=> "321"
       #
       # @faker.version 1.3.0
       def area_code
         fetch('phone_number.area_code')
-      rescue I18n::MissingTranslationData
-        nil
       end
 
       ##
-      # Produces a random US or Canada-based exchange code.
+      # Produces a random exchange code.
       #
       # @return [String]
       #
       # @example
       #   Faker::PhoneNumber.exchange_code #=> "208"
+      #   Faker::PhoneNumber.exchange_code #=> "415"
+      #   Faker::PhoneNumber.exchange_code #=> "652"
       #
       # @faker.version 1.3.0
       def exchange_code
         fetch('phone_number.exchange_code')
-      rescue I18n::MissingTranslationData
-        nil
       end
 
       ##
-      # Produces a random US or Canada-based extension / subscriber number. Can be used for both extensions and last four digits of phone number.
+      # Produces a random extension / subscriber number. Can be used for both extensions and last four digits of phone number.
       #
-      # @param length [Integer] Speficies the length of the return value.
+      # @param length [Integer] Specifies the length of the return value. Defaults to 4.
       # @return [String]
       #
       # @example
       #   Faker::PhoneNumber.subscriber_number #=> "3873"
       #   Faker::PhoneNumber.subscriber_number(length: 2) #=> "39"
       #   Faker::PhoneNumber.extension #=> "3764"
+      #   Faker::PhoneNumber.extension(length: 2) => "37"
       #
       # @faker.version 1.3.0
       def subscriber_number(length: 4)
-        rand.to_s[2..(1 + length)]
+        if !length.is_a?(Integer) || length > 10
+          raise ArgumentError, 'length must be an Integer and be lesser than 10'
+        end
+
+        generate(:string) do |g|
+          g.int(length: length)
+        end
       end
 
       alias extension subscriber_number

data/lib/faker/default/placeholdit.rb

@@ -45,7 +45,7 @@ module Faker
       private
 
       def generate_color
-        format('%06x', (rand * 0xffffff))
+        format('%06x', rand * 0xffffff)
       end
     end
   end

data/lib/faker/default/south_africa.rb

@@ -13,7 +13,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def id_number
-        Faker::IDNumber.south_african_id_number
+        Faker::IdNumber.south_african_id_number
       end
 
       ##
@@ -26,7 +26,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def valid_id_number
-        Faker::IDNumber.valid_south_african_id_number
+        Faker::IdNumber.valid_south_african_id_number
       end
 
       ##
@@ -39,7 +39,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def invalid_id_number
-        Faker::IDNumber.invalid_south_african_id_number
+        Faker::IdNumber.invalid_south_african_id_number
       end
 
       ##

data/lib/faker/{music/show.rb → default/theater.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Faker
-  class Show < Base
+  class Theater < Base
     class << self
       ##
       # Produces the name of a musical for an older audience
@@ -9,12 +9,12 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Alphanumeric.alpha
-      #     #=> "West Side Story"
+      #   Faker::Theater.adult_musical
+      #     #=> "Mamma Mia!"
       #
       # @faker.version 2.13.0
       def adult_musical
-        fetch('show.adult_musical')
+        fetch('theater.adult_musical')
       end
 
       ##
@@ -23,12 +23,12 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Alphanumeric.alpha
+      #   Faker::Theater.kids_musical
       #     #=> "Into the Woods JR."
       #
       # @faker.version 2.13.0
       def kids_musical
-        fetch('show.kids_musical')
+        fetch('theater.kids_musical')
       end
 
       ##
@@ -37,12 +37,12 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Alphanumeric.alpha
+      #   Faker::Theater.play
       #     #=> "Death of a Salesman"
       #
       # @faker.version 2.13.0
       def play
-        fetch('show.play')
+        fetch('theater.play')
       end
     end
   end

data/lib/faker/default/twitter.rb

@@ -18,7 +18,7 @@ module Faker
       # @faker.version 1.7.3
       def user(include_status: true, include_email: false)
         user_id = id
-        background_image_url = Faker::LoremPixel.image(size: '600x400') # TODO: Make the dimensions change
+        background_image_url = Faker::LoremFlickr.image(size: '600x400')
         profile_image_url = Faker::Avatar.image(slug: user_id, size: '48x48')
         user = {
           id: user_id,
@@ -46,7 +46,7 @@ module Faker
           profile_background_image_url_https: background_image_url,
           profile_background_image_url: background_image_url.sub('https://', 'http://'),
           profile_background_tile: Faker::Boolean.boolean(true_ratio: 0.1),
-          profile_banner_url: Faker::LoremPixel.image(size: '1500x500'),
+          profile_banner_url: Faker::LoremFlickr.image(size: '1500x500'),
           profile_image_url_https: profile_image_url,
           profile_image_url: profile_image_url.sub('https://', 'http://'),
           profile_link_color: Faker::Color.hex_color,
@@ -63,7 +63,7 @@ module Faker
           verified: Faker::Boolean.boolean(true_ratio: 0.1)
         }
         user[:status] = Faker::Twitter.status(include_user: false) if include_status
-        user[:email] = Faker::Internet.safe_email if include_email
+        user[:email] = Faker::Internet.email if include_email
         user
       end
 
@@ -163,9 +163,7 @@ module Faker
       end
 
       def photo_entity
-        # TODO: Dynamic image sizes
-        # TODO: Return accurate indices
-        media_url = Faker::LoremPixel.image(size: '1064x600')
+        media_url = Faker::LoremFlickr.image(size: '1064x600')
         media_id = id
         {
           id: media_id,

data/lib/faker/default/types.rb

@@ -18,11 +18,9 @@ module Faker
       # @faker.version 1.8.6
       def rb_string(words: 1)
         resolved_num = resolve(words)
-        word_list =
-          translate('faker.lorem.words')
-
+        word_list = translate('faker.lorem.words')
         word_list *= ((resolved_num / word_list.length) + 1)
-        shuffle(word_list)[0, resolved_num].join(' ')
+        sample(word_list, resolved_num).join(' ')
       end
 
       ##
@@ -97,12 +95,13 @@ module Faker
       # @example
       #   Faker::Types.rb_array #=> ["a"]
       #   Faker::Types.rb_array(len: 4) #=> ["a", 1, 2, "bob"]
+      #   Faker::Types.rb_array(len: 2, type: -> { Faker::Types.rb_string }) #=> ["cat", "foo"]
       #
       # @faker.version 1.8.6
-      def rb_array(len: 1)
+      def rb_array(len: 1, type: -> { random_type })
         [].tap do |ar|
           len.times do
-            ar.push random_type
+            ar.push type.is_a?(Proc) ? type.call : type
           end
         end
       end