Prepare v3 release (#10)

phpcurl · Nov 2, 2018 · b90cd2c · b90cd2c
1 parent 4679635
commit b90cd2c
Show file tree

Hide file tree

Showing 11 changed files with 54 additions and 59 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,11 +5,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [3.0.0]
 ### Added
 - php 7 type hints.
 - This changelog
 
 ### Removed
+- Initialization in constructors. Now `init()` has to be called explicitly.
 - php 5 support.
 - php 7.1 support.
 
@@ -69,7 +71,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial version.
 
-[Unreleased]: https://github.com/phpcurl/curlwrapper/compare/2.1.0...HEAD
+[Unreleased]: https://github.com/phpcurl/curlwrapper/compare/3.0.0...HEAD
+[3.0.0]: https://github.com/phpcurl/curlwrapper/compare/2.1.0...3.0.0
 [2.1.0]: https://github.com/phpcurl/curlwrapper/compare/2.0.1...2.1.0
 [2.0.1]: https://github.com/phpcurl/curlwrapper/compare/2.0.0...2.0.1
 [2.0.0]: https://github.com/phpcurl/curlwrapper/compare/1.0.0...2.0.0

diff --git a/README.md b/README.md
@@ -4,9 +4,9 @@
 [![Travis Build](https://travis-ci.org/phpcurl/curlwrapper.svg?branch=master)](https://travis-ci.org/phpcurl/curlwrapper)
 [![SensioLabs Insight](https://img.shields.io/sensiolabs/i/f6dd716c-7729-46f2-903f-12a53e427841.svg)](https://insight.sensiolabs.com/projects/f6dd716c-7729-46f2-903f-12a53e427841)
 
-
-The simplest OOP-style wrapper for the standard php curl functions.
-The main purpose is to make code that uses curl calls testable. We do it by injecting the Curl object as a dependency instead of calling curl functions directly.
+The simplest OOP-style wrapper for the standard php curl functions with no external dependencies.
+The main purpose is to make code that uses curl calls testable. 
+We do it by injecting the Curl object as a dependency instead of calling curl functions directly.
 
 
 Hard-coded dependencies. Not testable.
@@ -52,7 +52,7 @@ Via [composer](https://getcomposer.org):
 
 | Classic                          | OOP |
 | ---                              | --- |
-| `$h = curl_init($url)`           | `$curl = new Curl($url)` or `$curl->init($url)` |
+| `$h = curl_init($url)`           | `$curl = new Curl(); $curl->init($url)` |
 | `curl_close($h)`                 | `unset($curl)` |
 | `$e = curl_errno($h)`            | `$e = $curl->errno()` |
 | `$e = curl_error($h)`            | `$e = $curl->error()` |
@@ -71,7 +71,7 @@ Via [composer](https://getcomposer.org):
 
 | Classic                                    | OOP |
 | ---                                        | --- |
-| `curl_multi_init()`                        |   `$cm = new CurlMulti()` |
+| `curl_multi_init()`                        |   `$cm = new CurlMulti(); $cm->init()` |
 | `curl_multi_close($h)`                     |   `unset($cm)` |
 | `$i = curl_multi_add_handle($mh, $ch)`     |   `$i = $cm->add($curl)` |
 | `$i = curl_multi_remove_handle($mh, $ch)`  |   `$i = $cm->remove($curl)` |
@@ -85,6 +85,6 @@ Via [composer](https://getcomposer.org):
 
 | Classic                                  | OOP |
 | ---                                      | --- |
-| `curl_share_init()`                      |   `$cs = new CurlShare()` |
+| `curl_share_init()`                      |   `$cs = new CurlShare(); $cs->init()` |
 | `curl_share_close($h)`                   |   `unset($cs)` |
 | `$r = curl_multi_setopt($h, $opt, $val)` |   `$r = $cs->setOpt($opt, $val)` |
diff --git a/src/Curl.php b/src/Curl.php
@@ -1,4 +1,5 @@
-<?php
+<?php declare(strict_types=1);
+
 namespace PHPCurl\CurlWrapper;
 
 class Curl implements CurlInterface
@@ -8,14 +9,6 @@ class Curl implements CurlInterface
      */
     private $handle;
 
-    /**
-     * @param string $url URL
-     */
-    public function __construct(string $url = null)
-    {
-        $this->init($url);
-    }
-
     /**
      * @inheritdoc
      */
@@ -86,23 +79,23 @@ public function version(int $age = CURLVERSION_NOW): array
     /**
      * @inheritdoc
      */
-    public function strError(int $errornum): string
+    public function strError(int $errornum): ?string
     {
         return curl_strerror($errornum);
     }
 
     /**
      * @inheritdoc
      */
-    public function escape(string $str): string
+    public function escape(string $str)
     {
         return curl_escape($this->handle, $str);
     }
 
     /**
      * @inheritdoc
      */
-    public function unescape(string $str): string
+    public function unescape(string $str)
     {
         return curl_unescape($this->handle, $str);
     }

diff --git a/src/CurlInterface.php b/src/CurlInterface.php
@@ -1,4 +1,5 @@
-<?php
+<?php declare(strict_types=1);
+
 namespace PHPCurl\CurlWrapper;
 
 interface CurlInterface
@@ -43,8 +44,8 @@ public function getInfo(int $opt = 0);
     /**
      * @see curl_setopt()
      *
-     * @param int   $option Option code
-     * @param mixed $value  Option value
+     * @param int $option Option code
+     * @param mixed $value Option value
      * @return boolean
      */
     public function setOpt(int $option, $value): bool;
@@ -71,23 +72,23 @@ public function version(int $age = CURLVERSION_NOW): array;
      * @param int $errornum
      * @return string
      */
-    public function strError(int $errornum): string;
+    public function strError(int $errornum): ?string;
 
     /**
      * @see curl_escape()
      *
      * @param string $str
-     * @return string
+     * @return string|false
      */
-    public function escape(string $str): string;
+    public function escape(string $str);
 
     /**
      * @see curl_unescape()
      *
      * @param string $str
-     * @return string
+     * @return string|false
      */
-    public function unescape(string $str): string;
+    public function unescape(string $str);
 
     /**
      * @see curl_reset()

diff --git a/src/CurlMulti.php b/src/CurlMulti.php
@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace PHPCurl\CurlWrapper;
 
@@ -9,11 +9,6 @@ class CurlMulti implements CurlMultiInterface
      */
     private $handle;
 
-    public function __construct()
-    {
-        $this->init();
-    }
-
     /**
      * @inheritdoc
      */
@@ -57,15 +52,15 @@ public function getContent(CurlInterface $curl): ?string
     /**
      * @inheritdoc
      */
-    public function infoRead(int &$msgs = null): array
+    public function infoRead(int &$msgs = null)
     {
         return curl_multi_info_read($this->handle, $msgs);
     }
 
     /**
      * @inheritdoc
      */
-    public function remove(CurlInterface $curl): int
+    public function remove(CurlInterface $curl)
     {
         return curl_multi_remove_handle($this->handle, $curl->getHandle());
     }
@@ -81,7 +76,7 @@ public function select(float $timeout = 1.0): int
     /**
      * @inheritdoc
      */
-    public function strError(int $errornum): string
+    public function strError(int $errornum): ?string
     {
         return curl_multi_strerror($errornum);
     }

diff --git a/src/CurlMultiInterface.php b/src/CurlMultiInterface.php
@@ -1,4 +1,5 @@
-<?php
+<?php declare(strict_types=1);
+
 namespace PHPCurl\CurlWrapper;
 
 interface CurlMultiInterface
@@ -40,17 +41,17 @@ public function getContent(CurlInterface $curl): ?string;
      * @see curl_multi_info_read()
      *
      * @param int $msgs
-     * @return array
+     * @return array|false
      */
-    public function infoRead(int &$msgs = null): array;
+    public function infoRead(int &$msgs = null);
 
     /**
      * @see curl_multi_remove_handle()
      *
      * @param CurlInterface $curl Handle to remove
-     * @return int
+     * @return int|false
      */
-    public function remove(CurlInterface $curl): int;
+    public function remove(CurlInterface $curl);
 
     /**
      * @see curl_multi_select()
@@ -66,7 +67,7 @@ public function select(float $timeout = 1.0): int;
      * @param int $errornum
      * @return string
      */
-    public function strError(int $errornum): string;
+    public function strError(int $errornum): ?string;
 
     /**
      * @see curl_multi_setopt

diff --git a/src/CurlShare.php b/src/CurlShare.php
@@ -1,4 +1,5 @@
-<?php
+<?php declare(strict_types=1);
+
 namespace PHPCurl\CurlWrapper;
 
 class CurlShare implements CurlShareInterface
@@ -8,11 +9,6 @@ class CurlShare implements CurlShareInterface
      */
     private $handle;
 
-    public function __construct()
-    {
-        $this->init();
-    }
-
     /**
      * @inheritdoc
      */

diff --git a/src/CurlShareInterface.php b/src/CurlShareInterface.php
@@ -1,4 +1,5 @@
-<?php
+<?php declare(strict_types=1);
+
 namespace PHPCurl\CurlWrapper;
 
 interface CurlShareInterface
@@ -11,7 +12,7 @@ interface CurlShareInterface
     public function init();
 
     /**
-     * @see curl_share_setopt
+     * @see curl_share_setopt()
      *
      * @param int   $opt
      * @param mixed $val

diff --git a/test/CurlMultiTest.php b/test/CurlMultiTest.php
@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace PHPCurl\CurlWrapper;
 
@@ -36,7 +36,7 @@ function curl_multi_strerror($c)
 
 function curl_multi_select($h, $t)
 {
-    return $h === 'foo' ? $t : 0.0;
+    return 42;
 }
 
 function curl_multi_close($h)
@@ -68,16 +68,16 @@ public function testAll()
             ->will($this->returnValue('bar'));
 
         $cm = new CurlMulti();
+        $cm->init();
         $this->assertEquals('foo', $cm->getHandle());
         $this->assertTrue($cm->setOpt(0, 'val'));
         $this->assertEquals(1, $cm->add($c));
         $this->assertEquals(1, $cm->remove($c));
         $this->assertEquals('bar', $cm->getContent($c));
-        $this->assertEquals(1, $cm->select());
-        $this->assertEquals(2, $cm->select(2.3));
+        $this->assertEquals(42, $cm->select());
+        $this->assertEquals(42, $cm->select(2.3));
         $this->assertEquals(['foo' => 42], $cm->infoRead($msgs));
         $this->assertEquals(42, $msgs);
-        $running = 0;
         $this->assertEquals(1, $cm->exec($running));
         $this->assertEquals(24, $running);
         $this->assertEquals('strerror_1', $cm->strError(1));

diff --git a/test/CurlShareTest.php b/test/CurlShareTest.php
@@ -1,4 +1,5 @@
-<?php
+<?php declare(strict_types=1);
+
 namespace PHPCurl\CurlWrapper;
 
 use PHPUnit\Framework\TestCase;
@@ -25,6 +26,7 @@ class CurlShareTest extends TestCase
     public function testAll()
     {
         $c = new CurlShare();
+        $c->init();
         $this->assertTrue($c->setOpt(0, 'val'));
         unset($c);
         $this->assertEquals('close_foo', array_pop(self::$log));

diff --git a/test/CurlTest.php b/test/CurlTest.php
@@ -1,4 +1,5 @@
-<?php
+<?php declare(strict_types=1);
+
 namespace PHPCurl\CurlWrapper;
 
 use PHPUnit\Framework\TestCase;
@@ -96,7 +97,8 @@ class CurlTest extends TestCase
 
     public function testAll()
     {
-        $c = new Curl('http://example.com');
+        $c = new Curl();
+        $c->init('http://example.com');
         $this->assertEquals('my_handle', $c->getHandle());
         $this->assertEquals([123], $c->version());
         $this->assertEquals('my_strerror', $c->strError(5));
@@ -182,7 +184,8 @@ public function testAll()
 
     public function testClone()
     {
-        $c = new Curl('http://example.com');
+        $c = new Curl();
+        $c->init('http://example.com');
         $clone = clone($c);
         $this->assertEquals('my_handle_copy', $clone->getHandle());
     }