LogViewerController::getLogOrFail() - Code Metrics - Inspection of "Fixing the test" - ARCANEDEV/LogViewer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f22255...bc5ff7 )

by ARCANEDEV

created 2018-12-04 09:26 UTC

LogViewerController::getLogOrFail() A

↳ Parent: LogViewerController

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0
ccs	6
cts	6
cp	1
crap	2

<?php namespace Arcanedev\LogViewer\Http\Controllers;

use Arcanedev\LogViewer\Contracts\LogViewer as LogViewerContract;
use Arcanedev\LogViewer\Entities\LogEntry;
use Arcanedev\LogViewer\Exceptions\LogNotFoundException;
use Arcanedev\LogViewer\Tables\StatsTable;
use Illuminate\Http\Request;
use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Routing\Controller;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;

/**
 * Class     LogViewerController
 *
 * @package  LogViewer\Http\Controllers
 * @author   ARCANEDEV <[email protected]>
 */
class LogViewerController extends Controller
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * The log viewer instance
     *
     * @var \Arcanedev\LogViewer\Contracts\LogViewer
     */
    protected $logViewer;

    /** @var int */
    protected $perPage = 30;

    /** @var string */
    protected $showRoute = 'log-viewer::logs.show';

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

    /**
     * LogViewerController constructor.
     *
     * @param  \Arcanedev\LogViewer\Contracts\LogViewer  $logViewer
     */
    public function __construct(LogViewerContract $logViewer)
    {
        $this->logViewer = $logViewer;
        $this->perPage = config('log-viewer.per-page', $this->perPage);
    }

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

    /**
     * Show the dashboard.
     *
     * @return \Illuminate\View\View
     */
    public function index()
    {
        $stats     = $this->logViewer->statsTable();
        $chartData = $this->prepareChartData($stats);
        $percents  = $this->calcPercentages($stats->footer(), $stats->header());

        return $this->view('dashboard', compact('chartData', 'percents'));
    }

    /**
     * List all logs.
     *
     * @param  \Illuminate\Http\Request  $request
     *
     * @return \Illuminate\View\View
     */
    public function listLogs(Request $request)
    {
        $stats   = $this->logViewer->statsTable();
        $headers = $stats->header();
        $rows    = $this->paginate($stats->rows(), $request);

        return $this->view('logs', compact('headers', 'rows'));
    }

    /**
     * Show the log.
     *
     * @param  string                    $date
     * @param  \Illuminate\Http\Request  $request
     *
     * @return \Illuminate\View\View
     */
    public function show($date, Request $request)
    {
        $level   = 'all';
        $log     = $this->getLogOrFail($date);
        $query   = $request->get('query');
        $levels  = $this->logViewer->levelsNames();
        $entries = $log->entries($level)->paginate($this->perPage);

        return $this->view('show', compact('level', 'log', 'query', 'levels', 'entries'));
    }

    /**
     * Filter the log entries by level.
     *
     * @param  string                    $date
     * @param  string                    $level
     * @param  \Illuminate\Http\Request  $request
     *
     * @return \Illuminate\View\View|\Illuminate\Http\RedirectResponse
     */
    public function showByLevel($date, $level, Request $request)
    {
        if ($level === 'all')
            return redirect()->route($this->showRoute, [$date]);

        $log     = $this->getLogOrFail($date);
        $query   = $request->get('query');
        $levels  = $this->logViewer->levelsNames();
        $entries = $this->logViewer->entries($date, $level)->paginate($this->perPage);

        return $this->view('show', compact('level', 'log', 'query', 'levels', 'entries'));
    }

    /**
     * Show the log with the search query.
     *
     * @param  string                    $date
     * @param  string                    $level
     * @param  \Illuminate\Http\Request  $request
     *
     * @return \Illuminate\View\View|\Illuminate\Http\RedirectResponse
     */
    public function search($date, $level = 'all', Request $request)
    {
        $query   = $request->get('query');

        if (is_null($query))
            return redirect()->route($this->showRoute, [$date]);

        $log     = $this->getLogOrFail($date);
        $levels  = $this->logViewer->levelsNames();
        $entries = $log->entries($level)->filter(function (LogEntry $value) use ($query) {
            return Str::contains($value->header, $query);
        })->paginate($this->perPage);

        return $this->view('show', compact('level', 'log', 'query', 'levels', 'entries'));
    }

    /**
     * Download the log
     *
     * @param  string  $date
     *
     * @return \Symfony\Component\HttpFoundation\BinaryFileResponse
     */
    public function download($date)
    {
        return $this->logViewer->download($date);
    }

    /**
     * Delete a log.
     *
     * @param  \Illuminate\Http\Request  $request
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function delete(Request $request)
    {
        abort_unless($request->ajax(), 405, 'Method Not Allowed');

        $date = $request->get('date');

        return response()->json([
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            'result' => $this->logViewer->delete($date) ? 'success' : 'error'
        ]);
    }

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

    /**
     * Get the evaluated view contents for the given view.
     *
     * @param  string  $view
     * @param  array   $data
     * @param  array   $mergeData
     *
     * @return \Illuminate\View\View
     */
    protected function view($view, $data = [], $mergeData = [])
    {
        $theme = config('log-viewer.theme');

        return view()->make("log-viewer::{$theme}.{$view}", $data, $mergeData);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * Paginate logs.
     *
     * @param  array                     $data
     * @param  \Illuminate\Http\Request  $request
     *
     * @return \Illuminate\Pagination\LengthAwarePaginator
     */
    protected function paginate(array $data, Request $request)
    {
        $data = new Collection($data);
        $page = $request->get('page', 1);
        $path = $request->url();

        return new LengthAwarePaginator(
            $data->forPage($page, $this->perPage),
            $data->count(),
            $this->perPage,
            $page,
            compact('path')
        );
    }

    /**
     * Get a log or fail
     *
     * @param  string  $date
     *
     * @return \Arcanedev\LogViewer\Entities\Log|null
     */
    protected function getLogOrFail($date)
    {
        $log = null;

        try {
            $log = $this->logViewer->get($date);
        }
        catch (LogNotFoundException $e) {
            abort(404, $e->getMessage());
        }

        return $log;
    }

    /**
     * Prepare chart data.
     *
     * @param  \Arcanedev\LogViewer\Tables\StatsTable  $stats
     *
     * @return string
     */
    protected function prepareChartData(StatsTable $stats)
    {
        $totals = $stats->totals()->all();

        return json_encode([
            'labels'   => Arr::pluck($totals, 'label'),
            'datasets' => [
                [
                    'data'                 => Arr::pluck($totals, 'value'),
                    'backgroundColor'      => Arr::pluck($totals, 'color'),
                    'hoverBackgroundColor' => Arr::pluck($totals, 'highlight'),
                ],
            ],
        ]);
    }

    /**
     * Calculate the percentage.
     *
     * @param  array  $total
     * @param  array  $names
     *
     * @return array
     */
    protected function calcPercentages(array $total, array $names)
    {
        $percents = [];
        $all      = Arr::get($total, 'all');

        foreach ($total as $level => $count) {
            $percents[$level] = [
                'name'    => $names[$level],
                'count'   => $count,
                'percent' => $all ? round(($count / $all) * 100, 2) : 0,
            ];
        }

        return $percents;
    }
}


Push — master ( f22255...bc5ff7 )

LogViewerController::getLogOrFail() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1		<?php namespace Arcanedev\LogViewer\Http\Controllers;
2
3		use Arcanedev\LogViewer\Contracts\LogViewer as LogViewerContract;
4		use Arcanedev\LogViewer\Entities\LogEntry;
5		use Arcanedev\LogViewer\Exceptions\LogNotFoundException;
6		use Arcanedev\LogViewer\Tables\StatsTable;
7		use Illuminate\Http\Request;
8		use Illuminate\Pagination\LengthAwarePaginator;
9		use Illuminate\Routing\Controller;
10		use Illuminate\Support\Arr;
11		use Illuminate\Support\Collection;
12		use Illuminate\Support\Str;
13
14		/**
15		* Class LogViewerController
16		*
17		* @package LogViewer\Http\Controllers
18		* @author ARCANEDEV <[email protected]>
19		*/
20		class LogViewerController extends Controller
21		{
22		/* -----------------------------------------------------------------
23		\| Properties
24		\| -----------------------------------------------------------------
25		*/
26
27		/**
28		* The log viewer instance
29		*
30		* @var \Arcanedev\LogViewer\Contracts\LogViewer
31		*/
32		protected $logViewer;
33
34		/** @var int */
35		protected $perPage = 30;
36
37		/** @var string */
38		protected $showRoute = 'log-viewer::logs.show';
39
40		/* -----------------------------------------------------------------
41		\| Constructor
42		\| -----------------------------------------------------------------
43		*/
44
45		/**
46		* LogViewerController constructor.
47		*
48		* @param \Arcanedev\LogViewer\Contracts\LogViewer $logViewer
49		*/
50	33	public function __construct(LogViewerContract $logViewer)
51		{
52	33	$this->logViewer = $logViewer;
53	33	$this->perPage = config('log-viewer.per-page', $this->perPage);
54	33	}
55
56		/* -----------------------------------------------------------------
57		\| Main Methods
58		\| -----------------------------------------------------------------
59		*/
60
61		/**
62		* Show the dashboard.
63		*
64		* @return \Illuminate\View\View
65		*/
66	3	public function index()
67		{
68	3	$stats = $this->logViewer->statsTable();
69	3	$chartData = $this->prepareChartData($stats);
70	3	$percents = $this->calcPercentages($stats->footer(), $stats->header());
71
72	3	return $this->view('dashboard', compact('chartData', 'percents'));
73		}
74
75		/**
76		* List all logs.
77		*
78		* @param \Illuminate\Http\Request $request
79		*
80		* @return \Illuminate\View\View
81		*/
82	3	public function listLogs(Request $request)
83		{
84	3	$stats = $this->logViewer->statsTable();
85	3	$headers = $stats->header();
86	3	$rows = $this->paginate($stats->rows(), $request);
87
88	3	return $this->view('logs', compact('headers', 'rows'));
89		}
90
91		/**
92		* Show the log.
93		*
94		* @param string $date
95		* @param \Illuminate\Http\Request $request
96		*
97		* @return \Illuminate\View\View
98		*/
99	6	public function show($date, Request $request)
100		{
101	6	$level = 'all';
102	6	$log = $this->getLogOrFail($date);
103	3	$query = $request->get('query');
104	3	$levels = $this->logViewer->levelsNames();
105	3	$entries = $log->entries($level)->paginate($this->perPage);
106
107	3	return $this->view('show', compact('level', 'log', 'query', 'levels', 'entries'));
108		}
109
110		/**
111		* Filter the log entries by level.
112		*
113		* @param string $date
114		* @param string $level
115		* @param \Illuminate\Http\Request $request
116		*
117		* @return \Illuminate\View\View\|\Illuminate\Http\RedirectResponse
118		*/
119	6	public function showByLevel($date, $level, Request $request)
120		{
121	6	if ($level === 'all')
122	3	return redirect()->route($this->showRoute, [$date]);
123
124	3	$log = $this->getLogOrFail($date);
125	3	$query = $request->get('query');
126	3	$levels = $this->logViewer->levelsNames();
127	3	$entries = $this->logViewer->entries($date, $level)->paginate($this->perPage);
128
129	3	return $this->view('show', compact('level', 'log', 'query', 'levels', 'entries'));
130		}
131
132		/**
133		* Show the log with the search query.
134		*
135		* @param string $date
136		* @param string $level
137		* @param \Illuminate\Http\Request $request
138		*
139		* @return \Illuminate\View\View\|\Illuminate\Http\RedirectResponse
140		*/
141	3	public function search($date, $level = 'all', Request $request)
142		{
143	3	$query = $request->get('query');
144
145	3	if (is_null($query))
146		return redirect()->route($this->showRoute, [$date]);
147
148	3	$log = $this->getLogOrFail($date);
149	3	$levels = $this->logViewer->levelsNames();
150		$entries = $log->entries($level)->filter(function (LogEntry $value) use ($query) {
151	3	return Str::contains($value->header, $query);
152	3	})->paginate($this->perPage);
153
154	3	return $this->view('show', compact('level', 'log', 'query', 'levels', 'entries'));
155		}
156
157		/**
158		* Download the log
159		*
160		* @param string $date
161		*
162		* @return \Symfony\Component\HttpFoundation\BinaryFileResponse
163		*/
164	3	public function download($date)
165		{
166	3	return $this->logViewer->download($date);
167		}
168
169		/**
170		* Delete a log.
171		*
172		* @param \Illuminate\Http\Request $request
173		*
174		* @return \Illuminate\Http\JsonResponse
175		*/
176	9	public function delete(Request $request)
177		{
178	9	abort_unless($request->ajax(), 405, 'Method Not Allowed');
179
180	6	$date = $request->get('date');
181
182	6	return response()->json([
		0 ignored issues – show Bug introduced 2018-09-04 17:59 UTC by Report Bug Copy Issue Report The method `json` does only exist in `Illuminate\Contracts\Routing\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
183	6	'result' => $this->logViewer->delete($date) ? 'success' : 'error'
184		]);
185		}
186
187		/* -----------------------------------------------------------------
188		\| Other Methods
189		\| -----------------------------------------------------------------
190		*/
191
192		/**
193		* Get the evaluated view contents for the given view.
194		*
195		* @param string $view
196		* @param array $data
197		* @param array $mergeData
198		*
199		* @return \Illuminate\View\View
200		*/
201	15	protected function view($view, $data = [], $mergeData = [])
202		{
203	15	$theme = config('log-viewer.theme');
204
205	15	return view()->make("log-viewer::{$theme}.{$view}", $data, $mergeData);
		0 ignored issues – show Bug introduced 2018-02-08 14:37 UTC by Report Bug Copy Issue Report The method `make` does only exist in `Illuminate\Contracts\View\Factory`, but not in `Illuminate\View\View`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
206		}
207
208		/**
209		* Paginate logs.
210		*
211		* @param array $data
212		* @param \Illuminate\Http\Request $request
213		*
214		* @return \Illuminate\Pagination\LengthAwarePaginator
215		*/
216	3	protected function paginate(array $data, Request $request)
217		{
218	3	$data = new Collection($data);
219	3	$page = $request->get('page', 1);
220	3	$path = $request->url();
221
222	3	return new LengthAwarePaginator(
223	3	$data->forPage($page, $this->perPage),
224	3	$data->count(),
225	3	$this->perPage,
226	2	$page,
227	3	compact('path')
228		);
229		}
230
231		/**
232		* Get a log or fail
233		*
234		* @param string $date
235		*
236		* @return \Arcanedev\LogViewer\Entities\Log\|null
237		*/
238	12	protected function getLogOrFail($date)
239		{
240	12	$log = null;
241
242		try {
243	12	$log = $this->logViewer->get($date);
244		}
245	3	catch (LogNotFoundException $e) {
246	3	abort(404, $e->getMessage());
247		}
248
249	9	return $log;
250		}
251
252		/**
253		* Prepare chart data.
254		*
255		* @param \Arcanedev\LogViewer\Tables\StatsTable $stats
256		*
257		* @return string
258		*/
259	3	protected function prepareChartData(StatsTable $stats)
260		{
261	3	$totals = $stats->totals()->all();
262
263	3	return json_encode([
264	3	'labels' => Arr::pluck($totals, 'label'),
265		'datasets' => [
266		[
267	3	'data' => Arr::pluck($totals, 'value'),
268	3	'backgroundColor' => Arr::pluck($totals, 'color'),
269	3	'hoverBackgroundColor' => Arr::pluck($totals, 'highlight'),
270		],
271		],
272		]);
273		}
274
275		/**
276		* Calculate the percentage.
277		*
278		* @param array $total
279		* @param array $names
280		*
281		* @return array
282		*/
283	3	protected function calcPercentages(array $total, array $names)
284		{
285	3	$percents = [];
286	3	$all = Arr::get($total, 'all');
287
288	3	foreach ($total as $level => $count) {
289	3	$percents[$level] = [
290	3	'name' => $names[$level],
291	3	'count' => $count,
292	3	'percent' => $all ? round(($count / $all) * 100, 2) : 0,
293		];
294		}
295
296	3	return $percents;
297		}
298		}
299

ARCANEDEV / LogViewer

Push — master ( f22255...bc5ff7 )

LogViewerController::getLogOrFail() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like