faker 1.8.7 → 2.17.0

data/lib/faker/default/source.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Faker
+  class Source < Base
+    class << self
+      ##
+      # Produces source code for Hello World in a given language.
+      #
+      # @param lang [Symbol] The programming language to use
+      # @return [String]
+      #
+      # @example
+      #   Faker::Source.hello_world #=> "puts 'Hello World!'"
+      #
+      # @example
+      #   Faker::Source.hello_world(lang: :javascript)
+      #     #=> "alert('Hello World!');"
+      #
+      # @faker.version 1.9.0
+      def hello_world(legacy_lang = NOT_GIVEN, lang: :ruby)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :lang if legacy_lang != NOT_GIVEN
+        end
+
+        fetch("source.hello_world.#{lang}")
+      end
+
+      ##
+      # Produces source code for printing a string in a given language.
+      #
+      # @param str [String] The string to print
+      # @param lang [Symbol] The programming language to use
+      # @return [String]
+      #
+      # @example
+      #   Faker::Source.print #=> "puts 'faker_string_to_print'"
+      # @example
+      #   Faker::Source.print(str: 'foo bar', lang: :javascript)
+      #     #=> "console.log('foo bar');"
+      #
+      # @faker.version 1.9.0
+      def print(legacy_str = NOT_GIVEN, legacy_lang = NOT_GIVEN, str: 'some string', lang: :ruby)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :str if legacy_str != NOT_GIVEN
+        end
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :lang if legacy_lang != NOT_GIVEN
+        end
+        code = fetch("source.print.#{lang}")
+        code.gsub('faker_string_to_print', str)
+      end
+
+      ##
+      # Produces source code for printing 1 through 10 in a given language.
+      #
+      # @param lang [Symbol] The programming language to use
+      # @return [String]
+      #
+      # @example
+      #   Faker::Source.print_1_to_10 #=> "(1..10).each { |i| puts i }"
+      # @example
+      #   Faker::Source.print_1_to_10(lang: :javascript)
+      #   # => "for (let i=0; i<10; i++) {
+      #   #       console.log(i);
+      #   #    }"
+      #
+      # @faker.version 1.9.0
+      def print_1_to_10(legacy_lang = NOT_GIVEN, lang: :ruby)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :lang if legacy_lang != NOT_GIVEN
+        end
+        fetch("source.print_1_to_10.#{lang}")
+      end
+    end
+  end
+end

data/lib/faker/default/south_africa.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Faker
+  class SouthAfrica < Base
+    class << self
+      ##
+      # Produces a South African ID number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::SouthAfrica.id_number #=> "6110311856083"
+      #
+      # @faker.version 1.9.2
+      def id_number
+        Faker::IDNumber.south_african_id_number
+      end
+
+      ##
+      # Produces a valid South African ID number
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::SouthAfrica.valid_id_number #=> "6110311856083"
+      #
+      # @faker.version 1.9.2
+      def valid_id_number
+        Faker::IDNumber.valid_south_african_id_number
+      end
+
+      ##
+      # Produces an invalid South African ID number
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::SouthAfrica.invalid_id_number #=> "7018356904081"
+      #
+      # @faker.version 1.9.2
+      def invalid_id_number
+        Faker::IDNumber.invalid_south_african_id_number
+      end
+
+      ##
+      # Produces a South African phone number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::SouthAfrica.phone_number #=> "010 788 5009"
+      #
+      # @faker.version 1.9.2
+      def phone_number
+        with_locale 'en-ZA' do
+          Faker::PhoneNumber.phone_number
+        end
+      end
+
+      ##
+      # Produces a South African cell phone number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::SouthAfrica.cell_phone #=> "082 946 7470"
+      #
+      # @faker.version 1.9.2
+      def cell_phone
+        with_locale 'en-ZA' do
+          Faker::PhoneNumber.cell_phone
+        end
+      end
+
+      ##
+      # Produces a South African private company registration number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::SouthAfrica.pty_ltd_registration_number #=> "5301/714689/07"
+      #
+      # @faker.version 1.9.2
+      def pty_ltd_registration_number
+        Faker::Company.south_african_pty_ltd_registration_number
+      end
+
+      ##
+      # Produces a South African close corporation registration number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::SouthAfrica.close_corporation_registration_number #=> "CK74/7585/23"
+      #
+      # @faker.version 1.9.2
+      def close_corporation_registration_number
+        Faker::Company.south_african_close_corporation_registration_number
+      end
+
+      ##
+      # Produces a South African listed company registration number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::SouthAfrica.listed_company_registration_number #=> "7039/3135/06"
+      #
+      # @faker.version 1.9.2
+      def listed_company_registration_number
+        Faker::Company.south_african_listed_company_registration_number
+      end
+
+      ##
+      # Produces a South African trust registration number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::SouthAfrica.trust_registration_number #=> "IT38/6489900"
+      #
+      # @faker.version 1.9.2
+      def trust_registration_number
+        Faker::Company.south_african_trust_registration_number
+      end
+
+      ##
+      # Produces a South African VAT number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::SouthAfrica.vat_number #=> "ZA79494416181"
+      #
+      # @faker.version 1.9.2
+      def vat_number
+        Faker::Finance.vat_number(country: 'ZA')
+      end
+    end
+  end
+end

data/lib/faker/default/space.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module Faker
+  class Space < Base
+    flexible :space
+
+    class << self
+      ##
+      # Produces the name of a planet.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.planet #=> "Venus"
+      #
+      # @faker.version 1.6.4
+      def planet
+        fetch('space.planet')
+      end
+
+      ##
+      # Produces the name of a moon.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.moon #=> "Europa"
+      #
+      # @faker.version 1.6.4
+      def moon
+        fetch('space.moon')
+      end
+
+      ##
+      # Produces the name of a galaxy.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.galaxy #=> "Andromeda"
+      #
+      # @faker.version 1.6.4
+      def galaxy
+        fetch('space.galaxy')
+      end
+
+      ##
+      # Produces the name of a nebula.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.nebula #=> "Triffid Nebula"
+      #
+      # @faker.version 1.6.4
+      def nebula
+        fetch('space.nebula')
+      end
+
+      ##
+      # Produces the name of a star cluster.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.star_cluster #=> "Messier 70"
+      #
+      # @faker.version 1.6.4
+      def star_cluster
+        fetch('space.star_cluster')
+      end
+
+      ##
+      # Produces the name of a constellation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.constellation #=> "Orion"
+      #
+      # @faker.version 1.6.4
+      def constellation
+        fetch('space.constellation')
+      end
+
+      ##
+      # Produces the name of a star.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.star #=> "Proxima Centauri"
+      #
+      # @faker.version 1.6.4
+      def star
+        fetch('space.star')
+      end
+
+      ##
+      # Produces the name of a space agency.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.agency #=> "Japan Aerospace Exploration Agency"
+      #
+      # @faker.version 1.6.4
+      def agency
+        fetch('space.agency')
+      end
+
+      ##
+      # Produces a space agency abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.agency_abv #=> "NASA"
+      #
+      # @faker.version 1.6.4
+      def agency_abv
+        fetch('space.agency_abv')
+      end
+
+      ##
+      # Produces the name of a NASA spacecraft.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.nasa_space_craft #=> "Endeavour"
+      #
+      # @faker.version 1.6.4
+      def nasa_space_craft
+        fetch('space.nasa_space_craft')
+      end
+
+      ##
+      # Produces the name of a space company.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.company #=> "SpaceX"
+      #
+      # @faker.version 1.6.4
+      def company
+        fetch('space.company')
+      end
+
+      ##
+      # Produces a distance measurement.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.distance_measurement #=> "15 parsecs"
+      #
+      # @faker.version 1.6.4
+      def distance_measurement
+        "#{rand(10..100)} #{fetch('space.distance_measurement')}"
+      end
+
+      ##
+      # Produces the name of a meteorite.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.meteorite #=> "Ensisheim"
+      #
+      # @faker.version 1.7.0
+      def meteorite
+        fetch('space.meteorite')
+      end
+
+      ##
+      # Produces the name of a launch vehicle.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.launch_vehicle #=> "Saturn IV"
+      #
+      # @faker.version 1.9.0
+      def launch_vehicle
+        fetch('space.launch_vehicle')
+      end
+    end
+  end
+end

data/lib/faker/default/string.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Faker
+  class String < Base
+    class << self
+      # rubocop:disable Style/AsciiComments
+
+      ##
+      # Produces a random UTF-8 string with optional nested length selectors.
+      #
+      # @param length [Integer, Range, Array<Integer, Range, nil>] The length of produced string and/or specific UTF-8 characters to use.
+      # @return [String]
+      #
+      # @example
+      #   Faker::String.random #=> "3 뇦\u0017&y\u{3A109}$8^4* 녹豿4좘툢ꔾ쉙6ɉ\uA6 8TN畀챵|\"3쇤Ŵ"
+      #   Faker::String.random(length: 4) #=> "⼨%0*"
+      #   Faker::String.random(length: 3..12) #=> "\u{69FDC};秨툫"
+      #   Faker::String.random(length: [0, 6]) #=> "I轤𣴒P溟L"
+      #   Faker::String.random(length: [1, (2..5), [3, 6], nil]) #=> "葓L#ћ"
+      #
+      # @faker.version 1.9.0
+      def random(legacy_length = NOT_GIVEN, length: 32)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :length if legacy_length != NOT_GIVEN
+        end
+
+        utf8string select_a length
+      end
+      # rubocop:enable Style/AsciiComments
+
+      private
+
+      def select_a(length)
+        if length.class.included_modules.include? Enumerable
+          select_a sample(length.to_enum.to_a)
+        else
+          length # recursive base case
+        end
+      end
+
+      def utf8string(length)
+        ratio = char_space_ratio
+        (1..length.to_i).map do
+          space_or_utf8_char ratio
+        end.join
+      end
+
+      def space_or_utf8_char(ratio)
+        sample [32.chr(Encoding::UTF_8), [utf8character] * ratio].flatten
+      end
+
+      def char_space_ratio
+        sample [2, [3] * 5, [5] * 17, [7] * 11, 11, 191].flatten
+      end
+
+      def utf8character
+        sample([
+                 rand(32..90),           # latin alphabet
+                 rand(128),              # 7-bit ASCII
+                 rand(0xd800),           # utf-8 codepoints below utf-16 surrogate halves
+                 rand(57_344..1_114_111) # utf-8 codepoints above utf-16 surrogate halves
+               ]).chr(Encoding::UTF_8)
+      end
+    end
+  end
+end