rekey 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9fd354b9d3c1d9586254cada81be1e6bb9727a4a
-  data.tar.gz: 35a6a2235d235543d2ce42cd483f98ba8ea3da38
+SHA256:
+  metadata.gz: fa46e960e7f7282b323629b69f26868f9eb59f09752128afc01858fcd33e74b2
+  data.tar.gz: 6bdf503d29bdfce9e99a43a0ad6b418c1d3905b5c512a318e0b7bcab2f60b48d
 SHA512:
-  metadata.gz: f3dba9ce015ac3bd8cb5c6b0e9c1f887c2127453649e2d0357e52d710ddc67970a8ae2747d3b1686198ed29533b66c3445df3ef227d69b39c6666c075b51301c
-  data.tar.gz: b9b139e019b4587f06dd0c1a1fed7e7fb9e7bd78c72af91cdb2202a8015612c1f268e10b121cfcb23e12ac8160e2b10f83368b55cf6d6e400cb8048bbc81e62e
+  metadata.gz: dac8e9d6262d58ab957ca9175cbc081314612519776737cacce78f89580c65e0aa72393e6d79a0f43a230fa0dbde16b470a5292efabc98e55dd8156362d4f5b8
+  data.tar.gz: 01ed776768fed346f854f3ece0a4af3cf1a2cede9c13d390f5528a2af51f8e89b2125005b15fff65ccda8f5a5dc926b5a2c17c75908b87918f77cdd5fd293201

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+###  4.1.0  (2026-04-10)
+- ruby version / gem updates
+
+###  4.0.0  (2018-10-08)
+- 7a49250 better monkey patching tests
+- 9d94818 extend self
+- 574461c clean up arity handling, expand tests
+- 4b85ea6 require a key handle or block...for a nil key operation, use PluckIt
+- d6cba35 fix unit test requires
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel Pepper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,52 @@
+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
+
+#### Install
+```gem install rekey```
+
+
+#### Usage
+```ruby
+require "rekey"
+
+# 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},
+}
+
+
+# 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"
+}
+
+
+# or use blocks
+[ 2, 4, 6 ].rekey {|v| v / 2}
+=> {
+  1 => 2,
+  2 => 4,
+  3 => 6
+}
+```
+
+
+----

data/lib/rekey/rekey.rb

@@ -1,11 +1,18 @@
-require 'pluckit/pluck'
+require "pluckit/pluck"
+require "rekey/version"
 
 
 module Rekey
   extend self
 
+  refine Enumerable do
+    def rekey(key_handle = nil, value_handle = nil, &block)
+      Rekey.rekey(self, key_handle, value_handle, &block)
+    end
+  end
+
   def rekey(enumerable, key_handle = nil, value_handle = nil, &block)
-    validate_input key_handle, value_handle, &block
+    validate_input!(key_handle, value_handle, &block)
 
     key_value_fn = if enumerable.respond_to?(:keys)
       proc {|k, v| [k, v]}
@@ -15,7 +22,7 @@ module Rekey
 
     # rekey input
     enumerable.each_with_object({}) do |*args, res|
-      key, value = key_value_fn.call *args
+      key, value = key_value_fn.call(*args)
       new_key = key
       new_value = value
 
@@ -23,21 +30,21 @@ module Rekey
         if block.arity < 2
           # block only wants value
           # arity -1 is a function pointer, eg. &:to_i
-          new_key = block.call value
+          new_key = block.call(value)
         else
           # block wants both key and value
 
           if key_value_fn.arity != 2
             raise ArgumentError.new(
-              'rekey block requests key/value pair but only value available'
+              "rekey block requests key/value pair but only value available"
             )
           end
 
-          new_key = block.call key, value
+          new_key = block.call(key, value)
         end
       else
-        new_key = PluckIt.pluckit value, key_handle
-        new_value = PluckIt.pluckit value, value_handle if value_handle
+        new_key = PluckIt.pluckit(value, key_handle)
+        new_value = PluckIt.pluckit(value, value_handle) if value_handle
       end
 
       # collect results
@@ -48,15 +55,13 @@ module Rekey
 
   private
 
-  def validate_input key_handle, value_handle, &block
+  def validate_input!(key_handle, value_handle, &block)
     if block
-      if (key_handle or value_handle)
-        raise ArgumentError.new 'expected key / value handles, *or* block'
+      if (key_handle || value_handle)
+        raise ArgumentError, "expected key / value handles, *or* block"
       end
     elsif key_handle.nil?
-      raise ArgumentError.new 'key handle or block required'
+      raise ArgumentError, "key handle or block required"
     end
   end
-
-
 end

data/lib/rekey/version.rb

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

data/lib/rekey.rb

@@ -1,13 +1,7 @@
-require_relative 'rekey/rekey'
-
-
-module Rekey
-  VERSION = '4.0.0'
-end
-
+require_relative "rekey/rekey"
 
 module Enumerable
   def rekey(key_handle = nil, value_handle = nil, &block)
-    Rekey.rekey self, key_handle, value_handle, &block
+    Rekey.rekey(self, key_handle, value_handle, &block)
   end
 end

data/rekey.gemspec

@@ -0,0 +1,23 @@
+package_name = File.basename(__FILE__).split(".")[0]
+require "./lib/#{package_name}/version"
+
+package = Rekey
+
+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.license     = "MIT"
+  s.files       = `git ls-files * ":!:spec"`.split("\n")
+
+  s.required_ruby_version = ">= 3"
+
+  s.add_runtime_dependency "pluckit"
+
+  s.add_development_dependency "debug"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+end

metadata

@@ -1,79 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: rekey
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Daniel Pepper
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pluckit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Reformat Enumerables into Hashes, using derived keys / values
-email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
 - lib/rekey.rb
 - lib/rekey/rekey.rb
-- test/test_array_block.rb
-- test/test_array_handlers.rb
-- test/test_empty_input.rb
-- test/test_hash_block.rb
-- test/test_hash_handlers.rb
-- test/test_invalid_input.rb
-- test/test_monkey_patching.rb
-- test/test_range.rb
-- test/test_regexp.rb
-homepage: https://github.com/dpep/rb_rekey
+- lib/rekey/version.rb
+- rekey.gemspec
+homepage: https://github.com/dpep/rekey_rb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -81,25 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Rekey
-test_files:
-- test/test_array_block.rb
-- test/test_array_handlers.rb
-- test/test_empty_input.rb
-- test/test_hash_block.rb
-- test/test_hash_handlers.rb
-- test/test_invalid_input.rb
-- test/test_monkey_patching.rb
-- test/test_range.rb
-- test/test_regexp.rb
+test_files: []

data/test/test_array_block.rb

@@ -1,55 +0,0 @@
-require 'minitest/autorun'
-require_relative '../lib/rekey'
-
-
-class RekeyArrayBlockTest < Minitest::Test
-
-  def setup
-    @input = [*1..3]
-  end
-
-  def test_all
-    assert_equal({
-        1 => 1,
-        2 => 2,
-        3 => 3,
-      },
-      @input.rekey {|v| v }
-    )
-
-    assert_equal({
-        1 => 1,
-        2 => 2,
-        3 => 3,
-      },
-      @input.rekey(&:itself)
-    )
-
-    assert_equal({
-        2 => 1,
-        4 => 2,
-        6 => 3,
-      },
-      @input.rekey {|v| v * 2 }
-    )
-
-    assert_equal({
-        '1' => 1,
-        '2' => 2,
-        '3' => 3,
-      },
-      @input.rekey {|v| v.to_s }
-    )
-
-    assert_equal(
-      { nil => 3 },
-      @input.rekey {|v| nil }
-    )
-
-    assert_equal(
-      { 123 => 3 },
-      @input.rekey { 123 }
-    )
-  end
-
-end

data/test/test_array_handlers.rb

@@ -1,129 +0,0 @@
-require 'minitest/autorun'
-require_relative '../lib/rekey'
-
-
-class RekeyArrayHandlersTest < Minitest::Test
-
-  def setup
-    @input = [*1..3]
-  end
-
-
-  def test_keys
-    assert_equal({
-        '1' => 1,
-        '2' => 2,
-        '3' => 3,
-      },
-      @input.rekey(:to_s)
-    )
-
-    assert_equal({
-        '1' => 1,
-        '2' => 2,
-        '3' => 3,
-      },
-      @input.rekey('to_s')
-    )
-
-    assert_equal({
-        1.0 => 1,
-        2.0 => 2,
-        3.0 => 3,
-      },
-      @input.rekey(:to_f)
-    )
-
-    assert_equal({
-        1.0 => 1,
-        2.0 => 2,
-        3.0 => 3,
-      },
-      @input.rekey(&:to_f)
-    )
-  end
-
-
-  def test_both
-    assert_equal({
-        1 => 1,
-        2 => 2,
-        3 => 3,
-      },
-      @input.rekey(:to_i, :to_i)
-    )
-
-    assert_equal({
-        '1' => 1.0,
-        '2' => 2.0,
-        '3' => 3.0,
-      },
-      @input.rekey(:to_s, :to_f)
-    )
-
-    assert_equal({
-        '1' => 1.0,
-        '2' => 2.0,
-        '3' => 3.0,
-      },
-      @input.rekey('to_s', 'to_f')
-    )
-  end
-
-
-  def test_array_indices
-    array_data = [
-      [ 1, 2, 3 ],
-      [ 4, 5, 6 ],
-      [ 7, 8, 9 ],
-    ]
-
-    assert_equal({
-        1 => 3,
-        4 => 6,
-        7 => 9,
-      },
-      array_data.rekey(0, 2)
-    )
-
-    array_data = [
-      [ 1 ],
-      [ 2, 1 ],
-      [ 3, 2, 1 ],
-    ]
-    assert_equal({
-        1 => 1,
-        2 => 2,
-        3 => 3,
-      },
-      array_data.rekey(0, :count)
-    )
-  end
-
-
-  def test_hash_indices
-    data = [
-      { i: 1, v: 'a' },
-      { i: 2, v: 'b' },
-      { i: 3, v: 'c' },
-    ]
-
-    assert_equal({
-        1 => data[0],
-        2 => data[1],
-        3 => data[2],
-      },
-      data.rekey(:i)
-    )
-
-    assert_equal({
-        1 => 'a',
-        2 => 'b',
-        3 => 'c',
-      },
-      data.rekey(:i, :v)
-    )
-  end
-
-
-end

data/test/test_empty_input.rb

@@ -1,25 +0,0 @@
-require 'minitest/autorun'
-require 'set'
-require_relative '../lib/rekey'
-
-
-class RekeyEmptyInputTest < Minitest::Test
-
-  def test_all
-    assert_equal(
-      {},
-      [].rekey(:k, :v)
-    )
-
-    assert_equal(
-      {},
-      {}.rekey(:k, :v)
-    )
-
-    assert_equal(
-      {},
-      Set.new.rekey(:k, :v)
-    )
-  end
-
-end

data/test/test_hash_block.rb

@@ -1,74 +0,0 @@
-require 'minitest/autorun'
-require_relative '../lib/rekey'
-
-
-class RekeyHashBlockTest < Minitest::Test
-  def setup
-    @input = {
-      a: 1,
-      b: 2,
-      c: 3,
-    }
-  end
-
-  def test_arity1_keys
-    assert_equal({
-        1 => 1,
-        2 => 2,
-        3 => 3,
-      },
-      @input.rekey {|v| v }
-    )
-
-    assert_equal({
-        '1' => 1,
-        '2' => 2,
-        '3' => 3,
-      },
-      @input.rekey {|v| v.to_s }
-    )
-
-    # it can use Arrays as Hash keys...if you really want to
-    assert_equal({
-        [1] => 1,
-        [2] => 2,
-        [3] => 3,
-      },
-      @input.rekey {|v| [v] }
-    )
-  end
-
-  def test_arity2_keys
-    assert_equal({
-        1 => 1,
-        2 => 2,
-        3 => 3,
-      },
-      @input.rekey {|k, v| v }
-    )
-
-    assert_equal({
-        a: 1,
-        b: 2,
-        c: 3,
-      },
-      @input.rekey {|k, v| k }
-    )
-
-    assert_equal({
-        'aa' => 1,
-        'bb' => 2,
-        'cc' => 3,
-      },
-      @input.rekey {|k, v| k.to_s * 2 }
-    )
-  end
-
-  def test_nil_key
-    assert_equal(
-      { nil => 3 },
-      @input.rekey {|k, v| nil }
-    )
-  end
-
-end

data/test/test_hash_handlers.rb

@@ -1,112 +0,0 @@
-require 'minitest/autorun'
-require_relative '../lib/rekey'
-
-
-class RekeyHashHandlersTest < Minitest::Test
-
-  def setup
-    @input = {
-      a: 1,
-      b: 2,
-      c: 3,
-    }
-  end
-
-
-  def test_keys
-    assert_equal({
-        '1' => 1,
-        '2' => 2,
-        '3' => 3,
-      },
-      @input.rekey(:to_s)
-    )
-
-    assert_equal({
-        1.0 => 1,
-        2.0 => 2,
-        3.0 => 3,
-      },
-      @input.rekey(:to_f)
-    )
-  end
-
-
-  def test_both
-    assert_equal({
-        1 => 1,
-        2 => 2,
-        3 => 3,
-      },
-      @input.rekey(:to_i, :to_i)
-    )
-
-    assert_equal({
-        '1' => 1.0,
-        '2' => 2.0,
-        '3' => 3.0,
-      },
-      @input.rekey(:to_s, :to_i)
-    )
-
-    assert_equal({
-        '1' => 1.0,
-        '2' => 2.0,
-        '3' => 3.0,
-      },
-      @input.rekey('to_s', 'to_i')
-    )
-  end
-
-
-  def test_hash_array
-    data = {
-      a: [ 1, 2, 3 ],
-      b: [ 4, 5, 6 ],
-      c: [ 7, 8, 9 ],
-    }
-
-    assert_equal({
-        1 => 2,
-        4 => 5,
-        7 => 8,
-      },
-      data.rekey(0, 1)
-    )
-
-    assert_equal({
-        1 => 3,
-        4 => 6,
-        7 => 9,
-      },
-      data.rekey(:min, :max)
-    )
-  end
-
-
-  def test_hash_hash
-    data = {
-      a: { i: 1, v: 2 },
-      b: { i: 2, v: 4 },
-      c: { i: 3, v: 6 },
-    }
-
-    assert_equal({
-        1 => { i: 1, v: 2 },
-        2 => { i: 2, v: 4 },
-        3 => { i: 3, v: 6 },
-      },
-      data.rekey(:i)
-    )
-
-    assert_equal({
-        1 => 2,
-        2 => 4,
-        3 => 6,
-      },
-      data.rekey(:i, :v)
-    )
-
-  end
-
-end

data/test/test_invalid_input.rb

@@ -1,50 +0,0 @@
-require 'minitest/autorun'
-require_relative '../lib/rekey'
-
-
-class RekeyInvalidInputTest < Minitest::Test
-  def setup
-    @input = [*1..3]
-  end
-
-
-  def test_nil
-    assert_raises ArgumentError do
-      @input.rekey
-    end
-
-    assert_raises ArgumentError do
-      @input.rekey nil
-    end
-
-    assert_raises ArgumentError do
-      @input.rekey nil, :v
-    end
-
-    # unfortunately, these still pass
-    @input.rekey(nil) {|v| v}
-    @input.rekey(nil, nil) {|v| v}
-  end
-
-
-  def test_handles_and_block
-    assert_raises ArgumentError do
-      @input.rekey(:k) {|k| 1}
-    end
-
-    assert_raises ArgumentError do
-      @input.rekey(:k, :v) {|k| 1}
-    end
-  end
-
-
-  def test_block_underflow
-    # block requesting key and value, but @input
-    # doesn't have keys
-    assert_raises ArgumentError do
-      @input.rekey {|k, v| 1}
-    end
-  end
-
-
-end

data/test/test_monkey_patching.rb

@@ -1,44 +0,0 @@
-require 'minitest/autorun'
-require 'set'
-require_relative '../lib/rekey/rekey'
-
-
-class MonkeyPatchingTest < Minitest::Test
-
-  def test_not_installed
-    if defined? Rekey::VERSION
-      # entire library was loaded, so these tests are invalid.
-      # this happens when run through `rake`
-      skip
-    end
-
-    # `require 'rekey/rekey'` should load Rekey
-    assert Rekey
-
-    # but no monkey patching
-    assert_raises NoMethodError do
-      [ 1, 2, 3 ].rekey 0
-    end
-
-    assert_raises NoMethodError do
-      { a: 1 }.rekey 0
-    end
-
-    assert_raises NoMethodError do
-      Set.new([ 1, 2, 3 ]).rekey 0
-    end
-
-    puts 'yay, no monkey patching'
-  end
-
-
-  def test_pluckit
-    assert PluckIt
-
-    assert_raises NoMethodError do
-      [ 1, 2, 3 ].pluck 0
-    end
-  end
-
-
-end

data/test/test_range.rb

@@ -1,30 +0,0 @@
-require 'minitest/autorun'
-require_relative '../lib/rekey'
-
-
-class RekeyRangeTest < Minitest::Test
-
-  def setup
-    @input = [
-      [ 1, 2, 3 ],
-      [ 4, 5, 6 ],
-    ]
-  end
-
-  def test_stuff
-    assert_equal({
-        [ 1, 2 ] => [ 1, 2, 3 ],
-        [ 4, 5 ] => [ 4, 5, 6 ],
-      },
-      @input.rekey(0..1)
-    )
-
-    assert_equal({
-        3 => [ 1, 2 ],
-        6 => [ 4, 5 ],
-      },
-      @input.rekey(2, 0..1)
-    )
-  end
-
-end

data/test/test_regexp.rb

@@ -1,30 +0,0 @@
-require 'minitest/autorun'
-require_relative '../lib/rekey'
-
-
-class RekeyRegexpTest < Minitest::Test
-
-  def setup
-    @input = [
-      [ 'a', 'aa', 'b', 'ba', 'dd' ],
-      [ 'b', 'c', 'bc', 'de' ],
-    ]
-  end
-
-  def test_stuff
-    assert_equal({
-        'a' => ['a', 'aa', 'ba'],
-        'b' => [],
-      },
-      @input.rekey(0, /a/)
-    )
-
-    assert_equal({
-        ['dd'] => ['b', 'ba'],
-        ['de'] => ['b', 'bc'],
-      },
-      @input.rekey(/d/, /b/)
-    )
-  end
-
-end