Merge pull request #10 from PyRowMan/feature/4

Update doc and travis config

Author: PyRowMan

.travis.yml

@@ -11,7 +11,7 @@ env:
 #  - SYMFONY_VERSION=2.5.*
 #  - SYMFONY_VERSION=2.6.*
 #  - SYMFONY_VERSION=2.7.*
-#  - SYMFONY_VERSION=3.*
+  - SYMFONY_VERSION=3.*
   - SYMFONY_VERSION=4.*
 
 #matrix:

CHANGELOG.md

@@ -1,114 +1,3 @@
-## 3.3.0
-
-* Support Symfony 4
-
-## 3.1.0
-
-* Allow dependencies `symfony/framework-bundle` ~3.0
-* Allow dependencies `symfony/console` ~3.0
-
-## 3.0.0
-
-This version does not break compatibility itself, but it does upgrade
-Pheanstalk to version 3, which uses namespaces. If you use any Pheanstalk
-classes directly in your code, you should update those references.
-
-* Upped Pheanstalk version to ~3.0
-* Upped Symfony requirement to ~2.3
-* Upped PHP version requirement to 5.5.9
-* Added PRS-4 autoloader configuration
-* The option `enabled` was removed from configuration
-* The `*.class` service parameters were replaced by its real values
-
-## 2.5.0
-* Logging is now done to a specific channel (PR #50 @pkruithof)
-
-## 2.4.0
-* Add CLI Command to display next ready job
-
-## 2.3.0
-* PR #43 - StatsTube shows stats for all tube if no argument is given
-
-## 2.2.0
-* Pull Request #41 Fix chainable methods to return proxy object
-
-## 2.1.6
-* Add command to view the first ready/burried job in a certrain tube
-* Remove useless import
-* Add missing use
-* Add Scrutinizer Badge
-* Add link to LeezyPheanstalkBundleExtra
-
-## 2.1.5
-* Fix #38
-
-## 2.1.4
-* Fix install documentation.
-* Fix #29
-* Remove github analytics
-* Fixed FlushTube Command by catching the correct Exception
-* Pretty smal fixes to be more PSR2 compliant
-* Move connection definition from compiler pass to the extension
-
-## 2.1.3
-* Fixed return value for Proxy::putInTube
-* CHANGELOG use markdown extension
-
-## 2.1.2
-* Add KickJobCommand
-* Fix error management on command
-
-## 2.1.1
-* Fix missing implementation of PheanstalkInterface::kickJob
-
-## 2.1.0
-* Use pda/pheanstalk 2.1.0
-* Add KickCommand
-* Fix default name on Command
-
-## 2.0.1
-* Set type hint for logger
-* Add few tests on PheanstalkLogListener
-
-## 2.0.0
-* Add PheanstalkProxy
-* Allow user to define custom PheanstalkProxy
-* Fragment documentation
-* Events documentation
-* Change 'connection' name to 'pheanstalk'
-* Event integration
-* BC : Use 'pheanstalk' name instead of 'connection' to avoid confusion
-* Add more security on CLI
-* Logger integration
-* Add documentation on custom proxy
-
-## 1.2.0
-* Add profilter integration, thanks @Maxwell2022
-* Add ConnectionLocator
-
-## 1.1.0
-* Remove useless Tests/Fixtures/Entity/FakeMedia.php
-* Update composer to use symfony/framework-bundle instead of symfony/symfony
-* Remove requirement PHP >= 5.3.3. Use the PHP requirement of symfony/framework-bundle
-* Fix Travis-CI problem
-
-## 1.0.4
-* Update to PSR-0 : https://github.com/pda/pheanstalk/commit/412ab5b7469538ab613efd8fb91b4adc84bf599f
-* Add warning about composer minimum-stability due to : https://github.com/armetiz/LeezyPheanstalkBundle/issues/8
-
-## 1.0.3
-* Update code to pda/pheanstalk which is a PHP5.2 implementation.
-* BC still ok.
-
-## 1.0.2
-* Add Unit Test
-* Throw exception when more than one connection have the default flag
-* Switch dependency from 'mrpoundsign/pheanstalk-5.3' to 'pda/pheanstalk'
-* Add TravisCI configuration
-
-## 1.0.1
-* Fix dependency to pheanstalk-5.3. #4
-
 ## 1.0.0
 * Update README to be composer compliant.
 * First stable tag version.

README.md

@@ -1,31 +1,29 @@
-## LeezyPheanstalkBundle
+## PheanstalkBundle
 
 [![Packagist Version](https://img.shields.io/packagist/v/pyrowman/pheanstalk-bundle)](https://packagist.org/packages/pyrowman/pheanstalk-bundle)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/PyRowMan/pheanstalk-bundle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/PyRowMan/pheanstalk-bundle/?branch=master)
 [![Code Coverage](https://scrutinizer-ci.com/g/PyRowMan/pheanstalk-bundle/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/PyRowMan/pheanstalk-bundle/?branch=master)
 [![Build Status](https://travis-ci.org/PyRowMan/pheanstalk-bundle.svg?branch=master)](https://travis-ci.org/PyRowMan/pheanstalk-bundle)
 
-[EvQueue workqueue](http://www.evqueue.net/) clients for Symfony2.
+[EvQueue workqueue](http://www.evqueue.net/) clients for Symfony3.
 
-The Pyrowman\LeezyPheanstalkBundle is a fork from [LeezyPheanstalkBundle](https://github.com/armetiz/LeezyPheanstalkBundle) 
+The Pyrowman\PheanstalkBundle is a fork from [LeezyPheanstalkBundle](https://github.com/armetiz/LeezyPheanstalkBundle) 
 
-The Pyrowman\LeezyPheanstalkBundle is a Symfony2 Bundle that provides a [pheanstalk](https://github.com/pyrowman/pheanstalk) integration with the following features:
+The Pyrowman\PheanstalkBundle is a Symfony3 Bundle that provides a [pheanstalk](https://github.com/pyrowman/pheanstalk) integration with the following features:
 * Command Line Interface for manage the queues.
-* An integration to the Symfony2 event system.
-* An integration to the Symfony2 profiler system to monitor your beanstalk server.
-* An integration to the Symfony2 logger system.
+* An integration to the Symfony3 event system.
+* An integration to the Symfony3 profiler system to monitor your evqueue server.
+* An integration to the Symfony3 logger system.
 * A proxy system to customize the command features.
 * Auto-wiring: `PheanstalkInterface`
 
 
 Documentation :
-- [Installation](https://github.com/armetiz/LeezyPheanstalkBundle/blob/master/src/Resources/doc/1-installation.md)
-- [Configuration](https://github.com/armetiz/LeezyPheanstalkBundle/blob/master/src/Resources/doc/2-configuration.md)
-- [CLI Usage](https://github.com/armetiz/LeezyPheanstalkBundle/blob/master/src/Resources/doc/3-cli.md)
-- [Events](https://github.com/armetiz/LeezyPheanstalkBundle/blob/master/src/Resources/doc/4-events.md)
-- [Custom proxy](https://github.com/armetiz/LeezyPheanstalkBundle/blob/master/src/Resources/doc/5-custom-proxy.md)
-- [Extra - Beanstalk Manager](https://github.com/armetiz/LeezyPheanstalkBundle/blob/master/src/Resources/doc/6-extra-beanstalk-manager.md)
-- [Extra - Proxy to prefix tubes](https://github.com/h4cc/LeezyPheanstalkBundleExtra)
+- [Installation](https://github.com/PyRowMan/pheanstalk-bundle/blob/master/src/Resources/doc/1-installation.md)
+- [Configuration](https://github.com/PyRowMan/pheanstalk-bundle/blob/master/src/Resources/doc/2-configuration.md)
+- [CLI Usage](https://github.com/PyRowMan/pheanstalk-bundle/blob/master/src/Resources/doc/3-cli.md)
+- [Events](https://github.com/PyRowMan/pheanstalk-bundle/blob/master/src/Resources/doc/4-events.md)
+- [Custom proxy](https://github.com/PyRowMan/pheanstalk-bundle/blob/master/src/Resources/doc/5-custom-proxy.md)
 
 ## Usage example
 
@@ -34,15 +32,20 @@ Documentation :
 
 namespace Acme\DemoBundle\Controller;
 
-use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Pheanstalk\Structure\Schedule;
+use Pheanstalk\Structure\TimeSchedule;
+use Pyrowman\PheanstalkBundle\Proxy\PheanstalkProxy;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
-class HomeController extends Controller {
+class HomeController extends AbstractController 
+{
 
     public function indexAction() {
 
         $sc = $this->get('service_container');
         /** @var PheanstalkProxy $pheanstalk */
-        $pheanstalk = $sc->get("leezy.pheanstalk");
+        $pheanstalk = $sc->get("pheanstalk");
 
         // Create a simple Worflow with one task inside
 
@@ -59,8 +62,8 @@ class HomeController extends Controller {
 
         //-----------------------------------------
         // Add a scheduler for the job (by default in continous)
-        
-        $workflowSchedule = $pheanstalk->createSchedule($workflow, new TimeSchedule());
+        $schedule = new Schedule($workflow->getId(), new TimeSchedule());
+        $workflowSchedule = $pheanstalk->createSchedule($schedule);
 
         //-----------------------------------------
         // Edit a workflow
@@ -97,8 +100,21 @@ class HomeController extends Controller {
 ## Testing
 
 ```bash
-$ php composer.phar update
-$ phpunit
+# ensure you have Composer set up
+$ wget http://getcomposer.org/composer.phar
+$ php composer.phar install
+
+$ bin/phpunit 
+PHPUnit 7.1.2 by Sebastian Bergmann and contributors.
+
+..........................................................        58 / 58 (100%)
+
+Time: 11.36 seconds, Memory: 16.00 MB
+
+OK (58 tests, 98 assertions)
+
+Generating code coverage report in HTML format ... done
+
 ```
 
 ## License

phpunit.xml.dist

@@ -9,7 +9,7 @@
         <!--<log type="junit" target="build/logs/junit.xml"/>-->
     </logging>
     <testsuites>
-        <testsuite name="LeezyPheanstalkBundle test suite">
+        <testsuite name="PheanstalkBundle test suite">
             <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>

src/DependencyInjection/Configuration.php

@@ -39,7 +39,7 @@ public function getConfigTreeBuilder()
                         ->end()
                         ->scalarNode('port')
                             ->cannotBeEmpty()
-                            ->defaultValue('11300')
+                            ->defaultValue('5000')
                         ->end()
                         ->scalarNode('user')
                             ->cannotBeEmpty()

src/Resources/doc/1-installation.md

@@ -2,16 +2,16 @@
 
 Installation is a quick 3 step process:
 
-1. Download LeezyPheanstalkBundle using composer
+1. Download PheanstalkBundle using composer
 2. Enable the Bundle
 3. Configure your application's config.yml
 
-### Step 1: Require LeezyPheanstalkBundle
+### Step 1: Require PheanstalkBundle
 
 Tell composer to require this bundle by running:
 
 ``` bash
-$ composer require leezy/pheanstalk-bundle
+$ composer require pyrowman/pheanstalk-bundle
 ```
 
 ### Step 2: Enable the bundle
@@ -26,7 +26,7 @@ public function registerBundles()
 {
     $bundles = array(
         // ...
-        new Leezy\PheanstalkBundle\LeezyPheanstalkBundle(),
+        new Pyrowman\PheanstalkBundle\PheanstalkBundle(),
     );
 }
 ```
@@ -37,9 +37,11 @@ Finally, add the following to your config.yml
 
 ``` yaml
 # app/config/config.yml
-leezy_pheanstalk:
+pheanstalk:
     pheanstalks:
         primary:
-            server: beanstalkd.domain.tld
+            server: evqueue.domain.tld
+            user: my_awesome_login_from_env_file
+            password: my_awesome_password_from_env_file
             default: true
 ```

src/Resources/doc/2-configuration.md

@@ -3,49 +3,57 @@
 This bundle can be configured, and this is the list of what you can do :
 * Create many pheanstalk client.
 * Define specific server / host for each connection.
-* Define specific port for each connection. This option is optional and default value is 11300.
+* Define specific port for each connection. This option is optional and default value is 5000.
 * Define specific timeout for each connection. Timeout refere to the connection timeout. This option is optional and default value is 60.
 * Use custom proxy for pheanstalk client.
 * Disable this bundle. This options is optional and default value is true.
 
 ``` yaml
 # app/config/config.yml
-leezy_pheanstalk:
+pheanstalk:
     pheanstalks:
         primary:
-            server: beanstalkd.domain.tld
+            server: evqueue.domain.tld
+            user: my_awesome_login_from_env_file
+            password: my_awesome_password_from_env_file
             port: 11300
             timeout: 60
         secondary:
-            server: beanstalkd-2.domain.tld
+            server: evqueue-2.domain.tld
+            user: my_awesome_login_from_env_file
+            password: my_awesome_password_from_env_file
             default: true
             proxy: acme.pheanstalk
     profiler:
         enabled: true
-        template: 'LeezyPheanstalkBundle:Profiler:pheanstalk.html.twig'
+        template: 'PheanstalkBundle:Profiler:pheanstalk.html.twig'
 ```
 
-*acme.pheanstalk* is a custom proxy which implements the *Leezy\PheanstalkBundle\Proxy\PheanstalkProxyInterface* interface.
+*acme.pheanstalk* is a custom proxy which implements the *PyRowMan\PheanstalkBundle\Proxy\PheanstalkProxyInterface* interface.
 
 **Note:**
 ```
-    You can retreive each pheanstalk using the container with "leezy.pheanstalk.[pheanstalk_name]".
-    When you define a "default" pheanstalk. You can have a direct access to it with "leezy.pheanstalk".
+    You can retreive each pheanstalk using the container with "pheanstalk.[pheanstalk_name]".
+    When you define a "default" pheanstalk. You can have a direct access to it with "pheanstalk".
 ```
 
-``` php
+```php
 <?php
 
 namespace Acme\DemoBundle\Controller;
 
-use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Pheanstalk\Structure\Schedule;
+use Pheanstalk\Structure\TimeSchedule;
+use Pyrowman\PheanstalkBundle\Proxy\PheanstalkProxy;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
-class HomeController extends Controller
+class HomeController extends AbstractController 
 {
     public function indexAction()
     {
-        $pheanstalkPrimary = $this->get("leezy.pheanstalk.primary");
-        $pheanstalkSecondary = $this->get("leezy.pheanstalk");
+        $pheanstalkPrimary = $this->get("pheanstalk.primary");
+        $pheanstalkSecondary = $this->get("pheanstalk");
 
         // ----------------------------------------
         // producer (queues jobs) on beanstalk.domain.tld
@@ -68,7 +76,7 @@ class HomeController extends Controller
 
         // ----------------------------------------
         // on each defined pheanstalks
-        $pheanstalkLocator = $this->get("leezy.pheanstalk.pheanstalk_locator");
+        $pheanstalkLocator = $this->get("pheanstalk.pheanstalk_locator");
 
         foreach ($pheanstalkLocator->getPheanstalks() as $pheanstalk) {
             $pheanstalk