atomic 1.1.2-java → 1.1.4-java

data/README.rdoc

@@ -0,0 +1,43 @@
+= An atomic reference implementation for JRuby, Rubinius, and MRI.
+
+== 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
+
+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.

data/atomic.gemspec

@@ -1,21 +1,26 @@
 # -*- encoding: utf-8 -*-
 
 # Update these to get proper version and commit history
-new_version = "1.1.2"
-old_version = "1.1.1"
+new_version = "1.1.4"
+old_version = "1.1.0"
+
+git_lines = `git log --oneline #{old_version}...#{new_version}`.lines.map {|str| "* #{str}"}.join
+doc_lines = File.readlines("README.rdoc")
+description = <<EOS
+#{doc_lines[0]}
+
+== Changes since #{old_version}
+
+#{git_lines}
+#{doc_lines[2..-1].join("\n")}
+EOS
 
 Gem::Specification.new do |s|
   s.name = %q{atomic}
   s.version = new_version
   s.authors = ["Charles Oliver Nutter", "MenTaLguY", "Sokolov Yura"]
   s.date = Time.now.strftime('%Y-%m-%d')
-  s.description = <<EOS
-Changes in version #{new_version}:
-
-#{`git log --oneline #{old_version}...#{new_version}`}
-#{`kramdown README.md`}
-EOS
-puts s.description
+  s.description = description
   s.email = ["headius@headius.com", "mental@rydia.net", "funny.falcon@gmail.com"]
   s.homepage = "http://github.com/headius/ruby-atomic"
   s.require_paths = ["lib"]

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: atomic
 version: !ruby/object:Gem::Version
-  version: 1.1.2
   prerelease:
+  version: 1.1.4
 platform: java
 authors:
 - Charles Oliver Nutter
@@ -11,79 +11,104 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-04-06 00:00:00.000000000 Z
 dependencies: []
-description: |+
-  Changes in version 1.1.2:
+description: |
+  = An atomic reference implementation for JRuby, Rubinius, and MRI.
 
 
-  <p>atomic: An atomic reference implementation for JRuby, Rubinius, and MRI.</p>
+  == Changes since 1.1.0
 
-  <h1 id="summary">Summary</h1>
+  * a574b34 More formatting for description.
+  * 58d3e34 Convert README to rdoc and try again.
+  * f519385 Attempting to get description to look nice on rubygems.org.
+  * 2c5ab6c Include README and oneline logs in gem description.
+  * 6aeb053 Add @funny-falcon to authors.
+  * aa24d4d Bump version to 1.1.1.
+  * dc327eb Merge pull request #16 from funny-falcon/patch-1
+  * 1b68767 Fix JRUBYREFERENCE8_ALLOCATOR
 
-  <p>This library provides:</p>
+  == Summary
 
-  <ul>
-    <li>an Atomic class that guarantees atomic updates to its contained value</li>
-  </ul>
 
-  <p>The Atomic class provides accessors for the contained “value” plus two update
-  methods:</p>
 
-  <ul>
-    <li>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.</li>
-    <li>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.</li>
-  </ul>
+  This library provides:
 
-  <p>The atomic repository is at http://github.com/headius/ruby-atomic.</p>
 
-  <h1 id="usage">Usage</h1>
 
-  <p>The simplest way to use “atomic” is to call the “update” or “try_update”
-  methods.</p>
+  * an Atomic class that guarantees atomic updates to its contained value
 
-  <p>“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.</p>
 
-  <p>````ruby
-  require ‘atomic’</p>
 
-  <p>my_atomic = Atomic.new(0)
-  my_atomic.update {|v| v + 1}
-  begin
-    my_atomic.try_update {|v| v + 1}
-  rescue Atomic::ConcurrentUpdateError =&gt; cue
-    # deal with it (retry, propagate, etc)
-  end
-  ````</p>
+  The Atomic class provides accessors for the contained "value" plus two update methods:
 
-  <p>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.</p>
 
-  <p><code>ruby
-  my_atomic = Atomic.new(0)
-  my_atomic.value # =&gt; 0
-  my_atomic.value = 1
-  my_atomic.swap(2) # =&gt; 1
-  my_atomic.compare_and_swap(2, 3) # =&gt; true, updated to 3
-  my_atomic.compare_and_swap(2, 3) # =&gt; false, current is not 2
-  </code></p>
 
-  <h1 id="building">Building</h1>
+  * 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.
 
-  <p>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.</p>
+  * 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.
+
+
+
+      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.
 email:
 - headius@headius.com
 - mental@rydia.net
@@ -97,7 +122,7 @@ files:
 - .gitignore
 - .travis.yml
 - LICENSE
-- README.md
+- README.rdoc
 - Rakefile
 - atomic.gemspec
 - examples/atomic_example.rb
@@ -123,17 +148,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project:
 rubygems_version: 1.8.24

data/README.md

@@ -1,65 +0,0 @@
-atomic: An atomic reference implementation for JRuby, Rubinius, and MRI.
-
-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
-=====
-
-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
-````
-
-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.