Added code that allows user to work with different versions. #116

ulin-evgeny · 2024-04-26T06:43:15Z

No description provided.

DenTray · 2024-05-02T02:58:00Z

src/Contracts/VersionEnumContract.php

+
+namespace RonasIT\Support\Contracts;
+
+interface VersionEnumContract {


Suggested change

interface VersionEnumContract {

interface VersionEnumContract

{

DenTray · 2024-05-02T03:01:05Z

src/HelpersServiceProvider.php

@@ -24,6 +27,40 @@ public function boot()
        app(ExcelServiceProvider::class, ['app' => app()])->boot();

        $this->loadViewsFrom(__DIR__ . '/Stubs', 'ronasit');
+
+        /**


let's move it to the separate function extendRouter

please move only router extension to the separate method, not all logic :)

DenTray · 2024-05-02T03:11:24Z

src/Support/Version.php

+    {
+        $route = Route::getRoutes()->match(request());
+
+        return $route->parameters()['version'] ?? str_replace('/v', '', $route->getPrefix());


Suggested change

return $route->parameters()['version'] ?? str_replace('/v', '', $route->getPrefix());

return Arr::get($route->parameters(), 'version', str_replace('/v', '', $route->getPrefix());

DenTray · 2024-05-02T03:14:34Z

src/Support/Version.php

+        return $route->parameters()['version'] ?? str_replace('/v', '', $route->getPrefix());
+    }
+
+    public static function is(VersionEnumContract $checkedVersion): bool


Suggested change

public static function is(VersionEnumContract $checkedVersion): bool

public static function is(VersionEnumContract $expectedVersion): bool

DenTray · 2024-05-02T03:15:20Z

src/Support/Version.php

+    {
+        $version = self::current();
+
+        return $version >= $from->value && $version <= $to->value;


please use version_compare native function instead

DenTray · 2024-05-02T03:28:40Z

tests/TestCase.php

@@ -68,6 +69,13 @@ public function callRawRequest(string $method, string $uri, $content, array $hea
        return $this->call($method, $uri, [], [], [], $server, $content);
    }

+    public function json($method, $uri, array $data = [], array $headers = [], ?VersionEnumContract $apiVersion = null): TestResponse


let's keep this code in EmptyProject repository

DenTray · 2024-05-14T06:28:57Z

src/HelpersServiceProvider.php

@@ -24,6 +27,40 @@ public function boot()
        app(ExcelServiceProvider::class, ['app' => app()])->boot();

        $this->loadViewsFrom(__DIR__ . '/Stubs', 'ronasit');
+
+        /**


please move only router extension to the separate method, not all logic :)

tests/TestCase.php

tests/VersionTest.php

DenTray

please increase test coverage

DenTray · 2024-05-15T03:04:14Z

src/Enum/VersionEnum.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace RonasIT\Support\Enum;


Suggested change

namespace RonasIT\Support\Enum;

namespace RonasIT\Support\Tests\Support\Enum;

src/HelpersServiceProvider.php

DenTray · 2024-05-15T03:06:48Z

src/Enum/VersionEnum.php

+
+use RonasIT\Support\Contracts\VersionEnumContract;
+
+class VersionEnum implements VersionEnumContract


Suggested change

class VersionEnum implements VersionEnumContract

// Backward compatibility with PHP < 8

class VersionEnum implements VersionEnumContract

DenTray · 2024-05-15T03:13:15Z

src/HelpersServiceProvider.php

+            Route::macro('whereIn', function ($parameters, array $values) {
+                return $this->assignExpressionToParameters($parameters, implode('|', $values));
+            });


Suggested change

Route::macro('whereIn', function ($parameters, array $values) {

return $this->assignExpressionToParameters($parameters, implode('|', $values));

});

Route::macro('whereIn', fn ($parameters, array $values) => $this->assignExpressionToParameters($parameters, implode('|', $values)));

DenTray · 2024-05-15T03:13:58Z

src/HelpersServiceProvider.php

+                return $this->where(collect(Arr::wrap($parameters))
+                    ->mapWithKeys(function ($parameter) use ($expression) {
+                        return [$parameter => $expression];
+                    })->all());


Suggested change

return $this->where(collect(Arr::wrap($parameters))

->mapWithKeys(function ($parameter) use ($expression) {

return [$parameter => $expression];

})->all());

return $this

->where(collect(Arr::wrap($parameters))

->mapWithKeys(fn ($parameter) => [$parameter => $expression])

->all());

DenTray · 2024-05-15T03:28:18Z

tests/VersionRouteTest.php

+            $versionFrom = $this->createMock(VersionEnumContract::class);
+            $versionFrom->value = VersionEnum::v1;
+            $versionTo = $this->createMock(VersionEnumContract::class);
+            $versionTo->value = VersionEnum::v2;
+            Route::group(['prefix' => 'v{version}'], function () use ($versionTo, $versionFrom) {
+                Route::get(static::ROUTE_OBJECT, function () {
+                    return 'Route';
+                })->versionRange($versionFrom, $versionTo);
+            });


let's move it to the separate methods of the new trait RouteMockTrait

DenTray · 2024-05-15T03:28:54Z

tests/VersionRouteTest.php

+            $versionFrom = $this->createMock(VersionEnumContract::class);
+            $versionFrom->value = VersionEnum::v11;
+            $versionTo = $this->createMock(VersionEnumContract::class);
+            $versionTo->value = VersionEnum::v12;
+            Route::group(['prefix' => 'v{version}'], function () use ($versionTo, $versionFrom) {
+                RouteFacade::versionRange($versionFrom, $versionTo)->group(function () {
+                    Route::get(static::ROUTE_FACADE, function () {
+                        return 'RouteFacade';
+                    });
+                });
+            });


et's move it to the separate method of the new trait RouteMockTrait

DenTray · 2024-05-15T03:29:21Z

tests/VersionRouteTest.php

+    /**
+     * @dataProvider getTestVersionRangeData
+     */
+    public function testVersionRange(string $version, bool $assert, string $route): void


Suggested change

public function testVersionRange(string $version, bool $assert, string $route): void

public function testVersionRange(string $version, bool $isCorrectVersion, string $route): void

DenTray · 2024-05-15T03:29:29Z

tests/VersionRouteTest.php

+    {
+        $response = $this->get("/v{$version}{$route}");
+
+        $status = $assert ? 200 : 404;


Suggested change

$status = $assert ? 200 : 404;

$status = ($assert) ? 200 : 404;

DenTray · 2024-05-15T03:29:43Z

tests/VersionRouteTest.php

+        return [
+            [
+                'version' => '1',
+                'assert' => true,


Suggested change

'assert' => true,

'is_correct_version' => true,

DenTray · 2024-05-16T17:07:53Z

tests/VersionRouteTest.php

+
+        $this->app->bind(VersionEnumContract::class, VersionEnum::class);
+
+        switch ($this->getProvidedData()['route']) {


please move it to the RouteMockTrait

DenTray · 2024-05-17T11:45:03Z

tests/VersionRouteTest.php

+    public function getTestVersionRangeData(): array
+    {
+        return [
+            // Range


Suggested change

// Range

DenTray · 2024-05-17T11:45:29Z

tests/VersionRouteTest.php

+                'route' => static::ROUTE_FACADE_RANGE,
+            ],
+
+            // From


please implement several tests instead of comments

tests/VersionRouteTest.php

Added code that allows user to work with different versions.

4dad7b0

ulin-evgeny requested a review from DenTray April 26, 2024 06:43

ulin-evgeny assigned ulin-evgeny and DenTray Apr 26, 2024

DenTray requested changes May 2, 2024

View reviewed changes

DenTray removed their assignment May 2, 2024

Made fixes from PR !116.

572ea95

ulin-evgeny assigned DenTray May 6, 2024

Wrote tests for a helper class that checks versions.

cf06ecc

ulin-evgeny force-pushed the versioning branch from cf06ecc to 572ea95 Compare May 6, 2024 14:57

DenTray requested changes May 14, 2024

View reviewed changes

tests/VersionTest.php Outdated Show resolved Hide resolved

DenTray added 2 commits May 14, 2024 12:52

Apply suggestions from code review

33e19a6

Apply suggestions from code review

0279d3d

DenTray reviewed May 14, 2024

View reviewed changes

DenTray removed their assignment May 14, 2024

ulin-evgeny added 3 commits May 15, 2024 00:28

Wrote tests for macros in routing.

a0b24f5

Moved route extension into a method "extendRouter".

f39423d

Merge remote-tracking branch 'origin/versioning' into versioning

8c5a575

DenTray requested changes May 15, 2024

View reviewed changes

ulin-evgeny added 2 commits May 15, 2024 17:41

Merge remote-tracking branch 'origin/master' into versioning

d28aa37

Made edits from PR to improve code formatting.

2ca73ed

DenTray requested changes May 16, 2024

View reviewed changes

ulin-evgeny assigned DenTray May 16, 2024

ulin-evgeny force-pushed the versioning branch from 0275350 to 45a9ec3 Compare May 16, 2024 22:43

Improved tests for routes macros.

19ff088

ulin-evgeny force-pushed the versioning branch from 45a9ec3 to 19ff088 Compare May 16, 2024 23:03

DenTray requested changes May 17, 2024

View reviewed changes

Improved tests for routes macros x2.

721f3fb

ulin-evgeny removed their assignment May 17, 2024

ulin-evgeny assigned ulin-evgeny and unassigned ulin-evgeny May 17, 2024

DenTray requested changes May 20, 2024

View reviewed changes

tests/VersionRouteTest.php Outdated Show resolved Hide resolved

tests/VersionRouteTest.php Outdated Show resolved Hide resolved

Apply suggestions from code review

b7aae60

DenTray approved these changes May 20, 2024

View reviewed changes

DenTray merged commit 878cdba into master May 20, 2024
2 checks passed


		namespace RonasIT\Support\Contracts;

		interface VersionEnumContract {

	interface VersionEnumContract {
	interface VersionEnumContract
	{

	return $route->parameters()['version'] ?? str_replace('/v', '', $route->getPrefix());
	return Arr::get($route->parameters(), 'version', str_replace('/v', '', $route->getPrefix());

	public static function is(VersionEnumContract $checkedVersion): bool
	public static function is(VersionEnumContract $expectedVersion): bool

	namespace RonasIT\Support\Enum;
	namespace RonasIT\Support\Tests\Support\Enum;


		use RonasIT\Support\Contracts\VersionEnumContract;

		class VersionEnum implements VersionEnumContract

	class VersionEnum implements VersionEnumContract
	// Backward compatibility with PHP < 8
	class VersionEnum implements VersionEnumContract

	public function testVersionRange(string $version, bool $assert, string $route): void
	public function testVersionRange(string $version, bool $isCorrectVersion, string $route): void

	$status = $assert ? 200 : 404;
	$status = ($assert) ? 200 : 404;


		$this->app->bind(VersionEnumContract::class, VersionEnum::class);

		switch ($this->getProvidedData()['route']) {

Added code that allows user to work with different versions. #116

Added code that allows user to work with different versions. #116

Conversation

ulin-evgeny commented Apr 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DenTray left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment