atomic-ruby 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc55b63bd9de85a395232f89184e97aa80e08e8e082981f2b17012fd1b56b5c0
-  data.tar.gz: 25cffc0cbb45f1d145d3b99380decc91a39ef82415833781bed40ba2583286a8
+  metadata.gz: 21542683125e7a193b4500ff05f3ee74249db2e3b16e71a3b10b46ff53a52d4b
+  data.tar.gz: 609c1f8e8edb35ad1ad049a33c515a74522803b64a592ed49ac8666d8c06a8ba
 SHA512:
-  metadata.gz: 1420ff50010eec4386301619d4866c1e96aec8f91936e464b2ed56276607fd6dfaf88d0cc5582ee255c06a15928a2b1390f1a2e18ceb443ee0d74fa190a36ee9
-  data.tar.gz: 80ceb6dd2348ea38bbd8b63223fc7ab27a6d36026d0e028fc0aef60dd9f92885b29adb5fa997b551b54c9aadbaca24fdd71a4f7b1d94337f3a3887955c108a5b
+  metadata.gz: 8a3e15dee614e4455540272dba417192800fe85d41acdd0ff30babe8681f1d768b408a38fcf8acba878054fab96c94e085516299670b1643c591cc617a165919
+  data.tar.gz: ae7b2e2e3a03019471d741a995d95a83f2e52eeb36137942b14cea55e8e76f8fd48ae734acbad5c2ac1a98a2fc8c88ddf5192ff6a2598f53555d7c08bfcbce9e

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.4.0] - 2025-07-06
+
+- Revert "Fix `AtomicThreadPool#<<` shutdown check race condition"
+- Add `:name` to `AtomicThreadPool` initializer
+- Add `AtomicCountDownLatch`
+
+## [0.3.2] - 2025-06-14
+
+- Fix `AtomicThreadPool#<<` shutdown check race condition
+
 ## [0.3.1] - 2025-06-08
 
 - Fix current queue being mutated in `AtomicThreadPool#<<`

data/README.md

@@ -169,6 +169,7 @@ results = []
   results << result
 end
 
+puts "\n"
 puts "ruby version:            #{RUBY_DESCRIPTION}"
 puts "concurrent-ruby version: #{Concurrent::VERSION}"
 puts "atomic-ruby version:     #{AtomicRuby::VERSION}"
@@ -189,7 +190,7 @@ puts "Atomic Ruby Atomic Bank Account:     #{results[2].real.round(6)} seconds"
 
 ruby version:            ruby 3.4.4 (2025-05-14 revision a38531fd3f) +YJIT +PRISM [arm64-darwin24]
 concurrent-ruby version: 1.3.5
-atomic-ruby version:     0.3.0
+atomic-ruby version:     0.4.0
 
 Balances:
 Synchronized Bank Account Balance:           975
@@ -197,9 +198,9 @@ Concurrent Ruby Atomic Bank Account Balance: 975
 Atomic Ruby Atomic Bank Account Balance:     975
 
 Benchmark Results:
-Synchronized Bank Account:           5.125638 seconds
-Concurrent Ruby Atomic Bank Account: 5.114936 seconds
-Atomic Ruby Atomic Bank Account:     5.108171 seconds
+Synchronized Bank Account:           5.110062 seconds
+Concurrent Ruby Atomic Bank Account: 5.107966 seconds
+Atomic Ruby Atomic Bank Account:     5.107739 seconds
 ```
 
 </details>
@@ -215,6 +216,23 @@ require "benchmark/ips"
 require "concurrent-ruby"
 require_relative "../lib/atomic-ruby"
 
+module Benchmark
+  module IPS
+    class Job
+      class StreamReport
+        def start_warming
+          @out.puts "\n"
+          @out.puts "ruby version:            #{RUBY_DESCRIPTION}"
+          @out.puts "concurrent-ruby version: #{Concurrent::VERSION}"
+          @out.puts "atomic-ruby version:     #{AtomicRuby::VERSION}"
+          @out.puts "\n"
+          @out.puts "Warming up --------------------------------------"
+        end
+      end
+    end
+  end
+end
+
 Benchmark.ips do |x|
   x.report("Synchronized Boolean Toggle") do
     boolean = false
@@ -261,26 +279,29 @@ end
 ```
 > bundle exec rake compile && bundle exec ruby examples/atomic_boolean_benchmark.rb
 
-ruby 3.4.4 (2025-05-14 revision a38531fd3f) +YJIT +PRISM [arm64-darwin24]
+ruby version:            ruby 3.4.4 (2025-05-14 revision a38531fd3f) +YJIT +PRISM [arm64-darwin24]
+concurrent-ruby version: 1.3.5
+atomic-ruby version:     0.4.0
+
 Warming up --------------------------------------
 Synchronized Boolean Toggle
-                        83.000 i/100ms
+                       102.000 i/100ms
 Concurrent Ruby Atomic Boolean Toggle
-                        58.000 i/100ms
-Atomic Ruby Atomic Boolean Toggle
                         88.000 i/100ms
+Atomic Ruby Atomic Boolean Toggle
+                       109.000 i/100ms
 Calculating -------------------------------------
 Synchronized Boolean Toggle
-                        775.552 (± 6.2%) i/s    (1.29 ms/i) -      3.901k in   5.051649s
+                          1.062k (± 2.5%) i/s  (941.81 μs/i) -      5.406k in   5.094827s
 Concurrent Ruby Atomic Boolean Toggle
-                        741.655 (± 3.5%) i/s    (1.35 ms/i) -      3.712k in   5.011183s
+                        981.495 (± 3.5%) i/s    (1.02 ms/i) -      4.928k in   5.027167s
 Atomic Ruby Atomic Boolean Toggle
-                        881.916 (± 2.8%) i/s    (1.13 ms/i) -      4.488k in   5.092910s
+                          1.274k (± 1.5%) i/s  (784.70 μs/i) -      6.431k in   5.047458s
 
 Comparison:
-Atomic Ruby Atomic Boolean Toggle:      881.9 i/s
-Synchronized Boolean Toggle:            775.6 i/s - 1.14x  slower
-Concurrent Ruby Atomic Boolean Toggle:  741.7 i/s - 1.19x  slower
+Atomic Ruby Atomic Boolean Toggle:         1274.4 i/s
+Synchronized Boolean Toggle:               1061.8 i/s - 1.20x  slower
+Concurrent Ruby Atomic Boolean Toggle:      981.5 i/s - 1.30x  slower
 ```
 
 </details>
@@ -315,17 +336,15 @@ results = []
       pool << -> { 1_000_000.times.map(&:itself).sum }
     end
 
-    # concurrent-ruby does not wait for threads to die on shutdown
-    threads = if idx == 0
-      pool.instance_variable_get(:@pool).map { |worker| worker.instance_variable_get(:@thread) }
-    end
     pool.shutdown
-    threads&.each(&:join)
+    # concurrent-ruby's #shutdown does not wait for threads to terminate
+    pool.wait_for_termination if idx == 0
   end
 
   results << result
 end
 
+puts "\n"
 puts "ruby version:            #{RUBY_DESCRIPTION}"
 puts "concurrent-ruby version: #{Concurrent::VERSION}"
 puts "atomic-ruby version:     #{AtomicRuby::VERSION}"
@@ -340,11 +359,11 @@ puts "Atomic Ruby Atomic Thread Pool: #{results[1].real.round(6)} seconds"
 
 ruby version:            ruby 3.4.4 (2025-05-14 revision a38531fd3f) +YJIT +PRISM [arm64-darwin24]
 concurrent-ruby version: 1.3.5
-atomic-ruby version:     0.3.0
+atomic-ruby version:     0.4.0
 
 Benchmark Results:
-Concurrent Ruby Thread Pool:    5.136456 seconds
-Atomic Ruby Atomic Thread Pool: 4.700981 seconds
+Concurrent Ruby Thread Pool:    5.02207 seconds
+Atomic Ruby Atomic Thread Pool: 4.503302 seconds
 ```
 
 </details>

data/lib/atomic-ruby/atomic_boolean.rb

@@ -11,11 +11,11 @@ module AtomicRuby
         raise InvalidBooleanError, "expected boolean to be a `TrueClass` or `FalseClass`, got #{value.class}"
       end
 
-      @atom = Atom.new(value)
+      @boolean = Atom.new(value)
     end
 
     def value
-      @atom.value
+      @boolean.value
     end
 
     def true?
@@ -27,15 +27,15 @@ module AtomicRuby
     end
 
     def make_true
-      @atom.swap { true }
+      @boolean.swap { true }
     end
 
     def make_false
-      @atom.swap { false }
+      @boolean.swap { false }
     end
 
     def toggle
-      @atom.swap { |current_value| !current_value }
+      @boolean.swap { |current_value| !current_value }
     end
   end
 end

data/lib/atomic-ruby/atomic_count_down_latch.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "atom"
+
+module AtomicRuby
+  class AtomicCountDownLatch
+    class InvalidCountError < StandardError; end
+    class AlreadyCountedDownError < StandardError; end
+
+    def initialize(count)
+      unless count.is_a?(Integer)
+        raise InvalidCountError, "expected count to be an `Integer`, got #{count.class}"
+      end
+
+      @count = Atom.new(count)
+    end
+
+    def count
+      @count.value
+    end
+
+    def count_down
+      unless @count.value > 0
+        raise AlreadyCountedDownError, "count has already reached zero"
+      end
+
+      @count.swap { |current_value| current_value - 1 }
+    end
+
+    def wait
+      Thread.pass while @count.value > 0
+    end
+  end
+end

data/lib/atomic-ruby/atomic_thread_pool.rb

@@ -8,8 +8,9 @@ module AtomicRuby
     class UnsupportedWorkTypeError < StandardError; end
     class InvalidWorkQueueingError < StandardError; end
 
-    def initialize(size:)
+    def initialize(size:, name: nil)
       @size = size
+      @name = name
       @queue = Atom.new([])
       @threads = []
       @started_threads = Atom.new(0)
@@ -50,8 +51,9 @@ module AtomicRuby
     def start
       @threads = @size.times.map do |num|
         Thread.new(num) do |idx|
-          name = "AtomicRuby::AtomicThreadPool thread #{idx}"
-          Thread.current.name = name
+          thread_name = String.new("AtomicRuby::AtomicThreadPool thread #{idx}")
+          thread_name << " for #{@name}" if @name
+          Thread.current.name = thread_name
 
           @started_threads.swap { |current_count| current_count + 1 }
 
@@ -63,7 +65,7 @@ module AtomicRuby
               begin
                 work.call
               rescue => err
-                puts "#{name} rescued:"
+                puts "#{thread_name} rescued:"
                 puts "#{err.class}: #{err.message}"
                 puts err.backtrace.join("\n")
               end
@@ -80,7 +82,7 @@ module AtomicRuby
         end
       end
 
-      sleep(0.001) until @started_threads.value == @size
+      Thread.pass until @started_threads.value == @size
     end
   end
 end

data/lib/atomic-ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AtomicRuby
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/atomic-ruby.rb

@@ -3,7 +3,9 @@
 require_relative "atomic-ruby/version"
 require_relative "atomic-ruby/atomic_ruby"
 require_relative "atomic-ruby/atom"
+require_relative "atomic-ruby/atomic_boolean"
 require_relative "atomic-ruby/atomic_thread_pool"
+require_relative "atomic-ruby/atomic_count_down_latch"
 
 module AtomicRuby
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atomic-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Joshua Young
@@ -27,6 +27,7 @@ files:
 - lib/atomic-ruby.rb
 - lib/atomic-ruby/atom.rb
 - lib/atomic-ruby/atomic_boolean.rb
+- lib/atomic-ruby/atomic_count_down_latch.rb
 - lib/atomic-ruby/atomic_ruby.bundle
 - lib/atomic-ruby/atomic_thread_pool.rb
 - lib/atomic-ruby/version.rb
@@ -50,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.7.0.dev
 specification_version: 4
 summary: Atomic primitives for Ruby
 test_files: []