thread_variables 0.1.0 → 0.2.0

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.rvmrc
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -1,12 +1,12 @@
 # ThreadVariables
 
 This gem provides methods to access thread local variables with a ruby trunk compatible
-API. It also provides an implementation for ruby 1.9, since ruby 1.9.3 made thread locals
-fiber local.
+API. It also provides an implementation of thread local variables for ruby 1.9, since ruby
+1.9 made thread locals fiber local. This change in semantics can lead to surprising
+results when accessing thread locals from enumerators.
 
 See http://bugs.ruby-lang.org/issues/7097
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,12 +23,28 @@ Or install it yourself as:
 
 ## Usage
 
+Basic interface: (this is the native code interface for ruby trunk)
+
     require "thread_variables"
     Thread.current.thread_variable_set :foo, 5
     Thread.current.thread_variable_get :foo
     Thread.current.thread_variable? :foo
     Thread.current.thread_variables
 
+Convenience interface: (proxied access to native interface)
+
+    require "thread_variables/access"
+    Thread.current.locals[:foo] = 5
+    Thread.current.locals[:foo]
+    Thread.current.locals.key?(:foo)
+    Thread.current.locals.keys
+
+Especially useful for the ||= pattern:
+
+    Thread.current.locals[:counter] ||= 0
+    Thread.current.locals[:counter] += 1
+
+
 ## Contributing
 
 1. Fork it

data/lib/thread_variables/access.rb

@@ -0,0 +1,31 @@
+require "thread_variables"
+
+module ThreadVariables
+  class AccessProxy < (RUBY_VERSION >= "1.9" ? BasicObject : Object)
+    def initialize(thread)
+      @thread = thread
+    end
+
+    def [](k)
+      @thread.thread_variable_get(k)
+    end
+
+    def []=(k,v)
+      @thread.thread_variable_set(k,v)
+    end
+
+    def key?(k)
+      @thread.thread_variable?(k)
+    end
+
+    def keys
+      @thread.thread_variables
+    end
+  end
+end
+
+class Thread
+  def locals
+    @thread_variables_access_proxy ||= ThreadVariables::AccessProxy.new(self)
+  end
+end

data/lib/thread_variables/version.rb

@@ -1,3 +1,3 @@
 module ThreadVariables
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/thread_variables_test.rb

@@ -1,7 +1,12 @@
-require 'thread_variables'
 require 'test/unit'
 require File.expand_path('../colorized_test_output', __FILE__)
 
+require 'thread'
+if $NATIVE_THREAD_VARIABLES = Thread.instance_methods.include?(:thread_variables)
+  puts ANSI.ansi("\nYou have native thread variables. Hurray!\n", :green)
+end
+require 'thread_variables/access'
+
 class ThreadVariablesTest < Test::Unit::TestCase
 
   def test_symbol_setter_and_getter
@@ -125,6 +130,44 @@ class ThreadVariablesTest < Test::Unit::TestCase
     assert_raises(SecurityError) do
       Thread.new { $SAFE = 4; t.thread_variable_set(:foo, :baz) }.join
     end
-  end if RUBY_VERSION > "1.9.3"
+  end if $NATIVE_THREAD_VARIABLES
+
+end
+
+class ProxyTest < Test::Unit::TestCase
+
+  def test_proxy_get
+    t = Thread.new { Thread.current.thread_variable_set :foo, :lol }
+    t.join
+    assert_equal :lol, t.locals[:foo]
+  end
+
+  def test_proxy_set
+    t = Thread.new { Thread.current.locals[:foo] = :lol }
+    t.join
+    assert_equal :lol, t.thread_variable_get(:foo)
+  end
+
+  def test_proxy_key
+    t = Thread.new { Thread.current.thread_variable_set :foo, :lol }
+    t.join
+    assert t.locals.key?(:foo)
+  end
+
+  def test_proxy_keys
+    t = Thread.new { Thread.current.thread_variable_set :foo, :lol }
+    t.join
+    assert_equal [:foo], t.locals.keys
+  end
+
+  def test_or_equals_pattern
+    t = Thread.new do
+      locals = Thread.current.locals
+      locals[:counter] ||= 1
+      locals[:counter] += 1
+    end
+    t.join
+    assert_equal 2, t.thread_variable_get(:counter)
+  end
 
 end

metadata

@@ -1,77 +1,66 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: thread_variables
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Stefan Kaes
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-11-02 00:00:00 Z
+date: 2012-11-03 00:00:00.000000000 Z
 dependencies: []
-
 description: Provide thread local variables for ruby 1.9 and API for all ruby versions
-email: 
+email:
 - stefan.kaes@xing.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/thread_variables.rb
+- lib/thread_variables/access.rb
 - lib/thread_variables/version.rb
 - test/colorized_test_output.rb
 - test/thread_variables_test.rb
 - thread_variables.gemspec
 - thread_variables.patch
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -1903362225607811994
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -1903362225607811994
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Provide functionality compatible to latest trunk commit for all ruby version above 1.8
-test_files: 
+summary: Provide functionality compatible to latest trunk commit for all ruby version
+  above 1.8
+test_files:
 - test/colorized_test_output.rb
 - test/thread_variables_test.rb