InteractsWithSourceFiles::fileIsInExcludedPath() - Code Metrics - Inspection of "Refactor, Tiny Enhancements and Bug Fixes" - beyondcode/laravel-query-detector - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#79)

by Mohannad

created 2021-03-05 05:40 UTC

InteractsWithSourceFiles::fileIsInExcludedPath() A

↳ Parent: InteractsWithSourceFiles

Complexity

Conditions	3
Paths	3

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace BeyondCode\QueryDetector\Concerns;

trait InteractsWithSourceFiles
{
    protected function findSource($stack)
    {
        $sources = [];

        foreach ($stack as $index => $trace) {
            $sources[] = $this->parseTrace($index, $trace);
        }

        return array_values(array_filter($sources));
    }

    public function parseTrace($index, array $trace)
    {
        $frame = (object) [
            'index' => $index,
            'name' => null,
            'line' => isset($trace['line']) ? $trace['line'] : '?',
        ];

        if (isset($trace['class']) &&
            isset($trace['file']) &&
            !$this->fileIsInExcludedPath($trace['file'])
        ) {
            $frame->name = $this->normalizeFilename($trace['file']);

            return $frame;
        }

        return false;
    }

    /**
     * Check if the given file is to be excluded from analysis
     *
     * @param string $file
     * @return bool
     */
    protected function fileIsInExcludedPath($file)
    {
        $excludedPaths = [
            '/vendor/laravel/framework/src/Illuminate/Database',
            '/vendor/laravel/framework/src/Illuminate/Events',
        ];

        $normalizedPath = str_replace('\\', '/', $file);

        foreach ($excludedPaths as $excludedPath) {
            if (strpos($normalizedPath, $excludedPath) !== false) {
                return true;
            }
        }

        return false;
    }

    /**
     * Shorten the path by removing the relative links and base dir
     *
     * @param string $path
     * @return string
     */
    protected function normalizeFilename($path): string
    {
        if (file_exists($path)) {
            $path = realpath($path);
        }

        return str_replace(base_path(), '', $path);
    }
}

1			<?php
2
3			namespace BeyondCode\QueryDetector\Concerns;
4
5			trait InteractsWithSourceFiles
6			{
7			protected function findSource($stack)
8			{
9			$sources = [];
10
11			foreach ($stack as $index => $trace) {
12			$sources[] = $this->parseTrace($index, $trace);
13			}
14
15			return array_values(array_filter($sources));
16			}
17
18			public function parseTrace($index, array $trace)
19			{
20			$frame = (object) [
21			'index' => $index,
22			'name' => null,
23			'line' => isset($trace['line']) ? $trace['line'] : '?',
24			];
25
26			if (isset($trace['class']) &&
27			isset($trace['file']) &&
28			!$this->fileIsInExcludedPath($trace['file'])
29			) {
30			$frame->name = $this->normalizeFilename($trace['file']);
31
32			return $frame;
33			}
34
35			return false;
36			}
37
38			/**
39			* Check if the given file is to be excluded from analysis
40			*
41			* @param string $file
42			* @return bool
43			*/
44			protected function fileIsInExcludedPath($file)
45			{
46			$excludedPaths = [
47			'/vendor/laravel/framework/src/Illuminate/Database',
48			'/vendor/laravel/framework/src/Illuminate/Events',
49			];
50
51			$normalizedPath = str_replace('\\', '/', $file);
52
53			foreach ($excludedPaths as $excludedPath) {
54			if (strpos($normalizedPath, $excludedPath) !== false) {
55			return true;
56			}
57			}
58
59			return false;
60			}
61
62			/**
63			* Shorten the path by removing the relative links and base dir
64			*
65			* @param string $path
66			* @return string
67			*/
68			protected function normalizeFilename($path): string
69			{
70			if (file_exists($path)) {
71			$path = realpath($path);
72			}
73
74			return str_replace(base_path(), '', $path);
75			}
76			}

beyondcode / laravel-query-detector

Pull Request — master (#79)

InteractsWithSourceFiles::fileIsInExcludedPath() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like