faker 1.8.2 → 2.23.0

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,63 @@
+# frozen_string_literal: true
+
+module Faker
+  class String < Base
+    class << self
+      ##
+      # 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
+
+      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

data/lib/faker/default/stripe.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module Faker
+  class Stripe < Base
+    class << self
+      ##
+      # Produces a random valid card number.
+      #
+      # @param card_type [String] Specific valid card type.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Stripe.valid_card #=> "4242424242424242"
+      #   Faker::Stripe.valid_card(card_type: "visa_debit") #=> "4000056655665556"
+      #
+      # @faker.version 1.9.0
+      def valid_card(legacy_card_type = NOT_GIVEN, card_type: nil)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :card_type if legacy_card_type != NOT_GIVEN
+        end
+
+        valid_cards = translate('faker.stripe.valid_cards').keys
+
+        if card_type.nil?
+          card_type = sample(valid_cards).to_s
+        else
+          unless valid_cards.include?(card_type.to_sym)
+            raise ArgumentError,
+                  "Valid credit cards argument can be left blank or include #{valid_cards.join(', ')}"
+          end
+        end
+
+        fetch("stripe.valid_cards.#{card_type}")
+      end
+
+      ##
+      # Produces a random valid Stripe token.
+      #
+      # @param card_type [String] Specific valid card type.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Stripe.valid_token #=> "tok_visa"
+      #   Faker::Stripe.valid_token(card_type: "mc_debit") #=> "tok_mastercard_debit"
+      #
+      # @faker.version 1.9.0
+      def valid_token(legacy_card_type = NOT_GIVEN, card_type: nil)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :card_type if legacy_card_type != NOT_GIVEN
+        end
+
+        valid_tokens = translate('faker.stripe.valid_tokens').keys
+
+        if card_type.nil?
+          card_type = sample(valid_tokens).to_s
+        else
+          unless valid_tokens.include?(card_type.to_sym)
+            raise ArgumentError,
+                  "Valid credit cards argument can be left blank or include #{valid_tokens.join(', ')}"
+          end
+        end
+
+        fetch("stripe.valid_tokens.#{card_type}")
+      end
+
+      ##
+      # Produces a random invalid card number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Stripe.invalid_card #=> "4000000000000002"
+      #   Faker::Stripe.invalid_card(card_error: "addressZipFail") #=> "4000000000000010"
+      #
+      # @faker.version 1.9.0
+      def invalid_card(legacy_card_error = NOT_GIVEN, card_error: nil)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :card_error if legacy_card_error != NOT_GIVEN
+        end
+
+        invalid_cards = translate('faker.stripe.invalid_cards').keys
+
+        if card_error.nil?
+          card_error = sample(invalid_cards).to_s
+        else
+          unless invalid_cards.include?(card_error.to_sym)
+            raise ArgumentError,
+                  "Invalid credit cards argument can be left blank or include #{invalid_cards.join(', ')}"
+          end
+        end
+
+        fetch("stripe.invalid_cards.#{card_error}")
+      end
+
+      ##
+      # Produces a random month in two digits format.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Stripe.month #=> "10"
+      #
+      # @faker.version 1.9.0
+      def month
+        format('%02d', rand_in_range(1, 12))
+      end
+
+      ##
+      # Produces a random year that is always in the future.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Stripe.year #=> "2018" # This will always be a year in the future
+      #
+      # @faker.version 1.9.0
+      def year
+        start_year = ::Time.new.year + 1
+        rand_in_range(start_year, start_year + 5).to_s
+      end
+
+      ##
+      # Produces a random ccv number.
+      #
+      # @param card_type [String] Specific valid card type.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Stripe.ccv #=> "123"
+      #   Faker::Stripe.ccv(card_type: "amex") #=> "1234"
+      #
+      # @faker.version 1.9.0
+      def ccv(legacy_card_type = NOT_GIVEN, card_type: nil)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :card_type if legacy_card_type != NOT_GIVEN
+        end
+
+        (card_type.to_s == 'amex' ? rand_in_range(1000, 9999) : rand_in_range(100, 999)).to_s
+      end
+    end
+  end
+end

data/lib/faker/default/subscription.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Faker
+  class Subscription < Base
+    ##
+    # Produces the name of a subscription plan.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Subscription.plan #=> "Platinum"
+    #
+    # @faker.version 1.9.2
+    def self.plan
+      fetch('subscription.plans')
+    end
+
+    ##
+    # Produces a subscription status.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Subscription.status #=> "Active"
+    #
+    # @faker.version 1.9.2
+    def self.status
+      fetch('subscription.statuses')
+    end
+
+    ##
+    # Produces the name of a payment method.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Subscription.payment_method #=> "PayPal"
+    #
+    # @faker.version 1.9.2
+    def self.payment_method
+      fetch('subscription.payment_methods')
+    end
+
+    ##
+    # Produces the name of a subscription term.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Subscription.subscription_term #=> "Annual"
+    #
+    # @faker.version 1.9.2
+    def self.subscription_term
+      fetch('subscription.subscription_terms')
+    end
+
+    ##
+    # Produces the name of a payment term.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Subscription.payment_term #=> "Monthly"
+    #
+    # @faker.version 1.9.2
+    def self.payment_term
+      fetch('subscription.payment_terms')
+    end
+  end
+end

data/lib/faker/default/superhero.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Faker
+  class Superhero < Base
+    class << self
+      ##
+      # Produces a superpower.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Superhero.power #=> "Photokinesis"
+      #
+      # @faker.version 1.6.2
+      def power
+        fetch('superhero.power')
+      end
+
+      ##
+      # Produces a superhero name prefix.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Superhero.prefix #=> "the Fated"
+      #
+      # @faker.version 1.6.2
+      def prefix
+        fetch('superhero.prefix')
+      end
+
+      ##
+      # Produces a superhero name suffix.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Superhero.suffix #=> "Captain"
+      #
+      # @faker.version 1.6.2
+      def suffix
+        fetch('superhero.suffix')
+      end
+
+      ##
+      # Produces a superhero descriptor.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Superhero.descriptor #=> "Bizarro"
+      #
+      # @faker.version 1.6.2
+      def descriptor
+        fetch('superhero.descriptor')
+      end
+
+      ##
+      # Produces a random superhero name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Superhero.name #=> "Magnificent Shatterstar"
+      #
+      # @faker.version 1.6.2
+      def name
+        parse('superhero.name')
+      end
+    end
+  end
+end

data/lib/faker/default/tea.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Faker
+  class Tea < Base
+    flexible :tea
+
+    class << self
+      ##
+      # Produces a random variety or blend of tea.
+      #
+      # @param type [String, nil] the type of tea to query for (valid types: 'Black', 'Green', 'Oolong', 'White', and 'Herbal')
+      # @return [String] a variety of tea
+      #
+      # @example
+      #   Faker::Tea.variety
+      #     #=> "Earl Grey"
+      #
+      # @example
+      #   Faker::Tea.variety(type: 'Green')
+      #     #=> "Jasmine"
+      # @faker.version next
+      def variety(type: nil)
+        type ||= fetch('tea.type')
+        fetch "tea.variety.#{type.downcase}"
+      end
+
+      ##
+      # Produces a random type of tea.
+      #
+      # @return [String] a type of tea
+      #
+      # @example
+      #   Faker::Tea.type
+      #     #=> "Green"
+      # @faker.version next
+      def type
+        fetch 'tea.type'
+      end
+    end
+  end
+end

data/lib/faker/default/team.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Faker
+  class Team < Base
+    flexible :team
+
+    class << self
+      ##
+      # Produces a team name from a state and a creature.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Team.name #=> "Oregon vixens"
+      #
+      # @faker.version 1.3.0
+      def name
+        parse('team.name')
+      end
+
+      ##
+      # Produces a team creature.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Team.creature #=> "geese"
+      #
+      # @faker.version 1.3.0
+      def creature
+        fetch('team.creature')
+      end
+
+      ##
+      # Produces a team state.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Team.state #=> "Oregon"
+      #
+      # @faker.version 1.3.0
+      def state
+        fetch('address.state')
+      end
+
+      ##
+      # Produces a team sport.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Team.sport #=> "Lacrosse"
+      #
+      # @faker.version 1.5.0
+      def sport
+        fetch('team.sport')
+      end
+
+      ##
+      # Produces the name of a team mascot.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Team.mascot #=> "Hugo"
+      #
+      # @faker.version 1.8.1
+      def mascot
+        fetch('team.mascot')
+      end
+    end
+  end
+end