pseudo_random 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea6d1ceeeffde9f6428fbc99f74a8a3531c654aa42406592112da203b8c4aafb
-  data.tar.gz: ca518011da7918a0526ea200e3dd6873b98ffae7c770fcc55b199323e0763e26
+  metadata.gz: e4970f4efb26dab591b3993a5f32aa7c7dbbdc5c95c902b0ec17cc4bed992d30
+  data.tar.gz: 21d3fbe2944dee77e0bdcd119a5c4e36a35216d51da00e2f12a06e71f05db1c0
 SHA512:
-  metadata.gz: 33d3304a9b75f9107fab384a3aed3d7cb21d26733fbb72a1ac0323e40604dbc2948bf7be208bbe4bf95ce174d7a759fb2ed54d9f7451ae4469e8b61849d4e4e9
-  data.tar.gz: 7332ebea107f056678cae26fb02f0520f42d4e47d866fc4432af1e4083ef72d11829c22406016a40bc4bc00351927b0ac37cf6148f25f33e59c6ba2edf66bdfd
+  metadata.gz: 50e2ddda1158f48552b8817974c1e3f95e3cbe021307fbb9e84e8f29b1c0175adb2cf3a37da418f4fe0978b5d1a4498c34f13a3dd9ef00d4814c4682f9c37f4d
+  data.tar.gz: c6c820faf822459093a3bb9be9d4617256fa0c03acb310ed97bdd0d97100f0d4558bc204d94710f4d7107cbff9351597dc78ee22708b0fb12ad2ad560cae2761

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -16,6 +16,20 @@ Deprecations: A deprecated feature will remain for at least one MINOR release af
 
 ## [Unreleased]
 
+## [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 +63,7 @@ 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.0...HEAD
+[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

@@ -147,15 +147,27 @@ random_range = generator.rand(1..100)
 puts random_range  # => 64
 ```
 
-### Convenience one-off method
+### Convenience one-off methods
 
 ```ruby
-# One-off random number (legacy convenience)
-result = PseudoRandom.rand(42)
+# One-off random number
+result = PseudoRandom.rand(seed: 42)
 puts result  # => 0.6394267984578837
 
-# Create a new generator explicitly
-generator = PseudoRandom.new(42)
+# One-off hex string
+hex = PseudoRandom.hex(seed: 'my_seed', length: 16)
+puts hex  # => "a1b2c3d4e5f67890"
+
+# One-off alphabetic string
+alpha = PseudoRandom.alphabetic(seed: 'my_seed', length: 12)
+puts alpha  # => "AbCdEfGhIjKl"
+
+# One-off alphanumeric string
+alnum = PseudoRandom.alphanumeric(seed: 'my_seed', length: 10)
+puts alnum  # => "A1b2C3d4E5"
+
+# 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

data/lib/pseudo_random/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PseudoRandom
-  VERSION = '1.0.1'
+  VERSION = '2.0.0'
 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.0
 platform: ruby
 authors:
 - aYosukeMakita