DMSDocumentSetTest - Code Metrics - Inspection of "FIX Add friendly labels for ASC and DESC in query..." - silverstripe/silverstripe-dms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#160)

by Robbie

created 2017-06-06 04:56 UTC

DMSDocumentSetTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	236
Duplicated Lines	4.24 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

Metric	Value
wmc	16
lcom	1
cbo	7
dl	10
loc	236
rs	10
c	0
b	0
f	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	testGetDocumentsIsExtensible()	10	10	1
A	testGridFieldShowsWhenSetIsSaved()	0	18	1
A	testRelations()	0	14	1
B	testDocumentGridFieldConfig()	0	24	3
A	testShortcodeHandlerKeyFieldExists()	0	13	1
A	testGetDocumentDisplayFields()	0	12	1
A	testNiceFormattingForManuallyAddedInGridField()	0	15	1
A	testAddQueryFields()	0	18	1
A	testQueryBuilderDirectionFieldHasFriendlyLabels()	0	13	1
A	testDocumentsAreOrderable()	0	16	2
A	testSaveLinkedDocuments()	0	11	1
A	testExceptionOnNoTitleGiven()	0	4	1
A	testPageFieldRemovedWhenEditingInPageContext()	0	13	1

How to fix Duplicated Code

<?php

class DMSDocumentSetTest extends SapphireTest
namespace YourVendor;

class YourClass { }
{
    protected static $fixture_file = 'dmstest.yml';

    /**
     * Ensure that getDocuments is extensible
     */
    public function testGetDocumentsIsExtensible()

    {
        DMSDocumentSet::add_extension('StubRelatedDocumentExtension');

        $set = new DMSDocumentSet;
        $documents = $set->getDocuments();

        $this->assertCount(1, $documents);

        $this->assertSame('Extended', $documents->first()->Filename);

    }

    /**
     * Test that the GridField for documents isn't shown until you've saved the set
     */
    public function testGridFieldShowsWhenSetIsSaved()
    {
        $set = DMSDocumentSet::create();

        // Not in database yet
        $fields = $set->getCMSFields();
        $this->assertNull($fields->fieldByName('Root.Main.Documents'));

        $gridFieldNotice = $fields->fieldByName('Root.Main.GridFieldNotice');
        $this->assertNotNull($gridFieldNotice);

        $this->assertContains('Managing documents will be available', $gridFieldNotice->getContent());

        // In the database
        $set->Title = 'Testing';
        $set->write();
        $fields = $set->getCMSFields();
        $this->assertNotNull($fields->fieldByName('Root.Main.Documents'));

        $this->assertNull($fields->fieldByName('Root.Main.GridFieldNotice'));

    }

    public function testRelations()
    {
        $s1 = $this->objFromFixture('SiteTree', 's1');
        $s2 = $this->objFromFixture('SiteTree', 's2');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $s4 = $this->objFromFixture('SiteTree', 's4');

        $ds1 = $this->objFromFixture('DMSDocumentSet', 'ds1');
        $ds2 = $this->objFromFixture('DMSDocumentSet', 'ds2');
        $ds3 = $this->objFromFixture('DMSDocumentSet', 'ds3');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        $this->assertCount(0, $s4->getDocumentSets(), 'Page 4 has no document sets associated');

        $this->assertCount(2, $s1->getDocumentSets(), 'Page 1 has 2 document sets');

        $this->assertEquals(array($ds1->ID, $ds2->ID), $s1->getDocumentSets()->column('ID'));

    }

    /**
     * Test that various components exist in the GridField config. See {@link DMSDocumentSet::getCMSFields} for context.
     */
    public function testDocumentGridFieldConfig()
    {
        $set = $this->objFromFixture('DMSDocumentSet', 'ds1');
        $fields = $set->getCMSFields();
        $gridField = $fields->fieldByName('Root.Main.Documents');
        $this->assertTrue((bool) $gridField->hasClass('documents'));


        /** @var GridFieldConfig $config */
        $config = $gridField->getConfig();

        $this->assertNotNull($addNew = $config->getComponentByType('DMSGridFieldAddNewButton'));

        $this->assertSame($set->ID, $addNew->getDocumentSetId());


        if (class_exists('GridFieldPaginatorWithShowAll')) {
            $this->assertNotNull($config->getComponentByType('GridFieldPaginatorWithShowAll'));

        } else {
            $paginator = $config->getComponentByType('GridFieldPaginator');
            $this->assertNotNull($paginator);

            $this->assertSame(15, $paginator->getItemsPerPage());

        }

        $sortableAssertion = class_exists('GridFieldSortableRows') ? 'assertNotNull' : 'assertNull';
        $this->$sortableAssertion($config->getComponentByType('GridFieldSortableRows'));
    }

    /**
     * Ensure that the display fields for the documents GridField can be returned
     */
    public function testGetDocumentDisplayFields()
    {
        $document = $this->objFromFixture('DMSDocumentSet', 'ds1');
        $this->assertInternalType('array', $document->getDocumentDisplayFields());


        Config::inst()->update('DMSDocument', 'display_fields', array('apple' => 'Apple', 'orange' => 'Orange'));
        $displayFields = $document->getDocumentDisplayFields();
        $this->assertContains('Apple', $displayFields);
        $this->assertContains('Orange', $displayFields);
        $this->assertArrayHasKey('ManuallyAdded', $displayFields);

        $this->assertContains('Added', $displayFields);
    }

    /**
     * Tests to ensure that the callback for formatting ManuallyAdded will return a nice label for the user
     */
    public function testNiceFormattingForManuallyAddedInGridField()
    {
        $fieldFormatting = $this->objFromFixture('DMSDocumentSet', 'ds1')
            ->getCMSFields()
            ->fieldByName('Root.Main.Documents')
            ->getConfig()
            ->getComponentByType('GridFieldDataColumns')
            ->getFieldFormatting();

        $this->assertArrayHasKey('ManuallyAdded', $fieldFormatting);

        $this->assertTrue(is_callable($fieldFormatting['ManuallyAdded']));


        $this->assertSame('Manually', $fieldFormatting['ManuallyAdded'](1));

        $this->assertSame('Query Builder', $fieldFormatting['ManuallyAdded'](0));

    }

    /**
     * Test that query fields can be added to the gridfield
     */
    public function testAddQueryFields()
    {
        /** @var DMSDocumentSet $set */
        $set = $this->objFromFixture('DMSDocumentSet', 'ds6');
        /** @var FieldList $fields */
        $fields = new FieldList(new TabSet('Root'));
        /** @var FieldList $fields */
        $set->addQueryFields($fields);
        $keyValuePairs = $fields->dataFieldByName('KeyValuePairs');
        $this->assertNotNull(

            $keyValuePairs,
            'addQueryFields() includes KeyValuePairs composite field'
        );
        $this->assertNotNull(

            $keyValuePairs->fieldByName('KeyValuePairs[Title]'),
            'addQueryFields() includes KeyValuePairs composite field'
        );
    }

    /**
     * Ensure that the "direction" dropdown field has user friendly field labels
     */
    public function testQueryBuilderDirectionFieldHasFriendlyLabels()
    {
        $fields = $this->objFromFixture('DMSDocumentSet', 'ds1')->getCMSFields();

        $dropdown = $fields->fieldByName('Root.QueryBuilder')->FieldList()->filterByCallback(function ($field) {
            return $field instanceof FieldGroup;
        })->first()->fieldByName('SortByDirection');

        $this->assertInstanceOf('DropdownField', $dropdown);

        $source = $dropdown->getSource();
        $this->assertContains('Ascending', $source);
        $this->assertContains('Descending', $source);
    }

    /**
     * Ensure that the configurable shortcode handler key is a hidden field in the CMS
     */
    public function testShortcodeHandlerKeyFieldExists()
    {
        Config::inst()->update('DMS', 'shortcode_handler_key', 'unit-test');

        $set = DMSDocumentSet::create(array('Title' => 'TestSet'));
        $set->write();

        $fields = $set->getCMSFields();
        $field = $fields->fieldByName('Root.Main.DMSShortcodeHandlerKey');

        $this->assertInstanceOf('HiddenField', $field);

        $this->assertSame('unit-test', $field->Value());

    }

    /**
     * Ensure that if the module is available, the orderable rows GridField component is added
     */
    public function testDocumentsAreOrderable()
    {
        if (!class_exists('GridFieldSortableRows')) {
            $this->markTestSkipped('Test requires undefinedoffset/sortablegridfield installed.');

        }

        $fields = $this->objFromFixture('DMSDocumentSet', 'ds1')->getCMSFields();

        $gridField = $fields->fieldByName('Root.Main.Documents');
        $this->assertInstanceOf('GridField', $gridField);


        $this->assertInstanceOf(

            'GridFieldSortableRows',
            $gridField->getConfig()->getComponentByType('GridFieldSortableRows')
        );
    }

    /**
     * Test that extra documents are added after write
     */
    public function testSaveLinkedDocuments()
    {
        /** @var DMSDocumentSet $set */
        $set = $this->objFromFixture('DMSDocumentSet', 'dsSaveLinkedDocuments');
        // Assert initially docs
        $this->assertEquals(1, $set->getDocuments()->count(), 'Set has 1 document');

        // Now apply the query and see if 2 extras were added with CreatedByID filter
        $set->KeyValuePairs = '{"Filename":"extradoc3"}';
        $set->saveLinkedDocuments();
        $this->assertEquals(2, $set->getDocuments()->count(), 'Set has 2 documents');

    }

    /**
     * Tests that an exception is thrown if no title entered for a DMSDocumentSet.
     * @expectedException ValidationException
     */
    public function testExceptionOnNoTitleGiven()
    {
        DMSDocumentSet::create(array('Title' => ''))->write();
    }

    /**
     * Ensure that when editing in a page context that the "page" field is removed, or is labelled "Show on page"
     * otherwise
     */
    public function testPageFieldRemovedWhenEditingInPageContext()
    {
        $set = $this->objFromFixture('DMSDocumentSet', 'ds1');

        $fields = $set->getCMSFields();
        $this->assertInstanceOf('DropdownField', $fields->fieldByName('Root.Main.PageID'));


        $pageController = new CMSPageEditController;
        $pageController->pushCurrent();

        $fields = $set->getCMSFields();
        $this->assertNull($fields->fieldByName('Root.Main.PageID'));

    }
}


1		<?php
2
3		class DMSDocumentSetTest extends SapphireTest
		0 ignored issues – show Coding Style Compatibility introduced 2017-05-03 21:42 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...
4		{
5		protected static $fixture_file = 'dmstest.yml';
6
7		/**
8		* Ensure that getDocuments is extensible
9		*/
10	View Code Duplication	public function testGetDocumentsIsExtensible()
		0 ignored issues – show Duplication introduced 2017-05-05 01:36 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...
11		{
12		DMSDocumentSet::add_extension('StubRelatedDocumentExtension');
13
14		$set = new DMSDocumentSet;
15		$documents = $set->getDocuments();
16
17		$this->assertCount(1, $documents);
		0 ignored issues – show Bug introduced 2017-05-05 01:36 UTC by Report Bug Copy Issue Report The method `assertCount()` does not seem to exist on `object<DMSDocumentSetTest>`. 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...
18		$this->assertSame('Extended', $documents->first()->Filename);
		0 ignored issues – show Bug introduced 2017-05-05 01:36 UTC by Report Bug Copy Issue Report The method `assertSame()` does not seem to exist on `object<DMSDocumentSetTest>`. 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...
19		}
20
21		/**
22		* Test that the GridField for documents isn't shown until you've saved the set
23		*/
24		public function testGridFieldShowsWhenSetIsSaved()
25		{
26		$set = DMSDocumentSet::create();
27
28		// Not in database yet
29		$fields = $set->getCMSFields();
30		$this->assertNull($fields->fieldByName('Root.Main.Documents'));
		0 ignored issues – show Bug introduced 2017-05-08 23:34 UTC by Report Bug Copy Issue Report The method `assertNull()` does not seem to exist on `object<DMSDocumentSetTest>`. 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...
31		$gridFieldNotice = $fields->fieldByName('Root.Main.GridFieldNotice');
32		$this->assertNotNull($gridFieldNotice);
		0 ignored issues – show Bug introduced 2017-05-08 23:34 UTC by Report Bug Copy Issue Report The method `assertNotNull()` does not seem to exist on `object<DMSDocumentSetTest>`. 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...
33		$this->assertContains('Managing documents will be available', $gridFieldNotice->getContent());
34

silverstripe / silverstripe-dms

Pull Request — master (#160)

DMSDocumentSetTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

13 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like