faker 2.11.0 → 3.2.0

data/lib/faker/default/name.rb

@@ -5,14 +5,41 @@ module Faker
     flexible :name
 
     class << self
+      ##
+      # Produces a random name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Name.name #=> "Tyshawn Johns Sr."
+      #
+      # @faker.version 0.9.0
       def name
         parse('name.name')
       end
 
+      ##
+      # Produces a random name with middle name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Name.name_with_middle #=> "Aditya Elton Douglas"
+      #
+      # @faker.version 1.6.4
       def name_with_middle
         parse('name.name_with_middle')
       end
 
+      ##
+      # Produces a random first name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Name.first_name #=> "Kaci"
+      #
+      # @faker.version 0.9.0
       def first_name
         if parse('name.first_name').empty?
           fetch('name.first_name')
@@ -21,36 +48,103 @@ module Faker
         end
       end
 
+      ##
+      # Produces a random male first name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Name.male_first_name #=> "Edward"
+      #
+      # @faker.version 1.9.1
       def male_first_name
         fetch('name.male_first_name')
       end
       alias first_name_men male_first_name
       alias masculine_name male_first_name
 
+      ##
+      # Produces a random female first name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Name.female_first_name #=> "Natasha"
+      #
+      # @faker.version 1.9.1
       def female_first_name
         fetch('name.female_first_name')
       end
       alias first_name_women female_first_name
       alias feminine_name female_first_name
 
+      ##
+      # Produces a random gender neutral first name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Name.neutral_first_name #=> "Casey"
+      #
+      # @faker.version 2.13.0
+      def neutral_first_name
+        fetch('name.neutral_first_name')
+      end
+      alias first_name_neutral neutral_first_name
+      alias gender_neutral_first_name neutral_first_name
+
+      ##
+      # Produces a random last name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Name.last_name #=> "Ernser"
+      #
+      # @faker.version 0.9.0
       def last_name
         parse('name.last_name')
       end
       alias middle_name last_name
 
+      ##
+      # Produces a random name prefix.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Name.prefix #=> "Mr."
+      #
+      # @faker.version 0.9.0
       def prefix
         fetch('name.prefix')
       end
 
+      ##
+      # Produces a random name suffix.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Name.suffix #=> "IV"
+      #
+      # @faker.version 0.9.0
       def suffix
         fetch('name.suffix')
       end
 
-      def initials(legacy_number = NOT_GIVEN, number: 3)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :number if legacy_number != NOT_GIVEN
-        end
-
+      ##
+      # Produces random initials.
+      #
+      # @param number [Integer] Number of digits that the generated initials should have.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Name.initials            #=> "NJM"
+      #   Faker::Name.initials(number: 2) #=> "NM"
+      #
+      # @faker.version 1.8.5
+      def initials(number: 3)
         (0...number).map { rand(65..90).chr }.join
       end
     end

data/lib/faker/default/nation.rb

@@ -17,8 +17,6 @@ module Faker
         fetch('nation.nationality')
       end
 
-      # rubocop:disable Style/AsciiComments
-
       ##
       # Produces a random national flag emoji.
       #
@@ -31,7 +29,6 @@ module Faker
       def flag
         sample(translate('faker.nation.flag')).pack('C*').force_encoding('utf-8')
       end
-      # rubocop:enable Style/AsciiComments
 
       ##
       # Produces a random national language.

data/lib/faker/default/nhs.rb

@@ -3,6 +3,15 @@
 module Faker
   class NationalHealthService < Base
     class << self
+      ##
+      # Produces a random British NHS number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::NationalHealthService.british_number #=> "403 958 5577"
+      #
+      # @faker.version 1.9.2
       def british_number
         base_number = rand(400_000_001...499_999_999)
         # If the check digit is equivalent to 10, the number is invalid.
@@ -12,14 +21,20 @@ module Faker
                                                            .chars
                                                            .insert(3, ' ')
                                                            .insert(7, ' ')
-                                                           .join('')
+                                                           .join
       end
 
-      def check_digit(legacy_number = NOT_GIVEN, number: 0)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :number if legacy_number != NOT_GIVEN
-        end
-
+      ##
+      # Produces a random British NHS number's check digit.
+      #
+      # @param number [Integer] Specifies the NHS number the check digit belongs to.
+      # @return [Integer]
+      #
+      # @example
+      #   Faker::NationalHealthService.check_digit(number: 400_012_114) #=> 6
+      #
+      # @faker.version 1.9.2
+      def check_digit(number: 0)
         sum = 0
         number.to_s.chars.each_with_index do |digit, idx|
           position = idx + 1

data/lib/faker/default/number.rb

@@ -13,11 +13,7 @@ module Faker
       #   Faker::Number.number(digits: 10) #=> 1968353479
       #
       # @faker.version 1.0.0
-      def number(legacy_digits = NOT_GIVEN, digits: 10)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :digits if legacy_digits != NOT_GIVEN
-        end
-
+      def number(digits: 10)
         return if digits < 1
         return rand(0..9).round if digits == 1
 
@@ -35,12 +31,8 @@ module Faker
       #   Faker::Number.leading_zero_number(digits: 10) #=> "0669336915"
       #
       # @faker.version 1.0.0
-      def leading_zero_number(legacy_digits = NOT_GIVEN, digits: 10)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :digits if legacy_digits != NOT_GIVEN
-        end
-
-        '0' + (2..digits).collect { digit }.join
+      def leading_zero_number(digits: 10)
+        "0#{(2..digits).collect { digit }.join}"
       end
 
       ##
@@ -53,11 +45,7 @@ module Faker
       #   Faker::Number.decimal_part(digits: 2) #=> "09"
       #
       # @faker.version 1.0.0
-      def decimal_part(legacy_digits = NOT_GIVEN, digits: 10)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :digits if legacy_digits != NOT_GIVEN
-        end
-
+      def decimal_part(digits: 10)
         num = ''
         if digits > 1
           num = non_zero_digit
@@ -78,20 +66,13 @@ module Faker
       #   Faker::Number.decimal(l_digits: 3, r_digits: 3) #=> 181.843
       #
       # @faker.version 1.0.0
-      def decimal(legacy_l_digits = NOT_GIVEN, legacy_r_digits = NOT_GIVEN, l_digits: 5, r_digits: 2)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :l_digits if legacy_l_digits != NOT_GIVEN
-          keywords << :r_digits if legacy_r_digits != NOT_GIVEN
-        end
-
+      def decimal(l_digits: 5, r_digits: 2)
         l_d = number(digits: l_digits)
-        r_d = if r_digits == 1
-                generate(r_digits)
-              else
-                # Ensure the last digit is not zero
-                # so it does not get truncated on converting to float
-                generate(r_digits - 1).join + non_zero_digit.to_s
-              end
+
+        # Ensure the last digit is not zero
+        # so it does not get truncated on converting to float
+        r_d = generate(r_digits - 1).join + non_zero_digit.to_s
+
         "#{l_d}.#{r_d}".to_f
       end
 
@@ -131,33 +112,39 @@ module Faker
       #   Faker::Number.hexadecimal(digits: 3) #=> "e74"
       #
       # @faker.version 1.0.0
-      def hexadecimal(legacy_digits = NOT_GIVEN, digits: 6)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :digits if legacy_digits != NOT_GIVEN
-        end
-
+      def hexadecimal(digits: 6)
         hex = ''
         digits.times { hex += rand(15).to_s(16) }
         hex
       end
 
+      # Produces a number in binary format.
+      #
+      # @param digits [Integer] Number of digits to generate the binary as string
+      # @return [String]
+      #
+      # @example
+      #   Faker::Number.binary(digits: 4) #=> "1001"
+      #
+      # @faker.version next
+      def binary(digits: 4)
+        bin = ''
+        digits.times { bin += rand(2).to_s(2) }
+        bin
+      end
+
       ##
       # Produces a float given a mean and standard deviation.
       #
       # @param mean [Integer]
-      # @param standard_deviation [Integer, Float]
+      # @param standard_deviation [Numeric]
       # @return [Float]
       #
       # @example
       #   Faker::Number.normal(mean: 50, standard_deviation: 3.5) #=> 47.14669604069156
       #
       # @faker.version 1.0.0
-      def normal(legacy_mean = NOT_GIVEN, legacy_standard_deviation = NOT_GIVEN, mean: 1, standard_deviation: 1)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :mean if legacy_mean != NOT_GIVEN
-          keywords << :standard_deviation if legacy_standard_deviation != NOT_GIVEN
-        end
-
+      def normal(mean: 1, standard_deviation: 1)
         theta = 2 * Math::PI * rand
         rho = Math.sqrt(-2 * Math.log(1 - rand))
         scale = standard_deviation * rho
@@ -167,20 +154,16 @@ module Faker
       ##
       # Produces a number between two provided values. Boundaries are inclusive.
       #
-      # @param from [Integer] The lowest number to include.
-      # @param to [Integer] The highest number to include.
-      # @return [Integer]
+      # @param from [Numeric] The lowest number to include.
+      # @param to [Numeric] The highest number to include.
+      # @return [Numeric]
       #
       # @example
       #   Faker::Number.between(from: 1, to: 10) #=> 7
+      #   Faker::Number.between(from: 0.0, to: 1.0) #=> 0.7844640543957383
       #
       # @faker.version 1.0.0
-      def between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 1.00, to: 5000.00)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :from if legacy_from != NOT_GIVEN
-          keywords << :to if legacy_to != NOT_GIVEN
-        end
-
+      def between(from: 1.00, to: 5000.00)
         Faker::Base.rand_in_range(from, to)
       end
 
@@ -188,17 +171,14 @@ module Faker
       # Produces a number within two provided values. Boundaries are inclusive or exclusive depending on the range passed.
       #
       # @param range [Range] The range from which to generate a number.
-      # @return [Integer]
+      # @return [Numeric]
       #
       # @example
       #   Faker::Number.within(range: 1..10) #=> 7
+      #   Faker::Number.within(range: 0.0..1.0) #=> 0.7844640543957383
       #
       # @faker.version 1.0.0
-      def within(legacy_range = NOT_GIVEN, range: 1.00..5000.00)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :range if legacy_range != NOT_GIVEN
-        end
-
+      def within(range: 1.00..5000.00)
         between(from: range.min, to: range.max)
       end
 
@@ -213,12 +193,7 @@ module Faker
       #   Faker::Number.positive #=> 235.59238499107653
       #
       # @faker.version 1.0.0
-      def positive(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 1.00, to: 5000.00)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :from if legacy_from != NOT_GIVEN
-          keywords << :to if legacy_to != NOT_GIVEN
-        end
-
+      def positive(from: 1.00, to: 5000.00)
         random_number = between(from: from, to: to)
 
         greater_than_zero(random_number)
@@ -235,12 +210,7 @@ module Faker
       #   Faker::Number.negative #=> -4480.042585669558
       #
       # @faker.version 1.0.0
-      def negative(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: -5000.00, to: -1.00)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :from if legacy_from != NOT_GIVEN
-          keywords << :to if legacy_to != NOT_GIVEN
-        end
-
+      def negative(from: -5000.00, to: -1.00)
         random_number = between(from: from, to: to)
 
         less_than_zero(random_number)

data/lib/faker/default/omniauth.rb

@@ -9,21 +9,25 @@ module Faker
                 :email
 
     def initialize(name: nil, email: nil)
+      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
 
     class << self
-      # rubocop:disable Metrics/ParameterLists
-      def google(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 9).to_s)
-        # rubocop:enable Metrics/ParameterLists
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :name if legacy_name != NOT_GIVEN
-          keywords << :email if legacy_email != NOT_GIVEN
-          keywords << :uid if legacy_uid != NOT_GIVEN
-        end
-
+      ##
+      # Generate a mock Omniauth response from Google.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-google.
+      #
+      # @faker.version 1.8.0
+      def google(name: nil, email: nil, uid: Number.number(digits: 9).to_s)
         auth = Omniauth.new(name: name, email: email)
         {
           provider: 'google_oauth2',
@@ -53,7 +57,7 @@ module Faker
               picture: image,
               gender: gender,
               birthday: Date.backward(days: 36_400).strftime('%Y-%m-%d'),
-              local: 'en',
+              locale: 'en',
               hd: "#{Company.name.downcase}.com"
             },
             id_info: {
@@ -72,16 +76,18 @@ module Faker
         }
       end
 
-      # rubocop:disable Metrics/ParameterLists
-      def facebook(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_username = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, username: nil, uid: Number.number(digits: 7).to_s)
-        # rubocop:enable Metrics/ParameterLists
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :name if legacy_name != NOT_GIVEN
-          keywords << :email if legacy_email != NOT_GIVEN
-          keywords << :username if legacy_username != NOT_GIVEN
-          keywords << :uid if legacy_uid != NOT_GIVEN
-        end
-
+      ##
+      # Generate a mock Omniauth response from Facebook.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param username [String] A specific username to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-facebook.
+      #
+      # @faker.version 1.8.0
+      def facebook(name: nil, email: nil, username: nil, uid: Number.number(digits: 7).to_s)
         auth = Omniauth.new(name: name, email: email)
         username ||= "#{auth.first_name.downcase[0]}#{auth.last_name.downcase}"
         {
@@ -123,15 +129,17 @@ module Faker
         }
       end
 
-      # rubocop:disable Metrics/ParameterLists
-      def twitter(legacy_name = NOT_GIVEN, legacy_nickname = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, nickname: nil, uid: Number.number(digits: 6).to_s)
-        # rubocop:enable Metrics/ParameterLists
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :name if legacy_name != NOT_GIVEN
-          keywords << :nickname if legacy_nickname != NOT_GIVEN
-          keywords << :uid if legacy_uid != NOT_GIVEN
-        end
-
+      ##
+      # Generate a mock Omniauth response from Twitter.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param nickname [String] A specific nickname to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-twitter.
+      #
+      # @faker.version 1.8.0
+      def twitter(name: nil, nickname: nil, uid: Number.number(digits: 6).to_s)
         auth = Omniauth.new(name: name)
         nickname ||= auth.name.downcase.delete(' ')
         location = city_state
@@ -204,15 +212,17 @@ module Faker
         }
       end
 
-      # rubocop:disable Metrics/ParameterLists
-      def linkedin(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 6).to_s)
-        # rubocop:enable Metrics/ParameterLists
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :name if legacy_name != NOT_GIVEN
-          keywords << :email if legacy_email != NOT_GIVEN
-          keywords << :uid if legacy_uid != NOT_GIVEN
-        end
-
+      ##
+      # Generate a mock Omniauth response from LinkedIn.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-linkedin.
+      #
+      # @faker.version 1.8.0
+      def linkedin(name: nil, email: nil, uid: Number.number(digits: 6).to_s)
         auth = Omniauth.new(name: name, email: email)
         first_name = auth.first_name.downcase
         last_name = auth.last_name.downcase
@@ -275,15 +285,17 @@ module Faker
         }
       end
 
-      # rubocop:disable Metrics/ParameterLists
-      def github(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 8).to_s)
-        # rubocop:enable Metrics/ParameterLists
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :name if legacy_name != NOT_GIVEN
-          keywords << :email if legacy_email != NOT_GIVEN
-          keywords << :uid if legacy_uid != NOT_GIVEN
-        end
-
+      ##
+      # Generate a mock Omniauth response from Github.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-github.
+      #
+      # @faker.version 1.8.0
+      def github(name: nil, email: nil, uid: Number.number(digits: 8).to_s)
         auth = Omniauth.new(name: name, email: email)
         login = auth.name.downcase.tr(' ', '-')
         html_url = "https://github.com/#{login}"
@@ -342,13 +354,15 @@ module Faker
       end
 
       ##
-      # Generate a mock Omniauth response from Apple
+      # Generate a mock Omniauth response from Apple.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
       #
-      # @param name [String] A specific name to return in the response
-      # @param email [String] A specific email to return in the response
-      # @param uid [String] A specific UID to return in the response
+      # @return [Hash] An auth hash in the format provided by omniauth-apple.
       #
-      # @return [Hash] An auth hash in the format provided by omniauth-apple
+      # @faker.version 2.3.0
       def apple(name: nil, email: nil, uid: nil)
         uid ||= "#{Number.number(digits: 6)}.#{Number.hexadecimal(digits: 32)}.#{Number.number(digits: 4)}"
         auth = Omniauth.new(name: name, email: email)
@@ -383,6 +397,50 @@ module Faker
         }
       end
 
+      ##
+      # Generate a mock Omniauth response from Auth0.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-auth0.
+      #
+      # @faker.version next
+      def auth0(name: nil, email: nil, uid: nil)
+        uid ||= "auth0|#{Number.hexadecimal(digits: 24)}"
+        auth = Omniauth.new(name: name, email: email)
+        {
+          provider: 'auth0',
+          uid: uid,
+          info: {
+            name: uid,
+            nickname: auth.name,
+            email: auth.email,
+            image: image
+          },
+          credentials: {
+            expires_at: Time.forward.to_i,
+            expires: true,
+            token_type: 'Bearer',
+            id_token: Crypto.sha256,
+            token: Crypto.md5,
+            refresh_token: Crypto.md5
+          },
+          extra: {
+            raw_info: {
+              email: auth.email,
+              email_verified: true,
+              iss: 'https://auth0.com/',
+              sub: uid,
+              aud: 'Auth012345',
+              iat: Time.forward.to_i,
+              exp: Time.forward.to_i
+            }
+          }
+        }
+      end
+
       private
 
       def gender