faker 2.11.0 → 2.12.0

data/lib/faker/default/university.rb

@@ -5,22 +5,67 @@ module Faker
     flexible :university
 
     class << self
+      ##
+      # Produces a random university name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::University.name #=> "Eastern Mississippi Academy"
+      #
+      # @faker.version 1.5.0
       def name
         parse('university.name')
       end
 
+      ##
+      # Produces a random university prefix.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::University.prefix #=> "Western"
+      #
+      # @faker.version 1.5.0
       def prefix
         fetch('university.prefix')
       end
 
+      ##
+      # Produces a random university suffix.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::University.suffix #=> "Academy"
+      #
+      # @faker.version 1.5.0
       def suffix
         fetch('university.suffix')
       end
 
+      ##
+      # Produces a random greek organization.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::University.greek_organization #=> "BEX"
+      #
+      # @faker.version 1.5.0
       def greek_organization
         Array.new(3) { |_| sample(greek_alphabet) }.join
       end
 
+      ##
+      # Produces a greek alphabet.
+      #
+      # @return [Array]
+      #
+      # @example
+      #   Faker::University.greek_alphabet #=> ["Α", "B", "Γ", "Δ", ...]
+      #
+      # @faker.version 1.5.0
       def greek_alphabet
         %w[Α B Γ Δ E Z H Θ I K Λ M N Ξ
            O Π P Σ T Y Φ X Ψ Ω]

data/lib/faker/default/vehicle.rb

@@ -14,18 +14,54 @@ module Faker
     SG_CHECKSUM_CHARS = 'AYUSPLJGDBZXTRMKHEC'
 
     class << self
+      # Produces a random vehicle VIN number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.vin #=> "LLDWXZLG77VK2LUUF"
+      #
+      # @faker.version 1.6.4
       def vin
         regexify(VIN_REGEX)
       end
 
+      # Produces a random vehicle manufacturer.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.manufacture #=> "Lamborghini"
+      #
+      # @faker.version 1.6.4
       def manufacture
         fetch('vehicle.manufacture')
       end
 
+      ##
+      # Produces a random vehicle make.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.make #=> "Honda"
+      #
+      # @faker.version 1.6.4
       def make
         fetch('vehicle.makes')
       end
 
+      ##
+      # Produces a random vehicle model.
+      #
+      # @param make_of_model [String] Specific valid vehicle make.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.model #=> "A8"
+      #   Faker::Vehicle.model(make_of_model: 'Toyota') #=> "Prius"
+      #
+      # @faker.version 1.6.4
       def model(legacy_make_of_model = NOT_GIVEN, make_of_model: '')
         warn_for_deprecated_arguments do |keywords|
           keywords << :make_of_model if legacy_make_of_model != NOT_GIVEN
@@ -36,59 +72,183 @@ module Faker
         fetch("vehicle.models_by_make.#{make_of_model}")
       end
 
+      ##
+      # Produces a random vehicle make and model.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.make_and_model #=> "Dodge Charger"
+      #
+      # @faker.version 1.6.4
       def make_and_model
         m = make
 
         "#{m} #{model(make_of_model: m)}"
       end
 
+      ##
+      # Produces a random vehicle style.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.style #=> "ESi"
+      #
+      # @faker.version 1.6.4
       def style
         fetch('vehicle.styles')
       end
 
+      ##
+      # Produces a random vehicle color.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.color #=> "Red"
+      #
+      # @faker.version 1.6.4
       def color
         fetch('vehicle.colors')
       end
 
+      ##
+      # Produces a random vehicle transmission.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.transmission #=> "Automanual"
+      #
+      # @faker.version 1.6.4
       def transmission
         fetch('vehicle.transmissions')
       end
 
+      ##
+      # Produces a random vehicle drive type.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.drive_type #=> "4x2/2-wheel drive"
+      #
+      # @faker.version 1.6.4
       def drive_type
         fetch('vehicle.drive_types')
       end
 
+      ##
+      # Produces a random vehicle fuel type.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.fuel_type #=> "Diesel"
+      #
+      # @faker.version 1.6.4
       def fuel_type
         fetch('vehicle.fuel_types')
       end
 
+      ##
+      # Produces a random car type.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.car_type #=> "Sedan"
+      #
+      # @faker.version 1.6.4
       def car_type
         fetch('vehicle.car_types')
       end
 
+      ##
+      # Produces a random engine cylinder count.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.engine_size #=> 6
+      #   Faker::Vehicle.engine #=> 4
+      #
+      # @faker.version 1.6.4
       def engine
         "#{sample(fetch_all('vehicle.doors'))} #{fetch('vehicle.cylinder_engine')}"
       end
 
       alias engine_size engine
 
+      ##
+      # Produces a random list of car options.
+      #
+      # @return [Array<String>]
+      #
+      # @example
+      #   Faker::Vehicle.car_options #=> ["DVD System", "MP3 (Single Disc)", "Tow Package", "CD (Multi Disc)", "Cassette Player", "Bucket Seats", "Cassette Player", "Leather Interior", "AM/FM Stereo", "Third Row Seats"]
+      #
+      # @faker.version 1.6.4
       def car_options
         Array.new(rand(5...10)) { fetch('vehicle.car_options') }
       end
 
+      ##
+      # Produces a random list of standard specs.
+      #
+      # @return [Array<String>]
+      #
+      # @example
+      #   Faker::Vehicle.standard_specs #=> ["Full-size spare tire w/aluminum alloy wheel", "Back-up camera", "Carpeted cargo area", "Silver accent IP trim finisher -inc: silver shifter finisher", "Back-up camera", "Water-repellent windshield & front door glass", "Floor carpeting"]
+      #
+      # @faker.version 1.6.4
       def standard_specs
         Array.new(rand(5...10)) { fetch('vehicle.standard_specs') }
       end
 
+      ##
+      # Produces a random vehicle door count.
+      #
+      # @return [Integer]
+      #
+      # @example
+      #   Faker::Vehicle.doors #=> 1
+      #   Faker::Vehicle.door_count #=> 3
+      #
+      # @faker.version 1.6.4
       def doors
         sample(fetch_all('vehicle.doors'))
       end
       alias door_count doors
 
+      ##
+      # Produces a random car year between 1 and 15 years ago.
+      #
+      # @return [Integer]
+      #
+      # @example
+      #   Faker::Vehicle.year #=> 2008
+      #
+      # @faker.version 1.6.4
       def year
         Faker::Time.backward(days: rand_in_range(365, 5475), period: :all, format: '%Y').to_i
       end
 
+      ##
+      # Produces a random mileage/kilometrage for a vehicle.
+      #
+      # @param min [Integer] Specific minimum limit for mileage generation.
+      # @param max [Integer] Specific maximum limit for mileage generation.
+      # @return [Integer]
+      #
+      # @example
+      #   Faker::Vehicle.mileage #=> 26961
+      #   Faker::Vehicle.mileage(min: 50_000) #=> 81557
+      #   Faker::Vehicle.mileage(min: 50_000, max: 250_000) #=> 117503
+      #   Faker::Vehicle.kilometrage #=> 35378
+      #
+      # @faker.version 1.6.4
       def mileage(legacy_min = NOT_GIVEN, legacy_max = NOT_GIVEN, min: MILEAGE_MIN, max: MILEAGE_MAX)
         warn_for_deprecated_arguments do |keywords|
           keywords << :min if legacy_min != NOT_GIVEN
@@ -100,17 +260,37 @@ module Faker
 
       alias kilometrage mileage
 
-      def license_plate(legacy_state_abreviation = NOT_GIVEN, state_abreviation: '')
+      ##
+      # Produces a random license plate number.
+      #
+      # @param state_abbreviation [String] Two letter state abbreviation for license plate generation.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.license_plate #=> "DEP-2483"
+      #   Faker::Vehicle.license_plate(state_abbreviation: 'FL') #=> "977 UNU"
+      #
+      # @faker.version 1.6.4
+      def license_plate(legacy_state_abreviation = NOT_GIVEN, state_abbreviation: '')
         warn_for_deprecated_arguments do |keywords|
-          keywords << :state_abreviation if legacy_state_abreviation != NOT_GIVEN
+          keywords << :state_abbreviation if legacy_state_abreviation != NOT_GIVEN
         end
 
-        return regexify(bothify(fetch('vehicle.license_plate'))) if state_abreviation.empty?
+        return regexify(bothify(fetch('vehicle.license_plate'))) if state_abbreviation.empty?
 
-        key = 'vehicle.license_plate_by_state.' + state_abreviation
+        key = 'vehicle.license_plate_by_state.' + state_abbreviation
         regexify(bothify(fetch(key)))
       end
 
+      ##
+      # Produces a random license plate number for Singapore.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Vehicle.singapore_license_plate #=> "SLV1854M"
+      #
+      # @faker.version 1.6.4
       def singapore_license_plate
         key = 'vehicle.license_plate'
         plate_number = regexify(bothify(fetch(key)))

data/lib/faker/default/verb.rb

@@ -3,22 +3,67 @@
 module Faker
   class Verb < Base
     class << self
+      ##
+      # Produces the base form of a random verb.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verb.base #=> "hurt"
+      #
+      # @faker.version 1.9.0
       def base
         fetch('verbs.base')
       end
 
+      ##
+      # Produces a random verb in past tense.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verb.past #=> "completed"
+      #
+      # @faker.version 1.9.0
       def past
         fetch('verbs.past')
       end
 
+      ##
+      # Produces a random verb in past participle.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verb.past_participle #=> "digested"
+      #
+      # @faker.version 1.9.0
       def past_participle
         fetch('verbs.past_participle')
       end
 
+      ##
+      # Produces a random verb in simple present.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verb.simple_present #=> "climbs"
+      #
+      # @faker.version 1.9.0
       def simple_present
         fetch('verbs.simple_present')
       end
 
+      ##
+      # Produces a random verb in the .ing form.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Verb.ing_form #=> "causing"
+      #
+      # @faker.version 1.9.0
       def ing_form
         fetch('verbs.ing_form')
       end

data/lib/faker/games/control.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class Control < Base
+      class << self
+        ##
+        # Produces the name of a character from Control.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.character #=> "Jesse Faden"
+        #
+        # @faker.version next
+        def character
+          fetch('games.control.character')
+        end
+
+        ##
+        # Produces the name of a location from Control.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.character #=> "Dimensional Research"
+        #
+        # @faker.version next
+        def location
+          fetch('games.control.location')
+        end
+
+        ##
+        # Produces the name of an Object of Power (OoP)
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.object_of_power #=> "Hotline"
+        #
+        # @faker.version next
+        def object_of_power
+          fetch('games.control.object_of_power')
+        end
+
+        ##
+        # Produces the name of an Altered Item
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.altered_item #=> "Rubber Duck"
+        #
+        # @faker.version next
+        def altered_item
+          fetch('games.control.altered_item')
+        end
+
+        ##
+        # Produces the location of an Altered World Event (AWE)
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.altered_world_event #=> "Ordinary, Wisconsin"
+        #
+        # @faker.version next
+        def altered_world_event
+          fetch('games.control.altered_world_event')
+        end
+
+        ##
+        # Produces a line from the Hiss incantation
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.hiss #=> "Push the fingers through the surface into the wet."
+        #
+        # @faker.version next
+        def hiss
+          fetch('games.control.hiss')
+        end
+
+        ##
+        # < Produces a line/quote/message from The Board >
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.the_board #=> "< You/We wield the Gun/You. The Board appoints you. Congratulations, Director. >"
+        #
+        # @faker.version next
+        def the_board
+          fetch('games.control.the_board')
+        end
+
+        ##
+        # Produces a quote from Control
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.quote #=> "He never liked fridge duty"
+        #
+        # @faker.version next
+        def quote
+          fetch('games.control.quote')
+        end
+      end
+    end
+  end
+end