faker 2.2.2

data/lib/faker/default/house.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Faker
+  class House < Base
+    class << self
+      def furniture
+        fetch('house.furniture')
+      end
+
+      def room
+        fetch('house.rooms')
+      end
+    end
+  end
+end

data/lib/faker/default/id_number.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module Faker
+  class IDNumber < Base
+    CHECKS = 'TRWAGMYFPDXBNJZSQVHLCKE'
+    INVALID_SSN = [
+      /0{3}-\d{2}-\d{4}/,
+      /\d{3}-0{2}-\d{4}/,
+      /\d{3}-\d{2}-0{4}/,
+      /666-\d{2}-\d{4}/,
+      /9\d{2}-\d{2}-\d{4}/
+    ].freeze
+    ZA_RACE_DIGIT = '8'
+    ZA_CITIZENSHIP_DIGITS = %w[0 1].freeze
+    BRAZILIAN_ID_FORMAT = /(\d{1,2})(\d{3})(\d{3})([\dX])/.freeze
+    BRAZILIAN_ID_FROM = 10_000_000
+    BRAZILIAN_ID_TO = 99_999_999
+
+    class << self
+      def valid
+        _translate('valid')
+      end
+
+      def invalid
+        _translate('invalid')
+      end
+
+      def ssn_valid
+        ssn = regexify(/[0-8]\d{2}-\d{2}-\d{4}/)
+        # We could still have all 0s in one segment or another
+        INVALID_SSN.any? { |regex| regex =~ ssn } ? ssn_valid : ssn
+      end
+
+      def spanish_citizen_number
+        num = Faker::Number.number(digits: 8)
+        mod = num.to_i % 23
+        check = CHECKS[mod]
+        "#{num}-#{check}"
+      end
+
+      def spanish_foreign_citizen_number
+        code = 'XYZ'
+        digits = Faker::Number.number(digits: 7)
+        prefix = code[rand(code.length)]
+        prefix_val = 'XYZ'.index(prefix).to_s
+        mod = "#{prefix_val}#{digits}".to_i % 23
+        check = CHECKS[mod]
+        "#{prefix}-#{digits}-#{check}"
+      end
+
+      def valid_south_african_id_number
+        id_number = [
+          Faker::Date.birthday.strftime('%y%m%d'),
+          Faker::Number.number(digits: 4),
+          ZA_CITIZENSHIP_DIGITS.sample(random: Faker::Config.random),
+          ZA_RACE_DIGIT
+        ].join
+
+        [id_number, south_african_id_checksum_digit(id_number)].join
+      end
+
+      alias south_african_id_number valid_south_african_id_number
+
+      def invalid_south_african_id_number
+        invalid_date_of_birth = [
+          Faker::Number.number(digits: 2),
+          Faker::Number.between(from: 13, to: 99),
+          Faker::Number.between(from: 32, to: 99)
+        ].map(&:to_s).join
+
+        id_number = [
+          invalid_date_of_birth,
+          Faker::Number.number(digits: 4),
+          ZA_CITIZENSHIP_DIGITS.sample(random: Faker::Config.random),
+          ZA_RACE_DIGIT
+        ].join
+
+        [id_number, south_african_id_checksum_digit(id_number)].join
+      end
+
+      def brazilian_citizen_number(legacy_formatted = NOT_GIVEN, formatted: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :formatted if legacy_formatted != NOT_GIVEN
+        end
+
+        digits = Faker::Number.leading_zero_number(digits: 9) until digits&.match(/(\d)((?!\1)\d)+/)
+        first_digit = brazilian_citizen_number_checksum_digit(digits)
+        second_digit = brazilian_citizen_number_checksum_digit(digits + first_digit)
+        number = [digits, first_digit, second_digit].join
+        formatted ? format('%s.%s.%s-%s', *number.scan(/\d{2,3}/).flatten) : number
+      end
+
+      alias brazilian_cpf brazilian_citizen_number
+
+      def brazilian_id(legacy_formatted = NOT_GIVEN, formatted: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :formatted if legacy_formatted != NOT_GIVEN
+        end
+
+        digits = Faker::Number.between(to: BRAZILIAN_ID_FROM, from: BRAZILIAN_ID_TO).to_s
+        check_digit = brazilian_id_checksum_digit(digits)
+        number = [digits, check_digit].join
+        formatted ? format('%s.%s.%s-%s', *number.scan(BRAZILIAN_ID_FORMAT).flatten) : number
+      end
+
+      alias brazilian_rg brazilian_id
+
+      private
+
+      def south_african_id_checksum_digit(id_number)
+        value_parts = id_number.chars
+        even_digits = value_parts
+                      .select
+                      .with_index { |_, i| (i + 1).even? }
+        odd_digits_without_last_character = value_parts[0...-1]
+                                            .select
+                                            .with_index { |_, i| (i + 1).odd? }
+
+        sum_of_odd_digits = odd_digits_without_last_character.map(&:to_i).reduce(:+)
+        even_digits_times_two = (even_digits.join('').to_i * 2).to_s
+        sum_of_even_digits = even_digits_times_two.chars.map(&:to_i).reduce(:+)
+
+        total_sum = sum_of_odd_digits + sum_of_even_digits
+
+        ((10 - (total_sum % 10)) % 10).to_s
+      end
+
+      def brazilian_citizen_number_checksum_digit(digits)
+        checksum = brazilian_document_checksum(digits)
+        brazilian_document_digit(checksum)
+      end
+
+      def brazilian_id_checksum_digit(digits)
+        checksum = brazilian_document_checksum(digits)
+        brazilian_document_digit(checksum, id: true)
+      end
+
+      def brazilian_document_checksum(digits)
+        digits.chars.each_with_index.inject(0) do |acc, (digit, i)|
+          acc + digit.to_i * (digits.size + 1 - i)
+        end * 10
+      end
+
+      def brazilian_document_digit(checksum, id = false)
+        remainder = checksum % 11
+        id ? brazilian_id_digit(remainder) : brazilian_citizen_number_digit(remainder)
+      end
+
+      def brazilian_citizen_number_digit(remainder)
+        remainder == 10 ? '0' : remainder.to_s
+      end
+
+      def brazilian_id_digit(remainder)
+        subtraction = 11 - remainder.to_i
+        digits = { 10 => 'X', 11 => '0' }
+        digits.include?(subtraction) ? digits[subtraction] : subtraction.to_s
+      end
+
+      def _translate(key)
+        parse("id_number.#{key}")
+      end
+    end
+  end
+end

data/lib/faker/default/industry_segments.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Faker
+  class IndustrySegments < Base
+    flexible :industry_segments
+
+    class << self
+      def industry
+        fetch('industry_segments.industry')
+      end
+
+      def super_sector
+        fetch('industry_segments.super_sector')
+      end
+
+      def sector
+        fetch('industry_segments.sector')
+      end
+
+      def sub_sector
+        fetch('industry_segments.sub_sector')
+      end
+    end
+  end
+end

data/lib/faker/default/internet.rb

@@ -0,0 +1,283 @@
+# frozen_string_literal: true
+
+module Faker
+  class Internet < Base
+    class << self
+      def email(legacy_name = NOT_GIVEN, legacy_separators = NOT_GIVEN, name: nil, separators: nil)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :name if legacy_name != NOT_GIVEN
+          keywords << :separators if legacy_separators != NOT_GIVEN
+        end
+
+        if separators
+          [username(specifier: name, separators: separators), domain_name].join('@')
+        else
+          [username(specifier: name), domain_name].join('@')
+        end
+      end
+
+      def free_email(legacy_name = NOT_GIVEN, name: nil)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :name if legacy_name != NOT_GIVEN
+        end
+
+        [username(specifier: name), fetch('internet.free_email')].join('@')
+      end
+
+      def safe_email(legacy_name = NOT_GIVEN, name: nil)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :name if legacy_name != NOT_GIVEN
+        end
+
+        [username(specifier: name), 'example.' + sample(%w[org com net])].join('@')
+      end
+
+      def username(legacy_specifier = NOT_GIVEN, legacy_separators = NOT_GIVEN, specifier: nil, separators: %w[. _])
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :specifier if legacy_specifier != NOT_GIVEN
+          keywords << :separators if legacy_separators != NOT_GIVEN
+        end
+
+        with_locale(:en) do
+          return shuffle(specifier.scan(/[[:word:]]+/)).join(sample(separators)).downcase if specifier.respond_to?(:scan)
+
+          if specifier.is_a?(Integer)
+            # If specifier is Integer and has large value, Argument error exception is raised to overcome memory full error
+            raise ArgumentError, 'Given argument is too large' if specifier > 10**6
+
+            tries = 0 # Don't try forever in case we get something like 1_000_000.
+            result = nil
+            loop do
+              result = username(specifier: nil, separators: separators)
+              tries += 1
+              break unless result.length < specifier && tries < 7
+            end
+            return result * (specifier / result.length + 1) if specifier.positive?
+          elsif specifier.is_a?(Range)
+            tries = 0
+            result = nil
+            loop do
+              result = username(specifier: specifier.min, separators: separators)
+              tries += 1
+              break unless !specifier.include?(result.length) && tries < 7
+            end
+            return result[0...specifier.max]
+          end
+
+          sample([
+                   Char.prepare(Name.first_name),
+                   [Name.first_name, Name.last_name].map do |name|
+                     Char.prepare(name)
+                   end.join(sample(separators))
+                 ])
+        end
+      end
+
+      ##
+      # Produces a randomized string of characters
+      #
+      # @param [Integer] min_length
+      # @param [Integer] max_length
+      # @param [Boolean] mix_case
+      # @param [Boolean] special_characters
+      #
+      # @return [String]
+      #
+      # @example Faker::Internet.password #=> "Vg5mSvY1UeRg7"
+      # @example Faker::Internet.password(min_length: 8) #=> "YfGjIk0hGzDqS0"
+      # @example Faker::Internet.password(min_length: 10, max_length: 20) #=> "EoC9ShWd1hWq4vBgFw"
+      # @example Faker::Internet.password(min_length: 10, max_length: 20, mix_case: true) #=> "3k5qS15aNmG"
+      # @example Faker::Internet.password(min_length: 10, max_length: 20, mix_case: true, special_characters: true) #=> "*%NkOnJsH4"
+      #
+      # @faker.version 2.1.3
+      # rubocop:disable Metrics/ParameterLists
+      def password(legacy_min_length = NOT_GIVEN, legacy_max_length = NOT_GIVEN, legacy_mix_case = NOT_GIVEN, legacy_special_characters = NOT_GIVEN, min_length: 8, max_length: 16, mix_case: true, special_characters: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :min_length if legacy_min_length != NOT_GIVEN
+          keywords << :max_length if legacy_max_length != NOT_GIVEN
+          keywords << :mix_case if legacy_mix_case != NOT_GIVEN
+          keywords << :special_characters if legacy_special_characters != NOT_GIVEN
+        end
+
+        min_alpha = mix_case ? 2 : 0
+        temp = Lorem.characters(number: min_length, min_alpha: min_alpha)
+        diff_length = max_length - min_length
+
+        if diff_length.positive?
+          diff_rand = rand(diff_length + 1)
+          temp += Lorem.characters(number: diff_rand)
+        end
+
+        if mix_case
+          alpha_count = 0
+          temp.chars.each_with_index do |char, index|
+            if char =~ /[[:alpha:]]/
+              temp[index] = char.upcase if alpha_count.even?
+              alpha_count += 1
+            end
+          end
+        end
+
+        if special_characters
+          chars = %w[! @ # $ % ^ & *]
+          rand(1..min_length).times do |i|
+            temp[i] = chars[rand(chars.length)]
+          end
+        end
+
+        temp
+      end
+
+      def domain_name(legacy_subdomain = NOT_GIVEN, subdomain: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :subdomain if legacy_subdomain != NOT_GIVEN
+        end
+
+        with_locale(:en) do
+          domain_elements = [Char.prepare(domain_word), domain_suffix]
+          domain_elements.unshift(Char.prepare(domain_word)) if subdomain
+          domain_elements.join('.')
+        end
+      end
+
+      def fix_umlauts(legacy_string = NOT_GIVEN, string: '')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :string if legacy_string != NOT_GIVEN
+        end
+
+        Char.fix_umlauts(string)
+      end
+
+      def domain_word
+        with_locale(:en) { Char.prepare(Company.name.split(' ').first) }
+      end
+
+      def domain_suffix
+        fetch('internet.domain_suffix')
+      end
+
+      def mac_address(legacy_prefix = NOT_GIVEN, prefix: '')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :prefix if legacy_prefix != NOT_GIVEN
+        end
+
+        prefix_digits = prefix.split(':').map { |d| d.to_i(16) }
+        address_digits = Array.new((6 - prefix_digits.size)) { rand(256) }
+        (prefix_digits + address_digits).map { |d| format('%02x', d) }.join(':')
+      end
+
+      def ip_v4_address
+        [rand_in_range(0, 255), rand_in_range(0, 255),
+         rand_in_range(0, 255), rand_in_range(0, 255)].join('.')
+      end
+
+      def private_ip_v4_address
+        addr = nil
+        loop do
+          addr = ip_v4_address
+          break if private_net_checker[addr]
+        end
+        addr
+      end
+
+      def public_ip_v4_address
+        addr = nil
+        loop do
+          addr = ip_v4_address
+          break unless reserved_net_checker[addr]
+        end
+        addr
+      end
+
+      def private_nets_regex
+        [
+          /^10\./,                                       # 10.0.0.0    - 10.255.255.255
+          /^100\.(6[4-9]|[7-9]\d|1[0-1]\d|12[0-7])\./,   # 100.64.0.0  - 100.127.255.255
+          /^127\./,                                      # 127.0.0.0   - 127.255.255.255
+          /^169\.254\./,                                 # 169.254.0.0 - 169.254.255.255
+          /^172\.(1[6-9]|2\d|3[0-1])\./,                 # 172.16.0.0  - 172.31.255.255
+          /^192\.0\.0\./,                                # 192.0.0.0   - 192.0.0.255
+          /^192\.168\./,                                 # 192.168.0.0 - 192.168.255.255
+          /^198\.(1[8-9])\./                             # 198.18.0.0  - 198.19.255.255
+        ]
+      end
+
+      def private_net_checker
+        ->(addr) { private_nets_regex.any? { |net| net =~ addr } }
+      end
+
+      def reserved_nets_regex
+        [
+          /^0\./,                 # 0.0.0.0      - 0.255.255.255
+          /^192\.0\.2\./,         # 192.0.2.0    - 192.0.2.255
+          /^192\.88\.99\./,       # 192.88.99.0  - 192.88.99.255
+          /^198\.51\.100\./,      # 198.51.100.0 - 198.51.100.255
+          /^203\.0\.113\./,       # 203.0.113.0  - 203.0.113.255
+          /^(22[4-9]|23\d)\./,    # 224.0.0.0    - 239.255.255.255
+          /^(24\d|25[0-5])\./     # 240.0.0.0    - 255.255.255.254  and  255.255.255.255
+        ]
+      end
+
+      def reserved_net_checker
+        ->(addr) { (private_nets_regex + reserved_nets_regex).any? { |net| net =~ addr } }
+      end
+
+      def ip_v4_cidr
+        "#{ip_v4_address}/#{rand(1..31)}"
+      end
+
+      def ip_v6_address
+        (1..8).map { rand(65_536).to_s(16) }.join(':')
+      end
+
+      def ip_v6_cidr
+        "#{ip_v6_address}/#{rand(1..127)}"
+      end
+
+      def url(legacy_host = NOT_GIVEN, legacy_path = NOT_GIVEN, legacy_scheme = NOT_GIVEN, host: domain_name, path: "/#{username}", scheme: 'http')
+        # rubocop:enable Metrics/ParameterLists
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :host if legacy_host != NOT_GIVEN
+          keywords << :path if legacy_path != NOT_GIVEN
+          keywords << :scheme if legacy_scheme != NOT_GIVEN
+        end
+
+        "#{scheme}://#{host}#{path}"
+      end
+
+      def slug(legacy_words = NOT_GIVEN, legacy_glue = NOT_GIVEN, words: nil, glue: nil)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :words if legacy_words != NOT_GIVEN
+          keywords << :glue if legacy_glue != NOT_GIVEN
+        end
+
+        glue ||= sample(%w[- _])
+        (words || Faker::Lorem.words(number: 2).join(' ')).delete(',.').gsub(' ', glue).downcase
+      end
+
+      def device_token
+        shuffle(rand(16**64).to_s(16).rjust(64, '0').chars.to_a).join
+      end
+
+      def user_agent(legacy_vendor = NOT_GIVEN, vendor: nil)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :vendor if legacy_vendor != NOT_GIVEN
+        end
+
+        agent_hash = translate('faker.internet.user_agent')
+        agents = vendor.respond_to?(:to_sym) && agent_hash[vendor.to_sym] || agent_hash[sample(agent_hash.keys)]
+        sample(agents)
+      end
+
+      def uuid
+        # borrowed from: https://github.com/ruby/ruby/blob/d48783bb0236db505fe1205d1d9822309de53a36/lib/securerandom.rb#L250
+        ary = Faker::Config.random.bytes(16).unpack('NnnnnN')
+        ary[2] = (ary[2] & 0x0fff) | 0x4000
+        ary[3] = (ary[3] & 0x3fff) | 0x8000
+        '%08x-%04x-%04x-%04x-%04x%08x' % ary # rubocop:disable Style/FormatString
+      end
+
+      alias user_name username
+    end
+  end
+end