PruneAllVersionedRecords::run() - Code Metrics - Inspection of "WIP" - sunnysideup/silverstripe-version-pruner - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 55c317...8130df )

by Nicolaas

created 2022-09-06 03:38 UTC

PruneAllVersionedRecords::run() D

↳ Parent: PruneAllVersionedRecords

Complexity

Conditions	15
Paths	208

Size

Total Lines	56
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
cc	15
eloc	38
c	4
b	0
f	0
nc	208
nop	1
dl	0
loc	56
rs	4.9833

How to fix Long Method Complexity

<?php

namespace Sunnysideup\VersionPruner\Tasks;

use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\BuildTask;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DB;
use SilverStripe\Versioned\Versioned;
filter:
    dependency_paths: ["lib/*"]

use Sunnysideup\VersionPruner\Api\RunForOneObject;

class PruneAllVersionedRecords extends BuildTask
{
    /**
     * @var int
     */
    protected const MAX_ITEMS_PER_CLASS = 100;

    /**
     * @var string
     */
    protected $title = 'Prune all versioned records';

    protected $description = 'Go through all dataobjects that are versioned and prune them as per schema provided.';

    protected $limit = self::MAX_ITEMS_PER_CLASS;

    protected $verbose = false;

    protected $dryRun = false;

    /**
     * @var string
     */
    private static $segment = 'prune-all-versioned-records';

    public function setVerbose(?bool $verbose = true): self
    {
        $this->verbose = $verbose;

        return $this;
    }

    public function setDryRun(?bool $dryRun = true): self
    {
        $this->dryRun = $dryRun;

        return $this;
    }

    public function setLimit(int $limit): self
    {
        $this->limit = $limit;

        return $this;
    }

    /**
     * Prune all published DataObjects which are published according to config.
     *
     * @param mixed $request
     */
    public function run($request)
    {
        $classes = $this->getAllVersionedDataClasses();
        if ($request && $request->requestVar('verbose')) {
            $this->verbose = $request->requestVar('verbose');
        }

        if ($request && $request->requestVar('dry')) {
            $this->dryRun = $request->requestVar('dry');
        }

        if ($request && $request->requestVar('limit')) {
            $this->limit = $request->requestVar('limit');
        }

        DB::alteration_message('Pruning all DataObjects with a maximum of ' . self::MAX_ITEMS_PER_CLASS . ' per class.');
        $totalTotalDeleted = 0;
        $runObject = RunForOneObject::inst()
            ->setVerbose($this->verbose)
            ->setDryRun($this->dryRun)
        ;
        DB::alteration_message('settings (set as parameters)');
        DB::alteration_message('-------------------- ');
        DB::alteration_message('verbose: ' . ($this->verbose ? 'yes' : 'no'), 'created');
        DB::alteration_message('dry run: ' . ($this->dryRun ? 'yes' : 'no'), 'created');
        DB::alteration_message('limit per class: ' . $this->limit, 'created');
        DB::alteration_message('-------------------- ');
        foreach ($classes as $className) {
            $objects = $this->getObjectsPerClassName($runObject, $className);
            $noData = '';
            if(! $objects->exists()) {
                $noData = '- nothing to do';
            }
            DB::alteration_message('... Looking at ' . $className. ' '.$noData);
            $totalDeleted = 0;

            foreach ($objects as $object) {
                // check if stages are present
                if($this->verbose) {
                    DB::alteration_message('... ... Checking #ID: ' . $object->ID);
                }
                $totalDeleted += $runObject->deleteSuperfluousVersions($object);
            }

            if ($totalDeleted > 0) {
                DB::alteration_message('... ... Deleted ' . $totalDeleted . ' version records');
                $totalTotalDeleted += $totalDeleted;
            }
        }

        DB::alteration_message('-------------------- ');
        DB::alteration_message('Completed, pruned ' . $totalTotalDeleted . ' version records');
        DB::alteration_message('-------------------- ');
        $array = $runObject->getCountRegister();
        foreach ($array as $table => $count) {
            DB::alteration_message('... '.$table . ' has ' . $count . ' version records left.');
        }
    }

    protected function getObjectsPerClassName($runObject, string $className): DataList
    {
        $rootTable = $runObject->getRootTable($className);
        $sql = '
            SELECT COUNT("ID") AS C, "RecordID"
            FROM "'.$rootTable.'_Versions"
            WHERE ClassName = \''.addslashes($className).'\'
            GROUP BY "RecordID"
            ORDER BY C DESC
            LIMIT '.$this->limit.';';
        $rows = DB::query($sql);
        $array = [-1 => 0];
        foreach($rows as $row) {
            $array[] = $row['RecordID'];
        }
        return Versioned::get_by_stage($className, Versioned::DRAFT)
            ->filter(['ID' => $array])
            ->limit($this->limit)
        ;
    }

    /**
     * Get all versioned database classes.
     */
    protected function getAllVersionedDataClasses(): array
    {
        $allClasses = ClassInfo::subclassesFor(DataObject::class);
        $versionedClasses = [];
        foreach ($allClasses as $className) {
            if (DataObject::has_extension($className, Versioned::class)) {
                $versionedClasses[$className] = $className;
            }
        }

        return $versionedClasses;
    }

}


1			<?php
2
3			namespace Sunnysideup\VersionPruner\Tasks;
4
5			use SilverStripe\Core\ClassInfo;
6			use SilverStripe\Core\Config\Config;
7			use SilverStripe\Dev\BuildTask;
8			use SilverStripe\ORM\DataList;
9			use SilverStripe\ORM\DataObject;
10			use SilverStripe\ORM\DB;
11			use SilverStripe\Versioned\Versioned;
			0 ignored issues – show Bug introduced 2022-06-07 03:43 UTC by Report Bug Copy Issue Report The type `SilverStripe\Versioned\Versioned` 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...
12
13			use Sunnysideup\VersionPruner\Api\RunForOneObject;
14
15			class PruneAllVersionedRecords extends BuildTask
16			{
17			/**
18			* @var int
19			*/
20			protected const MAX_ITEMS_PER_CLASS = 100;
21
22			/**
23			* @var string
24			*/
25			protected $title = 'Prune all versioned records';
26
27			protected $description = 'Go through all dataobjects that are versioned and prune them as per schema provided.';
28
29			protected $limit = self::MAX_ITEMS_PER_CLASS;
30
31			protected $verbose = false;
32
33			protected $dryRun = false;
34
35			/**
36			* @var string
37			*/
38			private static $segment = 'prune-all-versioned-records';
39
40			public function setVerbose(?bool $verbose = true): self
41			{
42			$this->verbose = $verbose;
43
44			return $this;
45			}
46
47			public function setDryRun(?bool $dryRun = true): self
48			{
49			$this->dryRun = $dryRun;
50
51			return $this;
52			}
53
54			public function setLimit(int $limit): self
55			{
56			$this->limit = $limit;
57
58			return $this;
59			}
60
61			/**
62			* Prune all published DataObjects which are published according to config.
63			*
64			* @param mixed $request
65			*/
66			public function run($request)
67			{
68			$classes = $this->getAllVersionedDataClasses();
69			if ($request && $request->requestVar('verbose')) {
70			$this->verbose = $request->requestVar('verbose');
71			}
72
73			if ($request && $request->requestVar('dry')) {
74			$this->dryRun = $request->requestVar('dry');
75			}
76
77			if ($request && $request->requestVar('limit')) {
78			$this->limit = $request->requestVar('limit');
79			}
80
81			DB::alteration_message('Pruning all DataObjects with a maximum of ' . self::MAX_ITEMS_PER_CLASS . ' per class.');
82			$totalTotalDeleted = 0;
83			$runObject = RunForOneObject::inst()
84			->setVerbose($this->verbose)
85			->setDryRun($this->dryRun)
86			;
87			DB::alteration_message('settings (set as parameters)');
88			DB::alteration_message('-------------------- ');
89			DB::alteration_message('verbose: ' . ($this->verbose ? 'yes' : 'no'), 'created');
90			DB::alteration_message('dry run: ' . ($this->dryRun ? 'yes' : 'no'), 'created');
91			DB::alteration_message('limit per class: ' . $this->limit, 'created');
92			DB::alteration_message('-------------------- ');
93			foreach ($classes as $className) {
94			$objects = $this->getObjectsPerClassName($runObject, $className);
95			$noData = '';
96			if(! $objects->exists()) {
97			$noData = '- nothing to do';
98			}
99			DB::alteration_message('... Looking at ' . $className. ' '.$noData);
100			$totalDeleted = 0;
101
102			foreach ($objects as $object) {
103			// check if stages are present
104			if($this->verbose) {
105			DB::alteration_message('... ... Checking #ID: ' . $object->ID);
106			}
107			$totalDeleted += $runObject->deleteSuperfluousVersions($object);
108			}
109
110			if ($totalDeleted > 0) {
111			DB::alteration_message('... ... Deleted ' . $totalDeleted . ' version records');
112			$totalTotalDeleted += $totalDeleted;
113			}
114			}
115
116			DB::alteration_message('-------------------- ');
117			DB::alteration_message('Completed, pruned ' . $totalTotalDeleted . ' version records');
118			DB::alteration_message('-------------------- ');
119			$array = $runObject->getCountRegister();
120			foreach ($array as $table => $count) {
121			DB::alteration_message('... '.$table . ' has ' . $count . ' version records left.');
122			}
123			}
124
125			protected function getObjectsPerClassName($runObject, string $className): DataList
126			{
127			$rootTable = $runObject->getRootTable($className);
128			$sql = '
129			SELECT COUNT("ID") AS C, "RecordID"
130			FROM "'.$rootTable.'_Versions"
131			WHERE ClassName = \''.addslashes($className).'\'
132			GROUP BY "RecordID"
133			ORDER BY C DESC
134			LIMIT '.$this->limit.';';
135			$rows = DB::query($sql);
136			$array = [-1 => 0];
137			foreach($rows as $row) {
138			$array[] = $row['RecordID'];
139			}
140			return Versioned::get_by_stage($className, Versioned::DRAFT)
141			->filter(['ID' => $array])
142			->limit($this->limit)
143			;
144			}
145
146			/**
147			* Get all versioned database classes.
148			*/
149			protected function getAllVersionedDataClasses(): array
150			{
151			$allClasses = ClassInfo::subclassesFor(DataObject::class);
152			$versionedClasses = [];
153			foreach ($allClasses as $className) {
154			if (DataObject::has_extension($className, Versioned::class)) {
155			$versionedClasses[$className] = $className;
156			}
157			}
158
159			return $versionedClasses;
160			}
161
162			}
163

sunnysideup / silverstripe-version-pruner

Push — master ( 55c317...8130df )

PruneAllVersionedRecords::run() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like