tsafe 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kasper Johansen
+
+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,19 @@
+= tsafe
+
+Description goes here.
+
+== Contributing to tsafe
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Kasper Johansen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "tsafe"
+  gem.homepage = "http://github.com/kaspernj/tsafe"
+  gem.license = "MIT"
+  gem.summary = %Q{Threadsafe proxy, array, hash and framework for making other classes threadsafe.}
+  gem.description = %Q{Proxy-objects for making another object threadsafe by proxying calls through mutex and method_missing. Monitored array and hash where all methods are going through monitor. Threadsafe class for including into a class that extends another class in order to make it threadsafe.}
+  gem.email = "k@spernj.org"
+  gem.authors = ["Kasper Johansen"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tsafe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/tsafe.rb

@@ -0,0 +1,120 @@
+require "monitor"
+
+#This module contains various tools to handle thread-safety easily and pretty.
+module Tsafe
+  #JRuby can corrupt an array in a threadded env. Use this method to only get a synchronized array when running JRuby and not having to write "if RUBY_ENGINE"-stuff.
+  def self.std_array
+    return MonArray.new if RUBY_ENGINE == "jruby"
+    return []
+  end
+  
+  #Instances of this class proxies calls to a given-object by using a mutex or monitor.
+  #
+  #==== Examples
+  # threadsafe_array = Tsafe::Proxy.new(:obj => [])
+  # threadsafe_array << 5
+  # ret = threadsafe_array[0]
+  #
+  # threadsafe_array = Tsafe::Proxy.new(:obj => [], :monitor => true)
+  class Proxy
+    #Spawn needed vars.
+    def initialize(args)
+      if args[:monitor]
+        @mutex = Monitor.new
+      elsif args[:mutex]
+        @mutex = args[:mutex]
+      else
+        @mutex = Mutex.new
+      end
+      
+      @obj = args[:obj]
+    end
+    
+    #Proxies all calls to this object through the mutex.
+    def method_missing(method_name, *args, &block)
+      @mutex.synchronize do
+        @obj.__send__(method_name, *args, &block)
+      end
+    end
+  end
+  
+  #This module can be included on a class to make all method-calls synchronized (by using monitor). Examples with array and hash are below.
+  #
+  #===Examples
+  # class MySyncedClass < SomeOtherClassThatNeedsToBeSynchronized
+  #   include Tsafe::Monitored
+  # end
+  module Monitored
+    def self.included(base)
+      base.to_s.split("::").inject(Object, :const_get).class_eval do
+        self.instance_methods.each do |method_name|
+          #These two methods create warnings under JRuby.
+          if RUBY_ENGINE == "jruby"
+            next if method_name == :instance_exec or method_name == :instance_eval
+          end
+          
+          new_method_name = "_ts_#{method_name}"
+          alias_method(new_method_name, method_name)
+          
+          define_method method_name do |*args, &block|
+            #Need to use monitor, since the internal calls might have to run not-synchronized, and we have just overwritten the internal methods.
+            @_ts_mutex = Monitor.new if !@_ts_mutex
+            @_ts_mutex.synchronize do
+              return self._ts___send__(new_method_name, *args, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+  
+  #This module can be included on a class to make all method-calls synchronized (by using mutex). Examples with array and hash are below.
+  #
+  #===Examples
+  # class MySyncedClass < SomeOtherClassThatNeedsToBeSynchronized
+  #   include Tsafe::Mutexed
+  # end
+  module Mutexed
+    def self.included(base)
+      base.to_s.split("::").inject(Object, :const_get).class_eval do
+        self.instance_methods.each do |method_name|
+          #These two methods create warnings under JRuby.
+          if RUBY_ENGINE == "jruby"
+            next if method_name == :instance_exec or method_name == :instance_eval
+          end
+          
+          new_method_name = "_ts_#{method_name}"
+          alias_method(new_method_name, method_name)
+          
+          define_method method_name do |*args, &block|
+            #Need to use monitor, since the internal calls might have to run not-synchronized, and we have just overwritten the internal methods.
+            @_ts_mutex = Mutex.new if !@_ts_mutex
+            @_ts_mutex.synchronize do
+              return self._ts___send__(new_method_name, *args, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+  
+  #Predefined synchronized array.
+  #
+  #===Examples
+  # arr = Tsafe::MonArray.new
+  # arr << 5
+  # ret = arr[0]
+  class MonArray < ::Array
+    include Monitored
+  end
+  
+  #Predefined synchronized hash.
+  #
+  #===Examples
+  # h = Tsafe::MonHash.new
+  # h['test'] = 'trala'
+  # ret = h['test']
+  class MonHash < ::Hash
+    include Monitored
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'tsafe'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/tsafe_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Tsafe" do
+  it "should be able to spawn threadsafe proxy-objects" do
+    arr = Tsafe::Proxy.new(:obj => {})
+    
+    0.upto(5) do |i|
+      arr[i] = i
+    end
+    
+    Thread.new do
+      begin
+        arr.each do |key, val|
+          res = key + val
+          sleep 0.1
+        end
+      rescue Exception => e
+        print e.inspect
+      end
+    end
+    
+    5.upto(10) do |i|
+      arr[i] = i
+      sleep 0.1
+    end
+  end
+  
+  it "should be able to spawn special classes" do
+    #Create new synchronized hash.
+    arr = Tsafe::MonHash.new
+    
+    #Make sure we get the right results.
+    arr[1] = 2
+    
+    res = arr[1]
+    raise "Expected 2 but got '#{res}'." if res != 2
+    
+    #Set some values to test with.
+    0.upto(5) do |i|
+      arr[i] = i
+    end
+    
+    #Try to call through each through a thread and then also try to set new values, which normally would crash the hash.
+    Thread.new do
+      begin
+        arr.each do |key, val|
+          res = key + val
+          sleep 0.1
+        end
+      rescue Exception => e
+        print e.inspect
+      end
+    end
+    
+    #This should not crash it, since they should wait for each other.
+    5.upto(10) do |i|
+      arr[i] = i
+      sleep 0.1
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: tsafe
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Kasper Johansen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-10 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.12"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Proxy-objects for making another object threadsafe by proxying calls through mutex and method_missing. Monitored array and hash where all methods are going through monitor. Threadsafe class for including into a class that extends another class in order to make it threadsafe.
+email: k@spernj.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tsafe.rb
+- spec/spec_helper.rb
+- spec/tsafe_spec.rb
+has_rdoc: true
+homepage: http://github.com/kaspernj/tsafe
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -3605232843790904975
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Threadsafe proxy, array, hash and framework for making other classes threadsafe.
+test_files: []
+