ReportSpec - Code Metrics - Inspection of "test: Add Analytics resumption test" - scriptotek/php-alma-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 46ae11...0600cb )

by Dan Michael O.

created 2017-01-20 19:55 UTC

ReportSpec A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
dl	0
loc	60
rs	10
c	0
b	0
f	0
wmc	6
lcom	1
cbo	3

6 Methods

Rating	Name	Size	Complexity
A	let()	7	1
A	it_is_initializable()	4	1
A	it_has_rows()	6	1
A	it_supports_setting_headers()	6	1
A	it_supports_setting_filter()	6	1
A	it_supports_resumption()	23	1

<?php

namespace spec\Scriptotek\Alma\Analytics;

use PhpSpec\ObjectBehavior;
use Scriptotek\Alma\Analytics\Report;
use Scriptotek\Alma\Analytics\Row;
use Scriptotek\Alma\Client;
use spec\Scriptotek\Alma\SpecHelper;

class ReportSpec extends ObjectBehavior
{
    public function let(Client $almaClient)
    {
        $path = 'xyz';
        $this->beConstructedWith($almaClient, $path);
        $almaClient->getXML('/analytics/reports', ['path' => $path, 'limit' => 1000, 'token' => null, 'filter' => null])
            ->willReturn(SpecHelper::getDummyData('analytics_response.xml'));
    }

    public function it_is_initializable()
    {
        $this->shouldHaveType(Report::class);
    }

    public function it_has_rows()
    {
        $this->rows->shouldImplement(\Generator::class);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->rows->current()->shouldBeAnInstanceOf(Row::class);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->getRows()->shouldHaveCount(14);
    }

    public function it_supports_setting_headers(Client $almaClient)
    {
        $this->beConstructedWith($almaClient, 'xyz', ['a', 'b']);

        $this->headers->shouldBe(['a', 'b']);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    public function it_supports_setting_filter(Client $almaClient)
    {
        $this->beConstructedWith($almaClient, 'xyz', ['a', 'b'], 'la la la');

        $this->filter->shouldBe('la la la');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    public function it_supports_resumption(Client $almaClient)
    {
        $path = 'xyz';

        $almaClient->getXML('/analytics/reports', ['path' => $path, 'limit' => 1000, 'token' => null, 'filter' => null])
            ->shouldBeCalledTimes(1)
            ->willReturn(SpecHelper::getDummyData('analytics_response_part1.xml'));

        $almaClient->getXML('/analytics/reports', ['path' => null, 'limit' => 1000, 'token' => '9672D715A8E2EAAA6F30DD22FC52BE4CCAE35E29D921E0AC8BE8C6734C9E1571B4E48EEFCA4046EFF8CD7D1662C2D0A7677D3AD05EDC3CA7F06182E34E9D7A2F', 'filter' => null])
            ->shouldBeCalledTimes(3)
            ->willReturn(

                # If Analytics has a bad day, we might get a "still loading" response
                # See: https://bitbucket.org/uwlib/uwlib-alma-analytic-tools/wiki/Understanding_Analytic_GET_Requests#!analytic-still-loading
                SpecHelper::getDummyData('analytics_still_loading_response.xml'),

                SpecHelper::getDummyData('analytics_response_part2.xml'),
                SpecHelper::getDummyData('analytics_response_part3.xml')
            );

        $this->getRows()->shouldHaveCount(150 + 150 + 88);

    }
}


1			<?php
2
3			namespace spec\Scriptotek\Alma\Analytics;
4
5			use PhpSpec\ObjectBehavior;
6			use Scriptotek\Alma\Analytics\Report;
7			use Scriptotek\Alma\Analytics\Row;
8			use Scriptotek\Alma\Client;
9			use spec\Scriptotek\Alma\SpecHelper;
10
11			class ReportSpec extends ObjectBehavior
12			{
13			public function let(Client $almaClient)
14			{
15			$path = 'xyz';
16			$this->beConstructedWith($almaClient, $path);
17			$almaClient->getXML('/analytics/reports', ['path' => $path, 'limit' => 1000, 'token' => null, 'filter' => null])
18			->willReturn(SpecHelper::getDummyData('analytics_response.xml'));
19			}
20
21			public function it_is_initializable()
22			{
23			$this->shouldHaveType(Report::class);
24			}
25
26			public function it_has_rows()
27			{
28			$this->rows->shouldImplement(\Generator::class);
			0 ignored issues – show Documentation introduced 2016-11-24 19:52 UTC by Report Bug Copy Issue Report The property `rows` does not exist on `object<spec\Scriptotek\Alma\Analytics\ReportSpec>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
29			$this->rows->current()->shouldBeAnInstanceOf(Row::class);
			0 ignored issues – show Documentation introduced 2016-11-24 19:52 UTC by Report Bug Copy Issue Report The property `rows` does not exist on `object<spec\Scriptotek\Alma\Analytics\ReportSpec>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
30			$this->getRows()->shouldHaveCount(14);
31			}
32
33			public function it_supports_setting_headers(Client $almaClient)
34			{
35			$this->beConstructedWith($almaClient, 'xyz', ['a', 'b']);
36
37			$this->headers->shouldBe(['a', 'b']);
			0 ignored issues – show Documentation introduced 2016-11-24 19:52 UTC by Report Bug Copy Issue Report The property `headers` does not exist on `object<spec\Scriptotek\Alma\Analytics\ReportSpec>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
38			}
39
40			public function it_supports_setting_filter(Client $almaClient)
41			{
42			$this->beConstructedWith($almaClient, 'xyz', ['a', 'b'], 'la la la');
43
44			$this->filter->shouldBe('la la la');
			0 ignored issues – show Documentation introduced 2016-11-24 19:52 UTC by Report Bug Copy Issue Report The property `filter` does not exist on `object<spec\Scriptotek\Alma\Analytics\ReportSpec>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
45			}
46
47			public function it_supports_resumption(Client $almaClient)
48			{
49			$path = 'xyz';
50
51			$almaClient->getXML('/analytics/reports', ['path' => $path, 'limit' => 1000, 'token' => null, 'filter' => null])
52			->shouldBeCalledTimes(1)
53			->willReturn(SpecHelper::getDummyData('analytics_response_part1.xml'));
54
55			$almaClient->getXML('/analytics/reports', ['path' => null, 'limit' => 1000, 'token' => '9672D715A8E2EAAA6F30DD22FC52BE4CCAE35E29D921E0AC8BE8C6734C9E1571B4E48EEFCA4046EFF8CD7D1662C2D0A7677D3AD05EDC3CA7F06182E34E9D7A2F', 'filter' => null])
56			->shouldBeCalledTimes(3)
57			->willReturn(
58
59			# If Analytics has a bad day, we might get a "still loading" response
60			# See: https://bitbucket.org/uwlib/uwlib-alma-analytic-tools/wiki/Understanding_Analytic_GET_Requests#!analytic-still-loading
61			SpecHelper::getDummyData('analytics_still_loading_response.xml'),
62
63			SpecHelper::getDummyData('analytics_response_part2.xml'),
64			SpecHelper::getDummyData('analytics_response_part3.xml')
65			);
66
67			$this->getRows()->shouldHaveCount(150 + 150 + 88);
68
69			}
70			}
71

scriptotek / php-alma-client

Push — master ( 46ae11...0600cb )

ReportSpec A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Duplication Side-by-Side

Filter issues like