synchronizable 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.idea/*
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gemspec
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ryan LeCompte
+
+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,59 @@
+= Synchronizable
+
+Synchronizable is a gem that provides an easy module-based mechanism
+for making any object thread-safe with an instance-level lock. This
+gem was originally inspired from Mike Perham's dalli gem, which provides
+a ThreadSafe module for his memcached client. However, that solution
+is not currently generic. This gem attempts to provide a generic solution
+that can work with any object (including classes/modules) in your system.
+
+== Installation
+
+Synchronizable is available as a RubyGem:
+
+    gem install synchronizable
+
+== Examples
+
+    class Foo
+      def bar
+      end
+
+      def baz
+      end
+    end
+
+    foo = Foo.new
+    # the foo instance now has all methods synchronized / thread-safe
+    foo.extend(Synchronizable)
+
+    # note that classes are objects in Ruby and can also be synchronized
+    class Bar
+      def self.foo
+      end
+    end
+
+    # only class/singleton methods will become synchronized
+    Bar.extend(Synchronizable)
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Authors
+
+* Ryan LeCompte
+
+== Credits
+
+* Mike Perham (inspired from ThreadSafety module in https://github.com/mperham/dalli)
+
+== Copyright
+
+Copyright (c) 2011 Ryan LeCompte. See LICENSE for
+further details.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/synchronizable.rb

@@ -0,0 +1,30 @@
+require 'thread'
+require 'synchronizable/version'
+
+# Synchronizable is intended to be injected into objects via Object#extend.
+# After Object#extend(Synchronizable) is performed, the object's original
+# methods will become synchronized via a per-instance lock.
+module Synchronizable
+  IGNORABLE_METHOD_OWNERS = [Object, Kernel, BasicObject]
+
+  def self.extended(obj)
+    # immediately create object-level lock
+    obj.send(:__lock)
+
+    # redefine all user-defined methods to utilize lock
+    obj.methods.each do |m|
+      next if IGNORABLE_METHOD_OWNERS.include?(obj.method(m).owner)
+      obj.define_singleton_method(m) do |*args, &block|
+        __lock.synchronize do
+          super(*args, &block)
+        end
+      end
+    end
+  end
+
+  private
+
+  def __lock
+    @__lock ||= Mutex.new
+  end
+end

data/lib/synchronizable/version.rb

@@ -0,0 +1,3 @@
+module Synchronizable
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'synchronizable'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+RSpec.configure do |config|
+end

data/spec/synchronizable/synchronizable_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Synchronizable do
+  context "when extended by an object" do
+    let(:object) { String.new }
+
+    it "creates an instance-level lock" do
+      object.instance_variables.should_not include(:@__lock)
+      object.extend(Synchronizable)
+      object.instance_variables.should include(:@__lock)
+    end
+
+    it "creates a locked version of each original method" do
+      class TestLock
+        attr_reader :sync_invoked
+
+        def initialize
+          @sync_invoked = false
+        end
+
+        def synchronize(&block)
+          @sync_invoked = true
+        end
+      end
+
+      lock = TestLock.new
+      object.extend(Synchronizable)
+      object.instance_variable_set(:@__lock, lock)
+
+      # methods from Object not wrapped
+      object.object_id
+      lock.sync_invoked.should == false
+
+      # class-defined methods should be wrapped
+      object.size
+      lock.sync_invoked.should == true
+    end
+  end
+end

data/synchronizable.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "synchronizable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "synchronizable"
+  s.version     = Synchronizable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ryan LeCompte"]
+  s.email       = ["lecompte@gmail.com"]
+  s.homepage    = "http://github.com/ryanlecompte/synchronizable"
+  s.summary     = %q{Synchronizable is a generic way to provide per-object thread safety}
+  s.description = %q{Synchronizable is a generic way to provide per-object thread safety}
+
+  s.rubyforge_project = "synchronizable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency("rspec", "~> 2.5.0")
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: synchronizable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ryan LeCompte
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id001
+description: Synchronizable is a generic way to provide per-object thread safety
+email: 
+- lecompte@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/synchronizable.rb
+- lib/synchronizable/version.rb
+- spec/spec_helper.rb
+- spec/synchronizable/synchronizable_spec.rb
+- synchronizable.gemspec
+has_rdoc: true
+homepage: http://github.com/ryanlecompte/synchronizable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: synchronizable
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Synchronizable is a generic way to provide per-object thread safety
+test_files: 
+- spec/spec_helper.rb
+- spec/synchronizable/synchronizable_spec.rb