faker 1.8.2 → 2.23.0

data/lib/faker/default/code.rb

@@ -0,0 +1,282 @@
+# frozen_string_literal: true
+
+module Faker
+  class Code < Base
+    flexible :code
+    class << self
+      ##
+      # Produces a random NPI (National Provider Identifer) code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.npi #=> "9804062802"
+      #
+      # @faker.version 1.9.4
+      def npi
+        rand(10**10).to_s.rjust(10, '0')
+      end
+
+      ##
+      # Produces a random ISBN (International Standard Book Number) code.
+      #
+      # @param base [Integer] the length of the code to generate (either 10 or 13)
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.isbn(base: 13) #=> "896579606969-8"
+      # @example
+      #   Faker::Code.isbn #=> "170366802-2"
+      #
+      # @faker.version 2.2.0
+      def isbn(legacy_base = NOT_GIVEN, base: 10)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :base if legacy_base != NOT_GIVEN
+        end
+
+        case base
+        when 10 then generate_base10_isbn
+        when 13 then generate_base13_isbn
+        else raise ArgumentError, 'base must be 10 or 13'
+        end
+      end
+
+      ##
+      # Produces a random EAN (European Article Number) code.
+      #
+      # @param base [Integer] the length of the code to generate (either 8 or 13)
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.ean(base: 8) #=> "36941070"
+      # @example
+      #   Faker::Code.ean #=> "9941880131907"
+      #
+      # @faker.version 2.2.0
+      def ean(legacy_base = NOT_GIVEN, base: 13)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :base if legacy_base != NOT_GIVEN
+        end
+
+        case base
+        when 8 then generate_base8_ean
+        when 13 then generate_base13_ean
+        else raise ArgumentError, 'base must be 8 or 13'
+        end
+      end
+
+      ##
+      # Produces a random RUT (Rol Unico Nacional) code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.rut #=> "91611842-2"
+      #
+      # @faker.version 1.9.4
+      def rut
+        value = Number.number(digits: 8).to_s
+        vd = rut_verificator_digit(value)
+        value << "-#{vd}"
+      end
+
+      ##
+      # Produces a random NRIC (National Registry Identity Card) code.
+      # By default generates a Singaporean NRIC ID for someone
+      # who is born between the age of 18 and 65.
+      #
+      # @param min_age [Integer] the min age of the person in years
+      # @param max_age [Integer] the max age of the person in years
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.nric(min_age: 25, max_age: 50) #=> "S9347283G"
+      # @example
+      #   Faker::Code.nric(max_age: 55) #=> "S7876903C"
+      # @example
+      #   Faker::Code.nric(min_age: 25) #=> "S6281697Z"
+      # @example
+      #   Faker::Code.nric #=> "S6372958B"
+      #
+      # @faker.version 2.2.0
+      def nric(legacy_min_age = NOT_GIVEN, legacy_max_age = NOT_GIVEN, min_age: 18, max_age: 65)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :min_age if legacy_min_age != NOT_GIVEN
+          keywords << :max_age if legacy_max_age != NOT_GIVEN
+        end
+
+        birthyear = Date.birthday(min_age: min_age, max_age: max_age).year
+        prefix = birthyear < 2000 ? 'S' : 'T'
+        values = birthyear.to_s[-2..]
+        values << regexify(/\d{5}/)
+        check_alpha = generate_nric_check_alphabet(values, prefix)
+        "#{prefix}#{values}#{check_alpha}"
+      end
+
+      ##
+      # Produces a random IMEI (International Mobile Equipment Number) code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.imei #=> "492033129092256"
+      #
+      # @faker.version 1.9.4
+      def imei
+        generate_imei
+      end
+
+      ##
+      # Retrieves a real Amazon ASIN code from https://archive.org/details/asin_listing
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.asin #=> "B000MZW1GE"
+      #
+      # @faker.version 1.9.4
+      def asin
+        fetch('code.asin')
+      end
+
+      ##
+      # Produces a random SIN (Social Insurance Number for Canada) code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.sin #=> "996586962"
+      #
+      # @faker.version 1.9.4
+      def sin
+        # 1   - province or temporary resident
+        # 2-8 - random numbers
+        # 9   - checksum
+
+        # 1st digit. 8,0 are not used
+        registry = Faker::Base.sample([1, 2, 3, 4, 5, 6, 7, 9]).to_s
+
+        # generate 2nd to 8th
+        partial = Array.new(7) { Faker::Config.random.rand(0..9) }.join
+
+        # Generate 9th digit
+        check_digit = generate_sin_check_digit("#{registry}#{partial}0").to_s
+
+        registry + partial + check_digit
+      end
+
+      private
+
+      # Reporting body identifier
+      RBI = %w[01 10 30 33 35 44 45 49 50 51 52 53 54 86 91 98 99].freeze
+
+      def generate_imei
+        str = Array.new(15, 0)
+        sum = 0
+        len = 15
+
+        # Fill in the first two values of the string based with the specified prefix.
+        # Reporting Body Identifier list: http://en.wikipedia.org/wiki/Reporting_Body_Identifier
+        arr = sample(RBI)
+        str[0] = arr[0].to_i
+        str[1] = arr[1].to_i
+        pos = 2
+
+        # Fill all the remaining numbers except for the last one with random values.
+        while pos < (len - 1)
+          str[pos] = rand(0..9)
+          pos += 1
+        end
+
+        # Calculate the Luhn checksum of the values thus far
+        len_offset = (len + 1) % 2
+        (0..(len - 1)).each do |position|
+          if (position + len_offset).odd?
+            t = str[position] * 2
+
+            t -= 9 if t > 9
+
+            sum += t
+          else
+            sum += str[position]
+          end
+        end
+
+        # Choose the last digit so that it causes the entire string to pass the checksum.
+        str[len - 1] = (10 - (sum % 10)) % 10
+
+        # Output the IMEI value.
+        str.join
+      end
+
+      def generate_base10_isbn
+        values = regexify(/\d{9}/)
+        remainder = sum(values) { |value, index| (index + 1) * value.to_i } % 11
+        values << "-#{remainder == 10 ? 'X' : remainder}"
+      end
+
+      def generate_base13_isbn
+        values = regexify(/\d{12}/)
+        remainder = sum(values) { |value, index| index.even? ? value.to_i : value.to_i * 3 } % 10
+        values << "-#{(10 - remainder) % 10}"
+      end
+
+      def sum(values)
+        values.chars.each_with_index.inject(0) do |sum, (value, index)|
+          sum + yield(value, index)
+        end
+      end
+
+      def generate_base8_ean
+        values = regexify(/\d{7}/)
+        check_digit = 10 - values.chars.each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT8[i] } % 10
+        values << (check_digit == 10 ? 0 : check_digit).to_s
+      end
+
+      def generate_base13_ean
+        values = regexify(/\d{12}/)
+        check_digit = 10 - values.chars.each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT13[i] } % 10
+        values << (check_digit == 10 ? 0 : check_digit).to_s
+      end
+
+      EAN_CHECK_DIGIT8 = [3, 1, 3, 1, 3, 1, 3].freeze
+      EAN_CHECK_DIGIT13 = [1, 3, 1, 3, 1, 3, 1, 3, 1, 3, 1, 3].freeze
+
+      def rut_verificator_digit(rut)
+        total = rut.to_s.rjust(8, '0').chars.zip(%w[3 2 7 6 5 4 3 2]).collect { |a, b| a.to_i * b.to_i }.inject(:+)
+        (11 - total % 11).to_s.gsub(/10/, 'k').gsub(/11/, '0')
+      end
+
+      def generate_nric_check_alphabet(values, prefix)
+        weight = %w[2 7 6 5 4 3 2]
+        total = values.chars.zip(weight).collect { |a, b| a.to_i * b.to_i }.inject(:+)
+        total += 4 if prefix == 'T'
+        %w[A B C D E F G H I Z J][10 - total % 11]
+      end
+
+      def generate_sin_check_digit(digits)
+        # Fast Luhn checksum code from luhn.js:
+        # https://gist.github.com/ShirtlessKirk/2134376
+
+        len = 9
+        mul = 0
+
+        luhn_arr = [
+          [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
+          [0, 2, 4, 6, 8, 1, 3, 5, 7, 9]
+        ]
+        sum = 0
+
+        while len.positive?
+          len -= 1
+          num = digits[len].to_i
+          sum += luhn_arr[mul][num]
+          mul ^= 1
+        end
+
+        checksum = sum % 10
+        checksum.zero? ? checksum : (10 - checksum)
+      end
+    end
+  end
+end

data/lib/faker/default/coffee.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Faker
+  class Coffee < Base
+    flexible :coffee
+
+    class << self
+      ##
+      # Produces a random blend name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coffee.blend_name #=> "Major Java"
+      #
+      # @faker.version 1.9.0
+      def blend_name
+        parse('coffee.blend_name')
+      end
+
+      ##
+      # Produces a random coffee origin place.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coffee.origin #=> "Oaxaca, Mexico"
+      #
+      # @faker.version 1.9.0
+      def origin
+        country = fetch('coffee.country')
+        region = fetch("coffee.regions.#{search_format(country)}")
+        "#{region}, #{country}"
+      end
+
+      ##
+      # Produces a random coffee variety.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coffee.variety #=> "Red Bourbon"
+      #
+      # @faker.version 1.9.0
+      def variety
+        fetch('coffee.variety')
+      end
+
+      ##
+      # Produces a string containing a random description of a coffee's taste.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coffee.notes #=> "dull, tea-like, cantaloupe, soy sauce, marshmallow"
+      #
+      # @faker.version 1.9.0
+      def notes
+        parse('coffee.notes')
+      end
+
+      ##
+      # Produces a random coffee taste intensity.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coffee.intensifier #=> "mild"
+      #
+      # @faker.version 1.9.0
+      def intensifier
+        fetch('coffee.intensifier')
+      end
+
+      private
+
+      def search_format(key)
+        key.split.length > 1 ? key.split.join('_').downcase : key.downcase
+      end
+    end
+  end
+end

data/lib/faker/default/coin.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Faker
+  class Coin < Base
+    class << self
+      ##
+      # Retrieves a random coin from any country.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coin.name #=> "Brazilian Real"
+      #
+      # @faker.version 1.9.2
+      def name
+        fetch('currency.name')
+      end
+
+      ##
+      # Retrieves a face to a flipped coin
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coin.flip #=> "Heads"
+      #
+      # @faker.version 1.9.2
+      def flip
+        fetch('coin.flip')
+      end
+    end
+  end
+end

data/lib/faker/default/color.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Faker
+  class Color < Base
+    class << self
+      ##
+      # Produces a hex color code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Color.hex_color #=> "#31a785"
+      #
+      # @faker.version 1.5.0
+      def hex_color
+        format('#%06x', (rand * 0xffffff))
+      end
+
+      ##
+      # Produces the name of a color.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Color.color_name #=> "yellow"
+      #
+      # @faker.version 1.6.2
+      def color_name
+        fetch('color.name')
+      end
+
+      # @private
+      def single_rgb_color
+        sample((0..255).to_a)
+      end
+
+      ##
+      # Produces an array of integers representing an RGB color.
+      #
+      # @return [Array(Integer, Integer, Integer)]
+      #
+      # @example
+      #   Faker::Color.rgb_color #=> [54, 233, 67]
+      #
+      # @faker.version 1.5.0
+      def rgb_color
+        Array.new(3) { single_rgb_color }
+      end
+
+      ##
+      # Produces an array of floats representing an HSL color.
+      # The array is in the form of `[hue, saturation, lightness]`.
+      #
+      # @return [Array(Float, Float, Float)]
+      #
+      # @example
+      #   Faker::Color.hsl_color #=> [69.87, 0.66, 0.3]
+      #
+      # @faker.version 1.5.0
+      def hsl_color
+        [sample((0..360).to_a), rand.round(2), rand.round(2)]
+      end
+
+      ##
+      # Produces an array of floats representing an HSLA color.
+      # The array is in the form of `[hue, saturation, lightness, alpha]`.
+      #
+      # @return [Array(Float, Float, Float, Float)]
+      #
+      # @example
+      #   Faker::Color.hsla_color #=> [154.77, 0.36, 0.9, 0.2]
+      #
+      # @faker.version 1.5.0
+      def hsla_color
+        hsl_color << rand.round(1)
+      end
+    end
+  end
+end

data/lib/faker/default/commerce.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Faker
+  class Commerce < Base
+    class << self
+      ##
+      # Produces a random color.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Commerce.color #=> "lavender"
+      #
+      # @faker.version 1.2.0
+      def color
+        fetch('color.name')
+      end
+
+      ##
+      # Produces a random promotion code.
+      #
+      # @param digits [Integer] Updates the number of numerical digits used to generate the promotion code.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Commerce.promotion_code #=> "AmazingDeal829102"
+      #   Faker::Commerce.promotion_code(digits: 2) #=> "AmazingPrice57"
+      #
+      # @faker.version 1.7.0
+      def promotion_code(legacy_digits = NOT_GIVEN, digits: 6)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :digits if legacy_digits != NOT_GIVEN
+        end
+
+        [
+          fetch('commerce.promotion_code.adjective'),
+          fetch('commerce.promotion_code.noun'),
+          Faker::Number.number(digits: digits)
+        ].join
+      end
+
+      ##
+      # Produces a random department.
+      #
+      # @param max [Integer] Updates the maximum number of names used to generate the department name.
+      # @param fixed_amount [Boolean] Fixes the amount of departments to use instead of using a range.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Commerce.department #=> "Grocery, Health & Beauty"
+      #   Faker::Commerce.department(max: 5) #=> "Grocery, Books, Health & Beauty"
+      #   Faker::Commerce.department(max: 2, fixed_amount: true) #=> "Books & Tools"
+      #
+      # @faker.version 1.2.0
+      def department(legacy_max = NOT_GIVEN, legacy_fixed_amount = NOT_GIVEN, max: 3, fixed_amount: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :max if legacy_max != NOT_GIVEN
+          keywords << :fixed_amount if legacy_fixed_amount != NOT_GIVEN
+        end
+
+        num = max if fixed_amount
+        num ||= 1 + rand(max)
+
+        categories = categories(num)
+
+        if categories.is_a?(Array)
+          if categories.length > 1
+            merge_categories(categories)
+          else
+            categories[0]
+          end
+        else
+          categories
+        end
+      end
+
+      ##
+      # Produces a random product name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Commerce.product_name #=> "Practical Granite Shirt"
+      #
+      # @faker.version 1.2.0
+      def product_name
+        "#{fetch('commerce.product_name.adjective')} #{fetch('commerce.product_name.material')} #{fetch('commerce.product_name.product')}"
+      end
+
+      ##
+      # Produces a random material.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Commerce.material #=> "Plastic"
+      #
+      # @faker.version 1.5.0
+      def material
+        fetch('commerce.product_name.material')
+      end
+
+      ##
+      # Produces a random product price.
+      #
+      # @param range [Range] A range to generate the random number within.
+      # @param as_string [Boolean] Changes the return value to [String].
+      # @return [Float]
+      #
+      # @example
+      #   Faker::Commerce.price #=> 44.6
+      #   Faker::Commerce.price(range: 0..10.0, as_string: true) #=> "2.18"
+      #
+      # @faker.version 1.2.0
+      def price(legacy_range = NOT_GIVEN, legacy_as_string = NOT_GIVEN, range: 0..100.0, as_string: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :range if legacy_range != NOT_GIVEN
+          keywords << :as_string if legacy_as_string != NOT_GIVEN
+        end
+
+        price = (rand(range) * 100).floor / 100.0
+        if as_string
+          price_parts = price.to_s.split('.')
+          price = "#{price_parts[0]}.#{price_parts[-1].ljust(2, '0')}"
+        end
+        price
+      end
+
+      ##
+      # Produces a randomized string of a brand name
+      # @example
+      #   Faker::Commerce.brand #=> 'Apple'
+      #
+      # @return [string]
+      #
+      # @faker.version next
+      #
+      ##
+      def brand
+        fetch('commerce.brand')
+      end
+
+      ##
+      # Produces a randomized string of a vendor name
+      # @example
+      #   Faker::Commerce.vendor #=> 'Dollar General'
+      #
+      # @return [string]
+      #
+      # @faker.version next
+      #
+      ##
+      def vendor
+        fetch('commerce.vendor')
+      end
+
+      private
+
+      def categories(num)
+        sample(fetch_all('commerce.department'), num)
+      end
+
+      def merge_categories(categories)
+        separator = fetch('separator')
+        comma_separated = categories.slice!(0...-1).join(', ')
+
+        [comma_separated, categories[0]].join(separator)
+      end
+    end
+  end
+end