proc_rollback 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Michael Klaus
+
+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/lib/proc_rollback.rb

@@ -0,0 +1,43 @@
+# check fo tracing of attr_* methods
+c = Class.new do
+  attr_accessor :foo
+end
+o = c.new
+Thread.new do
+  result = false
+  Thread.current.send :set_trace_func, lambda {|type, file, line, mth, bnd, cls|
+    result = true if mth == :foo= and eval('self',bnd) == o
+  }
+  o.foo=o.foo
+  Thread.current.send :set_trace_func, nil
+  result
+end.value or puts("Tracing of attr_* methods does not work. Check http://redmine.ruby-lang.org/issues/4583 to see which ruby version you can use. Proc_rollback will not work in some cases.")
+
+# add rollbackablility to Proc
+class Proc
+  def call_rollbackable(*args, &b)
+    vars = {}
+    in_trace = false
+    tf = proc{ |action, file, line, mth, bnd, cls|
+      unless in_trace or (file == __FILE__)
+        in_trace = true
+        obj = eval("self", bnd)
+        vars[obj] ||= obj.instance_variables.inject({}){ |r, n| r.merge n => obj.instance_variable_get(n)}
+        in_trace = false
+      end
+    }
+
+    set_trace_func tf
+    result = call(*args, &b)
+    set_trace_func nil
+
+    class << self; self; end.send :define_method, :rollback do
+      vars.each_pair do |obj, vars|
+        vars.each_pair do |n, v|
+          obj.instance_variable_set(n, v)
+        end
+      end
+    end
+    result
+  end
+end

data/lib/proc_rollback/version.rb

@@ -0,0 +1,3 @@
+module ProcRollback
+  VERSION = '0.0.1'
+end

data/spec/proc_rollback_spec.rb

@@ -0,0 +1,80 @@
+require 'proc_rollback'
+
+class SomeClass
+  class << self
+    def modify_class_var(new_value)
+      @@class_var = new_value
+    end
+    def class_var
+      @@class_var
+    end
+
+    attr_accessor :class_inst_var    
+  end
+
+  attr_accessor :inst_var
+  def modify_inst_var(new_value)
+    self.inst_var = new_value
+  end
+end
+
+module SomeModule
+  class << self
+    attr_accessor :inst_var
+  end
+end
+
+describe Proc do
+  it 'should provide a rollback method after the call' do
+    p = proc{}
+    p.call_rollbackable
+    p.respond_to?(:rollback).should == true
+  end
+
+  it 'should return the value of the proc' do
+    p = proc{ 'foo' }
+    p.call_rollbackable.should == 'foo'
+  end
+
+  it 'should rollback object instance variables' do
+    @obj = SomeClass.new
+    @obj.inst_var = 'foo'
+    p = proc{ @obj.inst_var = 'bar' }
+    p.call_rollbackable
+    @obj.inst_var.should == 'bar'
+
+    p.rollback
+    @obj.inst_var.should == 'foo'
+  end
+
+  it 'should rollback class instance variables' do
+    SomeClass.class_inst_var = 'foo'
+    p = proc{ SomeClass.class_inst_var = 'bar' }
+    p.call_rollbackable
+    SomeClass.class_inst_var.should == 'bar'
+
+    p.rollback
+    SomeClass.class_inst_var.should == 'foo'
+  end
+
+  it 'should rollback module instance variables' do
+    SomeModule.inst_var = 'foo'
+    p = proc{ SomeModule.inst_var = 'bar' }
+    p.call_rollbackable
+    SomeModule.inst_var.should == 'bar'
+
+    p.rollback
+    SomeModule.inst_var.should == 'foo'
+  end
+
+  it 'should rollback method calls' do
+    @obj = SomeClass.new
+    @obj.inst_var = 'foo'
+    p = proc{ @obj.modify_inst_var 'bar' }
+    p.call_rollbackable
+    @obj.inst_var.should == 'bar'
+
+    p.rollback
+    @obj.inst_var.should == 'foo'
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: proc_rollback
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Klaus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-18 00:00:00 +02: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 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Rollback the side effects of a Proc by resetting the modified instance variables. Does not work on native code!
+email: 
+- Michael.Klaus@gmx.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/proc_rollback/version.rb
+- lib/proc_rollback.rb
+- spec/proc_rollback_spec.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/QaDeS/proc_rollback
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: proc_rollback
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Lets you rollback the side effects of a Proc by resetting the modified instance variables.
+test_files: []
+