StubDocumentSetMockExtension

Complexity

Total Complexity

1

Size/Duplication

Total Lines	18
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	updateQueryFields()	0	6	1

<?php

class DMSDocumentSetTest extends SapphireTest

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    protected static $fixture_file = 'dmstest.yml';

    protected $extraDataObjects = array(
        'DMSDocument_Mock'
    );

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

This method seems to be duplicated in your project.

    {
        DMSDocumentSet::add_extension('StubRelatedDocumentExtension');

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

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

The method assertCount() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertSame() does not seem to exist on object<DMSDocumentSetTest>.

    }

    /**
     * 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'));

The method assertNull() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertNotNull() does not seem to exist on object<DMSDocumentSetTest>.

        $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'));

The method assertNotNull() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertNull() does not seem to exist on object<DMSDocumentSetTest>.

    }

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

$s2 is not used, you could remove the assignment.

        $s4 = $this->objFromFixture('SiteTree', 's4');

        $ds1 = $this->objFromFixture('DMSDocumentSet', 'ds1');
        $ds2 = $this->objFromFixture('DMSDocumentSet', 'ds2');
        $ds3 = $this->objFromFixture('DMSDocumentSet', 'ds3');

$ds3 is not used, you could remove the assignment.

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

The method assertCount() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertCount() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertEquals() does not seem to exist on object<DMSDocumentSetTest>.

    }

    /**
     * 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'));

The method assertTrue() does not seem to exist on object<DMSDocumentSetTest>.

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

        $this->assertNotNull($config->getComponentByType('DMSGridFieldDeleteAction'));

The method assertNotNull() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertNotNull() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertSame() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertNotNull() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertNotNull() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertSame() does not seem to exist on object<DMSDocumentSetTest>.

        }

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

    /**
     * Test that query fields can be added to the gridfield
     */
    public function testAddQueryFields(){

        /** @var DMSDocumentSet $set */
        $set = $this->objFromFixture('DMSDocumentSet', 'ds6');
        $doc = new DMSDocument_Mock();
        $set->Documents()->add($doc);

The method Documents() does not exist on DMSDocumentSet. Did you maybe mean getDocuments()?

        DMSDocumentSet::$linked_document_type = 'DMSDocument_Mock';

It seems like 'DMSDocument_Mock' of type string is incompatible with the declared type object<Varchar> of property $linked_document_type.

        /** @var FieldList $fields */
        $fields = new FieldList(new TabSet('Root'));
        /** @var FieldList $fields */
        $set->addQueryFields($fields);
        $keyValuePairs = $fields->dataFieldByName('KeyValuePairs');
        $this->assertNotNull($keyValuePairs,

The method assertNotNull() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertNotNull() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertNotNull() does not seem to exist on object<DMSDocumentSetTest>.

            'addQueryFields() includes KeyValuePairs composite field');
        // Reset the type
        DMSDocumentSet::$linked_document_type = 'DMSDocument';

It seems like 'DMSDocument' of type string is incompatible with the declared type object<Varchar> of property $linked_document_type.

    }

    public function testAddQueryFieldsIsExtensible(){
        DMSDocumentSet::add_extension('StubDocumentSetMockExtension');

        $fields = new FieldList(new TabSet('Root'));
        $set = new DMSDocumentSet;
        $set->addQueryFields($fields);

        $this->assertNotNull($fields->dataFieldByName('ExtendedField'),

The method assertNotNull() does not seem to exist on object<DMSDocumentSetTest>.

            'addQueryFields() is extendible as it included the field from the extension');
    }

    /**
     * Test that extra documents are added after write
     */
    public function testSaveLinkedDocuments(){
        /** @var DMSDocumentSet $set */
        $set = $this->objFromFixture('DMSDocumentSet','ds6');

        // Assert initially docs
        $this->assertEquals(1, $set->getDocuments()->count(), 'Set 6 has 1 document');

The method assertEquals() does not seem to exist on object<DMSDocumentSetTest>.

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

The method assertEquals() does not seem to exist on object<DMSDocumentSetTest>.

    }
}

class DMSDocument_Mock extends DMSDocument implements TestOnly

PSR1 recommends that each class should be in its own file to aid autoloaders.

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    private static $db = array(

Consider using a different property name as you override a private property of the parent class.

The property $db is not used and could be removed.

        'IsImported' => 'Boolean',
        'ISBN'       => 'Varchar',
    );

    private static $searchable_fields = array(

Consider using a different property name as you override a private property of the parent class.

The property $searchable_fields is not used and could be removed.

        'IsImported',
        'ISBN',
    );
}

class StubDocumentSetMockExtension extends DataExtension implements TestOnly

PSR1 recommends that each class should be in its own file to aid autoloaders.

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     *
     * For method {@link DMSDocumentSet::addQueryFields}
     *
     * @param FieldList $fields
     *
     * @return FieldList
     */
    public function updateQueryFields($fields)
    {
        $fields->addFieldToTab('Root.QueryBuilder', new TextField('ExtendedField'));

        return $fields;
    }

}