tins 1.52.0 → 1.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fa2fd818ec06340248491b7ddd9710f6960351402305ed0e74967db12e067ef
-  data.tar.gz: e5626b112f428aeed1596384aa03642faeb6aea685b7f08e962bde6cb37f4ed1
+  metadata.gz: 7878ad969917b7fe9cb5ecdd474c612c5a440434331b3036729000b42ba26f7a
+  data.tar.gz: c0a7b9b5d3f69b19ed6ef11de637e70a286324089bf12f28c555502af1d7b775
 SHA512:
-  metadata.gz: 935cffcff615ef5e3b73580a1222f8b6210c1b1b007cedcd9c5332bd707f2dd99c7b74775ea52ec6fa2f55b3936869f670392a7c497e0bce1dd87f546d9dd5a6
-  data.tar.gz: df651121d32df44d80d974209bce4087dddc5277f7568e6b9e7ec4591719ca7b931ec2bcda6cf9bf2c084de519750f4b3fa5c47d38e3f533f7dbafecedf1571d
+  metadata.gz: 240db7924b97b15d7e8df113407fd3878f08911caf4c4b362569a6fb563ca49d6a7ffa2227ea9ff8180fb5b321e174def7799b9c147b6b29a8d5fde6e2d14f7a
+  data.tar.gz: c5f3a1447cf33d250f5819895d59cc74bd4168b0bccc49371cde8efdd377c54ae98a554e30ac817d7c5d597e92dea3c0c0b37e2ad3b6b058e390613db50a25a6

data/CHANGES.md

@@ -1,5 +1,20 @@
 # Changes
 
+## 2026-04-14 v1.53.0
+
+- Added `stringify_keys_recursive` and `stringify_keys_recursive!` methods to convert hash keys from symbols to strings
+    - Renamed `_symbolize_keys_recursive` to `_transform_keys_recursive` to
+      support both `:to_sym` and `:to_s` transformations
+    - Updated `symbolize_keys_recursive` to use the new
+      `_transform_keys_recursive` with `transform: :to_sym`
+    - Added comprehensive tests for the new `stringify_keys_recursive` methods
+      including circular reference handling
+    - Updated YARD documentation for all new and modified methods
+- Made `Token#bits` immutable from outside by changing `attr_accessor
+  :bits` to `attr_reader :bits` and using direct instance variable
+  assignment
+- Bump `s.rubygems_version` from **4.0.3** to **4.0.10** in `tins.gemspec`
+
 ## 2026-02-23 v1.52.0
 
 - Renamed `BASE32_EXTENDED_HEX_ALPHABET` to

data/lib/tins/hash_symbolize_keys_recursive.rb

@@ -49,7 +49,23 @@ module Tins
     #   # => { name: "John", self: "[Circular]" }
     def symbolize_keys_recursive(circular: nil)
       self.seen = {}
-      _symbolize_keys_recursive(self, circular: circular)
+      _transform_keys_recursive(self, circular: circular, transform: :to_sym)
+    ensure
+      self.seen = nil
+    end
+
+    # Converts all keys in the hash (and nested hashes) to strings.
+    #
+    # @param circular [Object] The value to return for circular references.
+    # @return [Hash] A new hash with all keys converted to strings.
+    #
+    # @example
+    #   hash = { name: "John", address: { city: "NYC" } }
+    #   hash.stringify_keys_recursive
+    #   # => { "name" => "John", "address" => { "city" => "NYC" } }
+    def stringify_keys_recursive(circular: nil)
+      self.seen = {}
+      _transform_keys_recursive(self, circular: circular, transform: :to_s)
     ensure
       self.seen = nil
     end
@@ -70,14 +86,28 @@ module Tins
       replace symbolize_keys_recursive(circular: circular)
     end
 
+    # Converts all keys in the hash (and nested hashes) to strings in place.
+    #
+    # @param circular [Object] The value to return for circular references.
+    # @return [Hash] The same hash with all keys converted to strings.
+    #
+    # @example
+    #   hash = { name: "John", address: { city: "NYC" } }
+    #   hash.stringify_keys_recursive!
+    #   # => { "name" => "John", "address" => { "city" => "NYC" } }
+    def stringify_keys_recursive!(circular: nil)
+      replace stringify_keys_recursive(circular: circular)
+    end
+
     private
 
-    # Performs the actual recursive symbolization work
+    # Performs the actual recursive transformation work
     #
     # @param object [Object] The object to process
     # @param circular [Object] The value to return for circular references
-    # @return [Object] The processed object with symbolized keys
-    def _symbolize_keys_recursive(object, circular: nil)
+    # @param transform [Symbol] The transformation to apply to keys (`:to_sym` or `:to_s`).
+    # @return [Object] The processed object with transformed keys
+    def _transform_keys_recursive(object, circular: nil, transform:)
       case
       when seen[object.__id__]
         object = circular
@@ -87,7 +117,8 @@ module Tins
         new_object = object.class.new
         seen[new_object.__id__] = true
         object.each do |k, v|
-          new_object[k.to_s.to_sym] = _symbolize_keys_recursive(v, circular: circular)
+          new_object[k.to_s.__send__(transform)] =
+            _transform_keys_recursive(v, circular: circular, transform:)
         end
         object = new_object
       when object.respond_to?(:to_ary)
@@ -96,7 +127,7 @@ module Tins
         new_object = object.class.new(object.size)
         seen[new_object.__id__] = true
         object.each_with_index do |v, i|
-          new_object[i] = _symbolize_keys_recursive(v, circular: circular)
+          new_object[i] = _transform_keys_recursive(v, circular: circular, transform:)
         end
         object = new_object
       end

data/lib/tins/token.rb

@@ -87,7 +87,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 = self.class.analyze(alphabet:, length:)
+      @bits = self.class.analyze(alphabet:, length:)
       token = +''
       length.times { token << alphabet[random.random_number(alphabet.size)] }
       super token
@@ -96,7 +96,7 @@ module Tins
     # The bit length of the token.
     #
     # @return [Integer] the number of bits of entropy in the token
-    attr_accessor :bits
+    attr_reader :bits
 
     # The analyze method calculates the bit length of a token based on its
     # alphabet and length.

data/lib/tins/version.rb

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

data/tests/hash_symbolize_keys_recursive_test.rb

@@ -59,5 +59,61 @@ module Tins
         hash.symbolize_keys_recursive(circular: :circular)
       )
     end
+
+    def test_stringify
+      hash = {
+        :key => [
+          {
+            :key => {
+              :key => true
+            },
+            :o => Object.new,
+          }
+        ],
+      }
+      hash2 = hash.stringify_keys_recursive
+      assert hash2["key"][0]["key"]["key"]
+      hash.stringify_keys_recursive!
+      assert hash["key"][0]["key"]["key"]
+    end
+
+    def test_stringify_bang
+      hash = { :foo => 'bar' }
+      hash.stringify_keys_recursive!
+      assert_equal({ "foo" => 'bar' }, hash)
+    end
+
+    def test_stringify_with_circular_array
+      circular_array = [].tap { |a| a << a }
+      assert_equal(
+        { "foo" => [ nil ] },
+        { :foo => circular_array }.stringify_keys_recursive
+      )
+      assert_equal(
+        { "foo" => [ :circular ] },
+        { :foo => circular_array }.stringify_keys_recursive(circular: :circular)
+      )
+    end
+
+    def test_stringify_with_circular_hash
+      circular_hash = {}.tap { |h| h[:foo] = h }
+      circular_hash_string = {}.tap { |h| h['foo'] = nil }
+      assert_equal(
+        { "bar" => circular_hash_string },
+        { :bar => circular_hash }.stringify_keys_recursive
+      )
+      assert_equal(
+        { "bar" => { "foo" => :circular } },
+        { :bar => circular_hash }.stringify_keys_recursive(circular: :circular)
+      )
+    end
+
+    def test_stringify_deeper_nesting
+      hash = { :foo => [ true, [ { :bar => {}.tap { |h| h[:foo] = h } }, 3.141, [].tap { |arr| arr << arr } ] ] }
+      assert_equal(
+        {"foo"=> [true, [{"bar"=> {"foo"=> :circular}}, 3.141, [:circular]]]},
+        hash.stringify_keys_recursive(circular: :circular)
+      )
+    end
   end
-end
+end

data/tins.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: tins 1.52.0 ruby lib
+# stub: tins 1.53.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "tins".freeze
-  s.version = "1.52.0".freeze
+  s.version = "1.53.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "Tins - Useful stuff.".freeze, "--main".freeze, "README.md".freeze]
   s.required_ruby_version = Gem::Requirement.new(">= 3.1".freeze)
-  s.rubygems_version = "4.0.3".freeze
+  s.rubygems_version = "4.0.10".freeze
   s.summary = "Useful stuff.".freeze
   s.test_files = ["tests/annotate_test.rb".freeze, "tests/ask_and_send_test.rb".freeze, "tests/attempt_test.rb".freeze, "tests/bijection_test.rb".freeze, "tests/blank_full_test.rb".freeze, "tests/case_predicate_test.rb".freeze, "tests/concern_test.rb".freeze, "tests/date_dummy_test.rb".freeze, "tests/date_time_dummy_test.rb".freeze, "tests/deep_dup_test.rb".freeze, "tests/delegate_test.rb".freeze, "tests/deprecate_test.rb".freeze, "tests/dslkit_test.rb".freeze, "tests/duration_test.rb".freeze, "tests/dynamic_scope_test.rb".freeze, "tests/expose_test.rb".freeze, "tests/extract_last_argument_options_test.rb".freeze, "tests/file_binary_test.rb".freeze, "tests/find_test.rb".freeze, "tests/from_module_test.rb".freeze, "tests/generator_test.rb".freeze, "tests/go_test.rb".freeze, "tests/hash_bfs_test.rb".freeze, "tests/hash_dfs_test.rb".freeze, "tests/hash_symbolize_keys_recursive_test.rb".freeze, "tests/hash_union_test.rb".freeze, "tests/if_predicate_test.rb".freeze, "tests/implement_test.rb".freeze, "tests/limited_test.rb".freeze, "tests/lines_file_test.rb".freeze, "tests/lru_cache_test.rb".freeze, "tests/memoize_test.rb".freeze, "tests/method_description_test.rb".freeze, "tests/minimize_test.rb".freeze, "tests/module_group_test.rb".freeze, "tests/named_set_test.rb".freeze, "tests/named_test.rb".freeze, "tests/null_test.rb".freeze, "tests/p_test.rb".freeze, "tests/partial_application_test.rb".freeze, "tests/proc_compose_test.rb".freeze, "tests/proc_prelude_test.rb".freeze, "tests/range_plus_test.rb".freeze, "tests/require_maybe_test.rb".freeze, "tests/responding_test.rb".freeze, "tests/rotate_test.rb".freeze, "tests/scope_test.rb".freeze, "tests/secure_write_test.rb".freeze, "tests/sexy_singleton_test.rb".freeze, "tests/string_byte_order_mark_test.rb".freeze, "tests/string_camelize_test.rb".freeze, "tests/string_named_placeholders.rb".freeze, "tests/string_underscore_test.rb".freeze, "tests/string_version_test.rb".freeze, "tests/subhash_test.rb".freeze, "tests/temp_io_test.rb".freeze, "tests/test_helper.rb".freeze, "tests/time_dummy_test.rb".freeze, "tests/time_freezer_test.rb".freeze, "tests/to_test.rb".freeze, "tests/token_test.rb".freeze, "tests/unit_test.rb".freeze, "tests/annotate_test.rb".freeze, "tests/ask_and_send_test.rb".freeze, "tests/attempt_test.rb".freeze, "tests/bijection_test.rb".freeze, "tests/blank_full_test.rb".freeze, "tests/case_predicate_test.rb".freeze, "tests/concern_test.rb".freeze, "tests/date_dummy_test.rb".freeze, "tests/date_time_dummy_test.rb".freeze, "tests/deep_dup_test.rb".freeze, "tests/delegate_test.rb".freeze, "tests/deprecate_test.rb".freeze, "tests/dslkit_test.rb".freeze, "tests/duration_test.rb".freeze, "tests/dynamic_scope_test.rb".freeze, "tests/expose_test.rb".freeze, "tests/extract_last_argument_options_test.rb".freeze, "tests/file_binary_test.rb".freeze, "tests/find_test.rb".freeze, "tests/from_module_test.rb".freeze, "tests/generator_test.rb".freeze, "tests/go_test.rb".freeze, "tests/hash_bfs_test.rb".freeze, "tests/hash_dfs_test.rb".freeze, "tests/hash_symbolize_keys_recursive_test.rb".freeze, "tests/hash_union_test.rb".freeze, "tests/if_predicate_test.rb".freeze, "tests/implement_test.rb".freeze, "tests/limited_test.rb".freeze, "tests/lines_file_test.rb".freeze, "tests/lru_cache_test.rb".freeze, "tests/memoize_test.rb".freeze, "tests/method_description_test.rb".freeze, "tests/minimize_test.rb".freeze, "tests/module_group_test.rb".freeze, "tests/named_set_test.rb".freeze, "tests/named_test.rb".freeze, "tests/null_test.rb".freeze, "tests/p_test.rb".freeze, "tests/partial_application_test.rb".freeze, "tests/proc_compose_test.rb".freeze, "tests/proc_prelude_test.rb".freeze, "tests/range_plus_test.rb".freeze, "tests/require_maybe_test.rb".freeze, "tests/responding_test.rb".freeze, "tests/rotate_test.rb".freeze, "tests/scope_test.rb".freeze, "tests/secure_write_test.rb".freeze, "tests/sexy_singleton_test.rb".freeze, "tests/string_byte_order_mark_test.rb".freeze, "tests/string_camelize_test.rb".freeze, "tests/string_underscore_test.rb".freeze, "tests/string_version_test.rb".freeze, "tests/subhash_test.rb".freeze, "tests/temp_io_test.rb".freeze, "tests/time_dummy_test.rb".freeze, "tests/time_freezer_test.rb".freeze, "tests/to_test.rb".freeze, "tests/token_test.rb".freeze, "tests/unit_test.rb".freeze]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tins
 version: !ruby/object:Gem::Version
-  version: 1.52.0
+  version: 1.53.0
 platform: ruby
 authors:
 - Florian Frank
@@ -503,7 +503,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Useful stuff.
 test_files: