faker 2.1.2 → 2.4.0

data/lib/faker/default/lorem_pixel.rb

@@ -18,7 +18,16 @@ module Faker
                                 transport].freeze
 
       # rubocop:disable Metrics/ParameterLists
-      def image(size: '300x300', is_gray: false, category: nil, number: nil, text: nil, secure: true)
+      def image(legacy_size = NOT_GIVEN, legacy_is_gray = NOT_GIVEN, legacy_category = NOT_GIVEN, legacy_number = NOT_GIVEN, legacy_text = NOT_GIVEN, legacy_secure = NOT_GIVEN, size: '300x300', is_gray: false, category: nil, number: nil, text: nil, secure: true)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :size if legacy_size != NOT_GIVEN
+          keywords << :is_gray if legacy_is_gray != NOT_GIVEN
+          keywords << :category if legacy_category != NOT_GIVEN
+          keywords << :number if legacy_number != NOT_GIVEN
+          keywords << :text if legacy_text != NOT_GIVEN
+          keywords << :secure if legacy_secure != NOT_GIVEN
+        end
+
         raise ArgumentError, 'Size should be specified in format 300x300' unless size =~ /^[0-9]+x[0-9]+$/
         raise ArgumentError, "Supported categories are #{SUPPORTED_CATEGORIES.join(', ')}" unless category.nil? || SUPPORTED_CATEGORIES.include?(category)
         raise ArgumentError, 'Category required when number is passed' if !number.nil? && category.nil?

data/lib/faker/default/markdown.rb

@@ -59,7 +59,12 @@ module Faker
         send(method_list[rand(0..method_list.length - 1)])
       end
 
-      def sandwich(sentences: 3, repeat: 1)
+      def sandwich(legacy_sentences = NOT_GIVEN, legacy_repeat = NOT_GIVEN, sentences: 3, repeat: 1)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :sentences if legacy_sentences != NOT_GIVEN
+          keywords << :repeat if legacy_repeat != NOT_GIVEN
+        end
+
         text_block = []
         text_block << headers
         repeat.times do

data/lib/faker/default/marketing.rb

@@ -5,6 +5,15 @@ module Faker
     flexible :marketing
 
     class << self
+      ##
+      # Produces the name of a video game console or platform.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Marketing.buzzwords #=> "rubber meets the road"
+      #
+      # @faker.version 1.9.4
       def buzzwords
         fetch('marketing.buzzwords')
       end

data/lib/faker/default/measurement.rb

@@ -6,35 +6,67 @@ module Faker
       ALL = 'all'
       NONE = 'none'
 
-      def height(amount: rand(10))
+      def height(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
         define_measurement_locale(amount, 'height')
       end
 
-      def length(amount: rand(10))
+      def length(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
         define_measurement_locale(amount, 'length')
       end
 
-      def volume(amount: rand(10))
+      def volume(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
         define_measurement_locale(amount, 'volume')
       end
 
-      def weight(amount: rand(10))
+      def weight(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
         define_measurement_locale(amount, 'weight')
       end
 
-      def metric_height(amount: rand(10))
+      def metric_height(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
         define_measurement_locale(amount, 'metric_height')
       end
 
-      def metric_length(amount: rand(10))
+      def metric_length(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
         define_measurement_locale(amount, 'metric_length')
       end
 
-      def metric_volume(amount: rand(10))
+      def metric_volume(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
         define_measurement_locale(amount, 'metric_volume')
       end
 
-      def metric_weight(amount: rand(10))
+      def metric_weight(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
         define_measurement_locale(amount, 'metric_weight')
       end
 

data/lib/faker/default/military.rb

@@ -3,22 +3,67 @@
 module Faker
   class Military < Base
     class << self
+      ##
+      # Produces a rank in the U.S. Army.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.army_rank #=> "Staff Sergeant"
+      #
+      # @faker.version 1.9.0
       def army_rank
         fetch('military.army_rank')
       end
 
+      ##
+      # Produces a rank in the U.S. Marines.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.marines_rank #=> "Gunnery Sergeant"
+      #
+      # @faker.version 1.9.0
       def marines_rank
         fetch('military.marines_rank')
       end
 
+      ##
+      # Produces a rank in the U.S. Navy.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.navy_rank #=> "Seaman"
+      #
+      # @faker.version 1.9.0
       def navy_rank
         fetch('military.navy_rank')
       end
 
+      ##
+      # Produces a rank in the U.S. Air Force.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.air_force_rank #=> "Captain"
+      #
+      # @faker.version 1.9.0
       def air_force_rank
         fetch('military.air_force_rank')
       end
 
+      ##
+      # Produces a U.S. Department of Defense Paygrade.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.dod_paygrade #=> "E-6"
+      #
+      # @faker.version 1.9.0
       def dod_paygrade
         fetch('military.dod_paygrade')
       end

data/lib/faker/default/name.rb

@@ -46,7 +46,11 @@ module Faker
         fetch('name.suffix')
       end
 
-      def initials(number: 3)
+      def initials(legacy_number = NOT_GIVEN, number: 3)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :number if legacy_number != NOT_GIVEN
+        end
+
         (0...number).map { rand(65..90).chr }.join
       end
     end

data/lib/faker/default/nato_phonetic_alphabet.rb

@@ -3,6 +3,15 @@
 module Faker
   class NatoPhoneticAlphabet < Base
     class << self
+      ##
+      # Produces a code word from the NATO phonetic alphabet.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::NatoPhoneticAlphabet.code_word #=> "Hotel"
+      #
+      # @faker.version 1.9.0
       def code_word
         fetch('nato_phonetic_alphabet.code_word')
       end

data/lib/faker/default/nhs.rb

@@ -15,7 +15,11 @@ module Faker
                                                            .join('')
       end
 
-      def check_digit(number: 0)
+      def check_digit(legacy_number = NOT_GIVEN, number: 0)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :number if legacy_number != NOT_GIVEN
+        end
+
         sum = 0
         number.to_s.chars.each_with_index do |digit, idx|
           position = idx + 1

data/lib/faker/default/number.rb

@@ -3,19 +3,31 @@
 module Faker
   class Number < Base
     class << self
-      def number(digits: 10)
+      def number(legacy_digits = NOT_GIVEN, digits: 10)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :digits if legacy_digits != NOT_GIVEN
+        end
+
         return if digits < 1
-        return 0 if digits == 1
+        return rand(0..9).round if digits == 1
 
         # Ensure the first digit is not zero
         ([non_zero_digit] + generate(digits - 1)).join.to_i
       end
 
-      def leading_zero_number(digits: 10)
+      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
       end
 
-      def decimal_part(digits: 10)
+      def decimal_part(legacy_digits = NOT_GIVEN, digits: 10)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :digits if legacy_digits != NOT_GIVEN
+        end
+
         num = ''
         if digits > 1
           num = non_zero_digit
@@ -24,7 +36,12 @@ module Faker
         leading_zero_number(digits: digits) + num.to_s
       end
 
-      def decimal(l_digits: 5, r_digits: 2)
+      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
+
         l_d = number(digits: l_digits)
         r_d = if r_digits == 1
                 generate(r_digits)
@@ -44,34 +61,62 @@ module Faker
         rand(10)
       end
 
-      def hexadecimal(digits: 6)
+      def hexadecimal(legacy_digits = NOT_GIVEN, digits: 6)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :digits if legacy_digits != NOT_GIVEN
+        end
+
         hex = ''
         digits.times { hex += rand(15).to_s(16) }
         hex
       end
 
-      def normal(mean: 1, standard_deviation: 1)
+      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
+
         theta = 2 * Math::PI * rand
         rho = Math.sqrt(-2 * Math.log(1 - rand))
         scale = standard_deviation * rho
         mean + scale * Math.cos(theta)
       end
 
-      def between(from: 1.00, to: 5000.00)
+      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
+
         Faker::Base.rand_in_range(from, to)
       end
 
-      def within(range: 1.00..5000.00)
+      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
+
         between(from: range.min, to: range.max)
       end
 
-      def positive(from: 1.00, to: 5000.00)
+      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
+
         random_number = between(from: from, to: to)
 
         greater_than_zero(random_number)
       end
 
-      def negative(from: -5000.00, to: -1.00)
+      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
+
         random_number = between(from: from, to: to)
 
         less_than_zero(random_number)

data/lib/faker/default/omniauth.rb

@@ -15,7 +15,15 @@ module Faker
     end
 
     class << self
-      def google(name: nil, email: nil, uid: Number.number(digits: 9).to_s)
+      # 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
+
         auth = Omniauth.new(name: name, email: email)
         {
           provider: 'google_oauth2',
@@ -27,7 +35,7 @@ module Faker
             email: auth.email,
             image: image
           },
-          credentials:  {
+          credentials: {
             token: Crypto.md5,
             refresh_token: Crypto.md5,
             expires_at: Time.forward.to_i,
@@ -35,7 +43,7 @@ module Faker
           },
           extra: {
             raw_info: {
-              sub:  uid,
+              sub: uid,
               email: auth.email,
               email_verified: random_boolean.to_s,
               name: auth.name,
@@ -64,7 +72,16 @@ module Faker
         }
       end
 
-      def facebook(name: nil, email: nil, username: nil, uid: Number.number(digits: 7).to_s)
+      # 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
+
         auth = Omniauth.new(name: name, email: email)
         username ||= "#{auth.first_name.downcase[0]}#{auth.last_name.downcase}"
         {
@@ -106,7 +123,15 @@ module Faker
         }
       end
 
-      def twitter(name: nil, nickname: nil, uid: Number.number(digits: 6).to_s)
+      # 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
+
         auth = Omniauth.new(name: name)
         nickname ||= auth.name.downcase.delete(' ')
         location = city_state
@@ -179,7 +204,15 @@ module Faker
         }
       end
 
-      def linkedin(name: nil, email: nil, uid: Number.number(digits: 6).to_s)
+      # 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
+
         auth = Omniauth.new(name: name, email: email)
         first_name = auth.first_name.downcase
         last_name = auth.last_name.downcase
@@ -242,7 +275,15 @@ module Faker
         }
       end
 
-      def github(name: nil, email: nil, uid: Number.number(digits: 8).to_s)
+      # 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
+
         auth = Omniauth.new(name: name, email: email)
         login = auth.name.downcase.tr(' ', '-')
         html_url = "https://github.com/#{login}"
@@ -261,7 +302,7 @@ module Faker
           },
           credentials: {
             token: Crypto.md5,
-            expires:  false
+            expires: false
           },
           extra: {
             raw_info: {
@@ -281,7 +322,7 @@ module Faker
               events_url: "#{api_url}/events{/privacy}",
               received_events_url: "#{api_url}/received_events",
               type: 'User',
-              site_admin:  random_boolean,
+              site_admin: random_boolean,
               name: auth.name,
               company: nil,
               blog: nil,
@@ -300,6 +341,48 @@ module Faker
         }
       end
 
+      ##
+      # 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
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-apple
+      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)
+        {
+          provider: 'apple',
+          uid: uid,
+          info: {
+            sub: uid,
+            email: auth.email,
+            first_name: auth.first_name,
+            last_name: auth.last_name
+          },
+          credentials: {
+            token: Crypto.md5,
+            refresh_token: Crypto.md5,
+            expires_at: Time.forward.to_i,
+            expires: true
+          },
+          extra: {
+            raw_info: {
+              iss: 'https://appleid.apple.com',
+              aud: 'CLIENT_ID',
+              exp: Time.forward.to_i,
+              iat: Time.forward.to_i,
+              sub: uid,
+              at_hash: Crypto.md5,
+              auth_time: Time.forward.to_i,
+              email: auth.email,
+              email_verified: true
+            }
+          }
+        }
+      end
+
       private
 
       def gender