faker 2.10.2 → 2.15.0

data/lib/faker/default/computer.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Faker
+  class Computer < Base
+    class << self
+      ##
+      # Produces the name of a computer platform.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Computer.platform #=> "Linux"
+      #
+      # @faker.version 2.12.0
+      def platform
+        fetch('computer.platform')
+      end
+
+      ##
+      # Produces the name of a computer type.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Computer.type #=> "server"
+      #
+      # @faker.version 2.12.0
+      def type
+        fetch('computer.type')
+      end
+
+      ##
+      # Produces the name of a computer os.
+      #
+      # @param platform [String] optionally specify the platform `linux`, `macos`, or `windows`.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Computer.os #=> "RHEL 6.10"
+      #
+      # @faker.version 2.12.0
+      def os(platform: self.platform)
+        platform = self.platform unless fetch_all('computer.platform').include?(platform)
+        fetch("computer.os.#{platform.downcase}")
+      end
+
+      ##
+      # Produces a string with computer platform and os
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Computer.stack #=> "Linux, RHEL 6.10"
+      #
+      # @faker.version 2.12.0
+      def stack
+        platform = self.platform
+        os = fetch("computer.os.#{platform.downcase}")
+        "#{platform}, #{os}"
+      end
+    end
+  end
+end

data/lib/faker/default/construction.rb

@@ -2,26 +2,80 @@
 
 module Faker
   class Construction < Base
+    ##
+    # Produces a random material.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Construction.material #=> "Wood"
+    #
+    # @faker.version 1.9.2
     def self.material
       fetch('construction.materials')
     end
 
+    ##
+    # Produces a random heavy equipment.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Construction.heavy_equipment #=> "Excavator"
+    #
+    # @faker.version 1.9.2
     def self.heavy_equipment
       fetch('construction.heavy_equipment')
     end
 
+    ##
+    # Produces a random trade.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Construction.trade #=> "Carpenter"
+    #
+    # @faker.version 1.9.2
     def self.trade
       fetch('construction.trades')
     end
 
+    ##
+    # Produces a random subcontract category.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Construction.subcontract_category #=> "Curb & Gutter"
+    #
+    # @faker.version 1.9.2
     def self.subcontract_category
       fetch('construction.subcontract_categories')
     end
 
+    ##
+    # Produces a random standard cost code.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Construction.standard_cost_code #=> "1-000 - Purpose"
+    #
+    # @faker.version 1.9.2
     def self.standard_cost_code
       fetch('construction.standard_cost_codes')
     end
 
+    ##
+    # Produces a random role.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Construction.role #=> "Engineer"
+    #
+    # @faker.version 1.9.2
     def self.role
       fetch('construction.roles')
     end

data/lib/faker/default/cosmere.rb

@@ -4,42 +4,132 @@ module Faker
   class Cosmere < Base
     flexible :cosmere
     class << self
+      ##
+      # Produces a random aon.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Cosmere.aon #=> "Rao"
+      #
+      # @faker.version 1.9.2
       def aon
         sample(aons)
       end
 
+      ##
+      # Produces a random shard world.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Cosmere.shard_world #=> "Yolen"
+      #
+      # @faker.version 1.9.2
       def shard_world
         sample(shard_worlds)
       end
 
+      ##
+      # Produces a random shard.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Cosmere.shard #=> "Ambition"
+      #
+      # @faker.version 1.9.2
       def shard
         sample(shards)
       end
 
+      ##
+      # Produces a random surge.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Cosmere.surge #=> "Progression"
+      #
+      # @faker.version 1.9.2
       def surge
         sample(surges)
       end
 
+      ##
+      # Produces a random knight radiant.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Cosmere.knight_radiant #=> "Truthwatcher"
+      #
+      # @faker.version 1.9.2
       def knight_radiant
         sample(knights_radiant)
       end
 
+      ##
+      # Produces a random metal.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Cosmere.metal #=> "Brass"
+      #
+      # @faker.version 1.9.2
       def metal
         sample(metals)
       end
 
+      ##
+      # Produces a random allomancer.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Cosmere.allomancer #=> "Coinshot"
+      #
+      # @faker.version 1.9.2
       def allomancer
         sample(allomancers)
       end
 
+      ##
+      # Produces a random feruchemist.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Cosmere.feruchemist #=> "Archivist"
+      #
+      # @faker.version 1.9.2
       def feruchemist
         sample(feruchemists)
       end
 
+      ##
+      # Produces a random herald.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Cosmere.herald #=> "Ishar"
+      #
+      # @faker.version 1.9.2
       def herald
         sample(heralds)
       end
 
+      ##
+      # Produces a random spren.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Cosmere.spren #=> "Flamespren"
+      #
+      # @faker.version 1.9.2
       def spren
         sample(sprens)
       end

data/lib/faker/default/crypto_coin.rb

@@ -7,6 +7,15 @@ module Faker
       ACRONYM = 1
       URL_LOGO = 2
 
+      ##
+      # Produces a random crypto coin name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::CryptoCoin.coin_name #=> "Bitcoin"
+      #
+      # @faker.version 1.9.2
       def coin_name(legacy_coin = NOT_GIVEN, coin: coin_array)
         warn_for_deprecated_arguments do |keywords|
           keywords << :coin if legacy_coin != NOT_GIVEN
@@ -15,6 +24,15 @@ module Faker
         coin[COIN_NAME]
       end
 
+      ##
+      # Produces a random crypto coin acronym.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::CryptoCoin.acronym #=> "BTC"
+      #
+      # @faker.version 1.9.2
       def acronym(legacy_coin = NOT_GIVEN, coin: coin_array)
         warn_for_deprecated_arguments do |keywords|
           keywords << :coin if legacy_coin != NOT_GIVEN
@@ -23,6 +41,15 @@ module Faker
         coin[ACRONYM]
       end
 
+      ##
+      # Produces a random crypto coin logo url.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::CryptoCoin.url_logo #=> "https://i.imgur.com/EFz61Ei.png"
+      #
+      # @faker.version 1.9.2
       def url_logo(legacy_coin = NOT_GIVEN, coin: coin_array)
         warn_for_deprecated_arguments do |keywords|
           keywords << :coin if legacy_coin != NOT_GIVEN
@@ -31,10 +58,28 @@ module Faker
         coin[URL_LOGO]
       end
 
+      ##
+      # Produces a random crypto coin's name, acronym and logo in an array.
+      #
+      # @return [Array<String>]
+      #
+      # @example
+      #   Faker::CryptoCoin.coin_array #=> ["Dash", "DASH", "https://i.imgur.com/2uX91cb.png"]
+      #
+      # @faker.version 1.9.2
       def coin_array
         fetch('crypto_coin.coin').split(',').map(&:strip)
       end
 
+      ##
+      # Produces a random crypto coin's name, acronym and logo in a hash.
+      #
+      # @return [Hash]
+      #
+      # @example
+      #   Faker::CryptoCoin.coin_hash {:name=>"Ethereum", :acronym=>"ETH", :url_logo=>"https://i.imgur.com/uOPFCXj.png"}
+      #
+      # @faker.version 1.9.2
       def coin_hash
         coin = coin_array
 

data/lib/faker/default/date.rb

@@ -6,13 +6,15 @@ module Faker
       ##
       # Produce a random date between two dates.
       #
-      # @param from [Date] The start of the usable date range.
-      # @param to [Date] The end of the usable date range.
+      # @param from [Date, String] The start of the usable date range.
+      # @param to [Date, String] The end of the usable date range.
       # @return [Date]
       #
-      # @example
-      #   Faker::Date.between(from: 2.days.ago, to: Date.today)
-      #     #=> #<Date: 2014-09-24>
+      # @example if used with or without Rails (Active Support)
+      #   Faker::Date.between(from: '2014-09-23', to: '2014-09-25') #=> #<Date: 2014-09-24>
+      #
+      # @example if used with Rails (Active Support)
+      #   Faker::Date.between(from: 2.days.ago, to: Date.today) #=> #<Date: 2014-09-24>
       #
       # @faker.version 1.0.0
       def between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from:, to:)
@@ -32,14 +34,16 @@ module Faker
       ##
       # Produce a random date between two dates.
       #
-      # @param from [Date] The start of the usable date range.
-      # @param to [Date] The end of the usable date range.
-      # @param excepted [Date] A date to exclude.
+      # @param from [Date, String] The start of the usable date range.
+      # @param to [Date, String] The end of the usable date range.
+      # @param excepted [Date, String] A date to exclude.
       # @return [Date]
       #
-      # @example
-      #   Faker::Date.between_except(from: 1.year.ago, to: 1.year.from_now, excepted: Date.today)
-      #     #=> #<Date: 2014-10-03>
+      # @example if used with or without Rails (Active Support)
+      #   Faker::Date.between_except(from: '2014-09-23', to: '2015-09-25', excepted: '2015-01-24') #=> #<Date: 2014-10-03>
+      #
+      # @example if used with Rails (Active Support)
+      #   Faker::Date.between_except(from: 1.year.ago, to: 1.year.from_now, excepted: Date.today) #=> #<Date: 2014-10-03>
       #
       # @faker.version 1.6.2
       def between_except(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, legacy_excepted = NOT_GIVEN, from:, to:, excepted:)
@@ -149,7 +153,7 @@ module Faker
       # @example
       #   Faker::Date.in_date_period(month: 2) #=> #<Date: 2019-02-26>
       #
-      # @faker.version next
+      # @faker.version 2.13.0
       def in_date_period(month: nil, year: ::Date.today.year)
         from = ::Date.new(year, month || 1, 1)
         to = ::Date.new(year, month || 12, ::Date.civil(year, month || 12, -1).day)

data/lib/faker/default/driving_licence.rb

@@ -6,6 +6,23 @@ module Faker
     NI_CHANCE = 0.03 # NI Pop is about 3% of total UK population
 
     class << self
+      ##
+      # Produces a random British driving licence number.
+      #
+      # @param last_name [String] The last name of the driving licence's owner.
+      # @param initials [String] The initials of the driving licence's owner.
+      # @param gender [String] The gender of the driving licence's owner.
+      # @param date_of_birth [String] The date of birth of the driving licence's owner.
+      # @return [String]
+      #
+      # @example
+      #   Faker::DrivingLicence.british_driving_licence        #=> "MCDER712081VF7EK"
+      #   Faker::DrivingLicence.british_driving_licence(last_name: "O'Carroll",
+      #                                                 initials: "J",
+      #                                                 gender: :female,
+      #                                                 date_of_birth: Date.parse("1986-10-24")) #=> "OCARR815246J91HT"
+      #
+      # @faker.version 1.9.2
       # rubocop:disable Metrics/ParameterLists
       def british_driving_licence(legacy_last_name = NOT_GIVEN, legacy_initials = NOT_GIVEN, legacy_gender = NOT_GIVEN, legacy_date_of_birth = NOT_GIVEN, last_name: Faker::Name.last_name, initials: Faker::Name.initials, gender: random_gender, date_of_birth: Faker::Date.birthday(min_age: 18, max_age: 65))
         # rubocop:enable Metrics/ParameterLists
@@ -24,10 +41,35 @@ module Faker
         ].join
       end
 
+      ##
+      # Produces a random Northern Irish licence number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::DrivingLicence.northern_irish_driving_licence #=> "70702548"
+      #
+      # @faker.version 1.9.2
       def northern_irish_driving_licence
         Faker::Number.number(digits: 8).to_s
       end
 
+      ##
+      # Produces a random UK driving licence number in either GB or NI format, at a rate consistent with their relative populations
+      #
+      # @overload uk_driving_licence(last_name, initials, gender, date_of_birth)
+      #   @param last_name [String] The last name of the driving licence's owner.
+      #   @param initials [String] The initials of the driving licence's owner.
+      #   @param gender [String] The gender of the driving licence's owner.
+      #   @param date_of_birth [String] The date of birth of the driving licence's owner.
+      # @overload uk_driving_licence()
+      # @return [String]
+      #
+      # @example
+      #   Faker::DrivingLicence.uk_driving_licence             #=> "OCARR815246J91HT"
+      #   Faker::DrivingLicence.uk_driving_licence             #=> "70702548"
+      #
+      # @faker.version 1.9.2
       def uk_driving_licence(*args)
         if Faker::Config.random.rand < NI_CHANCE
           northern_irish_driving_licence
@@ -36,6 +78,23 @@ module Faker
         end
       end
 
+      ##
+      # Produces a random USA driving licence number by state code passed.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::DrivingLicence.usa_driving_licence                 #=> "V5598249"
+      #   Faker::DrivingLicence.usa_driving_licence('new mexico')   #=> "270692028"
+      #   Faker::DrivingLicence.usa_driving_licence('New Mexico')   #=> "68178637"
+      #
+      # @faker.version 2.14.0
+      def usa_driving_licence(state = 'California')
+        bothify(fetch("driving_licence.usa.#{state.to_s.strip.downcase.gsub(' ', '_')}"))
+      rescue I18n::MissingTranslationData => _e
+        raise InvalidStatePassed, "Invalid state code passed for USA, '#{state}'"
+      end
+
       private
 
       def random_gender
@@ -62,4 +121,10 @@ module Faker
       end
     end
   end
+
+  class InvalidStatePassed < StandardError
+    def initialize(msg = 'Invalid state code passed')
+      super
+    end
+  end
 end