lib/core_ext/class.rb lib/rails_ext/activerecord/base.rb test/abstract_unit.rb test/active_record_test.rb @@ -3,9 +3,11 @@ require File.dirname(__FILE__) + '/lib/core_ext/proc_source' require File.dirname(__FILE__) + '/lib/background' require File.dirname(__FILE__) + '/lib/core_ext/background' +require File.dirname(__FILE__) + '/lib/core_ext/class' Dir.glob(File.dirname(__FILE__) + '/lib/core_ext/handlers/*.rb').each do |handler| require handler end Dir.glob(File.dirname(__FILE__) + '/lib/core_ext/error_reporters/*.rb').each do |reporter| require reporter end +require File.dirname(__FILE__) + '/lib/rails_ext/activerecord/base' init.rb @@ -20,8 +20,33 @@ module Background #:nodoc: end def self.load(configuration) - loaded_config = ((config[RAILS_ENV] || {})[configuration] || {}) - default_config.merge(loaded_config.symbolize_keys || {}) + if configuration.blank? + default_config + else + loaded_config = ((config[RAILS_ENV] || {})[configuration] || {}) + default_config.merge(loaded_config.symbolize_keys || {}) + end + end + end + + mattr_accessor :disabled + self.disabled = false + + def self.disable! + Background.disabled = true + end + + def self.enable! + Background.disabled = false + end + + def self.disable(&block) + value = Background.disabled + begin + Background.disable! + yield + ensure + Background.disabled = value end end end lib/background.rb @@ -15,7 +15,7 @@ module Kernel # end # # # execute all calls to FactorialClass#factorial in the background - # background :factorial, :params => ['number'] + # background :factorial # end # # === Execute a block in the background. @@ -69,10 +69,6 @@ module Kernel # element of the array may be a Symbol or a hash with one element. If it is a hash, the key # is the handler name, and the value contains configuration options for the handler. # - # params:: Parameter names of the method to decorate. These parameter names must match the parameter - # names of the original method, that is decorated. This option is ignored, when a block is - # given. - # # locals:: A Hash containing name-value-pairs of local variables that need to be accessible to the # block when it is run in the background. This option is ignored when a method is decorated. # @@ -130,35 +126,22 @@ module Kernel # serialized and can be referenced in the block using the self keyword. def background(*args, &block) if args.first.is_a?(Symbol) && self.is_a?(Class) - method = args.shift - options = args.first || {} - params = options.delete(:params) || [] - # handler = [options.delete(:handler)].flatten - - alias_method_chain method, :background do |aliased_target, punctuation| - self.class_eval %{ - def #{method}_with_background#{punctuation}(#{params.join(', ')}) - background(:locals => { #{params.collect {|p| ":#{p} => #{p}" }.join(', ')} }) do - #{method}_without_background#{punctuation}(#{params.join(', ')}) - end - end - } - end + # this is for backwards compatibility + background_method *args else options = args.first || {} locals = options.delete(:locals) || {} locals.each do |key, value| - locals[key] = value.dup rescue value + locals[key] = value.clone_for_background rescue value end - locals[:self] = self.dup - if options[:config] - #puts options[:config] - config = (Background::Config.load(options[:config].to_s) || {}) + locals[:self] = self.clone_for_background + + config = (Background::Config.load(options[:config].to_s) || {}) + handler = if Background.disabled + [:in_process] else - config = {} + [options.delete(:handler) || config[:handler] || Background::Config.default_handler].flatten end - #puts config.inspect - handler = [options.delete(:handler) || config[:handler] || Background::Config.default_handler].flatten reporter = options.delete(:reporter) || config[:reporter] || Background::Config.default_error_reporter handler.each do |hand| @@ -170,7 +153,10 @@ module Kernel end begin - "Background::#{hand.to_s.camelize}Handler".constantize.handle(locals, options, &block) + Background.disable do + "Background::#{hand.to_s.camelize}Handler".constantize.handle(locals, options, &block) + end + return hand rescue Exception => e "Background::#{reporter.to_s.camelize}ErrorReporter".constantize.report(e) @@ -179,4 +165,8 @@ module Kernel end nil end + + def clone_for_background + dup + end end lib/core_ext/background.rb @@ -46,12 +46,17 @@ module Background #:nodoc: # Executes a marshalled message which was previously sent over ActiveMQ, in the context of the self # object, with all the other local variables defined. def self.execute(message) - code, obj, variables = self.decode(message) - puts "--- executing code: #{code.source}\n--- with variables: #{variables.inspect}\n--- in object: #{obj.inspect}" + begin + code, obj, variables = self.decode(message) + puts "--- executing code: #{code.source}\n--- with variables: #{variables.inspect}\n--- in object: #{obj.inspect}\n--- with instance variables\n #{obj.instance_variables.collect { |v| v + " ==> " + obj.instance_variable_get(v).inspect }.join("\n")}" - obj.send :instance_eval, variables.collect { |key, value| "#{key} = variables[:#{key}]" }.join(';') - obj.send :instance_eval, code.source - puts "--- it happened!" + obj.send :instance_eval, variables.collect { |key, value| "#{key} = variables[:#{key}]" }.join(';') + obj.send :instance_eval, code.source + puts "--- it happened!" + rescue Exception => e + puts e.message + puts e.backtrace + end end end end lib/core_ext/handlers/active_messaging_handler.rb @@ -1,7 +1,4 @@ -require 'rubygems' -require 'activesupport' -require 'test/unit' -require File.dirname(__FILE__) + '/../init' +require File.expand_path(File.dirname(__FILE__) + '/abstract_unit') class SomeBackgroundClass def add_three(a, b, c) @@ -22,6 +19,7 @@ class BackgroundTest < Test::Unit::TestCase def teardown Background::TestHandler.reset Background::TestErrorReporter.last_error = nil + Background.enable! end def test_should_run_code_block_in_background @@ -110,4 +108,51 @@ class BackgroundTest < Test::Unit::TestCase assert_not_nil Background::TestHandler.options assert_equal 2, Background::TestHandler.options[:some_option] end + + def test_should_correctly_marshal_classes + assert_equal SomeBackgroundClass, Marshal.load(Marshal.dump(SomeBackgroundClass.clone_for_background)) + end + + def test_should_correctly_marshal_singleton_objects + obj = Object.new + def obj.some_method + end + + assert Marshal.load(Marshal.dump(obj.clone_for_background)) + end + + def test_should_disable_background + Background.enable! + Background.disable do + assert Background.disabled + end + assert !Background.disabled + end + + def test_should_disable_background_if_already_disabled + Background.disable! + Background.disable do + assert Background.disabled + end + assert Background.disabled + end + + def test_should_reenable_background_when_exception_is_raised_in_block + begin + Background.disable do + raise 'grr' + end + rescue RuntimeError => e + assert_equal 'grr', e.message + end + + assert !Background.disabled + end + + def test_should_disable_background_while_executing_block + Background.enable! + background :handler => :in_process do + assert Background.disabled + end + end end test/background_test.rb test/config/background.yml 0dfe353eecaa910818d8977c6d2ebdf41779fd07 Thomas Kadauke tkadauke@imedo.de http://github.com/imedo/background/commit/9792d10045ee3c417cf313d852319d09564ebb7e 9792d10045ee3c417cf313d852319d09564ebb7e 2009-03-07T11:54:32-08:00 2009-03-07T11:54:32-08:00 fixes in configuration loading; fixes in marshalling of active record objects 3c62495be45451e87af5a2ba3a442dac8d992d56 Thomas Kadauke tkadauke@imedo.de