UrlService::validatePath() - Code Metrics - Inspection of "update url controller" - devpri/tinre-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e84f2b...628701 )

by Paul

created 2020-08-27 08:51 UTC

UrlService::validatePath() A

↳ Parent: UrlService

Complexity

Conditions	3
Paths	3

Size

Total Lines	21
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	1	Features	0

Metric	Value
cc	3
eloc	12
c	4
b	1
f	0
nc	3
nop	1
dl	0
loc	21
rs	9.8666

<?php

namespace Devpri\Tinre\Services;

use Devpri\Tinre\Models\Url;
use Exception;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Validator;
use Illuminate\Support\Str;
use Illuminate\Validation\ValidationException;

class UrlService
{

    public function index(Request $request)
    {
        $request->validate([
            'search' => ['nullable', 'string'],
            'date' => ['nullable', 'array'],
            'limit' => ['nullable', 'number', 'min:1', 'max:100'],
            'active' => ['nullable', 'boolean'],
            'sort_by' => ['nullable', 'in:created_at,updated_at,clicks'],
            'sort_direction' => ['nullable', 'in:asc,desc']
        ]);
        
        $user = $request->user();
        $search = $request->search;
        $date = $request->date;
        $limit = $request->limit ?? 30;
        $active =$request->active;
        $sortBy = $request->sort_by ?? 'created_at';
        $sortDirection = $request->sort_direction ?? 'desc';
                
        $query = Url::query();

        if ($user->cant('viewAny', Url::class)) {
            $query->where('user_id', $user->id);
        }

        if ($search) {
            $query->where(function (Builder $query) use ($search) {
                $query->where('path', 'LIKE', "%{$search}%")
                    ->orWhere('long_url', 'LIKE', "%{$search}%")
                    ->orWhereHas('user', function ($query) use ($search) {
                        $query->where('name', 'LIKE', "%{$search}%")
                            ->orWhere('email', 'LIKE', "%{$search}%");
                    });
            });
        }

        if ($date) {
            $query->whereBetween('created_at', $date);
        }
        
        if(isset($active)) {
            $query->where('active', $active);
        }
        
        return $query->orderBy($sortBy, $sortDirection)->with('user')->paginate($limit);
    }

    public function create(Request $request): Url
    {
        $this->validateUrl($request->long_url);

        $user = $request->user();

        if ($user && $user->cant('create', Url::class)) {
            abort(401);
        }
        
        $url = new Url();
        $url->long_url = $request->long_url;
        $url->user_id = $user ? $user->id : null;

        if ($request->path && ($user || config('tinre.guest_form_custom_path'))) {
            $url->path = $request->path;

            $this->validatePath($url->path);

            $url->save();

            return $url;
        }

        $maxGenerationAttempts = 5;

        while ($maxGenerationAttempts-- > 0) {
            try {
                $url->path = strtolower(Str::random(config('tinre.default_path_length')));

                $this->validatePath($url->path);

                $url->save();

                return $url;
            } catch (Exception $e) {
                if ($maxGenerationAttempts === 0) {
                    throw $e;
                }
            }
        }
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
    }

    public function update(Request $request, $id)
    {
        $request->validate([
            'active' => ['required', 'boolean'],
        ]);

        $this->validateUrl($request->long_url);
        
        $url = Url::where('id', $id)->firstOrFail();

        if($url->path != $request->path) {
            $this->validatePath($request->path);
        }
        
        $user = $request->user();

        if ($user->cant('update', $url)) {
            abort(401);
        }

        $url->active = $request->active;
        $url->long_url = $request->long_url;
        $url->path = $request->path;
        $url->save();

        return $url;
    }

    protected function validatePath($path): void
    {
        Validator::make([
            'path' => $path
        ], [
            'path' => ['required', 'alpha_dash', 'min:'.config('tinre.min_path_length'), 'max:'.config('tinre.max_path_length')],
        ])->validate();
        
        $path = strtolower($path);

        $url = DB::table('urls')->whereRaw('lower(path) like (?)', ["%{$path}%"])->count();

        if ($url) {
            throw ValidationException::withMessages([
                'path' => [__('The path has already been taken.')],
            ]);
        }

        if (in_array($path, config('tinre.restricted_paths'))) {
            throw ValidationException::withMessages([
                'path' => [__('Restricted path.')],
            ]);
        }
    }

    protected function validateUrl($url): void
    {
        Validator::make([
            'long_url' => $url
        ], [
            'long_url' => ['required', 'url', 'active_url'],
        ])->validate();
        
        if (in_array(parse_url($url, PHP_URL_HOST), config('tinre.restricted_domains'))) {
            throw ValidationException::withMessages([
                'long_url' => [__('Restricted domain.')],
            ]);
        }
    }
}


1			<?php
2
3			namespace Devpri\Tinre\Services;
4
5			use Devpri\Tinre\Models\Url;
6			use Exception;
7			use Illuminate\Database\Eloquent\Builder;
8			use Illuminate\Http\Request;
9			use Illuminate\Support\Facades\DB;
10			use Illuminate\Support\Facades\Validator;
11			use Illuminate\Support\Str;
12			use Illuminate\Validation\ValidationException;
13
14			class UrlService
15			{
16
17			public function index(Request $request)
18			{
19			$request->validate([
20			'search' => ['nullable', 'string'],
21			'date' => ['nullable', 'array'],
22			'limit' => ['nullable', 'number', 'min:1', 'max:100'],
23			'active' => ['nullable', 'boolean'],
24			'sort_by' => ['nullable', 'in:created_at,updated_at,clicks'],
25			'sort_direction' => ['nullable', 'in:asc,desc']
26			]);
27
28			$user = $request->user();
29			$search = $request->search;
30			$date = $request->date;
31			$limit = $request->limit ?? 30;
32			$active =$request->active;
33			$sortBy = $request->sort_by ?? 'created_at';
34			$sortDirection = $request->sort_direction ?? 'desc';
35
36			$query = Url::query();
37
38			if ($user->cant('viewAny', Url::class)) {
39			$query->where('user_id', $user->id);
40			}
41
42			if ($search) {
43			$query->where(function (Builder $query) use ($search) {
44			$query->where('path', 'LIKE', "%{$search}%")
45			->orWhere('long_url', 'LIKE', "%{$search}%")
46			->orWhereHas('user', function ($query) use ($search) {
47			$query->where('name', 'LIKE', "%{$search}%")
48			->orWhere('email', 'LIKE', "%{$search}%");
49			});
50			});
51			}
52
53			if ($date) {
54			$query->whereBetween('created_at', $date);
55			}
56
57			if(isset($active)) {
58			$query->where('active', $active);
59			}
60
61			return $query->orderBy($sortBy, $sortDirection)->with('user')->paginate($limit);
62			}
63
64			public function create(Request $request): Url
65			{
66			$this->validateUrl($request->long_url);
67
68			$user = $request->user();
69
70			if ($user && $user->cant('create', Url::class)) {
71			abort(401);
72			}
73
74			$url = new Url();
75			$url->long_url = $request->long_url;
76			$url->user_id = $user ? $user->id : null;
77
78			if ($request->path && ($user \|\| config('tinre.guest_form_custom_path'))) {
79			$url->path = $request->path;
80
81			$this->validatePath($url->path);
82
83			$url->save();
84
85			return $url;
86			}
87
88			$maxGenerationAttempts = 5;
89
90			while ($maxGenerationAttempts-- > 0) {
91			try {
92			$url->path = strtolower(Str::random(config('tinre.default_path_length')));
93
94			$this->validatePath($url->path);
95
96			$url->save();
97
98			return $url;
99			} catch (Exception $e) {
100			if ($maxGenerationAttempts === 0) {
101			throw $e;
102			}
103			}
104			}
			0 ignored issues – show Bug Best Practice introduced 2020-08-27 08:56 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `Devpri\Tinre\Models\Url`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history...
105			}
106
107			public function update(Request $request, $id)
108			{
109			$request->validate([
110			'active' => ['required', 'boolean'],
111			]);
112
113			$this->validateUrl($request->long_url);
114
115			$url = Url::where('id', $id)->firstOrFail();
116
117			if($url->path != $request->path) {
118			$this->validatePath($request->path);
119			}
120
121			$user = $request->user();
122
123			if ($user->cant('update', $url)) {
124			abort(401);
125			}
126
127			$url->active = $request->active;
128			$url->long_url = $request->long_url;
129			$url->path = $request->path;
130			$url->save();
131
132			return $url;
133			}
134
135			protected function validatePath($path): void
136			{
137			Validator::make([
138			'path' => $path
139			], [
140			'path' => ['required', 'alpha_dash', 'min:'.config('tinre.min_path_length'), 'max:'.config('tinre.max_path_length')],
141			])->validate();
142
143			$path = strtolower($path);
144
145			$url = DB::table('urls')->whereRaw('lower(path) like (?)', ["%{$path}%"])->count();
146
147			if ($url) {
148			throw ValidationException::withMessages([
149			'path' => [__('The path has already been taken.')],
150			]);
151			}
152
153			if (in_array($path, config('tinre.restricted_paths'))) {
154			throw ValidationException::withMessages([
155			'path' => [__('Restricted path.')],
156			]);
157			}
158			}
159
160			protected function validateUrl($url): void
161			{
162			Validator::make([
163			'long_url' => $url
164			], [
165			'long_url' => ['required', 'url', 'active_url'],
166			])->validate();
167
168			if (in_array(parse_url($url, PHP_URL_HOST), config('tinre.restricted_domains'))) {
169			throw ValidationException::withMessages([
170			'long_url' => [__('Restricted domain.')],
171			]);
172			}
173			}
174			}
175

devpri / tinre-core

Push — master ( e84f2b...628701 )

UrlService::validatePath() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like