faker 2.0.0 → 3.8.0

data/lib/faker/default/compass.rb

@@ -3,62 +3,197 @@
 module Faker
   class Compass < Base
     class << self
+      ##
+      # Produces a random cardinal.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.cardinal #=> "north"
+      #
+      # @faker.version 1.8.0
       def cardinal
         fetch('compass.cardinal.word')
       end
 
+      ##
+      # Produces a random ordinal.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.ordinal #=> "northwest"
+      #
+      # @faker.version 1.8.0
       def ordinal
         fetch('compass.ordinal.word')
       end
 
+      ##
+      # Produces a random half wind.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.half_wind #=> "north-northwest"
+      #
+      # @faker.version 1.8.0
       def half_wind
         fetch('compass.half-wind.word')
       end
 
+      ##
+      # Produces a random quarter wind.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.quarter_wind #=> "north by west"
+      #
+      # @faker.version 1.8.0
       def quarter_wind
         fetch('compass.quarter-wind.word')
       end
 
+      ##
+      # Produces a random direction.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.direction #=> "southeast"
+      #
+      # @faker.version 1.8.0
       def direction
         parse('compass.direction')
       end
 
+      ##
+      # Produces a random abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.abbreviation #=> "NEbN"
+      #
+      # @faker.version 1.8.0
       def abbreviation
         parse('compass.abbreviation')
       end
 
+      ##
+      # Produces a random azimuth.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.azimuth #=> "168.75"
+      #
+      # @faker.version 1.8.0
       def azimuth
         parse('compass.azimuth')
       end
 
+      ##
+      # Produces a random cardinal abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.cardinal_abbreviation #=> "N"
+      #
+      # @faker.version 1.8.0
       def cardinal_abbreviation
         fetch('compass.cardinal.abbreviation')
       end
 
+      ##
+      # Produces a random ordinal abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.ordinal_abbreviation #=> "SW"
+      #
+      # @faker.version 1.8.0
       def ordinal_abbreviation
         fetch('compass.ordinal.abbreviation')
       end
 
+      ##
+      # Produces a random half wind abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.half_wind_abbreviation #=> "NNE"
+      #
+      # @faker.version 1.8.0
       def half_wind_abbreviation
         fetch('compass.half-wind.abbreviation')
       end
 
+      ##
+      # Produces a random quarter wind abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.quarter_wind_abbreviation #=> "SWbS"
+      #
+      # @faker.version 1.8.0
       def quarter_wind_abbreviation
         fetch('compass.quarter-wind.abbreviation')
       end
 
+      ##
+      # Produces a random cardinal azimuth.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.cardinal_azimuth #=> "90"
+      #
+      # @faker.version 1.8.0
       def cardinal_azimuth
         fetch('compass.cardinal.azimuth')
       end
 
+      ##
+      # Produces a random ordinal azimuth.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.ordinal_azimuth #=> "135"
+      #
+      # @faker.version 1.8.0
       def ordinal_azimuth
         fetch('compass.ordinal.azimuth')
       end
 
+      ##
+      # Produces a random half wind azimuth.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.half_wind_azimuth #=> "292.5"
+      #
+      # @faker.version 1.8.0
       def half_wind_azimuth
         fetch('compass.half-wind.azimuth')
       end
 
+      ##
+      # Produces a random quarter wind azimuth
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Compass.quarter_wind_azimuth #=> "56.25"
+      #
+      # @faker.version 1.8.0
       def quarter_wind_azimuth
         fetch('compass.quarter-wind.azimuth')
       end

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.rb

@@ -1,20 +1,67 @@
 # frozen_string_literal: true
 
-require 'digest'
-
 module Faker
   class Crypto < Base
     class << self
+      # Setting the lorem character number lower than the default of
+      # 255 reduces the time complexity of each hash algorithm while
+      # still returning deterministically unique values. See
+      # https://github.com/faker-ruby/faker/pull/2938 for more info.
+      MD5_MIN_NUMBER_OF_CHARACTERS = 25
+      SHA1_MIN_NUMBER_OF_CHARACTERS = 31
+      SHA256_MIN_NUMBER_OF_CHARACTERS = 50
+      SHA512_MIN_NUMBER_OF_CHARACTERS = 100
+
+      ##
+      # Produces an MD5 hash.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Crypto.md5 #=> "6b5ed240042e8a65c55ddb826c3408e6"
+      #
+      # @faker.version 1.6.4
       def md5
-        Digest::MD5.hexdigest(Lorem.characters)
+        OpenSSL::Digest::MD5.hexdigest(Lorem.characters(number: MD5_MIN_NUMBER_OF_CHARACTERS))
       end
 
+      ##
+      # Produces a SHA1 hash.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Crypto.sha1 #=> "4e99e31c51eef8b2d290e709f757f92e558a503f"
+      #
+      # @faker.version 1.6.4
       def sha1
-        Digest::SHA1.hexdigest(Lorem.characters)
+        OpenSSL::Digest::SHA1.hexdigest(Lorem.characters(number: SHA1_MIN_NUMBER_OF_CHARACTERS))
       end
 
+      ##
+      # Produces a SHA256 hash.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Crypto.sha256 #=> "51e4dbb424cd9db1ec5fb989514f2a35652ececef33f21c8dd1fd61bb8e3929d"
+      #
+      # @faker.version 1.6.4
       def sha256
-        Digest::SHA256.hexdigest(Lorem.characters)
+        OpenSSL::Digest::SHA256.hexdigest(Lorem.characters(number: SHA256_MIN_NUMBER_OF_CHARACTERS))
+      end
+
+      ##
+      # Produces a SHA512 hash.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Crypto.sha512 #=> "7b9fc82a6642874833d01b74a7b4fae3d15373193b55cfba47327f8f0afdc8d0ea155b58639a03a887009ef997dab8dd8d36767620d430f6e787e5996e26da80"
+      #
+      # @faker.version next
+      def sha512
+        OpenSSL::Digest::SHA512.hexdigest(Lorem.characters(number: SHA512_MIN_NUMBER_OF_CHARACTERS))
       end
     end
   end

data/lib/faker/default/crypto_coin.rb

@@ -7,22 +7,67 @@ 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(coin: coin_array)
         coin[COIN_NAME]
       end
 
+      ##
+      # Produces a random crypto coin acronym.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::CryptoCoin.acronym #=> "BTC"
+      #
+      # @faker.version 1.9.2
       def acronym(coin: coin_array)
         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(coin: coin_array)
         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/currency.rb

@@ -3,14 +3,41 @@
 module Faker
   class Currency < Base
     class << self
+      ##
+      # Produces the name of a currency.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Currency.name #=> "Swedish Krona"
+      #
+      # @faker.version 1.9.0
       def name
         fetch('currency.name')
       end
 
+      ##
+      # Produces a currency code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Currency.code #=> "USD"
+      #
+      # @faker.version 1.9.0
       def code
         fetch('currency.code')
       end
 
+      ##
+      # Produces a currency symbol.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Currency.symbol #=> "$"
+      #
+      # @faker.version 1.9.0
       def symbol
         fetch('currency.symbol')
       end