faker 1.8.7 → 2.17.0

data/lib/faker/default/internet_http.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Internet
+    class HTTP < Base
+      STATUS_CODES = {
+        information: [100, 101, 102, 103],
+        successful: [200, 201, 202, 203, 204, 205, 206, 207, 208, 226],
+        redirect: [300, 301, 302, 303, 304, 305, 306, 307, 308],
+        client_error: [400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412,
+                       413, 414, 415, 416, 417, 418, 421, 422, 423, 424, 425, 426, 428,
+                       429, 431, 451],
+        server_error: [500, 501, 502, 503, 504, 505, 506, 507, 508, 510, 511]
+      }.freeze
+
+      STATUS_CODES_GROUPS = STATUS_CODES.keys.freeze
+
+      class << self
+        ##
+        # Produces an HTTP status code
+        #
+        # @return [Integer]
+        #
+        # @example
+        #   Faker::Internet::HTTP.status_code #=> 418
+        # @example
+        #   Faker::Internet::HTTP.status_code(group: :information) #=> 102
+        # @example
+        #   Faker::Internet::HTTP.status_code(group: :successful) #=> 200
+        # @example
+        #   Faker::Internet::HTTP.status_code(group: :redirect) #=> 306
+        # @example
+        #   Faker::Internet::HTTP.status_code(group: :client_error) #=> 451
+        # @example
+        #   Faker::Internet::HTTP.status_code(group: :server_error) #=> 502
+        #
+        # @faker.version 2.13.0
+        def status_code(group: nil)
+          return STATUS_CODES[STATUS_CODES_GROUPS.sample].sample unless group
+
+          raise ArgumentError, 'Invalid HTTP status code group' unless STATUS_CODES_GROUPS.include?(group)
+
+          STATUS_CODES[group].sample
+        end
+      end
+    end
+  end
+end

data/lib/faker/default/invoice.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module Faker
+  class Invoice < Base
+    flexible :invoice
+
+    class << self
+      ##
+      # Produces a random amount between values with 2 decimals
+      #
+      # @param from [Integer] Specifies lower limit.
+      # @param to [Integer] Specifies upper limit.
+      # @return [Integer]
+      #
+      # @example
+      #   Faker::Finance.amount_between #=> 0
+      #   Faker::Finance.amount_between(0, 10) #=> 4.33
+      #
+      # @faker.version 1.9.0
+      def amount_between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 0, to: 0)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :from if legacy_from != NOT_GIVEN
+          keywords << :to if legacy_to != NOT_GIVEN
+        end
+
+        Faker::Base.rand_in_range(from, to).round(2)
+      end
+
+      ##
+      # Produces a random valid reference accoring to the International bank slip reference https://en.wikipedia.org/wiki/Creditor_Reference
+      #
+      # @param ref [String] Specifies reference base.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Invoice.creditor_reference #=> "RF34118592570724925498"
+      #
+      # @faker.version 1.9.0
+      def creditor_reference(legacy_ref = NOT_GIVEN, ref: '')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :ref if legacy_ref != NOT_GIVEN
+        end
+
+        ref = reference if ref.empty?
+
+        "RF#{iban_checksum('RF', ref)}#{ref}"
+      end
+
+      ##
+      # Produces a random valid reference.
+      #
+      # @param ref [String] Specifies reference base.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Invoice.reference #=> "45656646957845"
+      #
+      # @faker.version 1.9.0
+      def reference(legacy_ref = NOT_GIVEN, ref: '')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :ref if legacy_ref != NOT_GIVEN
+        end
+
+        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,61 @@
+# frozen_string_literal: true
+
+module Faker
+  class Job < Base
+    flexible :job
+
+    class << self
+      ##
+      # Produces a random job title.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Job.title #=> "Construction Manager"
+      #
+      # @faker.version 1.7.0
+      def title
+        parse('job.title')
+      end
+
+      ##
+      # Produces a random job position.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Job.position #=> "Strategist"
+      #
+      # @faker.version 1.8.7
+      def position
+        fetch('job.position')
+      end
+
+      ##
+      # Produces a random job field.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Job.field #=> "Banking"
+      #
+      # @faker.version 1.7.0
+      def field
+        fetch('job.field')
+      end
+
+      ##
+      # Produces a random job skill.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Job.key_skill #=> "Leadership"
+      #
+      # @faker.version 1.7.0
+      def key_skill
+        fetch('job.key_skills')
+      end
+    end
+  end
+end

data/lib/faker/default/json.rb

@@ -0,0 +1,143 @@
+module Faker
+  class Json < Base
+    require 'json'
+
+    class << self
+      ##
+      # Produces a random simple JSON formatted string.
+      #
+      # @param width [Integer] Specifies the number of key-value pairs.
+      # @param options [Hash] Specifies a Faker gem class to use for keys and for values, respectably. options_hash = {key: Class.method, value: Class.method}
+      # @return [Hash{String => String}]
+      #
+      # @example
+      #   Faker::Json.shallow_json(width: 3, options: { key: 'RockBand.name', value: 'Seinfeld.quote' }) # =>
+      #     {"Parliament Funkadelic":"They're real, and they're spectacular.",
+      #     "Fleetwood Mac":"I'm not a lesbian. I hate men, but I'm not a lesbian.",
+      #     "The Roots":"It became very clear to me sitting out there today that every decision
+      #     I've made in my entire life has been wrong. My life is the complete opposite of everything
+      #     I want it to be. Every instinct I have, in every aspect of life, be it something to wear,
+      #     something to eat - it's all been wrong."}
+      #
+      # @faker.version 1.9.2
+      def shallow_json(legacy_width = NOT_GIVEN, legacy_options = NOT_GIVEN, width: 3, options: { key: 'Name.first_name', value: 'Name.first_name' })
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :width if legacy_width != NOT_GIVEN
+          keywords << :options if legacy_options != NOT_GIVEN
+        end
+
+        options[:key] = "Faker::#{options[:key]}"
+        options[:value] = "Faker::#{options[:value]}"
+
+        hash = build_shallow_hash(width, options)
+        JSON.generate(hash)
+      end
+
+      # rubocop:disable Metrics/ParameterLists
+
+      ##
+      # Produces a random nested JSON formatted string that can take JSON as an additional argument.
+      #
+      # @param json [Hash{String => String}] Specifies a Json.shallow_json and uses its keys as keys of the nested JSON.
+      # @param width [Integer] Specifies the number of nested key-value pairs.
+      # @param options [Hash] Specifies a Faker gem class to use for nested keys and for values, respectably. options_hash = {key: Class.method, value: Class.method}
+      # @return [Hash{String => String}]
+      #
+      # @example
+      #   json = Faker::Json.shallow_json(width: 3, options: { key: 'Name.first_name', value: 'Name.last_name' })
+      #   puts json # =>
+      #     {"Alisha":"Olson","Everardo":"DuBuque","Bridgette":"Turner"}
+      #
+      #   json2 = Faker::Json.add_depth_to_json(json: json, width: 2, options: { key: 'Name.first_name', value: 'Name.last_name' })
+      #   puts json2 # =>
+      #     {"Alisha":{"Daisy":"Trantow","Oda":"Haag"},
+      #      "Everardo":{"Javier":"Marvin","Eliseo":"Schuppe"},
+      #      "Bridgette":{"Jorge":"Kertzmann","Lelah":"MacGyver"}}
+      #
+      #    json3 = Faker::Json.add_depth_to_json(json: json2, width: 4, options: { key: 'Name.first_name', value: 'Name.last_name' })
+      #      puts json3 # =>
+      #        {"Alisha":
+      #          {"Daisy":
+      #            {"Bulah":"Wunsch","Cristian":"Champlin","Lester":"Bartoletti","Greg":"Jacobson"},
+      #           "Oda":
+      #             {"Salvatore":"Kuhlman","Aubree":"Okuneva","Larry":"Schmitt","Velva":"Gibson"}},
+      #         "Everardo":
+      #           {"Javier":
+      #             {"Eduardo":"Orn","Laila":"Kub","Thad":"Legros","Dion":"Wilderman"},
+      #           "Eliseo":
+      #             {"Olin":"Hilpert","Marisa":"Greenfelder","Karlee":"Schmitt","Judd":"Larkin"}},
+      #         "Bridgette":
+      #           {"Jorge":
+      #             {"Eloy":"Pfeffer","Kody":"Hansen","Paxton":"Lubowitz","Abe":"Lesch"},
+      #           "Lelah":
+      #             {"Rick":"Wiza","Bonita":"Bayer","Gardner":"Auer","Felicity":"Abbott"}}}
+      #
+      # @faker.version 1.9.2
+      def add_depth_to_json(legacy_json = NOT_GIVEN, legacy_width = NOT_GIVEN, legacy_options = NOT_GIVEN, json: shallow_json, width: 3, options: { key: 'Name.first_name', value: 'Name.first_name' })
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :json if legacy_json != NOT_GIVEN
+        end
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :width if legacy_width != NOT_GIVEN
+        end
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :options if legacy_options != NOT_GIVEN
+        end
+
+        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
+      # rubocop:enable Metrics/ParameterLists
+
+      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,85 @@
+# frozen_string_literal: true
+
+module Faker
+  class Kpop < Base
+    class << self
+      ##
+      # Produces the name of a 1990's 'OG' K-Pop group.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Kpop.i_groups #=> "Seo Taiji and Boys"
+      #
+      # @faker.version 1.8.5
+      def i_groups
+        fetch('kpop.i_groups')
+      end
+
+      ##
+      # Produces the name of a 2000's K-Pop group.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Kpop.ii_groups #=> "Girls' Generation"
+      #
+      # @faker.version 1.8.5
+      def ii_groups
+        fetch('kpop.ii_groups')
+      end
+
+      ##
+      # Produces the name of a 2010's K-Pop group.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Kpop.iii_groups #=> "Trouble Maker"
+      #
+      # @faker.version 1.8.5
+      def iii_groups
+        fetch('kpop.iii_groups')
+      end
+
+      ##
+      # Produces the name of a K-Pop girl group.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Kpop.girl_groups #=> "2NE1"
+      #
+      # @faker.version 1.8.5
+      def girl_groups
+        fetch('kpop.girl_groups')
+      end
+
+      ##
+      # Produces the name of a K-Pop boy band.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Kpop.boy_bands #=> "Exo"
+      #
+      # @faker.version 1.8.5
+      def boy_bands
+        fetch('kpop.boy_bands')
+      end
+
+      ##
+      # Produces the name of a solo K-Pop artist.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Kpop.solo #=> "T.O.P"
+      #
+      # @faker.version 1.8.5
+      def solo
+        fetch('kpop.solo')
+      end
+    end
+  end
+end