Merge branch 'master' of git://github.com/chrisboulton/php-resque into blocking-list-pop

Conflicts:
	lib/Resque.php
	lib/Resque/RedisCluster.php
	lib/Resque/Worker.php

Author: ruudk

.gitignore

@@ -0,0 +1 @@
+vendor/

.travis.yml

@@ -1,5 +1,12 @@
 language: php
 php:
-  - 5.2
   - 5.3
   - 5.4
+env:
+  - REDIS_STANDALONE=0
+  - REDIS_STANDALONE=1
+before_script:
+  - sh -c "if [ $REDIS_STANDALONE -eq 0 ]; then wget https://github.com/nicolasff/phpredis/archive/2.2.2.zip -O php-redis.zip && unzip php-redis.zip; fi"
+  - sh -c "if [ $REDIS_STANDALONE -eq 0 ]; then cd phpredis-2.2.2/ && phpize && ./configure && make && make install; fi"
+  - sh -c "if [ $REDIS_STANDALONE -eq 0 ]; then echo \"extension=redis.so\" >> `php --ini | grep \"Loaded Configuration\" | sed -e \"s|.*:\s*||\"`; fi"
+  - composer install

CHANGELOG.md

@@ -1,4 +1,35 @@
-## 1.2 (Unreleased) ##
+## 1.3 (2013-??-??) - Current Master ##
+
+**Note:** This release introduces backwards incompatible changes with all previous versions of php-resque. Please see below for details.
+
+### Redisent (Redis Library) Replaced with Credis
+
+Redisent has always been the Redis backend for php-resque because of its lightweight nature. Unfortunately, Redisent is largely unmaintained.
+
+[Credis](http://example.com/) is a fork of Redisent, which among other improvements will automatically use the [phpredis](https://github.com/nicolasff/phpredis) native PHP extension if it is available. (you want this for speed, trust me)
+
+php-resque now utilizes Credis for all Redis based operations. Credis automatically required and installed as a Composer dependency.
+
+### Composer Support
+
+Composer support has been improved and is now the recommended method for including php-resque in your project. Details on Composer support can be found in the Getting Started section of the readme.
+
+### Other Improvements/Changes
+
+* **COMPATIBILITY BREAKING**: The bundled worker manager `resque.php` has been moved to `bin/resque`, and is available as `vendor/bin/resque` when php-resque is installed as a Composer package.
+
+* Restructure tests and test bootstrapping. Autoload tests via Composer (install test dependencies with `composer install --dev`)
+
+* Add `SETEX` to list of commands which supply a key as the first argument in Redisent (danhunsaker)
+
+* Fix an issue where a lost connection to Redis could cause an infinite loop (atorres757)
+
+* Add a helper method to `Resque_Redis` to remove the namespace applied to Redis keys (tonypiper)
+
+
+## 1.2 (2012-10-13) ##
+
+**Note:** This release is largely backwards compatible with php-resque 1.1. The next release will introduce backwards incompatible changes (moving from Redisent to Credis), and will drop compatibility with PHP 5.2.
 
 * Allow alternate redis database to be selected when calling setBackend by supplying a second argument (patrickbajao)
 * Use `require_once` when including php-resque after the app has been included in the sample resque.php to prevent include conflicts (andrewjshults)
@@ -10,7 +41,17 @@
 * Fix lost jobs when there is more than one worker process started by the same parent process (salimane)
 * Move include for resque before APP_INCLUDE is loaded in, so that way resque is available for the app
 * Avoid working with dirty worker IDs (salimane)
-
+* Allow UNIX socket to be passed to Resque when connecting to Redis (pedroarnal)
+* Fix typographical errors in PHP docblocks (chaitanyakuber)
+* Set the queue name on job instances when jobs are executed (chaitanyakuber)
+* Fix and add tests for Resque_Event::stopListening (ebernhardson)
+* Documentation cleanup (maetl)
+* Pass queue name to afterEvent callback
+* Only declare RedisException if it doesn't already exist (Matt Heath)
+* Add support for Composer
+* Fix missing and incorrect paths for Resque and Resque_Job_Status classes in demo (jjfrey)
+* Disable autoload for the RedisException class_exists call (scragg0x)
+* General tidy up of comments and files/folders
 
 ## 1.1 (2011-03-27) ##
 

LICENSE

@@ -1,4 +1,4 @@
-(c) 2010 Chris Boulton <chris.boulton@interspire.com>
+(c) Chris Boulton <chris@bigcommerce.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -37,17 +37,41 @@ pre and post jobs
 
 ## Requirements ##
 
-* PHP 5.2+
+* PHP 5.3+
 * Redis 2.2+
+* Optional but Recommended: Composer
+
+## Getting Started ##
+
+The easiest way to work with php-resque is when it's installed as a
+Composer package inside your project. Composer isn't strictly
+required, but makes life a lot easier.
+
+If you're not familiar with Composer, please see <http://getcomposer.org/>.
+
+1. Add php-resque to your application's composer.json.
+
+        {
+            ...
+            "require": {
+                "chrisboulton/php-resque": "1.2.x"
+            },
+            ...
+        }
+
+2. Run `composer install`.
+
+3. If you haven't already, add the Composer autoload to your project's
+   initialization file. (example)
+
+        require 'vendor/autoload.php';
 
 ## Jobs ##
 
 ### Queueing Jobs ###
 
 Jobs are queued as follows:
 
-    require_once 'lib/Resque.php';
-
 	// Required if redis is located elsewhere
 	Resque::setBackend('localhost:6379');
 
@@ -87,12 +111,12 @@ The `tearDown` method if defined, will be called after the job finishes.
 		{
 			// ... Set up environment for this job
 		}
-		
+
 		public function perform()
 		{
 			// .. Run job
 		}
-		
+
 		public function tearDown()
 		{
 			// ... Remove environment for this job
@@ -136,8 +160,9 @@ class.
 Workers work in the exact same way as the Ruby workers. For complete
 documentation on workers, see the original documentation.
 
-A basic "up-and-running" resque.php file is included that sets up a
-running worker environment is included in the root directory.
+A basic "up-and-running" `bin/resque` file is included that sets up a
+running worker environment is included. (`vendor/bin/resque` when installed
+via Composer)
 
 The exception to the similarities with the Ruby version of resque is
 how a worker is initially setup. To work under all environments,
@@ -146,13 +171,17 @@ not having a single environment such as with Ruby, the PHP port makes
 
 To start a worker, it's very similar to the Ruby version:
 
-    $ QUEUE=file_serve php resque.php
+    $ QUEUE=file_serve php bin/resque
 
 It's your responsibility to tell the worker which file to include to get
 your application underway. You do so by setting the `APP_INCLUDE` environment
 variable:
 
-   $ QUEUE=file_serve APP_INCLUDE=../application/init.php php resque.php
+    $ QUEUE=file_serve APP_INCLUDE=../application/init.php php bin/resque
+
+*Pro tip: Using Composer? More than likely, you don't need to worry about
+`APP_INCLUDE`, because hopefully Composer is responsible for autoloading
+your application too!*
 
 Getting your application underway also includes telling the worker your job
 classes, by means of either an autoloader or including them.
@@ -163,8 +192,8 @@ The port supports the same environment variables for logging to STDOUT.
 Setting `VERBOSE` will print basic debugging information and `VVERBOSE`
 will print detailed information.
 
-    $ VERBOSE QUEUE=file_serve php resque.php
-    $ VVERBOSE QUEUE=file_serve php resque.php
+    $ VERBOSE QUEUE=file_serve bin/resque
+    $ VVERBOSE QUEUE=file_serve bin/resque
 
 ### Priorities and Queue Lists ###
 
@@ -175,7 +204,7 @@ checked in.
 
 As per the original example:
 
-	$ QUEUE=file_serve,warm_cache php resque.php
+	$ QUEUE=file_serve,warm_cache bin/resque
 
 The `file_serve` queue will always be checked for new jobs on each
 iteration before the `warm_cache` queue is checked.
@@ -185,14 +214,14 @@ iteration before the `warm_cache` queue is checked.
 All queues are supported in the same manner and processed in alphabetical
 order:
 
-    $ QUEUE=* php resque.php
+    $ QUEUE=* bin/resque
 
 ### Running Multiple Workers ###
 
 Multiple workers ca be launched and automatically worked by supplying
 the `COUNT` environment variable:
 
-	$ COUNT=5 php resque.php
+	$ COUNT=5 bin/resque
 
 ### Forking ###
 
@@ -257,7 +286,7 @@ It is up to your application to register event listeners. When enqueuing events
 in your application, it should be as easy as making sure php-resque is loaded
 and calling `Resque_Event::listen`.
 
-When running workers, if you run workers via the default `resque.php` script,
+When running workers, if you run workers via the default `bin/resque` script,
 your `APP_INCLUDE` script should initialize and register any listeners required
 for operation. If you have rolled your own worker manager, then it is again your
 responsibility to register listeners.
@@ -329,3 +358,16 @@ Called after a job has been queued using the `Resque::enqueue` method. Arguments
 * KevBurnsJr
 * jmathai
 * dceballos
+* patrickbajao
+* andrewjshults
+* warezthebeef
+* d11wtq
+* hlegius
+* salimane
+* humancopy
+* pedroarnal
+* chaitanyakuber
+* maetl
+* Matt Heath
+* jjfrey
+* scragg0x

TODO.md

@@ -1 +1,106 @@
-#!/bin/sh
+#!/usr/bin/env php
+<?php
+
+// Find and initialize Composer
+$files = array(
+  __DIR__ . '/../../vendor/autoload.php',
+  __DIR__ . '/../../../autoload.php',
+  __DIR__ . '/../../../../autoload.php',
+  __DIR__ . '/../vendor/autoload.php',
+);
+
+$found = false;
+foreach ($files as $file) {
+	if (file_exists($file)) {
+		require_once $file;
+		break;
+	}
+}
+
+if (!class_exists('Composer\Autoload\ClassLoader', false)) {
+	die(
+		'You need to set up the project dependencies using the following commands:' . PHP_EOL .
+		'curl -s http://getcomposer.org/installer | php' . PHP_EOL .
+		'php composer.phar install' . PHP_EOL
+	);
+}
+
+$QUEUE = getenv('QUEUE');
+if(empty($QUEUE)) {
+	die("Set QUEUE env var containing the list of queues to work.\n");
+}
+
+$REDIS_BACKEND = getenv('REDIS_BACKEND');
+$REDIS_BACKEND_DB = getenv('REDIS_BACKEND_DB');
+if(!empty($REDIS_BACKEND)) {
+	if (empty($REDIS_BACKEND_DB)) 
+		Resque::setBackend($REDIS_BACKEND);
+	else
+		Resque::setBackend($REDIS_BACKEND, $REDIS_BACKEND_DB);
+}
+
+$logLevel = 0;
+$LOGGING = getenv('LOGGING');
+$VERBOSE = getenv('VERBOSE');
+$VVERBOSE = getenv('VVERBOSE');
+if(!empty($LOGGING) || !empty($VERBOSE)) {
+	$logLevel = Resque_Worker::LOG_NORMAL;
+}
+else if(!empty($VVERBOSE)) {
+	$logLevel = Resque_Worker::LOG_VERBOSE;
+}
+
+$APP_INCLUDE = getenv('APP_INCLUDE');
+if($APP_INCLUDE) {
+	if(!file_exists($APP_INCLUDE)) {
+		die('APP_INCLUDE ('.$APP_INCLUDE.") does not exist.\n");
+	}
+
+	require_once $APP_INCLUDE;
+}
+
+$interval = 5;
+$INTERVAL = getenv('INTERVAL');
+if(!empty($INTERVAL)) {
+	$interval = $INTERVAL;
+}
+
+$count = 1;
+$COUNT = getenv('COUNT');
+if(!empty($COUNT) && $COUNT > 1) {
+	$count = $COUNT;
+}
+
+if($count > 1) {
+	for($i = 0; $i < $count; ++$i) {
+		$pid = Resque::fork();
+		if($pid == -1) {
+			die("Could not fork worker ".$i."\n");
+		}
+		// Child, start the worker
+		else if(!$pid) {
+			$queues = explode(',', $QUEUE);
+			$worker = new Resque_Worker($queues);
+			$worker->logLevel = $logLevel;
+			fwrite(STDOUT, '*** Starting worker '.$worker."\n");
+			$worker->work($interval);
+			break;
+		}
+	}
+}
+// Start a single worker
+else {
+	$queues = explode(',', $QUEUE);
+	$worker = new Resque_Worker($queues);
+	$worker->logLevel = $logLevel;
+
+	$PIDFILE = getenv('PIDFILE');
+	if ($PIDFILE) {
+		file_put_contents($PIDFILE, getmypid()) or
+			die('Could not write PID information to ' . $PIDFILE);
+	}
+
+	fwrite(STDOUT, '*** Starting worker '.$worker."\n");
+	$worker->work($interval);
+}
+?>

bin/resque

@@ -11,9 +11,26 @@
 			"email": "[email protected]"
 		}
 	],
+	"repositories": [
+		{
+			"type": "vcs",
+			"url": "https://github.com/chrisboulton/credis"
+		}
+	],
 	"require": {
-		"php": ">=5.3.0"
+		"php": ">=5.3.0",
+		"colinmollenhour/credis": "dev-master"
 	},
+	"suggest": {
+		"ext-proctitle": "Allows php-resque to rename the title of UNIX processes to show the status of a worker.",
+		"ext-redis": "Native PHP extension for Redis connectivity. Credis will automatically utilize when available."
+	},
+	"require-dev": {
+		"phpunit/phpunit": "3.7.*"
+	},
+	"bin": [
+		"bin/resque"
+	],
 	"autoload": {
 		"psr-0": {
 			"Resque": "lib"