StringsTest.php$1 ➔ translateValue() - Code Metrics - Inspection of "Merge pull request #7 from chadicus/master" - traderinteractive/filter-strings-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fb1f20...81c4ba )

by Chad

created 2019-02-21 14:36 UTC

StringsTest.php$1 ➔ translateValue() A

↳ Parent: StringsTest

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
cc	1
rs	10

<?php

namespace TraderInteractive\Filter;

use InvalidArgumentException;
use PHPUnit\Framework\TestCase;
use TraderInteractive\Exceptions\FilterException;

/**
 * @coversDefaultClass \TraderInteractive\Filter\Strings
 * @covers ::<private>
 */
final class StringsTest extends TestCase
{
    /**
     * Verify basic use of filter
     *
     * @test
     * @covers ::filter
     * @dataProvider filterData
     *
     * @param mixed $input    The input.
     * @param mixed $expected The expected value(s).
     *
     * @return void
     * @throws FilterException
     */
    public function filter($input, $expected)
    {
        $this->assertSame($expected, Strings::filter($input));
    }

    /**
     * Data provider for basic filter tests
     *
     * @return array
     */
    public function filterData()
    {
        return [
            'string' => ['abc', 'abc'],
            'int' => [1, '1'],
            'float' => [1.1, '1.1'],
            'bool' => [true, '1'],
            'object' => [new \SplFileInfo(__FILE__), __FILE__],
        ];
    }

    /**
     * @test
     * @covers ::filter
     */
    public function filterNullPass()
    {
        $this->assertNull(Strings::filter(null, true));
    }

    /**
     * @test
     * @expectedException \TraderInteractive\Exceptions\FilterException
     * @expectedExceptionMessage Value failed filtering, $allowNull is set to false
     * @covers ::filter
     */
    public function filterNullFail()
    {
        Strings::filter(null);
    }

    /**
     * @test
     * @covers ::filter
     */
    public function filterMinLengthPass()
    {
        $this->assertSame('a', Strings::filter('a'));
    }

    /**
     * @test
     * @expectedException \TraderInteractive\Exceptions\FilterException
     * @covers ::filter
     */
    public function filterMinLengthFail()
    {
        Strings::filter('');
    }

    /**
     * @test
     * @covers ::filter
     */
    public function filterMaxLengthPass()
    {
        $this->assertSame('a', Strings::filter('a', false, 0, 1));
    }

    /**
     * @test
     * @expectedException \TraderInteractive\Exceptions\FilterException
     * @expectedExceptionMessage Value 'a' with length '1' is less than '0' or greater than '0'
     * @covers ::filter
     */
    public function filterMaxLengthFail()
    {
        Strings::filter('a', false, 0, 0);
    }

    /**
     * @test
     * @expectedException InvalidArgumentException
     * @expectedExceptionMessage $minLength was not a positive integer value
     * @covers ::filter
     */
    public function filterMinLengthNotInteger()
    {
        Strings::filter('a', false, -1);
    }

    /**
     * @test
     * @expectedException InvalidArgumentException
     * @expectedExceptionMessage $maxLength was not a positive integer value
     * @covers ::filter
     */
    public function filterMaxLengthNotInteger()
    {
        Strings::filter('a', false, 1, -1);
    }

    /**
     * @test
     * @expectedException InvalidArgumentException
     * @expectedExceptionMessage $minLength was not a positive integer value
     * @covers ::filter
     */
    public function filterMinLengthNegative()
    {
        Strings::filter('a', false, -1);
    }

    /**
     * @test
     * @expectedException InvalidArgumentException
     * @expectedExceptionMessage $maxLength was not a positive integer value
     * @covers ::filter
     */
    public function filterMaxLengthNegative()
    {
        Strings::filter('a', false, 1, -1);
    }

    /**
     * @test
     * @covers ::filter
     */
    public function filterWithScalar()
    {
        $this->assertSame('24141', Strings::filter(24141));
    }

    /**
     * @test
     * @covers ::filter
     */
    public function filterWithObject()
    {
        $testObject = new class() {
            private $data;

            public function __construct()
            {
                $this->data = [1,2,3,4,5];
            }

            public function __toString()
            {
                return implode(',', $this->data);
            }
        };

        $this->assertSame('1,2,3,4,5', Strings::filter(new $testObject));
    }

    /**
     * @test
     * @covers ::filter
     *
     * @expectedException \TraderInteractive\Exceptions\FilterException
     * @expectedExceptionMessage Value 'class@anonymous
     */
    public function filterWithObjectNoToStringMethod()
    {
        $testObject = new class() {
            private $data;

            public function __construct()
            {
                $this->data = [1, 2, 3, 4, 5];
            }
        };

        Strings::filter(new $testObject);
    }

    /**
     * @test
     * @covers ::translate
     */
    public function translateValue()
    {
        $map = ['foo' => '100', 'bar' => '200'];
        $this->assertSame('100', Strings::translate('foo', $map));
    }

    /**
     * @test
     * @covers ::translate
     * @expectedException \TraderInteractive\Exceptions\FilterException
     * @expectedExceptionMessage The value 'baz' was not found in the translation map array.
     */
    public function translateValueNotFoundInMap()
    {
        $map = ['foo' => '100', 'bar' => '200'];
        Strings::translate('baz', $map);
    }

    /**
     * Verifies basic explode functionality.
     *
     * @test
     * @covers ::explode
     */
    public function explode()
    {
        $this->assertSame(['a', 'bcd', 'e'], Strings::explode('a,bcd,e'));
    }

    /**
     * Verifies explode with a custom delimiter.
     *
     * @test
     * @covers ::explode
     */
    public function explodeCustomDelimiter()
    {
        $this->assertSame(['a', 'b', 'c', 'd,e'], Strings::explode('a b c d,e', ' '));
    }

    /**
     * @test
     * @expectedException \TraderInteractive\Exceptions\FilterException
     * @expectedExceptionMessage Value '1234' is not a string
     * @covers ::explode
     */
    public function explodeNonString()
    {
        Strings::explode(1234, '');
    }

    /**
     * Verifies explode filter with an empty delimiter.
     *
     * @test
     * @expectedException \InvalidArgumentException
     * @expectedExceptionMessage Delimiter '''' is not a non-empty string
     * @covers ::explode
     */
    public function explodeEmptyDelimiter()
    {
        Strings::explode('test', '');
    }

    /**
     * @test
     * @covers ::stripTags
     */
    public function stripTagsFromNullReturnsNull()
    {
        $this->assertNull(Strings::stripTags(null));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    /**
     * @test
     * @covers ::stripTags
     */
    public function stripTagsRemoveHtmlFromString()
    {
        $actual = Strings::stripTags('A string with <p>paragraph</p> tags');
        $expected = 'A string with paragraph tags';
        $this->assertSame($expected, $actual);
    }

    /**
     * @test
     * @covers ::concat
     */
    public function concat()
    {
        $this->assertSame('prefixstringsuffix', Strings::concat('string', 'prefix', 'suffix'));
    }

    /**
     * Verify behavior of concat() when $value is not filterable
     *
     * @test
     * @covers ::concat
     * @expectedException \TraderInteractive\Exceptions\FilterException
     *
     * @return void
     */
    public function concatValueNotFilterable()
    {
        Strings::concat(new \StdClass(), 'prefix', 'suffix');
    }

    /**
     * @test
     * @covers ::concat
     */
    public function concatScalarValue()
    {
        $this->assertSame('prefix123suffix', Strings::concat(123, 'prefix', 'suffix'));
    }

    /**
     * @test
     * @covers ::concat
     */
    public function concatObjectValue()
    {
        $this->assertSame('prefix' . __FILE__ . 'suffix', Strings::concat(new \SplFileInfo(__FILE__), 'prefix', 'suffix'));
    }
}


1			<?php
2
3			namespace TraderInteractive\Filter;
4
5			use InvalidArgumentException;
6			use PHPUnit\Framework\TestCase;
7			use TraderInteractive\Exceptions\FilterException;
8
9			/**
10			* @coversDefaultClass \TraderInteractive\Filter\Strings
11			* @covers ::<private>
12			*/
13			final class StringsTest extends TestCase
14			{
15			/**
16			* Verify basic use of filter
17			*
18			* @test
19			* @covers ::filter
20			* @dataProvider filterData
21			*
22			* @param mixed $input The input.
23			* @param mixed $expected The expected value(s).
24			*
25			* @return void
26			* @throws FilterException
27			*/
28			public function filter($input, $expected)
29			{
30			$this->assertSame($expected, Strings::filter($input));
31			}
32
33			/**
34			* Data provider for basic filter tests
35			*
36			* @return array
37			*/
38			public function filterData()
39			{
40			return [
41			'string' => ['abc', 'abc'],
42			'int' => [1, '1'],
43			'float' => [1.1, '1.1'],
44			'bool' => [true, '1'],
45			'object' => [new \SplFileInfo(__FILE__), __FILE__],
46			];
47			}
48
49			/**
50			* @test
51			* @covers ::filter
52			*/
53			public function filterNullPass()
54			{
55			$this->assertNull(Strings::filter(null, true));
56			}
57
58			/**
59			* @test
60			* @expectedException \TraderInteractive\Exceptions\FilterException
61			* @expectedExceptionMessage Value failed filtering, $allowNull is set to false
62			* @covers ::filter
63			*/
64			public function filterNullFail()
65			{
66			Strings::filter(null);
67			}
68
69			/**
70			* @test
71			* @covers ::filter
72			*/
73			public function filterMinLengthPass()
74			{
75			$this->assertSame('a', Strings::filter('a'));
76			}
77
78			/**
79			* @test
80			* @expectedException \TraderInteractive\Exceptions\FilterException
81			* @covers ::filter
82			*/
83			public function filterMinLengthFail()
84			{
85			Strings::filter('');
86			}
87
88			/**
89			* @test
90			* @covers ::filter
91			*/
92			public function filterMaxLengthPass()
93			{
94			$this->assertSame('a', Strings::filter('a', false, 0, 1));
95			}
96
97			/**
98			* @test
99			* @expectedException \TraderInteractive\Exceptions\FilterException
100			* @expectedExceptionMessage Value 'a' with length '1' is less than '0' or greater than '0'
101			* @covers ::filter
102			*/
103			public function filterMaxLengthFail()
104			{
105			Strings::filter('a', false, 0, 0);
106			}
107
108			/**
109			* @test
110			* @expectedException InvalidArgumentException
111			* @expectedExceptionMessage $minLength was not a positive integer value
112			* @covers ::filter
113			*/
114			public function filterMinLengthNotInteger()
115			{
116			Strings::filter('a', false, -1);
117			}
118
119			/**
120			* @test
121			* @expectedException InvalidArgumentException
122			* @expectedExceptionMessage $maxLength was not a positive integer value
123			* @covers ::filter
124			*/
125			public function filterMaxLengthNotInteger()
126			{
127			Strings::filter('a', false, 1, -1);
128			}
129
130			/**
131			* @test
132			* @expectedException InvalidArgumentException
133			* @expectedExceptionMessage $minLength was not a positive integer value
134			* @covers ::filter
135			*/
136			public function filterMinLengthNegative()
137			{
138			Strings::filter('a', false, -1);
139			}
140
141			/**
142			* @test
143			* @expectedException InvalidArgumentException
144			* @expectedExceptionMessage $maxLength was not a positive integer value
145			* @covers ::filter
146			*/
147			public function filterMaxLengthNegative()
148			{
149			Strings::filter('a', false, 1, -1);
150			}
151
152			/**
153			* @test
154			* @covers ::filter
155			*/
156			public function filterWithScalar()
157			{
158			$this->assertSame('24141', Strings::filter(24141));
159			}
160
161			/**
162			* @test
163			* @covers ::filter
164			*/
165			public function filterWithObject()
166			{
167			$testObject = new class() {
168			private $data;
169
170			public function __construct()
171			{
172			$this->data = [1,2,3,4,5];
173			}
174
175			public function __toString()
176			{
177			return implode(',', $this->data);
178			}
179			};
180
181			$this->assertSame('1,2,3,4,5', Strings::filter(new $testObject));
182			}
183
184			/**
185			* @test
186			* @covers ::filter
187			*
188			* @expectedException \TraderInteractive\Exceptions\FilterException
189			* @expectedExceptionMessage Value 'class@anonymous
190			*/
191			public function filterWithObjectNoToStringMethod()
192			{
193			$testObject = new class() {
194			private $data;
195
196			public function __construct()
197			{
198			$this->data = [1, 2, 3, 4, 5];
199			}
200			};
201
202			Strings::filter(new $testObject);
203			}
204
205			/**
206			* @test
207			* @covers ::translate
208			*/
209			public function translateValue()
210			{
211			$map = ['foo' => '100', 'bar' => '200'];
212			$this->assertSame('100', Strings::translate('foo', $map));
213			}
214
215			/**
216			* @test
217			* @covers ::translate
218			* @expectedException \TraderInteractive\Exceptions\FilterException
219			* @expectedExceptionMessage The value 'baz' was not found in the translation map array.
220			*/
221			public function translateValueNotFoundInMap()
222			{
223			$map = ['foo' => '100', 'bar' => '200'];
224			Strings::translate('baz', $map);
225			}
226
227			/**
228			* Verifies basic explode functionality.
229			*
230			* @test
231			* @covers ::explode
232			*/
233			public function explode()
234			{
235			$this->assertSame(['a', 'bcd', 'e'], Strings::explode('a,bcd,e'));
236			}
237
238			/**
239			* Verifies explode with a custom delimiter.
240			*
241			* @test
242			* @covers ::explode
243			*/
244			public function explodeCustomDelimiter()
245			{
246			$this->assertSame(['a', 'b', 'c', 'd,e'], Strings::explode('a b c d,e', ' '));
247			}
248
249			/**
250			* @test
251			* @expectedException \TraderInteractive\Exceptions\FilterException
252			* @expectedExceptionMessage Value '1234' is not a string
253			* @covers ::explode
254			*/
255			public function explodeNonString()
256			{
257			Strings::explode(1234, '');
258			}
259
260			/**
261			* Verifies explode filter with an empty delimiter.
262			*
263			* @test
264			* @expectedException \InvalidArgumentException
265			* @expectedExceptionMessage Delimiter '''' is not a non-empty string
266			* @covers ::explode
267			*/
268			public function explodeEmptyDelimiter()
269			{
270			Strings::explode('test', '');
271			}
272
273			/**
274			* @test
275			* @covers ::stripTags
276			*/
277			public function stripTagsFromNullReturnsNull()
278			{
279			$this->assertNull(Strings::stripTags(null));
			0 ignored issues – show Bug introduced 2018-12-21 14:39 UTC by Report Bug Copy Issue Report Are you sure the usage of `TraderInteractive\Filter\Strings::stripTags(null)` targeting `TraderInteractive\Filter\Strings::stripTags()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
280			}
281
282			/**
283			* @test
284			* @covers ::stripTags
285			*/
286			public function stripTagsRemoveHtmlFromString()
287			{
288			$actual = Strings::stripTags('A string with <p>paragraph</p> tags');
289			$expected = 'A string with paragraph tags';
290			$this->assertSame($expected, $actual);
291			}
292
293			/**
294			* @test
295			* @covers ::concat
296			*/
297			public function concat()
298			{
299			$this->assertSame('prefixstringsuffix', Strings::concat('string', 'prefix', 'suffix'));
300			}
301
302			/**
303			* Verify behavior of concat() when $value is not filterable
304			*
305			* @test
306			* @covers ::concat
307			* @expectedException \TraderInteractive\Exceptions\FilterException
308			*
309			* @return void
310			*/
311			public function concatValueNotFilterable()
312			{
313			Strings::concat(new \StdClass(), 'prefix', 'suffix');
314			}
315
316			/**
317			* @test
318			* @covers ::concat
319			*/
320			public function concatScalarValue()
321			{
322			$this->assertSame('prefix123suffix', Strings::concat(123, 'prefix', 'suffix'));
323			}
324
325			/**
326			* @test
327			* @covers ::concat
328			*/
329			public function concatObjectValue()
330			{
331			$this->assertSame('prefix' . __FILE__ . 'suffix', Strings::concat(new \SplFileInfo(__FILE__), 'prefix', 'suffix'));
332			}
333			}
334

traderinteractive / filter-strings-php

Push — master ( fb1f20...81c4ba )

StringsTest.php$1 ➔ translateValue() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like