Merge pull request #30 from SimonFrings/docs

Minor documentation and example improvement

Author: clue

README.md

@@ -65,19 +65,23 @@ Once [installed](#install), you can use the following code to access an
 HTTP webserver and send a large number of HTTP GET requests:
 
 ```php
+<?php
+
+require __DIR__ . '/vendor/autoload.php';
+
 $browser = new React\Http\Browser();
 
 // load a huge array of URLs to fetch
 $urls = file('urls.txt');
 
 // each job should use the browser to GET a certain URL
 // limit number of concurrent jobs here
-$q = new Queue(3, null, function ($url) use ($browser) {
+$q = new Clue\React\Mq\Queue(3, null, function ($url) use ($browser) {
     return $browser->get($url);
 });
 
 foreach ($urls as $url) {
-    $q($url)->then(function (ResponseInterface $response) use ($url) {
+    $q($url)->then(function (Psr\Http\Message\ResponseInterface $response) use ($url) {
         echo $url . ': ' . $response->getBody()->getSize() . ' bytes' . PHP_EOL;
     });
 }
@@ -473,7 +477,7 @@ for more details.
 
 ## Install
 
-The recommended way to install this library is [through Composer](https://getcomposer.org).
+The recommended way to install this library is [through Composer](https://getcomposer.org/).
 [New to Composer?](https://getcomposer.org/doc/00-intro.md)
 
 This project follows [SemVer](https://semver.org/).
@@ -487,12 +491,12 @@ See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
 
 This project aims to run on any platform and thus does not require any PHP
 extensions and supports running on legacy PHP 5.3 through current PHP 8+.
-It's *highly recommended to use PHP 7+* for this project.
+It's highly recommended to use the latest supported PHP version for this project.
 
 ## Tests
 
 To run the test suite, you first need to clone this repo and then install all
-dependencies [through Composer](https://getcomposer.org):
+dependencies [through Composer](https://getcomposer.org/):
 
 ```bash
 $ composer install
@@ -501,7 +505,7 @@ $ composer install
 To run the test suite, go to the project root and run:
 
 ```bash
-$ php vendor/bin/phpunit
+$ vendor/bin/phpunit
 ```
 
 ## License

composer.json

@@ -24,6 +24,6 @@
         "clue/block-react": "^1.0",
         "phpunit/phpunit": "^9.3 || ^5.7 || ^4.8.35",
         "react/event-loop": "^1.2",
-        "react/http": "^1.4"
+        "react/http": "^1.5"
     }
 }

examples/01-http.php

@@ -1,10 +1,5 @@
 <?php
 
-use Clue\React\Mq\Queue;
-use Psr\Http\Message\ResponseInterface;
-use React\EventLoop\Factory;
-use React\Http\Browser;
-
 require __DIR__ . '/../vendor/autoload.php';
 
 // list of all URLs you want to download
@@ -17,17 +12,17 @@
     'http://www.google.com/',
 );
 
-$browser = new Browser();
+$browser = new React\Http\Browser();
 
 // each job should use the browser to GET a certain URL
 // limit number of concurrent jobs here to avoid using excessive network resources
-$queue = new Queue(3, null, function ($url) use ($browser) {
+$queue = new Clue\React\Mq\Queue(3, null, function ($url) use ($browser) {
     return $browser->get($url);
 });
 
 foreach ($urls as $url) {
     $queue($url)->then(
-        function (ResponseInterface $response) use ($url) {
+        function (Psr\Http\Message\ResponseInterface $response) use ($url) {
             echo $url . ' has ' . $response->getBody()->getSize() . ' bytes' . PHP_EOL;
         },
         function (Exception $e) use ($url) {

examples/02-http-all.php

@@ -1,10 +1,5 @@
 <?php
 
-use Clue\React\Mq\Queue;
-use Psr\Http\Message\ResponseInterface;
-use React\EventLoop\Factory;
-use React\Http\Browser;
-
 require __DIR__ . '/../vendor/autoload.php';
 
 // list of all URLs you want to download
@@ -17,17 +12,17 @@
     //'http://httpbin.org/delay/2',
 );
 
-$browser = new Browser();
+$browser = new React\Http\Browser();
 
 // each job should use the browser to GET a certain URL
 // limit number of concurrent jobs here to avoid using excessive network resources
-$promise = Queue::all(3, array_combine($urls, $urls), function ($url) use ($browser) {
+$promise = Clue\React\Mq\Queue::all(3, array_combine($urls, $urls), function ($url) use ($browser) {
     return $browser->get($url);
 });
 
 $promise->then(
     function ($responses) {
-        /* @var $responses ResponseInterface[] */
+        /* @var $responses Psr\Http\Message\ResponseInterface[] */
         echo 'All URLs succeeded!' . PHP_EOL;
         foreach ($responses as $url => $response) {
             echo $url . ' has ' . $response->getBody()->getSize() . ' bytes' . PHP_EOL;

examples/03-http-any.php

@@ -1,10 +1,5 @@
 <?php
 
-use Clue\React\Mq\Queue;
-use Psr\Http\Message\ResponseInterface;
-use React\EventLoop\Factory;
-use React\Http\Browser;
-
 require __DIR__ . '/../vendor/autoload.php';
 
 // list of all URLs you want to try
@@ -18,13 +13,13 @@
     'http://www.google.com/invalid',
 );
 
-$browser = new Browser();
+$browser = new React\Http\Browser();
 
 // each job should use the browser to GET a certain URL
 // limit number of concurrent jobs here to avoid using excessive network resources
-$promise = Queue::any(2, $urls, function ($url) use ($browser) {
+$promise = Clue\React\Mq\Queue::any(2, $urls, function ($url) use ($browser) {
     return $browser->get($url)->then(
-        function (ResponseInterface $response) use ($url) {
+        function (Psr\Http\Message\ResponseInterface $response) use ($url) {
             // return only the URL for the first successful response
             return $url;
         }

examples/11-http-blocking.php

@@ -1,10 +1,7 @@
 <?php
 
 use Clue\React\Block;
-use Clue\React\Mq\Queue;
-use Psr\Http\Message\ResponseInterface;
-use React\EventLoop\Factory;
-use React\Http\Browser;
+use React\EventLoop\Loop;
 
 require __DIR__ . '/../vendor/autoload.php';
 
@@ -20,12 +17,12 @@
 
 function download(array $urls)
 {
-    $browser = new Browser();
+    $browser = new React\Http\Browser();
 
     $urls = array_combine($urls, $urls);
-    $promise = Queue::all(3, $urls, function ($url) use ($browser) {
+    $promise = Clue\React\Mq\Queue::all(3, $urls, function ($url) use ($browser) {
         return $browser->get($url)->then(
-            function (ResponseInterface $response) {
+            function (Psr\Http\Message\ResponseInterface $response) {
                 // return only the body for successful responses
                 return $response->getBody();
             },
@@ -36,7 +33,7 @@ function (Exception $e) {
         );
     });
 
-    return Block\await($promise, $loop);
+    return Block\await($promise, Loop::get());
 }
 
 $responses = download($urls);