resque 1.5.2 → 1.6.0

data/CONTRIBUTORS

@@ -1,23 +1,28 @@
 * Chris Wanstrath
+* gravis
 * John Barnette
+* scotttam
 * Aaron Quint
 * Adam Cooke
+* Ashley Martens
+* Jason Amster
 * Mike Mangino
 * Rob Hanlon
-* Jason Amster
 * jgeiger
-* Daniel Ceballos
-* Matt Duncan
 * Roman Heinrich
+* Thibaut Barrère
+* Matt Duncan
+* Daniel Ceballos
 * Ben VandenBos
 * Christos Trochalakis
-* Matt Palmer
-* Michael Dwan
-* Brian P O'Rourke
-* Karel Minarik
-* Arthur Zapparoli
+* Roland Moriz
 * Simon Rozet
-* Dave Hoover
+* Brian P O'Rourke
 * PJ Hyett
+* Ben Marini
+* Karel Minarik
 * Masatomo Nakano
-* gravis
+* Matt Palmer
+* Michael Dwan
+* Dave Hoover
+* Arthur Zapparoli

data/HISTORY.md

@@ -1,3 +1,10 @@
+## 1.6.0 (2010-03-09)
+
+* Added `before_first_fork`, `before_fork`, and `after_fork` hooks.
+* Hoptoad: Added server_environment config setting
+* Hoptoad bugfix: Don't depend on RAILS_ROOT
+* 1.8.6 compat fixes
+
 ## 1.5.2 (2010-03-03)
 
 * Bugfix: JSON check was crazy.

data/README.markdown

@@ -648,6 +648,36 @@ this way we can tell our Sinatra app about the config file:
 
 Now everyone is on the same page.
 
+If you wish to have a Proc called before the worker forks for the
+first time, you can add it in the initializer like so:
+
+    Resque.before_first_fork do
+      puts "CALL ME ONCE BEFORE THE WORKER FORKS THE FIRST TIME"
+    end
+
+You can also run a hook before _every_ fork:
+
+    Resque.before_fork do |job|
+      puts "CALL ME ONCE BEFORE THE WORKER FORKS THE FIRST TIME"
+    end
+
+The `before_fork` hook will be run in the **parent** process. So, be
+careful - any changes you make will be permanent for the lifespan of
+the worker.
+
+And after forking:
+
+    Resque.after_fork do |job|
+      puts "CALL ME ONCE BEFORE THE WORKER FORKS THE FIRST TIME"
+    end
+
+The `after_fork` hook will be run in the child process and is passed
+the current job. Any changes you make, therefor, will only live as
+long as the job currently being processes.
+
+All hooks can also be set using a setter, e.g.
+
+    Resque.after_fork = proc { puts "called" }
 
 Namespaces
 ----------
@@ -729,6 +759,9 @@ Once you've made your great commits:
 4. Create an [Issue][2] with a link to your branch
 5. That's it!
 
+You might want to checkout our [Contributing][cb] wiki page for information
+on coding standards, new features, etc.
+
 
 Mailing List
 ------------
@@ -764,3 +797,4 @@ Chris Wanstrath :: chris@ozmm.org :: @defunkt
 [2]: http://github.com/defunkt/resque/issues
 [sv]: http://semver.org/
 [rs]: http://github.com/defunkt/redis-namespace
+[cb]: http://wiki.github.com/defunkt/resque/contributing

data/lib/resque.rb

@@ -48,6 +48,53 @@ module Resque
     self.redis
   end
 
+  # The `before_first_fork` hook will be run in the **parent** process
+  # only once, before forking to run the first job. Be careful- any
+  # changes you make will be permanent for the lifespan of the
+  # worker.
+  #
+  # Call with a block to set the hook.
+  # Call with no arguments to return the hook.
+  def before_first_fork(&block)
+    block ? (@before_first_fork = block) : @before_first_fork
+  end
+
+  # Set a proc that will be called in the parent process before the
+  # worker forks for the first time.
+  def before_first_fork=(before_first_fork)
+    @before_first_fork = before_first_fork
+  end
+
+  # The `before_fork` hook will be run in the **parent** process
+  # before every job, so be careful- any changes you make will be
+  # permanent for the lifespan of the worker.
+  #
+  # Call with a block to set the hook.
+  # Call with no arguments to return the hook.
+  def before_fork(&block)
+    block ? (@before_fork = block) : @before_fork
+  end
+
+  # Set the before_fork proc.
+  def before_fork=(before_fork)
+    @before_fork = before_fork
+  end
+
+  # The `after_fork` hook will be run in the child process and is passed
+  # the current job. Any changes you make, therefor, will only live as
+  # long as the job currently being processes.
+  #
+  # Call with a block to set the hook.
+  # Call with no arguments to return the hook.
+  def after_fork(&block)
+    block ? (@after_fork = block) : @after_fork
+  end
+
+  # Set the after_fork proc.
+  def after_fork=(after_fork)
+    @after_fork = after_fork
+  end
+
   def to_s
     "Resque Client connected to #{redis.server}"
   end

data/lib/resque/failure/hoptoad.rb

@@ -15,6 +15,9 @@ module Resque
     #     # optional proxy support
     #     config.proxy_host = 'x.y.z.t'
     #     config.proxy_port = 8080
+    #
+    #     # server env support, defaults to RAILS_ENV or RACK_ENV
+    #     config.server_environment = "test"
     #   end
     class Hoptoad < Base
       # From the hoptoad plugin
@@ -22,6 +25,7 @@ module Resque
 
       class << self
         attr_accessor :secure, :api_key, :proxy_host, :proxy_port
+        attr_accessor :server_environment
       end
 
       def self.count
@@ -96,7 +100,7 @@ module Resque
             end
           end
           x.tag!("server-environment") do
-            x.tag!("environment-name",RAILS_ENV)
+            x.tag!("environment-name",server_environment)
           end
 
         end
@@ -105,7 +109,7 @@ module Resque
       def fill_in_backtrace_lines(x)
         exception.backtrace.each do |unparsed_line|
           _, file, number, method = unparsed_line.match(INPUT_FORMAT).to_a
-          x.line :file=>file,:number=>number
+          x.line :file => file,:number => number
         end
       end
 
@@ -116,6 +120,11 @@ module Resque
       def api_key
         self.class.api_key
       end
+
+      def server_environment
+        return self.class.server_environment if self.class.server_environment
+        defined?(RAILS_ENV) ? RAILS_ENV : (ENV['RACK_ENV'] || 'development')
+      end
     end
   end
 end

data/lib/resque/server.rb

@@ -33,7 +33,7 @@ module Resque
       end
 
       def class_if_current(path = '')
-        'class="current"' if current_page.start_with?(path.to_s)
+        'class="current"' if current_page[0, path.size] == path
       end
 
       def tab(name)

data/lib/resque/version.rb

@@ -1,3 +1,3 @@
 module Resque
-  Version = '1.5.2'
+  Version = '1.6.0'
 end

data/lib/resque/worker.rb

@@ -112,6 +112,7 @@ module Resque
 
         if not @paused and job = reserve
           log "got: #{job.inspect}"
+          run_hook :before_fork
 
           if @child = fork
             rand # Reseeding
@@ -142,6 +143,7 @@ module Resque
       return unless job ||= reserve
 
       begin
+        run_hook :after_fork, job
         working_on job
         job.perform
       rescue Object => e
@@ -202,6 +204,7 @@ module Resque
       enable_gc_optimizations
       register_signal_handlers
       prune_dead_workers
+      run_hook :before_first_fork
       register_worker
     end
 
@@ -306,6 +309,16 @@ module Resque
       started!
     end
 
+    # Runs a named hook, passing along any arguments.
+    def run_hook(name, *args)
+      return unless hook = Resque.send(name)
+      msg = "Running #{name} hook"
+      msg << " with #{args.inspect}" if args.any?
+      log msg
+
+      args.any? ? hook.call(*args) : hook.call
+    end
+
     # Unregisters ourself as a worker. Useful when shutting down.
     def unregister_worker
       redis.srem(:workers, self)

data/test/worker_test.rb

@@ -4,6 +4,10 @@ context "Resque::Worker" do
   setup do
     Resque.redis.flush_all
 
+    Resque.before_first_fork = nil
+    Resque.before_fork = nil
+    Resque.after_fork = nil
+
     @worker = Resque::Worker.new(:jobs)
     Resque::Job.create(:jobs, SomeJob, 20, '/tmp')
   end
@@ -119,7 +123,7 @@ context "Resque::Worker" do
       worker_id = Resque.workers[0].to_s
       Resque.remove_worker(worker_id)
       assert_equal [], Resque.workers
-   end
+    end
   end
 
   test "records what it is working on" do
@@ -240,4 +244,45 @@ context "Resque::Worker" do
     @worker.work(0)
     assert_equal 1, Resque.info[:processed]
   end
+
+  test "Will call a before_first_fork hook only once" do
+    Resque.redis.flush_all
+    $BEFORE_FORK_CALLED = 0
+    Resque.before_first_fork = Proc.new { $BEFORE_FORK_CALLED += 1 }
+    workerA = Resque::Worker.new(:jobs)
+    Resque::Job.create(:jobs, SomeJob, 20, '/tmp')
+
+    assert_equal 0, $BEFORE_FORK_CALLED
+
+    workerA.work(0)
+    assert_equal 1, $BEFORE_FORK_CALLED
+
+    # TODO: Verify it's only run once. Not easy.
+#     workerA.work(0)
+#     assert_equal 1, $BEFORE_FORK_CALLED
+  end
+
+  test "Will call a before_fork hook before forking" do
+    Resque.redis.flush_all
+    $BEFORE_FORK_CALLED = false
+    Resque.before_fork = Proc.new { $BEFORE_FORK_CALLED = true }
+    workerA = Resque::Worker.new(:jobs)
+
+    assert !$BEFORE_FORK_CALLED
+    Resque::Job.create(:jobs, SomeJob, 20, '/tmp')
+    workerA.work(0)
+    assert $BEFORE_FORK_CALLED
+  end
+
+  test "Will call an after_fork hook after forking" do
+    Resque.redis.flush_all
+    $AFTER_FORK_CALLED = false
+    Resque.after_fork = Proc.new { $AFTER_FORK_CALLED = true }
+    workerA = Resque::Worker.new(:jobs)
+
+    assert !$AFTER_FORK_CALLED
+    Resque::Job.create(:jobs, SomeJob, 20, '/tmp')
+    workerA.work(0)
+    assert $AFTER_FORK_CALLED
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: resque
 version: !ruby/object:Gem::Version 
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-03 00:00:00 -08:00
+date: 2010-03-09 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency