atomic 0.0.1

data/README.txt

@@ -0,0 +1,33 @@
+atomic: An atomic reference implementation for JRuby and green or GIL-threaded
+Ruby implementations (MRI 1.8/1.9, Rubinius)
+
+== Summary ==
+
+This library provides:
+
+* an Atomic class that guarantees atomic updates to its contained value
+
+The Atomic class provides accessors for the contained "value" plus two update
+methods:
+
+* update will run the provided block, passing the current value and replacing
+  it with the block result iff the value has not been changed in the mean time.
+  It may run the block repeatedly if there are other concurrent updates in
+  progress.
+* try_update will run the provided block, passing the current value and
+  replacing it with the block result. If the value changes before the update
+  can happen, it will throw Atomic::ConcurrentUpdateError.
+
+The atomic repository is at http://github.com/headius/ruby-atomic.
+
+== Usage ==
+
+require 'atomic'
+
+my_atomic = Atomic.new(0)
+my_atomic.update {|v| v + 1}
+begin
+  my_atomic.try_update {|v| v + 1}
+rescue Atomic::ConcurrentUpdateError => cue
+  # deal with it (retry, propagate, etc)
+end

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+
+desc "Run tests"
+Rake::TestTask.new :test do |t|
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*.rb"]
+end

data/atomic.gemspec

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{atomic}
+  s.version = "0.0.1"
+  s.authors = ["Charles Oliver Nutter", "MenTaLguY"]
+  s.date = Time.now.strftime('YYYY-MM-DD')
+  s.description = "An atomic reference implementation for JRuby and green or GIL-threaded impls"
+  s.email = ["headius@headius.com", "mental@rydia.net"]
+  s.files = Dir['{lib,examples,test}/**/*'] + Dir['{*.txt,*.gemspec,Rakefile}']
+  s.homepage = "http://github.com/headius/ruby-atomic"
+  s.require_paths = ["lib"]
+  s.summary = "An atomic reference implementation for JRuby and green or GIL-threaded impls"
+  s.test_files = Dir["test/test*.rb"]
+end

data/examples/atomic_example.rb

@@ -0,0 +1,12 @@
+require 'atomic'
+
+my_atomic = Atomic.new(0)
+my_atomic.update {|v| v + 1}
+puts "new value: #{my_atomic.value}"
+
+begin
+  my_atomic.try_update {|v| v + 1}
+rescue Atomic::ConcurrentUpdateError => cue
+  # deal with it (retry, propagate, etc)
+end
+puts "new value: #{my_atomic.value}"

data/lib/atomic.rb

@@ -0,0 +1,79 @@
+base_atomic = Class.new do
+  class ConcurrentUpdateError < ThreadError
+  end
+  
+  def initialize(value=nil)
+    @ref = InternalReference.new(value)
+  end
+
+  def value
+    @ref.get
+  end
+  
+  def value=(new_value)
+    @ref.set(new_value)
+    new_value
+  end
+
+  # Pass the current value to the given block, replacing it
+  # with the block's result. May retry if the value changes
+  # during the block's execution.
+  def update
+    begin
+      try_update { |v| yield v }
+    rescue ConcurrentUpdateError
+      retry
+    end
+  end
+
+  def try_update
+    old_value = @ref.get
+    new_value = yield old_value
+    unless @ref.compare_and_set(old_value, new_value)
+      raise ConcurrentUpdateError, "Update failed"
+    end
+    old_value
+  end
+end
+
+if defined? RUBY_ENGINE && RUBY_ENGINE == "jruby"
+  require 'java'
+  Atomic = Class.new(base_atomic) do
+    InternalReference = java.util.concurrent.atomic.AtomicReference
+  end
+else
+  Atomic = Class.new(base_atomic) do
+    class InternalReference
+      attr_accessor :value
+      alias_method :get, :value
+      alias_method :set, :value=
+
+      def initialize(value)
+        @value = value
+      end
+
+      def compare_and_set(old_value, new_value)
+        _exclusive do
+          return false unless @value.equal? old_value
+          @value = new_value
+        end
+        true
+      end
+      
+      HAS_EXCLUSIVE = defined? Thread.exclusive
+      def _exclusive
+        if HAS_EXCLUSIVE
+          Thread.exclusive {yield}
+        else
+          begin
+            Thread.critical = true
+            yield
+          ensure
+            Thread.critical = false
+          end
+        end
+      end
+      private :_exclusive
+    end
+  end
+end

data/test/test_atomic.rb

@@ -0,0 +1,35 @@
+require 'test/unit'
+require 'atomic'
+
+class TestAtomic < Test::Unit::TestCase
+  def test_construct
+    atomic = Atomic.new
+    assert_equal nil, atomic.value
+    
+    atomic = Atomic.new(0)
+    assert_equal 0, atomic.value
+  end
+  
+  def test_value
+    atomic = Atomic.new(0)
+    atomic.value = 1
+    
+    assert_equal 1, atomic.value
+  end
+  
+  def test_update
+    atomic = Atomic.new(0)
+    atomic.update {|v| v + 1}
+    
+    assert_equal 1, atomic.value
+  end
+  
+  def test_try_update
+    atomic = Atomic.new(0)
+    atomic.try_update {|v| v + 1}
+    
+    assert_equal 1, atomic.value
+  end
+  
+  # TODO: Test the ConcurrentUpdateError cases
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: atomic
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 0
+    - 0
+    - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+  - Charles Oliver Nutter
+  - MenTaLguY
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-08 00:03:10.533000 -04:00
+default_executable: 
+dependencies: []
+
+description: An atomic reference implementation for JRuby and green or GIL-threaded impls
+email: 
+  - headius@headius.com
+  - mental@rydia.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - lib/atomic.rb
+  - examples/atomic_example.rb
+  - test/test_atomic.rb
+  - README.txt
+  - atomic.gemspec
+  - Rakefile
+has_rdoc: true
+homepage: http://github.com/headius/ruby-atomic
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An atomic reference implementation for JRuby and green or GIL-threaded impls
+test_files: 
+  - test/test_atomic.rb