ApiResourceServiceProvider::handleSerializerCache() - Code Metrics - Inspection of "make cache bridge optional, so it is easier to upg..." - pjordaan/laravel-apie - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — feature-cache-bridge-optional (cb5811)

by Pieter

created 2019-11-26 15:18 UTC

handleSerializerCache() A

↳ Parent: ApiResourceServiceProvider

Complexity

Conditions	3
Paths	3

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace W2w\Laravel\Apie\Providers;

use DateTimeInterface;
use erasys\OpenApi\Spec\v3\Contact;
use erasys\OpenApi\Spec\v3\Info;
use erasys\OpenApi\Spec\v3\License;
use erasys\OpenApi\Spec\v3\Schema;
use Illuminate\Contracts\Cache\Repository as CacheRepository;
use Illuminate\Contracts\Cache\Repository;
use Illuminate\Http\Request;
use Illuminate\Support\ServiceProvider;
use Madewithlove\IlluminatePsrCacheBridge\Laravel\CacheItemPool;
filter:
    dependency_paths: ["lib/*"]
use Ramsey\Uuid\Uuid;
use Symfony\Component\Cache\Adapter\ArrayAdapter;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Serializer\SerializerInterface;
use W2w\Laravel\Apie\Services\Retrievers\DatabaseQueryRetriever;
use W2w\Laravel\Apie\Services\Retrievers\EloquentModelDataLayer;
use W2w\Lib\Apie\ApiResourceFacade;
use W2w\Lib\Apie\ApiResourceFactory;
use W2w\Lib\Apie\IdentifierExtractor;
use W2w\Lib\Apie\Mocks\MockApiResourceDataLayer;
use W2w\Lib\Apie\Mocks\MockApiResourceFactory;
use W2w\Lib\Apie\OpenApiSchema\OpenApiSpecGenerator;
use W2w\Lib\Apie\OpenApiSchema\SchemaGenerator;
use W2w\Lib\Apie\Resources\ApiResources;
use W2w\Lib\Apie\Resources\ApiResourcesInterface;
use W2w\Lib\Apie\Retrievers\ApplicationInfoRetriever;
use W2w\Lib\Apie\Retrievers\FileStorageDataLayer;
use W2w\Lib\Apie\Retrievers\StatusCheckRetriever;
use W2w\Laravel\Apie\Services\StatusChecks\StatusFromDatabaseRetriever;
use W2w\Lib\Apie\ServiceLibraryFactory;

/**
 * Install apie classes to Laravel.
 */
class ApiResourceServiceProvider extends ServiceProvider
{
    /**
     * Perform post-registration booting of services.
     *
     * @return void
     */
    public function boot()
    {
        if (function_exists('config_path')) {
            $this->publishes(
                [
                    __DIR__ . '/../../config/apie.php' => config_path('apie.php'),
                ]
            );
        }

        $this->loadMigrationsFrom(__DIR__ . '/../../migrations');
    }

    /**
     * Register any application services.
     */
    public function register()
    {
        $this->app->singleton('apie.config', function () {
            $config = $this->app->get('config');

            $resolver = new OptionsResolver();
            $defaults = require __DIR__ . '/../../config/apie.php';
            $resolver->setDefaults($defaults);
            return $resolver->resolve($config->get('apie') ?? []);
        });

        $this->app->singleton(ApiResourcesInterface::class, function () {
            $config = $this->app->get('apie.config');
            if (! empty($config['resources-service'])) {
                return $this->app->get($config['resources-service']);
            }
            if ($config['resources'] instanceof ApiResourcesInterface) {
                return $config['resources'];
            }
            return new ApiResources($config['resources']);
        });

        $this->app->singleton(ServiceLibraryFactory::class, function () {
            $this->createServiceLibraryFactory();
        });

        // MainScheduler: service that does all the background processes of api resources.
        //$this->app->singleton(MainScheduler::class, function () {
        //    return new MainScheduler($this->app->tagged(SchedulerInterface::class));
        //});

        // OpenApiSpecGenerator: generated an OpenAPI 3.0 spec file from a list of resources.
        $this->addOpenApiServices();
        $this->app->singleton(OpenApiSpecGenerator::class, function () {
            $config = $this->app->get('apie.config');
            $factory = $this->app->get(ServiceLibraryFactory::class);
            $baseUrl = $config['base-url'] . $config['api-url'];
            if ($this->app->has(Request::class)) {
                $baseUrl = $this->app->get(Request::class)->getSchemeAndHttpHost() . $baseUrl;
            }
            $this->app->get(SchemaGenerator::class);
            $factory->setInfo($this->app->get(Info::class));
            return $factory->getOpenApiSpecGenerator($baseUrl);
        });

        // SchemaGenerator: generates a OpenAPI Schema from a api resource class.
        $this->app->singleton(SchemaGenerator::class, function () {
            $factory = $this->app->get(ServiceLibraryFactory::class);
            $service = $factory->getSchemaGenerator();
            $service->defineSchemaForResource(Uuid::class, new Schema(['type' => 'string', 'format' => 'uuid']));
            $service->defineSchemaForResource(DateTimeInterface::class, new Schema(['type' => 'string', 'format' => 'date-time']));
            return $service;
        });

        $this->app->singleton(Serializer::class, function () {
            return $this->app->get(ServiceLibraryFactory::class)->getSerializer();
        });
        $this->app->bind(SerializerInterface::class, Serializer::class);
        $this->app->bind(NormalizerInterface::class, Serializer::class);
        $this->app->bind(DenormalizerInterface::class, Serializer::class);
        $this->app->singleton(CamelCaseToSnakeCaseNameConverter::class);
        $this->app->bind(NameConverterInterface::class, CamelCaseToSnakeCaseNameConverter::class);

        $this->app->singleton(ApplicationInfoRetriever::class, function () {
            $config = $this->app->get('apie.config');
            return new ApplicationInfoRetriever(
                config('app.name'),
                config('app.env'),
                $config['metadata']['hash'],
                config('app.debug')
            );
        });
        $this->app->singleton(EloquentModelDataLayer::class);
        $this->app->singleton(DatabaseQueryRetriever::class);
        $this->app->singleton(FileStorageDataLayer::class, function () {
            return new FileStorageDataLayer(
                storage_path('api-file-storage'),
                $this->app->get(ServiceLibraryFactory::class)->getPropertyAccessor()
            );
        });

        // ApiResourceFacade: class that calls all the right services with a simple interface.
        $this->app->singleton(ApiResourceFacade::class, function () {
            return $this->app->get(ServiceLibraryFactory::class)->getApiResourceFacade();
        });

        $this->addStatusResourceServices();

        if (strpos($this->app->version(), 'Lumen') === false) {
            $this->app->register(ApieLaravelServiceProvider::class);
        } else {
            $this->app->register(ApieLumenServiceProvider::class);
        }
    }

    private function addOpenApiServices()
    {
        // Provides contact information to the OpenAPI spec.
        $this->app->singleton(Contact::class, function () {
            $config = $this->app->get('apie.config');
            return new Contact([
                'name'  => $config['metadata']['contact-name'],
                'url'   => $config['metadata']['contact-url'],
                'email' => $config['metadata']['contact-email'],
            ]);
        });

        // Provides license information to the OpenAPI spec.
        $this->app->singleton(License::class, function () {
            $config = $this->app->get('apie.config');
            return new License(
                $config['metadata']['license'],
                $config['metadata']['license-url']
            );
        });

        // Provides OpenAPI info to the OpenAPI spec.
        $this->app->singleton(Info::class, function () {
            $config = $this->app->get('apie.config');
            return new Info(
                $config['metadata']['title'],
                $config['metadata']['version'],
                $config['metadata']['description'],
                [
                    'contact' => $this->app->get(Contact::class),
                    'license' => $this->app->get(License::class),
                ]
            );
        });
    }

    private function createServiceLibraryFactory(): ServiceLibraryFactory
    {
        $config = $this->app->get('apie.config');
        $result = new ServiceLibraryFactory(
            $this->app->get(ApiResourcesInterface::class),
            (bool) config('app.debug'),
            storage_path('apie-cache')
        );
        $result->setContainer($this->app);
        if (!config('app.debug')) {
            $this->handleSerializerCache($result);
        }
        $result->runBeforeInstantiation(function () use (&$result) {
            $normalizers = [
            ];
            $taggedNormalizers = $this->app->tagged(NormalizerInterface::class);
            // app->tagged return type is hazy....
            foreach ($taggedNormalizers as $taggedNormalizer) {
                $normalizers[] = $taggedNormalizer;
            }
            $result->setAdditionalNormalizers($normalizers);
        });

        if ($config['mock']) {
            $cachePool = $result->getSerializerCache();

            $result->setApiResourceFactory(
                new MockApiResourceFactory(
                    new MockApiResourceDataLayer(
                        $cachePool,
                        new IdentifierExtractor($result->getPropertyAccessor()),
                        $result->getPropertyAccessor()
                    ),
                    new ApiResourceFactory($this->app),
                    $config['mock-skipped-resources']
                )
            );
        }

        return $result;
    }

    private function handleSerializerCache(ServiceLibraryFactory $result)
    {
        if ($this->app->bound('cache.psr6')) {
            $result->setSerializerCache($this->app->get('cache.psr6'));
        } elseif (class_exists(CacheItemPool::class)) {
            $repository = $this->app->make(Repository::class);
            $result->setSerializerCache(new CacheItemPool($repository));
        }
    }

    private function addStatusResourceServices()
    {
        $this->app->singleton(StatusFromDatabaseRetriever::class, function () {
            return new StatusFromDatabaseRetriever(config('app.debug'));
        });
        $this->app->tag([StatusFromDatabaseRetriever::class], ['status-check']);
        $this->app->singleton(StatusCheckRetriever::class, function () {
            return new StatusCheckRetriever($this->app->tagged('status-check'));
        });
    }
}


1			<?php
2
3			namespace W2w\Laravel\Apie\Providers;
4
5			use DateTimeInterface;
6			use erasys\OpenApi\Spec\v3\Contact;
7			use erasys\OpenApi\Spec\v3\Info;
8			use erasys\OpenApi\Spec\v3\License;
9			use erasys\OpenApi\Spec\v3\Schema;
10			use Illuminate\Contracts\Cache\Repository as CacheRepository;
11			use Illuminate\Contracts\Cache\Repository;
12			use Illuminate\Http\Request;
13			use Illuminate\Support\ServiceProvider;
14			use Madewithlove\IlluminatePsrCacheBridge\Laravel\CacheItemPool;
			0 ignored issues – show Bug introduced 2019-11-26 15:14 UTC by Report Bug Copy Issue Report The type `Madewithlove\IlluminateP...e\Laravel\CacheItemPool` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
15			use Ramsey\Uuid\Uuid;
16			use Symfony\Component\Cache\Adapter\ArrayAdapter;
17			use Symfony\Component\OptionsResolver\OptionsResolver;
18			use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter;
19			use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
20			use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
21			use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
22			use Symfony\Component\Serializer\Serializer;
23			use Symfony\Component\Serializer\SerializerInterface;
24			use W2w\Laravel\Apie\Services\Retrievers\DatabaseQueryRetriever;
25			use W2w\Laravel\Apie\Services\Retrievers\EloquentModelDataLayer;
26			use W2w\Lib\Apie\ApiResourceFacade;
27			use W2w\Lib\Apie\ApiResourceFactory;
28			use W2w\Lib\Apie\IdentifierExtractor;
29			use W2w\Lib\Apie\Mocks\MockApiResourceDataLayer;
30			use W2w\Lib\Apie\Mocks\MockApiResourceFactory;
31			use W2w\Lib\Apie\OpenApiSchema\OpenApiSpecGenerator;
32			use W2w\Lib\Apie\OpenApiSchema\SchemaGenerator;
33			use W2w\Lib\Apie\Resources\ApiResources;
34			use W2w\Lib\Apie\Resources\ApiResourcesInterface;
35			use W2w\Lib\Apie\Retrievers\ApplicationInfoRetriever;
36			use W2w\Lib\Apie\Retrievers\FileStorageDataLayer;
37			use W2w\Lib\Apie\Retrievers\StatusCheckRetriever;
38			use W2w\Laravel\Apie\Services\StatusChecks\StatusFromDatabaseRetriever;
39			use W2w\Lib\Apie\ServiceLibraryFactory;
40
41			/**
42			* Install apie classes to Laravel.
43			*/
44			class ApiResourceServiceProvider extends ServiceProvider
45			{
46			/**
47			* Perform post-registration booting of services.
48			*
49			* @return void
50			*/
51			public function boot()
52			{
53			if (function_exists('config_path')) {
54			$this->publishes(
55			[
56			__DIR__ . '/../../config/apie.php' => config_path('apie.php'),
57			]
58			);
59			}
60
61			$this->loadMigrationsFrom(__DIR__ . '/../../migrations');
62			}
63
64			/**
65			* Register any application services.
66			*/
67			public function register()
68			{
69			$this->app->singleton('apie.config', function () {
70			$config = $this->app->get('config');
71
72			$resolver = new OptionsResolver();
73			$defaults = require __DIR__ . '/../../config/apie.php';
74			$resolver->setDefaults($defaults);
75			return $resolver->resolve($config->get('apie') ?? []);
76			});
77
78			$this->app->singleton(ApiResourcesInterface::class, function () {
79			$config = $this->app->get('apie.config');
80			if (! empty($config['resources-service'])) {
81			return $this->app->get($config['resources-service']);
82			}
83			if ($config['resources'] instanceof ApiResourcesInterface) {
84			return $config['resources'];
85			}
86			return new ApiResources($config['resources']);
87			});
88
89			$this->app->singleton(ServiceLibraryFactory::class, function () {
90			$this->createServiceLibraryFactory();
91			});
92
93			// MainScheduler: service that does all the background processes of api resources.
94			//$this->app->singleton(MainScheduler::class, function () {
95			// return new MainScheduler($this->app->tagged(SchedulerInterface::class));
96			//});
97
98			// OpenApiSpecGenerator: generated an OpenAPI 3.0 spec file from a list of resources.
99			$this->addOpenApiServices();
100			$this->app->singleton(OpenApiSpecGenerator::class, function () {
101			$config = $this->app->get('apie.config');
102			$factory = $this->app->get(ServiceLibraryFactory::class);
103			$baseUrl = $config['base-url'] . $config['api-url'];
104			if ($this->app->has(Request::class)) {
105			$baseUrl = $this->app->get(Request::class)->getSchemeAndHttpHost() . $baseUrl;
106			}
107			$this->app->get(SchemaGenerator::class);
108			$factory->setInfo($this->app->get(Info::class));
109			return $factory->getOpenApiSpecGenerator($baseUrl);
110			});
111
112			// SchemaGenerator: generates a OpenAPI Schema from a api resource class.
113			$this->app->singleton(SchemaGenerator::class, function () {
114			$factory = $this->app->get(ServiceLibraryFactory::class);
115			$service = $factory->getSchemaGenerator();
116			$service->defineSchemaForResource(Uuid::class, new Schema(['type' => 'string', 'format' => 'uuid']));
117			$service->defineSchemaForResource(DateTimeInterface::class, new Schema(['type' => 'string', 'format' => 'date-time']));
118			return $service;
119			});
120
121			$this->app->singleton(Serializer::class, function () {
122			return $this->app->get(ServiceLibraryFactory::class)->getSerializer();
123			});
124			$this->app->bind(SerializerInterface::class, Serializer::class);
125			$this->app->bind(NormalizerInterface::class, Serializer::class);
126			$this->app->bind(DenormalizerInterface::class, Serializer::class);
127			$this->app->singleton(CamelCaseToSnakeCaseNameConverter::class);
128			$this->app->bind(NameConverterInterface::class, CamelCaseToSnakeCaseNameConverter::class);
129
130			$this->app->singleton(ApplicationInfoRetriever::class, function () {
131			$config = $this->app->get('apie.config');
132			return new ApplicationInfoRetriever(
133			config('app.name'),
134			config('app.env'),
135			$config['metadata']['hash'],
136			config('app.debug')
137			);
138			});
139			$this->app->singleton(EloquentModelDataLayer::class);
140			$this->app->singleton(DatabaseQueryRetriever::class);
141			$this->app->singleton(FileStorageDataLayer::class, function () {
142			return new FileStorageDataLayer(
143			storage_path('api-file-storage'),
144			$this->app->get(ServiceLibraryFactory::class)->getPropertyAccessor()
145			);
146			});
147
148			// ApiResourceFacade: class that calls all the right services with a simple interface.
149			$this->app->singleton(ApiResourceFacade::class, function () {
150			return $this->app->get(ServiceLibraryFactory::class)->getApiResourceFacade();
151			});
152
153			$this->addStatusResourceServices();
154
155			if (strpos($this->app->version(), 'Lumen') === false) {
156			$this->app->register(ApieLaravelServiceProvider::class);
157			} else {
158			$this->app->register(ApieLumenServiceProvider::class);
159			}
160			}
161
162			private function addOpenApiServices()
163			{
164			// Provides contact information to the OpenAPI spec.
165			$this->app->singleton(Contact::class, function () {
166			$config = $this->app->get('apie.config');
167			return new Contact([
168			'name' => $config['metadata']['contact-name'],
169			'url' => $config['metadata']['contact-url'],
170			'email' => $config['metadata']['contact-email'],
171			]);
172			});
173
174			// Provides license information to the OpenAPI spec.
175			$this->app->singleton(License::class, function () {
176			$config = $this->app->get('apie.config');
177			return new License(
178			$config['metadata']['license'],
179			$config['metadata']['license-url']
180			);
181			});
182
183			// Provides OpenAPI info to the OpenAPI spec.
184			$this->app->singleton(Info::class, function () {
185			$config = $this->app->get('apie.config');
186			return new Info(
187			$config['metadata']['title'],
188			$config['metadata']['version'],
189			$config['metadata']['description'],
190			[
191			'contact' => $this->app->get(Contact::class),
192			'license' => $this->app->get(License::class),
193			]
194			);
195			});
196			}
197
198			private function createServiceLibraryFactory(): ServiceLibraryFactory
199			{
200			$config = $this->app->get('apie.config');
201			$result = new ServiceLibraryFactory(
202			$this->app->get(ApiResourcesInterface::class),
203			(bool) config('app.debug'),
204			storage_path('apie-cache')
205			);
206			$result->setContainer($this->app);
207			if (!config('app.debug')) {
208			$this->handleSerializerCache($result);
209			}
210			$result->runBeforeInstantiation(function () use (&$result) {
211			$normalizers = [
212			];
213			$taggedNormalizers = $this->app->tagged(NormalizerInterface::class);
214			// app->tagged return type is hazy....
215			foreach ($taggedNormalizers as $taggedNormalizer) {
216			$normalizers[] = $taggedNormalizer;
217			}
218			$result->setAdditionalNormalizers($normalizers);
219			});
220
221			if ($config['mock']) {
222			$cachePool = $result->getSerializerCache();
223
224			$result->setApiResourceFactory(
225			new MockApiResourceFactory(
226			new MockApiResourceDataLayer(
227			$cachePool,
228			new IdentifierExtractor($result->getPropertyAccessor()),
229			$result->getPropertyAccessor()
230			),
231			new ApiResourceFactory($this->app),
232			$config['mock-skipped-resources']
233			)
234			);
235			}
236
237			return $result;
238			}
239
240			private function handleSerializerCache(ServiceLibraryFactory $result)
241			{
242			if ($this->app->bound('cache.psr6')) {
243			$result->setSerializerCache($this->app->get('cache.psr6'));
244			} elseif (class_exists(CacheItemPool::class)) {
245			$repository = $this->app->make(Repository::class);
246			$result->setSerializerCache(new CacheItemPool($repository));
247			}
248			}
249
250			private function addStatusResourceServices()
251			{
252			$this->app->singleton(StatusFromDatabaseRetriever::class, function () {
253			return new StatusFromDatabaseRetriever(config('app.debug'));
254			});
255			$this->app->tag([StatusFromDatabaseRetriever::class], ['status-check']);
256			$this->app->singleton(StatusCheckRetriever::class, function () {
257			return new StatusCheckRetriever($this->app->tagged('status-check'));
258			});
259			}
260			}
261

pjordaan / laravel-apie

Branch — feature-cache-bridge-optional (cb5811)

handleSerializerCache() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like