faker 2.13.0 → 3.8.0

data/lib/faker/default/military.rb

@@ -55,6 +55,32 @@ module Faker
         fetch('military.air_force_rank')
       end
 
+      ##
+      # Produces a rank in the U.S. Space Force.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.space_force_rank #=> "Senior Enlisted Advisor of the Space Force"
+      #
+      # @faker.version next
+      def space_force_rank
+        fetch('military.space_force_rank')
+      end
+
+      ##
+      # Produces a rank in the U.S. Coast Guard
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.coast_guard_rank #=> "Master Chief Petty Officer of the Coast Guard"
+      #
+      # @faker.version next
+      def coast_guard_rank
+        fetch('military.coast_guard_rank')
+      end
+
       ##
       # Produces a U.S. Department of Defense Paygrade.
       #

data/lib/faker/default/mountain.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Faker
+  class Mountain < Base
+    class << self
+      ##
+      # Produces a name of a mountain
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Mountain.name #=> "Mount Everest"
+      #
+      #  @faker.version next
+      def name
+        fetch('mountain.name')
+      end
+
+      ##
+      # Produces a name of a range
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Mountain.range #=> "Dhaulagiri Himalaya"
+      #
+      # @faker.version next
+      def range
+        fetch('mountain.range')
+      end
+    end
+  end
+end

data/lib/faker/default/name.rb

@@ -144,11 +144,7 @@ module Faker
       #   Faker::Name.initials(number: 2) #=> "NM"
       #
       # @faker.version 1.8.5
-      def initials(legacy_number = NOT_GIVEN, number: 3)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :number if legacy_number != NOT_GIVEN
-        end
-
+      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 → 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('')
+                                                           .join
       end
 
+      private
+
       ##
       # Produces a random British NHS number's check digit.
       #
@@ -34,11 +38,7 @@ module Faker
       #   Faker::NationalHealthService.check_digit(number: 400_012_114) #=> 6
       #
       # @faker.version 1.9.2
-      def check_digit(legacy_number = NOT_GIVEN, number: 0)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :number if legacy_number != NOT_GIVEN
-        end
-
+      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,12 +66,7 @@ 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)
 
         # Ensure the last digit is not zero
@@ -129,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) }
+        digits.times { hex += rand(16).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
@@ -165,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
 
@@ -186,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
 
@@ -211,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)
@@ -233,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)