Merge pull request barryvdh#13 from GrahamCampbell/tweaks

Tweaks

Author: barryvdh

.gitattributes

@@ -1,22 +1,5 @@
-# Auto detect text files and perform LF normalization
 * text=auto
 
-# Custom for Visual Studio
-*.cs     diff=csharp
-*.sln    merge=union
-*.csproj merge=union
-*.vbproj merge=union
-*.fsproj merge=union
-*.dbproj merge=union
-
-# Standard to msysgit
-*.doc	 diff=astextplain
-*.DOC	 diff=astextplain
-*.docx diff=astextplain
-*.DOCX diff=astextplain
-*.dot  diff=astextplain
-*.DOT  diff=astextplain
-*.pdf  diff=astextplain
-*.PDF	 diff=astextplain
-*.rtf	 diff=astextplain
-*.RTF	 diff=astextplain
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/readme.md export-ignore

.gitignore

@@ -1,4 +1,2 @@
-/vendor
-composer.phar
 composer.lock
-.DS_Store
+vendor

composer.json

@@ -17,6 +17,5 @@
         "psr-4": {
             "Barryvdh\\Queue\\": "src/"
         }
-    },
-    "minimum-stability": "dev"
-}
+    }
+}

readme.md

@@ -1,4 +1,5 @@
 # Laravel 4 Async Queue Driver
+
 ## Push a function/closure to the background.
 
 Just like the 'sync' driver, this is not a real queue driver. It is always fired immediatly.
@@ -8,14 +9,15 @@ This package is more usable as an alternative for running incidental tasks in th
 > **Note:** If you are coming from 0.1.0 (or dev-master), you will need to run the migrations, since the new versions uses a database to store the queue.
 
 ### Install
+
 Add the package to the require section of your composer.json and run `composer update`
 
     "barryvdh/laravel-async-queue": "0.2.x"
 
 Add the Service Provider to the providers array in config/app.php
 
     'Barryvdh\Queue\AsyncServiceProvider',
-    
+
 You need to run the migrations for this package
 
     $ php artisan migrate --package="barryvdh/laravel-async-queue"
@@ -27,7 +29,7 @@ Or publish them, so they are copied to your regular migrations
 You should now be able to use the async driver in config/queue.php
 
     'default' => 'async',
-    
+
     'connections' => array(
         ...
         'async' => array(

src/AsyncQueue.php

@@ -1,40 +1,47 @@
-<?php namespace Barryvdh\Queue;
+<?php
 
+namespace Barryvdh\Queue;
+
+use Barryvdh\Queue\Models\Job;
 use Illuminate\Queue\Queue;
 use Illuminate\Queue\QueueInterface;
 use Symfony\Component\Process\Process;
-use Barryvdh\Queue\Models\Job;
-
-class AsyncQueue extends Queue implements QueueInterface {
 
+class AsyncQueue extends Queue implements QueueInterface
+{
     /**
      * Push a new job onto the queue.
      *
-     * @param  string  $job
-     * @param  mixed   $data
-     * @param  string  $queue
-     * @return mixed
+     * @param string      $job
+     * @param mixed       $data
+     * @param string|null $queue
+     *
+     * @return int
      */
     public function push($job, $data = '', $queue = null)
     {
         $id = $this->storeJob($job, $data);
         $this->startProcess($id, 0);
+
         return 0;
     }
 
     /**
-     * Store the job in the database
-     * 
-     * @param  string  $job
-     * @param  mixed   $data
-     * @param  integer $delay
-     * @return integer The id of the job
+     * Store the job in the database.
+     *
+     * Returns the id of the job.
+     *
+     * @param string $job
+     * @param mixed  $data
+     * @param int    $delay
+     *
+     * @return int
      */
-    public function storeJob($job, $data, $delay = 0){
-
+    public function storeJob($job, $data, $delay = 0)
+    {
         $payload = $this->createPayload($job, $data);
 
-        $job = new Job;
+        $job = new Job();
         $job->status = Job::STATUS_OPEN;
         $job->delay = $delay;
         $job->payload = $payload;
@@ -44,19 +51,21 @@ public function storeJob($job, $data, $delay = 0){
     }
 
     /**
-     * Make a Process for the Artisan command for the job id
+     * Make a Process for the Artisan command for the job id.
+     *
+     * @param int $jobId
      *
-     * @param  integer $jobId
+     * @return void
      */
     public function startProcess($jobId)
     {
         $environment = $this->container->environment();
         $cwd = $this->container['path.base'];
         $string = 'php artisan queue:async %d --env=%s ';
-        if (defined('PHP_WINDOWS_VERSION_BUILD')){
-            $string = 'start /B ' . $string . ' > NUL';
+        if (defined('PHP_WINDOWS_VERSION_BUILD')) {
+            $string = 'start /B '.$string.' > NUL';
         } else {
-            $string = 'nohup ' . $string . ' > /dev/null 2>&1 &';
+            $string = 'nohup '.$string.' > /dev/null 2>&1 &';
         }
 
         $command = sprintf($string, $jobId, $environment);
@@ -67,39 +76,45 @@ public function startProcess($jobId)
     /**
      * Push a new job onto the queue after a delay.
      *
-     * @param  \DateTime|int  $delay
-     * @param  string  $job
-     * @param  mixed  $data
-     * @param  string  $queue
-     * @return mixed
+     * @param \DateTime|int $delay
+     * @param string        $job
+     * @param mixed         $data
+     * @param string|null   $queue
+     *
+     * @return int
      */
     public function later($delay, $job, $data = '', $queue = null)
     {
         $delay = $this->getSeconds($delay);
         $id = $this->storeJob($job, $data, $delay);
         $this->startProcess($id);
+
         return 0;
     }
 
     /**
      * Pop the next job off of the queue.
      *
-     * @param  string  $queue
-     * @return \Illuminate\Queue\Jobs\Job|null
+     * @param string|null $queue
+     *
+     * @return void
      */
-    public function pop($queue = null) {}
-
+    public function pop($queue = null)
+    {
+        // do nothing
+    }
 
     /**
      * Push a raw payload onto the queue.
      *
-     * @param  string $payload
-     * @param  string $queue
-     * @param  array $options
-     * @return mixed
+     * @param string      $payload
+     * @param string|null $queue
+     * @param array       $options
+     *
+     * @return void
      */
     public function pushRaw($payload, $queue = null, array $options = array())
     {
-        //
+        // do nothing
     }
 }

src/AsyncServiceProvider.php

@@ -1,11 +1,13 @@
-<?php namespace Barryvdh\Queue;
+<?php
+
+namespace Barryvdh\Queue;
 
-use Illuminate\Support\ServiceProvider;
 use Barryvdh\Queue\Connectors\AsyncConnector;
 use Barryvdh\Queue\Console\AsyncCommand;
+use Illuminate\Support\ServiceProvider;
 
-class AsyncServiceProvider extends ServiceProvider {
-
+class AsyncServiceProvider extends ServiceProvider
+{
     /**
      * Indicates if loading of the provider is deferred.
      *
@@ -14,34 +16,36 @@ class AsyncServiceProvider extends ServiceProvider {
     protected $defer = false;
 
     /**
-     * Register the service provider.
+     * Add the connector to the queue drivers.
      *
      * @return void
      */
-    public function register()
+    public function boot()
     {
-        $this->registerAsyncCommand();
+        $manager = $this->app['queue'];
+        $this->registerAsyncConnector($manager);
     }
 
     /**
-     * Add the connector to the queue drivers
+     * Register the service provider.
+     *
+     * @return void
      */
-    public function boot(){
-        $manager = $this->app['queue'];
-        $this->registerAsyncConnector($manager);
+    public function register()
+    {
+        $this->registerAsyncCommand($this->app);
     }
 
     /**
      * Register the queue listener console command.
      *
+     * @param \Illuminate\Foundation\Application $app
+     *
      * @return void
      */
-    protected function registerAsyncCommand()
+    protected function registerAsyncCommand($app)
     {
-        $app = $this->app;
-
-        $app['command.queue.async'] = $app->share(function($app)
-            {
+        $app['command.queue.async'] = $app->share(function ($app) {
                 return new AsyncCommand();
             });
 
@@ -51,14 +55,14 @@ protected function registerAsyncCommand()
     /**
      * Register the Async queue connector.
      *
-     * @param  \Illuminate\Queue\QueueManager  $manager
+     * @param \Illuminate\Queue\QueueManager $manager
+     *
      * @return void
      */
     protected function registerAsyncConnector($manager)
     {
-        $manager->addConnector('async', function()
-            {
-                return new AsyncConnector;
+        $manager->addConnector('async', function () {
+                return new AsyncConnector();
             });
     }
 
@@ -71,5 +75,4 @@ public function provides()
     {
         return array('command.queue.async');
     }
-
 }

src/Connectors/AsyncConnector.php

@@ -1,19 +1,21 @@
-<?php namespace Barryvdh\Queue\Connectors;
+<?php
 
-use Illuminate\Queue\Connectors\ConnectorInterface;
-use Barryvdh\Queue\AsyncQueue;
+namespace Barryvdh\Queue\Connectors;
 
-class AsyncConnector implements ConnectorInterface {
+use Barryvdh\Queue\AsyncQueue;
+use Illuminate\Queue\Connectors\ConnectorInterface;
 
+class AsyncConnector implements ConnectorInterface
+{
     /**
      * Establish a queue connection.
      *
-     * @param  array  $config
+     * @param array $config
+     *
      * @return \Illuminate\Queue\QueueInterface
      */
     public function connect(array $config)
     {
-        return new AsyncQueue;
+        return new AsyncQueue();
     }
-
-}
+}