atomic-ruby 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e47f4b67bd3d4dcaecbd560ed61b8dc4c86c24882b52279a5d0e92fd6de666a
-  data.tar.gz: 2fb299af89ccc871b7c8b3d6ef18f15924e98b90ad196143c0ea9fa3cac76419
+  metadata.gz: 10b5f273dd24628d2bf10a095cb875647bc922fc36697528c472053c61b2822c
+  data.tar.gz: b1b45d921decbc9bd2f927b8b6ed11a8de9e36ca1acacd4dde411953992ffb3a
 SHA512:
-  metadata.gz: fb201628eedea540bea2a8436daf0bb9f9db3cf2f0cd1caa5d27a54af840b992474cf4e08496a52c16f963ab311cd14f3796977f6777140c648e38cd283a6679
-  data.tar.gz: fe346ae21ffa67e8ed82048a1b79fe2eada3f101e2b812112eef689139f924e01b420b6e0d56f37ca2c795e597bd86631e79f8d93fa5d32f50a77ef7eb1f9734
+  metadata.gz: c5ed7e71b51fa5b45e7031c7a08399f0158c588f3fe5b64844f7511fd959ebe7735fcc042d61b84c05729b961a133e7fa12a84663fe2e791b79fe3d02d6319f1
+  data.tar.gz: cd538c8c88fa9aa636ae0c0c69063b8288cde1af7b533c958c76096a7ecede7967ab45159ca04d010d507e084b8b13c38aa225d2ba675b146d2c7e8c473d147f

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.5.0] - 2025-07-17
+
+- Add shortcut aliases for `AtomicRuby` namespaced classes
+
+## [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

data/README.md

@@ -21,12 +21,12 @@ gem install atomic-ruby
 
 ## Usage
 
-`AtomicRuby::Atom`:
+`Atom`:
 
 ```ruby
 require "atomic-ruby"
 
-atom = AtomicRuby::Atom.new(0)
+atom = Atom.new(0)
 p atom.value #=> 0
 atom.swap { |current_value| current_value + 1 }
 p atom.value #=> 1
@@ -34,12 +34,12 @@ atom.swap { |current_value| current_value + 1 }
 p atom.value #=> 2
 ```
 
-`AtomicRuby::AtomicBoolean`:
+`AtomicBoolean`:
 
 ```ruby
 require "atomic-ruby"
 
-atom = AtomicRuby::AtomicBoolean.new(false)
+atom = AtomicBoolean.new(false)
 p atom.value  #=> false
 p atom.false? #=> true
 p atom.true?  #=> false
@@ -49,14 +49,14 @@ atom.toggle
 p atom.false? #=> true
 ```
 
-`AtomicRuby::AtomicThreadPool`:
+`AtomicThreadPool`:
 
 ```ruby
 require "atomic-ruby"
 
 results = []
 
-pool = AtomicRuby::AtomicThreadPool.new(size: 4)
+pool = AtomicThreadPool.new(size: 4)
 p pool.length       #=> 4
 
 10.times do |idx|
@@ -78,11 +78,30 @@ p results           #=> [8, 7, 10, 9, 6, 5, 3, 4, 2, 1]
 p results.sort      #=> [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
 ```
 
+`AtomicCountDownLatch`:
+
+```ruby
+require "atomic-ruby"
+
+latch = AtomicCountDownLatch.new(3)
+p latch.count #=> 3
+
+threads = 3.times.map do
+  Thread.new do
+    sleep(rand(5))
+    latch.count_down
+  end
+end
+
+latch.wait
+p latch.count #=> 0
+```
+
 ## Benchmarks
 
 <details>
 
-<summary>AtomicRuby::Atom</summary>
+<summary>Atom</summary>
 
 <br>
 
@@ -128,7 +147,7 @@ end
 
 class AtomicRubyAtomicBankAccount
   def initialize(balance)
-    @balance = AtomicRuby::Atom.new(balance)
+    @balance = Atom.new(balance)
   end
 
   def balance
@@ -190,7 +209,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.2
+atomic-ruby version:     0.4.0
 
 Balances:
 Synchronized Bank Account Balance:           975
@@ -198,16 +217,16 @@ Concurrent Ruby Atomic Bank Account Balance: 975
 Atomic Ruby Atomic Bank Account Balance:     975
 
 Benchmark Results:
-Synchronized Bank Account:           5.130792 seconds
-Concurrent Ruby Atomic Bank Account: 5.121400 seconds
-Atomic Ruby Atomic Bank Account:     5.119191 seconds
+Synchronized Bank Account:           5.110062 seconds
+Concurrent Ruby Atomic Bank Account: 5.107966 seconds
+Atomic Ruby Atomic Bank Account:     5.107739 seconds
 ```
 
 </details>
 
 <details>
 
-<summary>AtomicRuby::AtomicBoolean</summary>
+<summary>AtomicBoolean</summary>
 
 ```ruby
 # frozen_string_literal: true
@@ -262,7 +281,7 @@ Benchmark.ips do |x|
   end
 
   x.report("Atomic Ruby Atomic Boolean Toggle") do
-    boolean = AtomicRuby::AtomicBoolean.new(false)
+    boolean = AtomicBoolean.new(false)
     20.times.map do
       Thread.new do
         100.times do
@@ -281,34 +300,34 @@ end
 
 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.2
+atomic-ruby version:     0.4.0
 
 Warming up --------------------------------------
 Synchronized Boolean Toggle
-                        87.000 i/100ms
+                       102.000 i/100ms
 Concurrent Ruby Atomic Boolean Toggle
-                        81.000 i/100ms
+                        88.000 i/100ms
 Atomic Ruby Atomic Boolean Toggle
-                        92.000 i/100ms
+                       109.000 i/100ms
 Calculating -------------------------------------
 Synchronized Boolean Toggle
-                        969.205 (± 5.8%) i/s    (1.03 ms/i) -      4.872k in   5.043520s
+                          1.062k (± 2.5%) i/s  (941.81 μs/i) -      5.406k in   5.094827s
 Concurrent Ruby Atomic Boolean Toggle
-                        885.546 (± 5.2%) i/s    (1.13 ms/i) -      4.455k in   5.044282s
+                        981.495 (± 3.5%) i/s    (1.02 ms/i) -      4.928k in   5.027167s
 Atomic Ruby Atomic Boolean Toggle
-                         1.154k (± 5.3%) i/s  (866.65 μs/i) -      5.796k in   5.037272s
+                          1.274k (± 1.5%) i/s  (784.70 μs/i) -      6.431k in   5.047458s
 
 Comparison:
-Atomic Ruby Atomic Boolean Toggle:     1153.9 i/s
-Synchronized Boolean Toggle:            969.2 i/s - 1.19x  slower
-Concurrent Ruby Atomic Boolean Toggle:  885.5 i/s - 1.30x  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>
 
 <details>
 
-<summary>AtomicRuby::AtomicThreadPool</summary>
+<summary>AtomicThreadPool</summary>
 
 <br>
 
@@ -325,7 +344,7 @@ results = []
   result = Benchmark.measure do
     pool = case idx
     when 0 then Concurrent::FixedThreadPool.new(20)
-    when 1 then AtomicRuby::AtomicThreadPool.new(size: 20)
+    when 1 then AtomicThreadPool.new(size: 20)
     end
 
     100.times do
@@ -359,11 +378,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.2
+atomic-ruby version:     0.4.0
 
 Benchmark Results:
-Concurrent Ruby Thread Pool:    5.032940 seconds
-Atomic Ruby Atomic Thread Pool: 4.508259 seconds
+Concurrent Ruby Thread Pool:    5.02207 seconds
+Atomic Ruby Atomic Thread Pool: 4.503302 seconds
 ```
 
 </details>

data/ext/atomic_ruby/atomic_ruby.c

@@ -24,7 +24,7 @@ static void atomic_ruby_atom_compact(void *ptr) {
 }
 
 static const rb_data_type_t atomic_ruby_atom_type = {
-  .wrap_struct_name = "AtomicRuby::Atom",
+  .wrap_struct_name = "Atom",
   .function = {
     .dmark = atomic_ruby_atom_mark,
     .dfree = atomic_ruby_atom_free,

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)
@@ -23,13 +24,11 @@ module AtomicRuby
         raise UnsupportedWorkTypeError, "expected work to be a `Proc`, got #{work.class}"
       end
 
-      @queue.swap do |current_queue|
-        if @stopping.true?
-          raise InvalidWorkQueueingError, "cannot queue work during or after pool shutdown"
-        end
-
-        current_queue += [work]
+      if @stopping.true?
+        raise InvalidWorkQueueingError, "cannot queue work during or after pool shutdown"
       end
+
+      @queue.swap { |current_queue| current_queue += [work] }
       true
     end
 
@@ -52,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("AtomicThreadPool thread #{idx}")
+          thread_name << " for #{@name}" if @name
+          Thread.current.name = thread_name
 
           @started_threads.swap { |current_count| current_count + 1 }
 
@@ -65,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

data/lib/atomic-ruby/version.rb

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

data/lib/atomic-ruby.rb

@@ -3,8 +3,11 @@
 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
-end
+Atom = AtomicRuby::Atom
+AtomicBoolean = AtomicRuby::AtomicBoolean
+AtomicThreadPool = AtomicRuby::AtomicThreadPool
+AtomicCountDownLatch = AtomicRuby::AtomicCountDownLatch

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atomic-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.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.7.0.dev
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Atomic primitives for Ruby
 test_files: []