Merge branch 'release/0.8.2'

Author: repejota

.gitignore

@@ -4,6 +4,8 @@ vendor
 cover
 *.phar
 /composer.phar
+/phpDocumentor.phar
 /composer.lock
+/docs/api
 build
 .idea

.travis.yml

@@ -17,6 +17,7 @@ before_script:
   - make deps
 script:
   - mkdir -p build/logs
+  - make lint
   - make test
 after_script:
   - php vendor/bin/coveralls

Makefile

@@ -1,24 +1,36 @@
-lint:
+lint: lint-php lint-psr2 lint-squiz
+
+.PHONY: lint-php
+lint-php:
 	find src -name *.php -exec php -l {} \;
 	find test -name *.php -exec php -l {} \;
 	find spec -name *.php -exec php -l {} \;
 	find examples -name *.php -exec php -l {} \;
 
-cs: lint
-	./vendor/bin/phpcbf --standard=PSR2 src test examples
-	./vendor/bin/phpcs --standard=PSR2 --warning-severity=0 src test examples
-	./vendor/bin/phpcs --standard=Squiz --sniffs=Squiz.Commenting.FunctionComment,Squiz.Commenting.FunctionCommentThrowTag,Squiz.Commenting.ClassComment,Squiz.Commenting.VariableComment src test examples
+.PHONY: lint-psr2
+lint-psr2:
+	#./vendor/bin/phpcbf --standard=PSR2 src test examples
+	./vendor/bin/phpcs --standard=PSR2 --colors -w -s --warning-severity=0 src test examples
+
+.PHONY: lint-squiz
+lint-squiz:
+	# ./vendor/bin/phpcbf --standard=Squiz,./ruleset.xml src test examples
+	./vendor/bin/phpcs --standard=Squiz,./ruleset.xml --colors -w -s --warning-severity=0 src test examples
+
 
-test: tdd bdd
+test: test-tdd test-bdd
 
-tdd:
+.PHONY: test-tdd
+test-tdd:
 	./vendor/bin/phpunit test
 
-bdd:
+.PHONY: test-bdd
+test-bdd:
 	./vendor/bin/phpspec run --format=pretty -v
 
 cover:
 	./vendor/bin/phpunit --coverage-html ./cover test
+
 deps:
 	wget -q https://getcomposer.org/composer.phar -O ./composer.phar
 	chmod +x composer.phar
@@ -29,8 +41,16 @@ dist-clean:
 	rm -rf vendor
 	rm -f composer.phar
 	rm -f composer.lock
+	rm -f phpDocumentor.phar
+	rm -rf docs/api
 
 docker-nats:
 	docker run --rm -p 8222:8222 -p 4222:4222 -d --name nats-main nats
 
-.PHONY: lint test cs cover deps dist-clean
+phpdoc:
+	wget -q https://github.com/phpDocumentor/phpDocumentor2/releases/download/v2.9.0/phpDocumentor.phar -O ./phpDocumentor.phar
+	chmod +x phpDocumentor.phar
+	./phpDocumentor.phar -d ./src/ -t ./docs/api --template=checkstyle --template=responsive-twig
+
+serve-phpdoc:
+	cd docs/api && php -S localhost:8000 && cd ../..

README.md

@@ -3,13 +3,15 @@ phpnats
 
 **Travis**
 
-* Master: [![Build Status](https://travis-ci.org/repejota/phpnats.png?branch=master)](https://travis-ci.org/repejota/phpnats)
-* Develop: [![Build Status](https://travis-ci.org/repejota/phpnats.png?branch=develop)](https://travis-ci.org/repejota/phpnats)
+| Master  | Develop |
+| ------------- | ------------- |
+| [![Build Status](https://travis-ci.org/repejota/phpnats.png?branch=master)](https://travis-ci.org/repejota/phpnats)  | [![Build Status](https://travis-ci.org/repejota/phpnats.png?branch=develop)](https://travis-ci.org/repejota/phpnats)  |
 
 **Coverage**
 
-* Master: [![Coverage Status](https://coveralls.io/repos/repejota/phpnats/badge.svg?branch=master)](https://coveralls.io/r/repejota/phpnats?branch=master)
-* Develop: [![Coverage Status](https://coveralls.io/repos/repejota/phpnats/badge.svg?branch=develop)](https://coveralls.io/r/repejota/phpnats?branch=develop)
+| Master  | Develop |
+| ------------- | ------------- |
+| [![Coverage Status](https://coveralls.io/repos/repejota/phpnats/badge.svg?branch=master)](https://coveralls.io/r/repejota/phpnats?branch=master) | [![Coverage Status](https://coveralls.io/repos/repejota/phpnats/badge.svg?branch=develop)](https://coveralls.io/r/repejota/phpnats?branch=develop)  |
 
 Introduction
 ------------
@@ -88,23 +90,33 @@ Developer's Information
 
 ### Releases
 
-[Latest stable](https://github.com/repejota/phpnats/tree/master)
-[Latest dev](https://github.com/repejota/phpnats/tree/develop)
+* [Latest stable](https://github.com/repejota/phpnats/tree/master)
+* [Latest dev](https://github.com/repejota/phpnats/tree/develop)
+
+* [PHPNats on Packagist](https://packagist.org/packages/repejota/nats)
 
 ### Tests
 
 Tests are in the `tests` folder.
-To run them, you need `PHPUnit` and execute `make test`.
+To run them, you need `PHPUnit` and execute `make test-tdd`.
 
 We also have a BDD test suite under the `spec` folder.
-To run the suite, you need `PHPSpec` and execute `make bdd`.
+To run the suite, you need `PHPSpec` and execute `make test-bdd`.
+
+You can also execute the all suites ( TDD + BDD ) with `make test`.
 
 ### Code Quality
 
 We are using [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer/docs)
 to ensure our code follow an high quality standard.
 
-To perform an analysis of the code execute `make cs`.
+To perform an analysis of the code execute `make lint`.
+
+There is currently three steps when we lint our code:
+
+* First we lint with php itself `php -l`
+* Then we lint with PSR2 standard
+* And finally we lint with a custom [ruleset.xml](https://github.com/repejota/phpnats/blob/feature/lint-squiz/ruleset.xml) that checks dockblocks and different performance tips.
 
 
 Creators

VERSION

@@ -1 +1 @@
-0.8.1
+0.8.2

examples/connect.php

@@ -1,10 +1,8 @@
 <?php
-require_once __DIR__ . "/../vendor/autoload.php";
+require_once __DIR__.'/../vendor/autoload.php';
 
 $connectionOptions = new \Nats\ConnectionOptions();
-$connectionOptions
-    ->setHost('localhost')
-    ->setPort(4222);
+$connectionOptions->setHost('localhost')->setPort(4222);
 $c = new Nats\Connection($connectionOptions);
 $c->connect();
 $c->close();

examples/connectauth.php

@@ -1,12 +1,8 @@
 <?php
-require_once __DIR__ . "/../vendor/autoload.php";
+require_once __DIR__.'/../vendor/autoload.php';
 
 $connectionOptions = new \Nats\ConnectionOptions();
-$connectionOptions
-    ->setHost('localhost')
-    ->setPort(4222)
-    ->setUser("foo")
-    ->setPass("bar");
+$connectionOptions->setHost('localhost')->setPort(4222)->setUser('foo')->setPass('bar');
 $c = new Nats\Connection($connectionOptions);
 $c->connect();
 $c->close();

examples/ping.php

@@ -1,12 +1,10 @@
 <?php
-require_once __DIR__ . "/../vendor/autoload.php";
+require_once __DIR__.'/../vendor/autoload.php';
 
 $connectionOptions = new \Nats\ConnectionOptions();
-$connectionOptions
-    ->setHost('localhost')
-    ->setPort(4222);
+$connectionOptions->setHost('localhost')->setPort(4222);
 
-echo "Server: nats://" . $connectionOptions->getHost() . ":" . $connectionOptions->getPort() . PHP_EOL;
+echo 'Server: nats://'.$connectionOptions->getHost().':'.$connectionOptions->getPort().PHP_EOL;
 
 $c = new Nats\Connection($connectionOptions);
 $c->connect();

examples/pubsub/pub.php

@@ -1,17 +1,15 @@
 <?php
-require_once __DIR__ . "/../../vendor/autoload.php";
+require_once __DIR__.'/../../vendor/autoload.php';
 
 $connectionOptions = new \Nats\ConnectionOptions();
-$connectionOptions
-    ->setHost('localhost')
-    ->setPort(4222);
+$connectionOptions->setHost('localhost')->setPort(4222);
 $c = new Nats\Connection($connectionOptions);
 $c->connect();
 
 $c->reconnect();
 
-$c->publish("foo", "bar");
-$c->publish("foo", "bar");
-$c->publish("foo", "bar");
-$c->publish("foo", "bar");
-$c->publish("foo", "bar");
+$c->publish('foo', 'bar');
+$c->publish('foo', 'bar');
+$c->publish('foo', 'bar');
+$c->publish('foo', 'bar');
+$c->publish('foo', 'bar');

examples/pubsub/sub.php

@@ -1,18 +1,16 @@
 <?php
-require_once __DIR__ . "/../../vendor/autoload.php";
+require_once __DIR__.'/../../vendor/autoload.php';
 
 $connectionOptions = new \Nats\ConnectionOptions();
-$connectionOptions
-    ->setHost('localhost')
-    ->setPort(4222);
+$connectionOptions->setHost('localhost')->setPort(4222);
 $c = new Nats\Connection($connectionOptions);
 $c->connect();
 
 $callback = function ($payload) {
     printf("Data: %s\r\n", $payload);
 };
 
-$sid = $c->subscribe("foo", $callback);
+$sid = $c->subscribe('foo', $callback);
 
 $c->wait(2);