faker 2.1.0

data/lib/faker/default/internet.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Faker
+  class Internet < Base
+    class << self
+      def email(name: nil, separators: nil)
+        if separators
+          [username(specifier: name, separators: separators), domain_name].join('@')
+        else
+          [username(specifier: name), domain_name].join('@')
+        end
+      end
+
+      def free_email(name: nil)
+        [username(specifier: name), fetch('internet.free_email')].join('@')
+      end
+
+      def safe_email(name: nil)
+        [username(specifier: name), 'example.' + sample(%w[org com net])].join('@')
+      end
+
+      def username(specifier: nil, separators: %w[. _])
+        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
+
+      def password(min_length: 8, max_length: 16, mix_case: true, special_characters: false)
+        temp = Lorem.characters(number: min_length)
+        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
+          temp.chars.each_with_index do |char, index|
+            temp[index] = char.upcase if index.even?
+          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(subdomain: false)
+        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(string: '')
+        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(prefix: '')
+        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(host: domain_name, path: "/#{username}", scheme: 'http')
+        "#{scheme}://#{host}#{path}"
+      end
+
+      def slug(words: nil, glue: nil)
+        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(vendor: nil)
+        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

data/lib/faker/default/invoice.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Faker
+  class Invoice < Base
+    flexible :invoice
+
+    class << self
+      # Generate random amount between values with 2 decimals
+      def amount_between(from: 0, to: 0)
+        Faker::Base.rand_in_range(from, to).round(2)
+      end
+
+      # International bank slip reference https://en.wikipedia.org/wiki/Creditor_Reference
+      # ref is optional so that we can create unit tests
+      def creditor_reference(ref: '')
+        ref = reference if ref.empty?
+
+        'RF' + iban_checksum('RF', ref) + ref
+      end
+
+      # Payment references have some rules in certain countries
+      # ref is optional so that we can create unit tests
+      def reference(ref: '')
+        pattern = fetch('invoice.reference.pattern')
+
+        ref = Base.regexify(/#{pattern}/) if ref.empty?
+
+        # If reference contains reserved '#' characters we need to calculate check_digits as well
+        check_digit_match = ref.match(/#+/)
+        if check_digit_match
+          # Get the method for selected language
+          check_digit_method = fetch('invoice.reference.check_digit_method')
+
+          # Calculate the check digit with matching method name
+          # Trim all '#' from the reference before calculating that
+          check_digit = send(check_digit_method, ref.tr('#', ''))
+
+          # Make sure that our check digit is as long as all of the '###' we found
+          check_digit = check_digit.to_s.rjust(check_digit_match[0].length, '0')
+
+          # Replace all of the
+          ref = ref.sub(check_digit_match[0], check_digit)
+        end
+
+        ref
+      end
+
+      private
+
+      # Calculates the mandatory checksum in 3rd and 4th characters in IBAN format
+      # source: https://en.wikipedia.org/wiki/International_Bank_Account_Number#Validating_the_IBAN
+      def iban_checksum(country_code, account)
+        # Converts letters to numbers according the iban rules, A=10..Z=35
+        account_to_number = "#{account}#{country_code}00".upcase.chars.map do |d|
+          d =~ /[A-Z]/ ? (d.ord - 55).to_s : d
+        end.join.to_i
+
+        # This is answer to (iban_to_num + checksum) % 97 == 1
+        checksum = (1 - account_to_number) % 97
+
+        # Use leftpad to make the size always to 2
+        checksum.to_s.rjust(2, '0')
+      end
+
+      # 731 Method
+      # Source: https://wiki.xmldation.com/support/fk/finnish_reference_number
+      def method_731(base)
+        weighted_sum = calculate_weighted_sum(base, [7, 3, 1])
+        mod10_remainder(weighted_sum)
+      end
+
+      # Norsk Modulus 10 - KIDMOD10
+      def kidmod10(base)
+        weighted_sum = calculate_weighted_sum(base, [1, 2])
+        mod10_remainder(weighted_sum)
+      end
+
+      # Calculates weigthed sum
+      #
+      # For example with 12345678, [1,2]
+      # Ref.num. 1 2 3 4 5 6 7 8
+      # Multipl. 1 2 1 2 1 2 1 2
+      # Total 1+ 4+ 3+ 8+ 5+1+2+ 7+1+6 = 38
+      def calculate_weighted_sum(base, weight_factors)
+        base.to_s.reverse.each_char.with_index.map do |digit, index|
+          digit.to_i * weight_factors.at(index % weight_factors.length)
+        end.reduce(:+) # reduce(:+) = sum() but with better ruby version support
+      end
+
+      # MOD-10 - remainder
+      def mod10_remainder(number)
+        -number % 10
+      end
+    end
+  end
+end

data/lib/faker/default/job.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Faker
+  class Job < Base
+    flexible :job
+
+    class << self
+      def title
+        parse('job.title')
+      end
+
+      def position
+        fetch('job.position')
+      end
+
+      def field
+        fetch('job.field')
+      end
+
+      def key_skill
+        fetch('job.key_skills')
+      end
+    end
+  end
+end

data/lib/faker/default/json.rb

@@ -0,0 +1,70 @@
+module Faker
+  class Json < Base
+    require 'json'
+
+    class << self
+      def shallow_json(width: 3, options: { key: 'Name.first_name', value: 'Name.first_name' })
+        options[:key] = 'Faker::' + options[:key]
+        options[:value] = 'Faker::' + options[:value]
+
+        hash = build_shallow_hash(width, options)
+        JSON.generate(hash)
+      end
+
+      def add_depth_to_json(json: shallow_json, width: 3, options: { key: 'Name.first_name', value: 'Name.first_name' })
+        options[:key] = 'Faker::' + options[:key]
+        options[:value] = 'Faker::' + options[:value]
+
+        hash = JSON.parse(json)
+        hash.each do |key, _|
+          add_hash_to_bottom(hash, [key], width, options)
+        end
+        JSON.generate(hash)
+      end
+
+      private
+
+      def build_shallow_hash(width, options)
+        key = options[:key]
+        value = options[:value]
+
+        hash = {}
+        width.times do
+          hash[eval(key)] = eval(value)
+        end
+        hash
+      end
+
+      def add_hash_to_bottom(hash, key_array, width, options)
+        key_string = build_keys_from_array(key_array)
+        if eval("hash#{key_string}").is_a?(::Hash)
+          eval("hash#{key_string}").each do |key, _|
+            key_array << key
+            add_hash_to_bottom(hash, key_array, width, options)
+          end
+        else
+          add_hash(key_array, hash, width, options)
+          key_array.pop
+        end
+      end
+
+      def add_hash(key_array, hash, width, options)
+        string_to_eval = 'hash'
+        key_array.length.times do |index|
+          string_to_eval << "['#{key_array[index]}']"
+        end
+        string_to_eval << " = #{build_shallow_hash(width, options)}"
+        eval(string_to_eval)
+        hash
+      end
+
+      def build_keys_from_array(key_array)
+        key_string = ''
+        key_array.each do |value|
+          key_string << "['#{value}']"
+        end
+        key_string
+      end
+    end
+  end
+end

data/lib/faker/default/kpop.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Faker
+  class Kpop < Base
+    class << self
+      def i_groups
+        fetch('kpop.i_groups')
+      end
+
+      def ii_groups
+        fetch('kpop.ii_groups')
+      end
+
+      def iii_groups
+        fetch('kpop.iii_groups')
+      end
+
+      def girl_groups
+        fetch('kpop.girl_groups')
+      end
+
+      def boy_bands
+        fetch('kpop.boy_bands')
+      end
+
+      def solo
+        fetch('kpop.solo')
+      end
+    end
+  end
+end

data/lib/faker/default/lorem.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Faker
+  # Based on Perl's Text::Lorem
+  class Lorem < Base
+    class << self
+      def word
+        sample(translate('faker.lorem.words'))
+      end
+
+      def words(number: 3, supplemental: false)
+        resolved_num = resolve(number)
+        word_list = (
+          translate('faker.lorem.words') +
+          (supplemental ? translate('faker.lorem.supplemental') : [])
+        )
+        word_list *= ((resolved_num / word_list.length) + 1)
+        shuffle(word_list)[0, resolved_num]
+      end
+
+      def character
+        sample(Types::CHARACTERS)
+      end
+
+      def characters(number: 255)
+        Alphanumeric.alphanumeric(number: number)
+      end
+
+      def multibyte
+        sample(translate('faker.lorem.multibyte')).pack('C*').force_encoding('utf-8')
+      end
+
+      def sentence(word_count: 4, supplemental: false, random_words_to_add: 0)
+        words(number: word_count + rand(random_words_to_add.to_i), supplemental: supplemental).join(' ').capitalize + locale_period
+      end
+
+      def sentences(number: 3, supplemental: false)
+        1.upto(resolve(number)).collect { sentence(word_count: 3, supplemental: supplemental) }
+      end
+
+      def paragraph(sentence_count: 3, supplemental: false, random_sentences_to_add: 0)
+        sentences(number: resolve(sentence_count) + rand(random_sentences_to_add.to_i), supplemental: supplemental).join(locale_space)
+      end
+
+      def paragraphs(number: 3, supplemental: false)
+        1.upto(resolve(number)).collect { paragraph(sentence_count: 3, supplemental: supplemental) }
+      end
+
+      def paragraph_by_chars(number: 256, supplemental: false)
+        paragraph = paragraph(sentence_count: 3, supplemental: supplemental)
+
+        paragraph += ' ' + paragraph(sentence_count: 3, supplemental: supplemental) while paragraph.length < number
+
+        paragraph[0...number - 1] + '.'
+      end
+
+      def question(word_count: 4, supplemental: false, random_words_to_add: 0)
+        words(number: word_count + rand(random_words_to_add), supplemental: supplemental).join(' ').capitalize + locale_question_mark
+      end
+
+      def questions(number: 3, supplemental: false)
+        1.upto(resolve(number)).collect { question(word_count: 3, supplemental: supplemental) }
+      end
+
+      private
+
+      def locale_period
+        translate('faker.lorem.punctuation.period') || '.'
+      end
+
+      def locale_space
+        translate('faker.lorem.punctuation.space') || ' '
+      end
+
+      def locale_question_mark
+        translate('faker.lorem.punctuation.question_mark') || '?'
+      end
+    end
+  end
+end