Changelog::versionChanges() - Code Metrics - Inspection of "Changelog helper" - sfneal/laravel-helpers - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#19)

by Stephen

created 2021-03-17 19:20 UTC

Changelog::versionChanges() A

↳ Parent: Changelog

Complexity

Conditions	2
Paths	1

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Sfneal\Helpers\Laravel\Support;

use ErrorException;
use Illuminate\Support\Facades\Cache;

class Changelog
{
    // todo: add ability to replace package names (user/package) with github links

    /**
     * @var string
     */
    private $path;

    /**
     * Changelog constructor.
     *
     * @param string|null $path
     */
    public function __construct(string $path = null)
    {
        $this->path = $path ?? config('app-info.changelog_path');
    }

    /**
     * Read the application's changelog & return an array of changes.
     *
     * @return array
     */
    public function changelog(): array
    {
        return Cache::rememberForever((new CacheKey("changelog:$this->path"))->execute(), function () {
            // Read the changelog
            $file_lines = file($this->path);
            $changes = [];

            for ($row = 0; $row < count($file_lines); $row++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                // Check if line starts with 'version'
                if (substr(strtolower($file_lines[$row]), 0, strlen('version')) == 'version') {
                    $version_date = explode(', ', $file_lines[$row]);

                    // Extract version and date
                    $date = $version_date[1];
                    $version = explode(' ', $version_date[0])[1];
                    $changes[$version] = ['date' => trim($date), 'changes' => []];

                    // Skip ahead two lines to skip sep line
                    $row += 2;

                    // Keep iterating over rows until we get to a blank line
                    while ($row < count($file_lines) && strlen(trim($file_lines[$row])) > 1) {
                        if (substr(trim($file_lines[$row]), 0, 1) == '-') {
                            $changes[$version]['changes'][] = str_replace('- ', '', trim($file_lines[$row]));
                            $row++;
                        } else {
                            break;
                        }
                    }
                }
            }

            return $changes;
        });
    }

    /**
     * Retrieve an array of changes made to a particular application version.
     *
     * @param string|null $version
     * @return array|null
     */
    public function versionChanges(string $version): ?array
    {
        return Cache::rememberForever(
            // Cache key
            (new CacheKey("changelog:$this->path", $version))->execute(),

            // Value to cache
            function () use ($version) {
                try {
                    return $this->changelog()[$version];
                } catch (ErrorException $exception) {
                    return null;
                }
            }
        );
    }

    /**
     * Retrieve an array of the version history.
     *
     *  - optionally include the release date in the array values
     *
     * @param bool $releaseDates
     * @return array
     */
    public function versions(bool $releaseDates = false): array
    {
        // Flat array of versions
        $versions = array_keys($this->changelog());

        // Return an array of version keys & release date values
        if ($releaseDates) {
            // todo: optimize this
            return array_combine(
                $versions,
                array_map(
                    function ($array) {
                        return $array['date'];
                    },
                    array_values($this->changelog())
                )
            );
        }

        // Return a array of versions
        else {
            return $versions;
        }
    }
}


1			<?php
2
3			namespace Sfneal\Helpers\Laravel\Support;
4
5			use ErrorException;
6			use Illuminate\Support\Facades\Cache;
7
8			class Changelog
9			{
10			// todo: add ability to replace package names (user/package) with github links
11
12			/**
13			* @var string
14			*/
15			private $path;
16
17			/**
18			* Changelog constructor.
19			*
20			* @param string\|null $path
21			*/
22			public function __construct(string $path = null)
23			{
24			$this->path = $path ?? config('app-info.changelog_path');
25			}
26
27			/**
28			* Read the application's changelog & return an array of changes.
29			*
30			* @return array
31			*/
32			public function changelog(): array
33			{
34			return Cache::rememberForever((new CacheKey("changelog:$this->path"))->execute(), function () {
35			// Read the changelog
36			$file_lines = file($this->path);
37			$changes = [];
38
39			for ($row = 0; $row < count($file_lines); $row++) {
			0 ignored issues – show Performance Best Practice introduced 2021-03-10 23:03 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
40			// Check if line starts with 'version'
41			if (substr(strtolower($file_lines[$row]), 0, strlen('version')) == 'version') {
42			$version_date = explode(', ', $file_lines[$row]);
43
44			// Extract version and date
45			$date = $version_date[1];
46			$version = explode(' ', $version_date[0])[1];
47			$changes[$version] = ['date' => trim($date), 'changes' => []];
48
49			// Skip ahead two lines to skip sep line
50			$row += 2;
51
52			// Keep iterating over rows until we get to a blank line
53			while ($row < count($file_lines) && strlen(trim($file_lines[$row])) > 1) {
54			if (substr(trim($file_lines[$row]), 0, 1) == '-') {
55			$changes[$version]['changes'][] = str_replace('- ', '', trim($file_lines[$row]));
56			$row++;
57			} else {
58			break;
59			}
60			}
61			}
62			}
63
64			return $changes;
65			});
66			}
67
68			/**
69			* Retrieve an array of changes made to a particular application version.
70			*
71			* @param string\|null $version
72			* @return array\|null
73			*/
74			public function versionChanges(string $version): ?array
75			{
76			return Cache::rememberForever(
77			// Cache key
78			(new CacheKey("changelog:$this->path", $version))->execute(),
79
80			// Value to cache
81			function () use ($version) {
82			try {
83			return $this->changelog()[$version];
84			} catch (ErrorException $exception) {
85			return null;
86			}
87			}
88			);
89			}
90
91			/**
92			* Retrieve an array of the version history.
93			*
94			* - optionally include the release date in the array values
95			*
96			* @param bool $releaseDates
97			* @return array
98			*/
99			public function versions(bool $releaseDates = false): array
100			{
101			// Flat array of versions
102			$versions = array_keys($this->changelog());
103
104			// Return an array of version keys & release date values
105			if ($releaseDates) {
106			// todo: optimize this
107			return array_combine(
108			$versions,
109			array_map(
110			function ($array) {
111			return $array['date'];
112			},
113			array_values($this->changelog())
114			)
115			);
116			}
117
118			// Return a array of versions
119			else {
120			return $versions;
121			}
122			}
123			}
124

sfneal / laravel-helpers

Pull Request — master (#19)

Changelog::versionChanges() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like