faker 2.11.0 → 2.13.0

data/lib/faker/default/blood.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Blood < Base
+    flexible :blood
+
+    class << self
+      ##
+      # Produces a random blood type.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Blood.type #=> "AB"
+      #
+      # @faker.version 2.13.0
+      def type
+        fetch('blood.type')
+      end
+
+      ##
+      # Produces a random blood RH-Factor.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Blood.rh_factor #=> "-"
+      #
+      # @faker.version 2.13.0
+      def rh_factor
+        fetch('blood.rh_factor')
+      end
+
+      ##
+      # Produces a random blood group name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Blood.group #=> "AB-"
+      #
+      # @faker.version 2.13.0
+      def group
+        parse('blood.group')
+      end
+    end
+  end
+end

data/lib/faker/default/business.rb

@@ -26,7 +26,7 @@ module Faker
       # @return [Date]
       #
       # @example
-      #   Faker::Business.credit_card_number #=> <Date: 2015-11-11 ((2457338j,0s,0n),+0s,2299161j)>
+      #   Faker::Business.credit_card_expiry_date #=> <Date: 2015-11-11 ((2457338j,0s,0n),+0s,2299161j)>
       #
       # @faker.version 1.2.0
       def credit_card_expiry_date

data/lib/faker/default/chile_rut.rb

@@ -5,7 +5,19 @@ module Faker
     class << self
       @last_rut = nil
 
-      # Fixed param added for testing a specific RUT and check digit combination.
+      ##
+      # Produces a random Chilean RUT (Rol Unico Tributario, ID with 8 digits).
+      #
+      # @param min_rut [Integer] Specifies the minimum value of the rut.
+      # @param fixed [Boolean] Determines if the rut is fixed (returns the min_rut value).
+      # @return [Number]
+      #
+      # @example
+      #   Faker::ChileRut.rut #=> 11235813
+      #   Faker::ChileRut.rut(min_rut: 20890156) #=> 31853211
+      #   Faker::ChileRut.rut(min_rut: 20890156, fixed: true) #=> 20890156
+      #
+      # @faker.version 1.9.2
       def rut(legacy_min_rut = NOT_GIVEN, legacy_fixed = NOT_GIVEN, min_rut: 1, fixed: false)
         warn_for_deprecated_arguments do |keywords|
           keywords << :min_rut if legacy_min_rut != NOT_GIVEN
@@ -15,6 +27,15 @@ module Faker
         @last_rut = fixed ? min_rut : rand_in_range(min_rut, 99_999_999)
       end
 
+      ##
+      # Produces a random Chilean digito verificador (check-digit).
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::ChileRut.dv #=> "k"
+      #
+      # @faker.version 1.9.2
       def dv
         split_reversed_rut = @last_rut.to_s.reverse.split('')
         seq = [2, 3, 4, 5, 6, 7]
@@ -34,11 +55,33 @@ module Faker
         end
       end
 
+      ##
+      # Produces a random Chilean digito verificador (check-digit).
       # Alias for english speaking devs.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::ChileRut.check_digit #=> "5"
+      #
+      # @faker.version 1.9.2
       def check_digit
         dv
       end
 
+      ##
+      # Produces a random Chilean RUT (Rol Unico Tributario, ID with 8 digits) with a dv (digito verificador, check-digit).
+      #
+      # @param min_rut [Integer] Specifies the minimum value of the rut.
+      # @param fixed [Boolean] Determines if the rut is fixed (returns the min_rut value).
+      # @return [String]
+      #
+      # @example
+      #   Faker::ChileRut.full_rut #=> "30686957-4"
+      #   Faker::ChileRut.full_rut(min_rut: 20890156) #=> "30686957-4"
+      #   Faker::ChileRut.full_rut(min_rut: 30686957, fixed: true) #=> "30686957-4"
+      #
+      # @faker.version 1.9.2
       def full_rut(legacy_min_rut = NOT_GIVEN, legacy_fixed = NOT_GIVEN, min_rut: 0, fixed: false)
         warn_for_deprecated_arguments do |keywords|
           keywords << :min_rut if legacy_min_rut != NOT_GIVEN

data/lib/faker/default/commerce.rb

@@ -3,10 +3,30 @@
 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
@@ -19,6 +39,19 @@ module Faker
         ].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
@@ -30,19 +63,55 @@ module Faker
 
         categories = categories(num)
 
-        return merge_categories(categories) if num > 1
-
-        categories[0]
+        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
@@ -60,13 +129,7 @@ module Faker
       private
 
       def categories(num)
-        categories = []
-        while categories.length < num
-          category = fetch('commerce.department')
-          categories << category unless categories.include?(category)
-        end
-
-        categories
+        sample(fetch_all('commerce.department'), num)
       end
 
       def merge_categories(categories)

data/lib/faker/default/company.rb

@@ -165,9 +165,7 @@ module Faker
       def spanish_organisation_number
         # Valid leading character: A, B, C, D, E, F, G, H, J, N, P, Q, R, S, U, V, W
         # 7 digit numbers
-        letters = %w[A B C D E F G H J N P Q R S U V W]
-        base = [sample(letters), format('%07d', rand(10**7))].join
-        base
+        [sample(self::ULetters), format('%07d', rand(10**7))].join
       end
 
       ##
@@ -399,6 +397,11 @@ module Faker
         formatted ? format('%s.%s.%s/%s-%s', *number.scan(/(\d{2})(\d{3})(\d{3})(\d{4})(\d{2})/).flatten) : number
       end
 
+      # Get a random Russian tax number.
+      def russian_tax_number(region: nil, type: :legal)
+        inn_number(region, type)
+      end
+
       ##
       # Produces a company sic code.
       #
@@ -491,6 +494,40 @@ module Faker
         end
         sum
       end
+
+      # rubocop:disable Style/AsciiComments
+      #
+      # For more on Russian tax number algorithm here:
+      # https://ru.wikipedia.org/wiki/Идентификационный_номер_налогоплательщика#Вычисление_контрольных_цифр
+      #
+      # Range of regions:
+      # https://ru.wikipedia.org/wiki/Коды_субъектов_Российской_Федерации
+      #
+      # rubocop:enable Style/AsciiComments
+      def inn_number(region, type)
+        n10 = [2, 4, 10, 3, 5, 9, 4, 6, 8]
+        n11 = [7, 2, 4, 10, 3, 5, 9, 4, 6, 8]
+        n12 = [3, 7, 2, 4, 10, 3, 5, 9, 4, 6, 8]
+
+        region = format('%.2d', rand(0o1..92)) if region.nil?
+        checksum = if type == :legal
+                     number = region.to_s + rand(1_000_000..9_999_999).to_s
+                     inn_checksum(n10, number)
+                   else
+                     number = region.to_s + rand(10_000_000..99_999_999).to_s
+                     inn_checksum(n11, number) + inn_checksum(n12, number + inn_checksum(n11, number))
+                   end
+
+        number + checksum
+      end
+
+      def inn_checksum(factor, number)
+        (
+          factor.map.with_index.reduce(0) do |v, i|
+            v + i[0] * number[i[1]].to_i
+          end % 11 % 10
+        ).to_s
+      end
     end
   end
 end

data/lib/faker/default/compass.rb

@@ -3,62 +3,197 @@
 module Faker
   class Compass < Base
     class << self
+      ##
+      # Produces a random cardinal.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.cardinal #=> "north"
+      #
+      # @faker.version 1.8.0
       def cardinal
         fetch('compass.cardinal.word')
       end
 
+      ##
+      # Produces a random ordinal.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.ordinal #=> "northwest"
+      #
+      # @faker.version 1.8.0
       def ordinal
         fetch('compass.ordinal.word')
       end
 
+      ##
+      # Produces a random half wind.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.half_wind #=> "north-northwest"
+      #
+      # @faker.version 1.8.0
       def half_wind
         fetch('compass.half-wind.word')
       end
 
+      ##
+      # Produces a random quarter wind.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.quarter_wind #=> "north by west"
+      #
+      # @faker.version 1.8.0
       def quarter_wind
         fetch('compass.quarter-wind.word')
       end
 
+      ##
+      # Produces a random direction.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.direction #=> "southeast"
+      #
+      # @faker.version 1.8.0
       def direction
         parse('compass.direction')
       end
 
+      ##
+      # Produces a random abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.abbreviation #=> "NEbN"
+      #
+      # @faker.version 1.8.0
       def abbreviation
         parse('compass.abbreviation')
       end
 
+      ##
+      # Produces a random azimuth.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.azimuth #=> "168.75"
+      #
+      # @faker.version 1.8.0
       def azimuth
         parse('compass.azimuth')
       end
 
+      ##
+      # Produces a random cardinal abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.cardinal_abbreviation #=> "N"
+      #
+      # @faker.version 1.8.0
       def cardinal_abbreviation
         fetch('compass.cardinal.abbreviation')
       end
 
+      ##
+      # Produces a random ordinal abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.ordinal_abbreviation #=> "SW"
+      #
+      # @faker.version 1.8.0
       def ordinal_abbreviation
         fetch('compass.ordinal.abbreviation')
       end
 
+      ##
+      # Produces a random half wind abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.half_wind_abbreviation #=> "NNE"
+      #
+      # @faker.version 1.8.0
       def half_wind_abbreviation
         fetch('compass.half-wind.abbreviation')
       end
 
+      ##
+      # Produces a random quarter wind abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.quarter_wind_abbreviation #=> "SWbS"
+      #
+      # @faker.version 1.8.0
       def quarter_wind_abbreviation
         fetch('compass.quarter-wind.abbreviation')
       end
 
+      ##
+      # Produces a random cardinal azimuth.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.cardinal_azimuth #=> "90"
+      #
+      # @faker.version 1.8.0
       def cardinal_azimuth
         fetch('compass.cardinal.azimuth')
       end
 
+      ##
+      # Produces a random ordinal azimuth.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.ordinal_azimuth #=> "135"
+      #
+      # @faker.version 1.8.0
       def ordinal_azimuth
         fetch('compass.ordinal.azimuth')
       end
 
+      ##
+      # Produces a random half wind azimuth.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.half_wind_azimuth #=> "292.5"
+      #
+      # @faker.version 1.8.0
       def half_wind_azimuth
         fetch('compass.half-wind.azimuth')
       end
 
+      ##
+      # Produces a random quarter wind azimuth
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.quarter_wind_azimuth #=> "56.25"
+      #
+      # @faker.version 1.8.0
       def quarter_wind_azimuth
         fetch('compass.quarter-wind.azimuth')
       end