weak 0.1.0

data/lib/weak/version.rb

@@ -0,0 +1,14 @@
+# 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
+  # The {Weak} version as a `Gem::Version` string. We follow semantic
+  # versioning.
+  # @see https://semver.org/
+  VERSION = "0.1.0"
+end

data/lib/weak.rb

@@ -0,0 +1,45 @@
+# 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 "singleton"
+
+require_relative "weak/version"
+require_relative "weak/map"
+require_relative "weak/set"
+
+# 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.
+module Weak
+  # A class for the {UNDEFINED} object. Being a singleton, there will only be
+  # exactly one object of this class: the {UNDEFINED} object.
+  #
+  # @private
+  class UndefinedClass
+    include Singleton
+
+    def initialize
+      freeze
+    end
+
+    # @return [String] the string `"UNDEFINED"`
+    def to_s
+      "UNDEFINED"
+    end
+    alias_method :inspect, :to_s
+  end
+
+  # The {UNDEFINED} object can be used as the default value for method arguments
+  # to distinguish it from `nil`.
+  #
+  # @see https://holgerjust.de/2016/detecting-default-arguments-in-ruby/#special-default-value
+  UNDEFINED = UndefinedClass.instance
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: weak
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Holger Just
+bindir: bin
+cert_chain: []
+date: 2025-03-14 00:00:00.000000000 Z
+dependencies: []
+description: |
+  The Weak library provides a Weak::Set class to store an unordered list of
+  objects and a Weak::Map class to store a key-value map. The collection
+  classes only hold weak references to all elements so they can be
+  garbage-collected when there are no more references left.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/weak.rb
+- lib/weak/map.rb
+- lib/weak/map/abstract_strong_keys.rb
+- lib/weak/map/deletable.rb
+- lib/weak/map/strong_keys.rb
+- lib/weak/map/strong_secondary_keys.rb
+- lib/weak/map/weak_keys.rb
+- lib/weak/map/weak_keys_with_delete.rb
+- lib/weak/set.rb
+- lib/weak/set/strong_keys.rb
+- lib/weak/set/strong_secondary_keys.rb
+- lib/weak/set/weak_keys.rb
+- lib/weak/set/weak_keys_with_delete.rb
+- lib/weak/version.rb
+homepage: https://github.com/meineerde/weak
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  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
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Tools to use handle collections of weak-referenced values in Ruby
+test_files: []