Modelarium\Laravel\Console\Commands\WriterTrait

Complexity

Total Complexity

11

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	writeFiles()	0	32	6
A	writeFile()	0	18	5

<?php declare(strict_types=1);

namespace Modelarium\Laravel\Console\Commands;

use Modelarium\Exception\Exception;
use Modelarium\GeneratedCollection;
use Modelarium\GeneratedItem;

trait WriterTrait
{
    /**
     * Write a GeneractedCollection to the filesystem
     *
     * @param GeneratedCollection $collection
     * @param string $basepath
     * @param boolean|callable $overwrite. If a callable expects (GeneratedItem $item): bool
     * @return array The written files with their full path.
     */
    public function writeFiles(GeneratedCollection $collection, string $basepath, $overwrite = true): array
    {
        $writtenFiles = [];
        foreach ($collection as $element) {
            /**
             * @var GeneratedItem $element
             */
            
            $path = $basepath . '/' . $element->filename;
            $o = false;
            if ($element->onlyIfNewFile) {
                $o = false;
            } elseif (is_bool($overwrite)) {
                $o = $overwrite;
            } elseif (is_callable($overwrite)) {
                $o = $overwrite($element);
            } else {
                throw new Exception("Invalid overwrite value on writeFiles");
            }
            $contents = $element->contents;
            if (is_callable($contents)) {
                $contents = $contents($basepath, $element);
            }
        
            $this->writeFile(
                $path,
                $o,
                $contents
            );
            $writtenFiles[] = $path;
        }
        return $writtenFiles;
    }

    /**
     * Takes a stub file and generates the target file with replacements.
     *
     * @param string $targetPath The path for the stub file.
     * @param boolean $overwrite
     * @param string $data The data to write
     * @return void
     */
    protected function writeFile(string $targetPath, bool $overwrite, string $data)
    {
        if (file_exists($targetPath) && !$overwrite) {
            $this->comment("File $targetPath already exists, not overwriting.");

It seems like comment() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return;
        }

        $dir = dirname($targetPath);
        if (!is_dir($dir)) {
            \Safe\mkdir($dir, 0777, true);
        }

        $ret = \Safe\file_put_contents($targetPath, $data);
        if (!$ret) {
            $this->error("Cannot write to $targetPath");

It seems like error() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return;
        }
        $this->line("Wrote $targetPath");

It seems like line() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }
}