faker 2.6.0

data/lib/faker/default/marketing.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Faker
+  class Marketing < Base
+    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
+    end
+  end
+end

data/lib/faker/default/measurement.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Faker
+  class Measurement < Base
+    class << self
+      ALL = 'all'
+      NONE = 'none'
+
+      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(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(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(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(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(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(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(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
+
+      private
+
+      def check_for_plural(text, number)
+        if number && number != 1
+          make_plural(text)
+        else
+          text
+        end
+      end
+
+      def define_measurement_locale(amount, locale)
+        ensure_valid_amount(amount)
+        if amount == ALL
+          make_plural(fetch("measurement.#{locale}"))
+        elsif amount == NONE
+          fetch("measurement.#{locale}")
+        else
+          locale = check_for_plural(fetch("measurement.#{locale}"), amount)
+
+          "#{amount} #{locale}"
+        end
+      end
+
+      def ensure_valid_amount(amount)
+        raise ArgumentError, 'invalid amount' unless amount == NONE || amount == ALL || amount.is_a?(Integer) || amount.is_a?(Float)
+      end
+
+      def make_plural(text)
+        case text
+        when 'foot'
+          'feet'
+        when 'inch'
+          'inches'
+        when 'fluid ounce'
+          'fluid ounces'
+        when 'metric ton'
+          'metric tons'
+        else
+          "#{text}s"
+        end
+      end
+    end
+  end
+end

data/lib/faker/default/military.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+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
+    end
+  end
+end

data/lib/faker/default/name.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Faker
+  class Name < Base
+    flexible :name
+
+    class << self
+      def name
+        parse('name.name')
+      end
+
+      def name_with_middle
+        parse('name.name_with_middle')
+      end
+
+      def first_name
+        if parse('name.first_name').empty?
+          fetch('name.first_name')
+        else
+          parse('name.first_name')
+        end
+      end
+
+      def male_first_name
+        fetch('name.male_first_name')
+      end
+      alias first_name_men male_first_name
+      alias masculine_name male_first_name
+
+      def female_first_name
+        fetch('name.female_first_name')
+      end
+      alias first_name_women female_first_name
+      alias feminine_name female_first_name
+
+      def last_name
+        parse('name.last_name')
+      end
+      alias middle_name last_name
+
+      def prefix
+        fetch('name.prefix')
+      end
+
+      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
+
+        (0...number).map { rand(65..90).chr }.join
+      end
+    end
+  end
+end

data/lib/faker/default/nation.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Faker
+  class Nation < Base
+    flexible :nation
+    class << self
+      ##
+      # Produces a random nationality.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Nation.nationality #=> "Nepalese"
+      #
+      # @faker.version 1.9.0
+      def nationality
+        fetch('nation.nationality')
+      end
+
+      # rubocop:disable Style/AsciiComments
+
+      ##
+      # Produces a random national flag emoji.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Nation.flag #=> "🇫🇮"
+      #
+      # @faker.version 1.9.0
+      def flag
+        sample(translate('faker.nation.flag')).pack('C*').force_encoding('utf-8')
+      end
+      # rubocop:enable Style/AsciiComments
+
+      ##
+      # Produces a random national language.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Nation.language #=> "Nepali"
+      #
+      # @faker.version 1.9.0
+      def language
+        fetch('nation.language')
+      end
+
+      ##
+      # Produces a random capital city.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Nation.capital_city #=> "Kathmandu"
+      #
+      # @faker.version 1.9.0
+      def capital_city
+        fetch('nation.capital_city')
+      end
+
+      ##
+      # Produces a random national sport.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Nation.national_sport #=> "dandi biyo"
+      #
+      # @faker.version 1.9.0
+      def national_sport
+        fetch('team.sport')
+      end
+    end
+  end
+end

data/lib/faker/default/nato_phonetic_alphabet.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+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
+    end
+  end
+end

data/lib/faker/default/nhs.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Faker
+  class NationalHealthService < Base
+    class << self
+      def british_number
+        base_number = rand(400_000_001...499_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
+                                                           .insert(3, ' ')
+                                                           .insert(7, ' ')
+                                                           .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
+
+        sum = 0
+        number.to_s.chars.each_with_index do |digit, idx|
+          position = idx + 1
+          sum += (digit.to_i * (11 - position))
+        end
+        result = 11 - (sum % 11)
+
+        # A value of 11 is considered the same as 0
+        # See https://en.wikipedia.org/wiki/NHS_number
+        return 0 if result == 11
+
+        result
+      end
+    end
+  end
+end

data/lib/faker/default/number.rb

@@ -0,0 +1,274 @@
+# frozen_string_literal: true
+
+module Faker
+  class Number < Base
+    class << self
+      ##
+      # Produce a random number.
+      #
+      # @param digits [Integer] Number of digits that the generated number should have.
+      # @return [Integer]
+      #
+      # @example
+      #   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
+
+        return 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
+
+      ##
+      # Produce a random number with a leading zero.
+      #
+      # @param digits [Integer] Number of digits that the generated number should have.
+      # @return [String]
+      #
+      # @example
+      #   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
+      end
+
+      ##
+      # Produce a number with a number of digits, preserves leading zeroes.
+      #
+      # @param digits [Integer] Number of digits that the generated number should have.
+      # @return [String]
+      #
+      # @example
+      #   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
+
+        num = ''
+        if digits > 1
+          num = non_zero_digit
+          digits -= 1
+        end
+        leading_zero_number(digits: digits) + num.to_s
+      end
+
+      ##
+      # Produces a float.
+      #
+      # @param l_digits [Integer] Number of digits that the generated decimal should have to the left of the decimal point.
+      # @param r_digits [Integer] Number of digits that the generated decimal should have to the right of the decimal point.
+      # @return [Float]
+      #
+      # @example
+      #   Faker::Number.decimal(l_digits: 2) #=> 11.88
+      #   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
+
+        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
+        "#{l_d}.#{r_d}".to_f
+      end
+
+      ##
+      # Produces a non-zero single-digit integer.
+      #
+      # @return [Integer]
+      #
+      # @example
+      #   Faker::Number.non_zero_digit #=> 8
+      #
+      # @faker.version 1.0.0
+      def non_zero_digit
+        rand(1..9)
+      end
+
+      ##
+      # Produces a single-digit integer.
+      #
+      # @return [Integer]
+      #
+      # @example
+      #   Faker::Number.digit #=> 1
+      #
+      # @faker.version 1.0.0
+      def digit
+        rand(10)
+      end
+
+      ##
+      # Produces a number in hexadecimal format.
+      #
+      # @param digits [Integer] Number of digits in the he
+      # @return [String]
+      #
+      # @example
+      #   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
+
+        hex = ''
+        digits.times { hex += rand(15).to_s(16) }
+        hex
+      end
+
+      ##
+      # Produces a float given a mean and standard deviation.
+      #
+      # @param mean [Integer]
+      # @param standard_deviation [Integer, Float]
+      # @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
+
+        theta = 2 * Math::PI * rand
+        rho = Math.sqrt(-2 * Math.log(1 - rand))
+        scale = standard_deviation * rho
+        mean + scale * Math.cos(theta)
+      end
+
+      ##
+      # 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]
+      #
+      # @example
+      #   Faker::Number.between(from: 1, to: 10) #=> 7
+      #
+      # @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
+
+        Faker::Base.rand_in_range(from, to)
+      end
+
+      ##
+      # 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]
+      #
+      # @example
+      #   Faker::Number.within(range: 1..10) #=> 7
+      #
+      # @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
+
+        between(from: range.min, to: range.max)
+      end
+
+      ##
+      # Produces a positive float.
+      #
+      # @param from [Integer] The lower boundary.
+      # @param to [Integer] The higher boundary.
+      # @return [Float]
+      #
+      # @example
+      #   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
+
+        random_number = between(from: from, to: to)
+
+        greater_than_zero(random_number)
+      end
+
+      ##
+      # Produces a negative float.
+      #
+      # @param from [Integer] The lower boundary.
+      # @param to [Integer] The higher boundary.
+      # @return [Float]
+      #
+      # @example
+      #   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
+
+        random_number = between(from: from, to: to)
+
+        less_than_zero(random_number)
+      end
+
+      private
+
+      def generate(count)
+        return [] if count.zero?
+
+        Array.new(count) { digit }
+      end
+
+      def greater_than_zero(number)
+        should_be(number, :>)
+      end
+
+      def less_than_zero(number)
+        should_be(number, :<)
+      end
+
+      def should_be(number, method_to_compare)
+        if number.send(method_to_compare, 0)
+          number
+        else
+          number * -1
+        end
+      end
+    end
+  end
+end