Processor::setSourcePath() - Code Metrics - Inspection of "[10.x] Minor fix for structure correction of the `..." - andrey-helldar/laravel-lang-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#123)

by Andrey

created 2021-06-16 16:04 UTC

Processor::setSourcePath() A

↳ Parent: Processor

Complexity

Conditions	5
Paths	16

Size

Total Lines	21
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	13
nc	16
nop	2
dl	0
loc	21
ccs	13
cts	13
cp	1
crap	5
rs	9.5222
c	1
b	0
f	0

<?php

namespace Helldar\LaravelLangPublisher\Services\Processors;

use Helldar\LaravelLangPublisher\Concerns\Containable;
use Helldar\LaravelLangPublisher\Concerns\Contains;
use Helldar\LaravelLangPublisher\Concerns\Logger;
use Helldar\LaravelLangPublisher\Concerns\Pathable;
use Helldar\LaravelLangPublisher\Constants\Locales;
use Helldar\LaravelLangPublisher\Contracts\Processor as Contract;
use Helldar\LaravelLangPublisher\Services\Comparators\Manage;
use Helldar\LaravelLangPublisher\Services\Filesystem\Manager;
use Helldar\Support\Concerns\Makeable;
use Helldar\Support\Facades\Helpers\Filesystem\File;

abstract class Processor implements Contract
{
    use Containable;
    use Contains;
    use Logger;

    use Makeable;
    use Pathable;

    protected $package;

    protected $locale;

    protected $source_path;

    protected $target_path;

    protected $main_path;

    protected $force;

    protected $full = false;

    public function package(string $package): Contract
    {
        $this->package = $package;

        return $this;
    }

    public function locale(string $locale): Contract
    {
        $this->locale = $locale;

        return $this;
    }

    public function sourceFilename(string $filename, bool $is_inline = true): Contract
    {
        $this->setSourcePath($filename, $is_inline);

        return $this;
    }

    public function targetFilename(string $filename): Contract
    {
        $this->setTargetPath($filename);
        $this->setMainPath($filename);

        return $this;
    }

    public function force(bool $force = false): Contract
    {
        $this->force = $force;

        return $this;
    }

    public function full(bool $full = false): Contract
    {
        $this->full = $full;

        return $this;
    }

    public function whenPackage(?string $package): Contract
    {
        if ($package) {
            $this->package($package);
        }

        return $this;
    }

    public function whenLocale(?string $locale): Contract
    {
        if ($locale) {
            $this->locale($locale);
        }

        return $this;
    }

    public function whenSourceFilename(?string $filename, bool $is_inline = true): Contract
    {
        if ($filename) {
            $this->sourceFilename($filename, $is_inline);
        }

        return $this;
    }

    public function whenTargetFilename(?string $filename): Contract
    {
        if ($filename) {
            $this->targetFilename($filename);
        }

        return $this;
    }

    protected function main(): void
    {
        $this->process($this->source_path, $this->target_path, $this->main_path);
    }

    protected function process(string $source_path, string $target_path, string $main_path = null): void
    {
        $this->log('The process of processing a file from', $source_path, 'to', $target_path, 'has begun.');

        $source = $this->load($source_path, $main_path);
        $target = $this->load($target_path);

        $result = $this->compare($source, $target);

        $this->store($target_path, $result);
    }

    protected function setSourcePath(string $filename, bool $is_inline): void
    {
        $this->log('Setting the path to the source file:', $filename);

        $path = $this->isJson($filename)
            ? $this->pathSource($this->package, Locales::ENGLISH)
            : $this->pathSource($this->package, $this->locale);

        if ($is_inline) {
            $this->log('The', $filename, '(is inline: ', $is_inline, ')', 'file is a collection of inline messages...');

            $directory = $this->pathDirectory($filename);
            $name      = $this->pathFilename($filename);
            $extension = $this->pathExtension($filename);

            $inline_file = $directory . '/' . $name . '-inline.' . $extension;
        }

        $this->source_path = $is_inline && File::exists($path . '/' . $inline_file)

            ? $path . '/' . $inline_file
            : $path . '/' . $filename;
    }

    protected function setTargetPath(string $filename): void
    {
        $this->log('Setting the path to the target file:', $filename);

        $this->target_path = $this->pathTargetFull($this->locale, $filename);
    }

    protected function setMainPath(string $filename): void
    {
        $this->log('Setting the path to the json main file with', $filename);

        if ($this->isJson($filename)) {
            $path = $this->pathSource($this->package, $this->locale);

            $file = $this->locale . '.json';

            $this->main_path = $path . '/' . $file;
        }
    }

    protected function compare(array $source, array $target): array
    {
        $this->log('Find an object and perform object comparison.');

        return Manage::make()
            ->filename($this->source_path)
            ->full($this->full)
            ->source($source)
            ->target($target)
            ->find()
            ->toArray();
    }

    protected function load(string $path, string $filename = null): array
    {
        $this->log('Loading an array:', $path, $filename);

        return $this->manager()->load($path, $filename);
    }

    protected function store(string $path, array $content): void
    {
        $this->log('Saving an array to a file:', $path);

        $this->manager()->store($path, $content);
    }

    protected function manager(): Manager
    {
        $this->log('Getting a comparison object...');

        return $this->container(Manager::class);
    }

    protected function doesntExists(): bool
    {
        $this->log('Checking for the existence of a file:', $this->target_path);

        return ! File::exists($this->target_path);
    }
}


1		<?php
2
3		namespace Helldar\LaravelLangPublisher\Services\Processors;
4
5		use Helldar\LaravelLangPublisher\Concerns\Containable;
6		use Helldar\LaravelLangPublisher\Concerns\Contains;
7		use Helldar\LaravelLangPublisher\Concerns\Logger;
8		use Helldar\LaravelLangPublisher\Concerns\Pathable;
9		use Helldar\LaravelLangPublisher\Constants\Locales;
10		use Helldar\LaravelLangPublisher\Contracts\Processor as Contract;
11		use Helldar\LaravelLangPublisher\Services\Comparators\Manage;
12		use Helldar\LaravelLangPublisher\Services\Filesystem\Manager;
13		use Helldar\Support\Concerns\Makeable;
14		use Helldar\Support\Facades\Helpers\Filesystem\File;
15
16		abstract class Processor implements Contract
17		{
18		use Containable;
19		use Contains;
20		use Logger;
		0 ignored issues – show Bug introduced 2021-04-14 18:41 UTC by Report Bug Copy Issue Report The trait `Helldar\LaravelLangPublisher\Concerns\Logger` requires the property `$output` which is not provided by `Helldar\LaravelLangPubli...es\Processors\Processor`. Loading history...
21		use Makeable;
22		use Pathable;
23
24		protected $package;
25
26		protected $locale;
27
28		protected $source_path;
29
30		protected $target_path;
31
32		protected $main_path;
33
34		protected $force;
35	28
36		protected $full = false;
37	28
38		public function package(string $package): Contract
39	28	{
40		$this->package = $package;
41
42	30	return $this;
43		}
44	30
45		public function locale(string $locale): Contract
46	30	{
47		$this->locale = $locale;
48
49	28	return $this;
50		}
51	28
52		public function sourceFilename(string $filename, bool $is_inline = true): Contract
53	28	{
54		$this->setSourcePath($filename, $is_inline);
55
56	28	return $this;
57		}
58	28
59		public function targetFilename(string $filename): Contract
60	28	{
61		$this->setTargetPath($filename);
62		$this->setMainPath($filename);
63	30
64		return $this;
65	30	}
66
67	30	public function force(bool $force = false): Contract
68		{
69		$this->force = $force;
70	4
71		return $this;
72	4	}
73
74	4	public function full(bool $full = false): Contract
75		{
76		$this->full = $full;
77	30
78		return $this;
79	30	}
80	28
81		public function whenPackage(?string $package): Contract
82		{
83	30	if ($package) {
84		$this->package($package);
85		}
86	30
87		return $this;
88	30	}
89	30
90		public function whenLocale(?string $locale): Contract
91		{
92	30	if ($locale) {
93		$this->locale($locale);
94		}
95	30
96		return $this;
97	30	}
98	28
99		public function whenSourceFilename(?string $filename, bool $is_inline = true): Contract
100		{
101	30	if ($filename) {
102		$this->sourceFilename($filename, $is_inline);
103		}
104	30
105		return $this;
106	30	}
107	28
108		public function whenTargetFilename(?string $filename): Contract
109		{
110	30	if ($filename) {
111		$this->targetFilename($filename);
112		}
113	28
114		return $this;
115	28	}
116	28
117		protected function main(): void
118	28	{
119		$this->process($this->source_path, $this->target_path, $this->main_path);
120	28	}
121
122	28	protected function process(string $source_path, string $target_path, string $main_path = null): void
123	28	{
124		$this->log('The process of processing a file from', $source_path, 'to', $target_path, 'has begun.');
125	28
126		$source = $this->load($source_path, $main_path);
127	28	$target = $this->load($target_path);
128	28
129		$result = $this->compare($source, $target);
130	28
131		$this->store($target_path, $result);
132	28	}
133
134	28	protected function setSourcePath(string $filename, bool $is_inline): void
135		{
136	28	$this->log('Setting the path to the source file:', $filename);
137	15
138		$path = $this->isJson($filename)
139	15	? $this->pathSource($this->package, Locales::ENGLISH)
140	15	: $this->pathSource($this->package, $this->locale);
141	15
142		if ($is_inline) {
143	15	$this->log('The', $filename, '(is inline: ', $is_inline, ')', 'file is a collection of inline messages...');
144
145		$directory = $this->pathDirectory($filename);
146	28	$name = $this->pathFilename($filename);
147	15	$extension = $this->pathExtension($filename);
148	28
149	28	$inline_file = $directory . '/' . $name . '-inline.' . $extension;
150		}
151	28
152		$this->source_path = $is_inline && File::exists($path . '/' . $inline_file)
		0 ignored issues – show Comprehensibility Best Practice introduced 2021-05-20 18:23 UTC by Report Bug Copy Issue Report The variable `$inline_file` does not seem to be defined for all execution paths leading up to this point. Loading history...
153	28	? $path . '/' . $inline_file
154		: $path . '/' . $filename;
155	28	}
156	28
157		protected function setTargetPath(string $filename): void
158	28	{
159		$this->log('Setting the path to the target file:', $filename);
160	28
161		$this->target_path = $this->pathTargetFull($this->locale, $filename);
162	28	}
163	28
164	28	protected function setMainPath(string $filename): void
165	28	{
166	28	$this->log('Setting the path to the json main file with', $filename);
167	28
168	28	if ($this->isJson($filename)) {
169		$path = $this->pathSource($this->package, $this->locale);
170
171	28	$file = $this->locale . '.json';
172
173	28	$this->main_path = $path . '/' . $file;
174		}
175	28	}
176
177		protected function compare(array $source, array $target): array
178	28	{
179		$this->log('Find an object and perform object comparison.');
180	28
181		return Manage::make()
182	28	->filename($this->source_path)
183	28	->full($this->full)
184		->source($source)
185	28	->target($target)
186		->find()
187	28	->toArray();
188		}
189	28
190		protected function load(string $path, string $filename = null): array
191		{
192	12	$this->log('Loading an array:', $path, $filename);
193
194	12	return $this->manager()->load($path, $filename);
195		}
196	12
197		protected function store(string $path, array $content): void
198		{
199		$this->log('Saving an array to a file:', $path);
200
201		$this->manager()->store($path, $content);
202		}
203
204		protected function manager(): Manager
205		{
206		$this->log('Getting a comparison object...');
207
208		return $this->container(Manager::class);
209		}
210
211		protected function doesntExists(): bool
212		{
213		$this->log('Checking for the existence of a file:', $this->target_path);
214
215		return ! File::exists($this->target_path);
216		}
217		}
218

andrey-helldar / laravel-lang-publisher

Pull Request — main (#123)

Processor::setSourcePath() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like