Skip to content

Commit 545a5de

Browse files
authored
Merge pull request #199 from splitio/maintenance/linting
replaced setMethods and doc
2 parents bffeba0 + cd81457 commit 545a5de

40 files changed

+57
-103
lines changed

src/SplitIO/Component/Cache/ImpressionCache.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
namespace SplitIO\Component\Cache;
33

44
use SplitIO\Component\Common\Context;
5-
use SplitIO\Component\Cache\KeyFactory;
65
use SplitIO\Sdk\QueueMetadataMessage;
76
use SplitIO\Component\Cache\Pool;
87

src/SplitIO/Component/Cache/SplitCache.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ private static function getSplitNameFromCacheKey($key)
4444
}
4545

4646
/**
47-
* @return long
47+
* @return int
4848
*/
4949
public function getChangeNumber()
5050
{
@@ -64,7 +64,7 @@ public function getSplit($splitName)
6464

6565
/**
6666
* @param array $splitNames
67-
* @return string JSON representation
67+
* @return array
6868
*/
6969
public function getSplits($splitNames)
7070
{

src/SplitIO/Component/Cache/SplitCacheInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
interface SplitCacheInterface
55
{
66
/**
7-
* @return long
7+
* @return int
88
*/
99
public function getChangeNumber();
1010

src/SplitIO/Component/Cache/Storage/Adapter/PRedis.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
namespace SplitIO\Component\Cache\Storage\Adapter;
33

44
use SplitIO\Component\Cache\Storage\Exception\AdapterException;
5-
use SplitIO\Component\Cache\Item;
65
use SplitIO\Component\Utils as SplitIOUtils;
76
use SplitIO\Component\Common\Context;
87

src/SplitIO/Component/Cache/Storage/Adapter/SafeRedisWrapper.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
<?php
22
namespace SplitIO\Component\Cache\Storage\Adapter;
33

4-
use SplitIO\Component\Cache\Storage\Exception\AdapterException;
5-
use SplitIO\Component\Cache\Item;
6-
use SplitIO\Component\Utils as SplitIOUtils;
74
use SplitIO\Component\Common\Context;
85

96
/**

src/SplitIO/Component/Common/Context.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ class Context
1818
. "Make sure you definitely want this additional instance. We recommend keeping only one instance of "
1919
. "the factory at all times (Singleton pattern) and reusing it throughout your application.";
2020

21-
private \SplitIO\Component\Log\Logger $logger;
21+
private Logger $logger;
2222

2323
private array $factoryTracker = array();
2424

2525
private string $ipAddress = "";
2626

2727
/**
28-
* @var Singleton The reference to *Singleton* instance of this class
28+
* @var Context The reference to *Singleton* instance of this class
2929
*/
3030
private static $instance;
3131

src/SplitIO/Component/Initialization/LoggerFactory.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class LoggerFactory
1616
* Builds defaultLogger
1717
*
1818
* @param $options
19-
* @return SplitIO\Component\Log\Handler
19+
* @return \SplitIO\Component\Log\Handler\LogHandlerInterface
2020
*/
2121
private static function buildAdapter(array $options)
2222
{
@@ -42,7 +42,7 @@ private static function buildAdapter(array $options)
4242
* Builds logger
4343
*
4444
* @param $options
45-
* @return SplitIO\Component\Log\Logger
45+
* @return \SplitIO\Component\Log\Logger
4646
*/
4747
public static function setupLogger(array $options)
4848
{

src/SplitIO/Component/Log/Logger.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<?php
22
namespace SplitIO\Component\Log;
33

4-
use Psr\Log\LoggerInterface;
54
use Psr\Log\LogLevel;
65
use \SplitIO\Component\Log\Handler\LogHandlerInterface;
76
use SplitIO\Component\Log\Handler\VoidHandler;

src/SplitIO/Engine.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
namespace SplitIO;
33

44
use SplitIO\Grammar\Split as SplitGrammar;
5-
use SplitIO\Grammar\Condition;
65
use SplitIO\Engine\Splitter;
76
use SplitIO\Grammar\Condition\ConditionTypeEnum;
87
use SplitIO\Sdk\Impressions\ImpressionLabel;

src/SplitIO/Engine/Hash/HashFactory.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ class HashFactory
66
{
77
/**
88
* @param $algo
9-
* @return \SplitIO\Engine\HashInterface
9+
* @return \SplitIO\Engine\Hash\HashInterface
1010
*/
1111
public static function getHashAlgorithm($algo)
1212
{

src/SplitIO/Engine/Splitter.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
class Splitter
99
{
1010
/**
11-
* @param HashAlgorithmEnum $algo
11+
* @param \SplitIO\Engine\Hash\HashAlgorithmEnum $algo
1212
* @param string $key
13-
* @param long $seed
13+
* @param int $seed
1414
* @return int
1515
*/
1616
public static function getBucket($algo, $key, $seed)
@@ -23,9 +23,9 @@ public static function getBucket($algo, $key, $seed)
2323

2424
/**
2525
* @param string $key
26-
* @param long $seed
26+
* @param int $seed
2727
* @param array $partitions
28-
* @param HashAlgorithmEnum $algo
28+
* @param \SplitIO\Engine\Hash\HashAlgorithmEnum $algo
2929
* @return null|string
3030
*/
3131
public static function getTreatment($key, $seed, $partitions, $algo)

src/SplitIO/Grammar/Condition/Matcher/Dependency.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
namespace SplitIO\Grammar\Condition\Matcher;
33

44
use SplitIO\Grammar\Condition\Matcher;
5-
use SplitIO\Sdk\Key;
65
use SplitIO\Exception\Exception;
76

87
class Dependency

src/SplitIO/Grammar/Condition/Matcher/Segment.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<?php
22
namespace SplitIO\Grammar\Condition\Matcher;
33

4-
use SplitIO\Component\Cache\SegmentCache;
54
use SplitIO\Engine\Hash\Murmur3Hash;
65
use SplitIO\Grammar\Condition\Matcher;
76
use SplitIO\Exception\Exception;

src/SplitIO/Grammar/Split.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ public function getTreatments()
146146
}
147147

148148
/**
149-
* @return HashAlgorithmEnum
149+
* @return \SplitIO\Engine\Hash\HashAlgorithmEnum
150150
*/
151151
public function getAlgo()
152152
{

src/SplitIO/Sdk.php

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
<?php
22
namespace SplitIO;
33

4-
use SplitIO\Component\Initialization\CacheTrait;
54
use SplitIO\Component\Initialization\LoggerFactory;
6-
use SplitIO\Component\Common\ServiceProvider;
75
use SplitIO\Exception\Exception;
86
use SplitIO\Sdk\Factory\LocalhostSplitFactory;
97
use SplitIO\Sdk\Factory\SplitFactory;
108
use SplitIO\Component\Common\Context;
11-
use SplitIO\Engine\Splitter;
129
use SplitIO\Component\Cache\Pool;
1310

1411
class Sdk
@@ -88,6 +85,6 @@ private static function configureCache(array $options)
8885

8986
private static function setIP($ip)
9087
{
91-
\SplitIO\Component\Common\Context::setIPAddress($ip);
88+
Context::setIPAddress($ip);
9289
}
9390
}

src/SplitIO/Sdk/Factory/SplitFactory.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
<?php
22
namespace SplitIO\Sdk\Factory;
33

4-
use SplitIO\Component\Stats\Latency;
5-
use SplitIO\Exception\TimeOutException;
64
use SplitIO\Sdk\Client;
7-
use SplitIO\Sdk\LocalhostClient;
85
use SplitIO\Sdk\Manager\SplitManager;
96
use SplitIO\Component\Cache\Pool;
107
use SplitIO\Component\Cache\EventsCache;

src/SplitIO/Sdk/Manager/LocalhostSplitManager.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,11 @@ public function splits()
7474
return $_splits;
7575
}
7676

77+
/**
78+
* Return split
79+
* @param mixed $featureName
80+
* @return SplitView|null
81+
*/
7782
public function split($featureName)
7883
{
7984
$featureName = InputValidator::validateFeatureName($featureName, 'split');

src/SplitIO/Sdk/Manager/SplitManager.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
namespace SplitIO\Sdk\Manager;
33

44
use \stdClass;
5-
use SplitIO\Grammar\Condition;
65
use SplitIO\Grammar\Split;
76
use SplitIO\Split as SplitApp;
87
use SplitIO\Component\Cache\SplitCache;
@@ -57,7 +56,7 @@ public function split($featureName)
5756

5857
/**
5958
* @param $splitRepresentation
60-
* @return SplitView
59+
* @return null|SplitView
6160
*/
6261
private static function parseSplitView($splitRepresentation)
6362
{

src/SplitIO/Sdk/Validator/InputValidator.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
use SplitIO\Split as SplitApp;
66
use SplitIO\Sdk\Key;
77
use SplitIO\Component\Utils as SplitIOUtils;
8-
use SplitIO\Component\Cache\SplitCache;
9-
use SplitIO\Grammar\Condition\Partition\TreatmentEnum;
108
use SplitIO\Sdk\Impressions\ImpressionLabel;
119

1210
const MAX_LENGTH = 250;

src/SplitIO/Split.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ class Split
77
{
88

99
/**
10-
* @return null|\Psr\Log\LoggerInterface
10+
* @return \Splitio\Component\Log\Logger
1111
*/
1212
public static function logger()
1313
{

src/SplitIO/functions.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
<?php
22
namespace SplitIO;
33

4-
use SplitIO\Grammar\Condition\Partition\TreatmentEnum;
5-
64
function version()
75
{
86
return Version::CURRENT;

tests/Suite/Adapter/RedisAdapterTest.php

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
namespace SplitIO\Test\Suite\Adapter;
44

55
use SplitIO\Component\Cache\Storage\Adapter\PRedis;
6-
use SplitIO\Component\Cache\Storage\Exception\AdapterException;
7-
use \Predis\Response\ServerException;
8-
use \Predis\ClientException;
96
use SplitIO\Test\Suite\Redis\ReflectiveTools;
107

118
class RedisAdapterTest extends \PHPUnit\Framework\TestCase
@@ -16,8 +13,8 @@ private function getMockedLogger()
1613
$logger = $this
1714
->getMockBuilder('\SplitIO\Component\Log\Logger')
1815
->disableOriginalConstructor()
19-
->setMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
20-
'alert', 'notice', 'write', 'log'))
16+
->onlyMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
17+
'alert', 'notice', 'log'))
2118
->getMock();
2219

2320
ReflectiveTools::overrideLogger($logger);

tests/Suite/Attributes/SdkAttributesTest.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
<?php
22
namespace SplitIO\Test\Suite\Engine;
33

4-
use Monolog\Logger;
5-
use Monolog\Handler\ErrorLogHandler;
6-
use SplitIO\Component\Cache\SegmentCache;
7-
use SplitIO\Component\Cache\SplitCache;
8-
94
use SplitIO\Test\Utils;
105

116
class SdkAttributesTest extends \PHPUnit\Framework\TestCase

tests/Suite/Component/KeysStaticMethodsTest.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22

33
namespace SplitIO\Test\Suite\Component;
44

5-
use SplitIO\Component\Cache\ImpressionCache;
65
use SplitIO\Component\Cache\SplitCache;
7-
use SplitIO\Component\Cache\SegmentCache;
8-
use SplitIO\Component\Cache\TrafficTypeCache;
96

107
class KeyTest extends \PHPUnit\Framework\TestCase
118
{

tests/Suite/Component/TrafficTypeTests.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ private function getMockedLogger()
1313
$logger = $this
1414
->getMockBuilder('\SplitIO\Component\Log\Logger')
1515
->disableOriginalConstructor()
16-
->setMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
16+
->onlyMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
1717
'alert', 'notice', 'write', 'log'))
1818
->getMock();
1919

@@ -42,10 +42,11 @@ public function testTrafficTypeWarning()
4242

4343
$this->assertEquals($keyTrafficType, 'SPLITIO.trafficType.abc');
4444

45-
$redisClient = ReflectiveTools::clientFromCachePool(Context::getCache());
45+
$redisClient = ReflectiveTools::clientFromFactory($splitFactory);
46+
$cachePool = ReflectiveTools::cacheFromFactory($splitFactory);
4647
$redisClient->del($keyTrafficType);
4748

48-
$splitCache = new SplitCache();
49+
$splitCache = new SplitCache($cachePool);
4950

5051
$this->assertEquals($splitCache->trafficTypeExists("abc"), false);
5152

tests/Suite/DynamicConfigurations/EvaluatorTest.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
use SplitIO\Test\Suite\Redis\ReflectiveTools;
55
use SplitIO\Component\Cache\SplitCache;
66
use SplitIO\Component\Cache\SegmentCache;
7-
use SplitIO\Grammar\Split;
87
use SplitIO\Sdk\Evaluator;
98

109
class EvaluatorTest extends \PHPUnit\Framework\TestCase

tests/Suite/Engine/SplitterTest.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,9 @@
22
namespace SplitIO\Test\Suite\Engine;
33

44
use SplitIO\Component\Initialization\LoggerFactory;
5-
use SplitIO\Component\Common\ServiceProvider;
6-
use SplitIO\Component\Log\LogLevelEnum;
75
use SplitIO\Engine\Splitter;
86
use SplitIO\Grammar\Condition\Partition;
97
use SplitIO\Engine\Hash\HashAlgorithmEnum;
10-
use SplitIO\Grammar\Split;
11-
use SplitIO\Engine;
128
use SplitIO\Component\Common\Context;
139

1410
class SplitterTest extends \PHPUnit\Framework\TestCase

tests/Suite/InputValidation/FactoryTrackerTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ private function getMockedLogger()
1111
$logger = $this
1212
->getMockBuilder('\SplitIO\Component\Log\Logger')
1313
->disableOriginalConstructor()
14-
->setMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
15-
'alert', 'notice', 'write', 'log'))
14+
->onlyMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
15+
'alert', 'notice', 'log'))
1616
->getMock();
1717

1818
ReflectiveTools::overrideLogger($logger);

tests/Suite/InputValidation/GetTreatmentValidationTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ private function getMockedLogger()
3232
$logger = $this
3333
->getMockBuilder('\SplitIO\Component\Log\Logger')
3434
->disableOriginalConstructor()
35-
->setMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
36-
'alert', 'notice', 'write', 'log'))
35+
->onlyMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
36+
'alert', 'notice', 'log'))
3737
->getMock();
3838

3939
ReflectiveTools::overrideLogger($logger);

tests/Suite/InputValidation/GetTreatmentsValidationTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ private function getMockedLogger()
3232
$logger = $this
3333
->getMockBuilder('\SplitIO\Component\Log\Logger')
3434
->disableOriginalConstructor()
35-
->setMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
36-
'alert', 'notice', 'write', 'log'))
35+
->onlyMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
36+
'alert', 'notice', 'log'))
3737
->getMock();
3838

3939
ReflectiveTools::overrideLogger($logger);

tests/Suite/InputValidation/ManagerValidationTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ private function getMockedLogger()
2929
$logger = $this
3030
->getMockBuilder('\SplitIO\Component\Log\Logger')
3131
->disableOriginalConstructor()
32-
->setMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
33-
'alert', 'notice', 'write', 'log'))
32+
->onlyMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
33+
'alert', 'notice', 'log'))
3434
->getMock();
3535

3636
ReflectiveTools::overrideLogger($logger);

tests/Suite/InputValidation/TrackValidationTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ private function getMockedLogger()
3232
$logger = $this
3333
->getMockBuilder('\SplitIO\Component\Log\Logger')
3434
->disableOriginalConstructor()
35-
->setMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
36-
'alert', 'notice', 'write', 'log'))
35+
->onlyMethods(array('warning', 'debug', 'error', 'info', 'critical', 'emergency',
36+
'alert', 'notice', 'log'))
3737
->getMock();
3838

3939
ReflectiveTools::overrideLogger($logger);

0 commit comments

Comments
 (0)