Adds documentation and turns on the option for using the disconnect recovery

Author: Conor Pappas

lib/resque_stuck_queue.rb

@@ -61,6 +61,14 @@ def abort_on_exception
         end
       end
 
+      def disconnect_recovery
+        if !config[:disconnect_recovery].nil?
+          config[:disconnect_recovery] # allow overriding w true
+        else
+          false # default
+        end
+      end
+
       def start_in_background
         Thread.new do
           Thread.current.abort_on_exception = abort_on_exception
@@ -326,7 +334,7 @@ def handle_redis_disconnect(error_message)
         message = error_message.respond_to?(:call) ? error_message.call(e) : error_message
         logger.error(message)
         logger.error("\n#{e.backtrace.join("\n")}")
-        raise e unless config[:redis_disconnect_recovery]
+        raise e unless disconnect_recovery
       end
     end
   end

lib/resque_stuck_queue/config.rb

@@ -19,20 +19,21 @@ module StuckQueue
     class Config < Hash
 
       OPTIONS_DESCRIPTIONS = {
-        :triggered_handler  => "set to what gets triggered when resque-stuck-queue will detect the latest heartbeat is older than the trigger_timeout time setting.\n\tExample:\n\tResque::StuckQueue.config[:triggered_handler] = proc { |queue_name, lagtime| send_email('queue \#{queue_name} isnt working, aaah the daemons') }",
-        :recovered_handler  => "set to what gets triggered when resque-stuck-queue has triggered a problem, but then detects the queue went back down to functioning well again(it wont trigger again until it has recovered).\n\tExample:\n\tResque::StuckQueue.config[:recovered_handler] = proc { |queue_name, lagtime| send_email('phew, queue \#{queue_name} is ok') }",
-        :heartbeat_interval => "set to how often to push the 'heartbeat' job which will refresh the latest working time.\n\tExample:\n\tResque::StuckQueue.config[:heartbeat_interval] = 5.minutes",
-        :watcher_interval            => "set to how often to check to see when the last time it worked was.\n\tExample:\n\tResque::StuckQueue.config[:watcher_interval] = 1.minute",
-        :trigger_timeout    => "set to how much of a resque work lag you are willing to accept before being notified. note: take the :watcher_interval setting into account when setting this timeout.\n\tExample:\n\tResque::StuckQueue.config[:trigger_timeout] = 9.minutes",
-        :warn_interval      => "optional: if set, it will continiously trigger/warn in spaces of this interval after first trigger. eg, as long as lagtime keeps on being above trigger_timeout/recover hasn't occured yet.",
-        :redis              => "set the Redis StuckQueue will use. Either a Redis or Redis::Namespace instance.",
-        :heartbeat_key      => "optional, name of keys to keep track of the last good resque heartbeat time",
-        :triggered_key      => "optional, name of keys to keep track of the last trigger time",
-        :logger             => "optional, pass a Logger. Default a ruby logger will be instantiated. Needs to respond to that interface.",
-        :queues             => "optional, monitor specific queues you want to send a heartbeat/monitor to. default is [:app]",
-        :abort_on_exception => "optional, if you want the resque-stuck-queue threads to explicitly raise, default is true",
-        :heartbeat_job      => "optional, your own custom refreshing job. if you are using something other than resque",
-        :enable_signals     => "optional, allow resque::stuck's signal_handlers which do mostly nothing at this point. possible future plan: log info, reopen log file, etc.",
+        :triggered_handler   => "set to what gets triggered when resque-stuck-queue will detect the latest heartbeat is older than the trigger_timeout time setting.\n\tExample:\n\tResque::StuckQueue.config[:triggered_handler] = proc { |queue_name, lagtime| send_email('queue \#{queue_name} isnt working, aaah the daemons') }",
+        :recovered_handler   => "set to what gets triggered when resque-stuck-queue has triggered a problem, but then detects the queue went back down to functioning well again(it wont trigger again until it has recovered).\n\tExample:\n\tResque::StuckQueue.config[:recovered_handler] = proc { |queue_name, lagtime| send_email('phew, queue \#{queue_name} is ok') }",
+        :heartbeat_interval  => "set to how often to push the 'heartbeat' job which will refresh the latest working time.\n\tExample:\n\tResque::StuckQueue.config[:heartbeat_interval] = 5.minutes",
+        :watcher_interval    => "set to how often to check to see when the last time it worked was.\n\tExample:\n\tResque::StuckQueue.config[:watcher_interval] = 1.minute",
+        :trigger_timeout     => "set to how much of a resque work lag you are willing to accept before being notified. note: take the :watcher_interval setting into account when setting this timeout.\n\tExample:\n\tResque::StuckQueue.config[:trigger_timeout] = 9.minutes",
+        :warn_interval       => "optional: if set, it will continiously trigger/warn in spaces of this interval after first trigger. eg, as long as lagtime keeps on being above trigger_timeout/recover hasn't occured yet.",
+        :redis               => "set the Redis StuckQueue will use. Either a Redis or Redis::Namespace instance.",
+        :heartbeat_key       => "optional, name of keys to keep track of the last good resque heartbeat time",
+        :triggered_key       => "optional, name of keys to keep track of the last trigger time",
+        :logger              => "optional, pass a Logger. Default a ruby logger will be instantiated. Needs to respond to that interface.",
+        :queues              => "optional, monitor specific queues you want to send a heartbeat/monitor to. default is [:app]",
+        :abort_on_exception  => "optional, if you want the resque-stuck-queue threads to explicitly raise, default is true",
+        :heartbeat_job       => "optional, your own custom refreshing job. if you are using something other than resque",
+        :enable_signals      => "optional, allow resque::stuck's signal_handlers which do mostly nothing at this point. possible future plan: log info, reopen log file, etc.",
+        :disconnect_recovery => "optional, continues running resque-stuck-queue even if there is an issue connecting to redis. Will continue looping and making attempts until connection is re-established. Default is false",
       }
 
       OPTIONS = OPTIONS_DESCRIPTIONS.keys