Fix issues reported by PHPStan

Fixed all PHPStan issues up to level 4 and added PHPStan to
CI scripts.
Fixed an issue reported by PhpStorm.

Added a new test-case to test a basic setup. This also tests the
removal of empty elements.

Fixes #27

Author: jaylinski

.travis.yml

@@ -9,8 +9,9 @@ before_script:
   - travis_retry composer install --prefer-source --no-interaction --dev
 
 script:
-  - vendor/bin/php-cs-fixer fix src --dry-run --rules=@PSR2
-  - vendor/bin/phpspec run --no-interaction --verbose
+  - composer run lint-ci
+  - composer run test-ci
+  - composer run analyse
 
 after_success:
   - bash <(curl -s https://codecov.io/bash)

composer.json

@@ -19,7 +19,8 @@
     "require-dev": {
         "friends-of-phpspec/phpspec-code-coverage": "^5.0",
         "friendsofphp/php-cs-fixer": "^2.14",
-        "phpspec/phpspec": "^6.1"
+        "phpspec/phpspec": "^6.1",
+        "phpstan/phpstan": "^0.12.57"
     },
     "autoload": {
         "psr-4": {
@@ -28,7 +29,10 @@
     },
     "scripts": {
         "test": "phpspec run --ansi",
-        "lint": "php-cs-fixer fix src --rules=@PSR2"
+        "test-ci": "phpspec run --no-interaction --verbose",
+        "lint": "php-cs-fixer fix src --rules=@PSR2",
+        "lint-ci": "php-cs-fixer fix src --dry-run --rules=@PSR2",
+        "analyse": "phpstan analyse --level 4 src"
     },
     "config": {
         "platform": {

composer.lock

@@ -2,6 +2,7 @@
 
 namespace spec\XmlTv;
 
+use XmlTv\Exceptions\ValidationException;
 use XmlTv\Tv;
 use XmlTv\XmlElement;
 use XmlTv\XmlTv;
@@ -21,7 +22,25 @@ function it_generates_an_xml_file_from_an_empty_tv_object()
         $this->generate(new Tv(), false)->shouldReturn($xml);
     }
 
-    function it_generates_an_xml_file()
+    function it_generates_a_basic_xml_file()
+    {
+        $xml = file_get_contents(__DIR__.'/../epg-basic.xml');
+
+        $tv = new Tv();
+        $channel = new Tv\Channel('test');
+        $channel->addDisplayName(new Tv\Elements\DisplayName('foo'));
+        $programme = new Tv\Programme('test', '1', '2');
+        $programme->addTitle(new Tv\Elements\Title('bar'));
+        $programme->video = new Tv\Elements\Video('yes');
+        $programme->audio = new Tv\Elements\Audio('no');
+
+        $tv->addChannel($channel);
+        $tv->addProgramme($programme);
+
+        $this->generate($tv, false)->shouldReturn($xml);
+    }
+
+    function it_generates_a_xml_file()
     {
         $xml = file_get_contents(__DIR__.'/../epg.xml');
         $date = gmdate(Tv::DATE_FORMAT, 100000);
@@ -85,12 +104,19 @@ function it_generates_an_xml_file()
 
     function it_throws_if_the_generated_xml_does_not_validate()
     {
-        $this->shouldThrow('XmlTv\Exceptions\ValidationException')->duringGenerate(new InvalidTv(), true);
+        $this->shouldThrow(ValidationException::class)->duringGenerate(new InvalidTv(), true);
     }
 
-    function it_triggers_a_warning_if_an_element_cannot_be_serialized()
+    function it_throws_if_an_element_cannot_be_serialized()
     {
-        $this->shouldTrigger(E_USER_WARNING)->duringGenerate(new UnserializableChild(), false);
+        $this->shouldThrow(\TypeError::class)->duringGenerate(new UnserializableChild(), false);
+    }
+
+    function it_provides_support_for_legacy_code()
+    {
+        $xml = '<?xml version="1.0"?>' . PHP_EOL . '<tv/>' . PHP_EOL;
+
+        $this->generate(new LegacyMethods(), false)->shouldReturn($xml);
     }
 }
 
@@ -108,6 +134,15 @@ class UnserializableChild extends Tv
     public function xmlSerialize(): XmlElement
     {
         return (new XmlElement('tv'))
-            ->withOptionalChild(new \stdClass());
+            ->withChild(new \stdClass());
+    }
+}
+
+class LegacyMethods extends Tv
+{
+    public function xmlSerialize(): XmlElement
+    {
+        return (new XmlElement('tv'))
+            ->withOptionalChild(new XmlElement('foo'));
     }
 }

spec/XmlTv/XmlTvSpec.php

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<tv generator-info-name="jaylinski/xmltv" generator-info-url="https://github.com/jaylinski/xmltv">
+  <channel id="test">
+    <display-name>foo</display-name>
+  </channel>
+  <programme channel="test" start="1" stop="2">
+    <title>bar</title>
+    <video>
+      <present>yes</present>
+    </video>
+    <audio>
+      <present>no</present>
+    </audio>
+  </programme>
+</tv>

spec/epg-basic.xml

@@ -58,9 +58,6 @@ public function __construct(string $date = '', string $sourceInfoUrl = '', strin
         $this->sourceDataUrl = $sourceDataUrl;
     }
 
-    /**
-     * @param Channel $channel
-     */
     public function addChannel(Channel $channel): void
     {
         array_push($this->channel, $channel);
@@ -74,9 +71,6 @@ public function getChannels(): array
         return $this->channel;
     }
 
-    /**
-     * @param Programme $programme
-     */
     public function addProgramme(Programme $programme): void
     {
         array_push($this->programme, $programme);

src/Tv.php

@@ -30,11 +30,6 @@ class Channel implements XmlSerializable
      */
     private $url = [];
 
-    /**
-     * Channel constructor.
-     *
-     * @param string $id
-     */
     public function __construct(string $id)
     {
         $this->id = $id;

src/Tv/Channel.php

@@ -33,7 +33,7 @@ public function __construct(string $present = '', string $stereo = '')
     public function xmlSerialize(): XmlElement
     {
         return (new XmlElement('audio'))
-            ->withOptionalChild(new XmlElement('present', $this->present))
-            ->withOptionalChild(new XmlElement('stereo', $this->stereo));
+            ->withChild(new XmlElement('present', $this->present))
+            ->withChild(new XmlElement('stereo', $this->stereo));
     }
 }

src/Tv/Elements/Audio.php

@@ -31,6 +31,6 @@ public function xmlSerialize(): XmlElement
     {
         return (new XmlElement('subtitles'))
             ->withAttribute('type', $this->type)
-            ->withOptionalChild($this->language);
+            ->withChild($this->language);
     }
 }

src/Tv/Elements/Subtitles.php

@@ -46,9 +46,9 @@ public function __construct(string $present = '', string $colour = '', string $a
     public function xmlSerialize(): XmlElement
     {
         return (new XmlElement('video'))
-            ->withOptionalChild(new XmlElement('present', $this->present))
-            ->withOptionalChild(new XmlElement('colour', $this->colour))
-            ->withOptionalChild(new XmlElement('aspect', $this->aspect))
-            ->withOptionalChild(new XmlElement('quality', $this->quality));
+            ->withChild(new XmlElement('present', $this->present))
+            ->withChild(new XmlElement('colour', $this->colour))
+            ->withChild(new XmlElement('aspect', $this->aspect))
+            ->withChild(new XmlElement('quality', $this->quality));
     }
 }