WorkflowImportExportTest - Code Metrics - Inspection of "Merge pull request #229 from helpfulrobot/add-stan..." - silverstripe-australia/advancedworkflow - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c44703...1db852 )

by Marcus

created 2015-11-24 22:52 UTC

WorkflowImportExportTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	232
Duplicated Lines	9.91 %

Coupling/Cohesion

Components	0
Dependencies	8

Metric	Value
wmc	9
lcom	0
cbo	8
dl	23
loc	232
rs	10

9 Methods

Rating	Name	Duplication	Size	Complexity
A	createDefinition()	23	23	1
A	testFormatWithActions()	0	19	1
A	testFormatWithoutActions()	0	19	1
B	testParseBadYAMLNoHeaderImport()	0	29	1
B	testParseBadYAMLMalformedImport()	0	32	1
B	testParseGoodYAMLImport()	0	31	1
A	testGetImportedWorkflowsNone()	0	6	1
A	testGetImportedWorkflowsOne()	0	13	1
A	testGetImportedWorkflowsMany()	0	12	1

How to fix Duplicated Code

<?php
/**
 * Tests for workflow import/export logic.
 *
 * @author     [email protected]
 * @license    BSD License (http://silverstripe.org/bsd-license/)
 * @package    advancedworkflow
 * @subpackage tests
 */
class WorkflowImportExportTest extends SapphireTest {
namespace YourVendor;

class YourClass { }
	
	public static $fixture_file = 'advancedworkflow/tests/workflowtemplateimport.yml';
	
	/**
	 * Utility method, used in tests
	 * @return \WorkflowDefinition
	 */
	protected function createDefinition() {

		$definition = new WorkflowDefinition();
		$definition->Title = "Dummy Workflow Definition";
<?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.");
        }
    }

}
		$definition->write();

		$stepOne = new WorkflowAction();
		$stepOne->Title = "Step One";
<?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.");
        }
    }

}
		$stepOne->WorkflowDefID = $definition->ID;
<?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.");
        }
    }

}
		$stepOne->write();

		$stepTwo = new WorkflowAction();
		$stepTwo->Title = "Step Two";
<?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.");
        }
    }

}
		$stepTwo->WorkflowDefID = $definition->ID;
<?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.");
        }
    }

}
		$stepTwo->write();

		$transitionOne = new WorkflowTransition();
		$transitionOne->Title = 'Step One T1';
<?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.");
        }
    }

}
		$transitionOne->ActionID = $stepOne->ID;
<?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.");
        }
    }

}
		$transitionOne->NextActionID = $stepTwo->ID;
<?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.");
        }
    }

}
		$transitionOne->write();

		return $definition;
	}	

	/**
	 * Create a WorkflowDefinition with some actions. Ensure an expected length of formatted template.
	 */
	public function testFormatWithActions() {
		$definition = $this->createDefinition();
		$exporter = Injector::inst()->createWithArgs('WorkflowDefinitionExporter', array($definition->ID));
		$member = new Member();
		$member->FirstName = 'joe';
		$member->Surname = 'bloggs';
		$exporter->setMember($member);
		$templateData = new ArrayData(array(
			'ExportMetaData' => $exporter->ExportMetaData(),
			'ExportActions' => $exporter->getDefinition()->Actions()
		));
		
		$formatted = $exporter->format($templateData);
		$numActions = count(preg_split("#\R#", $formatted)); 
		
		$this->assertNotEmpty($formatted);

		// Seems arbitrary, but if no actions, then the resulting YAML file is exactly 18 lines long
		$this->assertGreaterThan(18, $numActions);				

	}
	
	/**
	 * Create a WorkflowDefinition with NO actions. Ensure an expected length of formatted template.
	 */
	public function testFormatWithoutActions() {
		$definition = $this->createDefinition();
		$exporter = Injector::inst()->createWithArgs('WorkflowDefinitionExporter', array($definition->ID));
		$member = new Member();
		$member->FirstName = 'joe';
		$member->Surname = 'bloggs';
		$exporter->setMember($member);
		$templateData = new ArrayData(array());
		
		$formatted = $exporter->format($templateData);
		$numActions = count(preg_split("#\R#", $formatted)); 
		
		// Seems arbitrary, but if no actions, then the resulting YAML file is exactly 18 lines long
		$this->assertEquals(18, $numActions);

		
		// Ensure outputted YAML has no blank lines, where SS's control structures would normally be
		$numBlanks = preg_match("#^\s*$#m", $formatted);
		$this->assertEquals(0, $numBlanks);		

	}
	
	/**
	 * Tests a badly formatted YAML import for parsing (no headers)
	 * Note: The available test-cases we can expect to get out of sfYamlParser is limited..
	 */
	public function testParseBadYAMLNoHeaderImport() {
		$importer = new WorkflowDefinitionImporter();
		$this->setExpectedException('Exception', 'Invalid YAML format.');

		$source = <<<'EOD'
Injector:
  ExportedWorkflow:
    class: WorkflowTemplate
    constructor:
      - 'My Workflow 4 20/02/2014 03-12-55'
      - 'Exported from localhost on 20/02/2014 03:12:55 by joe bloggs using SilverStripe versions Framework 3.1.2, CMS 3.1.2'
      - 0.2
      - 0
      - 3
    properties:
      structure:
        'Step One':
          type: WorkflowAction
          transitions:
            - Step One T1: 'Step Two'
        'Step Two':
          type: WorkflowAction
  WorkflowService:
    properties:
      templates:
        - %$ExportedWorkflow
EOD;
		
		$importer->parseYAMLImport($source);
	}	
	
	/**
	 * Tests a badly formatted YAML import for parsing (missing YML colon)
	 * Note: The available test-cases we can expect to get out of sfYamlParser is limited..
	 */
	public function testParseBadYAMLMalformedImport() {
		$importer = new WorkflowDefinitionImporter();
		$this->setExpectedException('ValidationException', 'Invalid YAML format. Unable to parse.');

		$source = <<<'EOD'
---
Name: exportedworkflow
---
Injector:
  ExportedWorkflow:
    class: WorkflowTemplate
    constructor:
      - 'My Workflow 4 20/02/2014 03-12-55'
      - 'Exported from localhost on 20/02/2014 03-12-55 by joe bloggs using SilverStripe versions Framework 3.1.2, CMS 3.1.2'
      - 0.2
      - 0
      - 3
    properties:
      structure:
        'Step One'
          type: WorkflowAction
          transitions:
            - Step One T1: 'Step Two'
        'Step Two':
          type: WorkflowAction
  WorkflowService:
    properties:
      templates:
        - %$ExportedWorkflow
EOD;
		
		$importer->parseYAMLImport($source);
	}	
	
	/**
	 * Tests a well-formatted YAML import for parsing
	 * Note: The available test-cases we can expect to get out of sfYamlParser is limited..
	 */
	public function testParseGoodYAMLImport() {
		$importer = new WorkflowDefinitionImporter();
		$source = <<<'EOD'
---
Name: exportedworkflow
---
Injector:
  ExportedWorkflow:
    class: WorkflowTemplate
    constructor:
      - 'My Workflow 4 20/02/2014 03-12-55'
      - 'Exported from localhost on 20/02/2014 03-12-55 by joe bloggs using SilverStripe versions Framework 3.1.2, CMS 3.1.2'
      - 0.2
      - 0
      - 3
    properties:
      structure:
        'Step One':
          type: WorkflowAction
          transitions:
            - Step One T1: 'Step Two'
        'Step Two':
          type: WorkflowAction
  WorkflowService:
    properties:
      templates:
        - %$ExportedWorkflow
EOD;
		
		$this->assertNotEmpty($importer->parseYAMLImport($source));

	}
	
	/**
	 * Given no ImportedWorkflowTemplate fixture/input data, tests an empty array is returned 
	 * by WorkflowDefinitionImporter#getImportedWorkflows()
	 */
	public function testGetImportedWorkflowsNone() {
		$this->clearFixtures();
		$importer = new WorkflowDefinitionImporter();
		$imports = $importer->getImportedWorkflows();
		$this->assertEmpty($imports);

	}
	
	/**
	 * Given a single ImportedWorkflowTemplate fixture/input data, tests an non-empty array is returned 
	 * by WorkflowDefinitionImporter#getImportedWorkflows()
	 */	
	public function testGetImportedWorkflowsOne() {
		$name = 'My Workflow 21/02/2014 09-01-29';
		// Pretend a ImportedWorkflowTemplate object has been created by WorkflowBulkLoader
		$this->objFromFixture('ImportedWorkflowTemplate', 'Import01');		
		
		$importer = singleton('WorkflowDefinitionImporter');
		$import = $importer->getImportedWorkflows($name);

		$this->assertNotEmpty($import);

		$this->assertInstanceOf('WorkflowTemplate', $import);

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

		$this->assertEquals($name, $import->getName());

	}
	
	/**
	 * Given many ImportedWorkflowTemplate fixture/input data, tests an non-empty array is returned 
	 * by WorkflowDefinitionImporter#getImportedWorkflows()
	 */	
	public function testGetImportedWorkflowsMany() {
		// Pretend some ImportedWorkflowTemplate objects have been created by WorkflowBulkLoader
		$this->objFromFixture('ImportedWorkflowTemplate', 'Import02');
		$this->objFromFixture('ImportedWorkflowTemplate', 'Import03');
		
		$importer = singleton('WorkflowDefinitionImporter');
		$imports = $importer->getImportedWorkflows();

		$this->assertNotEmpty($imports);

		$this->assertInternalType('array', $imports);

		$this->assertGreaterThan(1, count($imports));

	}	
	
}

1		<?php
2		/**
3		* Tests for workflow import/export logic.
4		*
5		* @author [email protected]
6		* @license BSD License (http://silverstripe.org/bsd-license/)
7		* @package advancedworkflow
8		* @subpackage tests
9		*/
10		class WorkflowImportExportTest extends SapphireTest {
		0 ignored issues – show Coding Style Compatibility introduced 2015-11-21 06:31 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...
11
12		public static $fixture_file = 'advancedworkflow/tests/workflowtemplateimport.yml';
13
14		/**
15		* Utility method, used in tests
16		* @return \WorkflowDefinition
17		*/
18	View Code Duplication	protected function createDefinition() {
		0 ignored issues – show Duplication introduced 2015-11-21 06:31 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...
19		$definition = new WorkflowDefinition();
20		$definition->Title = "Dummy Workflow Definition";
		0 ignored issues – show Documentation introduced 2015-11-21 06:31 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<WorkflowDefinition>`. 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...
21		$definition->write();
22
23		$stepOne = new WorkflowAction();
24		$stepOne->Title = "Step One";
		0 ignored issues – show Documentation introduced 2015-11-21 06:31 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<WorkflowAction>`. 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...
25		$stepOne->WorkflowDefID = $definition->ID;
		0 ignored issues – show Documentation introduced 2015-11-21 06:31 UTC by Report Bug Copy Issue Report The property `WorkflowDefID` does not exist on `object<WorkflowAction>`. 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...
26		$stepOne->write();
27
28		$stepTwo = new WorkflowAction();
29		$stepTwo->Title = "Step Two";
		0 ignored issues – show Documentation introduced 2015-11-21 06:31 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<WorkflowAction>`. 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...
30		$stepTwo->WorkflowDefID = $definition->ID;
		0 ignored issues – show Documentation introduced 2015-11-21 06:31 UTC by Report Bug Copy Issue Report The property `WorkflowDefID` does not exist on `object<WorkflowAction>`. 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...
31		$stepTwo->write();
32
33		$transitionOne = new WorkflowTransition();

silverstripe-australia / advancedworkflow

Push — master ( c44703...1db852 )

WorkflowImportExportTest A

Complexity

Size/Duplication

Coupling/Cohesion

9 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like