everythingrb 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfa8c1ad4940f61e609e0b70618493a050979540beb9e3388828d9c8741f9103
-  data.tar.gz: a4851a664e888577d68a01fc9830d9d8c812ff5758edce994eacd0f1440887f4
+  metadata.gz: f3a8a85bd0554c198bd29acae4a9f4d5126fd34d9907dd3b9b8b65c03cc32f86
+  data.tar.gz: 580151bb2f1a764ad993d25ae0e615095c37b4d61a6f454b4d6e9be300e6ed39
 SHA512:
-  metadata.gz: dd750b905857c86db3cdd8c054c50a7900e2ef194fdd51df69bd35267f0f947bbb93dca3df9bb7596758b15a5312203cb02875ff99c90eca03aab7d63c064e79
-  data.tar.gz: 6c9c6198b3ef913c4cfebcae52cc85573a499a29b4d21eb2826e22f13dfd58f20fa96333faa92a3ff2d7e88ad38df97247d1836b7b554eb859e59dcd17f03bd2
+  metadata.gz: a10e0a0980a4a061d8103f0ec99523094320b432bf5c15e367313d0be06bdadb22ee0fcaae037fdbb233501aa48081a84502c03c74a7e786e573f1679fb81549
+  data.tar.gz: e6a2368422b235a1d5859f0afb3dbc908d777d5098296cf64f10cd212f2e6d23f7dc6a5d6cb740e0a71da833536bcf7351934895ae73294a62026ac052bb3ee9

data/CHANGELOG.md

@@ -15,15 +15,60 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 -->
 
-## [Unreleased]
+## [0.6.0] - 12025-04-26
+
+### BREAKING CHANGES:
+
+- **Replaced method-based `with_key` approach with direct parameter**:
+  The chainable `.with_key` method approach has been replaced with a more straightforward parameter-based approach.
+
+  **Before:**
+  ```ruby
+  hash.transform_values.with_key { |value, key| "#{key}:#{value}" }
+  hash.transform_values!.with_key { |value, key| "#{key}:#{value}" }
+  ```
+
+  **After:**
+  ```ruby
+  hash.transform_values(with_key: true) { |value, key| "#{key}:#{value}" }
+  hash.transform_values!(with_key: true) { |value, key| "#{key}:#{value}" }
+  ```
+
+### Added:
+
+- Added ActiveSupport integration for deep transforms with key access:
+  - `Hash#deep_transform_values(with_key: true)`
+  - `Hash#deep_transform_values!(with_key: true)`
+
+## [0.5.0] - 12025-04-17
+
+**BREAKING:**
+
+The parameter order in `Hash#transform_values.with_key` has been changed to yield `|value, key|` instead of `|key, value|` to maintain consistency with Ruby's standard enumeration methods like `each_with_index`.
+
+**Before:**
+```ruby
+hash.transform_values.with_key { |key, value| "#{key}: #{value}" }
+```
+
+**After:**
+```ruby
+hash.transform_values.with_key { |value, key| "#{key}: #{value}" }
+```
+
+This change aligns our method signatures with Ruby's conventions and matches our other methods like `join_map(with_index: true)` which yields `|value, index|`.
 
 ### Added
 
+- Added `Hash#transform` and `Hash#transform!` for transforming a hash's keys and values at the same time.
+
 ### Changed
+- Changed parameter order in `Hash#transform_values.with_key` to yield `|value, key|` instead of `|key, value|` for consistency with Ruby conventions.
 
 ### Removed
 
-## [0.4.0]
+
+## [0.4.0] - 12025-04-11
 
 ### Added
 
@@ -170,7 +215,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added alias `each` to `each_pair` in OpenStruct for better enumerable compatibility
 
-[unreleased]: https://github.com/itsthedevman/everythingrb/compare/v0.4.0...HEAD
+[unreleased]: https://github.com/itsthedevman/everythingrb/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/itsthedevman/everythingrb/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/itsthedevman/everythingrb/compare/v0.3.1...v0.4.0
 [0.3.1]: https://github.com/itsthedevman/everythingrb/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/itsthedevman/everythingrb/compare/v0.2.5...v0.3.0

data/README.md

@@ -7,8 +7,9 @@
 Super handy extensions to Ruby core classes that make your code more expressive, readable, and fun to write.
 
 ```ruby
-# Instead of this:
 users = [{ name: "Alice", role: "admin" }, { name: "Bob", role: "user" }]
+
+# Instead of this:
 admin_names = users.select { |u| u[:role] == "admin" }.map { |u| u[:name] }.join(", ")
 
 # Write this:
@@ -141,7 +142,7 @@ stats[:server][:region][:us_east][:errors] << "Connection timeout"
 # No need to initialize each level first!
 
 # Transform values with access to keys
-users.transform_values.with_key { |k, v| "User #{k}: #{v[:name]}" }
+users.transform_values(with_key: true) { |v, k| "User #{k}: #{v[:name]}" }
 
 # Find values based on conditions
 users.values_where { |k, v| v[:role] == "admin" }

data/flake.nix

@@ -1,5 +1,5 @@
 {
-  description = "Ruby 3.4 development environment";
+  description = "Ruby 3.2 development environment";
 
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
@@ -20,7 +20,7 @@
       {
         devShells.default = pkgs.mkShell {
           buildInputs = with pkgs; [
-            (ruby_3_4.override {
+            (ruby_3_2.override {
               jemallocSupport = true;
               docSupport = false;
             })

data/lib/everythingrb/hash.rb

@@ -8,6 +8,7 @@
 # - #join_map: Combine filter_map and join operations
 # - #deep_freeze: Recursively freeze hash and contents
 # - #transform_values.with_key: Transform values with access to keys
+# - #transform, #transform!: Transform keys and values
 # - #value_where, #values_where: Find values based on conditions
 # - #rename_key, #rename_keys: Rename hash keys while preserving order
 # - ::new_nested_hash: Create automatically nesting hashes
@@ -257,60 +258,236 @@ class Hash
   alias_method :og_transform_values!, :transform_values!
 
   #
-  # Transforms hash values while allowing access to keys via the chainable with_key method
+  # Returns a new hash with all values transformed by the block
   #
-  # This method either performs a standard transform_values operation if a block is given,
-  # or returns an enumerator with a with_key method that passes both the key and value
-  # to the block.
+  # Enhances Ruby's standard transform_values with key access capability.
   #
-  # @yield [value] Block to transform each value (standard behavior)
+  # @param with_key [Boolean] Whether to yield both value and key to the block
+  #
+  # @yield [value, key] Block that transforms each value
   # @yieldparam value [Object] The value to transform
+  # @yieldparam key [Object] The corresponding key (only if with_key: true)
   # @yieldreturn [Object] The transformed value
   #
-  # @return [Hash, Enumerator] Result hash or Enumerator with with_key method
+  # @return [Hash] A new hash with transformed values
+  # @return [Enumerator] If no block is given
   #
-  # @example Standard transform_values
+  # @example Standard usage
   #   {a: 1, b: 2}.transform_values { |v| v * 2 }
   #   # => {a: 2, b: 4}
   #
-  # @example Using with_key to access keys during transformation
-  #   {a: 1, b: 2}.transform_values.with_key { |k, v| "#{k}_#{v}" }
-  #   # => {a: "a_1", b: "b_2"}
+  # @example With key access
+  #   {a: 1, b: 2}.transform_values(with_key: true) { |v, k| "#{k}:#{v}" }
+  #   # => {a: "a:1", b: "b:2"}
   #
-  def transform_values(&block)
-    return transform_values_enumerator if block.nil?
+  def transform_values(with_key: false, &block)
+    return to_enum(:transform_values, with_key:) if block.nil?
 
-    og_transform_values(&block)
+    if with_key
+      each_pair.with_object({}) do |(key, value), output|
+        output[key] = block.call(value, key)
+      end
+    else
+      og_transform_values(&block)
+    end
   end
 
   #
-  # Transforms hash values in place while allowing access to keys via the chainable with_key method
+  # Transforms all values in the hash in place
+  #
+  # Enhances Ruby's standard transform_values! with key access capability.
   #
-  # This method either performs a standard transform_values! operation if a block is given,
-  # or returns an enumerator with a with_key method that passes both the key and value
-  # to the block, updating the hash in place.
+  # @param with_key [Boolean] Whether to yield both value and key to the block
   #
-  # @yield [value] Block to transform each value (standard behavior)
+  # @yield [value, key] Block that transforms each value
   # @yieldparam value [Object] The value to transform
+  # @yieldparam key [Object] The corresponding key (only if with_key: true)
   # @yieldreturn [Object] The transformed value
   #
-  # @return [self, Enumerator]
-  #   Original hash with transformed values or Enumerator with with_key method
+  # @return [self] The transformed hash
+  # @return [Enumerator] If no block is given
   #
-  # @example Standard transform_values!
+  # @example Standard usage
   #   hash = {a: 1, b: 2}
   #   hash.transform_values! { |v| v * 2 }
   #   # => {a: 2, b: 4}
+  #   # hash is now {a: 2, b: 4}
   #
-  # @example Using with_key to access keys during in-place transformation
+  # @example With key access
   #   hash = {a: 1, b: 2}
-  #   hash.transform_values!.with_key { |k, v| "#{k}_#{v}" }
-  #   # => {a: "a_1", b: "b_2"}
+  #   hash.transform_values!(with_key: true) { |v, k| "#{k}:#{v}" }
+  #   # => {a: "a:1", b: "b:2"}
+  #   # hash is now {a: "a:1", b: "b:2"}
   #
-  def transform_values!(&block)
-    return transform_values_bang_enumerator if block.nil?
+  def transform_values!(with_key: false, &block)
+    return to_enum(:transform_values!, with_key:) if block.nil?
 
-    og_transform_values!(&block)
+    if with_key
+      each_pair do |key, value|
+        self[key] = block.call(value, key)
+      end
+    else
+      og_transform_values!(&block)
+    end
+  end
+
+  # ActiveSupport integrations
+  if defined?(ActiveSupport)
+    # Allows calling original method. See below
+    alias_method :og_deep_transform_values, :deep_transform_values
+
+    # Allows calling original method. See below
+    alias_method :og_deep_transform_values!, :deep_transform_values!
+
+    #
+    # Recursively transforms all values in the hash and nested structures
+    #
+    # Walks through the hash and all nested hashes/arrays and yields each non-hash and
+    # non-array value to the block, replacing it with the block's return value.
+    #
+    # @param with_key [Boolean] Whether to yield both value and key to the block
+    #
+    # @yield [value, key] Block that transforms each value
+    # @yieldparam value [Object] The value to transform
+    # @yieldparam key [Object] The corresponding key (only if with_key: true)
+    # @yieldreturn [Object] The transformed value
+    #
+    # @return [Hash] A new hash with all values recursively transformed
+    # @return [Enumerator] If no block is given
+    #
+    # @example Basic usage
+    #   hash = {a: 1, b: {c: 2, d: [3, 4]}}
+    #   hash.deep_transform_values { |v| v * 2 }
+    #   # => {a: 2, b: {c: 4, d: [6, 8]}}
+    #
+    # @example With key access
+    #   hash = {a: 1, b: {c: 2}}
+    #   hash.deep_transform_values(with_key: true) { |v, k| "#{k}:#{v}" }
+    #   # => {a: "a:1", b: {c: "c:2"}}
+    #
+    def deep_transform_values(with_key: false, &block)
+      return to_enum(:deep_transform_values, with_key:) if block.nil?
+
+      if with_key
+        _deep_transform_values_with_key(self, nil, &block)
+      else
+        og_deep_transform_values(&block)
+      end
+    end
+
+    #
+    # Recursively transforms all values in the hash and nested structures in place
+    #
+    # Same as #deep_transform_values but modifies the hash in place.
+    #
+    # @param with_key [Boolean] Whether to yield both value and key to the block
+    #
+    # @yield [value, key] Block that transforms each value
+    # @yieldparam value [Object] The value to transform
+    # @yieldparam key [Object] The corresponding key (only if with_key: true)
+    # @yieldreturn [Object] The transformed value
+    #
+    # @return [self] The transformed hash
+    # @return [Enumerator] If no block is given
+    #
+    # @example Basic usage
+    #   hash = {a: 1, b: {c: 2, d: [3, 4]}}
+    #   hash.deep_transform_values! { |v| v * 2 }
+    #   # => {a: 2, b: {c: 4, d: [6, 8]}}
+    #   # hash is now {a: 2, b: {c: 4, d: [6, 8]}}
+    #
+    # @example With key access
+    #   hash = {a: 1, b: {c: 2}}
+    #   hash.deep_transform_values!(with_key: true) { |v, k| "#{k}:#{v}" }
+    #   # => {a: "a:1", b: {c: "c:2"}}
+    #   # hash is now {a: "a:1", b: {c: "c:2"}}
+    #
+    def deep_transform_values!(with_key: false, &block)
+      return to_enum(:deep_transform_values!, with_key:) if block.nil?
+
+      if with_key
+        _deep_transform_values_with_key!(self, nil, &block)
+      else
+        og_deep_transform_values!(&block)
+      end
+    end
+
+    private
+
+    # https://github.com/rails/rails/blob/main/activesupport/lib/active_support/core_ext/hash/deep_transform_values.rb#L25
+    def _deep_transform_values_with_key(object, key, &block)
+      case object
+      when Hash
+        object.transform_values(with_key: true) do |value, key|
+          _deep_transform_values_with_key(value, key, &block)
+        end
+      when Array
+        object.map do |value|
+          _deep_transform_values_with_key(value, nil, &block)
+        end
+      else
+        block.call(object, key)
+      end
+    end
+
+    # https://github.com/rails/rails/blob/main/activesupport/lib/active_support/core_ext/hash/deep_transform_values.rb#L36
+    def _deep_transform_values_with_key!(object, key, &block)
+      case object
+      when Hash
+        object.transform_values!(with_key: true) do |value, key|
+          _deep_transform_values_with_key!(value, key, &block)
+        end
+      when Array
+        object.map! do |value|
+          _deep_transform_values_with_key!(value, nil, &block)
+        end
+      else
+        block.call(object, key)
+      end
+    end
+  end
+
+  #
+  # Transforms keys and values to create a new hash
+  #
+  # @yield [key, value] Block that returns a new key-value pair
+  # @yieldparam key [Object] The original key
+  # @yieldparam value [Object] The original value
+  # @yieldreturn [Array] Two-element array containing the new key and value
+  #
+  # @return [Hash] A new hash with transformed keys and values
+  # @return [Enumerator] If no block is given
+  #
+  # @example Transform both keys and values
+  #   {a: 1, b: 2}.transform { |k, v| ["#{k}_key", v * 2] }
+  #   # => {a_key: 2, b_key: 4}
+  #
+  def transform(&block)
+    return to_enum(:transform) if block.nil?
+
+    to_h(&block)
+  end
+
+  #
+  # Transforms keys and values in place
+  #
+  # @yield [key, value] Block that returns a new key-value pair
+  # @yieldparam key [Object] The original key
+  # @yieldparam value [Object] The original value
+  # @yieldreturn [Array] Two-element array containing the new key and value
+  #
+  # @return [self] The transformed hash
+  # @return [Enumerator] If no block is given
+  #
+  # @example Transform both keys and values in place
+  #   hash = {a: 1, b: 2}
+  #   hash.transform! { |k, v| ["#{k}_key", v * 2] }
+  #   # => {a_key: 2, b_key: 4}
+  #
+  def transform!(&block)
+    return to_enum(:transform!) if block.nil?
+
+    replace(transform(&block))
   end
 
   #
@@ -484,40 +661,4 @@ class Hash
     self[new_key] = delete(old_key)
     self
   end
-
-  private
-
-  def transform_values_enumerator
-    original_hash = self
-    enum = to_enum(:transform_values)
-
-    # Add the with_key method directly to the enum
-    enum.define_singleton_method(:with_key) do |&block|
-      raise ArgumentError, "Missing block for Hash#transform_values.with_key" if block.nil?
-
-      original_hash.each_pair.with_object({}) do |(key, value), output|
-        output[key] = block.call(key, value)
-      end
-    end
-
-    enum
-  end
-
-  def transform_values_bang_enumerator
-    original_hash = self
-    enum = to_enum(:transform_values!)
-
-    # Add the with_key method directly to the enum
-    enum.define_singleton_method(:with_key) do |&block|
-      raise ArgumentError, "Missing block for Hash#transform_values!.with_key" if block.nil?
-
-      original_hash.each_pair do |key, value|
-        original_hash[key] = block.call(key, value)
-      end
-
-      original_hash
-    end
-
-    enum
-  end
 end

data/lib/everythingrb/version.rb

@@ -7,5 +7,5 @@
 #
 module Everythingrb
   # Current version of the everythingrb gem
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everythingrb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Bryan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-12 00:00:00.000000000 Z
+date: 2025-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ostruct