pseudo_random 1.0.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea6d1ceeeffde9f6428fbc99f74a8a3531c654aa42406592112da203b8c4aafb
-  data.tar.gz: ca518011da7918a0526ea200e3dd6873b98ffae7c770fcc55b199323e0763e26
+  metadata.gz: 62b608038d538d7b3b2214254d4e4c710e12850447f61946e7160fcb8f7431db
+  data.tar.gz: f15a95f68ae4a7abec4b36f2b7b66128472e7a27290c0c83e853f09ae439f034
 SHA512:
-  metadata.gz: 33d3304a9b75f9107fab384a3aed3d7cb21d26733fbb72a1ac0323e40604dbc2948bf7be208bbe4bf95ce174d7a759fb2ed54d9f7451ae4469e8b61849d4e4e9
-  data.tar.gz: 7332ebea107f056678cae26fb02f0520f42d4e47d866fc4432af1e4083ef72d11829c22406016a40bc4bc00351927b0ac37cf6148f25f33e59c6ba2edf66bdfd
+  metadata.gz: cb223bd31b10081e99f70306d078a10ee29b705223e8b861353f43cb3a40a1897eb4c999b4b22290fe1a727df8e30daab3e2b041a8faedb630fc3d8f85b70449
+  data.tar.gz: b2a176e1dfea1b430771ba69cac292b441779f8e5c9321c468a8e7b462c42525324f18d7d05baad334c076d9ea140fa835bf8275a2ec362d369b446e2791c219

data/.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
   Exclude:
     - 'pseudo_random.gemspec'
     - 'vendor/**/*'
+    - 'lib/**/*.so'
 
 ##################### Layout #################################
 Layout/LineLength:

data/CHANGELOG.md

@@ -16,6 +16,28 @@ Deprecations: A deprecated feature will remain for at least one MINOR release af
 
 ## [Unreleased]
 
+## [2.0.1] - 2025-12-20
+
+### Fixed
+
+- Fixed README examples to match actual execution results
+  - Updated all code examples with correct output values
+  - Examples now accurately reflect the deterministic behavior of the library
+
+## [2.0.0] - 2025-12-06
+
+### Changed
+
+- **Breaking Change**: `PseudoRandom.rand` method now requires keyword arguments
+  - Old API (deprecated): `PseudoRandom.rand(seed)` - positional argument
+  - New API: `PseudoRandom.rand(seed: your_seed)` - keyword argument
+  - The old positional argument API will raise an `ArgumentError` with a deprecation message
+  - This change unifies the API style with other one-off convenience methods (`hex`, `alphabetic`, `alphanumeric`)
+
+### Fixed
+
+- Fixed rubocop warnings
+
 ## [1.0.1] - 2025-09-06
 
 ### Added
@@ -49,6 +71,8 @@ Deprecations: A deprecated feature will remain for at least one MINOR release af
 - Initial release: Deterministic pseudo-random generator (numbers / hex / alphabetic / alphanumeric string generation)
 - Support for arbitrary object seeds
 
-[Unreleased]: https://github.com/aYosukeMakita/pseudo_random/compare/v1.0.1...HEAD
+[Unreleased]: https://github.com/aYosukeMakita/pseudo_random/compare/v2.0.1...HEAD
+[2.0.1]: https://github.com/aYosukeMakita/pseudo_random/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/aYosukeMakita/pseudo_random/compare/v1.0.1...v2.0.0
 [1.0.1]: https://github.com/aYosukeMakita/pseudo_random/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/aYosukeMakita/pseudo_random/releases/tag/v1.0.0

data/README.md

@@ -132,30 +132,42 @@ generator = PseudoRandom.new(42)
 
 # Float in [0.0, 1.0)
 random_float = generator.rand
-puts random_float  # => 0.6394267984578837
+puts random_float  # => 0.8731369804701281
 
 # Integer in [0, 9]
 random_int = generator.rand(10)
-puts random_int  # => 6
+puts random_int  # => 9
 
 # Float in [0.0, 10.0)
 random_float_range = generator.rand(10.0)
-puts random_float_range  # => 9.66814512009282
+puts random_float_range  # => 3.440017825456998
 
 # Integer in [1, 100]
 random_range = generator.rand(1..100)
-puts random_range  # => 64
+puts random_range  # => 41
 ```
 
-### Convenience one-off method
+### Convenience one-off methods
 
 ```ruby
-# One-off random number (legacy convenience)
-result = PseudoRandom.rand(42)
-puts result  # => 0.6394267984578837
+# One-off random number
+result = PseudoRandom.rand(seed: 42)
+puts result  # => 0.8731369804701281
 
-# Create a new generator explicitly
-generator = PseudoRandom.new(42)
+# One-off hex string
+hex = PseudoRandom.hex(seed: 'my_seed', length: 16)
+puts hex  # => "cee117d6757980b7"
+
+# One-off alphabetic string
+alpha = PseudoRandom.alphabetic(seed: 'my_seed', length: 12)
+puts alpha  # => "aZikVznxlLXj"
+
+# One-off alphanumeric string
+alnum = PseudoRandom.alphanumeric(seed: 'my_seed', length: 10)
+puts alnum  # => "Q3a2S8sXED"
+
+# These are equivalent to creating a generator and calling the method once:
+# PseudoRandom.hex(seed: 'my_seed', length: 16) == PseudoRandom.new('my_seed').hex(16)
 ```
 
 ### Diverse seed types
@@ -165,23 +177,23 @@ You can pass any Ruby object as a seed to `PseudoRandom.new`. The object will be
 ```ruby
 # String seed
 generator1 = PseudoRandom.new("hello")
-puts generator1.rand  # => 0.1915194503788923
+puts generator1.rand  # => 0.37097030662852004
 
 # Array seed
 generator2 = PseudoRandom.new([1, 2, 3])
-puts generator2.rand  # => 0.04548605918364251
+puts generator2.rand  # => 0.41837699041143994
 
 # Hash seed
 generator3 = PseudoRandom.new({ name: "John", age: 30 })
-puts generator3.rand  # => 0.7550896311312906
+puts generator3.rand  # => 0.5869273234945404
 
 # Time seed
 generator4 = PseudoRandom.new(Time.new(2023, 1, 1))
-puts generator4.rand  # => 0.4320558086698993
+puts generator4.rand  # => 0.6345803634459501
 
 # Omitted seed (uses hash of nil)
 generator5 = PseudoRandom.new
-puts generator5.rand  # => 0.8501480898450888
+puts generator5.rand  # => 0.9527695090684619
 ```
 
 ### Hex string generation
@@ -191,15 +203,15 @@ generator = PseudoRandom.new("secret")
 
 # 8 hex characters
 hex_string = generator.hex(8)
-puts hex_string  # => "a1b2c3d4"
+puts hex_string  # => "0b628b64"
 
 # 10 hex characters
 hex_string_10 = generator.hex(10)
-puts hex_string_10  # => "a50ee918e5"
+puts hex_string_10  # => "6f291838f3"
 
 # 16 hex characters
 long_hex = generator.hex(16)
-puts long_hex  # => "a1b2c3d4e5f67890"
+puts long_hex  # => "afef24ef63f4e104"
 
 # Empty string (length 0)
 empty_hex = generator.hex(0)
@@ -219,11 +231,11 @@ gen2 = PseudoRandom.new("test")
 end
 
 # Example output:
-# gen1: 0.5985762380674765, gen2: 0.5985762380674765
-# gen1: 0.8325673044064309, gen2: 0.8325673044064309
-# gen1: 0.24136065771243595, gen2: 0.24136065771243595
-# gen1: 0.7392418174919607, gen2: 0.7392418174919607
-# gen1: 0.9853406830436152, gen2: 0.9853406830436152
+# gen1: 0.7714906738735868, gen2: 0.7714906738735868
+# gen1: 0.9245604822851962, gen2: 0.9245604822851962
+# gen1: 0.4030548732252476, gen2: 0.4030548732252476
+# gen1: 0.07008281657880167, gen2: 0.07008281657880167
+# gen1: 0.8898582626604018, gen2: 0.8898582626604018
 ```
 
 ### Practical examples

data/lib/pseudo_random/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PseudoRandom
-  VERSION = '1.0.1'
+  VERSION = '2.0.1'
 end

data/lib/pseudo_random.rb

@@ -169,12 +169,48 @@ module PseudoRandom
     Generator.new(seed)
   end
 
-  # Generates a single pseudo-random number based on the given seed (backward compatibility)
-  def self.rand(seed)
+  # Generates a single pseudo-random number based on the given seed (one-off convenience)
+  # @param seed [Object] the seed value for the generator
+  # @return [Float] a float in [0.0, 1.0)
+  def self.rand(positional_arg = nil, seed: nil)
+    if !positional_arg.nil? && seed.nil?
+      raise ArgumentError,
+            'PseudoRandom.rand(seed) is deprecated in v2.0.0. ' \
+            "Use PseudoRandom.rand(seed: #{positional_arg.inspect}) instead."
+    end
+    raise ArgumentError, 'missing keyword: seed. Usage: PseudoRandom.rand(seed: your_seed)' if seed.nil?
+
     generator = new(seed)
     generator.rand
   end
 
+  # Generates a single hexadecimal string based on the given seed (one-off convenience)
+  # @param seed [Object] the seed value for the generator
+  # @param length [Integer] the number of hexadecimal characters to generate
+  # @return [String] a hexadecimal string with lowercase a-f
+  def self.hex(seed:, length:)
+    generator = new(seed)
+    generator.hex(length)
+  end
+
+  # Generates a single alphabetic string based on the given seed (one-off convenience)
+  # @param seed [Object] the seed value for the generator
+  # @param length [Integer] the number of alphabetic characters to generate
+  # @return [String] a string containing uppercase letters (A-Z) and lowercase letters (a-z)
+  def self.alphabetic(seed:, length:)
+    generator = new(seed)
+    generator.alphabetic(length)
+  end
+
+  # Generates a single alphanumeric string based on the given seed (one-off convenience)
+  # @param seed [Object] the seed value for the generator
+  # @param length [Integer] the number of alphanumeric characters to generate
+  # @return [String] a string containing A-Z, a-z, and 0-9
+  def self.alphanumeric(seed:, length:)
+    generator = new(seed)
+    generator.alphanumeric(length)
+  end
+
   # Returns true if native C++ extension is loaded and available
   def self.native_extension_loaded?
     NATIVE_EXTENSION_LOADED

data/sig/pseudo_random.rbs

@@ -20,5 +20,9 @@ module PseudoRandom
   end
 
   def self.new: (?untyped seed) -> Generator
-  def self.rand: (untyped seed) -> Float
+  def self.rand: (?untyped positional_arg, ?seed: untyped) -> Float
+  def self.hex: (seed: untyped, length: Integer) -> String
+  def self.alphabetic: (seed: untyped, length: Integer) -> String
+  def self.alphanumeric: (seed: untyped, length: Integer) -> String
+  def self.native_extension_loaded?: () -> bool
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pseudo_random
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.1
 platform: ruby
 authors:
 - aYosukeMakita