tins 1.47.0 → 1.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37dea3f4959ecf698b1908647ef0a7e1c19abe61aa669bbc63aa65fde10714e4
-  data.tar.gz: 78d9256391b2a6dd105be5bc8e0b37aef0508516ddc2cbc578e4766a4f02a50c
+  metadata.gz: e6498c3e89e39b8351e408abc526110d4a67b7666990a100657ebcb30d626312
+  data.tar.gz: a131c7c65f440c56fbfd295478acb9400ccaf27e2b07e43ea8e4e6b17f89bdd9
 SHA512:
-  metadata.gz: 04d75c6e6264659e08574a21bf0a2899702a7765ca90e32baec72056b6a95a639b35aeef7c0ad0d81a35287b3b076b9185f029be9115ae1d0b009236a3a4ca2a
-  data.tar.gz: df69723660df31a08011a5209d460d55a6422cc1999067e2739365866ce30f4f2135a81484d722ae9ac9d83a0ed1c9cdbfe53d1f76ee6060457ad292717cd126
+  metadata.gz: 2905a2fa59926a1406cbbfc2ffcf5d68f536558287e852a701b61f9df0f7dfd4e9cd98e62113806cd44015ac26bb0187a55314f6a0246c97baa4ec9bb2aad848
+  data.tar.gz: c5bbe5c05a230bcf2127355e021ca2c90d72ccab8260543b11f8dfd9664746ffc1ea667f7cf7433e2a740e60a51aa4b199cd614e0f811f89086bca4adf0112b8

data/CHANGES.md

@@ -1,5 +1,19 @@
 # Changes
 
+## 2025-12-05 v1.48.0
+
+- Added `Tins::Token.analyze` class method to calculate bit strength
+- Moved bit calculation logic from `initialize` to `analyze` method for reuse
+- Implemented bit strength calculation using formula: `length ×
+  log₂(alphabet_size)`
+- Added comprehensive tests for the `analyze` method with various alphabets
+- Support both token string and length-based analysis
+- Implemented proper error handling for required parameters
+- Updated `initialize` method to use the new `analyze` method
+- Test cases verify bit strength for **BASE16**, **BASE64**, and **BASE32**
+  alphabets
+- Method returns integer bit strength for cryptographic token analysis
+
 ## 2025-11-14 v1.47.0
 
 - Tins::GO

data/lib/tins/token.rb

@@ -81,7 +81,7 @@ module Tins
         bits > 0 or raise ArgumentError, 'bits has to be positive'
         length = (Math.log(1 << bits) / Math.log(alphabet.size)).ceil
       end
-      self.bits = (Math.log(alphabet.size ** length) / Math.log(2)).floor
+      self.bits = self.class.analyze(alphabet:, length:)
       token = +''
       length.times { token << alphabet[random.random_number(alphabet.size)] }
       super token
@@ -91,5 +91,22 @@ module Tins
     #
     # @return [Integer] the number of bits of entropy in the token
     attr_accessor :bits
+
+    # The analyze method calculates the bit length of a token based on its
+    # alphabet and length.
+    #
+    # @param alphabet [String] the alphabet used for token generation, defaults
+    #   to Tins::Token::DEFAULT_ALPHABET
+    # @param token [String, nil] the token string to analyze, optional
+    # @param length [Integer, nil] the length of the token, optional
+    #
+    # @return [Integer] the calculated bit length of the token
+    #
+    # @raise [ArgumentError] if neither token nor length is provided, or if both are provided
+    def self.analyze(alphabet: Tins::Token::DEFAULT_ALPHABET, token: nil, length: nil)
+      token.nil? ^ length.nil? or raise ArgumentError, 'either token or length is required'
+      length ||= token.length
+      (Math.log(alphabet.size ** length) / Math.log(2)).floor
+    end
   end
 end

data/lib/tins/version.rb

@@ -1,6 +1,6 @@
 module Tins
   # Tins version
-  VERSION         = '1.47.0'
+  VERSION         = '1.48.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/tests/token_test.rb

@@ -32,6 +32,37 @@ module Tins
       assert_equal 128, token.length
       assert_equal 256, token.bits
     end
+
+    def test_analyze_method
+      # Test with default alphabet and length
+      bits = Tins::Token.analyze(alphabet: Tins::Token::DEFAULT_ALPHABET, length: 22)
+      assert_equal 130, bits
+
+      # Test with hex alphabet and length
+      bits = Tins::Token.analyze(alphabet: Tins::Token::BASE16_LOWERCASE_ALPHABET, length: 32)
+      assert_equal 128, bits  # 32 × 4 = 128 bits
+
+      # Test with base64 alphabet and length
+      bits = Tins::Token.analyze(alphabet: Tins::Token::BASE64_ALPHABET, length: 44)
+      assert_equal 264, bits  # 44 × 6 = 264 bits
+
+      # Test with base32 alphabet and length
+      bits = Tins::Token.analyze(alphabet: Tins::Token::BASE32_ALPHABET, length: 52)
+      assert_equal 260, bits  # 52 × 5 = 260 bits
+
+      # Test with token string instead of length
+      token = "5f4dcc3b5aa765d61d8327deb882cf99"
+      bits = Tins::Token.analyze(alphabet: Tins::Token::BASE16_LOWERCASE_ALPHABET, token: token)
+      assert_equal 128, bits
+
+      # Test error handling
+      assert_raise(ArgumentError) do
+        Tins::Token.analyze(alphabet: Tins::Token::DEFAULT_ALPHABET)
+      end
+
+      assert_raise(ArgumentError) do
+        Tins::Token.analyze(alphabet: Tins::Token::DEFAULT_ALPHABET, token: "test", length: 5)
+      end
+    end
   end
 end
-

data/tins.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: tins 1.47.0 ruby lib
+# stub: tins 1.48.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "tins".freeze
-  s.version = "1.47.0".freeze
+  s.version = "1.48.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tins
 version: !ruby/object:Gem::Version
-  version: 1.47.0
+  version: 1.48.0
 platform: ruby
 authors:
 - Florian Frank