weak 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86165785c0d1874c5c54d7a72c3b703f5a21832cf0df8ffa917b4793dc40c502
-  data.tar.gz: a02c81a859c4f887181a2e33a124d6584a987d40cde92770fd1d6953a836f10d
+  metadata.gz: 1495109d765259effd2efb1f7d97c7ad7e71e060ecb1d8f8f6cd6386e3a4d93c
+  data.tar.gz: 73be12838b3bdb16f45215dd9b07152e798d62130ca0bdfbca999b57a21ae25d
 SHA512:
-  metadata.gz: 60d9a3259f88cd37a001b60fdf5247a856d1c637a54d0085712b347ab9b4c0dda330e8cabe69ead1bdf8193fdb70d8a0f7b419ea407afdcbea0b8e659331473c
-  data.tar.gz: b2dbc7c76ee9fd24d1a06df292e4683f5f5eb1a1b7a2d9db6ab653e691e818d3d6b3975589e020c47daede1b50ab48a4c417830af1c7b4cac12a9e2b61dc47f1
+  metadata.gz: 35c2aa978606c8c1bd1c83838e9eb418eba8e4bada89936675fcb82c6a6a24304da7e34a56b38cf2bab42fd0b682efcf2577c2fecb4fd2c7fb02344869ab3cfd
+  data.tar.gz: 47e6c245cfe310e9ad7b538028cac0e36531b3c856ac3ec6efbb66126ac5c51f26dbecc03a516eca9598f8c81f02de5e26a51c435cc2f40a86a7d39ff2253793

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## [Unreleased]
 
+## [0.2.1] - 2025-12-27
+
+- Fix typos in code documentation
+- Ignore some unnecessary methods defined on some `Set` implementations in `set_spec`
+- Run specs on JRuby 10 in Github Actions
+- Retry TruffleRuby rspec runs on Github Actions to avoid random failures due to flakey GC.
+- Extract UNDEFINED to its own file and require it where used.
+- Add more details about the gem version in `Weak::Version`
+- Handle object cycles in `pretty_print`.
+
 ## [0.2.0] - 2025-04-09
 
 - Add `Weak::Map#delete_if`

data/README.md

@@ -1,8 +1,7 @@
 # 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)
+[![github repo badge](https://img.shields.io/badge/github-repo-blue?logo=github)](https://github.com/meineerde/weak)
 
 Weak is a Ruby library which implements collections of unordered values without strong object references.
 
@@ -38,11 +37,11 @@ set
 `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:
+Compared to the `Hash` 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).
+  - Map membership is governed by object identity of the key rather than by using its `hash` and `eql?` methods. A `Weak::Map` thus works similar 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
@@ -64,7 +63,7 @@ map
 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)
+- [💥 Development Documentation](https://www.rubydoc.info/github/meineerde/weak) 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.
@@ -213,6 +212,9 @@ end
 
 ## Development
 
+[![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)
+
 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)
@@ -225,7 +227,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/meinee
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
 
 ## Code of Conduct
 

data/lib/weak/map/abstract_strong_keys.rb

@@ -34,9 +34,9 @@ module Weak
       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.
+      # overwritten in a "sub"-module 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

data/lib/weak/map/strong_keys.rb

@@ -8,6 +8,7 @@
 require "set"
 
 require "weak/map/abstract_strong_keys"
+require "weak/undefined"
 
 ##
 module Weak

data/lib/weak/map/strong_secondary_keys.rb

@@ -8,6 +8,7 @@
 require "set"
 
 require "weak/map/abstract_strong_keys"
+require "weak/undefined"
 
 ##
 module Weak

data/lib/weak/map/weak_keys.rb

@@ -6,6 +6,7 @@
 # of the MIT license. See the LICENSE.txt file for details.
 
 require "weak/map/deletable"
+require "weak/undefined"
 
 ##
 module Weak

data/lib/weak/map/weak_keys_with_delete.rb

@@ -5,6 +5,8 @@
 # This software may be modified and distributed under the terms
 # of the MIT license. See the LICENSE.txt file for details.
 
+require "weak/undefined"
+
 ##
 module Weak
   class Map

data/lib/weak/map.rb

@@ -5,10 +5,11 @@
 # This software may be modified and distributed under the terms
 # of the MIT license. See the LICENSE.txt file for details.
 
-require_relative "map/weak_keys_with_delete"
-require_relative "map/weak_keys"
-require_relative "map/strong_keys"
-require_relative "map/strong_secondary_keys"
+require "weak/map/weak_keys_with_delete"
+require "weak/map/weak_keys"
+require "weak/map/strong_keys"
+require "weak/map/strong_secondary_keys"
+require "weak/undefined"
 
 ##
 module Weak
@@ -486,8 +487,8 @@ module Weak
 
       object_ids << object_id
       begin
-        elements = to_a.sort_by! { |k, _v| k.__id__ }.to_h.inspect[1..-2]
-        "#<#{self.class} {#{elements}}>"
+        elements = to_a.sort_by! { |k, _v| k.__id__ }.to_h
+        "#<#{self.class} #{elements}>"
       ensure
         object_ids.pop
       end
@@ -590,6 +591,11 @@ module Weak
       end
     end
 
+    # @!visibility private
+    def pretty_print_cycle(pp)
+      pp.text "#<#{self.class} {#{"..." unless empty?}}>"
+    end
+
     # Deletes every key-value pair from `self` for which the given block
     # evaluates to a truethy value.
     #

data/lib/weak/set.rb

@@ -561,7 +561,7 @@ module Weak
 
     # @!visibility private
     def pretty_print_cycle(pp)
-      pp.text "#<#{self.class} {#{empty? ? "" : "..."}}>"
+      pp.text "#<#{self.class} {#{"..." unless empty?}}>"
     end
 
     # @param other [Weak::Set] a weak set

data/lib/weak/undefined.rb

@@ -0,0 +1,35 @@
+# 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"
+
+##
+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

data/lib/weak/version.rb

@@ -7,8 +7,36 @@
 
 ##
 module Weak
-  # The {Weak} version as a `Gem::Version` string. We follow semantic
-  # versioning.
-  # @see https://semver.org/
-  VERSION = "0.2.0"
+  # Version information about {Weak}}. We follow semantic versioning.
+  module Version
+    # MAJOR version. It is incremented after incompatible API changes
+    MAJOR = 0
+    # MINOR version. It is incremented after adding functionality in a
+    # backwards-compatible manner
+    MINOR = 2
+    # PATCH version. It is incremented when making backwards-compatible
+    # bug-fixes.
+    PATCH = 1
+    # PRERELEASE suffix. Set to a alphanumeric string on any pre-release
+    # versions like beta or RC releases; `nil` on regular releases
+    PRERELEASE = nil
+
+    # The {Weak} version as a `Gem::Version` string. We follow semantic
+    # versioning.
+    # @see https://semver.org/
+    STRING = [MAJOR, MINOR, PATCH, PRERELEASE].compact.join(".").freeze
+
+    # @return [Gem::Version] the {Weak} version as a `Gem::Version` object
+    def self.gem_version
+      Gem::Version.new STRING
+    end
+
+    # @return [String] the Weak version as a `Gem::Version` string
+    def self.to_s
+      STRING
+    end
+  end
+
+  # (see Version::STRING)
+  VERSION = Weak::Version::STRING
 end

data/lib/weak.rb

@@ -5,8 +5,6 @@
 # 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"
@@ -19,27 +17,4 @@ require_relative "weak/set"
 # 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

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: weak
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Holger Just
 bindir: bin
 cert_chain: []
-date: 2025-04-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: |
   The Weak library provides a Weak::Set class to store an unordered list of
@@ -36,6 +36,7 @@ files:
 - lib/weak/set/strong_secondary_keys.rb
 - lib/weak/set/weak_keys.rb
 - lib/weak/set/weak_keys_with_delete.rb
+- lib/weak/undefined.rb
 - lib/weak/version.rb
 homepage: https://github.com/meineerde/weak
 licenses:
@@ -45,7 +46,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.2.0
+  documentation_uri: https://www.rubydoc.info/gems/weak/0.2.1
 rdoc_options: []
 require_paths:
 - lib
@@ -60,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Tools to handle collections of weakly-referenced values
 test_files: []