WorkflowsReportController::build() - Code Metrics - Inspection of "Working admin/reports/qa/workflows and drush qawl." - OSInet/qa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 8.x-1.x ( 3c8412...894b5c )

by Frédéric G.

created 2017-02-15 18:48 UTC

WorkflowsReportController::build() B

↳ Parent: WorkflowsReportController

Complexity

Conditions	2
Paths	2

Size

Total Lines	33
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	27
nc	2
nop	1
dl	0
loc	33
rs	8.8571
c	0
b	0
f	0

<?php

namespace Drupal\qa\Controller;

use Drupal\content_moderation\ContentModerationState;
use Drupal\Core\Config\Entity\ConfigEntityStorageInterface;
use Drupal\Core\Controller\ControllerBase;
use Drupal\workflows\Entity\Workflow;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * WorkflowsReportController validates workflow connectivity.
 *
 * It considers workflows with fonts, sink, or islands as non-optimal:
 * - fonts are states where it is impossible to return once they've been left,
 * - sinks are states from which is is impossible to exit,
 * - islands are unreachable states.
 *
 * The first two are inconvenient, while instances of the latter are useless.
 *
 * Implementation note: some properties and methods are public to allow reuse by
 * an equivalent Drush command formatting the same date for CLI display.
 */
class WorkflowsReportController extends ControllerBase {

  /**
   * The workflow storage.
   *
   * @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
   */
  public $storage;

  /**
   * WorkflowsReportController constructor.
   *
   * @param \Drupal\Core\Config\Entity\ConfigEntityStorageInterface $storage
   *   The workflow storage.
   */
  public function __construct(ConfigEntityStorageInterface $storage) {
    $this->storage = $storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $etm = $container->get('entity_type.manager');

    /** @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface $storage */
    $storage = $etm->getStorage('workflow');

    return new static($storage);
  }

  /**
   * Count transitions, fonts, sinks, and islands in a workflow.
   *
   * @param \Drupal\workflows\Entity\Workflow $workflow
   *   The workflow to examine.
   *
   * @return array
   *   An information hash.
   */
  public static function getConnectivity(Workflow $workflow) {
    $result = [
      'islandNodes' => 0,
      'fontNodes' => 0,
      'sinkNodes' => 0,
    ];

    /** @var ContentModerationStateInterface $state */
    foreach ($workflow->getStates() as $state) {
      $id = $state->id();
      $maybeIsland = FALSE;
      if (empty($workflow->getTransitionsForState($id, 'from'))) {
        $result['sinkNodes']++;
        $maybeIsland = TRUE;
      }
      if (empty($workflow->getTransitionsForState($id, 'to'))) {
        $result['fontNodes']++;
        if ($maybeIsland) {
          $result['islandNodes']++;
        }
      }
    }
    return array_filter($result);
  }

  /**
   * Build an information summary for all workflows.
   *
   * @param array $workflows
   *   An array of Workflow entities to check.
   *
   * @return array
   *   A summary information hash, keyed and ordered by id.
   */
  public function getWorkflowSummary(array $workflows) {
    $list = array_map(function (Workflow $workflow) {
      $states = array_map(function (ContentModerationState &$state) {
        return $state->label();
      }, $workflow->getStates());
      $stateIds = array_keys($states);
      sort($stateIds);
      $cell = [
        'label' => $workflow->label(),
        'states' => $stateIds,
        'transitionCount' => count($workflow->getTransitions()),
      ] + self::getConnectivity($workflow);
      return $cell;
    }, $workflows);

    ksort($list);
    return $list;
  }

  /**
   * Build a table cell from a value, using the qa/results library classes.
   *
   * Assumes the cell is to be used within a ".qa-results" CSS element.
   *
   * @param array $workflow
   *   An information array about a workflow.
   * @param string $key
   *   The string to extract from the information array.
   *
   * @return array
   *   A table cell array.
   */
  protected function buildControlCell($workflow, $key) {
    $value = $workflow[$key] ?? 0;
    $cell = $value
      ? ['class' => 'qa-results__ko']
      : ['class' => 'qa-results__ok'];
    $cell['data'] = $value;
    return $cell;
  }

  /**
   * Build a table from a workflow summary analysis.
   *
   * @param array $list
   *   A workflow summary analysis, from ::getWorkflowSummary().
   *
   * @return array
   *   A render array for the table.
   */
  protected function build(array $list) {
    $header = [
      $this->t('ID'),
      $this->t('Label'),
      $this->t('States'),
      $this->t('# transitions'),
      $this->t('# fonts'),
      $this->t('# sinks'),
      $this->t('# islands'),
    ];
    $rows = [];
    foreach ($list as $id => $workflow) {
      $row = [];
      $row[] = $id;
      $row[] = $workflow['label'];
      $row[] = implode(', ', $workflow['states']);
      $row[] = $workflow['transitionCount'] ?? 0;
      $row[] = $this->buildControlCell($workflow, 'fontNodes');
      $row[] = $this->buildControlCell($workflow, 'sinkNodes');
      $row[] = $this->buildControlCell($workflow, 'islandNodes');
      $rows[] = $row;
    }

    $build = [
      '#type' => 'table',
      '#attributes' => ['class' => ['qa-results']],
      '#header' => $header,
      '#rows' => $rows,
      '#attached' => ['library' => ['qa/results']],
    ];

    return $build;
  }

  /**
   * Report on existing workflows.
   *
   * @return array
   *   The render array for the controller.
   */
  public function report() {
    $workflows = $this->storage->loadMultiple();
    $list = $this->getWorkflowSummary($workflows);
    $build = $this->build($list);

    return $build;
  }

}


1			<?php
2
3			namespace Drupal\qa\Controller;
4
5			use Drupal\content_moderation\ContentModerationState;
6			use Drupal\Core\Config\Entity\ConfigEntityStorageInterface;
7			use Drupal\Core\Controller\ControllerBase;
8			use Drupal\workflows\Entity\Workflow;
9			use Symfony\Component\DependencyInjection\ContainerInterface;
10
11			/**
12			* WorkflowsReportController validates workflow connectivity.
13			*
14			* It considers workflows with fonts, sink, or islands as non-optimal:
15			* - fonts are states where it is impossible to return once they've been left,
16			* - sinks are states from which is is impossible to exit,
17			* - islands are unreachable states.
18			*
19			* The first two are inconvenient, while instances of the latter are useless.
20			*
21			* Implementation note: some properties and methods are public to allow reuse by
22			* an equivalent Drush command formatting the same date for CLI display.
23			*/
24			class WorkflowsReportController extends ControllerBase {
25
26			/**
27			* The workflow storage.
28			*
29			* @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
30			*/
31			public $storage;
32
33			/**
34			* WorkflowsReportController constructor.
35			*
36			* @param \Drupal\Core\Config\Entity\ConfigEntityStorageInterface $storage
37			* The workflow storage.
38			*/
39			public function __construct(ConfigEntityStorageInterface $storage) {
40			$this->storage = $storage;
41			}
42
43			/**
44			* {@inheritdoc}
45			*/
46			public static function create(ContainerInterface $container) {
47			$etm = $container->get('entity_type.manager');
48
49			/** @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface $storage */
50			$storage = $etm->getStorage('workflow');
51
52			return new static($storage);
53			}
54
55			/**
56			* Count transitions, fonts, sinks, and islands in a workflow.
57			*
58			* @param \Drupal\workflows\Entity\Workflow $workflow
59			* The workflow to examine.
60			*
61			* @return array
62			* An information hash.
63			*/
64			public static function getConnectivity(Workflow $workflow) {
65			$result = [
66			'islandNodes' => 0,
67			'fontNodes' => 0,
68			'sinkNodes' => 0,
69			];
70
71			/** @var ContentModerationStateInterface $state */
72			foreach ($workflow->getStates() as $state) {
73			$id = $state->id();
74			$maybeIsland = FALSE;
75			if (empty($workflow->getTransitionsForState($id, 'from'))) {
76			$result['sinkNodes']++;
77			$maybeIsland = TRUE;
78			}
79			if (empty($workflow->getTransitionsForState($id, 'to'))) {
80			$result['fontNodes']++;
81			if ($maybeIsland) {
82			$result['islandNodes']++;
83			}
84			}
85			}
86			return array_filter($result);
87			}
88
89			/**
90			* Build an information summary for all workflows.
91			*
92			* @param array $workflows
93			* An array of Workflow entities to check.
94			*
95			* @return array
96			* A summary information hash, keyed and ordered by id.
97			*/
98			public function getWorkflowSummary(array $workflows) {
99			$list = array_map(function (Workflow $workflow) {
100			$states = array_map(function (ContentModerationState &$state) {
101			return $state->label();
102			}, $workflow->getStates());
103			$stateIds = array_keys($states);
104			sort($stateIds);
105			$cell = [
106			'label' => $workflow->label(),
107			'states' => $stateIds,
108			'transitionCount' => count($workflow->getTransitions()),
109			] + self::getConnectivity($workflow);
110			return $cell;
111			}, $workflows);
112
113			ksort($list);
114			return $list;
115			}
116
117			/**
118			* Build a table cell from a value, using the qa/results library classes.
119			*
120			* Assumes the cell is to be used within a ".qa-results" CSS element.
121			*
122			* @param array $workflow
123			* An information array about a workflow.
124			* @param string $key
125			* The string to extract from the information array.
126			*
127			* @return array
128			* A table cell array.
129			*/
130			protected function buildControlCell($workflow, $key) {
131			$value = $workflow[$key] ?? 0;
132			$cell = $value
133			? ['class' => 'qa-results__ko']
134			: ['class' => 'qa-results__ok'];
135			$cell['data'] = $value;
136			return $cell;
137			}
138
139			/**
140			* Build a table from a workflow summary analysis.
141			*
142			* @param array $list
143			* A workflow summary analysis, from ::getWorkflowSummary().
144			*
145			* @return array
146			* A render array for the table.
147			*/
148			protected function build(array $list) {
149			$header = [
150			$this->t('ID'),
151			$this->t('Label'),
152			$this->t('States'),
153			$this->t('# transitions'),
154			$this->t('# fonts'),
155			$this->t('# sinks'),
156			$this->t('# islands'),
157			];
158			$rows = [];
159			foreach ($list as $id => $workflow) {
160			$row = [];
161			$row[] = $id;
162			$row[] = $workflow['label'];
163			$row[] = implode(', ', $workflow['states']);
164			$row[] = $workflow['transitionCount'] ?? 0;
165			$row[] = $this->buildControlCell($workflow, 'fontNodes');
166			$row[] = $this->buildControlCell($workflow, 'sinkNodes');
167			$row[] = $this->buildControlCell($workflow, 'islandNodes');
168			$rows[] = $row;
169			}
170
171			$build = [
172			'#type' => 'table',
173			'#attributes' => ['class' => ['qa-results']],
174			'#header' => $header,
175			'#rows' => $rows,
176			'#attached' => ['library' => ['qa/results']],
177			];
178
179			return $build;
180			}
181
182			/**
183			* Report on existing workflows.
184			*
185			* @return array
186			* The render array for the controller.
187			*/
188			public function report() {
189			$workflows = $this->storage->loadMultiple();
190			$list = $this->getWorkflowSummary($workflows);
191			$build = $this->build($list);
192
193			return $build;
194			}
195
196			}
197

OSInet / qa

Push — 8.x-1.x ( 3c8412...894b5c )

WorkflowsReportController::build() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like