Composer::path() - Code Metrics - Inspection of "8cc7c1033a8ee428dd6c405aeb157f3884c3e185" - maestriam/samurai - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Branch — feature/refactoring-samurai (8cc7c1)

by Giuliano

created 2021-07-10 01:09 UTC

Composer::path() A

↳ Parent: Composer

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php

namespace Maestriam\Samurai\Entities;

use Exception;
use Maestriam\Samurai\Contracts\Entities\ComposerContract;
use Maestriam\Samurai\Exceptions\InvalidComposerFileException;

class Composer extends Source implements ComposerContract
{

    
    /**
     * Caminho absoluto do arquivo
     * 
     * @var string
     */
    private string $path;

    /**
     * Descrição do tema
     * 
     * @var string
     */
    private string $desc;

    /**
     * Informações 
     * 
     * @var object
     */
    private object $info;

    /**
     * Nome do template
     * 
     * @var string
     */
    protected string $template = 'composer';    

    /**
     * Instância com as regras de negócio sobre composer.json
     *
     * @param Vendor $vendor
     * @param string $desc
     */
    public function __construct(Theme $theme, string $desc = null)
    {
        $this->setTheme($theme);

        if ($desc) {
            $this->description($desc);
        }
    }

    /**
     * {@inheritDoc}
     */
    public function description(string $desc = null) : string|Composer
    {
        if (! $desc) {
            return $this->getDescription();
        }

        return $this->setDescription($desc);
    }

    /**
     * Verifica se o arquivo já existe dentro do tema
     *
     * @return boolean
     */
    public function exists() : bool
    {
        return $this->fileExists();
    }

    /**
     * Executa a criação de um composer.json dentro do tema
     *
     * @return Composer
     */
    public function create() : Composer
    {
        $info = $this->createFile();

        $this->setPath($info->absolute_path);

        return $this;
    }

    /**
     * Carrega as informações do arquivo composer.json, dentro do tema.  
     *
     * @return Composer
     */
    public function load() : Composer
    {
        $pack = $this->theme()->package();
        
        $content = $this->loadContent();

        $json = json_decode($content);        

        if (! $this->isValid($json)) {           
            throw new InvalidComposerFileException($pack);
        }       
        
        return $this->extract($json);
    }

    /**
     * Retorna as informações do arquivo composer.json
     *
     * @return object
     */
    public function info() : object
    {
        return $this->info;
    }

    /**
     * {@inheritDoc}
     */
    public function preview() : string
    {
        return $this->previewContent();
    }

    /**
     * Retorna o caminho do arquivo composer.json dentro do tema
     *
     * @return string|null
     */
    public function path() : ?string
    {
        return $this->path;
    }

    /**
     * {@inheritDoc}
     */
    protected function placeholders() : array
    {
        return [
            'description' => $this->description(),
            'authorName'  => $this->theme()->author()->name(),
            'authorEmail' => $this->theme()->author()->email(),
            'package'     => $this->theme()->vendor()->package(),
        ];
    }

    /**
     * {@inheritDoc}
     */
    protected function filename() : string
    {
        return 'composer.json';
    }

    /**
     * Define a descrição do tema
     *
     * @param  string $desc
     * @return Composer
     */
    private function setDescription(string $desc) : Composer
    {
        $this->desc = $desc;

        return $this;
    }

    /**
     * Define as informações extraídas do 
     *
     * @param  object $info
     * @return Composer
     */
    private function setInfo(object $info) : Composer
    {
        $this->info = $info;

        return $this;
    }

    /**
     * Retorna a descrição do tema  
     * Se não houver uma descrição definida, retorna a descrição padrão
     * inserida no arquivo config.php 
     *
     * @return string
     */
    private function getDescription() : string
    {
        return $this->desc ?? $this->config()->description();
    }

    /**
     * Verifica se o arquivo composer do tema é válido
     *
     * @param  object $json
     * @return boolean
     */
    private function isValid(object $json) : bool
    {
        $keys = ['name', 'description', 'type', 'require', 'authors'];

        foreach ($keys as $k) {            
            if (! property_exists($json, $k) || $json->$k == null) {
                return false;   
            }            
        }

        if (! is_array($json->authors) || empty($json->authors)) {
            return false;
        }

        return true;
    }
    
    /**
     * Pega as informações do arquivo Json
     *
     * @param  object $json
     * @return Composer
     */
    private function extract(object $json) : Composer
    {
        $this->setInfo($json)->description($json->description);

        return $this;
    }

    /**
     * Define o caminho completo do arquivo composer.json dentro do tema
     *
     * @param  string $path
     * @return Composer
     */
    private function setPath(string $path) : Composer
    {
        if (! is_file($path)) {
            throw new \Exception('');
        }

        $this->path = $path;
        return $this;
    }
}


1			<?php
2
3			namespace Maestriam\Samurai\Entities;
4
5			use Exception;
6			use Maestriam\Samurai\Contracts\Entities\ComposerContract;
7			use Maestriam\Samurai\Exceptions\InvalidComposerFileException;
8
9			class Composer extends Source implements ComposerContract
10			{
11
12
13			/**
14			* Caminho absoluto do arquivo
15			*
16			* @var string
17			*/
18			private string $path;
19
20			/**
21			* Descrição do tema
22			*
23			* @var string
24			*/
25			private string $desc;
26
27			/**
28			* Informações
29			*
30			* @var object
31			*/
32			private object $info;
33
34			/**
35			* Nome do template
36			*
37			* @var string
38			*/
39			protected string $template = 'composer';
40
41			/**
42			* Instância com as regras de negócio sobre composer.json
43			*
44			* @param Vendor $vendor
45			* @param string $desc
46			*/
47			public function __construct(Theme $theme, string $desc = null)
48			{
49			$this->setTheme($theme);
50
51			if ($desc) {
52			$this->description($desc);
53			}
54			}
55
56			/**
57			* {@inheritDoc}
58			*/
59			public function description(string $desc = null) : string\|Composer
60			{
61			if (! $desc) {
62			return $this->getDescription();
63			}
64
65			return $this->setDescription($desc);
66			}
67
68			/**
69			* Verifica se o arquivo já existe dentro do tema
70			*
71			* @return boolean
72			*/
73			public function exists() : bool
74			{
75			return $this->fileExists();
76			}
77
78			/**
79			* Executa a criação de um composer.json dentro do tema
80			*
81			* @return Composer
82			*/
83			public function create() : Composer
84			{
85			$info = $this->createFile();
86
87			$this->setPath($info->absolute_path);
88
89			return $this;
90			}
91
92			/**
93			* Carrega as informações do arquivo composer.json, dentro do tema.
94			*
95			* @return Composer
96			*/
97			public function load() : Composer
98			{
99			$pack = $this->theme()->package();
100
101			$content = $this->loadContent();
102
103			$json = json_decode($content);
104
105			if (! $this->isValid($json)) {
106			throw new InvalidComposerFileException($pack);
107			}
108
109			return $this->extract($json);
110			}
111
112			/**
113			* Retorna as informações do arquivo composer.json
114			*
115			* @return object
116			*/
117			public function info() : object
118			{
119			return $this->info;
120			}
121
122			/**
123			* {@inheritDoc}
124			*/
125			public function preview() : string
126			{
127			return $this->previewContent();
128			}
129
130			/**
131			* Retorna o caminho do arquivo composer.json dentro do tema
132			*
133			* @return string\|null
134			*/
135			public function path() : ?string
136			{
137			return $this->path;
138			}
139
140			/**
141			* {@inheritDoc}
142			*/
143			protected function placeholders() : array
144			{
145			return [
146			'description' => $this->description(),
147			'authorName' => $this->theme()->author()->name(),
148			'authorEmail' => $this->theme()->author()->email(),
149			'package' => $this->theme()->vendor()->package(),
150			];
151			}
152
153			/**
154			* {@inheritDoc}
155			*/
156			protected function filename() : string
157			{
158			return 'composer.json';
159			}
160
161			/**
162			* Define a descrição do tema
163			*
164			* @param string $desc
165			* @return Composer
166			*/
167			private function setDescription(string $desc) : Composer
168			{
169			$this->desc = $desc;
170
171			return $this;
172			}
173
174			/**
175			* Define as informações extraídas do
176			*
177			* @param object $info
178			* @return Composer
179			*/
180			private function setInfo(object $info) : Composer
181			{
182			$this->info = $info;
183
184			return $this;
185			}
186
187			/**
188			* Retorna a descrição do tema
189			* Se não houver uma descrição definida, retorna a descrição padrão
190			* inserida no arquivo config.php
191			*
192			* @return string
193			*/
194			private function getDescription() : string
195			{
196			return $this->desc ?? $this->config()->description();
197			}
198
199			/**
200			* Verifica se o arquivo composer do tema é válido
201			*
202			* @param object $json
203			* @return boolean
204			*/
205			private function isValid(object $json) : bool
206			{
207			$keys = ['name', 'description', 'type', 'require', 'authors'];
208
209			foreach ($keys as $k) {
210			if (! property_exists($json, $k) \|\| $json->$k == null) {
211			return false;
212			}
213			}
214
215			if (! is_array($json->authors) \|\| empty($json->authors)) {
216			return false;
217			}
218
219			return true;
220			}
221
222			/**
223			* Pega as informações do arquivo Json
224			*
225			* @param object $json
226			* @return Composer
227			*/
228			private function extract(object $json) : Composer
229			{
230			$this->setInfo($json)->description($json->description);
231
232			return $this;
233			}
234
235			/**
236			* Define o caminho completo do arquivo composer.json dentro do tema
237			*
238			* @param string $path
239			* @return Composer
240			*/
241			private function setPath(string $path) : Composer
242			{
243			if (! is_file($path)) {
244			throw new \Exception('');
245			}
246
247			$this->path = $path;
248			return $this;
249			}
250			}
251

maestriam / samurai

Branch — feature/refactoring-samurai (8cc7c1)

Composer::path() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like