faker 2.0.0 → 3.8.0

data/lib/faker/default/south_africa.rb

@@ -3,46 +3,136 @@
 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
+        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
+        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
+        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

data/lib/faker/default/space.rb

@@ -3,59 +3,186 @@
 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).to_s + ' ' + fetch('space.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

data/lib/faker/default/sport.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Faker
+  class Sport < Base
+    class << self
+      ##
+      # Produces a sport from the modern olympics or paralympics, summer or winter.
+      #
+      # @param include_ancient [Boolean] If true, may produce a sport from the ancient olympics
+      # @param include_unusual [Boolean] If true, may produce an unusual (definitely not olympic) sport
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.sport #=> "Football"
+      # @example
+      #   Faker::Sport.sport(include_ancient: true) #=> "Chariot racing"
+      # @example
+      #   Faker::Sport.sport(include_unsual: true) #=> "Flugtag/Birdman"
+      # @example
+      #   Faker::Sport.sport(include_ancient:true, include_unusual: true) #=> "Water polo"
+      #
+      # @faker.version next
+      def sport(include_ancient: false, include_unusual: false)
+        sports = []
+        sports.concat(
+          fetch_all('sport.summer_olympics'),
+          fetch_all('sport.summer_paralympics'),
+          fetch_all('sport.winter_olympics'),
+          fetch_all('sport.winter_paralympics')
+        )
+        sports.concat(fetch_all('sport.ancient_olympics')) if include_ancient
+        sports.concat(fetch_all('sport.unusual')) if include_unusual
+        sample(sports)
+      end
+
+      ##
+      # Produces a sport from the summer olympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.summer_olympics_sport #=> "Archery"
+      #
+      # @faker.version next
+      def summer_olympics_sport
+        fetch('sport.summer_olympics')
+      end
+
+      ##
+      # Produces a sport from the winter olympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.winter_olympics_sport #=> "Bobsleigh"
+      #
+      # @faker.version next
+      def winter_olympics_sport
+        fetch('sport.winter_olympics')
+      end
+
+      ##
+      # Produces a sport from the summer paralympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.summer_paralympics_sport #=> "Wheelchair Basketball"
+      #
+      # @faker.version next
+      def summer_paralympics_sport
+        fetch('sport.summer_paralympics')
+      end
+
+      ##
+      # Produces a sport from the winter paralympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.winter_paralympics_sport #=> "Para Ice Hockey"
+      #
+      # @faker.version next
+      def winter_paralympics_sport
+        fetch('sport.winter_paralympics')
+      end
+
+      ##
+      # Produces an unusual sport.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.unusual_sport #=> "Camel Jumping"
+      #
+      # @faker.version next
+      def unusual_sport
+        fetch('sport.unusual')
+      end
+
+      ##
+      # Produces a sport from the ancient olympics.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Sport.ancient_olympics_sport #=> "Pankration"
+      #
+      # @faker.version next
+      def ancient_olympics_sport
+        fetch('sport.ancient_olympics')
+      end
+    end
+  end
+end

data/lib/faker/default/string.rb

@@ -3,6 +3,20 @@
 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(length: 32)
         utf8string select_a length
       end
@@ -10,7 +24,7 @@ module Faker
       private
 
       def select_a(length)
-        if length.class.included_modules.include? Enumerable
+        if length.class.include?(Enumerable)
           select_a sample(length.to_enum.to_a)
         else
           length # recursive base case
@@ -34,9 +48,9 @@ module Faker
 
       def utf8character
         sample([
-                 rand(32..90), # latin alphabet
-                 rand(128),             # 7-bit ASCII
-                 rand(0xd800),          # utf-8 codepoints below utf-16 surrogate halves
+                 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

data/lib/faker/default/stripe.rb

@@ -3,6 +3,17 @@
 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(card_type: nil)
         valid_cards = translate('faker.stripe.valid_cards').keys
 
@@ -15,9 +26,20 @@ module Faker
           end
         end
 
-        fetch('stripe.valid_cards.' + card_type)
+        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(card_type: nil)
         valid_tokens = translate('faker.stripe.valid_tokens').keys
 
@@ -30,9 +52,19 @@ module Faker
           end
         end
 
-        fetch('stripe.valid_tokens.' + card_type)
+        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(card_error: nil)
         invalid_cards = translate('faker.stripe.invalid_cards').keys
 
@@ -45,18 +77,47 @@ module Faker
           end
         end
 
-        fetch('stripe.invalid_cards.' + card_error)
+        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(card_type: nil)
         (card_type.to_s == 'amex' ? rand_in_range(1000, 9999) : rand_in_range(100, 999)).to_s
       end

data/lib/faker/default/subscription.rb

@@ -2,22 +2,67 @@
 
 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