Builder::blank() - Code Metrics - Inspection of "Update composer.lock" - ericsizemore/mimey - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — develop ( 728be8...044541 )

by Eric
created 2024-02-12 05:50 UTC
Builder::blank() A

↳ Parent: Builder
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	2
cts	2
cp	1
crap	1
<?php

declare(strict_types=1);

/**
 * Mimey - PHP package for converting file extensions to MIME types and vice versa.
 *
 * @author    Eric Sizemore <[email protected]>
 * @version   2.0.0
 * @copyright (C) 2023-2024 Eric Sizemore
 * @license   The MIT License (MIT)
 *
 * Copyright (C) 2023-2024 Eric Sizemore<https://www.secondversion.com/>.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/**
 * Esi\Mimey is a fork of Elephox\Mimey (https://github.com/elephox-dev/mimey) which is:
 *     Copyright (c) 2022 Ricardo Boss
 * Elephox\Mimey is a fork of ralouphie/mimey (https://github.com/ralouphie/mimey) which is:
 *     Copyright (c) 2016 Ralph Khattar
 */

namespace Esi\Mimey\Mapping;

// Classes
use JetBrains\PhpStorm\Pure;

// Exceptions
use JsonException;
use RuntimeException;
use Throwable;

// Functions & constants
use function array_unshift;
use function array_unique;
use function json_encode;
use function file_put_contents;
use function dirname;
use function file_get_contents;
use function json_decode;

use const JSON_THROW_ON_ERROR;
use const JSON_PRETTY_PRINT;

/**
 * Class for converting MIME types to file extensions and vice versa.
 *
 * This psalm-type looks gnarly, but it covers just about everything.
 *
 * @psalm-type MimeTypeMap = array{
 *    mimes: array<
 *        non-empty-string, list<non-empty-string>
 *    >|non-empty-array<
 *        string, array<int<0, max>, string>
 *    >,
 *    extensions: array<
 *        non-empty-string, list<non-empty-string>
 *    >|non-empty-array<
 *        string, array<int<0, max>, string>
 *    >|array<
 *        string, array<int<0, max>, string>
 *    >
 * }
 */
class Builder
{
    /**
     * Create a new mapping builder.
     *
     * @param MimeTypeMap $mapping An associative array containing two entries. See `MimeTypes` constructor for details.
filter:
    dependency_paths: ["lib/*"]
     */
    private function __construct(
        /**
         * The Mapping Array
         */
        protected array $mapping
    ) {}

    /**
     * Add a conversion.
     *
     * @param string $mime              The MIME type.
     * @param string $extension         The extension.
     * @param bool   $prependExtension  Whether this should be the preferred conversion for MIME type to extension.
     * @param bool   $prependMime       Whether this should be the preferred conversion for extension to MIME type.
     */
    public function add(string $mime, string $extension, bool $prependExtension = true, bool $prependMime = true): void
    {
        $existingExtensions = $this->mapping['extensions'][$mime] ?? [];
        $existingMimes      = $this->mapping['mimes'][$extension] ?? [];

        if ($prependExtension) {
            array_unshift($existingExtensions, $extension);
        } else {
            $existingExtensions[] = $extension;
        }

        if ($prependMime) {
            array_unshift($existingMimes, $mime);
        } else {
            $existingMimes[] = $mime;
        }

        $this->mapping['extensions'][$mime] = array_unique($existingExtensions);
        $this->mapping['mimes'][$extension] = array_unique($existingMimes);
    }

    /**
     * Retrieves the current mapping array.
     *
     * @return MimeTypeMap The mapping.
     */
    public function getMapping(): array
    {
        return $this->mapping;

    }

    /**
     * Compile the current mapping to PHP.
     *
     * @param  bool    $pretty  Whether to pretty print the output.
     * @return string           The compiled PHP code to save to a file.
     *
     * @throws JsonException
     */
    public function compile(bool $pretty = false): string
    {
        $mapping = $this->getMapping();

        return json_encode($mapping, flags: JSON_THROW_ON_ERROR | ($pretty ? JSON_PRETTY_PRINT : 0));
    }

    /**
     * Save the current mapping to a file.
     *
     * @param  string     $file     The file to save to.
     * @param  int        $flags    Flags for `file_put_contents`.
     * @param  resource   $context  Context for `file_put_contents`.
     * @return false|int            The number of bytes that were written to the file, or false on failure.
     *
     * @throws JsonException
     */
    public function save(string $file, int $flags = 0, mixed $context = null): false | int
    {
        return file_put_contents($file, $this->compile(), $flags, $context);
    }

    /**
     * Create a new mapping builder based on the built-in types.
     *
     * @return  Builder  A mapping builder with built-in types loaded.
     */
    public static function create(): Builder
    {
        return self::load(dirname(__DIR__, 2) . '/dist/mime.types.min.json');
    }

    /**
     * Create a new mapping builder based on types from a file.
     *
     * @param  string   $file  The compiled PHP file to load.
     * @return Builder         A mapping builder with types loaded from a file.
     *
     * @throws RuntimeException
     */
    public static function load(string $file): Builder
    {
        try {
            /** @var string $json **/
            $json = file_get_contents($file);
            /** @var MimeTypeMap $json **/
            $json = json_decode(/** @scrutinizer ignore-type */ $json, true, flags: JSON_THROW_ON_ERROR);

            return new self($json);
            return new self(/** @scrutinizer ignore-type */ $json);
        } catch (Throwable $e) {
            throw new RuntimeException('Unable to parse built-in types at ' . $file, 0, $e);
        }
    }

    /**
     * Create a new mapping builder that has no types defined.
     *
     * @return  Builder  A mapping builder with no types defined.
     */
    #[Pure]
    public static function blank(): Builder
    {
        return new self(['mimes' => [], 'extensions' => []]);
    }
}

ericsizemore / mimey

Push — develop ( 728be8...044541 )

Builder::blank() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
