SmartWeb\ModuleTesting\Generator\BaseTestGenerator

Complexity

Total Complexity

11

Size/Duplication

Total Lines	157
Duplicated Lines	6.37 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	getBaseClass()	0	4	1
A	prepareSettings()	0	4	1
	getBaseSettings()	0	1	?
A	getSuiteSettings()	0	4	1
A	getSettingsForModule()	0	4	1
A	generate()	0	9	1
A	prepareName()	0	6	2
A	createFile()	10	10	2
A	getPath()	0	4	1

<?php


namespace SmartWeb\ModuleTesting\Generator;

use Codeception\Configuration;
use Illuminate\Contracts\Filesystem\FileNotFoundException;
use Illuminate\Contracts\Filesystem\Filesystem;
use Illuminate\Support\Str;
use SmartWeb\ModuleTesting\Codeception\SetupInterface;
use SmartWeb\ModuleTesting\Template\TemplateFactory;
use SmartWeb\ModuleTesting\Util\Template;
use const DIRECTORY_SEPARATOR;
use function array_merge;


/**
 * Class BaseTestGenerator
 *
 * @package SmartWeb\ModuleTesting\Generator
 */
abstract class BaseTestGenerator
{
    
    /**
     * @var CodeceptionTestType
     */
    protected $type;
    
    /**
     * @var Filesystem
     */
    protected $disk;
    
    /**
     * @var SetupInterface
     */
    protected $setup;
    
    /**
     * @var string
     */
    protected $suite;
    
    /**
     * @var string
     */
    protected $name;
    
    /**
     * @var array
     */
    protected $settings;
    
    /**
     * Key used to identify the template to use for generating test files.
     *
     * @var string
     */
    protected $templateKey;
    
    /**
     * BaseTestGenerator constructor.
     *
     * @param CodeceptionTestType $type
     * @param SetupInterface      $setup
     * @param string              $suite
     * @param string              $name
     * @param array               $settings
     *
     * @throws \Exception
     */
    public function __construct(CodeceptionTestType $type, SetupInterface $setup, string $suite, string $name, array $settings = [])
    {
        $this->type = $type;
        $this->setup = $setup;
        $this->disk = $setup->getDisk();
        $this->suite = $suite;
        $this->name = $this->prepareName($name);
        $this->settings = $settings;
        $this->templateKey = $this->type . '.' . Str::lower($this->suite);
    }
    
    /**
     * @return string
     */
    final protected function getBaseClass() : string
    {
        return Template::getBaseTestClass($this->suite, $this->type);
    }
    
    /**
     * @param array $settings
     *
     * @return array
     */
    final protected function prepareSettings(array $settings) : array
    {
        return array_merge($this->getBaseSettings(), $settings);
    }
    
    /**
     * @return array
     */
    abstract protected function getBaseSettings() : array;
    
    /**
     * @param string $suite
     *
     * @return array
     * @throws \Exception
     */
    final protected function getSuiteSettings(string $suite) : array
    {
        return Configuration::suiteSettings($suite, $this->getSettingsForModule());
    }
    
    /**
     * @return array
     * @throws \Codeception\Exception\ConfigurationException
     */
    final protected function getSettingsForModule()
    {
        return Configuration::config($this->setup->getWorkDir());
    }
    
    /**
     * @throws FileNotFoundException
     */
    final public function generate()
    {
        $factory = new TemplateFactory();
        $fileContents = $factory->getTemplate($this->templateKey)->produceWith($this->prepareSettings($this->settings));
        
        $path = $this->suite . DIRECTORY_SEPARATOR . $this->name . Str::ucfirst($this->type) . '.php';
        
        $this->createFile($path, $fileContents);
    }
    
    /**
     * @param string $name
     *
     * @return string
     */
    final protected function prepareName(string $name) : string
    {
        return Str::endsWith($name, Str::ucfirst($this->type))
            ? Str::replaceLast(Str::ucfirst($this->type), '', $name)
            : $name;
    }
    
    /**
     * @param string $path
     * @param        $contents
     *
     * @return bool
     */
    final protected function createFile(string $path, $contents) : bool

This method seems to be duplicated in your project.

    {
        $path = $this->getPath($path);
        
        if (!$this->disk->exists($path)) {
            return $this->disk->put($path, $contents);
        }
        
        return false;
    }
    
    /**
     * @param string $path
     *
     * @return string
     */
    final protected function getPath(string $path) : string
    {
        return $this->setup->getWorkDir() . DIRECTORY_SEPARATOR . $this->setup->getTestsDir() . DIRECTORY_SEPARATOR . $path;
    }
}