tins 1.46.0 → 1.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d1b389e636a16cc5689bf6289e6ec7eb0242c245851fbf208d14284df4fb941
-  data.tar.gz: f1d2211dfed516bbff6a93a94a0ac02dc2ab1aa029dd741655eac116e35d2cb6
+  metadata.gz: e6498c3e89e39b8351e408abc526110d4a67b7666990a100657ebcb30d626312
+  data.tar.gz: a131c7c65f440c56fbfd295478acb9400ccaf27e2b07e43ea8e4e6b17f89bdd9
 SHA512:
-  metadata.gz: 408866a386efdeaf813f5c0ece264da6851ff6e4332a4838c8daa5f7e50d4689e652201ec0160f38d7e92d738d19fef9800842a7ec4e301a37458ca378a27afa
-  data.tar.gz: 213f32c4de0712be8e495a6ffebb2f36172e77016b56831bb5106efb5b020322317b0870ed2b3ab11f88bf469c1ba60fc539c4003ce1bbf86a53a591ac667455
+  metadata.gz: 2905a2fa59926a1406cbbfc2ffcf5d68f536558287e852a701b61f9df0f7dfd4e9cd98e62113806cd44015ac26bb0187a55314f6a0246c97baa4ec9bb2aad848
+  data.tar.gz: c5bbe5c05a230bcf2127355e021ca2c90d72ccab8260543b11f8dfd9664746ffc1ea667f7cf7433e2a740e60a51aa4b199cd614e0f811f89086bca4adf0112b8

data/CHANGES.md

@@ -1,5 +1,33 @@
 # 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
+    - Renamed `EnumerableExtension` module to `ArrayExtension` throughout the
+      codebase
+    - Updated method calls from `<<` to `push` for consistency with
+      `ArrayExtension`
+    - Modified `to_a` method implementation to return `@arguments` directly
+    - Updated test assertions to expect `ArrayExtension` instead of
+      `EnumerableExtension`
+    - Changed documentation comments to reflect the new `ArrayExtension` name
+    - Updated type checking from `EnumerableExtension` to `ArrayExtension` in
+      conditional logic
+
 ## 2025-11-10 v1.46.0
 
 - Updated `s.rubygems_version` from **3.6.9** to **3.7.2** in gemspec

data/lib/tins/go.rb

@@ -12,15 +12,12 @@ module Tins
   # @example Multiple values for same option
   #   # Handle: -f foo -f bar -f baz
   #   options = Tins::GO.go('f:', ARGV)
-  #   # options['f'] will contain an EnumerableExtension collection with all
+  #   # options['f'] will contain an ArrayExtension collection with all
   #   values, see `option['f'].to_a`
   module GO
-    # An extension module that provides Enumerable behavior for collecting
-    # multiple values associated with the same command-line option.
-    #
-    # This extension enables command-line flags like `-f foo -f bar` to be
-    # collected into a single collection that can be queried via #to_a or #each.
-    module EnumerableExtension
+    # A module that provides extension methods for Strings let them double as
+    # arrays.
+    module ArrayExtension
       # Adds an element to the collection.
       #
       # This method allows for chaining operations and collects multiple
@@ -34,30 +31,11 @@ module Tins
         self
       end
 
-      # Alias for {#push}
-      #
-      # Enables intuitive syntax for adding elements: `collection << item`
-      #
-      # @see #push
-      alias << push
-
-      # Iterates over each element in the collection.
-      #
-      # Implements the Enumerable interface, allowing the use of all Enumerable
-      # methods like map, select, find, etc.
-      #
-      # @yield [element] Yields each element in the collection
-      # @yieldparam element [Object] Each element in the collection
-      # @return [self] Returns self to enable method chaining
-      def each(&block)
-        @arguments.each(&block)
-        self
+      # The to_a method converts the object to an array.
+      # @return [Array] a new array containing the object's elements
+      def to_a
+        @arguments
       end
-
-      # Includes the Enumerable module to provide rich iteration capabilities.
-      #
-      # This enables the use of methods like map, select, find, etc.
-      include Enumerable
     end
 
     module_function
@@ -89,7 +67,7 @@ module Tins
     # @example Multiple values for same option
     #   # Handle: -f foo -f bar -f baz
     #   options = Tins::GO.go('f:', ARGV)
-    #   # options['f'] will contain an EnumerableExtension collection with
+    #   # options['f'] will contain an ArrayExtension collection with
     #   # all values, see options['f'].to_a
     #
     # @example Boolean flag counting
@@ -145,13 +123,13 @@ module Tins
             else
               a = p
             end
-            if v[o].nil? || !(EnumerableExtension === v[o])
+            if v[o].nil? || !(ArrayExtension === v[o])
               a = a.dup
-              a.extend EnumerableExtension
-              a << a
+              a.extend ArrayExtension
+              a.push a
               v[o] = a
             else
-              v[o] << a
+              v[o].push a
             end
             break
           elsif b.key?(o)
@@ -167,10 +145,10 @@ module Tins
       end
       r.reject! { |a| (b[p] = false) || true if /\A~(?<p>.)/ =~ a  }
       v.transform_values! do |w|
-        if w.is_a?(String) && !w.is_a?(EnumerableExtension)
+        if w.is_a?(String) && !w.is_a?(ArrayExtension)
           w = w.dup
-          w.extend EnumerableExtension
-          w << w
+          w.extend ArrayExtension
+          w.push w
         else
           w
         end

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.46.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/go_test.rb

@@ -61,8 +61,8 @@ module Tins
     def test_defaults
       r = go('bv:w:', args = %w[ -v bar ], defaults: { ?b => true, ?v => 'foo', ?w => 'baz' })
       assert_equal({ ?b => 1, 'v' => 'bar', 'w' => 'baz' }, r)
-      assert_kind_of(Tins::GO::EnumerableExtension, r[?v])
-      assert_kind_of(Tins::GO::EnumerableExtension, r[?w])
+      assert_kind_of(Tins::GO::ArrayExtension, r[?v])
+      assert_kind_of(Tins::GO::ArrayExtension, r[?w])
       assert_equal [], args
       r = go('bv:', args = %w[ -v bar ~b baz ], defaults: { ?b => true, ?v => 'foo' })
       assert_equal({ ?b => false, 'v' => 'bar' }, r)

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.46.0 ruby lib
+# stub: tins 1.48.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "tins".freeze
-  s.version = "1.46.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.46.0
+  version: 1.48.0
 platform: ruby
 authors:
 - Florian Frank