atomic-ruby 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21542683125e7a193b4500ff05f3ee74249db2e3b16e71a3b10b46ff53a52d4b
-  data.tar.gz: 609c1f8e8edb35ad1ad049a33c515a74522803b64a592ed49ac8666d8c06a8ba
+  metadata.gz: 10b5f273dd24628d2bf10a095cb875647bc922fc36697528c472053c61b2822c
+  data.tar.gz: b1b45d921decbc9bd2f927b8b6ed11a8de9e36ca1acacd4dde411953992ffb3a
 SHA512:
-  metadata.gz: 8a3e15dee614e4455540272dba417192800fe85d41acdd0ff30babe8681f1d768b408a38fcf8acba878054fab96c94e085516299670b1643c591cc617a165919
-  data.tar.gz: ae7b2e2e3a03019471d741a995d95a83f2e52eeb36137942b14cea55e8e76f8fd48ae734acbad5c2ac1a98a2fc8c88ddf5192ff6a2598f53555d7c08bfcbce9e
+  metadata.gz: c5ed7e71b51fa5b45e7031c7a08399f0158c588f3fe5b64844f7511fd959ebe7735fcc042d61b84c05729b961a133e7fa12a84663fe2e791b79fe3d02d6319f1
+  data.tar.gz: cd538c8c88fa9aa636ae0c0c69063b8288cde1af7b533c958c76096a7ecede7967ab45159ca04d010d507e084b8b13c38aa225d2ba675b146d2c7e8c473d147f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [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"

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
@@ -207,7 +226,7 @@ Atomic Ruby Atomic Bank Account:     5.107739 seconds
 
 <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
@@ -308,7 +327,7 @@ Concurrent Ruby Atomic Boolean Toggle:      981.5 i/s - 1.30x  slower
 
 <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

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_thread_pool.rb

@@ -51,7 +51,7 @@ module AtomicRuby
     def start
       @threads = @size.times.map do |num|
         Thread.new(num) do |idx|
-          thread_name = String.new("AtomicRuby::AtomicThreadPool thread #{idx}")
+          thread_name = String.new("AtomicThreadPool thread #{idx}")
           thread_name << " for #{@name}" if @name
           Thread.current.name = thread_name
 

data/lib/atomic-ruby/version.rb

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

data/lib/atomic-ruby.rb

@@ -7,6 +7,7 @@ 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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Joshua Young
@@ -51,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: []