deepmap 0.2.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4cf7c264a6edf69602a9ae213c0f039b4c819160c4661bdfe376512f58a971b
-  data.tar.gz: d321c60e683abeb46d3d72aef3511df43fe243e4664ddbc5dc5ddfbbacfa8d7e
+  metadata.gz: 240ee3a7cd29cd15d11424600fc2940cfbcc7983fefe6ae01be3c22fc8683a96
+  data.tar.gz: 52145a92013910d58b1130b1f6a18a68562db6d4c833ec8d800d3ccaaca1a403
 SHA512:
-  metadata.gz: 90caafddebe9ce0e01df2524c7485dbf9071de1c9224cf3b9422a6a510c3364c0a5a94315c235d5f2d699e429df934b83adbd8419ae24bbc99d3e640919a100f
-  data.tar.gz: c09f6ed63e01037c3433dced30f3ad5d447cd6b72018526b9bfb149571cbec26459a43385a4931d68fca6488c071051c72b1d662038d71184dfdda5a970efc90
+  metadata.gz: d850a9b0a49e7a19734c8ab7f94b074a01eb3216089d72a9c2f2911a4abacf545ecc4f8bcdc155df6c0c2ec7a24c4684e757b64ca4063f6b0596efe534a890d2
+  data.tar.gz: 7702ed7f53b51a6030712286d870491feafdb9544aa40f35442aa07324c0b0eea2e06a4cba8dd7dd34259fb045ba450d81084f362fb00408d90ecb7f20fde928

data/lib/deepmap/deepmap.rb

@@ -1,19 +1,30 @@
-# Creating deep_map, key_map, val_map methods in DeepMap.
+# frozen_string_literal: true
 
+# Creating deep_map, key_map, val_map methods in DeepMap.
 module DeepMap
-  def deep_map
-    return self if !block_given?
-    recurse { |x| yield x }
+  # Raised when on_collision: :raise is set and a key transform produces
+  # duplicate keys within the same hash level.
+  class KeyCollisionError < StandardError; end
+
+  # Valid on_collision modes for deep_map and key_map.
+  COLLISION_MODES = %i[warn raise ignore].freeze
+
+  def deep_map(on_collision: :warn, &block)
+    return self unless block
+
+    recurse(self, t: 'both', on_collision: collision_mode(on_collision), &pairable(block))
   end
 
-  def key_map
-    return self if !block_given?
-    recurse("key") { |x| yield x }
+  def key_map(on_collision: :warn, &block)
+    return self unless block
+
+    recurse(self, t: 'key', on_collision: collision_mode(on_collision), &pairable(block))
   end
 
-  def val_map
-    return self if !block_given?
-    recurse("val") { |x| yield x }
+  def val_map(&block)
+    return self unless block
+
+    recurse(self, t: 'val', &pairable(block))
   end
 
   private
@@ -24,32 +35,59 @@ module DeepMap
   # the key is a hash, than collect the results of calling it recursively. If
   # the key is an array, then map the recursive method over each item in the
   # array. If it is niether a hash or an array, then apply the block to that
-  # item, and return the result.
+  # item, and return the result. 'k' carries the nearest ancestor hash key down
+  # through arrays/leaves so value blocks can optionally see it too.
 
-  def recurse(t = "both", h = self)
-    if h.is_a?(Hash)
-      hash_collect(t, h) { |x| yield x }
+  def recurse(h, k = nil, t:, on_collision: :warn, &block)
+    case h
+    when Hash
+      hash_collect(h, t:, on_collision:, &block)
 
-    elsif h.is_a?(Array)
-      h.map { |v| recurse(t, v) { |x| yield x } }
+    when Array
+      h.map { |v| recurse(v, k, t:, on_collision:, &block) }
 
     else # apply to value
-      t == "key" ? h : yield(h)
+      t == 'key' ? h : yield(h, k)
+
+    end
+  end
 
+  # Transformed keys that collide collapse in to_h (last pair wins), which is
+  # detectable as the result shrinking. Val mode never transforms keys, so it
+  # can never shrink and needs no special casing here.
+  def hash_collect(h, t:, on_collision:, &block)
+    pairs = h.map do |k, v|
+      [t == 'val' ? k : yield(k, v), recurse(v, k, t:, on_collision:, &block)]
     end
+
+    result = pairs.to_h
+    report_collisions(pairs, on_collision) if result.size < pairs.size
+    result
+  end
+
+  def report_collisions(pairs, on_collision)
+    return if on_collision == :ignore
+
+    dupes = pairs.map(&:first).tally.select { |_, count| count > 1 }.keys
+    message = "deepmap: key collision(s) produced duplicate key(s) #{dupes.inspect}; " \
+              'earlier entries will be overwritten'
+    raise KeyCollisionError, message if on_collision == :raise
+
+    warn message
   end
 
-  def hash_collect(t, h)
-    Hash[h.collect { |k, v|
-      case t # type
-      when "both", "key"
-        [yield(k), recurse(t, v) { |x| yield x }]
+  def collision_mode(mode)
+    return mode if COLLISION_MODES.include?(mode)
 
-      when "val"
-        [k, recurse(t, v) { |x| yield x }]
+    raise ArgumentError, "on_collision must be one of #{COLLISION_MODES.inspect}, got #{mode.inspect}"
+  end
 
-      end
-    }]
+  # Blocks are yielded two arguments (the mapped item plus its counterpart).
+  # Plain blocks that mention one argument just discard the second, but strict
+  # arity callables (&:method, method references, lambdas) would not -- wrap
+  # those so they keep receiving the single argument they expect.
+  def pairable(block)
+    block.lambda? && block.arity != 2 ? proc { |a| block.call(a) } : block
   end
 end
 

data/lib/deepmap/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DeepMap
+  VERSION = '1.1.0'
+end

data/readme.md

@@ -57,6 +57,45 @@ irb(main):005:0> test.val_map(&:upcase)
 => {"a"=>"B", "c"=>["D", "E"], "f"=>{"g"=>["H", "I", {"j"=>"K"}]}}
 ```
 
+Blocks may also take a second argument to make decisions based on both the key
+and the value, even while nominally mapping over just one of them. For
+`key_map`, the first argument is the key and the second is the value; for
+`val_map` it's the other way around, so single-argument blocks (including the
+`&:method` shortcut) keep working exactly as before:
+
+```ruby
+irb(main):002:0> test = { 1 => 'a', -2 => 'b', 3 => 'c' }
+=> {1=>"a", -2=>"b", 3=>"c"}
+
+irb(main):003:0> test.key_map {|k, v| k.positive? ? k * 10 : v }
+=> {10=>"a", "b"=>"b", 30=>"c"}
+
+irb(main):004:0> test.val_map {|v, k| k.positive? ? v.upcase : v }
+=> {1=>"A", -2=>"b", 3=>"C"}
+```
+
+## key collisions
+
+Since `key_map` and `deep_map` can map two different keys to the same new key,
+it's possible for the resulting hash to silently drop an entry (the last pair
+wins). By default this is checked for and reported with a warning; pass
+`on_collision:` to `key_map`/`deep_map` to change that behavior:
+
+```ruby
+irb(main):002:0> { 1 => 'a', 2 => 'b' }.key_map {|k| 0 }
+deepmap: key collision(s) produced duplicate key(s) [0]; earlier entries will be overwritten
+=> {0=>"b"}
+
+irb(main):003:0> { 1 => 'a', 2 => 'b' }.key_map(on_collision: :raise) {|k| 0 }
+DeepMap::KeyCollisionError: deepmap: key collision(s) produced duplicate key(s) [0]; earlier entries will be overwritten
+
+irb(main):004:0> { 1 => 'a', 2 => 'b' }.key_map(on_collision: :ignore) {|k| 0 }
+=> {0=>"b"}
+```
+
+`val_map` never transforms keys, so it has no `on_collision` option. Passing
+anything other than `:warn`, `:raise`, or `:ignore` raises an `ArgumentError`.
+
 ## development / testing
 
 First, clone this repo:
@@ -72,16 +111,10 @@ try running `gem install bundler`. Once that is done:
 Now, we should be able to build the gem locally. This will build the local
 deepmap gem and link it in your path, so you can playing around with `deepmap`.
 
-    bundle exec rake build
-
-This uses `rspec` and `rake` to run a suite of unit tests. To run the suite:
-
-    bundle exec rake
+    just build
 
-## todo
+This uses `rspec`, `rubocop`, and `simplecov` to run and check a suite of unit
+tests. To run the full suite:
 
-* collison checking/warning/confirmation workflow
-* support key-val iteration in mapping over vals/keys. This would allow support
-  for mapping conditionally based on a key/value, even if you are iterating
-  over all values/keys (`key_map {|k, v| k > 0 ? k : v }`).
+    just ci
 

metadata

@@ -1,75 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: deepmap
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeremy Warner
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: colored
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
-  name: rufo
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.22.0
 description: Map functions over nested hash/arrays objects (e.g., YAML, JSON).
 email: jeremywrnr@gmail.com
 executables: []
@@ -77,12 +64,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/deepmap/deepmap.rb
+- lib/deepmap/version.rb
 - readme.md
 homepage: http://github.com/jeremywrnr/deepmap
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib/deepmap
@@ -90,15 +77,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Nested hash/array function mapping.
 test_files: []