securerandom 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e5fca1a0e74f7d256340e2b2e12196ed97adc8ebc512697473d56c110fe682c
-  data.tar.gz: 19d45327f812eede26a7a1432381e8c43d114ca0268ea1697b727db5c94c5ca9
+  metadata.gz: 154280692de39feb39b719344f5c47fd256decdb5bd71cf80cb54b87ef155bd3
+  data.tar.gz: 0aab5a7dc6e671530e0327bcad3bf9d4caae862fed9925bc9cdcc47a57eae68f
 SHA512:
-  metadata.gz: e36e2adb4f23bf29d52a519e68e89dd5c947803399fd493bdab26c452e38142f11d7af03ef436f70c6f7a3c8881cee75b179167b5376556dfc91e4ab3f8ccc46
-  data.tar.gz: 0e86593665d73afc22c91f6964df05f6134dc3b75b443932dde93ee38d296c692478b456a95110e042c4ff7dc54ccefb6cad84847dcd8a3e97d47736a6f25a6c
+  metadata.gz: 99c06212cd3c4908e1bf9c2a459e7f3cc851fbb38396256932787b9725b7aaad7873c7b3ac00bfde458bd2316f1e38e02e62734d0df43d1d1c6ca29c2905ea3c
+  data.tar.gz: c8680a7e9566fcd2d064560c46046f7bc97d1e3b257613c7396306912fac01dcb810f20604e87c4914c327cc1d0f66c3ae8fc952b40f75bec58f520da2f7c627

data/.document

@@ -0,0 +1,4 @@
+LICENSE.txt
+README.md
+docs/
+lib/

data/docs/random.rb

@@ -0,0 +1,10 @@
+# This file is only for RDoc
+
+# Random provides an interface to Ruby's pseudo-random number generator, or
+# PRNG.
+#
+# See also Random::Formatter module that adds convenience methods to generate
+# various forms of random data.
+
+class Random
+end

data/lib/random/formatter.rb

@@ -201,9 +201,8 @@ module Random::Formatter
   #
   # The result contains 74 random bits (9.25 random bytes).
   #
-  # Note that this method cannot be made reproducable with Kernel#srand, which
-  # can only affect the random bits.  The sorted bits will still be based on
-  # Process.clock_gettime.
+  # Note that this method cannot be made reproducable because its output
+  # includes not only random bits but also timestamp.
   #
   # See draft-ietf-uuidrev-rfc4122bis[https://datatracker.ietf.org/doc/draft-ietf-uuidrev-rfc4122bis/]
   # for details of UUIDv7.
@@ -293,6 +292,7 @@ module Random::Formatter
     end
   end
 
+  # Internal interface to Random; Generate random data _n_ bytes.
   private def gen_random(n)
     self.bytes(n)
   end
@@ -340,7 +340,9 @@ module Random::Formatter
     result
   end
 
+  # The default character list for #alphanumeric.
   ALPHANUMERIC = [*'A'..'Z', *'a'..'z', *'0'..'9']
+
   # Generate a random alphanumeric string.
   #
   # The argument _n_ specifies the length, in characters, of the alphanumeric

data/lib/securerandom.rb

@@ -40,19 +40,27 @@ require 'random/formatter'
 
 module SecureRandom
 
-  VERSION = "0.3.0"
+  # The version
+  VERSION = "0.3.1"
 
   class << self
+    # Returns a random binary string containing +size+ bytes.
+    #
+    # See Random.bytes
     def bytes(n)
       return gen_random(n)
     end
 
     private
 
+    # :stopdoc:
+
+    # Implementation using OpenSSL
     def gen_random_openssl(n)
       return OpenSSL::Random.random_bytes(n)
     end
 
+    # Implementation using system random device
     def gen_random_urandom(n)
       ret = Random.urandom(n)
       unless ret
@@ -78,6 +86,9 @@ module SecureRandom
       end
     end
 
+    # :startdoc:
+
+    # Generate random data bytes for Random::Formatter
     public :gen_random
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: securerandom
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Tanaka Akira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-07 00:00:00.000000000 Z
+date: 2023-12-16 00:00:00.000000000 Z
 dependencies: []
 description: Interface for secure random number generator.
 email:
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".document"
 - ".github/dependabot.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
@@ -26,6 +27,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/random.rb
 - lib/random/formatter.rb
 - lib/securerandom.rb
 - rakelib/epoch.rake