Skip to content

Commit 9b5217c

Browse files
danhunsakerdanhunsaker
committed
Namespace change!
Updated Composer config and documentation to reflect the new home alongside the other Resque projects. Also cleaned up some formatting in the Markdown files.
1 parent 0e1f21e commit 9b5217c

File tree

5 files changed

+503
-449
lines changed

5 files changed

+503
-449
lines changed

‎CHANGELOG.md

+108-66
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,124 @@
1-
## 1.3 (2013-??-??) - Current Master ##
1+
## 1.3 (2013-??-??) - Current Master
22

3-
**Note:** This release introduces backwards incompatible changes with all previous versions of php-resque. Please see below for details.
3+
**Note:** This release introduces backwards incompatible changes with all
4+
previous versions of php-resque. Please see below for details.
45

56
### Redisent (Redis Library) Replaced with Credis
67

7-
Redisent has always been the Redis backend for php-resque because of its lightweight nature. Unfortunately, Redisent is largely unmaintained.
8+
Redisent has always been the Redis backend for php-resque because of its
9+
lightweight nature. Unfortunately, Redisent is largely unmaintained.
810

9-
[Credis](https://github.com/colinmollenhour/credis) 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)
11+
[Credis](https://github.com/colinmollenhour/credis) is a fork of Redisent, which
12+
among other improvements will automatically use the
13+
[phpredis](https://github.com/nicolasff/phpredis) native PHP extension if it is
14+
available. (you want this for speed, trust me)
1015

11-
php-resque now utilizes Credis for all Redis based operations. Credis automatically required and installed as a Composer dependency.
16+
php-resque now utilizes Credis for all Redis based operations. Credis
17+
automatically required and installed as a Composer dependency.
1218

1319
### Composer Support
1420

15-
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.
21+
Composer support has been improved and is now the recommended method for
22+
including php-resque in your project. Details on Composer support can be found
23+
in the Getting Started section of the readme.
1624

1725
### Improved DSN Support
1826

19-
Changes by iskandar introduce improved support for using DSNs to connect to Redis. You can now utilize the following formatted strings for the REDIS_BACKEND environment variable to connect:
27+
Changes by iskandar introduce improved support for using DSNs to connect to
28+
Redis. You can now utilize the following formatted strings for the REDIS_BACKEND
29+
environment variable to connect:
2030

21-
* `host`
22-
* `host:port`
23-
* `redis://host:port`
24-
* `redis://host:port/db`
25-
* `redis://user:pass@host:port/` (username is required but will be ignored)
26-
* `tcp://user:pass@host:port/` (username is required but will be ignored)
31+
- `host`
32+
- `host:port`
33+
- `redis://host:port`
34+
- `redis://host:port/db`
35+
- `redis://user:pass@host:port/` (username is required but will be ignored)
36+
- `tcp://user:pass@host:port/` (username is required but will be ignored)
2737

2838
### Other Improvements/Changes
2939

30-
* **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.
31-
* Restructure tests and test bootstrapping. Autoload tests via Composer (install test dependencies with `composer install --dev`)
32-
* Add `SETEX` to list of commands which supply a key as the first argument in Redisent (danhunsaker)
33-
* Fix an issue where a lost connection to Redis could cause an infinite loop (atorres757)
34-
* Add a helper method to `Resque_Redis` to remove the namespace applied to Redis keys (tonypiper)
35-
* Call beforePerform hook before retrieivng an instance of the job class (allows beforePerform to cancel a job with DontPerform before initialising your application)
36-
* Add `beforeEnqueue` hook, called before a job is placed on a queue
37-
38-
## 1.2 (2012-10-13) ##
39-
40-
**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.
41-
42-
* Allow alternate redis database to be selected when calling setBackend by supplying a second argument (patrickbajao)
43-
* Use `require_once` when including php-resque after the app has been included in the sample resque.php to prevent include conflicts (andrewjshults)
44-
* Wrap job arguments in an array to improve compatibility with ruby resque (warezthebeef)
45-
* Fix a bug where the worker would spin out of control taking the server with it, if the redis connection was interrupted even briefly. Use SIGPIPE to trap this scenario cleanly. (d11wtq)
46-
* Added support of Redis prefix (namespaces) (hlegius)
47-
* When reserving jobs, check if the payload received from popping a queue is a valid object (fix bug whereby jobs are reserved based on an erroneous payload) (salimane)
48-
* Re-enable autoload for class_exists in Job.php (humancopy)
49-
* Fix lost jobs when there is more than one worker process started by the same parent process (salimane)
50-
* Move include for resque before APP_INCLUDE is loaded in, so that way resque is available for the app
51-
* Avoid working with dirty worker IDs (salimane)
52-
* Allow UNIX socket to be passed to Resque when connecting to Redis (pedroarnal)
53-
* Fix typographical errors in PHP docblocks (chaitanyakuber)
54-
* Set the queue name on job instances when jobs are executed (chaitanyakuber)
55-
* Fix and add tests for Resque_Event::stopListening (ebernhardson)
56-
* Documentation cleanup (maetl)
57-
* Pass queue name to afterEvent callback
58-
* Only declare RedisException if it doesn't already exist (Matt Heath)
59-
* Add support for Composer
60-
* Fix missing and incorrect paths for Resque and Resque_Job_Status classes in demo (jjfrey)
61-
* Disable autoload for the RedisException class_exists call (scragg0x)
62-
* General tidy up of comments and files/folders
63-
64-
## 1.1 (2011-03-27) ##
65-
66-
* Update Redisent library for Redis 2.2 compatibility. Redis 2.2 is now required. (thedotedge)
67-
* Trim output of `ps` to remove any prepended whitespace (KevBurnsJr)
68-
* Use `getenv` instead of `$_ENV` for better portability across PHP configurations (hobodave)
69-
* Add support for sub-second queue check intervals (KevBurnsJr)
70-
* Ability to specify a cluster/multiple redis servers and consistent hash between them (dceballos)
71-
* Change arguments for jobs to be an array as they're easier to work with in PHP.
72-
* Implement ability to have setUp and tearDown methods for jobs, called before and after every single run.
73-
* Fix `APP_INCLUDE` environment variable not loading correctly.
74-
* Jobs are no longer defined as static methods, and classes are instantiated first. This change is NOT backwards compatible and requires job classes are updated.
75-
* Job arguments are passed to the job class when it is instantiated, and are accessible by $this->args. This change will break existing job classes that rely on arguments that have not been updated.
76-
* Bundle sample script for managing php-resque instances using monit
77-
* Fix undefined variable `$child` when exiting on non-forking operating systems
78-
* Add `PIDFILE` environment variable to write out a PID for single running workers
79-
80-
## 1.0 (2010-04-18) ##
81-
82-
* Initial release
40+
- **COMPATIBILITY BREAKING**: The bundled worker manager `resque.php` has been
41+
moved to `bin/resque`, and is available as `vendor/bin/resque` when
42+
php-resque is installed as a Composer package.
43+
- Restructure tests and test bootstrapping. Autoload tests via Composer
44+
(install test dependencies with `composer install --dev`)
45+
- Add `SETEX` to list of commands which supply a key as the first argument in
46+
Redisent (danhunsaker)
47+
- Fix an issue where a lost connection to Redis could cause an infinite loop
48+
(atorres757)
49+
- Add a helper method to `Resque_Redis` to remove the namespace applied to
50+
Redis keys (tonypiper)
51+
- Call beforePerform hook before retrieivng an instance of the job class
52+
(allows beforePerform to cancel a job with DontPerform before initialising
53+
your application)
54+
- Add `beforeEnqueue` hook, called before a job is placed on a queue
55+
56+
## 1.2 (2012-10-13)
57+
58+
**Note:** This release is largely backwards compatible with php-resque 1.1. The
59+
next release will introduce backwards incompatible changes (moving from
60+
Redisent to Credis), and will drop compatibility with PHP 5.2.
61+
62+
- Allow alternate redis database to be selected when calling setBackend by
63+
supplying a second argument (patrickbajao)
64+
- Use `require_once` when including php-resque after the app has been included
65+
in the sample resque.php to prevent include conflicts (andrewjshults)
66+
- Wrap job arguments in an array to improve compatibility with ruby resque
67+
(warezthebeef)
68+
- Fix a bug where the worker would spin out of control taking the server with
69+
it, if the redis connection was interrupted even briefly. Use SIGPIPE to
70+
trap this scenario cleanly. (d11wtq)
71+
- Added support of Redis prefix (namespaces) (hlegius)
72+
- When reserving jobs, check if the payload received from popping a queue is a
73+
valid object (fix bug whereby jobs are reserved based on an erroneous
74+
payload) (salimane)
75+
- Re-enable autoload for class_exists in Job.php (humancopy)
76+
- Fix lost jobs when there is more than one worker process started by the same
77+
parent process (salimane)
78+
- Move include for resque before APP_INCLUDE is loaded in, so that way resque
79+
is available for the app
80+
- Avoid working with dirty worker IDs (salimane)
81+
- Allow UNIX socket to be passed to Resque when connecting to Redis
82+
(pedroarnal)
83+
- Fix typographical errors in PHP docblocks (chaitanyakuber)
84+
- Set the queue name on job instances when jobs are executed (chaitanyakuber)
85+
- Fix and add tests for Resque_Event::stopListening (ebernhardson)
86+
- Documentation cleanup (maetl)
87+
- Pass queue name to afterEvent callback
88+
- Only declare RedisException if it doesn't already exist (Matt Heath)
89+
- Add support for Composer
90+
- Fix missing and incorrect paths for Resque and Resque_Job_Status classes in
91+
demo (jjfrey)
92+
- Disable autoload for the RedisException class_exists call (scragg0x)
93+
- General tidy up of comments and files/folders
94+
95+
## 1.1 (2011-03-27)
96+
97+
- Update Redisent library for Redis 2.2 compatibility. Redis 2.2 is now
98+
required. (thedotedge)
99+
- Trim output of `ps` to remove any prepended whitespace (KevBurnsJr)
100+
- Use `getenv` instead of `$_ENV` for better portability across PHP
101+
configurations (hobodave)
102+
- Add support for sub-second queue check intervals (KevBurnsJr)
103+
- Ability to specify a cluster/multiple redis servers and consistent hash
104+
between them (dceballos)
105+
- Change arguments for jobs to be an array as they're easier to work with in
106+
PHP.
107+
- Implement ability to have setUp and tearDown methods for jobs, called before
108+
and after every single run.
109+
- Fix `APP_INCLUDE` environment variable not loading correctly.
110+
- Jobs are no longer defined as static methods, and classes are instantiated
111+
first. This change is NOT backwards compatible and requires job classes are
112+
updated.
113+
- Job arguments are passed to the job class when it is instantiated, and are
114+
accessible by $this->args. This change will break existing job classes that
115+
rely on arguments that have not been updated.
116+
- Bundle sample script for managing php-resque instances using monit
117+
- Fix undefined variable `$child` when exiting on non-forking operating
118+
systems
119+
- Add `PIDFILE` environment variable to write out a PID for single running
120+
workers
121+
122+
## 1.0 (2010-04-18)
123+
124+
- Initial release

0 commit comments

Comments
 (0)