weak 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d9cec118afb4ce760b9f1881b0489f9e9b1954ad5c20727d8d1124f9d80027d
-  data.tar.gz: f0fd0cef1c7ce6403fb12630b880cb262063bc759100cfc4a6c7896cd0721e98
+  metadata.gz: 86165785c0d1874c5c54d7a72c3b703f5a21832cf0df8ffa917b4793dc40c502
+  data.tar.gz: a02c81a859c4f887181a2e33a124d6584a987d40cde92770fd1d6953a836f10d
 SHA512:
-  metadata.gz: c91a2284ad2a25a96ede2f44fcb2e6ed94d08342d83fefe3096c867385369b5ad48977fea610f611894ed763e981cb1b424dd84c23471ba9fb9bc3c19941b8c4
-  data.tar.gz: 2bfd81fc7bb755ee7156a30527478c745dd10e8fff4b5865af823b3726c7105302d446aea9afc3e8c5d4e51ce612e28005c98cb8af5b0a76f98891aa0313cf36
+  metadata.gz: 60d9a3259f88cd37a001b60fdf5247a856d1c637a54d0085712b347ab9b4c0dda330e8cabe69ead1bdf8193fdb70d8a0f7b419ea407afdcbea0b8e659331473c
+  data.tar.gz: b2dbc7c76ee9fd24d1a06df292e4683f5f5eb1a1b7a2d9db6ab653e691e818d3d6b3975589e020c47daede1b50ab48a4c417830af1c7b4cac12a9e2b61dc47f1

data/.yardopts

@@ -0,0 +1,12 @@
+--protected
+--no-private
+--markup markdown
+--title=Weak
+--template default
+--default-return undocumented
+lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+LICENSE.txt

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [Unreleased]
+
+## [0.2.0] - 2025-04-09
+
+- Add `Weak::Map#delete_if`
+- Add `Weak::Map#keep_if`
+- Add `Weak::Map#reject!`
+- Add `Weak::Map#replace`
+- Add `Weak::Map#select!`
+- Add `Weak::Map#values_at`
+
 ## [0.1.0] - 2025-03-14
 
 - Initial version of `Weak::Set` to store an unordered collection of objects.

data/lib/weak/map.rb

@@ -270,15 +270,14 @@ module Weak
     INSPECT_KEY = :__inspect_key__
     private_constant :INSPECT_KEY
 
-    # @param maps [Array<#each_pair>] a list of maps which should be
-    #   merged into the new {Weak::Map}
+    # @param maps [Array<Weak::Map, Hash, #to_hash>] a list of maps which should
+    #   be merged into the new {Weak::Map}
     # @return [Weak::Map] a new {Weak::Map} object populated with the given
     #   objects, if any. With no argument, returns a new empty {Weak::Map}.
     # @example
     #   hash = {foo: 0, bar: 1, baz: 2}
     #   Weak::Map[hash]
     #   # => #<Weak::Map {:foo=>0, :bar=>1, :baz=>2}>
-
     def self.[](*maps)
       Weak::Map.new.merge!(*maps)
     end
@@ -432,6 +431,26 @@ module Weak
       proc
     end
 
+    # Deletes every key-value pair from `self` for which the given block
+    # evaluates to a truthy value.
+    #
+    # If no block is given, an `Enumerator` is returned instead.
+    #
+    # @yield [key, value] calls the given block once for each key in the map
+    # @yieldparam key [Object] a key
+    # @yieldparam value [Object] the corresponding value
+    # @return [Enumerator, self] `self` if a block was given or an `Enumerator`
+    #   if no block was given.
+    # @see reject!
+    def delete_if(&block)
+      return enum_for(__method__) { size } unless block_given?
+
+      each do |key, value|
+        delete(key) if yield(key, value)
+      end
+      self
+    end
+
     # @return [Boolean] `true` if `self` contains no elements
     def empty?
       size == 0
@@ -475,17 +494,37 @@ module Weak
     end
     alias_method :to_s, :inspect
 
+    # Deletes every key-value pair from `self` for which the given block
+    # evaluates to a falsey value.
+    #
+    # If no block is given, an `Enumerator` is returned instead.
+    #
+    # @yield [key, value] calls the given block once for each key in the map
+    # @yieldparam key [String] a hash key
+    # @yieldparam value [Object] the corresponding hash value
+    # @return [Enumerator, self] `self` if a block was given, an `Enumerator`
+    #  if no block was given.
+    # @see select!
+    def keep_if(&block)
+      return enum_for(__method__) { size } unless block_given?
+
+      each do |key, value|
+        delete(key) unless yield(key, value)
+      end
+      self
+    end
+
     # Returns the new {Weak::Map} formed by merging each of `other_maps` into a
     # copy of `self`.
     #
-    # Each argument in other_maos must be respond to `each_pair`, e.g. a
-    # {Weak::Map} or a `Hash`.
+    # Each argument in `other_maps` must be either a {Weak::Map}, a Hash object
+    # or must be transformable to a Hash by calling `each_hash` on it.
     #
     # With arguments and no block:
     #
     #   - Returns a new {Weak::Map}, after the given maps are merged into a copy
     #     of `self`.
-    #   - The given hashes are merged left to right.
+    #   - The given maps are merged left to right.
     #   - Each duplicate-key entry’s value overwrites the previous value.
     #
     # Example:
@@ -502,7 +541,7 @@ module Weak
     # With arguments and a block:
     #
     #   - Returns `self`, after the given maps are merged.
-    #   - The given hashes are merged left to right.
+    #   - The given maps are merged left to right.
     #   - For each duplicate key:
     #     - Calls the block with the key and the old and new values.
     #     - The block’s return value becomes the new value for the entry.
@@ -526,8 +565,8 @@ module Weak
     #   - Returns a copy of `self`.
     #   - The block, if given, is ignored.
     #
-    # @param other_maps [Array<#each_pair>] a list of maps which should be
-    #   merged into a copy of `self`
+    # @param other_maps [Array<Weak::Map, Hash, #to_hash>] a list of maps which
+    #   should be merged into a copy of `self`
     # @yield [key, old_value, new_value] If `self` already contains a value for
     #   a key, we yield the key, the old value from `self` and the new value
     #   from the given map and use the value returned from the block as the new
@@ -551,15 +590,87 @@ module Weak
       end
     end
 
+    # Deletes every key-value pair from `self` for which the given block
+    # evaluates to a truethy value.
+    #
+    # Equivalent to {#delete_if}, but returns `nil` if no changes were made.
+    #
+    # If no block is given, an `Enumerator` is returned instead.
+    #
+    # @yield [key, value] calls the given block once for each key in the map
+    # @yieldparam key [Object] a key
+    # @return [Enumerator, self, nil] `self` if a block was given and some
+    #    element(s) were deleted, `nil` if a block was given but no keys were
+    #   deleted, or an `Enumerator` if no block was given.
+    # #see #delete_if
+    def reject!(&block)
+      return enum_for(__method__) { size } unless block_given?
+
+      deleted_anything = false
+      each do |key, value|
+        next unless yield(key, value)
+
+        delete(key)
+        deleted_anything = true
+      end
+
+      self if deleted_anything
+    end
+
+    # Replaces the contents of `self` with the contents of the given Hash-like
+    # object and returns `self`.
+    #
+    # If the given `map` defines a {#default} value or {#default_proc}, this
+    # will also replace the respective seting in `self`.
+    #
+    # @param map (see #_implicit)
+    # @return [self]
+    # @example
+    #     map = Weak::Map[a: 1, b: 3, c: 1] #=> #<Weak::Map {a: 1, b: 3, c: 1}>
+    #     map.replace({x: :y})              #=> #<Weak::Map {x: :y}>
+    #     map                               #=> #<Weak::Map {x: :y}>
+    def replace(map)
+      initialize_copy(_implicit(map))
+    end
+
+    # Deletes every key-value pair from `self` for which the given block
+    # evaluates to a falsey value.
+    #
+    # Equivalent to {#keep_if}, but returns `nil` if no changes were made.
+    #
+    # If no block is given, an `Enumerator` is returned instead.
+    #
+    # @yield [key, value] calls the given block once for each key in the map
+    # @yieldparam key [Object] a key
+    # @yieldparam value [Object] the corresponding value
+    # @return [Enumerator, self, nil] `self` if a block was given and some
+    #    element(s) were deleted, `nil` if a block was given but nothing was
+    #    deleted, or an `Enumerator` if no block was given.
+    # @see keep_if
+    def select!(&block)
+      return enum_for(__method__) { size } unless block_given?
+
+      deleted_anything = false
+      each do |key, value|
+        next if yield(key, value)
+
+        delete(key)
+        deleted_anything = true
+      end
+
+      self if deleted_anything
+    end
+    alias_method :filter!, :select!
+
     # Merges each of `other_maps` into `self`; returns `self`.
     #
-    # Each argument in other_maos must be respond to `each_pair`, e.g. a
-    # {Weak::Map} or a `Hash`.
+    # Each argument in `other_maps` must be either a {Weak::Map}, a Hash object
+    # or must be transformable to a Hash by calling `each_hash` on it.
     #
     # With arguments and no block:
     #
     #   - Returns self, after the given maps are merged into it.
-    #   - The given hashes are merged left to right.
+    #   - The given maps are merged left to right.
     #   - Each duplicate-key entry’s value overwrites the previous value.
     #
     # Example:
@@ -576,7 +687,7 @@ module Weak
     # With arguments and a block:
     #
     #   - Returns `self`, after the given maps are merged.
-    #   - The given hashes are merged left to right.
+    #   - The given maps are merged left to right.
     #   - For each duplicate key:
     #     - Calls the block with the key and the old and new values.
     #     - The block’s return value becomes the new value for the entry.
@@ -600,8 +711,8 @@ module Weak
     #   - Returns `self`.
     #   - The block, if given, is ignored.
     #
-    # @param other_maps [Array<#each_pair>] a list of maps which should be
-    #   merged into `self`
+    # @param other_maps [Array<Weak::Map, Hash, #to_hash>] a list of maps which
+    #    should be merged into `self`
     # @yield [key, old_value, new_value] If `self` already contains a value for
     #   a key, we yield the key, the old value from `self` and the new value
     #   from the given map and use the value returned from the block as the new
@@ -618,7 +729,7 @@ module Weak
         missing = Object.new
 
         other_maps.each do |map|
-          map.each_pair do |key, value|
+          _implicit(map).each_pair do |key, value|
             old_value = fetch(key, missing)
             value = yield(key, old_value, value) unless missing == old_value
             self[key] = value
@@ -626,7 +737,7 @@ module Weak
         end
       else
         other_maps.each do |map|
-          map.each_pair do |key, value|
+          _implicit(map).each_pair do |key, value|
             self[key] = value
           end
         end
@@ -675,6 +786,25 @@ module Weak
       hash
     end
 
+    # Returns a new `Array` containing values for the given keys:
+    #
+    #     map = Weak::Map[foo: 0, bar: 1, baz: 2]
+    #     map.values_at(:baz, :foo)
+    #     # => [2, 0]
+    #
+    # The default values are returned for any keys that are not found:
+    #
+    #     map.values_at(:hello, :foo)
+    #     # => [nil, 0]
+    #
+    # @param keys [Array<Object>] a list of keys
+    # @return [Array] an `Array` containing the values for the given keys if
+    #   present or the default value if not. The order of the given `keys` is
+    #   preserved.
+    def values_at(*keys)
+      keys.map { |key| self[key] }
+    end
+
     private
 
     # Callback method which is called on the new object during `dup` or `clone`
@@ -710,5 +840,21 @@ module Weak
         )
       end
     end
+
+    # @param map [Weak::Map, Hash, #to_hash] a {Weak::Map} or a Hash object or
+    #   an object which can be converted to a `Hash` by calling `to_hash` on it
+    # @return [Weak::Map, Hash] either a `Weak::Map` or a `Hash` object
+    #   converted from the given `map`
+    # @raise [TypeError] if the given `map` is not a {Weak::Map} and not a
+    #   `Hash`, and could not ge converted to a Hash
+    def _implicit(map)
+      if Weak::Map === map || ::Hash === map
+        map
+      elsif (hash = ::Hash.try_convert(map))
+        hash
+      else
+        raise TypeError, "no implicit conversion of #{map.class} into #{self.class}"
+      end
+    end
   end
 end

data/lib/weak/version.rb

@@ -10,5 +10,5 @@ module Weak
   # The {Weak} version as a `Gem::Version` string. We follow semantic
   # versioning.
   # @see https://semver.org/
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: weak
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Holger Just
 bindir: bin
 cert_chain: []
-date: 2025-03-14 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies: []
 description: |
   The Weak library provides a Weak::Set class to store an unordered list of
@@ -18,6 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
@@ -44,7 +45,7 @@ metadata:
   homepage_uri: https://github.com/meineerde/weak
   source_code_uri: https://github.com/meineerde/weak
   changelog_uri: https://github.com/meineerde/weak/blob/main/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/weak/0.1.0
+  documentation_uri: https://www.rubydoc.info/gems/weak/0.2.0
 rdoc_options: []
 require_paths:
 - lib
@@ -61,5 +62,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.3
 specification_version: 4
-summary: Tools to use handle collections of weak-referenced values in Ruby
+summary: Tools to handle collections of weakly-referenced values
 test_files: []