faker 2.11.0 → 3.4.2

data/lib/faker/default/commerce.rb

@@ -3,15 +3,31 @@
 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
 
-      def promotion_code(legacy_digits = NOT_GIVEN, digits: 6)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :digits if legacy_digits != NOT_GIVEN
-        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(digits: 6)
         [
           fetch('commerce.promotion_code.adjective'),
           fetch('commerce.promotion_code.noun'),
@@ -19,54 +35,115 @@ module Faker
         ].join
       end
 
-      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
-
+      ##
+      # 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(max: 3, fixed_amount: false)
         num = max if fixed_amount
         num ||= 1 + rand(max)
 
         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
 
-      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
-
+      ##
+      # 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(range: 0..100.0, as_string: false)
         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')
+          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)
-        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

@@ -151,6 +151,19 @@ module Faker
         fetch('company.profession')
       end
 
+      ##
+      # Produces a company department.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Company.department #=> "Information Technology"
+      #
+      # @faker.version next
+      def department
+        fetch('company.department')
+      end
+
       ##
       # Produces a company spanish organisation number.
       #
@@ -162,12 +175,17 @@ module Faker
       # @faker.version 1.8.5
       #
       # Get a random Spanish organization number. See more here https://es.wikipedia.org/wiki/N%C3%BAmero_de_identificaci%C3%B3n_fiscal
-      def spanish_organisation_number
+      def spanish_organisation_number(organization_type: nil)
         # Valid leading character: A, B, C, D, E, F, G, H, J, N, P, Q, R, S, U, V, W
-        # 7 digit numbers
+        # format: 1 digit letter (organization type) + 7 digit numbers + 1 digit control (letter or number based on
+        # organization type)
         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
+
+        organization_type = sample(letters) unless letters.include?(organization_type)
+        code = format('%07d', rand(10**7))
+        control = spanish_cif_control_digit(organization_type, code)
+
+        [organization_type, code, control].join
       end
 
       ##
@@ -291,7 +309,7 @@ module Faker
           result = Array.new(3) { rand(1..9) } + Array.new(7) { rand(10) }
           break if (weight_sum(result, weights) % 11) == result[9]
         end
-        result.join('')
+        result.join
       end
 
       ##
@@ -304,11 +322,7 @@ module Faker
       #
       # @faker.version 1.9.1
       # Get a random Polish register of national economy number. More info https://pl.wikipedia.org/wiki/REGON
-      def polish_register_of_national_economy(legacy_length = NOT_GIVEN, length: 9)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :length if legacy_length != NOT_GIVEN
-        end
-
+      def polish_register_of_national_economy(length: 9)
         raise ArgumentError, 'Length should be 9 or 14' unless [9, 14].include? length
 
         random_digits = []
@@ -316,7 +330,7 @@ module Faker
           random_digits = Array.new(length) { rand(10) }
           break if collect_regon_sum(random_digits) == random_digits.last
         end
-        random_digits.join('')
+        random_digits.join
       end
 
       ##
@@ -329,7 +343,12 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_pty_ltd_registration_number
-        regexify(/\d{4}\/\d{4,10}\/07/)
+        generate(:string) do |g|
+          g.int(length: 4)
+          g.lit('/')
+          g.int(ranges: [1000..9_999_999_999])
+          g.lit('/07')
+        end
       end
 
       ##
@@ -342,7 +361,18 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_close_corporation_registration_number
-        regexify(/(CK\d{2}|\d{4})\/\d{4,10}\/23/)
+        generate(:string) do |g|
+          g.oneof do |one|
+            one.group do |g_|
+              g_.lit('CK')
+              g_.int(length: 2)
+            end
+            one.int(length: 4)
+          end
+          g.lit('/')
+          g.int(ranges: [1000..9_999_999_999])
+          g.lit('/23')
+        end
       end
 
       ##
@@ -355,7 +385,12 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_listed_company_registration_number
-        regexify(/\d{4}\/\d{4,10}\/06/)
+        generate(:string) do |g|
+          g.int(length: 4)
+          g.lit('/')
+          g.int(ranges: [1000..9_999_999_999])
+          g.lit('/06')
+        end
       end
 
       ##
@@ -368,7 +403,12 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_trust_registration_number
-        regexify(/IT\d{2,4}\/\d{2,10}/)
+        generate(:string) do |g|
+          g.lit('IT')
+          g.int(ranges: [10..9999])
+          g.lit('/')
+          g.int(ranges: [10..9_999_999_999])
+        end
       end
 
       ##
@@ -380,11 +420,7 @@ module Faker
       #   Faker::Company.brazilian_company_number #=> "37205322000500"
       #
       # @faker.version 1.9.2
-      def brazilian_company_number(legacy_formatted = NOT_GIVEN, formatted: false)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :formatted if legacy_formatted != NOT_GIVEN
-        end
-
+      def brazilian_company_number(formatted: false)
         digits = Array.new(8) { Faker::Number.digit.to_i } + [0, 0, 0, Faker::Number.non_zero_digit.to_i]
 
         factors = [5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2, 6].cycle
@@ -399,6 +435,22 @@ 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.
+      # @param region [String] Any region string
+      # @param type [Symbol] Legeal or not, defaults to :legal
+      #
+      # @return [String]
+      # @example
+      #   Faker::Company.russian_tax_number                             #=> "0415584064"
+      #   Faker::Company.russian_tax_number(region: 'AZ')               #=> "AZ50124562"
+      #   Faker::Company.russian_tax_number(region: 'AZ', type: false)  #=> "AZ8802315465"
+      #
+      # @faker.version 1.9.4
+      def russian_tax_number(region: nil, type: :legal)
+        inn_number(region, type)
+      end
+
       ##
       # Produces a company sic code.
       #
@@ -412,6 +464,61 @@ module Faker
         fetch('company.sic_code')
       end
 
+      ##
+      # Get a random Indian Goods and Services Tax (GST) number.
+      # For more on Indian tax number here:
+      # https://simple.wikipedia.org/wiki/GSTIN
+      # @params state code [String] Any state code.
+      #
+      # @return [String]
+      # @example
+      #   Faker::Company.indian_gst_number #=> "15VQPNZ2126J2ZU"
+      #   Faker::Company.indian_gst_number(state_code: "22") #=> "22ZVWEY6632K0ZN"
+      #
+      # @faker.version 3.2.1
+      def indian_gst_number(state_code: nil)
+        # Check if state code is valid
+        state_code_ranges = [('02'..'38'), ['98']]
+        if state_code && !(state_code_ranges[0].include?(state_code) || state_code == '98')
+          raise ArgumentError, 'state code must be in a range of 02 to 38 or 98'
+        end
+
+        PositionalGenerator.new(:string) do |gen|
+          # Generate a state code if not given
+          if state_code
+            gen.lit(state_code, name: :state_code_param)
+          else
+            gen.letter(name: :state_code_param, length: 1, ranges: state_code_ranges)
+          end
+
+          # Construct taxpayer number
+          gen.group(name: :taxpayer_number) do |g_|
+            g_.letter(length: 3, ranges: ['A'..'Z'])
+            g_.letter(length: 1, ranges: [%w[A B C F G H L J P T K]].to_a)
+            g_.letter(length: 1, ranges: ['A'..'Z'])
+            g_.int(length: 4, ranges: [0..9999])
+            g_.letter(length: 1, ranges: ['A'..'Z'])
+          end
+
+          gen.int(name: :registration_number, length: 1, ranges: [0..9])
+
+          gen.letter(name: :z_char, length: 1, ranges: [['Z']])
+
+          gen.computed(deps: %i[state_code_param taxpayer_number registration_number]) do |state_code_param, taxpayer_number, registration_number|
+            gst_base = "#{state_code_param}#{taxpayer_number}#{registration_number}"
+            chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'.chars
+            values = gst_base.chars
+            sum = values.map.with_index do |char, index|
+              product = chars.index(char) * (index.odd? ? 2 : 1)
+              (product / chars.length).floor + (product % chars.length)
+            end.reduce(:+)
+
+            checksum = (chars.length - (sum % chars.length)) % chars.length
+            chars[checksum]
+          end
+        end.generate
+      end
+
       private
 
       # Mod11 functionality from https://github.com/badmanski/mod11/blob/master/lib/mod11.rb
@@ -438,7 +545,7 @@ module Faker
       def luhn_algorithm(number)
         multiplications = []
 
-        number.to_s.reverse.split(//).each_with_index do |digit, i|
+        number.to_s.reverse.chars.each_with_index do |digit, i|
           multiplications << if i.even?
                                digit.to_i * 2
                              else
@@ -454,13 +561,11 @@ module Faker
           end
         end
 
-        control_digit = if (sum % 10).zero?
-                          0
-                        else
-                          (sum / 10 + 1) * 10 - sum
-                        end
-
-        control_digit
+        if (sum % 10).zero?
+          0
+        else
+          (sum / 10 + 1) * 10 - sum
+        end
       end
 
       def abn_checksum(abn)
@@ -491,6 +596,83 @@ module Faker
         end
         sum
       end
+
+      #
+      # For more on Russian tax number algorithm here:
+      # https://ru.wikipedia.org/wiki/Идентификационный_номер_налогоплательщика#Вычисление_контрольных_цифр
+      #
+      # Range of regions:
+      # https://ru.wikipedia.org/wiki/Коды_субъектов_Российской_Федерации
+      # region [String] Any region string
+      # @param type [Symbol] Legeal or not, defaults to :legal
+      #
+      # @return [String]
+      # @example
+      #   Faker::Comnpany.russian_tax_number
+      #   Faker::Comnpany.russian_tax_number(region: 'AZ')
+      #   Faker::Comnpany.russian_tax_number(region: 'AZ', type: false)
+      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
+
+      def spanish_cif_control_digit(organization_type, code)
+        letters = %w[J A B C D E F G H I]
+
+        control = code.chars.each_with_index.inject(0) do |sum, (value, index)|
+          if (index + 1).even?
+            sum + value.to_i
+          else
+            sum + spanish_b_algorithm(value.to_i)
+          end
+        end
+
+        control = control.to_s[-1].to_i
+        control = 10 - control unless control.zero?
+
+        %w[A B C D E F G H J U V].include?(organization_type) ? control : letters[control]
+      end
+
+      def spanish_b_algorithm(value)
+        result = value.to_i * 2
+
+        return result if result < 10
+
+        result.to_s[0].to_i + result.to_s[1].to_i
+      end
+
+      def calculate_gst_checksum(state_code, taxpayer_number, registration_number)
+        gst_base = "#{state_code}#{taxpayer_number}#{registration_number}"
+        chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'.chars
+        values = gst_base.upcase.chars
+        sum = values.map.with_index do |char, index|
+          product = chars.index(char) * (index.odd? ? 2 : 1)
+          (product / chars.length).floor + (product % chars.length)
+        end.reduce(:+)
+
+        checksum = (chars.length - (sum % chars.length)) % chars.length
+        chars[checksum]
+      end
     end
   end
 end