thread_variable 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in thread_variable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 J. Andrew Marshall <http://johnandrewmarshall.com>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# ThreadVariable
+
+[![Build Status](https://secure.travis-ci.org/amarshall/thread_variable.png)](http://travis-ci.org/amarshall/thread_variable)
+
+Makes it easy to create and use thread-local variables. This encapsulates two patterns:
+
+- The `Thread.current` hash is not namespaced, which can make name collision between different libraries or parts of an app very possible. ThreadVariable gets around this by namespacing variables under the current class/module name.
+- Accessing and setting `Thread.current` is not so pretty to look at, so ThreadVariable creates a getter and setter for each thread variable.
+
+## Installation
+
+Install as your normally would, nothing special here. Only compatible with Ruby 1.9+.
+
+## Usage
+
+Simply `extend ThreadVariable` and call `thread_variable` in classes you want thread variables in:
+
+    class C
+      extend ThreadVariable
+      thread_variable :foo
+    end
+
+    C.foo = 'bar'
+
+    Thread.new do
+      C.foo = 'baz'
+      C.foo  #=> "baz"
+    end.join
+
+    C.foo  #=> "bar"
+
+If you don’t want to `extend ThreadLocal` everywhere you can instead do
+
+    require 'thread_variable/core_ext'
+
+which will `include ThreadVariable` in both `Class` & `Module`.
+
+For more, just read the source. Seriously, go read it—it’s less than 20 lines and will only take a minute.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits & License
+
+Copyright © 2012 J. Andrew Marshall. All rights reserved.
+License is available in the LICENSE file.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/thread_variable/core_ext.rb

@@ -0,0 +1,9 @@
+require 'thread_variable'
+
+class Class
+  include ThreadVariable
+end
+
+class Module
+  include ThreadVariable
+end

data/lib/thread_variable/version.rb

@@ -0,0 +1,3 @@
+module ThreadVariable
+  VERSION = '0.1.0'
+end

data/lib/thread_variable.rb

@@ -0,0 +1,17 @@
+require 'thread_variable/version'
+
+module ThreadVariable
+  def thread_variable *names
+    names.each do |name|
+      define_singleton_method :"#{name}" do
+        namespace = (self.name ? self.name : self.object_id.to_s).to_sym
+        (Thread.current[namespace] ||= {})[name]
+      end
+
+      define_singleton_method :"#{name}=" do |val|
+        namespace = (self.name ? self.name : self.object_id.to_s).to_sym
+        (Thread.current[namespace] ||= {})[name] = val
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'thread_variable'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

data/spec/thread_variable_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe ThreadVariable do
+  let(:klass) do
+    Class.new do
+      extend ThreadVariable
+      thread_variable :my_var
+    end
+  end
+
+  before do
+    # Normally I wouldn't do this, but threads are special
+    klass.my_var.should be_nil
+  end
+
+  it "can set and retrieve a thread variable" do
+    klass_var = klass.my_var = double
+    klass.my_var.should == klass_var
+  end
+
+  it "is local to a thread" do
+    klass_var = klass.my_var = double
+    Thread.new do
+      klass.my_var.should be_nil
+    end.join
+    klass.my_var.should == klass_var
+  end
+
+  it "namespaces thread variables for anonymous classes" do
+    other_klass = Class.new do
+      extend ThreadVariable
+      thread_variable :my_var
+    end
+
+    klass_var = klass.my_var = double
+    other_var = other_klass.my_var = double
+
+    klass.my_var.should == klass_var
+    other_klass.my_var.should == other_var
+  end
+
+  it "namespaces thread variables for named classes" do
+    stub_const 'C', klass
+    stub_const 'D', (Class.new do
+      extend ThreadVariable
+      thread_variable :my_var
+    end)
+
+    c_var = C.my_var = double
+    d_var = D.my_var = double
+
+    C.my_var.should == c_var
+    D.my_var.should == d_var
+  end
+end

data/thread_variable.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thread_variable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'thread_variable'
+  gem.version       = ThreadVariable::VERSION
+  gem.authors       = ['Andrew Marshall']
+  gem.email         = ['andrew@johnandrewmarshall.com']
+  gem.description   = %q{Makes it easy to create and use thread-local variables.}
+  gem.summary       = %q{Makes it easy to create and use thread-local variables.}
+  gem.homepage      = 'http://johnandrewmarshall.com/projects/thread_variable'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: thread_variable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Marshall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Makes it easy to create and use thread-local variables.
+email:
+- andrew@johnandrewmarshall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/thread_variable.rb
+- lib/thread_variable/core_ext.rb
+- lib/thread_variable/version.rb
+- spec/spec_helper.rb
+- spec/thread_variable_spec.rb
+- thread_variable.gemspec
+homepage: http://johnandrewmarshall.com/projects/thread_variable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Makes it easy to create and use thread-local variables.
+test_files:
+- spec/spec_helper.rb
+- spec/thread_variable_spec.rb
+has_rdoc: