atomic 1.1.3 → 1.1.4

data/README.rdoc

@@ -6,58 +6,38 @@ 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:
+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.
+* 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
 
-The simplest way to use "atomic" is to call the "update" or "try_update"
-methods.
-
-"try_update" and "update" both call the given block, passing the current
-value and using the block's result as the new value. If the value is updated
-by another thread before the block completes, "try update" raises a
-ConcurrentUpdateError and "update" retries the block. Because "update" may call
-the block several times when multiple threads are all updating the same value,
-the block's logic should be kept as simple as possible.
-
-````ruby
-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
-````
-
-It's also possible to use the regular get/set operations on the Atomic, if you
-want to avoid the exception and respond to contended changes in some other way.
-
-````ruby
-my_atomic = Atomic.new(0)
-my_atomic.value # => 0
-my_atomic.value = 1
-my_atomic.swap(2) # => 1
-my_atomic.compare_and_swap(2, 3) # => true, updated to 3
-my_atomic.compare_and_swap(2, 3) # => false, current is not 2
-````
+The simplest way to use "atomic" is to call the "update" or "try_update" methods.
+
+"try_update" and "update" both call the given block, passing the current value and using the block's result as the new value. If the value is updated by another thread before the block completes, "try update" raises a ConcurrentUpdateError and "update" retries the block. Because "update" may call the block several times when multiple threads are all updating the same value, the block's logic should be kept as simple as possible.
+
+    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
+
+It's also possible to use the regular get/set operations on the Atomic, if you want to avoid the exception and respond to contended changes in some other way.
+
+    my_atomic = Atomic.new(0)
+    my_atomic.value # => 0
+    my_atomic.value = 1
+    my_atomic.swap(2) # => 1
+    my_atomic.compare_and_swap(2, 3) # => true, updated to 3
+    my_atomic.compare_and_swap(2, 3) # => false, current is not 2
 
 == Building
 
-As of 1.1.0, JDK8 is required to build the atomic gem, since it attempts to use
-the new atomic Unsafe.getAndSetObject method only in JDK8. The resulting code
-should still work fine as far back as Java 5.
+As of 1.1.0, JDK8 is required to build the atomic gem, since it attempts to use the new atomic Unsafe.getAndSetObject method only in JDK8. The resulting code should still work fine as far back as Java 5.

data/atomic.gemspec

@@ -1,17 +1,18 @@
 # -*- encoding: utf-8 -*-
 
 # Update these to get proper version and commit history
-new_version = "1.1.3"
+new_version = "1.1.4"
 old_version = "1.1.0"
 
-lines = File.readlines("README.rdoc")
+git_lines = `git log --oneline #{old_version}...#{new_version}`.lines.map {|str| "* #{str}"}.join
+doc_lines = File.readlines("README.rdoc")
 description = <<EOS
-#{lines[0]}
+#{doc_lines[0]}
 
 == Changes since #{old_version}
 
-#{`git log --oneline #{old_version}...#{new_version}`}
-#{lines[0..-1].join("\n")}
+#{git_lines}
+#{doc_lines[2..-1].join("\n")}
 EOS
 
 Gem::Specification.new do |s|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atomic
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -14,39 +14,38 @@ cert_chain: []
 date: 2013-04-05 00:00:00.000000000 Z
 dependencies: []
 description: ! "= An atomic reference implementation for JRuby, Rubinius, and MRI.\n\n\n==
-  Changes since 1.1.0\n\n58d3e34 Convert README to rdoc and try again.\nf519385 Attempting
-  to get description to look nice on rubygems.org.\n2c5ab6c Include README and oneline
-  logs in gem description.\n6aeb053 Add @funny-falcon to authors.\naa24d4d Bump version
-  to 1.1.1.\ndc327eb Merge pull request #16 from funny-falcon/patch-1\n1b68767 Fix
-  JRUBYREFERENCE8_ALLOCATOR\n\n= An atomic reference implementation for JRuby, Rubinius,
-  and MRI.\n\n\n\n== Summary\n\n\n\nThis library provides:\n\n\n\n* an Atomic class
-  that guarantees atomic updates to its contained value\n\n\n\nThe Atomic class provides
-  accessors for the contained \"value\" plus two update\n\nmethods:\n\n\n\n* update
-  will run the provided block, passing the current value and replacing\n\n  it with
-  the block result iff the value has not been changed in the mean time.\n\n  It may
-  run the block repeatedly if there are other concurrent updates in\n\n  progress.\n\n*
-  try_update will run the provided block, passing the current value and\n\n  replacing
-  it with the block result. If the value changes before the update\n\n  can happen,
-  it will throw Atomic::ConcurrentUpdateError.\n\n\n\nThe atomic repository is at
-  http://github.com/headius/ruby-atomic.\n\n\n\n\n\n== Usage\n\n\n\nThe simplest way
-  to use \"atomic\" is to call the \"update\" or \"try_update\"\n\nmethods.\n\n\n\n\"try_update\"
-  and \"update\" both call the given block, passing the current\n\nvalue and using
-  the block's result as the new value. If the value is updated\n\nby another thread
-  before the block completes, \"try update\" raises a\n\nConcurrentUpdateError and
-  \"update\" retries the block. Because \"update\" may call\n\nthe block several times
-  when multiple threads are all updating the same value,\n\nthe block's logic should
-  be kept as simple as possible.\n\n\n\n````ruby\n\nrequire 'atomic'\n\n\n\nmy_atomic
-  = Atomic.new(0)\n\nmy_atomic.update {|v| v + 1}\n\nbegin\n\n  my_atomic.try_update
-  {|v| v + 1}\n\nrescue Atomic::ConcurrentUpdateError => cue\n\n  # deal with it (retry,
-  propagate, etc)\n\nend\n\n````\n\n\n\nIt's also possible to use the regular get/set
-  operations on the Atomic, if you\n\nwant to avoid the exception and respond to contended
-  changes in some other way.\n\n\n\n````ruby\n\nmy_atomic = Atomic.new(0)\n\nmy_atomic.value
-  # => 0\n\nmy_atomic.value = 1\n\nmy_atomic.swap(2) # => 1\n\nmy_atomic.compare_and_swap(2,
-  3) # => true, updated to 3\n\nmy_atomic.compare_and_swap(2, 3) # => false, current
-  is not 2\n\n````\n\n\n\n== Building\n\n\n\nAs of 1.1.0, JDK8 is required to build
-  the atomic gem, since it attempts to use\n\nthe new atomic Unsafe.getAndSetObject
-  method only in JDK8. The resulting code\n\nshould still work fine as far back as
-  Java 5.\n"
+  Changes since 1.1.0\n\n* a574b34 More formatting for description.\n* 58d3e34 Convert
+  README to rdoc and try again.\n* f519385 Attempting to get description to look nice
+  on rubygems.org.\n* 2c5ab6c Include README and oneline logs in gem description.\n*
+  6aeb053 Add @funny-falcon to authors.\n* aa24d4d Bump version to 1.1.1.\n* dc327eb
+  Merge pull request #16 from funny-falcon/patch-1\n* 1b68767 Fix JRUBYREFERENCE8_ALLOCATOR\n\n==
+  Summary\n\n\n\nThis library provides:\n\n\n\n* an Atomic class that guarantees atomic
+  updates to its contained value\n\n\n\nThe Atomic class provides accessors for the
+  contained \"value\" plus two update methods:\n\n\n\n* 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.\n\n* 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.\n\n\n\nThe
+  atomic repository is at http://github.com/headius/ruby-atomic.\n\n\n\n== Usage\n\n\n\nThe
+  simplest way to use \"atomic\" is to call the \"update\" or \"try_update\" methods.\n\n\n\n\"try_update\"
+  and \"update\" both call the given block, passing the current value and using the
+  block's result as the new value. If the value is updated by another thread before
+  the block completes, \"try update\" raises a ConcurrentUpdateError and \"update\"
+  retries the block. Because \"update\" may call the block several times when multiple
+  threads are all updating the same value, the block's logic should be kept as simple
+  as possible.\n\n\n\n    require 'atomic'\n\n\n\n    my_atomic = Atomic.new(0)\n\n
+  \   my_atomic.update {|v| v + 1}\n\n    begin\n\n      my_atomic.try_update {|v|
+  v + 1}\n\n    rescue Atomic::ConcurrentUpdateError => cue\n\n      # deal with it
+  (retry, propagate, etc)\n\n    end\n\n\n\nIt's also possible to use the regular
+  get/set operations on the Atomic, if you want to avoid the exception and respond
+  to contended changes in some other way.\n\n\n\n    my_atomic = Atomic.new(0)\n\n
+  \   my_atomic.value # => 0\n\n    my_atomic.value = 1\n\n    my_atomic.swap(2) #
+  => 1\n\n    my_atomic.compare_and_swap(2, 3) # => true, updated to 3\n\n    my_atomic.compare_and_swap(2,
+  3) # => false, current is not 2\n\n\n\n== Building\n\n\n\nAs of 1.1.0, JDK8 is required
+  to build the atomic gem, since it attempts to use the new atomic Unsafe.getAndSetObject
+  method only in JDK8. The resulting code should still work fine as far back as Java
+  5.\n"
 email:
 - headius@headius.com
 - mental@rydia.net