First round of updates finished.

- Needs better test cases.

.travis.yml

@@ -1,5 +1,7 @@
 language: php
 
+sudo: false
+
 php:
   - 5.3.3
   - 5.3
@@ -8,9 +10,8 @@ php:
   - 5.6
 
 before_script:
-  - composer self-update
+  - composer self-update 1.0.0-alpha10
-  - composer update --prefer-source
+  - composer install --no-interaction --prefer-source
-  - composer install --no-interaction --dev --prefer-source
 
 script:
   - ./vendor/bin/phpunit

LICENSE

@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    {project}  Copyright (C) {year}  {fullname}
+    dcarbone/ugly-queue  Copyright (C) 2015  Daniel Paul Carbone
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

README.md

@@ -1,8 +1,93 @@
 ugly-queue
 ==========
 
-A simple file-based queue system for PHP 5.3.3+
+A simple file-based FIFO queue system for PHP 5.3.3+
 
-Build status: [![Build Status](https://travis-ci.org/dcarbone/ugly-queue.svg)](https://travis-ci.org/dcarbone/ugly-queue)
+Build statuses:
+- master: [![Build Status](https://travis-ci.org/dcarbone/ugly-queue.svg?branch=master)](https://travis-ci.org/dcarbone/ugly-queue)
+- 0.3.1: [![Build Status](https://travis-ci.org/dcarbone/ugly-queue.svg?branch=0.3.1)](https://travis-ci.org/dcarbone/ugly-queue)
 
-Documentation and Test suites forthcoming.
+## Installation
+This library is designed to be installed into your app using [https://getcomposer.org/](Composer).
+Simply copy-paste the following line into your `"requires:"` hash:
+
+```json
+"dcarbone/ugly-queue": "0.3.*"
+```
+
+## Basic Usage
+Once installed, you must first initialize an instance of [src/UglyQueueManager.php](UglyQueueManager).
+This is done as such:
+
+```php
+$queueBaseDir = 'path to where you would like queue files and directories to be stored';
+
+$manager = new UglyQueueManager($queueBaseDir);
+```
+
+Once initialized, you can start adding queues!
+
+```php
+$sandwichQueue = $manager->createQueue('sandwiches');
+
+$sandwichQueue->lock();
+
+$sandwichQueue->addItems(array(
+    'bread',
+    'meat',
+    'cheese',
+    'lettuce',
+    'bread'
+));
+
+$sandwichQueue->unlock();
+```
+
+Once you have items added to the queue, you can either pull items out ad-hoc or set up some sort of cron
+or schedule task to process items regularly.
+
+If the base directory for all of your queues remains the same, each initialization
+of `UglyQueueManager` will automatically find and initialize instances of pre-existing
+UglyQueues.
+
+In a subsequent request, simply do the following:
+
+```php
+$queueBaseDir = 'path to where you would like queue files and directories to be stored';
+
+$manager = new UglyQueueManager($queueBaseDir);
+
+// 'tasty-sandwich' queue will exist now
+
+$tastySandwich = $manager->getQueue('sandwiches');
+
+$tastySandwich->lock();
+
+// Specify the number of items you wish to retrieve from the queue
+
+$items = $tastySandwich->retrieveItems(4);
+
+// $items is now an array...
+
+var_export($items);
+
+/*
+array (
+  4 => 'bread',
+  3 => 'lettuce',
+  2 => 'cheese',
+  1 => 'meat',
+)
+*/
+
+```
+
+The queue will then retain a single item, `0 => 'bread'` as the 5th item left in the queue.
+
+At any time you can determine how many items remain in a queue by executing `count($queueObj);`
+
+There are a few limitations currently:
+
+1. This lib is designed for small values without much in the way of formatting or line breaks
+2. It is designed to be atomic, meaning that only one process can be adding / retrieving items from
+a queue at a time.  Reading actions (count, searching, etc) are NOT atomic, however.

composer.json

@@ -21,11 +21,11 @@
 
     "require" : {
         "php" : ">=5.3.3",
-        "dcarbone/helpers" : "6.1.*"
+        "dcarbone/helpers" : "~6.1"
     },
 
     "require-dev" : {
-        "phpunit/phpunit": "4.1.*"
+        "phpunit/phpunit": "~4.1"
     },
 
     "autoload" : {

src/UglyQueue.php

@@ -5,137 +5,70 @@ use DCarbone\Helpers\FileHelper;
 /**
  * Class UglyQueue
  * @package DCarbone
- *
- * @property string name
- * @property string path
- * @property bool locked
  */
-class UglyQueue implements \Serializable, \SplSubject
+class UglyQueue implements \Serializable, \SplSubject, \Countable
 {
-    const NOTIFY_QUEUE_INITIALIZED              = 0;
-    const NOTIFY_QUEUE_LOCKED                   = 1;
-    const NOTIFY_QUEUE_FAILED_TO_LOCK           = 2;
-    const NOTIFY_QUEUE_LOCKED_BY_OTHER_PROCESS  = 3;
-    const NOTIFY_QUEUE_UNLOCKED                 = 4;
-    const NOTIFY_QUEUE_PROCESSING               = 5;
-    const NOTIFY_QUEUE_REACHED_END              = 6;
-
-    /** @var int */
-    public $notifyStatus;
-
     const QUEUE_READONLY = 0;
     const QUEUE_READWRITE = 1;
 
-    /** @var array */
+    /** @var int */
-    private $observers = array();
+    private $_notifyStatus;
+
+    /** @var \SplObserver[] */
+    private $_observers = array();
 
     /** @var int */
     protected $mode = null;
 
     /** @var string */
-    protected $_name;
+    protected $baseDir;
 
     /** @var string */
-    protected $_path;
+    protected $name;
+
+    /** @var string */
+    protected $path;
 
     /** @var bool */
-    protected $_locked = false;
+    protected $locked = false;
 
     /** @var resource */
-    protected $_tmpHandle;
+    protected $tmpHandle;
+
+    /** @var string */
+    protected $queueFile;
+
+    /** @var string */
+    protected $queueTmpFile;
+
+    /** @var string */
+    protected $lockFile;
+
+    /** @var string */
+    protected $serializeFile;
 
     /**
-     * @param string $directoryPath
+     * @param string $baseDir
-     * @param array $observers
+     * @param string $name
-     * @throws \RuntimeException
+     * @param \SplObserver[] $observers
-     * @throws \InvalidArgumentException
-     * @return UglyQueue
      */
-    public static function queueWithDirectoryPathAndObservers($directoryPath, array $observers = array())
+    public function __construct($baseDir, $name, array $observers = array())
     {
-        if (!is_string($directoryPath))
+        $this->baseDir = realpath($baseDir);
-            throw new \InvalidArgumentException('Argument 1 expected to be string, '.gettype($directoryPath).' seen');
+        $this->name = $name;
+        $this->_observers = $observers;
 
-        if (($directoryPath = trim($directoryPath)) === '')
+        $path = sprintf('%s%s%s', $baseDir, DIRECTORY_SEPARATOR, $name);
-            throw new \InvalidArgumentException('Empty string passed for argument 1');
+        if (!file_exists($path) && !@mkdir($path))
+            throw new \RuntimeException('Unable to initialize queue directory "'.$path.'".  Please check permissions.');
 
-        if (file_exists($directoryPath))
+        $this->path = $path;
-        {
+        $this->lockFile = sprintf('%s%squeue.lock', $path, DIRECTORY_SEPARATOR);
-            if (!is_dir($directoryPath))
+        $this->queueFile = sprintf('%s%squeue.txt', $path, DIRECTORY_SEPARATOR);
-                throw new \RuntimeException('Argument 1 expected to be path to directory, path to non-directory seen');
+        $this->queueTmpFile = sprintf('%s%squeue.tmp', $path, DIRECTORY_SEPARATOR);
-        }
+        $this->serializeFile = sprintf('%s%sugly-queue.obj', $path, DIRECTORY_SEPARATOR);
-        else if (!@mkdir($directoryPath))
-        {
-            throw new \RuntimeException('Unable to create queue directory at path: "'.$directoryPath.'".');
-        }
 
-        $uglyQueue = new UglyQueue();
+        $this->initialize();
-        $uglyQueue->observers = $observers;
-
-        $split = preg_split('#[/\\\]+#', $directoryPath);
-
-        $uglyQueue->_name = end($split);
-        $uglyQueue->_path = rtrim(realpath(implode(DIRECTORY_SEPARATOR, $split)), "/\\").DIRECTORY_SEPARATOR;
-
-        if (is_writable($uglyQueue->_path))
-            $uglyQueue->mode = self::QUEUE_READWRITE;
-        else if (is_readable($uglyQueue->_path))
-            $uglyQueue->mode = self::QUEUE_READONLY;
-
-        // Insert "don't look here" index.html file
-        if (!file_exists($uglyQueue->_path.'index.html'))
-        {
-            if ($uglyQueue->mode === self::QUEUE_READONLY)
-                throw new \RuntimeException('Cannot initialize queue with name "'.$uglyQueue->_name.'", the user lacks permission to create files.');
-
-            $html = <<<HTML
-<html>
-<head>
-	<title>403 Forbidden</title>
-</head>
-<body>
-<p>Directory access is forbidden.</p>
-</body>
-</html>
-HTML;
-            file_put_contents($uglyQueue->_path.'index.html', $html);
-        }
-
-        if (!file_exists($uglyQueue->_path.'queue.txt'))
-        {
-            if ($uglyQueue->mode === self::QUEUE_READONLY)
-                throw new \RuntimeException('Cannot initialize queue with name "'.$uglyQueue->_name.'", the user lacks permission to create files.');
-
-            file_put_contents($uglyQueue->_path.'queue.txt', '');
-        }
-
-        $uglyQueue->notifyStatus = self::NOTIFY_QUEUE_INITIALIZED;
-        $uglyQueue->notify();
-
-        return $uglyQueue;
-    }
-
-    /**
-     * @param string $param
-     * @return string
-     * @throws \OutOfBoundsException
-     */
-    public function __get($param)
-    {
-        switch($param)
-        {
-            case 'name' :
-                return $this->_name;
-
-            case 'path':
-                return $this->_path;
-
-            case 'locked':
-                return $this->_locked;
-
-            default:
-                throw new \OutOfBoundsException(get_class($this).' does not have a property named "'.$param.'".');
-        }
     }
 
     /**
@@ -145,7 +78,79 @@ HTML;
     {
         $this->_populateQueue();
         $this->unlock();
-        file_put_contents($this->_path.UglyQueueManager::UGLY_QUEUE_SERIALIZED_NAME, serialize($this));
+        file_put_contents($this->path.'/ugly-queue.obj', serialize($this));
+    }
+
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * @return int
+     */
+    public function getMode()
+    {
+        return $this->mode;
+    }
+
+    /**
+     * @return string
+     */
+    public function getPath()
+    {
+        return $this->path;
+    }
+
+    /**
+     * @return string
+     */
+    public function getBaseDir()
+    {
+        return $this->baseDir;
+    }
+
+    /**
+     * @return string
+     */
+    public function getQueueFile()
+    {
+        return $this->queueFile;
+    }
+
+    /**
+     * @return string
+     */
+    public function getQueueTmpFile()
+    {
+        return $this->queueTmpFile;
+    }
+
+    /**
+     * @return string
+     */
+    public function getLockFile()
+    {
+        return $this->lockFile;
+    }
+
+    /**
+     * @return string
+     */
+    public function getSerializeFile()
+    {
+        return $this->serializeFile;
+    }
+
+    /**
+     * @return boolean
+     */
+    public function isLocked()
+    {
+        return $this->locked;
     }
 
     /**
@@ -158,59 +163,32 @@ HTML;
         if (!is_int($ttl))
             throw new \InvalidArgumentException('Argument 1 expected to be integer, "'.gettype($ttl).'" seen');
 
-        if ($ttl < 0)
+        if ($ttl < 1)
-            throw new \InvalidArgumentException('Argument 1 expected to be positive integer, "'.$ttl.'" seen');
+            throw new \InvalidArgumentException('Argument 1 expected to be greater than 0 "'.$ttl.'" seen');
-
-        $alreadyLocked = $this->isLocked();
 
         // If there is currently no lock
-        if ($alreadyLocked === false)
+        if ($this->isAlreadyLocked() === false)
             return $this->createLockFile($ttl);
 
         // If we make it this far, there is already a lock in place.
-        $this->_locked = false;
+        $this->locked = false;
-        $this->notifyStatus = self::NOTIFY_QUEUE_LOCKED_BY_OTHER_PROCESS;
+        $this->_notifyStatus = UglyQueueEnum::QUEUE_LOCKED_BY_OTHER_PROCESS;
         $this->notify();
 
         return false;
     }
 
-    /**
-     * @param int $ttl seconds to live
-     * @return bool
-     */
-    protected function createLockFile($ttl)
-    {
-        $ok = (bool)@file_put_contents(
-            $this->_path.'queue.lock',
-            json_encode(array('ttl' => $ttl, 'born' => time())));
-
-        if ($ok !== true)
-        {
-            $this->notifyStatus = self::NOTIFY_QUEUE_FAILED_TO_LOCK;
-            $this->notify();
-            return $this->_locked = false;
-        }
-
-        $this->_locked = true;
-
-        $this->notifyStatus = self::NOTIFY_QUEUE_LOCKED;
-        $this->notify();
-
-        return true;
-    }
-
     /**
      * Close this ugly queue, writing out contents to file.
      */
     public function unlock()
     {
-        if ($this->_locked === true)
+        if ($this->isLocked() === true)
         {
-            unlink($this->_path.'queue.lock');
+            unlink($this->lockFile);
-            $this->_locked = false;
+            $this->locked = false;
 
-            $this->notifyStatus = self::NOTIFY_QUEUE_UNLOCKED;
+            $this->_notifyStatus = UglyQueueEnum::QUEUE_UNLOCKED;
             $this->notify();
         }
     }
@@ -219,27 +197,26 @@ HTML;
      * @throws \RuntimeException
      * @return bool
      */
-    public function isLocked()
+    public function isAlreadyLocked()
     {
         // First check for lock file
-        if (is_file($this->_path.'queue.lock'))
+        if (is_file($this->lockFile))
         {
-            $lock = json_decode(file_get_contents($this->_path.'queue.lock'), true);
+            $lock = json_decode(file_get_contents($this->lockFile), true);
 
-            // If we have an invalid lock structure.
+            // If the decoded lock file contains a ttl and born value...
-            if (!isset($lock['ttl']) || !isset($lock['born']))
+            if (isset($lock['ttl']) && isset($lock['born']))
-                throw new \RuntimeException('Invalid "queue.lock" file structure seen at "'.$this->_path.'queue.lock".');
+            {
+                $lock_ttl = ((int)$lock['born'] + (int)$lock['ttl']);
 
-            // Otherwise...
+                // If we're within the TTL of the lock, assume another thread is already processing.
-            $lock_ttl = ((int)$lock['born'] + (int)$lock['ttl']);
+                // We'll pick it up on the next go around.
-
+                if ($lock_ttl > time())
-            // If we're within the TTL of the lock, assume another thread is already processing.
+                    return true;
-            // We'll pick it up on the next go around.
+            }
-            if ($lock_ttl > time())
-                return true;
 
             // Else, remove lock file and assume we're good to go!
-            unlink($this->_path.'queue.lock');
+            unlink($this->lockFile);
             return false;
         }
 
@@ -253,14 +230,14 @@ HTML;
      * @throws \InvalidArgumentException
      * @return bool|array
      */
-    public function processQueue($count = 1)
+    public function retrieveItems($count = 1)
     {
         if ($this->mode === self::QUEUE_READONLY)
-            throw new \RuntimeException('Queue "'.$this->_name.'" cannot be processed. It was started in Read-Only mode (the user running this process does not have permission to write to the queue directory).');
+            throw new \RuntimeException('Queue "'.$this->name.'" cannot be processed. It was started in Read-Only mode (the user running this process does not have permission to write to the queue directory).');
 
         // If we don't have a lock, assume issue and move on.
-        if ($this->_locked === false)
+        if ($this->isLocked() === false)
-            throw new \RuntimeException('Cannot process queue named "'.$this->_name.'".  It is locked by another process.');
+            throw new \RuntimeException('Cannot process queue named "'.$this->name.'".  It is locked by another process.');
 
         // If non-int valid is passed
         if (!is_int($count))
@@ -270,21 +247,21 @@ HTML;
         if ($count <= 0)
             throw new \InvalidArgumentException('Argument 1 expected to be integer greater than 0, "'.$count.'" seen');
 
-        if ($this->notifyStatus !== self::NOTIFY_QUEUE_PROCESSING)
+        if ($this->_notifyStatus !== UglyQueueEnum::QUEUE_PROCESSING)
         {
-            $this->notifyStatus = self::NOTIFY_QUEUE_PROCESSING;
+            $this->_notifyStatus = UglyQueueEnum::QUEUE_PROCESSING;
             $this->notify();
         }
 
         // Find number of lines in the queue file
-        $lineCount  = FileHelper::getLineCount($this->_path.'queue.txt');
+        $lineCount  = count($this);
 
         // If queue line count is 0, assume empty
         if ($lineCount === 0)
             return false;
 
         // Try to open the file for reading / writing.
-        $queueFileHandle = fopen($this->_path.'queue.txt', 'r+');
+        $queueFileHandle = fopen($this->queueFile, 'r+');
         if ($queueFileHandle === false)
             $this->unlock();
 
@@ -297,7 +274,7 @@ HTML;
             if ($i++ >= $start_line)
             {
                 list ($key, $value) = $line;
-                $data[$key] = $value;
+                $data = array($key => $value) + $data;
             }
         }
 
@@ -308,13 +285,13 @@ HTML;
             ftruncate($queueFileHandle, 0);
             fclose($queueFileHandle);
 
-            $this->notifyStatus = self::NOTIFY_QUEUE_REACHED_END;
+            $this->_notifyStatus = UglyQueueEnum::QUEUE_REACHED_END;
             $this->notify();
         }
         // Otherwise, create new queue file minus the processed lines.
         else
         {
-            $tmp = fopen($this->_path.'queue.tmp', 'w+');
+            $tmp = fopen($this->queueTmpFile, 'w+');
             rewind($queueFileHandle);
             $i = 0;
             while (($line = fgets($queueFileHandle)) !== false && $i < $start_line)
@@ -327,8 +304,8 @@ HTML;
 
             fclose($queueFileHandle);
             fclose($tmp);
-            unlink($this->_path.'queue.txt');
+            unlink($this->queueFile);
-            rename($this->_path.'queue.tmp', $this->_path.'queue.txt');
+            rename($this->queueTmpFile, $this->queueFile);
         }
 
         return $data;
@@ -340,19 +317,19 @@ HTML;
      * @return bool
      * @throws \RuntimeException
      */
-    public function addToQueue($key, $value)
+    public function addItem($key, $value)
     {
         if ($this->mode === self::QUEUE_READONLY)
-            throw new \RuntimeException('Cannot add items to queue "'.$this->_name.'" as it is in read-only mode');
+            throw new \RuntimeException('Cannot add item to queue "'.$this->name.'" as it is in read-only mode');
 
         // If we don't have a lock, assume issue and move on.
-        if ($this->_locked === false)
+        if ($this->isLocked() === false)
-            throw new \RuntimeException('Cannot add items to queue "'.$this->_name.'". Queue is already locked by another process');
+            throw new \RuntimeException('Cannot add item to queue "'.$this->name.'". Queue is already locked by another process');
 
-        if (!is_resource($this->_tmpHandle))
+        if (!is_resource($this->tmpHandle))
         {
-            $this->_tmpHandle = fopen($this->_path.'queue.tmp', 'w+');
+            $this->tmpHandle = fopen($this->queueTmpFile, 'w+');
-            if ($this->_tmpHandle === false)
+            if ($this->tmpHandle === false)
                 throw new \RuntimeException('Unable to create "queue.tmp" file.');
         }
 
@@ -360,11 +337,22 @@ HTML;
             $value = json_encode($value);
 
         return (bool)fwrite(
-            $this->_tmpHandle,
+            $this->tmpHandle,
             $key."\t".str_replace(array("\r\n", "\n"), ' ', $value)
             ."\n");
     }
 
+    /**
+     * @param array $items
+     */
+    public function addItems(array $items)
+    {
+        foreach($items as $k=>$v)
+        {
+            $this->addItem($k, $v);
+        }
+    }
+
     /**
      * If there is a tmp queue file, add it's contents to the beginning of a new queue file
      *
@@ -372,35 +360,26 @@ HTML;
      */
     public function _populateQueue()
     {
-        if (is_resource($this->_tmpHandle))
+        if (is_resource($this->tmpHandle))
         {
-            if (file_exists($this->_path.'queue.txt'))
+            if (file_exists($this->queueFile))
             {
-                $queueFileHandle = fopen($this->_path.'queue.txt', 'r+');
+                $queueFileHandle = fopen($this->queueFile, 'r+');
                 while (($line = fgets($queueFileHandle)) !== false)
                 {
                     if ($line !== "\n" && $line !== "")
-                        fwrite($this->_tmpHandle, $line);
+                        fwrite($this->tmpHandle, $line);
                 }
 
                 fclose($queueFileHandle);
-                unlink($this->_path.'queue.txt');
+                unlink($this->queueFile);
             }
 
-            fclose($this->_tmpHandle);
+            fclose($this->tmpHandle);
-            rename($this->_path.'queue.tmp', $this->_path.'queue.txt');
+            rename($this->queueTmpFile, $this->queueFile);
         }
     }
 
-    /**
-     * @return int
-     * @throws \RuntimeException
-     */
-    public function getQueueItemCount()
-    {
-        return FileHelper::getLineCount($this->_path.'queue.txt');
-    }
-
     /**
      * @param string $key
      * @return bool
@@ -411,13 +390,11 @@ HTML;
         $key = (string)$key;
 
         // Try to open the file for reading / writing.
-        $queueFileHandle = fopen($this->_path.'queue.txt', 'r');
+        $queueFileHandle = fopen($this->queueFile, 'r');
 
         while(($line = fscanf($queueFileHandle, "%s\t%s\n")) !== false)
         {
-            list ($lineKey, $lineValue) = $line;
+            if ($key === $line[0])
-
-            if ($key === $lineKey)
             {
                 fclose($queueFileHandle);
                 return true;
@@ -428,6 +405,18 @@ HTML;
         return false;
     }
 
+    /**
+     * (PHP 5 >= 5.1.0)
+     * Count elements of an object
+     * @link http://php.net/manual/en/countable.count.php
+     *
+     * @return int The custom count as an integer.
+     */
+    public function count()
+    {
+        return (int)FileHelper::getLineCount($this->queueFile);
+    }
+
     /**
      * (PHP 5 >= 5.1.0)
      * String representation of object
@@ -437,7 +426,17 @@ HTML;
      */
     public function serialize()
     {
-        return serialize(array($this->_name, $this->_path));
+        return serialize(
+            array(
+                $this->baseDir,
+                $this->name,
+                $this->path,
+                $this->queueFile,
+                $this->queueTmpFile,
+                $this->lockFile,
+                $this->serializeFile,
+            )
+        );
     }
 
     /**
@@ -450,10 +449,15 @@ HTML;
      */
     public function unserialize($serialized)
     {
-        /** @var \DCarbone\UglyQueue $uglyQueue */
         $data = unserialize($serialized);
-        $this->_name = $data[0];
+        $this->baseDir = $data[0];
-        $this->_path = $data[1];
+        $this->name = $data[1];
+        $this->path = $data[2];
+        $this->queueFile = $data[3];
+        $this->queueTmpFile = $data[4];
+        $this->lockFile = $data[5];
+        $this->serializeFile = $data[6];
+        $this->initialize();
     }
 
     /**
@@ -466,8 +470,8 @@ HTML;
      */
     public function attach(\SplObserver $observer)
     {
-        if (!in_array($observer, $this->observers))
+        if (!in_array($observer, $this->_observers))
-            $this->observers[] = $observer;
+            $this->_observers[] = $observer;
     }
 
     /**
@@ -480,9 +484,9 @@ HTML;
      */
     public function detach(\SplObserver $observer)
     {
-        $idx = array_search($observer, $this->observers, true);
+        $idx = array_search($observer, $this->_observers, true);
         if ($idx !== false)
-            unset($this->observers[$idx]);
+            unset($this->_observers[$idx]);
     }
 
     /**
@@ -494,9 +498,97 @@ HTML;
      */
     public function notify()
     {
-        for ($i = 0, $count = count($this->observers); $i < $count; $i++)
+        foreach($this->_observers as $observer)
         {
-            $this->observers[$i]->notify($this);
+            $observer->update($this);
         }
     }
+
+    /**
+     * This method is mostly intended to check the "validity" of a re-initialized queue
+     *
+     * Could probably stand to be improved.
+     *
+     * @return bool
+     */
+    public function _valid()
+    {
+        return (
+            $this->baseDir !== null &&
+            $this->name !== null &&
+            $this->path !== null &&
+            $this->queueFile !== null &&
+            $this->queueTmpFile !== null &&
+            $this->lockFile !== null &&
+            $this->serializeFile !== null
+        );
+    }
+
+    // --------
+
+    /**
+     * @param int $ttl seconds to live
+     * @return bool
+     */
+    protected function createLockFile($ttl)
+    {
+        $ok = (bool)@file_put_contents(
+            $this->lockFile,
+            json_encode(array('ttl' => $ttl, 'born' => time())));
+
+        if ($ok !== true)
+        {
+            $this->_notifyStatus = UglyQueueEnum::QUEUE_FAILED_TO_LOCK;
+            $this->notify();
+            return $this->locked = false;
+        }
+
+        $this->locked = true;
+        $this->_notifyStatus = UglyQueueEnum::QUEUE_LOCKED;
+        $this->notify();
+
+        return true;
+    }
+
+    /**
+     * Post-construct initialization method.
+     *
+     * Also used post-un-serialization
+     */
+    protected function initialize()
+    {
+        if (is_readable($this->path) && is_writable($this->path))
+            $this->mode = self::QUEUE_READWRITE;
+        else if (is_readable($this->path))
+            $this->mode = self::QUEUE_READONLY;
+
+        if (!file_exists($this->path.'/index.html'))
+        {
+            if ($this->mode === self::QUEUE_READONLY)
+                throw new \RuntimeException('Cannot initialize queue with name "'.$this->name.'", the user lacks permission to create files.');
+
+            $html = <<<HTML
+<html>
+<head>
+	<title>403 Forbidden</title>
+</head>
+<body>
+    <p>Directory access is forbidden.</p>
+</body>
+</html>
+HTML;
+            file_put_contents($this->path.'/index.html', $html);
+        }
+
+        if (!file_exists($this->queueFile))
+        {
+            if ($this->mode === self::QUEUE_READONLY)
+                throw new \RuntimeException('Cannot initialize queue with name "'.$this->name.'", the user lacks permission to create files.');
+
+            file_put_contents($this->queueFile, '');
+        }
+
+        $this->_notifyStatus = UglyQueueEnum::QUEUE_INITIALIZED;
+        $this->notify();
+    }
 }

src/UglyQueueEnum.php

@@ -0,0 +1,24 @@
+<?php namespace DCarbone;
+
+/**
+ * Class UglyQueueEnum
+ * @package DCarbone
+ *
+ * Pseudo-enum thing.
+ */
+abstract class UglyQueueEnum
+{
+    // Typically used by UglyQueueManager
+    const MANAGER_INITIALIZED = 1;
+    const QUEUE_ADDED = 2;
+    const QUEUE_REMOVED = 3;
+
+    // Typically used by UglyQueues
+    const QUEUE_INITIALIZED              = 100;
+    const QUEUE_LOCKED                   = 101;
+    const QUEUE_FAILED_TO_LOCK           = 102;
+    const QUEUE_LOCKED_BY_OTHER_PROCESS  = 103;
+    const QUEUE_UNLOCKED                 = 104;
+    const QUEUE_PROCESSING               = 105;
+    const QUEUE_REACHED_END              = 106;
+}

src/UglyQueueManager.php

@@ -4,81 +4,54 @@
  * Class UglyQueueManager
  * @package DCarbone
  */
-class UglyQueueManager implements \SplObserver, \SplSubject
+class UglyQueueManager implements \SplObserver, \Countable
 {
-    const NOTIFY_MANAGER_INITIALIZED = 0;
+    /** @var UglyQueue[] */
-    const NOTIFY_QUEUE_ADDED = 1;
-    const NOTIFY_QUEUE_REMOVED = 2;
-
-    /** @var int */
-    public $notifyStatus;
-
-    const UGLY_QUEUE_SERIALIZED_NAME = 'ugly-queue.obj';
-
-    /** @var array */
-    private $observers = array();
-
-    /** @var array */
     protected $queues = array();
 
-    /** @var array */
-    protected $config = array();
-
     /** @var string */
-    protected $queueBaseDir;
+    protected $baseDir;
 
     /**
      * Constructor
      *
-     * @param array $config
+     * @param string $baseDir
-     * @param array $observers
      * @throws \RuntimeException
      * @throws \InvalidArgumentException
      */
-    protected function __construct(array $config, array $observers = array())
+    public function __construct($baseDir)
     {
-        if (!isset($config['queue-base-dir']))
+        if (false === is_string($baseDir))
-            throw new \InvalidArgumentException('"$config" parameter "queue-base-dir" not seen.');
+            throw new \InvalidArgumentException('Argument 1 expected to be string, "'.gettype($baseDir).'" seen.');
 
-        if (!is_dir($config['queue-base-dir']))
+        if (false === is_dir($baseDir))
-            throw new \RuntimeException('"queue-base-dir" points to a directory that does not exist.');
+            throw new \RuntimeException('"'.$baseDir.'" points to a directory that does not exist.');
 
-        $this->config = $config;
+        if (false === is_readable($baseDir))
-        $this->queueBaseDir =  rtrim(realpath($this->config['queue-base-dir']), "/\\").DIRECTORY_SEPARATOR;
+            throw new \RuntimeException('"'.$baseDir.'" is not readable and/or writable .');
-        $this->observers = $observers;
+
+        $this->baseDir =  rtrim($baseDir, "/\\");
+
+        foreach(glob(sprintf('%s/*', $this->baseDir), GLOB_ONLYDIR) as $queueDir)
+        {
+            $this->addQueueAtPath($queueDir);
+        }
     }
 
     /**
-     * @param array $config
+     * @param string $name
-     * @param array $observers
+     * @return UglyQueue|UglyQueueManager
-     * @return UglyQueueManager
      */
-    public static function init(array $config, array $observers = array())
+    public function getQueue($name)
     {
-        /** @var \DCarbone\UglyQueueManager $manager */
+        if (isset($this->queues[$name]))
-        $manager = new static($config, $observers);
+            return $this->queues[$name];
 
-        /** @var \DCarbone\UglyQueue $uglyQueue */
+        $path = sprintf('%s/%s', $this->baseDir, $name);
+        if (file_exists($path))
+            return $this->addQueueAtPath($path);
 
-        foreach(glob($manager->queueBaseDir.DIRECTORY_SEPARATOR.'*', GLOB_ONLYDIR) as $queueDir)
+        return $this->createQueue($name);
-        {
-            // Try to avoid looking at hidden directories or magic dirs such as '.' and '..'
-            $split = preg_split('#[/\\\]+#', $queueDir);
-            if (strpos(end($split), '.') === 0)
-                continue;
-
-            if (file_exists($queueDir.DIRECTORY_SEPARATOR.self::UGLY_QUEUE_SERIALIZED_NAME))
-                $uglyQueue = unserialize(file_get_contents($queueDir.DIRECTORY_SEPARATOR.self::UGLY_QUEUE_SERIALIZED_NAME));
-            else
-                $uglyQueue = UglyQueue::queueWithDirectoryPathAndObservers($queueDir, $manager->observers);
-
-            $manager->addQueue($uglyQueue);
-        }
-
-        $manager->notifyStatus = self::NOTIFY_MANAGER_INITIALIZED;
-        $manager->notify();
-
-        return $manager;
     }
 
     /**
@@ -88,24 +61,50 @@ class UglyQueueManager implements \SplObserver, \SplSubject
      */
     public function addQueue(UglyQueue $uglyQueue)
     {
-        if ($this->containsQueueWithName($uglyQueue->name))
+        $name = $uglyQueue->getName();
-            throw new \RuntimeException('Queue named "'.$uglyQueue->name.'" already exists in this manager.');
 
-        $this->queues[$uglyQueue->name] = $uglyQueue;
+        if ($this->containsQueueWithName($name))
+            throw new \RuntimeException('Queue named "'.$name.'" already exists in this manager.');
 
-        $this->notifyStatus = self::NOTIFY_QUEUE_ADDED;
+        $this->queues[$name] = $uglyQueue;
-        $this->notify();
 
         return $this;
     }
 
     /**
-     * @param $path
+     * @param string $name
+     * @return UglyQueue
+     */
+    public function createQueue($name)
+    {
+        $queue = new UglyQueue($this->baseDir, $name, array($this));
+        $this->addQueue($queue);
+        return end($this->queues);
+    }
+
+    /**
+     * @param string $path
      * @return \DCarbone\UglyQueueManager
      */
     public function addQueueAtPath($path)
     {
-        $uglyQueue = UglyQueue::queueWithDirectoryPathAndObservers($path, $this->observers);
+        // Try to avoid looking at hidden directories or magic dirs such as '.' and '..'
+        $split = preg_split('#[/\\\]+#', $path);
+
+        $queueName = end($split);
+
+        if (0 === strpos($queueName, '.'))
+            return null;
+
+        $serializedFile = sprintf('%s/%s/ugly-queue.obj', $this->baseDir, $queueName);
+        /** @var \DCarbone\UglyQueue $uglyQueue */
+        if (file_exists($serializedFile))
+            $uglyQueue = unserialize(file_get_contents($serializedFile));
+
+        if (!isset($uglyQueue) || $uglyQueue->_valid() === false)
+            $uglyQueue = new UglyQueue($this->baseDir, $queueName, array($this));
+
+        $uglyQueue->attach($this);
 
         return $this->addQueue($uglyQueue);
     }
@@ -116,8 +115,9 @@ class UglyQueueManager implements \SplObserver, \SplSubject
      */
     public function removeQueue(UglyQueue $uglyQueue)
     {
-        if ($this->containsQueueWithName($uglyQueue->name))
+        $name = $uglyQueue->getName();
-            unset($this->queues[$uglyQueue->name]);
+        if ($this->containsQueueWithName($name))
+            unset($this->queues[$name]);
 
         return $this;
     }
@@ -129,11 +129,7 @@ class UglyQueueManager implements \SplObserver, \SplSubject
     public function removeQueueByName($name)
     {
         if ($this->containsQueueWithName($name))
-        {
             unset($this->queues[$name]);
-            $this->notifyStatus = self::NOTIFY_QUEUE_REMOVED;
-            $this->notify();
-        }
 
         return $this;
     }
@@ -143,7 +139,7 @@ class UglyQueueManager implements \SplObserver, \SplSubject
      * @return \DCarbone\UglyQueue
      * @throws \InvalidArgumentException
      */
-    public function &getQueueWithName($name)
+    public function getQueueWithName($name)
     {
         if (isset($this->queues[$name]))
             return $this->queues[$name];
@@ -168,6 +164,18 @@ class UglyQueueManager implements \SplObserver, \SplSubject
         return array_keys($this->queues);
     }
 
+    /**
+     * (PHP 5 >= 5.1.0)
+     * Count elements of an object
+     * @link http://php.net/manual/en/countable.count.php
+     *
+     * @return int The custom count as an integer. The return value is cast to an integer.
+     */
+    public function count()
+    {
+        return count($this->queues);
+    }
+
     /**
      * (PHP 5 >= 5.1.0)
      * Receive update from subject
@@ -178,53 +186,6 @@ class UglyQueueManager implements \SplObserver, \SplSubject
      */
     public function update(\SplSubject $subject)
     {
-        for ($i = 0, $count = count($this->observers); $i < $count; $i++)
+        // Nothing for now...
-        {
-            $this->observers[$i]->notify($subject);
-        }
-    }
-
-    /**
-     * (PHP 5 >= 5.1.0)
-     * Attach an SplObserver
-     * @link http://php.net/manual/en/splsubject.attach.php
-     *
-     * @param \SplObserver $observer The SplObserver to attach.
-     * @return void
-     */
-    public function attach(\SplObserver $observer)
-    {
-        if (!in_array($observer, $this->observers, true))
-            $this->observers[] = $observer;
-    }
-
-    /**
-     * (PHP 5 >= 5.1.0)
-     * Detach an observer
-     * @link http://php.net/manual/en/splsubject.detach.php
-     *
-     * @param \SplObserver $observer The SplObserver to detach.
-     * @return void
-     */
-    public function detach(\SplObserver $observer)
-    {
-        $idx = array_search($observer, $this->observers, true);
-        if ($idx !== false)
-            unset($this->observers[$idx]);
-    }
-
-    /**
-     * (PHP 5 >= 5.1.0)
-     * Notify an observer
-     * @link http://php.net/manual/en/splsubject.notify.php
-     *
-     * @return void
-     */
-    public function notify()
-    {
-        for ($i = 0, $count = count($this->observers); $i < $count; $i++)
-        {
-            $this->observers[$i]->notify($this);
-        }
     }
 }

tests/UglyQueue/UglyQueueTest.php

@@ -9,6 +9,8 @@ require_once __DIR__.'/../misc/cleanup.php';
  */
 class UglyQueueTest extends PHPUnit_Framework_TestCase
 {
+    protected $baseDir;
+
     /**
      * @var array
      */
@@ -26,14 +28,19 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
         '10' => 'Virginia baked ham, sliced',
     );
 
+    protected function setUp()
+    {
+        $this->baseDir = realpath(__DIR__.'/../misc/queues');
+    }
+
     /**
-     * @covers \DCarbone\UglyQueue::queueWithDirectoryPathAndObservers
+     * @covers \DCarbone\UglyQueue::__construct
      * @uses \DCarbone\UglyQueue
      * @return \DCarbone\UglyQueue
      */
-    public function testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers()
+    public function testCanInitializeObjectWithValidParameters()
     {
-        $uglyQueue = \DCarbone\UglyQueue::queueWithDirectoryPathAndObservers(dirname(__DIR__).'/misc/queues/tasty-sandwich');
+        $uglyQueue = new \DCarbone\UglyQueue($this->baseDir, 'tasty-sandwich');
 
         $this->assertInstanceOf('\\DCarbone\\UglyQueue', $uglyQueue);
 
@@ -41,136 +48,198 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::queueWithDirectoryPathAndObservers
+     * @covers \DCarbone\UglyQueue::retrieveItems
      * @uses \DCarbone\UglyQueue
-     * @expectedException \InvalidArgumentException
+     * @depends testCanInitializeObjectWithValidParameters
-     */
-    public function testExceptionThrownWhenInitializingUglyQueueWithEmptyOrInvalidConf()
-    {
-        $uglyQueue = \DCarbone\UglyQueue::queueWithDirectoryPathAndObservers(array());
-    }
-
-    /**
-     * @covers \DCarbone\UglyQueue::processQueue
-     * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers
      * @expectedException \RuntimeException
      * @param \DCarbone\UglyQueue $uglyQueue
      */
     public function testExceptionThrownWhenTryingToProcessQueueAfterInitializationBeforeLock(\DCarbone\UglyQueue $uglyQueue)
     {
-        $process = $uglyQueue->processQueue();
+        
+        $uglyQueue->retrieveItems();
     }
 
     /**
      * @covers \DCarbone\UglyQueue::keyExistsInQueue
      * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers
+     * @depends testCanInitializeObjectWithValidParameters
      * @param \DCarbone\UglyQueue $uglyQueue
      */
     public function testKeyExistsInQueueReturnsFalseWithEmptyQueueAfterInitialization(\DCarbone\UglyQueue $uglyQueue)
     {
+        
         $exists = $uglyQueue->keyExistsInQueue(0);
 
         $this->assertFalse($exists);
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::addToQueue
+     * @covers \DCarbone\UglyQueue::addItem
      * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers
+     * @depends testCanInitializeObjectWithValidParameters
      * @expectedException \RuntimeException
      * @param \DCarbone\UglyQueue $uglyQueue
      */
     public function testExceptionThrownWhenTryingToAddItemsToQueueWithoutLock(\DCarbone\UglyQueue $uglyQueue)
     {
-        $addToQueue = $uglyQueue->addToQueue('test', 'value');
+        $uglyQueue->addItem('test', 'value');
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::__get
+     * @covers \DCarbone\UglyQueue::getPath
      * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers
+     * @depends testCanInitializeObjectWithValidParameters
      * @param \DCarbone\UglyQueue $uglyQueue
      */
     public function testCanGetQueueDirectory(\DCarbone\UglyQueue $uglyQueue)
     {
-        $queuePath = $uglyQueue->path;
+        $queuePath = $uglyQueue->getPath();
 
         $this->assertFileExists($queuePath);
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::__get
+     * @covers \DCarbone\UglyQueue::getName
      * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers
+     * @depends testCanInitializeObjectWithValidParameters
      * @param \DCarbone\UglyQueue $uglyQueue
      */
     public function testCanGetQueueName(\DCarbone\UglyQueue $uglyQueue)
     {
-        $queueName = $uglyQueue->name;
+        $queueName = $uglyQueue->getName();
 
         $this->assertEquals('tasty-sandwich', $queueName);
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::__get
+     * @covers \DCarbone\UglyQueue::getMode
+     * @depends testCanInitializeObjectWithValidParameters
+     * @param \DCarbone\UglyQueue $uglyQueue
+     */
+    public function testCanGetQueueMode(\DCarbone\UglyQueue $uglyQueue)
+    {
+        $mode = $uglyQueue->getMode();
+        $this->assertEquals(\DCarbone\UglyQueue::QUEUE_READWRITE, $mode);
+    }
+
+    /**
+     * @covers \DCarbone\UglyQueue::getBaseDir
+     * @depends testCanInitializeObjectWithValidParameters
+     * @param \DCarbone\UglyQueue $uglyQueue
+     */
+    public function testCanGetBaseDirectory(\DCarbone\UglyQueue $uglyQueue)
+    {
+        $baseDir = $uglyQueue->getBaseDir();
+        $this->assertEquals($this->baseDir, $baseDir);
+    }
+
+    /**
+     * @covers \DCarbone\UglyQueue::getLockFile
+     * @depends testCanInitializeObjectWithValidParameters
+     * @param \DCarbone\UglyQueue $uglyQueue
+     */
+    public function testCanGetLockFilePath(\DCarbone\UglyQueue $uglyQueue)
+    {
+        $lockFile = $uglyQueue->getLockFile();
+        $this->assertEquals(
+            sprintf('%s%s%s%squeue.lock',
+                $this->baseDir,
+                DIRECTORY_SEPARATOR,
+                $uglyQueue->getName(),
+                DIRECTORY_SEPARATOR),
+            $lockFile
+        );
+    }
+
+    /**
+     * @covers \DCarbone\UglyQueue::getQueueFile
+     * @depends testCanInitializeObjectWithValidParameters
+     * @param \DCarbone\UglyQueue $uglyQueue
+     */
+    public function testCanGetQueueFilePath(\DCarbone\UglyQueue $uglyQueue)
+    {
+        $queueFile = $uglyQueue->getQueueFile();
+        $this->assertEquals(
+            sprintf('%s%s%s%squeue.txt',
+                $this->baseDir,
+                DIRECTORY_SEPARATOR,
+                $uglyQueue->getName(),
+                DIRECTORY_SEPARATOR),
+            $queueFile
+        );
+    }
+
+    /**
+     * @covers \DCarbone\UglyQueue::getQueueTmpFile
+     * @depends testCanInitializeObjectWithValidParameters
+     * @param \DCarbone\UglyQueue $uglyQueue
+     */
+    public function testCanGetQueueTmpFilePath(\DCarbone\UglyQueue $uglyQueue)
+    {
+        $queueTmpFile = $uglyQueue->getQueueTmpFile();
+        $this->assertEquals(
+            sprintf(
+                '%s%s%s%squeue.tmp',
+                $this->baseDir,
+                DIRECTORY_SEPARATOR,
+                $uglyQueue->getName(),
+                DIRECTORY_SEPARATOR),
+            $queueTmpFile
+        );
+    }
+
+    /**
+     * @covers \DCarbone\UglyQueue::getSerializeFile
+     * @depends testCanInitializeObjectWithValidParameters
+     * @param \DCarbone\UglyQueue $uglyQueue
+     */
+    public function testCanGetSerializeFilePath(\DCarbone\UglyQueue $uglyQueue)
+    {
+        $serializeFile = $uglyQueue->getSerializeFile();
+        $this->assertEquals(
+            sprintf(
+                '%s%s%s%sugly-queue.obj',
+                $this->baseDir,
+                DIRECTORY_SEPARATOR,
+                $uglyQueue->getName(),
+                DIRECTORY_SEPARATOR),
+            $serializeFile
+        );
+    }
+
+    /**
+     * @covers \DCarbone\isAlreadyLocked::isAlreadyLocked
      * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers
+     * @depends testCanInitializeObjectWithValidParameters
      * @param \DCarbone\UglyQueue $uglyQueue
      */
     public function testCanGetQueueLockedStatus(\DCarbone\UglyQueue $uglyQueue)
     {
-        $locked = $uglyQueue->locked;
+        $locked = $uglyQueue->isAlreadyLocked();
-
         $this->assertFalse($locked);
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::__get
+     * @covers \DCarbone\UglyQueue::count
      * @uses \DCarbone\UglyQueue
-     * @expectedException \OutOfBoundsException
+     * @depends testCanInitializeObjectWithValidParameters
-     * @depends testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers
-     * @param \DCarbone\UglyQueue $uglyQueue
-     */
-    public function testExceptionThrownWhenAttemptingToGetInvalidProperty(\DCarbone\UglyQueue $uglyQueue)
-    {
-        $sandwich = $uglyQueue->sandwich;
-    }
-
-    /**
-     * @covers \DCarbone\UglyQueue::isLocked
-     * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers
-     * @param \DCarbone\UglyQueue $uglyQueue
-     */
-    public function testIsLockedReturnsFalseBeforeLocking(\DCarbone\UglyQueue $uglyQueue)
-    {
-        $isLocked = $uglyQueue->isLocked();
-
-        $this->assertFalse($isLocked);
-    }
-
-    /**
-     * @covers \DCarbone\UglyQueue::getQueueItemCount
-     * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers
      * @param \DCarbone\UglyQueue $uglyQueue
      */
     public function testGetQueueItemCountReturnsZeroWithEmptyQueue(\DCarbone\UglyQueue $uglyQueue)
     {
-        $itemCount = $uglyQueue->getQueueItemCount();
+        $itemCount = count($uglyQueue);
         $this->assertEquals(0, $itemCount);
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::queueWithDirectoryPathAndObservers
+     * @covers \DCarbone\UglyQueue::__construct
      * @uses \DCarbone\UglyQueue
      * @return \DCarbone\UglyQueue
      */
     public function testCanInitializeExistingQueue()
     {
-        $uglyQueue = \DCarbone\UglyQueue::queueWithDirectoryPathAndObservers(dirname(__DIR__).'/misc/queues/tasty-sandwich');
+        $uglyQueue = new \DCarbone\UglyQueue($this->baseDir, 'tasty-sandwich');
 
         $this->assertInstanceOf('\\DCarbone\\UglyQueue', $uglyQueue);
 
@@ -180,7 +249,7 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
     /**
      * @covers \DCarbone\UglyQueue::lock
      * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers
+     * @depends testCanInitializeObjectWithValidParameters
      * @expectedException \InvalidArgumentException
      * @param \DCarbone\UglyQueue $uglyQueue
      */
@@ -192,7 +261,7 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
     /**
      * @covers \DCarbone\UglyQueue::lock
      * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers
+     * @depends testCanInitializeObjectWithValidParameters
      * @expectedException \InvalidArgumentException
      * @param \DCarbone\UglyQueue $uglyQueue
      */
@@ -203,10 +272,10 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
 
     /**
      * @covers \DCarbone\UglyQueue::lock
-     * @covers \DCarbone\UglyQueue::isLocked
+     * @covers \DCarbone\isAlreadyLocked::isAlreadyLocked
      * @covers \DCarbone\UglyQueue::createLockFile
      * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeUglyQueueWithValidConfigArrayAndNoObservers
+     * @depends testCanInitializeObjectWithValidParameters
      * @param \DCarbone\UglyQueue $uglyQueue
      * @return \DCarbone\UglyQueue
      */
@@ -216,11 +285,9 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
 
         $this->assertTrue($locked);
 
-        $queueDir = $uglyQueue->path;
+        $this->assertFileExists($uglyQueue->getLockFile());
 
-        $this->assertFileExists($queueDir.'queue.lock');
+        $decode = @json_decode(file_get_contents($uglyQueue->getLockFile()));
-
-        $decode = @json_decode(file_get_contents($queueDir.'queue.lock'));
 
         $this->assertTrue((json_last_error() === JSON_ERROR_NONE));
         $this->assertObjectHasAttribute('ttl', $decode);
@@ -232,27 +299,29 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
 
     /**
      * @covers \DCarbone\UglyQueue::lock
-     * @covers \DCarbone\UglyQueue::isLocked
+     * @covers \DCarbone\isAlreadyLocked::isAlreadyLocked
      * @uses \DCarbone\UglyQueue
      * @depends testCanInitializeExistingQueue
      * @param \DCarbone\UglyQueue $uglyQueue
      */
     public function testCannotLockQueueThatIsAlreadyLocked(\DCarbone\UglyQueue $uglyQueue)
     {
+        
         $lock = $uglyQueue->lock();
 
         $this->assertFalse($lock);
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::isLocked
+     * @covers \DCarbone\isAlreadyLocked::isAlreadyLocked
      * @uses \DCarbone\UglyQueue
      * @depends testCanLockUglyQueueWithDefaultTTL
      * @param \DCarbone\UglyQueue $uglyQueue
      */
     public function testIsLockedReturnsTrueAfterLocking(\DCarbone\UglyQueue $uglyQueue)
     {
-        $isLocked = $uglyQueue->isLocked();
+        
+        $isLocked = $uglyQueue->isAlreadyLocked();
         $this->assertTrue($isLocked);
     }
 
@@ -266,31 +335,31 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
      */
     public function testCanUnlockLockedQueue(\DCarbone\UglyQueue $uglyQueue)
     {
+        
         $uglyQueue->unlock();
 
-        $queueGroupDir = $uglyQueue->path;
+        $this->assertFileNotExists($uglyQueue->getLockFile());
-
-        $this->assertFileNotExists($queueGroupDir.'queue.lock');
 
         return $uglyQueue;
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::isLocked
+     * @covers \DCarbone\isAlreadyLocked::isAlreadyLocked
      * @uses \DCarbone\UglyQueue
      * @depends testCanUnlockLockedQueue
      * @param \DCarbone\UglyQueue $uglyQueue
      */
     public function testIsLockedReturnsFalseAfterUnlockingQueue(\DCarbone\UglyQueue $uglyQueue)
     {
-        $isLocked = $uglyQueue->isLocked();
+        
+        $isLocked = $uglyQueue->isAlreadyLocked();
 
         $this->assertFalse($isLocked);
     }
 
     /**
      * @covers \DCarbone\UglyQueue::lock
-     * @covers \DCarbone\UglyQueue::isLocked
+     * @covers \DCarbone\isAlreadyLocked::isAlreadyLocked
      * @uses \DCarbone\UglyQueue
      * @uses \DCarbone\Helpers\FileHelper
      * @depends testCanUnlockLockedQueue
@@ -298,20 +367,20 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
      */
     public function testIsLockedReturnsFalseWithStaleQueueLockFile(\DCarbone\UglyQueue $uglyQueue)
     {
+        
         $uglyQueue->lock(2);
-        $isLocked = $uglyQueue->isLocked();
+        $isLocked = $uglyQueue->isAlreadyLocked();
         $this->assertTrue($isLocked);
 
         sleep(3);
 
-        $isLocked = $uglyQueue->isLocked();
+        $isLocked = $uglyQueue->isAlreadyLocked();
         $this->assertFalse($isLocked);
     }
 
     /**
      * @covers \DCarbone\UglyQueue::lock
-     * @covers \DCarbone\UglyQueue::isLocked
+     * @covers \DCarbone\isAlreadyLocked::isAlreadyLocked
-     * @covers \DCarbone\UglyQueue::__get
      * @uses \DCarbone\UglyQueue
      * @depends testCanUnlockLockedQueue
      * @param \DCarbone\UglyQueue $uglyQueue
@@ -319,15 +388,14 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
      */
     public function testCanLockQueueWithValidIntegerValue(\DCarbone\UglyQueue $uglyQueue)
     {
+        
         $locked = $uglyQueue->lock(200);
 
         $this->assertTrue($locked);
 
-        $queueDir = $uglyQueue->path;
+        $this->assertFileExists($uglyQueue->getLockFile());
 
-        $this->assertFileExists($queueDir.'queue.lock');
+        $decode = @json_decode(file_get_contents($uglyQueue->getLockFile()));
-
-        $decode = @json_decode(file_get_contents($queueDir.'queue.lock'));
 
         $this->assertTrue((json_last_error() === JSON_ERROR_NONE));
         $this->assertObjectHasAttribute('ttl', $decode);
@@ -338,7 +406,7 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::addToQueue
+     * @covers \DCarbone\UglyQueue::addItem
      * @uses \DCarbone\UglyQueue
      * @uses \DCarbone\Helpers\FileHelper
      * @depends testCanLockQueueWithValidIntegerValue
@@ -347,19 +415,18 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
      */
     public function testCanPopulateQueueTempFileAfterInitializationAndAcquiringLock(\DCarbone\UglyQueue $uglyQueue)
     {
+        
         foreach(array_reverse($this->tastySandwich, true) as $k=>$v)
         {
-            $added = $uglyQueue->addToQueue($k, $v);
+            $added = $uglyQueue->addItem($k, $v);
             $this->assertTrue($added);
         }
 
-        $groupDir = $uglyQueue->path;
-
         $this->assertFileExists(
-            $groupDir.'queue.tmp',
+            $uglyQueue->getQueueTmpFile(),
             'queue.tmp file was not created!');
 
-        $lineCount = \DCarbone\Helpers\FileHelper::getLineCount($groupDir.'queue.tmp');
+        $lineCount = \DCarbone\Helpers\FileHelper::getLineCount($uglyQueue->getQueueTmpFile());
 
         $this->assertEquals(11, $lineCount);
 
@@ -375,11 +442,10 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
      */
     public function testCanForciblyUpdateQueueFileFromTempFile(\DCarbone\UglyQueue $uglyQueue)
     {
+        
         $uglyQueue->_populateQueue();
 
-        $groupDir = $uglyQueue->path;
+        $this->assertFileNotExists($uglyQueue->getQueueTmpFile());
-
-        $this->assertFileNotExists($groupDir.'queue.tmp');
 
         $uglyQueue->_populateQueue();
 
@@ -387,7 +453,7 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::getQueueItemCount
+     * @covers \DCarbone\UglyQueue::count
      * @uses \DCarbone\UglyQueue
      * @uses \DCarbone\Helpers\FileHelper
      * @depends testCanPopulateQueueTempFileAfterInitializationAndAcquiringLock
@@ -395,7 +461,7 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
      */
     public function testCanGetCountOfItemsInPopulatedQueue(\DCarbone\UglyQueue $uglyQueue)
     {
-        $itemCount = $uglyQueue->getQueueItemCount();
+        $itemCount = count($uglyQueue);
 
         $this->assertEquals(11, $itemCount);
     }
@@ -408,13 +474,14 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
      */
     public function testKeyExistsReturnsTrueWithPopulatedQueue(\DCarbone\UglyQueue $uglyQueue)
     {
+        
         $exists = $uglyQueue->keyExistsInQueue(5);
 
         $this->assertTrue($exists);
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::processQueue
+     * @covers \DCarbone\UglyQueue::retrieveItems
      * @uses \DCarbone\UglyQueue
      * @depends testCanPopulateQueueTempFileAfterInitializationAndAcquiringLock
      * @expectedException \InvalidArgumentException
@@ -422,11 +489,12 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
      */
     public function testExceptionThrownWhenTryingToProcessLockedQueueWithNonInteger(\DCarbone\UglyQueue $uglyQueue)
     {
-        $process = $uglyQueue->processQueue('Eleventy Billion');
+        
+        $uglyQueue->retrieveItems('Eleventy Billion');
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::processQueue
+     * @covers \DCarbone\UglyQueue::retrieveItems
      * @uses \DCarbone\UglyQueue
      * @depends testCanPopulateQueueTempFileAfterInitializationAndAcquiringLock
      * @expectedException \InvalidArgumentException
@@ -434,12 +502,13 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
      */
     public function testExceptionThrownWhenTryingToProcessLockedQueueWithIntegerLessThan1(\DCarbone\UglyQueue $uglyQueue)
     {
-        $process = $uglyQueue->processQueue(0);
+        
+        $uglyQueue->retrieveItems(0);
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::processQueue
+     * @covers \DCarbone\UglyQueue::retrieveItems
-     * @covers \DCarbone\UglyQueue::getQueueItemCount
+     * @covers \DCarbone\UglyQueue::count
      * @uses \DCarbone\UglyQueue
      * @uses \DCarbone\Helpers\FileHelper
      * @depends testCanPopulateQueueTempFileAfterInitializationAndAcquiringLock
@@ -448,21 +517,22 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
      */
     public function testCanGetPartialQueueContents(\DCarbone\UglyQueue $uglyQueue)
     {
-        $process = $uglyQueue->processQueue(5);
+        
+        $process = $uglyQueue->retrieveItems(5);
 
         $this->assertEquals(5, count($process));
 
         $this->assertArrayHasKey('0', $process);
         $this->assertArrayHasKey('4', $process);
 
-        $this->assertEquals(6, $uglyQueue->getQueueItemCount());
+        $this->assertEquals(6, count($uglyQueue));
 
         return $uglyQueue;
     }
 
     /**
-     * @covers \DCarbone\UglyQueue::processQueue
+     * @covers \DCarbone\UglyQueue::retrieveItems
-     * @covers \DCarbone\UglyQueue::getQueueItemCount
+     * @covers \DCarbone\UglyQueue::count
      * @uses \DCarbone\UglyQueue
      * @uses \DCarbone\Helpers\FileHelper
      * @depends testCanGetPartialQueueContents
@@ -471,14 +541,14 @@ class UglyQueueTest extends PHPUnit_Framework_TestCase
      */
     public function testCanGetFullQueueContents(\DCarbone\UglyQueue $uglyQueue)
     {
-        $process = $uglyQueue->processQueue(6);
+        $process = $uglyQueue->retrieveItems(6);
 
         $this->assertEquals(6, count($process));
 
         $this->assertArrayHasKey('10', $process);
         $this->assertArrayHasKey('5', $process);
 
-        $this->assertEquals(0, $uglyQueue->getQueueItemCount());
+        $this->assertEquals(0, count($uglyQueue));
 
         return $uglyQueue;
     }

tests/UglyQueueManager/UglyQueueManagerTest.php

@@ -5,30 +5,31 @@
  */
 class UglyQueueManagerTest extends PHPUnit_Framework_TestCase
 {
+    protected $baseDir;
+
     protected $reallyTastySandwich = array(
         '0' => 'beef broth',
         '1' => 'barbeque sauce',
         '2' => 'boneless pork ribs',
     );
 
+    protected function setUp()
+    {
+        $this->baseDir = realpath(__DIR__.'/../misc/queues');
+    }
+
     /**
      * @covers \DCarbone\UglyQueueManager::__construct
-     * @covers \DCarbone\UglyQueueManager::init
      * @covers \DCarbone\UglyQueue::unserialize
-     * @covers \DCarbone\UglyQueue::__get
      * @covers \DCarbone\UglyQueueManager::addQueue
      * @covers \DCarbone\UglyQueueManager::containsQueueWithName
      * @uses \DCarbone\UglyQueueManager
      * @uses \DCarbone\UglyQueue
      * @return \DCarbone\UglyQueueManager
      */
-    public function testCanInitializeManagerWithConfigAndNoObservers()
+    public function testCanInitializeObjectWithValidPath()
     {
-        $config = array(
+        $manager = new \DCarbone\UglyQueueManager($this->baseDir);
-            'queue-base-dir' => __DIR__.'/../misc/queues'
-        );
-
-        $manager = \DCarbone\UglyQueueManager::init($config);
 
         $this->assertInstanceOf('\\DCarbone\\UglyQueueManager', $manager);
 
@@ -36,39 +37,20 @@ class UglyQueueManagerTest extends PHPUnit_Framework_TestCase
     }
 
     /**
-     * @covers \DCarbone\UglyQueueManager::init
      * @covers \DCarbone\UglyQueueManager::__construct
      * @uses \DCarbone\UglyQueueManager
      * @expectedException \RuntimeException
      */
     public function testExceptionThrownDuringConstructionWithInvalidBasePathValue()
     {
-        $config = array(
+        new \DCarbone\UglyQueueManager('i do not exist!');
-            'queue-base-dir' => 'i do not exist!'
-        );
-
-        $manager = \DCarbone\UglyQueueManager::init($config);
     }
 
-    /**
-     * @covers \DCarbone\UglyQueueManager::init
-     * @covers \DCarbone\UglyQueueManager::__construct
-     * @uses \DCarbone\UglyQueueManager
-     * @expectedException \InvalidArgumentException
-     */
-    public function testExceptionThrownDuringConstructionWithInvalidConfArray()
-    {
-        $config = array(
-            'wrong-key' => 'wrong value'
-        );
-
-        $manager = \DCarbone\UglyQueueManager::init($config);
-    }
 
     /**
      * @covers \DCarbone\UglyQueueManager::containsQueueWithName
      * @uses \DCarbone\UglyQueueManager
-     * @depends testCanInitializeManagerWithConfigAndNoObservers
+     * @depends testCanInitializeObjectWithValidPath
      * @param \DCarbone\UglyQueueManager $manager
      */
     public function testCanDetermineIfValidQueueExistsInManager(\DCarbone\UglyQueueManager $manager)
@@ -81,7 +63,7 @@ class UglyQueueManagerTest extends PHPUnit_Framework_TestCase
     /**
      * @covers \DCarbone\UglyQueueManager::containsQueueWithName
      * @uses \DCarbone\UglyQueueManager
-     * @depends testCanInitializeManagerWithConfigAndNoObservers
+     * @depends testCanInitializeObjectWithValidPath
      * @param \DCarbone\UglyQueueManager $manager
      */
     public function testCanDetermineQueueDoesNotExistInManager(\DCarbone\UglyQueueManager $manager)
@@ -93,10 +75,9 @@ class UglyQueueManagerTest extends PHPUnit_Framework_TestCase
 
     /**
      * @covers \DCarbone\UglyQueueManager::getQueueWithName
-     * @covers \DCarbone\UglyQueue::__get
      * @uses \DCarbone\UglyQueueManager
      * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeManagerWithConfigAndNoObservers
+     * @depends testCanInitializeObjectWithValidPath
      * @param \DCarbone\UglyQueueManager $manager
      */
     public function testCanGetUglyQueueObjectFromManager(\DCarbone\UglyQueueManager $manager)
@@ -104,25 +85,25 @@ class UglyQueueManagerTest extends PHPUnit_Framework_TestCase
         $uglyQueue = $manager->getQueueWithName('tasty-sandwich');
 
         $this->assertInstanceOf('\\DCarbone\\UglyQueue', $uglyQueue);
-        $this->assertEquals('tasty-sandwich', $uglyQueue->name);
+        $this->assertEquals('tasty-sandwich', $uglyQueue->getName());
     }
 
     /**
      * @covers \DCarbone\UglyQueueManager::getQueueWithName
      * @uses \DCarbone\UglyQueueManager
      * @expectedException \InvalidArgumentException
-     * @depends testCanInitializeManagerWithConfigAndNoObservers
+     * @depends testCanInitializeObjectWithValidPath
      * @param \DCarbone\UglyQueueManager $manager
      */
     public function testExceptionThrownWhenTryingToGetNonExistentQueueFromManager(\DCarbone\UglyQueueManager $manager)
     {
-        $shouldNotExist = $manager->getQueueWithName('sandwiches');
+        $manager->getQueueWithName('sandwiches');
     }
 
     /**
      * @covers \DCarbone\UglyQueueManager::getQueueList
      * @uses \DCarbone\UglyQueueManager
-     * @depends testCanInitializeManagerWithConfigAndNoObservers
+     * @depends testCanInitializeObjectWithValidPath
      * @param \DCarbone\UglyQueueManager $manager
      */
     public function testCanGetListOfQueuesInManager(\DCarbone\UglyQueueManager $manager)
@@ -140,7 +121,7 @@ class UglyQueueManagerTest extends PHPUnit_Framework_TestCase
      * @uses \DCarbone\UglyQueueManager
      * @uses \DCarbone\UglyQueue
      * @expectedException \RuntimeException
-     * @depends testCanInitializeManagerWithConfigAndNoObservers
+     * @depends testCanInitializeObjectWithValidPath
      * @param \DCarbone\UglyQueueManager $manager
      */
     public function testExceptionThrownWhenReAddingQueueToManager(\DCarbone\UglyQueueManager $manager)
@@ -156,17 +137,17 @@ class UglyQueueManagerTest extends PHPUnit_Framework_TestCase
      * @covers \DCarbone\UglyQueueManager::getQueueWithName
      * @uses \DCarbone\UglyQueueManager
      * @uses \DCarbone\UglyQueue
-     * @depends testCanInitializeManagerWithConfigAndNoObservers
+     * @depends testCanInitializeObjectWithValidPath
      * @param \DCarbone\UglyQueueManager $manager
      */
     public function testCanInitializeNewQueueAndAddToManager(\DCarbone\UglyQueueManager $manager)
     {
-        $manager->addQueueAtPath(__DIR__.'/../misc/queues/really-tasty-sandwich');
+        $manager->addQueueAtPath($this->baseDir.'/really-tasty-sandwich');
 
         $uglyQueue = $manager->getQueueWithName('really-tasty-sandwich');
 
         $this->assertInstanceOf('\\DCarbone\\UglyQueue', $uglyQueue);
-        $this->assertEquals('really-tasty-sandwich', $uglyQueue->name);
+        $this->assertEquals('really-tasty-sandwich', $uglyQueue->getName());
 
         $queueList = $manager->getQueueList();
 
@@ -178,7 +159,7 @@ class UglyQueueManagerTest extends PHPUnit_Framework_TestCase
     /**
      * @covers \DCarbone\UglyQueueManager::removeQueueByName
      * @uses \DCarbone\UglyQueueManager
-     * @depends testCanInitializeManagerWithConfigAndNoObservers
+     * @depends testCanInitializeObjectWithValidPath
      * @param \DCarbone\UglyQueueManager $manager
      */
     public function testCanRemoveQueueFromManagerByName(\DCarbone\UglyQueueManager $manager)