rekey 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa46e960e7f7282b323629b69f26868f9eb59f09752128afc01858fcd33e74b2
-  data.tar.gz: 6bdf503d29bdfce9e99a43a0ad6b418c1d3905b5c512a318e0b7bcab2f60b48d
+  metadata.gz: 2fa7a26ea0c5de294ea7b5b87c72d9bfb1dfe60bd4aed34068712d0e751dab4d
+  data.tar.gz: d4021c41d1147df578cb411224c53adcef870b1484e45c432c83f9312b81a089
 SHA512:
-  metadata.gz: dac8e9d6262d58ab957ca9175cbc081314612519776737cacce78f89580c65e0aa72393e6d79a0f43a230fa0dbde16b470a5292efabc98e55dd8156362d4f5b8
-  data.tar.gz: 01ed776768fed346f854f3ece0a4af3cf1a2cede9c13d390f5528a2af51f8e89b2125005b15fff65ccda8f5a5dc926b5a2c17c75908b87918f77cdd5fd293201
+  metadata.gz: af81ef145ff59e27ac19c720f44f4976c69df570c2d19d7b711f134906df651c8e202798ab9429644b59dba4e4f47d0cd367db90a07b8838a4540d522cfd8a19
+  data.tar.gz: '0986dbde9b4e19dcc4f4b07ce619396a335b990258107ce0b5314844aa0a2e5d24fe4fd3d43379e9fb7af2fd619a38d6587a8baf708cd4db2ecbcdd3d56a6d52'

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+###  4.2.0  (2026-11-03)
+- drop Ruby 3.0 and 3.1 (end of life); requires Ruby >= 3.2
+- fix: a block with two required args and a splat (`|k, v, *rest|`) gets the key and value instead of the value as `k`
+- fix: a `false` handle passed together with a block raises ArgumentError instead of being ignored
+- feature: a callable (lambda, proc, Method) works as a key or value handle: `users.rekey(:id, ->(u) { u.name.upcase })`. Requires pluckit >= 1.3
+
 ###  4.1.0  (2026-04-10)
 - ruby version / gem updates
 

data/README.md

@@ -3,49 +3,115 @@ Rekey
 ![Gem](https://img.shields.io/gem/dt/rekey?style=plastic)
 [![codecov](https://codecov.io/gh/dpep/rekey_rb/branch/main/graph/badge.svg?token=Z6W48XUEQD)](https://codecov.io/gh/dpep/rekey_rb)
 
-Reformat Enumerables into Hashes, using derived keys / values
+Turn an Enumerable into a Hash, with derived keys and values.
+
+```ruby
+require "rekey"
+
+rows = [
+  { id: 1, name: "alice" },
+  { id: 2, name: "bob" },
+]
+
+rows.rekey(:id)
+# => {1 => {id: 1, name: "alice"}, 2 => {id: 2, name: "bob"}}
+
+rows.rekey(:id, :name)
+# => {1 => "alice", 2 => "bob"}
+```
 
 #### Install
 ```gem install rekey```
 
 
-#### Usage
+#### Handles
+`rekey(key_handle, value_handle = nil)`. Without a value handle, each element is its own value.
+
+[pluckit](https://github.com/dpep/pluckit_rb) resolves handles, so a handle can be a Hash key, a method name, an array index, a Range, or a Regexp:
+
 ```ruby
-require "rekey"
+[[1, "a"], [2, "b"]].rekey(0, 1)
+# => {1 => "a", 2 => "b"}
 
-# key a list of records by id
-[
-  { id: 1, name: "alice", age: 30},
-  { id: 2, name: "bob", age: 24},
-  { id: 3, name: "charlie", age: 88},
-].rekey :id
-=> {
-  1 => { id: 1, name: "alice", age: 30},
-  2 => { id: 2, name: "bob", age: 24},
-  3 => { id: 3, name: "charlie", age: 88},
-}
+%w[apple banana].rekey(0..2, :length)
+# => {"app" => 5, "ban" => 6}
+
+%w[apple banana].rekey(/^./)
+# => {"a" => "apple", "b" => "banana"}
+```
 
+A callable (lambda, proc, Method) works as either handle:
+
+```ruby
+rows.rekey(:id, ->(r) { r[:name].upcase })
+# => {1 => "ALICE", 2 => "BOB"}
+
+[1, 2].rekey(:itself, 10.method(:*))
+# => {1 => 10, 2 => 20}
+```
+
+
+#### Blocks
+A block computes the key; the element stays the value.
+
+```ruby
+[2, 4, 6].rekey { |v| v / 2 }
+# => {1 => 2, 2 => 4, 3 => 6}
+```
+
+Pass handles or a block, not both. Mixing them raises ArgumentError.
 
-# create an id => value map from a list of records
-[
-  { id: 1, name: "alice", age: 30},
-  { id: 2, name: "bob", age: 24},
-  { id: 3, name: "charlie", age: 88},
-].rekey :id, :name
-=> {
-  1 => "alice",
-  2 => "bob",
-  3 => "charlie"
-}
 
+#### Hash input
+Handles and one-parameter blocks look at the values. The outer keys are dropped.
 
-# or use blocks
-[ 2, 4, 6 ].rekey {|v| v / 2}
-=> {
-  1 => 2,
-  2 => 4,
-  3 => 6
+```ruby
+users = {
+  x: { id: 1, name: "alice" },
+  y: { id: 2, name: "bob" },
 }
+
+users.rekey(:id, :name)
+# => {1 => "alice", 2 => "bob"}
+```
+
+A block with two required parameters gets the key and value:
+
+```ruby
+{ a: 1 }.rekey { |k, v| "#{k}#{v}" }
+# => {"a1" => 1}
+```
+
+On anything other than a Hash, a two-parameter block raises ArgumentError.
+
+
+#### Duplicate keys
+The last one wins, as with `to_h` and `index_by`.
+
+```ruby
+[{ id: 1, v: "a" }, { id: 1, v: "b" }].rekey(:id, :v)
+# => {1 => "b"}
+```
+
+Watch for a handle that misses. A typo, or `"id"` on symbol-keyed hashes, gives `nil` for every row, so the whole result collapses to one entry:
+
+```ruby
+rows.rekey("id")
+# => {nil => {id: 2, name: "bob"}}
+```
+
+
+#### Without the monkey patch
+`require "rekey"` adds `#rekey` to every Enumerable. To skip the global patch, load the module alone and use the refinement, or call it directly:
+
+```ruby
+require "rekey/rekey"
+
+using Rekey
+rows.rekey(:id)
+
+# or
+Rekey.rekey(rows, :id)
 ```
 
 

data/lib/rekey/rekey.rb

@@ -27,9 +27,8 @@ module Rekey
       new_value = value
 
       if block
-        if block.arity < 2
+        if required_args(block) < 2
           # block only wants value
-          # arity -1 is a function pointer, eg. &:to_i
           new_key = block.call(value)
         else
           # block wants both key and value
@@ -55,9 +54,14 @@ module Rekey
 
   private
 
+  # a negative arity means -(required + 1): optional args or a splat follow
+  def required_args(block)
+    block.arity < 0 ? -block.arity - 1 : block.arity
+  end
+
   def validate_input!(key_handle, value_handle, &block)
     if block
-      if (key_handle || value_handle)
+      unless key_handle.nil? && value_handle.nil?
         raise ArgumentError, "expected key / value handles, *or* block"
       end
     elsif key_handle.nil?

data/lib/rekey/version.rb

@@ -1,3 +1,3 @@
 module Rekey
-  VERSION = "4.1.0"
+  VERSION = "4.2.0"
 end

data/rekey.gemspec

@@ -1,21 +1,24 @@
-package_name = File.basename(__FILE__).split(".")[0]
-require "./lib/#{package_name}/version"
-
-package = Rekey
+require_relative "lib/rekey/version"
 
 Gem::Specification.new do |s|
-  s.name        = package_name
-  s.version     = package.const_get "VERSION"
   s.authors     = ["Daniel Pepper"]
-  s.summary     = package.to_s
   s.description = "Reformat Enumerables into Hashes, using derived keys / values"
-  s.homepage    = "https://github.com/dpep/#{package_name}_rb"
+  s.files       = `git ls-files * ':!:spec'`.split("\n")
+  s.homepage    = "https://github.com/dpep/rekey_rb"
   s.license     = "MIT"
-  s.files       = `git ls-files * ":!:spec"`.split("\n")
+  s.name        = "rekey"
+  s.summary     = s.description
+  s.version     = Rekey::VERSION
+
+  s.metadata = {
+    "changelog_uri" => "#{s.homepage}/blob/main/CHANGELOG.md",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => s.homepage,
+  }
 
-  s.required_ruby_version = ">= 3"
+  s.required_ruby_version = ">= 3.2"
 
-  s.add_runtime_dependency "pluckit"
+  s.add_dependency "pluckit", ">= 1.3"
 
   s.add_development_dependency "debug"
   s.add_development_dependency "rspec"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rekey
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Daniel Pepper
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,10 @@ files:
 homepage: https://github.com/dpep/rekey_rb
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/dpep/rekey_rb/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/dpep/rekey_rb
 rdoc_options: []
 require_paths:
 - lib
@@ -89,14 +92,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
-summary: Rekey
+summary: Reformat Enumerables into Hashes, using derived keys / values
 test_files: []