tlattr_accessors 0.0.3

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT license:
+Copyright (c) 2009 Maximilian Schöfmann
+ 
+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.rdoc

@@ -0,0 +1,81 @@
+= Thread-local accessors for your classes
+
+Yet another tiny library to tackle this problem.
+
+Install with: <tt>gem install schoefmax-tlattr_accessors --source=http://gems.github.com</tt>
+
+=== Example
+
+  require 'rubygems'
+  require 'tlattr_accessors'
+
+  class ThreadExample
+    extend ThreadLocalAccessors
+    tlattr_accessor :foo
+
+    def test
+      self.foo = "bla"
+      Thread.new {
+        puts foo                  # prints "nil"
+        self.foo = "blubb"
+        puts foo                  # prints "blubb"
+      }.join
+      puts foo                    # prints "bla"
+    end
+  end
+
+  ThreadExample.new.test
+
+If you want to enable them globally, add this somewhere (e.g. an initializer in Rails)
+
+  Object.send :extend, ThreadLocalAccessors
+
+=== Default values
+
+Adding +true+ as last parameter will cause the first value set on the
+attribute to act as default value for all other threads:
+
+  tlattr_accessor :yeah, :baby, true
+
+  def test_default
+    self.yeah = "bla"
+    Thread.new {
+      puts yeah                  # prints "bla"
+      puts baby                  # prints "nil"
+      self.baby = "blubb"
+      self.yeah = "blabla"
+    }.join
+    puts yeah                    # prints "bla"
+    puts baby                    # prints "blubb"
+  end
+
+=== Getters and Setters
+
+This gem doesn't support <tt>tlattr</tt> or <tt>tlattr_reader|writer</tt> for
+the simple reason that they don't make any sense here (you don't have an "instance
+variable", so you need both methods).
+If you want to hide one of them from your API, you can always make them private:
+
+  tlattr_accessor :foo
+  private :foo= # hide the setter
+
+=== Performance
+
+The <tt>Thread.current</tt>-Hash is a global namespace. Using it to store
+thread-local variables safely requires carefully crafted keys, which tend to
+be rather expensive to compute. This hurts performance if the attribute is
+accessed frequently.
+Therefore, this library uses a different approach, which is a lot faster:
+The values are stored in a separate hash which is keyed by the object_id of
+the thread. Finalizers make sure no memory is leaked when threads finish
+(see the spec). 
+
+=== Running specs
+
+If you haven't already, install the rspec gem, then run:
+
+  spec spec
+
+
+(c) 2009, Max Schoefmann <max (a) pragmatic-it de>
+Released under the MIT license

data/lib/tlattr_accessors.rb

@@ -0,0 +1,45 @@
+module ThreadLocalAccessors
+  # Creates thread-local accessors for the given attribute name.
+  #
+  # === Example:
+  #
+  #   tlattr_accessor :my_attr, :another_attr
+  #
+  # === Default values
+  #
+  # You can make the attribute inherit the first value that was set on it in
+  # any thread:
+  #
+  #   tlattr_accessor :my_attr, true
+  #
+  #   def initialize
+  #     self.my_attr = "foo"
+  #     Thread.new do
+  #        puts self.my_attr # => "foo" (instead of nil)
+  #     end.join
+  #   end
+  def tlattr_accessor(*names)
+    first_is_default = names.pop if [true, false].include?(names.last)
+    names.each do |name|
+      ivar = "@_tlattr_#{name}"
+      class_eval %Q{
+        def #{name}
+          if #{ivar}
+            #{ivar}[Thread.current.object_id]
+          else
+            nil
+          end
+        end
+
+        def #{name}=(val)
+          #{ivar} = Hash.new #{'{|h, k| h[k] = val}' if first_is_default} unless #{ivar}
+          thread_id = Thread.current.object_id
+          unless #{ivar}.has_key?(thread_id)
+            ObjectSpace.define_finalizer(Thread.current, lambda { #{ivar}.delete(thread_id) })
+          end
+          #{ivar}[thread_id] = val
+        end
+      }, __FILE__, __LINE__
+    end
+  end
+end

data/spec/thread_local_accessors_spec.rb

@@ -0,0 +1,87 @@
+require 'rubygems'
+require 'spec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'tlattr_accessors')
+
+describe ThreadLocalAccessors do
+
+  class Foo
+    extend ThreadLocalAccessors
+    tlattr_accessor :bar, true
+    tlattr_accessor :foo, :baz
+  end
+
+  class Bar
+    def initialize(value)
+      @value = value
+    end
+  end
+
+  it 'should allow defining multiple attributes at once' do
+    x = Foo.new
+    [:foo, :foo=, :baz=, :baz].each do |method|
+      x.should respond_to(method)
+    end
+  end
+
+  it "should store values local to the thread" do
+    x = Foo.new
+    x.baz = 2
+    Thread.new do
+      x.baz = 3
+      Thread.new do
+        x.baz = 5
+      end.join
+      x.baz.should == 3
+    end.join
+    x.baz.should == 2
+  end
+  
+  it 'should, by default, not return a default value' do
+    x = Foo.new
+    x.baz = 2
+    Thread.new do
+      x.baz.should be_nil
+    end.join
+  end
+
+  it 'should, if told to, use the first value as default for subsequent threads' do
+    # Foo#bar is defined with +true+ as last param
+    x = Foo.new
+    x.bar = 2
+    Thread.new do
+      x.bar.should == 2
+      x.bar = 3
+      Thread.new do
+        x.bar.should == 2
+        x.bar = 5
+      end.join
+      x.bar.should == 3
+    end.join
+    x.bar.should == 2
+  end
+
+  it 'should not leak memory' do
+    x = Foo.new
+    n = 6000
+    # create many thread-local values to make sure GC is invoked
+    n.times do
+      Thread.new do
+        x.bar = Bar.new(rand)
+      end.join
+    end
+    hash = x.send :instance_variable_get, '@_tlattr_bar'
+    hash.size.should < (n / 2) # it should be a lot lower than n!
+  end
+
+  it 'should define only one finalizer per thread' do
+    ObjectSpace.should_receive(:define_finalizer).exactly(:twice)
+    x = Foo.new
+    2.times do
+      Thread.new do
+        10.times { x.foo = "bar" }
+      end.join
+    end
+  end
+
+end
+

data/tlattr_accessors.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tlattr_accessors}
+  s.version = "0.0.3"
+  s.authors = ["Maximilian Sch\303\266fmann"]
+  s.date = %q{2009-03-10}
+  s.description = "thread-local accessors for your classes"
+  s.email = "max@pragmatic-it.de"
+  s.extra_rdoc_files = ["LICENSE", "README.rdoc"]
+  s.files = ["lib/tlattr_accessors.rb", "LICENSE", "README.rdoc", "spec/thread_local_accessors_spec.rb", "tlattr_accessors.gemspec"]
+  s.has_rdoc = true
+  s.homepage = "http://github.com/schoefmax/tlattr_accessors"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "tlattr_accessors", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "tlattr_accessors"
+  s.rubygems_version = %q{1.3.1}
+  s.summary = "thread-local accessors for your classes"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: tlattr_accessors
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- "Maximilian Sch\xC3\xB6fmann"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-10 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: thread-local accessors for your classes
+email: max@pragmatic-it.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/tlattr_accessors.rb
+- LICENSE
+- README.rdoc
+- spec/thread_local_accessors_spec.rb
+- tlattr_accessors.gemspec
+has_rdoc: true
+homepage: http://github.com/schoefmax/tlattr_accessors
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- tlattr_accessors
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: tlattr_accessors
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: thread-local accessors for your classes
+test_files: []
+