weak 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d9cec118afb4ce760b9f1881b0489f9e9b1954ad5c20727d8d1124f9d80027d
+  data.tar.gz: f0fd0cef1c7ce6403fb12630b880cb262063bc759100cfc4a6c7896cd0721e98
+SHA512:
+  metadata.gz: c91a2284ad2a25a96ede2f44fcb2e6ed94d08342d83fefe3096c867385369b5ad48977fea610f611894ed763e981cb1b424dd84c23471ba9fb9bc3c19941b8c4
+  data.tar.gz: 2bfd81fc7bb755ee7156a30527478c745dd10e8fff4b5865af823b3726c7105302d446aea9afc3e8c5d4e51ce612e28005c98cb8af5b0a76f98891aa0313cf36

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## [0.1.0] - 2025-03-14
+
+- Initial version of `Weak::Set` to store an unordered collection of objects.
+- Initial version of `Weak::Map` to store key-value pairs of objects.
+
+- Support for Ruby 3.0 using the following impementations
+    - Ruby (aka. MRI, aka. YARV) >= 3.0
+    - JRuby >= 9.4
+    - TruffleRuby >= 22
+
+## [0.0.1.pre] - 2025-02-05
+
+- First blank slate

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+https://github.com/meineerde/weak/issues/new or privately by contacting
+Holger Just using the communication methods mentioned at
+https://holgerjust.de/contact/.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Holger Just
+
+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,232 @@
+# Weak
+
+[![gem version badge](https://badge.fury.io/rb/weak.svg)](https://rubygems.org/gems/weak)
+[![CI status badge](https://github.com/meineerde/weak/actions/workflows/ci.yml/badge.svg)](https://github.com/meineerde/weak/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/meineerde/weak/badge.svg?branch=main)](https://coveralls.io/github/meineerde/weak?branch=main)
+
+Weak is a Ruby library which implements collections of unordered values without strong object references.
+
+We provide multiple classes which behave similar to their standard-library counterparts. However, all elements are only weakly referenced. That way, all elements can be garbage collected and silently removed from the collection unless they are still referenced from some other live object.
+
+## Weak::Set 
+
+`Weak::Set` behaves similar to the [Set](https://docs.ruby-lang.org/en/3.4/Set.html) class of the Ruby standard library, but all values are only weakly referenced. That way, all values can be garbage collected and silently removed from the set unless they are still referenced from some other live object.
+
+Compared to the `Set` class however, there are a few differences:
+
+  - All element references are weak, allowing each element to be garbage collected unless there is a strong reference to it somwhere else.
+  - We do not necessarily retain the order of elements as they are inserted into the `Weak::Set`. You should not rely on a specific order.
+  - Set membership is governed by object identity rather than by using the `hash` and `eql?` methods of the elements. A `Weak::Set` thus works similat to a `Set` marked as [compare_by_identity](https://docs.ruby-lang.org/en/3.4/Set.html#method-i-compare_by_identity).
+  - You can freely change any objects added to the `Weak::Set`.
+
+```ruby
+require "weak/set"
+set = Weak::Set.new
+
+set << "some string"
+# => #<Weak::Set {"some string"}>
+
+# Do some work, wait a bit, or force a garbage collection run
+3.times { GC.start }
+
+set
+# => #<Weak::Set {}>
+```
+
+## Weak::Map
+
+`Weak::Map` behaves similar to a `Hash` or an `ObjectSpace::WeakMap` in Ruby (aka. MRI, aka. YARV). 
+Both keys and values are weak references, allowing either of them to be garbage collected. If either the key or the value of a pair is garbage collected, the entire pair will be removed from the `Weak::Map`.
+
+Compared to the `Set` class however, there are a few differences:
+
+  - Key and value references are weak, allowing each key-value pair to be garbage collected unless there is a strong reference to boith the key and the value somewhere else.
+  - We do not necessarily retain the order of elements as they are inserted into the `Weak::Map`. You should not rely on a specific order.
+  - Map membership is governed by object identity of the key rather than by using the `hash` and `eql?` methods of the elements. A `Weak::Map` thus works similat to a `Hash` marked as [compare_by_identity](https://docs.ruby-lang.org/en/3.4/Hash.html#method-i-compare_by_identity).
+  - You can freely change both keys and values added to the `Weak::Map`.
+
+```ruby
+require "weak/map"
+map = Weak::Map.new
+
+map["some key"] = "a value"
+# => #<Weak::Map {"some key" => "a value"}>
+
+# Do some work, wait a bit, or force a garbage collection run
+3.times { GC.start }
+
+map
+# => #<Weak::Map {}>
+```
+
+## Usage
+
+Please refer to the documentation at:
+
+- [📘 Documentation](https://www.rubydoc.info/gems/weak)
+- [💥 Development Documentation](https://www.rubydoc.info/github/meineerde/weak/main) of the [main branch](https://github.com/meineerde/weak/tree/main)
+
+> [!WARNING]
+> The Weak collections are not inherently thread-safe. When accessing a collection from multiple threads or fibers, you MUST use a mutex or another locking mechanism.
+
+The Weak collections use Ruby's [ObjectSpace::WeakMap](https://docs.ruby-lang.org/en/3.4/ObjectSpace/WeakMap.html) under the hood. Unfortunately, different Ruby implementations and versions such as Ruby (aka. MRI, aka. YARV), JRuby, or TruffleRuby show quite diverse behavior in their respective `ObjectSpace::WeakMap` implementations. To provide a unified behavior on all supported Rubies, we use multiple different storage strategies.
+
+The appropriate strategy is selected automatically. Their exposed behavior should be identical across all implementations. If you experience diverging behavior, we consider this a bug. Please [open an issue](https://github.com/meineerde/weak/issues/new) and describe the diverging or unexpected behavior.
+
+## Installation
+
+Weak supports the following Ruby implementation:
+
+- Ruby (aka. MRI, aka. YARV) >= 3.0
+- JRuby >= 9.4
+- TruffleRuby >= 22
+
+Add the `weak` gem to the application's `Gemfile` and install it by executing:
+
+```sh
+bundle add weak
+```
+
+If [bundler](https://bundler.io/) is not being used to manage dependencies, install the gem manually by executing:
+
+```sh
+gem install weak
+```
+
+## Examples
+
+### Weak::Set Example
+
+A Weak::Set can be used as a cache or for validation purposes were it is not desirable to keep a full object reference. For example, it can be used with a basic `ConnectionPool` as follows
+
+```ruby
+require "weak/set"
+
+class Connection
+  # A sample connection class.
+  # Our ConnectionPool will return objects from this class.
+end
+
+class ConnectionPool
+  def initialize
+    @pool = []
+    @outstanding = Weak::Set.new
+    @mutex = Mutex.new
+  end
+
+  # Fetch or create a connection object. The connection object can (but does not
+  # have to) be returned to the pool again with `checkin`.
+  def checkout
+    @mutex.synchronize do
+      connection = @pool.pop || Connection.new
+      @outstanding << connection
+
+      connection
+    end
+  end
+
+  # Allows to return a previously checked-out connection object back to the pool
+  # for later re-use. Only connection objects which were previously checked-out
+  # can be returned to the pool.
+  def checkin(connection)
+    @mutex.synchronize do
+      if @outstanding.delete?(connection)
+        @pool.push connection
+      else
+        raise ArgumentError, "connection was not checked out before"
+      end
+    end
+
+    nil
+  end
+
+  # Fetch or create a connection object and yield it to the given block. After
+  # the block completes, the connection is automatically checked-in again for
+  # later re-use. The method returns the return value of the block.
+  def with
+    connection = checkout
+    begin
+      yield connection
+    ensure
+      checkin(connection)
+    end
+  end
+end
+```
+
+During `checkout` we remember a reference to the returned connection object in the `@outstanding` weak set. The caller is free to do whatever they like with the connection. Specifically, they are not required to return the connection to the pool.
+
+If the caller just "forgets" the connection, our pool will also forget it during the next Ruby garbage collection run.
+
+If the caller returns the connection by calling `checkin` again, we can verify that we have in fact created the object by deleting it from the `@outstanding` list. That way, the a checked-out connection can be checked-in again only once and only if it was initially created by the `ConnectionPool`.
+
+### Weak::Map Example
+
+Conversely a `Weak::Map` can be used to store references to other objects. In the example below, we use a single `Mutex` for each `obj` wrapped in a `LockedObject` instance.
+
+Even if a single object is wrapped in multiple `LockedObject` instances, we still use the same shared mutex in each of these instances, ensuring that the `obj` is only every accessed while holding the mutex. Different objects use different mutexes.
+
+If all LockedObject instances for an `obj` and the `obj` itself vanish by being garbage collected, the associated mutex will also be garbage collected without requiring any external coordination.
+
+```ruby
+class LockedObject < BasicObject
+  LOCKS = Weak::Map.new
+  LOCKS_MUTEX = Mutex.new
+
+  def initialize(obj)
+    @obj = obj
+
+    # Assigning the obj mutex must itself be wrapped in a different mutex as a Weak::Map
+    # is not thread-safe. We retain the mutex for obj in @mutex for the LockedObject
+    # instance.
+    LOCKS_MUTEX.synchronize do
+      @mutex = (LOCKS[obj] ||= Mutex.new)
+    end
+  end
+
+  private
+
+  def method_missing(m, *args, **kwargs, &block)
+    @mutex.synchronize do
+      obj.public_send(m, *args, **kwargs, &block)
+    end
+  end
+
+  def respond_to_missing?(m)
+    obj.respond_to?(m)
+  end
+end
+
+string = "foo"
+
+# As an example, we simulate concurrent access to the string from multiple Threads.
+# Especially on JRuby, you would likely see data corruptions without the mutex here.
+5.times do
+  Thread.new do
+    locked = Locked.new(string)
+    ("a".."z").each do |char|
+      locked << char*2
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+[![code style: standard badge](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/standardrb/standard)
+
+We follow the Standard Ruby style. Please make sure that all code is formatted according to the Standard rules. This is enforced by the CI. Please try to keep all code lines at or below 100 characters in length.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/meineerde/weak. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/meineerde/weak/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Weak project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/meineerde/weak/blob/main/CODE_OF_CONDUCT.md).

data/lib/weak/map/abstract_strong_keys.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# Copyright (c) Holger Just
+#
+# This software may be modified and distributed under the terms
+# of the MIT license. See the LICENSE.txt file for details.
+
+require "weak/map/deletable"
+
+##
+module Weak
+  class Map
+    # @abstract This module implements a common subset of (helper-)methods
+    #   for a {Weak::Map} with an `ObjectSpace::WeakMap` with strong keys, i.e.,
+    #   {StrongKeys} and {StrongSecondaryKeys}.
+    module AbstractStrongKeys
+      include Deletable
+
+      # @!macro weak_map_method_keys
+      def keys
+        each_key.to_a
+      end
+
+      # @!macro weak_map_method_size
+      def size
+        each_key.count
+      end
+
+      # @!macro weak_map_method_values
+      def values
+        each_value.to_a
+      end
+
+      private
+
+      # This method is called during {#_get}. It generally needs to be
+      # overwritten in a "sub"-mdule to automatically cleanup any internal data.
+      # The implemented `auto_prune` method should quickly check if a prune is
+      # necessary and then either call the `prune` method or return.
+      #
+      # @return [void]
+      def auto_prune
+      end
+
+      def _delete(id)
+        if have?(@keys[id])
+          @keys[id] = DeletedEntry.new
+          has_key = true
+        end
+
+        raw_value = @values[id]
+        if have?(raw_value)
+          @values[id] = DeletedEntry.new
+          return value!(raw_value) if has_key
+        end
+
+        yield
+      end
+
+      def _get(id)
+        raw_value = @values[id]
+        has_key = have?(@keys[id])
+
+        auto_prune
+        if have?(raw_value)
+          if has_key
+            # We have a stored key AND a stored value. This is the positive case
+            # where we return the stored value
+            value!(raw_value)
+          else
+            # Here, we have a stored value but a missing key which likely was
+            # garbage collected. Thus, we explicitly delete the now invalid
+            # value and act as if it was already removed.
+            @values[id] = DeletedEntry.new
+            yield
+          end
+        else
+          # Here, we do not have a stored value (e.g. because it was garbage
+          # collected or is generally absent). If we have found a valid key
+          # earlier, this key is thus invalid and we explicitly delete it.
+          @keys[id] = DeletedEntry.new if has_key
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/weak/map/deletable.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Copyright (c) Holger Just
+#
+# This software may be modified and distributed under the terms
+# of the MIT license. See the LICENSE.txt file for details.
+
+##
+module Weak
+  class Map
+    # Utility methods used in {Weak::Map} strategies to emulate deletion when
+    # the `ObjectSpace:WeakMap` does not directly allow to delete elements.
+    module Deletable
+      # A class to create objects from to mark deleted entries. These objects
+      # can be garbage collected. When reading values, we handle DeletedEntry
+      # instances the same way we would handle `nil` values.
+      # @see #mising?
+      class DeletedEntry; end
+      private_constant :DeletedEntry
+
+      # A special marker value to store `nil` in the WeakMap. We use this
+      # constant to distinguish the user-provided `nil` value (which is stored
+      # as `NIL`) from the absent value.
+      NIL = Object.new
+      private_constant :NIL
+
+      private
+
+      # Checks if an object gathered from an `ObjectSpace::WeakMap` is present,
+      # i.e., if it is not `missing?`
+      #
+      # @param obj [Object] an object to check
+      # @return [Bool] `true` if the `obj` is a present value, i.e. it is
+      #   neither `nil` nor a `DeletedEntry`; false otherwise
+      def have?(obj)
+        !missing?(obj)
+      end
+
+      # Checks if an object gathered from an `ObjectSpace::WeakMap` is missing.
+      # It is missing if it is either `nil` (if no value was present in the map)
+      # or if it is a `DeletedEntry` and was thus marked as deleted.
+      #
+      # The allowed `nil` value is represented with the special `NIL` constant
+      # which is not `missing?`.
+      #
+      # @param obj [Object] an object to check
+      # @return [Bool] `true` if the `obj` is absent, i.e. it is either `nil`
+      #   or a `DeletedEntry`; false otherwise
+      def missing?(obj)
+        obj.nil? || DeletedEntry === obj
+      end
+
+      # Get the final value for a retreived raw value. This convertes the
+      # special `NIL` value back to `nil`.
+      # @param obj [Object, NIL] an object retreived from an
+      #   `ObjectSpace::WeakMap`
+      # @return [Object, nil] the object or `nil` if `NIL` was given.
+      def value!(obj)
+        NIL.equal?(obj) ? nil : obj
+      end
+    end
+
+    private_constant :Deletable
+  end
+end