PartialFormSubmissionTest::testGenerateKey() - Code Metrics - Inspection of "Merge pull request #13 from Firesphere/feature/sha..." - Firesphere/silverstripe-partial-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c07b10...3eba7c )

by Simon

created 2019-08-22 04:53 UTC

PartialFormSubmissionTest::testGenerateKey() A

↳ Parent: PartialFormSubmissionTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.9
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Firesphere\PartialUserforms\Tests;

use Firesphere\PartialUserforms\Models\PartialFormSubmission;
use SilverStripe\Control\Controller;
use SilverStripe\Control\Director;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\UserForms\Model\UserDefinedForm;

class PartialFormSubmissionTest extends SapphireTest
{
    /**
     * @var bool
     */
    protected $usesDatabase = true;

    /**
     * @var PartialFormSubmission
     */
    protected $submission;

    public function testGetCMSFields()
    {
        $fields = $this->submission->getCMSFields();

        $this->assertNull($fields->dataFieldByName('Values'));
        $this->assertNull($fields->dataFieldByName('IsSend'));
        $this->assertNull($fields->dataFieldByName('TokenSalt'));
        $this->assertNull($fields->dataFieldByName('Token'));
        $this->assertNull($fields->dataFieldByName('UserDefinedFormID'));
        $this->assertInstanceOf(GridField::class, $fields->dataFieldByName('PartialFields'));
    }

    public function testCanCreate()

    {
        $this->assertTrue($this->submission->canCreate());

        $this->submission->ParentID = $this->submission->UserDefinedFormID;
<?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->submission->UserDefinedFormID = 0;

        $this->assertTrue($this->submission->canCreate());
    }

    public function testCanView()

    {
        $this->assertTrue($this->submission->canView());

        $this->submission->ParentID = $this->submission->UserDefinedFormID;
<?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->submission->UserDefinedFormID = 0;

        $this->assertTrue($this->submission->canView());
    }

    public function testCanEdit()

    {
        $this->assertTrue($this->submission->canEdit());

        $this->submission->ParentID = $this->submission->UserDefinedFormID;
<?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->submission->UserDefinedFormID = 0;

        $this->assertTrue($this->submission->canEdit());
    }

    public function testCanDelete()

    {
        $this->assertTrue($this->submission->canDelete());

        $this->submission->ParentID = $this->submission->UserDefinedFormID;
<?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->submission->UserDefinedFormID = 0;

        $this->assertTrue($this->submission->canDelete());
    }

    public function testGetParent()
    {
        $parent = $this->submission->getParent();

        $this->assertInstanceOf(UserDefinedForm::class, $parent);
    }

    public function testGetPartialLink()
    {
        $partial = PartialFormSubmission::create();
        $this->assertEquals('(none)', $partial->getPartialLink());

        $partial->write();
        $this->assertNotEquals('(none)', $partial->getPartialLink());

        $partial->Token = 'test-token';
<?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.");
        }
    }

}
        $partial->TokenSalt = 'test-salt';
<?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.");
        }
    }

}
        $partial->write();

        $link = Controller::join_links(
            Director::absoluteBaseURL(),
            'partial',
            $partial->generateKey('test-token'),
            'test-token'
        );
        $this->assertEquals($link, $partial->getPartialLink());
    }

    public function testGetPartialToken()
    {
        $partial = PartialFormSubmission::create();
        $partial->TokenSalt = 'test-salt';
<?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->assertNull(TestHelper::invokeMethod($partial, 'getPartialToken'));

        $partial->TokenSalt = null;
        $partial->write();
        $this->assertNotNull(TestHelper::invokeMethod($partial, 'getPartialToken'));

        $partial->Token = 'test-token';
        $partial->TokenSalt = 'test-salt';
        $partial->write();

        $this->assertEquals('test-token', TestHelper::invokeMethod($partial, 'getPartialToken'));
    }

    public function testGenerateToken()
    {
        $partial = singleton(PartialFormSubmission::class);
        $token = TestHelper::invokeMethod($partial, 'generateToken');
        $this->assertNotNull($token);
        $this->assertEquals(16, strlen($token));
    }

    public function testGenerateKey()
    {
        $partial = PartialFormSubmission::create();
        $token = 'test-token';
        $this->assertEquals('b041b97441e59b3a', $partial->generateKey($token));

        $partial->TokenSalt = 'test-salt';
<?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.");
        }
    }

}
        $key = $partial->generateKey($token);
        $this->assertEquals('30505a53806d5de9', $key);
        $this->assertEquals(16, strlen($key));
    }

    protected function setUp()
    {
        $this->submission = Injector::inst()->get(PartialFormSubmission::class);
        $form = UserDefinedForm::create(['Title' => 'Test']);
        $formID = $form->write();
        $this->submission->UserDefinedFormID = $formID;
        $this->submission->UserDefinedFormClass = UserDefinedForm::class;
        $this->submission->write();

        return parent::setUp();
    }
}


1		<?php
2
3		namespace Firesphere\PartialUserforms\Tests;
4
5		use Firesphere\PartialUserforms\Models\PartialFormSubmission;
6		use SilverStripe\Control\Controller;
7		use SilverStripe\Control\Director;
8		use SilverStripe\Core\Injector\Injector;
9		use SilverStripe\Dev\SapphireTest;
10		use SilverStripe\Forms\GridField\GridField;
11		use SilverStripe\UserForms\Model\UserDefinedForm;
12
13		class PartialFormSubmissionTest extends SapphireTest
14		{
15		/**
16		* @var bool
17		*/
18		protected $usesDatabase = true;
19
20		/**
21		* @var PartialFormSubmission
22		*/
23		protected $submission;
24
25		public function testGetCMSFields()
26		{
27		$fields = $this->submission->getCMSFields();
28
29		$this->assertNull($fields->dataFieldByName('Values'));
30		$this->assertNull($fields->dataFieldByName('IsSend'));
31		$this->assertNull($fields->dataFieldByName('TokenSalt'));
32		$this->assertNull($fields->dataFieldByName('Token'));
33		$this->assertNull($fields->dataFieldByName('UserDefinedFormID'));
34		$this->assertInstanceOf(GridField::class, $fields->dataFieldByName('PartialFields'));
35		}
36
37	View Code Duplication	public function testCanCreate()
		0 ignored issues – show Duplication introduced 2018-06-08 01:09 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...
38		{
39		$this->assertTrue($this->submission->canCreate());
40
41		$this->submission->ParentID = $this->submission->UserDefinedFormID;
		0 ignored issues – show Documentation introduced 2018-06-08 01:09 UTC by Report Bug Copy Issue Report The property `ParentID` does not exist on `object<Firesphere\Partia...\PartialFormSubmission>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
42		$this->submission->UserDefinedFormID = 0;
43
44		$this->assertTrue($this->submission->canCreate());
45		}
46
47	View Code Duplication	public function testCanView()
		0 ignored issues – show Duplication introduced 2018-06-08 01:09 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...
48		{
49		$this->assertTrue($this->submission->canView());
50
51		$this->submission->ParentID = $this->submission->UserDefinedFormID;
		0 ignored issues – show Documentation introduced 2018-06-08 01:09 UTC by Report Bug Copy Issue Report The property `ParentID` does not exist on `object<Firesphere\Partia...\PartialFormSubmission>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
52		$this->submission->UserDefinedFormID = 0;
53
54		$this->assertTrue($this->submission->canView());
55		}
56
57	View Code Duplication	public function testCanEdit()
		0 ignored issues – show Duplication introduced 2018-06-08 00:25 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...
58		{
59		$this->assertTrue($this->submission->canEdit());
60
61		$this->submission->ParentID = $this->submission->UserDefinedFormID;
		0 ignored issues – show Documentation introduced 2018-06-08 01:09 UTC by Report Bug Copy Issue Report The property `ParentID` does not exist on `object<Firesphere\Partia...\PartialFormSubmission>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
62		$this->submission->UserDefinedFormID = 0;
63
64		$this->assertTrue($this->submission->canEdit());
65		}
66
67	View Code Duplication	public function testCanDelete()
		0 ignored issues – show Duplication introduced 2018-06-08 01:09 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...
68		{
69		$this->assertTrue($this->submission->canDelete());
70
71		$this->submission->ParentID = $this->submission->UserDefinedFormID;
		0 ignored issues – show Documentation introduced 2018-06-08 01:09 UTC by Report Bug Copy Issue Report The property `ParentID` does not exist on `object<Firesphere\Partia...\PartialFormSubmission>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
72		$this->submission->UserDefinedFormID = 0;
73
74		$this->assertTrue($this->submission->canDelete());
75		}
76
77		public function testGetParent()
78		{
79		$parent = $this->submission->getParent();
80
81		$this->assertInstanceOf(UserDefinedForm::class, $parent);
82		}
83
84		public function testGetPartialLink()
85		{
86		$partial = PartialFormSubmission::create();
87		$this->assertEquals('(none)', $partial->getPartialLink());
88
89		$partial->write();
90		$this->assertNotEquals('(none)', $partial->getPartialLink());
91
92		$partial->Token = 'test-token';
		0 ignored issues – show Documentation introduced 2019-08-21 07:18 UTC by Report Bug Copy Issue Report The property `Token` does not exist on `object<Firesphere\Partia...\PartialFormSubmission>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
93		$partial->TokenSalt = 'test-salt';
		0 ignored issues – show Documentation introduced 2019-08-21 07:18 UTC by Report Bug Copy Issue Report The property `TokenSalt` does not exist on `object<Firesphere\Partia...\PartialFormSubmission>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
94		$partial->write();
95
96		$link = Controller::join_links(
97		Director::absoluteBaseURL(),
98		'partial',
99		$partial->generateKey('test-token'),
100		'test-token'
101		);
102		$this->assertEquals($link, $partial->getPartialLink());
103		}
104
105		public function testGetPartialToken()
106		{
107		$partial = PartialFormSubmission::create();
108		$partial->TokenSalt = 'test-salt';
		0 ignored issues – show Documentation introduced 2019-08-21 07:18 UTC by Report Bug Copy Issue Report The property `TokenSalt` does not exist on `object<Firesphere\Partia...\PartialFormSubmission>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
109		$this->assertNull(TestHelper::invokeMethod($partial, 'getPartialToken'));
110
111		$partial->TokenSalt = null;
112		$partial->write();
113		$this->assertNotNull(TestHelper::invokeMethod($partial, 'getPartialToken'));
114
115		$partial->Token = 'test-token';
116		$partial->TokenSalt = 'test-salt';
117		$partial->write();
118
119		$this->assertEquals('test-token', TestHelper::invokeMethod($partial, 'getPartialToken'));
120		}
121
122		public function testGenerateToken()
123		{
124		$partial = singleton(PartialFormSubmission::class);
125		$token = TestHelper::invokeMethod($partial, 'generateToken');
126		$this->assertNotNull($token);
127		$this->assertEquals(16, strlen($token));
128		}
129
130		public function testGenerateKey()
131		{
132		$partial = PartialFormSubmission::create();
133		$token = 'test-token';
134		$this->assertEquals('b041b97441e59b3a', $partial->generateKey($token));
135
136		$partial->TokenSalt = 'test-salt';
		0 ignored issues – show Documentation introduced 2019-08-21 07:18 UTC by Report Bug Copy Issue Report The property `TokenSalt` does not exist on `object<Firesphere\Partia...\PartialFormSubmission>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
137		$key = $partial->generateKey($token);
138		$this->assertEquals('30505a53806d5de9', $key);
139		$this->assertEquals(16, strlen($key));
140		}
141
142		protected function setUp()
143		{
144		$this->submission = Injector::inst()->get(PartialFormSubmission::class);
145		$form = UserDefinedForm::create(['Title' => 'Test']);
146		$formID = $form->write();
147		$this->submission->UserDefinedFormID = $formID;
148		$this->submission->UserDefinedFormClass = UserDefinedForm::class;
149		$this->submission->write();
150
151		return parent::setUp();
152		}
153		}
154

Firesphere / silverstripe-partial-userforms

Push — master ( c07b10...3eba7c )

PartialFormSubmissionTest::testGenerateKey() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like