PublishableSiteTreeTest::testObjectToUpdateOnSiteTreeReorganise() - Code Metrics - Inspection of "SS4 Compatability" - silverstripe/silverstripe-staticpublishqueue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#70)

by Daniel

created 2018-01-11 14:30 UTC

testObjectToUpdateOnSiteTreeReorganise() A

↳ Parent: PublishableSiteTreeTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	51
Code Lines	31

Duplication

Lines	18
Ratio	35.29 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	18
loc	51
rs	9.4109
cc	1
eloc	31
nc	1
nop	0

How to fix Long Method

<?php

namespace SilverStripe\StaticPublishQueue\Test;

use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\ORM\ArrayList;
use SilverStripe\StaticPublishQueue\Extension\Engine\SiteTreePublishingEngine;
use SilverStripe\StaticPublishQueue\Extension\Publishable\PublishableSiteTree;
use SilverStripe\StaticPublishQueue\Test\PublishableSiteTreeTest\Model\PublishablePage;

class PublishableSiteTreeTest extends SapphireTest
{
    protected $usesDatabase = true;

    protected static $required_extensions = [
        PublishablePage::class => [PublishableSiteTree::class]
    ];

    public function testObjectToUpdateOnSiteTreeReorganise()
    {
        // build a mock of the extension overriding flushChanges to prevent writing to the queue
        $mockExtension = $this->getMockBuilder(SiteTreePublishingEngine::class)
            ->setMethods([
                'flushChanges',
            ])
            ->getMock();

        $getURL = function ($value) {
            return $value->URLSegment;
        };

        // IF YOU'RE OF A NERVOUS DISPOSITION, LOOK AWAY NOT
        // stub the flushChanges method and make sure that each call is able to assert the correct items are in the
        $mockExtension->expects($this->exactly(3))->method('flushChanges')->willReturnOnConsecutiveCalls(
            new \PHPUnit_Framework_MockObject_Stub_ReturnCallback(function () use ($mockExtension, $getURL) {

                $this->assertEmpty($mockExtension->getToDelete());
                $mockExtension->setToDelete([]);
                $this->assertEquals(['stub'], array_map($getURL, $mockExtension->getToUpdate()));
                $mockExtension->setToUpdate([]);
            }),
            new \PHPUnit_Framework_MockObject_Stub_ReturnCallback(function () use ($mockExtension, $getURL) {

                $this->assertEquals(['stub'], array_map($getURL, $mockExtension->getToDelete()));
                $mockExtension->setToDelete([]);
                $this->assertEmpty($mockExtension->getToUpdate());
                $mockExtension->setToUpdate([]);
            }),
            new \PHPUnit_Framework_MockObject_Stub_ReturnCallback(function () use ($mockExtension, $getURL) {

                $this->assertEmpty($mockExtension->getToDelete());
                $mockExtension->setToDelete([]);
                $this->assertEquals(['stub-a-lub-a-dub-dub'], array_map($getURL, $mockExtension->getToUpdate()));
                $mockExtension->setToUpdate([]);
            })
        );

        // register our extension instance so it's applied to all SiteTree objects
        Injector::inst()->registerService($mockExtension, SiteTreePublishingEngine::class);

        $page = new PublishablePage;
        $page->URLSegment = 'stub';

        // publish the page
        $page->write();
        $page->publishRecursive();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        // change the URL and go again
        $page->URLSegment = 'stub-a-lub-a-dub-dub';
        $page->write();
        $page->publishRecursive();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    public function testObjectsToUpdateOnPublish()
    {
        $parent = PublishablePage::create();

        $stub = $this->getMockBuilder(PublishablePage::class)
            ->setMethods(
                [
                    'getParentID',
                    'Parent',
                ]
            )->getMock();

        $stub->expects($this->once())
            ->method('getParentID')
            ->will($this->returnValue('2'));

        $stub->expects($this->once())
            ->method('Parent')
            ->will($this->returnValue($parent));

        $objects = $stub->objectsToUpdate(['action' => 'publish']);
        $this->assertContains($stub, $objects);
        $this->assertContains($parent, $objects);
        $this->assertCount(2, $objects);
    }

    public function testObjectsToUpdateOnUnpublish()
    {
        $parent = PublishablePage::create();

        $stub = $this->getMockBuilder(PublishablePage::class)
            ->setMethods(
                [
                    'getParentID',
                    'Parent',
                ]
            )->getMock();

        $stub->expects($this->once())
            ->method('getParentID')
            ->will($this->returnValue('2'));

        $stub->expects($this->once())
            ->method('Parent')
            ->will($this->returnValue($parent));

        $updates = $stub->objectsToUpdate(['action' => 'unpublish']);
        $deletions = $stub->objectsToDelete(['action' => 'unpublish']);
        $this->assertContains($stub, $deletions);
        $this->assertNotContains($parent, $deletions);
        $this->assertContains($parent, $updates);
        $this->assertNotContains($stub, $updates);
        $this->assertCount(1, $deletions);
        $this->assertCount(1, $updates);
    }

    public function testObjectsToDeleteOnPublish()
    {
        $stub = PublishablePage::create();
        $objects = $stub->objectsToDelete(['action' => 'publish']);

        $this->assertEmpty($objects);
    }

    public function testObjectsToDeleteOnUnpublish()
    {
        $stub = PublishablePage::create();
        $stub->Title = 'stub';
        $objects = $stub->objectsToDelete(['action' => 'unpublish']);

        $this->assertContains($stub, $objects);
        $this->assertCount(1, $objects);
    }

    public function testObjectsToUpdateOnPublishIfVirtualExists()

    {
        $redir = PublishablePage::create();

        $stub = $this->getMockBuilder(PublishablePage::class)
            ->setMethods(['getMyVirtualPages'])
            ->getMock();

        $stub->expects($this->once())
            ->method('getMyVirtualPages')
            ->will(
                $this->returnValue(
                    new ArrayList([$redir])
                )
            );

        $objects = $stub->objectsToUpdate(['action' => 'publish']);
        $this->assertContains($stub, $objects);
        $this->assertContains($redir, $objects);
        $this->assertCount(2, $objects);
    }

    public function testObjectsToDeleteOnUnpublishIfVirtualExists()

    {
        $redir = PublishablePage::create();

        $stub = $this->getMockBuilder(PublishablePage::class)
            ->setMethods(['getMyVirtualPages'])
            ->getMock();

        $stub->Title = 'stub';

        $stub->expects($this->once())
            ->method('getMyVirtualPages')
            ->will(
                $this->returnValue(
                    new ArrayList([$redir])
                )
            );

        $objects = $stub->objectsToDelete(['action' => 'unpublish']);
        $this->assertContains($stub, $objects);
        $this->assertContains($redir, $objects);
        $this->assertCount(2, $objects);
    }
}


1		<?php
2
3		namespace SilverStripe\StaticPublishQueue\Test;
4
5		use SilverStripe\CMS\Model\SiteTree;
6		use SilverStripe\Core\Injector\Injector;
7		use SilverStripe\Dev\SapphireTest;
8		use SilverStripe\ORM\ArrayList;
9		use SilverStripe\StaticPublishQueue\Extension\Engine\SiteTreePublishingEngine;
10		use SilverStripe\StaticPublishQueue\Extension\Publishable\PublishableSiteTree;
11		use SilverStripe\StaticPublishQueue\Test\PublishableSiteTreeTest\Model\PublishablePage;
12
13		class PublishableSiteTreeTest extends SapphireTest
14		{
15		protected $usesDatabase = true;
16
17		protected static $required_extensions = [
18		PublishablePage::class => [PublishableSiteTree::class]
19		];
20
21		public function testObjectToUpdateOnSiteTreeReorganise()
22		{
23		// build a mock of the extension overriding flushChanges to prevent writing to the queue
24		$mockExtension = $this->getMockBuilder(SiteTreePublishingEngine::class)
25		->setMethods([
26		'flushChanges',
27		])
28		->getMock();
29
30		$getURL = function ($value) {
31		return $value->URLSegment;
32		};
33
34		// IF YOU'RE OF A NERVOUS DISPOSITION, LOOK AWAY NOT
35		// stub the flushChanges method and make sure that each call is able to assert the correct items are in the
36		$mockExtension->expects($this->exactly(3))->method('flushChanges')->willReturnOnConsecutiveCalls(
37	View Code Duplication	new \PHPUnit_Framework_MockObject_Stub_ReturnCallback(function () use ($mockExtension, $getURL) {
		0 ignored issues – show Duplication introduced 2018-01-11 14:31 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
38		$this->assertEmpty($mockExtension->getToDelete());
39		$mockExtension->setToDelete([]);
40		$this->assertEquals(['stub'], array_map($getURL, $mockExtension->getToUpdate()));
41		$mockExtension->setToUpdate([]);
42		}),
43	View Code Duplication	new \PHPUnit_Framework_MockObject_Stub_ReturnCallback(function () use ($mockExtension, $getURL) {
		0 ignored issues – show Duplication introduced 2018-01-11 14:31 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
44		$this->assertEquals(['stub'], array_map($getURL, $mockExtension->getToDelete()));
45		$mockExtension->setToDelete([]);
46		$this->assertEmpty($mockExtension->getToUpdate());
47		$mockExtension->setToUpdate([]);
48		}),
49	View Code Duplication	new \PHPUnit_Framework_MockObject_Stub_ReturnCallback(function () use ($mockExtension, $getURL) {
		0 ignored issues – show Duplication introduced 2018-01-11 14:31 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
50		$this->assertEmpty($mockExtension->getToDelete());
51		$mockExtension->setToDelete([]);
52		$this->assertEquals(['stub-a-lub-a-dub-dub'], array_map($getURL, $mockExtension->getToUpdate()));
53		$mockExtension->setToUpdate([]);
54		})
55		);
56
57		// register our extension instance so it's applied to all SiteTree objects
58		Injector::inst()->registerService($mockExtension, SiteTreePublishingEngine::class);
59
60		$page = new PublishablePage;
61		$page->URLSegment = 'stub';
62
63		// publish the page
64		$page->write();
65		$page->publishRecursive();
		0 ignored issues – show Documentation Bug introduced 2018-01-11 14:31 UTC by Report Bug Copy Issue Report The method `publishRecursive` does not exist on `object<SilverStripe\Stat...\Model\PublishablePage>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
66
67		// change the URL and go again
68		$page->URLSegment = 'stub-a-lub-a-dub-dub';
69		$page->write();
70		$page->publishRecursive();
		0 ignored issues – show Documentation Bug introduced 2018-01-11 14:31 UTC by Report Bug Copy Issue Report The method `publishRecursive` does not exist on `object<SilverStripe\Stat...\Model\PublishablePage>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
71		}
72
73		public function testObjectsToUpdateOnPublish()
74		{
75		$parent = PublishablePage::create();
76
77		$stub = $this->getMockBuilder(PublishablePage::class)
78		->setMethods(
79		[
80		'getParentID',
81		'Parent',
82		]
83		)->getMock();
84
85		$stub->expects($this->once())
86		->method('getParentID')
87		->will($this->returnValue('2'));
88
89		$stub->expects($this->once())
90		->method('Parent')
91		->will($this->returnValue($parent));
92
93		$objects = $stub->objectsToUpdate(['action' => 'publish']);
94		$this->assertContains($stub, $objects);
95		$this->assertContains($parent, $objects);
96		$this->assertCount(2, $objects);
97		}
98
99		public function testObjectsToUpdateOnUnpublish()
100		{
101		$parent = PublishablePage::create();
102
103		$stub = $this->getMockBuilder(PublishablePage::class)
104		->setMethods(
105		[
106		'getParentID',
107		'Parent',
108		]
109		)->getMock();
110
111		$stub->expects($this->once())
112		->method('getParentID')
113		->will($this->returnValue('2'));
114
115		$stub->expects($this->once())
116		->method('Parent')
117		->will($this->returnValue($parent));
118
119		$updates = $stub->objectsToUpdate(['action' => 'unpublish']);
120		$deletions = $stub->objectsToDelete(['action' => 'unpublish']);
121		$this->assertContains($stub, $deletions);
122		$this->assertNotContains($parent, $deletions);
123		$this->assertContains($parent, $updates);
124		$this->assertNotContains($stub, $updates);
125		$this->assertCount(1, $deletions);
126		$this->assertCount(1, $updates);
127		}
128
129		public function testObjectsToDeleteOnPublish()
130		{
131		$stub = PublishablePage::create();
132		$objects = $stub->objectsToDelete(['action' => 'publish']);
		0 ignored issues – show Bug introduced 2017-12-29 17:10 UTC by Report Bug Copy Issue Report The method `objectsToDelete()` does not exist on `SilverStripe\StaticPubli...t\Model\PublishablePage`. Did you maybe mean `delete()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
133		$this->assertEmpty($objects);
134		}
135
136		public function testObjectsToDeleteOnUnpublish()
137		{
138		$stub = PublishablePage::create();
139		$stub->Title = 'stub';
140		$objects = $stub->objectsToDelete(['action' => 'unpublish']);
		0 ignored issues – show Bug introduced 2017-12-29 17:10 UTC by Report Bug Copy Issue Report The method `objectsToDelete()` does not exist on `SilverStripe\StaticPubli...t\Model\PublishablePage`. Did you maybe mean `delete()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
141		$this->assertContains($stub, $objects);
142		$this->assertCount(1, $objects);
143		}
144
145	View Code Duplication	public function testObjectsToUpdateOnPublishIfVirtualExists()
		0 ignored issues – show Duplication introduced 2017-12-29 17:10 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
146		{
147		$redir = PublishablePage::create();
148
149		$stub = $this->getMockBuilder(PublishablePage::class)
150		->setMethods(['getMyVirtualPages'])
151		->getMock();
152
153		$stub->expects($this->once())
154		->method('getMyVirtualPages')
155		->will(
156		$this->returnValue(
157		new ArrayList([$redir])
158		)
159		);
160
161		$objects = $stub->objectsToUpdate(['action' => 'publish']);
162		$this->assertContains($stub, $objects);
163		$this->assertContains($redir, $objects);
164		$this->assertCount(2, $objects);
165		}
166
167	View Code Duplication	public function testObjectsToDeleteOnUnpublishIfVirtualExists()
		0 ignored issues – show Duplication introduced 2017-12-29 17:10 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
168		{
169		$redir = PublishablePage::create();
170
171		$stub = $this->getMockBuilder(PublishablePage::class)
172		->setMethods(['getMyVirtualPages'])
173		->getMock();
174
175		$stub->Title = 'stub';
176
177		$stub->expects($this->once())
178		->method('getMyVirtualPages')
179		->will(
180		$this->returnValue(
181		new ArrayList([$redir])
182		)
183		);
184
185		$objects = $stub->objectsToDelete(['action' => 'unpublish']);
186		$this->assertContains($stub, $objects);
187		$this->assertContains($redir, $objects);
188		$this->assertCount(2, $objects);
189		}
190		}
191

silverstripe / silverstripe-staticpublishqueue

Pull Request — master (#70)

testObjectToUpdateOnSiteTreeReorganise() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like