OpenWeatherMapTest::tearDown() - Code Metrics - Inspection of "Version 3 Update" - cmfcmf/OpenWeatherMap-PHP-API - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#134)

by Christian

created 2019-06-01 16:38 UTC

OpenWeatherMapTest::tearDown() A

↳ Parent: OpenWeatherMapTest

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0
cc	2
nc	2
nop	0

<?php
/**
 * Copyright Zikula Foundation 2014 - Zikula Application Framework
 *
 * This work is contributed to the Zikula Foundation under one or more
 * Contributor Agreements and licensed to You under the following license:
 *
 * @license GNU/LGPv3 (or at your option any later version).
 * @package OpenWeatherMap-PHP-Api
 *
 * Please see the NOTICE file distributed with this source code for further
 * information regarding copyright and licensing.
 */

namespace Cmfcmf\OpenWeatherMap\Tests\OpenWeatherMap;

use Cmfcmf\OpenWeatherMap;
use Cmfcmf\OpenWeatherMap\Exception;
use Cmfcmf\OpenWeatherMap\Tests\TestHttpClient;
use Cache\Adapter\PHPArray\ArrayCachePool;
use Http\Factory\Guzzle\RequestFactory;
use Http\Adapter\Guzzle6\Client as GuzzleAdapter;
use Psr\SimpleCache\CacheInterface;

class OpenWeatherMapTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var string
     */
    protected $apiKey;

    /**
     * @var OpenWeatherMap
     */
    protected $owm;

    /**
     * @var OpenWeatherMap
     */
    protected $openWeather;

    /**
     * @var CacheInterface
     */
    protected $cache;

    /**
     * @var TestHttpClient
     */
    protected $httpClient;

    protected function setUp()
    {
        $ini = parse_ini_file(__DIR__.'/../Examples/ApiKey.ini');
        $this->apiKey = $ini['api_key'];
        $this->httpClient = new TestHttpClient();
        $this->owm = new OpenWeatherMap($this->apiKey, $this->httpClient, new RequestFactory());
        $this->openWeather = new OpenWeatherMap($this->apiKey, GuzzleAdapter::createWithConfig([]), new RequestFactory());
        $this->cache =  new ArrayCachePool();
    }

    public function testApiKeyNotNull()
    {
        $weather = $this->owm;
        $apiKey = $weather->getApiKey();

        $this->assertSame($this->apiKey, $apiKey);
    }

    public function testSetApiKey()
    {
        $weather = $this->owm;
        $weather->setApiKey($this->apiKey);
        $apiKey = $weather->getApiKey();

        $this->assertSame($this->apiKey, $apiKey);
    }

    public function testGetApiKey()
    {
        $weather = $this->owm;
        $apiKey = $weather->getApiKey();

        $this->assertSame($this->apiKey, $apiKey);
    }

    /**
     * @expectedException \Cmfcmf\OpenWeatherMap\Exception
     */
    public function testInvalidData()
    {
        $this->httpClient->returnErrorForNextRequest(500);
        $this->owm->getWeather('Berlin', 'imperial', 'en', '');
    }

    public function testGetWeather()
    {
        $currentWeather = $this->owm->getWeather('Berlin', 'imperial', 'en', '');

        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeather', $currentWeather);
    }

    public function testGetWeatherGroup()
    {
        $currentWeather = $this->owm->getWeatherGroup(array('2950159'), 'imperial', 'en', '');
        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeatherGroup', $currentWeather);

        $currentWeather = $this->owm->getWeatherGroup('2950159', 'imperial', 'en', '');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeatherGroup', $currentWeather);
    }

    public function testGetWeatherForecast()
    {
        $days = 1;
        $defaultDay = $this->owm->getWeatherForecast('Berlin', 'imperial', 'en', '', $days);

        $days = 16;
        $maxDay = $this->owm->getWeatherForecast('Berlin', 'imperial', 'en', '', $days);

        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $defaultDay);
        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $maxDay);
    }

    public function testGetCurrentUVIndex()
    {
        $owm = $this->openWeather;
        $result = $owm->getCurrentUVIndex(40.7, -74.2);
        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
    }

    public function testGetForecastUVIndex()
    {
        $owm = $this->openWeather;

        try {
            $result = $owm->getForecastUVIndex(40.7, -74.2, 5);
        } catch (Exception $e) {
            // OWM might not actually have data for the timespan.
            $this->assertSame('An error occurred: not found', $e->getMessage());
        }
        $this->assertContainsOnlyInstancesOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
    }

    public function testGetHistoryUVIndex()
    {
        $owm = $this->openWeather;

        try {
            $start = new \DateTime('1969-08-15');
            $end = new \DateTime('1969-08-18');
            $result = $owm->getHistoricUVIndex(40.7, -74.2, $start, $end);
        } catch (Exception $e) {
            // OWM might not actually have data for the timespan.
            $this->assertSame('An error occurred: not found', $e->getMessage());
        }
        $this->assertContainsOnlyInstancesOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

    public function testGetDailyWeatherForecast()
    {
        $days = 16;
        $dailyForecast = $this->owm->getDailyWeatherForecast('Berlin', 'imperial', 'en', '', $days);

        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $dailyForecast);
    }

    public function testGetWeatherHistory()
    {
        $this->markTestSkipped('This getWeatherHistory method ignored because the api key need to have a paid permission.');
    }

    public function testWasCached()
    {
        $weather = $this->owm;
        $result = $weather->wasCached();

        $this->assertFalse($result);
    }

    public function testCached()
    {
        $weather = new OpenWeatherMap($this->apiKey, new TestHttpClient(), new RequestFactory(), $this->cache, 600);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $currWeatherData = $weather->getRawWeatherData('Berlin', 'imperial', 'en', $this->apiKey, 'xml');
        $this->assertFalse($weather->wasCached());
        $cachedWeatherData = $weather->getRawWeatherData('Berlin', 'imperial', 'en', $this->apiKey, 'xml');
        $this->assertTrue($weather->wasCached());

        $this->assertInternalType('string', $currWeatherData);
        $this->assertInternalType('string', $cachedWeatherData);
        $this->assertSame($currWeatherData, $cachedWeatherData);
    }

    public function testBuildQueryUrlParameter()
    {
        $weather = $this->owm;
        $queryWithNumbericArray = $weather->getWeather(array('2950159'), 'imperial', 'en', '');
        $queryWithLatLonArray = $weather->getWeather(array('lat' => 52.524368, 'lon' => 13.410530), 'imperial', 'en', '');

        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeather', $queryWithNumbericArray);
        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeather', $queryWithLatLonArray);
    }
}


1			<?php
2			/**
3			* Copyright Zikula Foundation 2014 - Zikula Application Framework
4			*
5			* This work is contributed to the Zikula Foundation under one or more
6			* Contributor Agreements and licensed to You under the following license:
7			*
8			* @license GNU/LGPv3 (or at your option any later version).
9			* @package OpenWeatherMap-PHP-Api
10			*
11			* Please see the NOTICE file distributed with this source code for further
12			* information regarding copyright and licensing.
13			*/
14
15			namespace Cmfcmf\OpenWeatherMap\Tests\OpenWeatherMap;
16
17			use Cmfcmf\OpenWeatherMap;
18			use Cmfcmf\OpenWeatherMap\Exception;
19			use Cmfcmf\OpenWeatherMap\Tests\TestHttpClient;
20			use Cache\Adapter\PHPArray\ArrayCachePool;
21			use Http\Factory\Guzzle\RequestFactory;
22			use Http\Adapter\Guzzle6\Client as GuzzleAdapter;
23			use Psr\SimpleCache\CacheInterface;
24
25			class OpenWeatherMapTest extends \PHPUnit_Framework_TestCase
26			{
27			/**
28			* @var string
29			*/
30			protected $apiKey;
31
32			/**
33			* @var OpenWeatherMap
34			*/
35			protected $owm;
36
37			/**
38			* @var OpenWeatherMap
39			*/
40			protected $openWeather;
41
42			/**
43			* @var CacheInterface
44			*/
45			protected $cache;
46
47			/**
48			* @var TestHttpClient
49			*/
50			protected $httpClient;
51
52			protected function setUp()
53			{
54			$ini = parse_ini_file(__DIR__.'/../Examples/ApiKey.ini');
55			$this->apiKey = $ini['api_key'];
56			$this->httpClient = new TestHttpClient();
57			$this->owm = new OpenWeatherMap($this->apiKey, $this->httpClient, new RequestFactory());
58			$this->openWeather = new OpenWeatherMap($this->apiKey, GuzzleAdapter::createWithConfig([]), new RequestFactory());
59			$this->cache = new ArrayCachePool();
60			}
61
62			public function testApiKeyNotNull()
63			{
64			$weather = $this->owm;
65			$apiKey = $weather->getApiKey();
66
67			$this->assertSame($this->apiKey, $apiKey);
68			}
69
70			public function testSetApiKey()
71			{
72			$weather = $this->owm;
73			$weather->setApiKey($this->apiKey);
74			$apiKey = $weather->getApiKey();
75
76			$this->assertSame($this->apiKey, $apiKey);
77			}
78
79			public function testGetApiKey()
80			{
81			$weather = $this->owm;
82			$apiKey = $weather->getApiKey();
83
84			$this->assertSame($this->apiKey, $apiKey);
85			}
86
87			/**
88			* @expectedException \Cmfcmf\OpenWeatherMap\Exception
89			*/
90			public function testInvalidData()
91			{
92			$this->httpClient->returnErrorForNextRequest(500);
93			$this->owm->getWeather('Berlin', 'imperial', 'en', '');
94			}
95
96			public function testGetWeather()
97			{
98			$currentWeather = $this->owm->getWeather('Berlin', 'imperial', 'en', '');
99
100			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeather', $currentWeather);
101			}
102
103			public function testGetWeatherGroup()
104			{
105			$currentWeather = $this->owm->getWeatherGroup(array('2950159'), 'imperial', 'en', '');
106			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeatherGroup', $currentWeather);
107
108			$currentWeather = $this->owm->getWeatherGroup('2950159', 'imperial', 'en', '');
			0 ignored issues – show Documentation introduced 2016-12-30 20:39 UTC by Report Bug Copy Issue Report `'2950159'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
109			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeatherGroup', $currentWeather);
110			}
111
112			public function testGetWeatherForecast()
113			{
114			$days = 1;
115			$defaultDay = $this->owm->getWeatherForecast('Berlin', 'imperial', 'en', '', $days);
116
117			$days = 16;
118			$maxDay = $this->owm->getWeatherForecast('Berlin', 'imperial', 'en', '', $days);
119
120			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $defaultDay);
121			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $maxDay);
122			}
123
124			public function testGetCurrentUVIndex()
125			{
126			$owm = $this->openWeather;
127			$result = $owm->getCurrentUVIndex(40.7, -74.2);
128			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
129			}
130
131			public function testGetForecastUVIndex()
132			{
133			$owm = $this->openWeather;
134
135			try {
136			$result = $owm->getForecastUVIndex(40.7, -74.2, 5);
137			} catch (Exception $e) {
138			// OWM might not actually have data for the timespan.
139			$this->assertSame('An error occurred: not found', $e->getMessage());
140			}
141			$this->assertContainsOnlyInstancesOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
142			}
143
144			public function testGetHistoryUVIndex()
145			{
146			$owm = $this->openWeather;
147
148			try {
149			$start = new \DateTime('1969-08-15');
150			$end = new \DateTime('1969-08-18');
151			$result = $owm->getHistoricUVIndex(40.7, -74.2, $start, $end);
152			} catch (Exception $e) {
153			// OWM might not actually have data for the timespan.
154			$this->assertSame('An error occurred: not found', $e->getMessage());
155			}
156			$this->assertContainsOnlyInstancesOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
			0 ignored issues – show Bug introduced 2019-05-07 07:34 UTC by Report Bug Copy Issue Report The variable `$result` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
157			}
158
159			public function testGetDailyWeatherForecast()
160			{
161			$days = 16;
162			$dailyForecast = $this->owm->getDailyWeatherForecast('Berlin', 'imperial', 'en', '', $days);
163
164			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $dailyForecast);
165			}
166
167			public function testGetWeatherHistory()
168			{
169			$this->markTestSkipped('This getWeatherHistory method ignored because the api key need to have a paid permission.');
170			}
171
172			public function testWasCached()
173			{
174			$weather = $this->owm;
175			$result = $weather->wasCached();
176
177			$this->assertFalse($result);
178			}
179
180			public function testCached()
181			{
182			$weather = new OpenWeatherMap($this->apiKey, new TestHttpClient(), new RequestFactory(), $this->cache, 600);
			0 ignored issues – show Documentation introduced 2019-06-01 15:35 UTC by Report Bug Copy Issue Report `$this->cache` is of type `object<Psr\SimpleCache\CacheInterface>`, but the function expects a `null\|object<Psr\Cache\CacheItemPoolInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
183			$currWeatherData = $weather->getRawWeatherData('Berlin', 'imperial', 'en', $this->apiKey, 'xml');
184			$this->assertFalse($weather->wasCached());
185			$cachedWeatherData = $weather->getRawWeatherData('Berlin', 'imperial', 'en', $this->apiKey, 'xml');
186			$this->assertTrue($weather->wasCached());
187
188			$this->assertInternalType('string', $currWeatherData);
189			$this->assertInternalType('string', $cachedWeatherData);
190			$this->assertSame($currWeatherData, $cachedWeatherData);
191			}
192
193			public function testBuildQueryUrlParameter()
194			{
195			$weather = $this->owm;
196			$queryWithNumbericArray = $weather->getWeather(array('2950159'), 'imperial', 'en', '');
197			$queryWithLatLonArray = $weather->getWeather(array('lat' => 52.524368, 'lon' => 13.410530), 'imperial', 'en', '');
198
199			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeather', $queryWithNumbericArray);
200			$this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\CurrentWeather', $queryWithLatLonArray);
201			}
202			}
203

cmfcmf / OpenWeatherMap-PHP-API

Pull Request — master (#134)

OpenWeatherMapTest::tearDown() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like