Filesystem::delete() - Code Metrics - Inspection of "Clear all logs using the `log-viewer:clear` comman..." - ARCANEDEV/LogViewer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#251)

by ARCANEDEV

created 2018-12-04 09:05 UTC

Filesystem::delete() A

↳ Parent: Filesystem

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0
ccs	3
cts	3
cp	1
crap	2

<?php namespace Arcanedev\LogViewer\Utilities;

use Arcanedev\LogViewer\Contracts\Utilities\Filesystem as FilesystemContract;
use Arcanedev\LogViewer\Exceptions\FilesystemException;
use Illuminate\Filesystem\Filesystem as IlluminateFilesystem;

/**
 * Class     Filesystem
 *
 * @package  Arcanedev\LogViewer\Utilities
 * @author   ARCANEDEV <[email protected]>
 */
class Filesystem implements FilesystemContract
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * The filesystem instance.
     *
     * @var \Illuminate\Filesystem\Filesystem
     */
    protected $filesystem;

    /**
     * The base storage path.
     *
     * @var string
     */
    protected $storagePath;

    /**
     * The log files prefix pattern.
     *
     * @var string
     */
    protected $prefixPattern;

    /**
     * The log files date pattern.
     *
     * @var string
     */
    protected $datePattern;

    /**
     * The log files extension.
     *
     * @var string
     */
    protected $extension;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Filesystem constructor.
     *
     * @param  \Illuminate\Filesystem\Filesystem  $files
     * @param  string                             $storagePath
     */
    public function __construct(IlluminateFilesystem $files, $storagePath)
    {
        $this->filesystem  = $files;
        $this->setPath($storagePath);
        $this->setPattern();
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the files instance.
     *
     * @return \Illuminate\Filesystem\Filesystem
     */
    public function getInstance()
    {
        return $this->filesystem;
    }

    /**
     * Set the log storage path.
     *
     * @param  string  $storagePath
     *
     * @return self
     */
    public function setPath($storagePath)
    {
        $this->storagePath = $storagePath;

        return $this;
    }

    /**
     * Get the log pattern.
     *
     * @return string
     */
    public function getPattern()
    {
        return $this->prefixPattern.$this->datePattern.$this->extension;
    }

    /**
     * Set the log pattern.
     *
     * @param  string  $date
     * @param  string  $prefix
     * @param  string  $extension
     *
     * @return self
     */
    public function setPattern(
        $prefix    = self::PATTERN_PREFIX,
        $date      = self::PATTERN_DATE,
        $extension = self::PATTERN_EXTENSION
    ) {
        $this->setPrefixPattern($prefix);
        $this->setDatePattern($date);
        $this->setExtension($extension);

        return $this;
    }

    /**
     * Set the log date pattern.
     *
     * @param  string  $datePattern
     *
     * @return self
     */
    public function setDatePattern($datePattern)
    {
        $this->datePattern = $datePattern;

        return $this;
    }

    /**
     * Set the log prefix pattern.
     *
     * @param  string  $prefixPattern
     *
     * @return self
     */
    public function setPrefixPattern($prefixPattern)
    {
        $this->prefixPattern = $prefixPattern;

        return $this;
    }

    /**
     * Set the log extension.
     *
     * @param  string  $extension
     *
     * @return self
     */
    public function setExtension($extension)
    {
        $this->extension = $extension;

        return $this;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get all log files.
     *
     * @return array
     */
    public function all()
    {
        return $this->getFiles('*'.$this->extension);
    }

    /**
     * Get all valid log files.
     *
     * @return array
     */
    public function logs()
    {
        return $this->getFiles($this->getPattern());
    }

    /**
     * List the log files (Only dates).
     *
     * @param  bool  $withPaths
     *
     * @return array
     */
    public function dates($withPaths = false)
    {
        $files = array_reverse($this->logs());
        $dates = $this->extractDates($files);

        if ($withPaths) {
            $dates = array_combine($dates, $files); // [date => file]
        }

        return $dates;
    }

    /**
     * Read the log.
     *
     * @param  string  $date
     *
     * @return string
     *
     * @throws \Arcanedev\LogViewer\Exceptions\FilesystemException
     */
    public function read($date)
    {
        try {
            $log = $this->filesystem->get(
                $this->getLogPath($date)
            );
        }
        catch (\Exception $e) {
            throw new FilesystemException($e->getMessage());
        }

        return $log;
    }

    /**
     * Delete the log.
     *
     * @param  string  $date
     *
     * @return bool
     *
     * @throws \Arcanedev\LogViewer\Exceptions\FilesystemException
     */
    public function delete($date)
    {
        $path = $this->getLogPath($date);

        // @codeCoverageIgnoreStart
        if ( ! $this->filesystem->delete($path)) {
            throw new FilesystemException('There was an error deleting the log.');
        }
        // @codeCoverageIgnoreEnd

        return true;
    }

    /**
     * Clear the log files.
     *
     * @return bool
     */
    public function clear()
    {
        return $this->filesystem->delete(
            $this->logs()
        );
    }

    /**
     * Get the log file path.
     *
     * @param  string  $date
     *
     * @return string
     */
    public function path($date)
    {
        return $this->getLogPath($date);
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get all files.
     *
     * @param  string  $pattern
     *
     * @return array
     */
    private function getFiles($pattern)
    {
        $files = $this->filesystem->glob(
            $this->storagePath.DS.$pattern, GLOB_BRACE
        );

        return array_filter(array_map('realpath', $files));
    }

    /**
     * Get the log file path.
     *
     * @param  string  $date
     *
     * @return string
     *
     * @throws \Arcanedev\LogViewer\Exceptions\FilesystemException
     */
    private function getLogPath($date)
    {
        $path = $this->storagePath.DS.$this->prefixPattern.$date.$this->extension;

        if ( ! $this->filesystem->exists($path)) {
            throw new FilesystemException("The log(s) could not be located at : $path");
        }

        return realpath($path);
    }

    /**
     * Extract dates from files.
     *
     * @param  array  $files
     *
     * @return array
     */
    private function extractDates(array $files)
    {
        return array_map(function ($file) {
            return extract_date(basename($file));
        }, $files);
    }
}


1		<?php namespace Arcanedev\LogViewer\Utilities;
2
3		use Arcanedev\LogViewer\Contracts\Utilities\Filesystem as FilesystemContract;
4		use Arcanedev\LogViewer\Exceptions\FilesystemException;
5		use Illuminate\Filesystem\Filesystem as IlluminateFilesystem;
6
7		/**
8		* Class Filesystem
9		*
10		* @package Arcanedev\LogViewer\Utilities
11		* @author ARCANEDEV <[email protected]>
12		*/
13		class Filesystem implements FilesystemContract
14		{
15		/* -----------------------------------------------------------------
16		\| Properties
17		\| -----------------------------------------------------------------
18		*/
19
20		/**
21		* The filesystem instance.
22		*
23		* @var \Illuminate\Filesystem\Filesystem
24		*/
25		protected $filesystem;
26
27		/**
28		* The base storage path.
29		*
30		* @var string
31		*/
32		protected $storagePath;
33
34		/**
35		* The log files prefix pattern.
36		*
37		* @var string
38		*/
39		protected $prefixPattern;
40
41		/**
42		* The log files date pattern.
43		*
44		* @var string
45		*/
46		protected $datePattern;
47
48		/**
49		* The log files extension.
50		*
51		* @var string
52		*/
53		protected $extension;
54
55		/* -----------------------------------------------------------------
56		\| Constructor
57		\| -----------------------------------------------------------------
58		*/
59
60		/**
61		* Filesystem constructor.
62		*
63		* @param \Illuminate\Filesystem\Filesystem $files
64		* @param string $storagePath
65		*/
66	366	public function __construct(IlluminateFilesystem $files, $storagePath)
67		{
68	366	$this->filesystem = $files;
69	366	$this->setPath($storagePath);
70	366	$this->setPattern();
71	366	}
72
73		/* -----------------------------------------------------------------
74		\| Getters & Setters
75		\| -----------------------------------------------------------------
76		*/
77
78		/**
79		* Get the files instance.
80		*
81		* @return \Illuminate\Filesystem\Filesystem
82		*/
83	3	public function getInstance()
84		{
85	3	return $this->filesystem;
86		}
87
88		/**
89		* Set the log storage path.
90		*
91		* @param string $storagePath
92		*
93		* @return self
94		*/
95	366	public function setPath($storagePath)
96		{
97	366	$this->storagePath = $storagePath;
98
99	366	return $this;
100		}
101
102		/**
103		* Get the log pattern.
104		*
105		* @return string
106		*/
107	210	public function getPattern()
108		{
109	210	return $this->prefixPattern.$this->datePattern.$this->extension;
110		}
111
112		/**
113		* Set the log pattern.
114		*
115		* @param string $date
116		* @param string $prefix
117		* @param string $extension
118		*
119		* @return self
120		*/
121	366	public function setPattern(
122		$prefix = self::PATTERN_PREFIX,
123		$date = self::PATTERN_DATE,
124		$extension = self::PATTERN_EXTENSION
125		) {
126	366	$this->setPrefixPattern($prefix);
127	366	$this->setDatePattern($date);
128	366	$this->setExtension($extension);
129
130	366	return $this;
131		}
132
133		/**
134		* Set the log date pattern.
135		*
136		* @param string $datePattern
137		*
138		* @return self
139		*/
140	366	public function setDatePattern($datePattern)
141		{
142	366	$this->datePattern = $datePattern;
143
144	366	return $this;
145		}
146
147		/**
148		* Set the log prefix pattern.
149		*
150		* @param string $prefixPattern
151		*
152		* @return self
153		*/
154	366	public function setPrefixPattern($prefixPattern)
155		{
156	366	$this->prefixPattern = $prefixPattern;
157
158	366	return $this;
159		}
160
161		/**
162		* Set the log extension.
163		*
164		* @param string $extension
165		*
166		* @return self
167		*/
168	366	public function setExtension($extension)
169		{
170	366	$this->extension = $extension;
171
172	366	return $this;
173		}
174
175		/* -----------------------------------------------------------------
176		\| Main Methods
177		\| -----------------------------------------------------------------
178		*/
179
180		/**
181		* Get all log files.
182		*
183		* @return array
184		*/
185	21	public function all()
186		{
187	21	return $this->getFiles('*'.$this->extension);
188		}
189
190		/**
191		* Get all valid log files.
192		*
193		* @return array
194		*/
195	201	public function logs()
196		{
197	201	return $this->getFiles($this->getPattern());
198		}
199
200		/**
201		* List the log files (Only dates).
202		*
203		* @param bool $withPaths
204		*
205		* @return array
206		*/
207	186	public function dates($withPaths = false)
208		{
209	186	$files = array_reverse($this->logs());
210	186	$dates = $this->extractDates($files);
211
212	186	if ($withPaths) {
213	171	$dates = array_combine($dates, $files); // [date => file]
214		}
215
216	186	return $dates;
217		}
218
219		/**
220		* Read the log.
221		*
222		* @param string $date
223		*
224		* @return string
225		*
226		* @throws \Arcanedev\LogViewer\Exceptions\FilesystemException
227		*/
228	249	public function read($date)
229		{
230		try {
231	249	$log = $this->filesystem->get(
232	249	$this->getLogPath($date)
233		);
234		}
235	3	catch (\Exception $e) {
236	3	throw new FilesystemException($e->getMessage());
237		}
238
239	246	return $log;
240		}
241
242		/**
243		* Delete the log.
244		*
245		* @param string $date
246		*
247		* @return bool
248		*
249		* @throws \Arcanedev\LogViewer\Exceptions\FilesystemException
250		*/
251	15	public function delete($date)
252		{
253	15	$path = $this->getLogPath($date);
254
255		// @codeCoverageIgnoreStart
256		if ( ! $this->filesystem->delete($path)) {
257		throw new FilesystemException('There was an error deleting the log.');
258		}
259		// @codeCoverageIgnoreEnd
260
261	9	return true;
262		}
263
264		/**
265		* Clear the log files.
266		*
267		* @return bool
268		*/
269		public function clear()
270		{
271	69	return $this->filesystem->delete(
272		$this->logs()
273	69	);
274		}
275
276		/**
277		* Get the log file path.
278		*
279		* @param string $date
280		*
281		* @return string
282		*/
283		public function path($date)
284		{
285		return $this->getLogPath($date);
286		}
287
288	222	/* -----------------------------------------------------------------
289		\| Other Methods
290	222	\| -----------------------------------------------------------------
291	222	*/
292
293		/**
294	222	* Get all files.
295		*
296		* @param string $pattern
297		*
298		* @return array
299		*/
300		private function getFiles($pattern)
301		{
302		$files = $this->filesystem->glob(
303		$this->storagePath.DS.$pattern, GLOB_BRACE
304		);
305
306	267	return array_filter(array_map('realpath', $files));
307		}
308	267
309		/**
310	267	* Get the log file path.
311	9	*
312		* @param string $date
313		*
314	258	* @return string
315		*
316		* @throws \Arcanedev\LogViewer\Exceptions\FilesystemException
317		*/
318		private function getLogPath($date)
319		{
320		$path = $this->storagePath.DS.$this->prefixPattern.$date.$this->extension;
321
322		if ( ! $this->filesystem->exists($path)) {
323		throw new FilesystemException("The log(s) could not be located at : $path");
324	186	}
325
326		return realpath($path);
327	186	}
328	186
329		/**
330		* Extract dates from files.
331		*
332		* @param array $files
333		*
334		* @return array
335		*/
336		private function extractDates(array $files)
337		{
338		return array_map(function ($file) {
339		return extract_date(basename($file));
340		}, $files);
341		}
342		}
343

ARCANEDEV / LogViewer

Pull Request — master (#251)

Filesystem::delete() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like