faker 2.2.0 → 3.2.2

data/lib/faker/blockchain/bitcoin.rb

@@ -1,31 +1,57 @@
 # frozen_string_literal: true
 
-require 'digest'
+require 'openssl'
 require 'securerandom'
 
 module Faker
   class Blockchain
     class Bitcoin < Base
       class << self
+        # @private
         PROTOCOL_VERSIONS = {
           main: 0,
           testnet: 111
         }.freeze
 
+        ##
+        # Produces a Bitcoin wallet address
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Bitcoin.address
+        #     #=> "147nDP22h3pHrLt2qykTH4txUwQh1ccaXp"
+        #
+        # @faker.version 1.9.2
         def address
           address_for(:main)
         end
 
+        ##
+        # Produces a Bitcoin testnet address
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Bitcoin.testnet_address
+        #     #=> "n4YjRyYD6V6zREpk6opqESDqD3KYnMdVEB"
+        #
+        # @faker.version 1.9.2
         def testnet_address
           address_for(:testnet)
         end
 
         protected
 
+        ##
+        # Generates a random Bitcoin address for the given network
+        #
+        # @param network [Symbol] The name of network protocol to generate an address for
+        # @return [String] A Bitcoin address
         def address_for(network)
           version = PROTOCOL_VERSIONS.fetch(network)
           packed = version.chr + Faker::Config.random.bytes(20)
-          checksum = Digest::SHA2.digest(Digest::SHA2.digest(packed))[0..3]
+          checksum = OpenSSL::Digest::SHA256.digest(OpenSSL::Digest::SHA256.digest(packed))[0..3]
           Faker::Base58.encode(packed + checksum)
         end
       end

data/lib/faker/blockchain/ethereum.rb

@@ -4,10 +4,20 @@ module Faker
   class Blockchain
     class Ethereum < Base
       class << self
+        ##
+        # Produces a random Ethereum wallet address
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Ethereum.address
+        #     #=> "0xd392b0c0500700d02d27ab30805ec80ddd3320ff"
+        #
+        # @faker.version 1.9.1
         def address
           hex_alphabet = '0123456789abcdef'
           var = +'0x'
-          40.times { var << sample(shuffle(hex_alphabet.split(''))) }
+          40.times { var << sample(shuffle(hex_alphabet.chars)) }
           var
         end
       end

data/lib/faker/blockchain/tezos.rb

@@ -1,48 +1,132 @@
 # frozen_string_literal: true
 
-require 'digest'
+require 'openssl'
 require 'securerandom'
 
 module Faker
   class Blockchain
     class Tezos < Base
       class << self
+        # @private
         PREFIXES = {
-          tz1:   [6, 161, 159],
-          KT1:   [2, 90, 121],
-          edpk:  [13, 15, 37, 217],
-          edsk:  [13, 15, 58, 7],
+          tz1: [6, 161, 159],
+          KT1: [2, 90, 121],
+          edpk: [13, 15, 37, 217],
+          edsk: [13, 15, 58, 7],
           edsig: [9, 245, 205, 134, 18],
-          B:     [1, 52],
-          o:     [5, 116]
+          B: [1, 52],
+          o: [5, 116]
         }.freeze
 
+        ##
+        # Produces a random Tezos account address
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.account
+        #     #=> "tz1eUsgK6aj752Fbxwk5sAoEFvSDnPjZ4qvk"
+        #
+        # @faker.version 1.9.2
         def account
           encode_tz(:tz1, 20)
         end
 
+        ##
+        # Produces a random Tezos contract
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.contract
+        #     #=> "KT1MroqeP15nnitB4CnNfkqHYa2NErhPPLWF"
+        #
+        # @faker.version 1.9.2
         def contract
           encode_tz(:KT1, 20)
         end
 
+        ##
+        # Produces a random Tezos operation
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.operation
+        #     #=> "onygWYXJX3xNstFLv9PcCrhQdCkENC795xwSinmTEc1jsDN4VDa"
+        #
+        # @faker.version 1.9.2
         def operation
           encode_tz(:o, 32)
         end
 
+        ##
+        # Produces a random Tezos block
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.block
+        #     #=> "BMbhs2rkY1dvAkAyRytvPsjFQ2RiPrBhYkxvWpY65dzkdSuw58a"
+        #
+        # @faker.version 1.9.4
         def block
           encode_tz(:B, 32)
         end
 
+        ##
+        # Produces a random Tezos signature
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.signature
+        #     #=> "edsigu165B7VFf3Dpw2QABVzEtCxJY2gsNBNcE3Ti7rRxtDUjqTFRpg67EdAQmY6YWPE5tKJDMnSTJDFu65gic8uLjbW2YwGvAZ"
+        #
+        # @faker.version 1.9.2
         def signature
           encode_tz(:edsig, 64)
         end
 
+        ##
+        # Produces a random Tezos public key
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.public_key
+        #     #=> "edpkuib9x8QXRc5nWwHUg7U1dXsVmaUrUNU5sX9pVEEvwbMVdfMCeq"
+        #
+        # @faker.version 2.15.2
+        def public_key
+          encode_tz(:edpk, 32)
+        end
+
+        ##
+        # Produces a random Tezos public key
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.secret_key
+        #     #=> "edsk3HZCAGEGpzQPnQUwQeFY4ESanFhQCgLpKriQw8GHyhKCrjHawv"
+        #
+        # @faker.version 2.15.2
+        def secret_key
+          encode_tz(:edsk, 32)
+        end
+
         protected
 
+        ##
+        # @param prefix [Symbol]
+        # @param payload_size [Integer] The size of the payload
+        #
+        # @return [String]
         def encode_tz(prefix, payload_size)
           prefix = PREFIXES.fetch(prefix)
-          packed = prefix.map(&:chr).join('') + Faker::Config.random.bytes(payload_size)
-          checksum = Digest::SHA2.digest(Digest::SHA2.digest(packed))[0..3]
+          packed = prefix.map(&:chr).join + Faker::Config.random.bytes(payload_size)
+          checksum = OpenSSL::Digest::SHA256.digest(OpenSSL::Digest::SHA256.digest(packed))[0..3]
           Faker::Base58.encode(packed + checksum)
         end
       end

data/lib/faker/books/book.rb

@@ -5,18 +5,54 @@ module Faker
     flexible :book
 
     class << self
+      ##
+      # Produces a random book title
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Book.title #=> "The Odd Sister"
+      #
+      # @faker.version 1.9.3
       def title
         fetch('book.title')
       end
 
+      ##
+      # Produces a random book author
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Book.author #=> "Alysha Olsen"
+      #
+      # @faker.version 1.9.3
       def author
         parse('book.author')
       end
 
+      ##
+      # Produces a random book publisher
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Book.publisher #=> "Opus Reader"
+      #
+      # @faker.version 1.9.3
       def publisher
         fetch('book.publisher')
       end
 
+      ##
+      # Produces a random genre
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Book.genre #=> "Mystery"
+      #
+      # @faker.version 1.9.3
       def genre
         fetch('book.genre')
       end

data/lib/faker/books/culture_series.rb

@@ -4,27 +4,76 @@ module Faker
   class Books
     class CultureSeries < Base
       flexible :culture_series
+
       class << self
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::CultureSeries.book
+        #     #=> "The Player of Games"
+        #
+        # @faker.version 1.9.3
         def book
           fetch('culture_series.books')
         end
 
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::CultureSeries.culture_ship
+        #     #=> "Fate Amenable To Change"
+        #
+        # @faker.version 1.9.3
         def culture_ship
           fetch('culture_series.culture_ships')
         end
 
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::CultureSeries.culture_ship_class
+        #     #=> "General Systems Vehicle"
+        #
+        # @faker.version 1.9.3
         def culture_ship_class
           fetch('culture_series.culture_ship_classes')
         end
 
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::CultureSeries.culture_ship_class_abv
+        #     #=> "The Odd Sister"
+        #
+        # @faker.version 1.9.3
         def culture_ship_class_abv
           fetch('culture_series.culture_ship_class_abvs')
         end
 
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::CultureSeries.civ
+        #     #=> "Culture"
+        #
+        # @faker.version 1.9.3
         def civ
           fetch('culture_series.civs')
         end
 
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::CultureSeries.planet
+        #     #=> "Xinth"
+        #
+        # @faker.version 1.9.3
         def planet
           fetch('culture_series.planets')
         end

data/lib/faker/books/dune.rb

@@ -2,29 +2,76 @@
 
 module Faker
   class Books
+    ##
+    # A Faker module beyond your dreams, test data beyond your imagination.
     class Dune < Base
       class << self
-        # QUOTED_CHARACTERS = fetch("dune.quotes")
-        # SAYING_SOURCES = %w(translate("faker.dune.sources"))
-
+        ##
+        # Produces the name of a character from Dune
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.character #=> "Leto Atreides"
+        #
+        # @faker.version 1.9.3
         def character
           fetch('dune.characters')
         end
 
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.title #=> "Duke"
+        #
+        # @faker.version 1.9.3
         def title
           fetch('dune.titles')
         end
 
+        ##
+        # Produces the name of a city from Dune
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.city #=> "Arrakeen"
+        #
+        # @faker.version next
+        def city
+          fetch('dune.cities')
+        end
+
+        ##
+        # Produces the name of a planet from Dune
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.planet #=> "Caladan"
+        #
+        # @faker.version 1.9.3
         def planet
           fetch('dune.planets')
         end
 
-        def quote(legacy_character = NOT_GIVEN, character: nil)
-          if legacy_character != NOT_GIVEN
-            warn_with_uplevel 'Passing `character` with the 1st argument of `Dune.quote` is deprecated. Use keyword argument like `Dune.quote(character: ...)` instead.', uplevel: 1
-            character = legacy_character
-          end
-
+        ##
+        # Produces a quote from Dune
+        #
+        # @param character [String] The name of the character that the quote should be from
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.quote
+        #     #=> "A dead man, surely, no longer requires that water."
+        # @example
+        #   Faker::Books::Dune.quote(character: "baron_harkonnen")
+        #     #=> "He who controls the spice, controls the universe!"
+        #
+        # @faker.version 1.9.3
+        def quote(character: nil)
           quoted_characters = translate('faker.dune.quotes').keys
 
           if character.nil?
@@ -38,15 +85,24 @@ module Faker
             end
           end
 
-          fetch('dune.quotes.' + character)
+          fetch("dune.quotes.#{character}")
         end
 
-        def saying(legacy_source = NOT_GIVEN, source: nil)
-          if legacy_source != NOT_GIVEN
-            warn_with_uplevel 'Passing `source` with the 1st argument of `Dune.saying` is deprecated. Use keyword argument like `Dune.saying(source: ...)` instead.', uplevel: 1
-            source = legacy_source
-          end
-
+        ##
+        # Produces a saying from Dune
+        #
+        # @param source [String]
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.saying #=> "You do not beg the sun for mercy."
+        # @example
+        #   Faker::Books::Dune.saying(source: "fremen")
+        #     #=> "May thy knife chip and shatter."
+        #
+        # @faker.version 1.9.3
+        def saying(source: nil)
           sourced_sayings = translate('faker.dune.sayings').keys
 
           if source.nil?
@@ -60,7 +116,7 @@ module Faker
             end
           end
 
-          fetch('dune.sayings.' + source)
+          fetch("dune.sayings.#{source}")
         end
       end
     end