SiteTreeContentReviewTest - Code Metrics - Inspection of "FIX Ensure QueuedJob health check doesn't kill lon..." - silverstripe/silverstripe-contentreview - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#54)

by Jake

created 2017-11-20 22:14 UTC

SiteTreeContentReviewTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	332
Duplicated Lines	44.58 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

Metric	Value
wmc	18
lcom	1
cbo	6
dl	148
loc	332
rs	10
c	0
b	0
f	0

18 Methods

Rating	Name	Duplication	Size	Complexity
B	testOwnerNames()	0	29	1
A	testPermissionsExists()	0	6	1
A	testUserWithPermissionCanEdit()	14	14	1
A	testUserWithoutPermissionCannotEdit()	14	14	1
A	testAutomaticallyToNotSetReviewDate()	0	16	1
A	testAddReviewNote()	0	16	1
A	testGetContentReviewOwners()	0	10	1
A	testCanNotBeReviewBecauseNoReviewDate()	14	14	1
A	testCanNotBeReviewedBecauseInFuture()	14	14	1
A	testCanNotBeReviewedByUser()	14	14	1
A	testCanBeReviewedByUser()	14	14	1
A	testCanNotBeReviewedByGroup()	14	14	1
A	testCanBeReviewedByGroup()	14	14	1
A	testCanBeReviewedFromInheritedSetting()	0	20	1
B	testUnModifiedPagesDontChangeEditor()	0	31	1
A	testReviewActionVisibleForAuthor()	18	18	1
A	testReviewActionNotVisibleForEditor()	18	18	1
A	testSiteConfigSettingsAreUsedAsDefaults()	0	20	1

How to fix Duplicated Code

<?php

/**
 * @mixin PHPUnit_Framework_TestCase
 */
class SiteTreeContentReviewTest extends ContentReviewBaseTest
namespace YourVendor;

class YourClass { }
{
    /**
     * @var string
     */
    public static $fixture_file = "contentreview/tests/ContentReviewTest.yml";

    /**
     * @var array
     */
    protected $requiredExtensions = array(
        "SiteTree"              => array("SiteTreeContentReview"),
        "Group"                 => array("ContentReviewOwner"),
        "Member"                => array("ContentReviewOwner"),
        "CMSPageEditController" => array("ContentReviewCMSExtension"),
        "SiteConfig"            => array("ContentReviewDefaultSettings"),
    );

    public function testOwnerNames()
    {
        /** @var Member $editor */
        $editor = $this->objFromFixture("Member", "editor");

        $this->logInAs($editor);

        /** @var Page|SiteTreeContentReview $page */
        $page = new Page();
        $page->ReviewPeriodDays = 10;
        $page->ContentReviewType = "Custom";

        $page->ContentReviewUsers()->push($editor);
        $page->write();


        $this->assertTrue($page->canPublish());

        $this->assertTrue($page->doPublish());

        $this->assertEquals($page->OwnerNames, "Test Editor", "Test Editor should be the owner");


        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture("Page", "about");

        $page->OwnerUsers()->removeAll();
        $page->write();


        $this->assertTrue($page->canPublish());

        $this->assertTrue($page->doPublish());

        $this->assertEquals("", $page->OwnerNames);

    }

    public function testPermissionsExists()
    {
        $perms = singleton("SiteTreeContentReview")->providePermissions();

        $this->assertTrue(isset($perms["EDIT_CONTENT_REVIEW_FIELDS"]));

    }

    public function testUserWithPermissionCanEdit()

    {
        /** @var Member $editor */
        $editor = $this->objFromFixture("Member", "editor");

        $this->logInAs($editor);

        /** @var Page|SiteTreeContentReview $page */
        $page = new Page();

        $fields = $page->getSettingsFields();


        $this->assertNotNull($fields->dataFieldByName("NextReviewDate"));

    }

    public function testUserWithoutPermissionCannotEdit()

    {
        /** @var Member $author */
        $author = $this->objFromFixture("Member", "author");

        $this->logInAs($author);

        /** @var Page|SiteTreeContentReview $page */
        $page = new Page();

        $fields = $page->getSettingsFields();


        $this->assertNull($fields->dataFieldByName("NextReviewDate"));

    }

    public function testAutomaticallyToNotSetReviewDate()
    {
        /** @var Member $editor */
        $editor = $this->objFromFixture("Member", "editor");

        $this->logInAs($editor);

        /** @var Page|SiteTreeContentReview $page */
        $page = new Page();

        $page->ReviewPeriodDays = 10;
        $page->write();


        $this->assertTrue($page->doPublish());

        $this->assertEquals(null, $page->NextReviewDate);

    }

    public function testAddReviewNote()
    {
        /** @var Member $author */
        $author = $this->objFromFixture("Member", "author");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture("Page", "home");

        $page->addReviewNote($author, "This is a message");

        /** @var Page|SiteTreeContentReview $page */
        $homepage = $this->objFromFixture("Page", "home");

        $this->assertEquals(1, $homepage->ReviewLogs()->count());

        $this->assertEquals("This is a message", $homepage->ReviewLogs()->first()->Note);

    }

    public function testGetContentReviewOwners()
    {
        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture("Page", "group-owned");

        $owners = $page->ContentReviewOwners();

        $this->assertEquals(1, $owners->count());

        $this->assertEquals("[email protected]", $owners->first()->Email);

    }

    public function testCanNotBeReviewBecauseNoReviewDate()

    {
        SS_Datetime::set_mock_now("2010-01-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture("Member", "author");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture("Page", "no-review");

        $this->assertFalse($page->canBeReviewedBy($author));


        SS_Datetime::clear_mock_now();
    }

    public function testCanNotBeReviewedBecauseInFuture()

    {
        SS_Datetime::set_mock_now("2010-01-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture("Member", "author");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture("Page", "staff");

        $this->assertFalse($page->canBeReviewedBy($author));


        SS_Datetime::clear_mock_now();
    }

    public function testCanNotBeReviewedByUser()

    {
        SS_Datetime::set_mock_now("2010-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture("Member", "author");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture("Page", "home");

        $this->assertFalse($page->canBeReviewedBy($author));


        SS_Datetime::clear_mock_now();
    }

    public function testCanBeReviewedByUser()

    {
        SS_Datetime::set_mock_now("2010-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture("Member", "author");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture("Page", "staff");

        $this->assertTrue($page->canBeReviewedBy($author));


        SS_Datetime::clear_mock_now();
    }

    public function testCanNotBeReviewedByGroup()

    {
        SS_Datetime::set_mock_now("2010-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture("Member", "editor");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture("Page", "contact");

        $this->assertFalse($page->canBeReviewedBy($author));


        SS_Datetime::clear_mock_now();
    }

    public function testCanBeReviewedByGroup()

    {
        SS_Datetime::set_mock_now("2010-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture("Member", "author");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture("Page", "contact");

        $this->assertTrue($page->canBeReviewedBy($author));


        SS_Datetime::clear_mock_now();
    }

    public function testCanBeReviewedFromInheritedSetting()
    {
        SS_Datetime::set_mock_now("2013-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture("Member", "author");

        /** @var Page|SiteTreeContentReview $parentPage */
        $parentPage = $this->objFromFixture("Page", "contact");

        $parentPage->NextReviewDate = "2013-01-01";
        $parentPage->write();


        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture("Page", "contact-child");

        $this->assertTrue($page->canBeReviewedBy($author));


        SS_Datetime::clear_mock_now();
    }

    public function testUnModifiedPagesDontChangeEditor() {
        SS_Datetime::set_mock_now("2013-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture("Member", "author");
        $this->logInAs($author);

        // Page which is un-modified doesn't advance version of have an editor assigned
        $contactPage = $this->objFromFixture("Page", "contact");
        $contactPageVersion = $contactPage->Version;
        $contactPage->write();
        $this->assertEmpty($contactPage->LastEditedByName);

        $this->assertEquals(

            $contactPageVersion,
            Versioned::get_versionnumber_by_stage('SiteTree', 'Stage', $contactPage->ID, false)
        );

        // Page with modifications gets marked
        $homePage = $this->objFromFixture("Page", "home");
        $homePageVersion = $homePage->Version;
        $homePage->Content = '<p>Welcome!</p>';
        $homePage->write();
        $this->assertNotEmpty($homePage->LastEditedByName);

        $this->assertEquals($author->getTitle(), $homePage->LastEditedByName);

        $this->assertGreaterThan(

            $homePageVersion,
            Versioned::get_versionnumber_by_stage('SiteTree', 'Stage', $homePage->ID, false)
        );

        SS_Datetime::clear_mock_now();
    }

    public function testReviewActionVisibleForAuthor()

    {
        SS_Datetime::set_mock_now("2020-03-01 12:00:00");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture("Page", "contact");

        /** @var Member $author */
        $author = $this->objFromFixture("Member", "author");

        $this->logInAs($author);

        $fields = $page->getCMSActions();


        $this->assertNotNull($fields->fieldByName("ActionMenus.ReviewContent"));


        SS_Datetime::clear_mock_now();
    }

    public function testReviewActionNotVisibleForEditor()

    {
        SS_Datetime::set_mock_now("2020-03-01 12:00:00");

        /** @var Page|SiteTreeContentReview $page */
        $page = $this->objFromFixture("Page", "contact");

        /** @var Member $author */
        $author = $this->objFromFixture("Member", "editor");

        $this->logInAs($author);

        $fields = $page->getCMSActions();


        $this->assertNull($fields->fieldByName("ActionMenus.ReviewContent"));


        SS_Datetime::clear_mock_now();
    }

    public function testSiteConfigSettingsAreUsedAsDefaults()
    {
        SS_Datetime::set_mock_now("2020-03-01 12:00:00");

        /** @var Member $author */
        $author = $this->objFromFixture('Member', 'editor');

        /** @var SiteConfig $siteConfig */
        $siteConfig = SiteConfig::current_site_config();

        // Set the author to a default user for reviewing
        $siteConfig->OwnerUsers()->add($author);

        $emptyPage = new Page;
        $emptyPage->NextReviewDate = '2020-02-20 12:00:00';

        $this->assertTrue($emptyPage->canBeReviewedBy($author));


        SS_Datetime::clear_mock_now();
    }
}


1			<?php
2
3			/**
4			* @mixin PHPUnit_Framework_TestCase
5			*/
6			class SiteTreeContentReviewTest extends ContentReviewBaseTest
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-20 23:48 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
7			{
8			/**
9			* @var string
10			*/
11			public static $fixture_file = "contentreview/tests/ContentReviewTest.yml";
12
13			/**
14			* @var array
15			*/
16			protected $requiredExtensions = array(
17			"SiteTree" => array("SiteTreeContentReview"),
18			"Group" => array("ContentReviewOwner"),
19			"Member" => array("ContentReviewOwner"),
20			"CMSPageEditController" => array("ContentReviewCMSExtension"),
21			"SiteConfig" => array("ContentReviewDefaultSettings"),
22			);
23
24			public function testOwnerNames()
25			{
26			/** @var Member $editor */
27			$editor = $this->objFromFixture("Member", "editor");
28
29			$this->logInAs($editor);
30
31			/** @var Page\|SiteTreeContentReview $page */
32			$page = new Page();
33			$page->ReviewPeriodDays = 10;
34			$page->ContentReviewType = "Custom";
35
36			$page->ContentReviewUsers()->push($editor);
37			$page->write();
			0 ignored issues – show Bug introduced 2015-11-20 23:48 UTC by Report Bug Copy Issue Report The method `write()` does not seem to exist on `object<SiteTreeContentReview>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
38

silverstripe / silverstripe-contentreview

Pull Request — master (#54)

SiteTreeContentReviewTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

18 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like