faker 2.2.0 → 3.2.2

data/lib/faker/default/code.rb

@@ -4,73 +4,149 @@ module Faker
   class Code < Base
     flexible :code
     class << self
-      # Generates a 10 digit NPI (National Provider Identifier
-      # issued to health care providers in the United States)
+      ##
+      # Produces a random NPI (National Provider Identifier) code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.npi #=> "9804062802"
+      #
+      # @faker.version 1.9.4
       def npi
         rand(10**10).to_s.rjust(10, '0')
       end
 
-      # By default generates 10 sign isbn code in format 123456789-X
-      # You can pass 13 to generate new 13 sign code
-      def isbn(legacy_base = NOT_GIVEN, base: 10)
-        if legacy_base != NOT_GIVEN
-          warn_with_uplevel 'Passing `base` with the 1st argument of `Code.isbn` is deprecated. Use keyword argument like `Code.isbn(base: ...)` instead.', uplevel: 1
-          base = legacy_base
+      ##
+      # 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(base: 10)
+        case base
+        when 10 then generate_base10_isbn
+        when 13 then generate_base13_isbn
+        else raise ArgumentError, 'base must be 10 or 13'
         end
-
-        base == 13 ? generate_base13_isbn : generate_base10_isbn
       end
 
-      # By default generates 13 sign ean code in format 1234567890123
-      # You can pass 8 to generate ean8 code
-      def ean(legacy_base = NOT_GIVEN, base: 13)
-        if legacy_base != NOT_GIVEN
-          warn_with_uplevel 'Passing `base` with the 1st argument of `Code.ean` is deprecated. Use keyword argument like `Code.ean(base: ...)` instead.', uplevel: 1
-          base = legacy_base
+      ##
+      # 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(base: 13)
+        case base
+        when 8 then generate_base8_ean
+        when 13 then generate_base13_ean
+        else raise ArgumentError, 'base must be 8 or 13'
         end
-
-        base == 8 ? generate_base8_ean : generate_base13_ean
       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.
-      def nric(legacy_min_age = NOT_GIVEN, legacy_max_age = NOT_GIVEN, min_age: 18, max_age: 65)
-        if legacy_min_age != NOT_GIVEN
-          warn_with_uplevel 'Passing `min_age` with the 1st argument of `Code.nric` is deprecated. Use keyword argument like `Code.nric(min_age: ...)` instead.', uplevel: 1
-          min_age = legacy_min_age
-        end
-        if legacy_max_age != NOT_GIVEN
-          warn_with_uplevel 'Passing `max_age` with the 2nd argument of `Code.nric` is deprecated. Use keyword argument like `Code.nric(max_age: ...)` instead.', uplevel: 1
-          max_age = legacy_max_age
-        end
-
+      #
+      # @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(min_age: 18, max_age: 65)
         birthyear = Date.birthday(min_age: min_age, max_age: max_age).year
-        prefix = birthyear < 2000 ? 'S' : 'T'
-        values = birthyear.to_s[-2..-1]
-        values << regexify(/\d{5}/)
-        check_alpha = generate_nric_check_alphabet(values, prefix)
-        "#{prefix}#{values}#{check_alpha}"
+
+        generate(:string) do |g|
+          g.computed(name: :prefix) do
+            if birthyear < 2000
+              'S'
+            else
+              'T'
+            end
+          end
+          g.computed(name: :yy) do
+            birthyear.to_s[-2..]
+          end
+          g.int(name: :values, length: 5)
+          g.computed(name: :check, deps: %i[prefix yy values]) do |prefix, yy, values|
+            generate_nric_check_alphabet("#{yy}#{values}", prefix)
+          end
+        end
       end
 
-      # Generate GSM modem, device or mobile phone 15 digit IMEI number.
+      ##
+      # 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 list taken from
-      # https://archive.org/details/asin_listing
+      ##
+      # 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
 
-      # Generates Social Insurance Number issued in Canada
-      # https://en.wikipedia.org/wiki/Social_Insurance_Number
+      ##
+      # 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
@@ -83,7 +159,7 @@ module Faker
         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
+        check_digit = generate_sin_check_digit("#{registry}#{partial}0").to_s
 
         registry + partial + check_digit
       end
@@ -96,8 +172,6 @@ module Faker
       def generate_imei
         str = Array.new(15, 0)
         sum = 0
-        t = 0
-        len_offset = 0
         len = 15
 
         # Fill in the first two values of the string based with the specified prefix.
@@ -131,50 +205,80 @@ module Faker
         str[len - 1] = (10 - (sum % 10)) % 10
 
         # Output the IMEI value.
-        str.join('')
+        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}"
+        generate(:string) do |g|
+          g.int(name: :values, length: 9)
+          g.lit('-')
+          g.computed(name: :checksum, deps: [:values]) do |values|
+            remainder = sum(values.to_s) { |value, offset| (offset + 1) * value.to_i } % 11
+            if remainder == 10
+              'X'
+            else
+              remainder.to_s
+            end
+          end
+        end
       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)}"
+        generate(:string) do |g|
+          g.int(name: :values, length: 12)
+          g.lit('-')
+          g.computed(name: :checksum, deps: [:values]) do |values|
+            remainder = sum(values.to_s) { |value, offset| offset.even? ? value.to_i : value.to_i * 3 } % 10
+            (10 - remainder) % 10
+          end
+        end
       end
 
       def sum(values)
-        values.split(//).each_with_index.inject(0) do |sum, (value, index)|
+        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.split(//).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
+        generate(:string) do |g|
+          g.int(name: :values, length: 7)
+          g.computed(name: :checksum, deps: [:values]) do |values|
+            check_digit = 10 - values.to_s.chars.each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT8[i] } % 10
+            if check_digit == 10
+              0
+            else
+              check_digit
+            end
+          end
+        end
       end
 
       def generate_base13_ean
-        values = regexify(/\d{12}/)
-        check_digit = 10 - values.split(//).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
+        generate(:string) do |g|
+          g.int(name: :values, length: 12)
+          g.computed(name: :checksum, deps: [:values]) do |values|
+            check_digit = 10 - values.to_s.chars.each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT13[i] } % 10
+            if check_digit == 10
+              0
+            else
+              check_digit
+            end
+          end
+        end
       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').split(//).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')
+        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.split(//).zip(weight).collect { |a, b| a.to_i * b.to_i }.inject(:+)
+        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

data/lib/faker/default/coffee.rb

@@ -5,24 +5,69 @@ module Faker
     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

data/lib/faker/default/coin.rb

@@ -3,10 +3,28 @@
 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

data/lib/faker/default/color.rb

@@ -3,30 +3,148 @@
 module Faker
   class Color < Base
     class << self
-      def hex_color
-        format('#%06x', (rand * 0xffffff))
+      LIGHTNESS_LOOKUP = {
+        light: 0.8,
+        dark: 0.2
+      }.freeze
+      ##
+      # Produces a hex color code.
+      # Clients are able to specify the hue, saturation, or lightness of the required color.
+      # Alternatively a client can simply specify that they need a light or dark color.
+      #
+      # @param args [Hash, Symbol] Allows the client to specify what color should be return
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Color.hex_color #=> "#31a785"
+      # @example
+      #   Faker::Color.hex_color(hue: 118, saturation: 1, lightness: 0.53) #=> "#048700"
+      # @example
+      #   Faker::Color.hex_color(:light) #=> "#FFEE99"
+      # @example
+      #   Faker::Color.hex_color(:dark) #=> "#665500"
+      #
+      # @faker.version next
+      def hex_color(args = nil)
+        hsl_hash = {}
+        hsl_hash = { lightness: LIGHTNESS_LOOKUP[args] } if %i[dark light].include?(args)
+        hsl_hash = args if args.is_a?(Hash)
+        hsl_to_hex(hsl_color(**hsl_hash))
       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
 
-      # returns [hue, saturation, lightness]
-      def hsl_color
-        [sample((0..360).to_a), rand.round(2), rand.round(2)]
+      ##
+      # Produces an array of floats representing an HSL color.
+      # The array is in the form of `[hue, saturation, lightness]`.
+      #
+      # @param hue [FLoat] Optional value to use for hue
+      # @param saturation [Float] Optional value to use for saturation
+      # @param lightness [Float] Optional value to use for lightness
+      # @return [Array(Float, Float, Float)]
+      #
+      # @example
+      #   Faker::Color.hsl_color #=> [69.87, 0.66, 0.3]
+      # @example
+      #   Faker::Color.hsl_color(hue: 70, saturation: 0.5, lightness: 0.8) #=> [70, 0.5, 0.8]
+      # @example
+      #   Faker::Color.hsl_color(hue: 70) #=> [70, 0.66, 0.6]
+      # @example
+      #   Faker::Color.hsl_color(saturation: 0.2) #=> [54, 0.2, 0.3]
+      # @example
+      #   Faker::Color.hsl_color(lightness: 0.6) #=> [69.87, 0.66, 0.6]
+      #
+      # @faker.version next
+      def hsl_color(hue: nil, saturation: nil, lightness: nil)
+        valid_hue = hue || sample((0..360).to_a)
+        valid_saturation = saturation&.clamp(0, 1) || rand.round(2)
+        valid_lightness = lightness&.clamp(0, 1) || rand.round(2)
+        [valid_hue, valid_saturation, valid_lightness]
       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
+
+      private
+
+      ##
+      # Produces a hex code representation of an HSL color
+      #
+      # @param a_hsl_color [Array(Float, Float, Float)] The array that represents the HSL color
+      #
+      # @return [String]
+      #
+      # @example
+      #   hsl_to_hex([50, 100,80]) #=> #FFEE99
+      #
+      # @see https://en.wikipedia.org/wiki/HSL_and_HSV#HSL_to_RGB
+      # @see https://github.com/jpmckinney/color-generator/blob/master/lib/color-generator.rb
+      #
+      def hsl_to_hex(a_hsl_color)
+        h, s, l = a_hsl_color
+        c = (1 - (2 * l - 1).abs) * s
+        h_prime = h / 60
+        x = c * (1 - (h_prime % 2 - 1).abs)
+        m = l - 0.5 * c
+
+        rgb = case h_prime.to_i
+              when 0 # 0 <= H' < 1
+                [c, x, 0]
+              when 1 # 1 <= H' < 2
+                [x, c, 0]
+              when 2 # 2 <= H' < 3
+                [0, c, x]
+              when 3 # 3 <= H' < 4
+                [0, x, c]
+              when 4 # 4 <= H' < 5
+                [x, 0, c]
+              else # 5 <= H' < 6
+                [c, 0, x]
+              end.map { |value| ((value + m) * 255).round }
+
+        format('#%02x%02x%02x', rgb[0], rgb[1], rgb[2])
+      end
     end
   end
 end