thecodingmachine / utils.patcher

src/Mouf/Utils/Patcher/PatchService.php

Indentation +89 added lines, -89 removed lines

@@ -30,42 +30,42 @@ 
  * @ExtendedAction {"name":"View patches list", "url":"patcher/", "default":false}
  */
 class PatchService implements MoufValidatorInterface {
-    const IFEXISTS_EXCEPTION = "exception";
-    const IFEXISTS_IGNORE = "ignore";
+	const IFEXISTS_EXCEPTION = "exception";
+	const IFEXISTS_IGNORE = "ignore";
 
 
-    /**
+	/**
 	 * The list of patches declared for this application.
 	 * 
 	 * @var PatchInterface[]
 	 */
 	private $patchs = [];
 
-    /**
-     * The list of exiting patch types for this application.
-     *
-     * @var PatchType[]
-     */
+	/**
+	 * The list of exiting patch types for this application.
+	 *
+	 * @var PatchType[]
+	 */
 	private $types = [];
 
-    /**
-     * The list of listeners on the patch service.
-     *
-     * @var array|PatchListenerInterface[]
-     */
-    private $listeners;
+	/**
+	 * The list of listeners on the patch service.
+	 *
+	 * @var array|PatchListenerInterface[]
+	 */
+	private $listeners;
 
-    /**
-     * @param PatchType[] $types
-     * @param PatchListenerInterface[] $listeners
-     */
-    public function __construct(array $types, array $listeners = [])
-    {
-        $this->types = $types;
-        $this->listeners = $listeners;
-    }
+	/**
+	 * @param PatchType[] $types
+	 * @param PatchListenerInterface[] $listeners
+	 */
+	public function __construct(array $types, array $listeners = [])
+	{
+		$this->types = $types;
+		$this->listeners = $listeners;
+	}
 
-    /**
+	/**
 	 * The list of patches declared for this application.
 	 * @param PatchInterface[] $patchs
 	 * @return PatchService
@@ -75,26 +75,26 @@ 
 		return $this;
 	}
 
-    /**
-     * The list of exiting patch types for this application.
-     *
-     * @return PatchType[]
-     */
-    public function getTypes(): array
-    {
-        return $this->types;
-    }
+	/**
+	 * The list of exiting patch types for this application.
+	 *
+	 * @return PatchType[]
+	 */
+	public function getTypes(): array
+	{
+		return $this->types;
+	}
 
-    /**
-     * @internal Returns a serialized list of types for the patch UI.
-     * @return array
-     */
-    public function _getSerializedTypes(): array
-    {
-        return array_map(function(PatchType $type) {
-            return $type->jsonSerialize();
-        }, $this->types);
-    }
+	/**
+	 * @internal Returns a serialized list of types for the patch UI.
+	 * @return array
+	 */
+	public function _getSerializedTypes(): array
+	{
+		return array_map(function(PatchType $type) {
+			return $type->jsonSerialize();
+		}, $this->types);
+	}
 
 	/**
 	 * Adds this patch to the list of existing patches.
@@ -223,8 +223,8 @@ 
 	
 	/**
 	 * Returns a PHP array representing the patchs.
-     *
-     * @internal
+	 *
+	 * @internal
 	 */
 	public function getView(): array {
 		$view = array();
@@ -258,7 +258,7 @@ 
 				"description"=>$description,
 				"error_message"=>$error_message,
 				"edit_url"=>$editUrl,
-                "patch_type"=>$patchType
+				"patch_type"=>$patchType
 			);
 			$view[] = $patchView;
 		}
@@ -293,52 +293,52 @@ 
 		$patch->revert();
 	}
 
-    /**
-     * Apply all remaining patches (patches in state "awaiting" or in "error").
-     * The types of the patches can be passed as an array of string where the string is the name of the patch.
-     * Patches with the "default" type are always applied.
-     *
-     * @param string[] $types
-     * @return array An array containing 2 keys: "applied" and "skipped". Each key contains an associative array with the type of the patch and the number of patches of this type applied.
-     */
+	/**
+	 * Apply all remaining patches (patches in state "awaiting" or in "error").
+	 * The types of the patches can be passed as an array of string where the string is the name of the patch.
+	 * Patches with the "default" type are always applied.
+	 *
+	 * @param string[] $types
+	 * @return array An array containing 2 keys: "applied" and "skipped". Each key contains an associative array with the type of the patch and the number of patches of this type applied.
+	 */
 	public function applyAll(array $types = []): array {
-        // Array of count of applied and skipped patches. Key is the patch type.
-        $appliedPatchArray = [];
-        $skippedPatchArray = [];
+		// Array of count of applied and skipped patches. Key is the patch type.
+		$appliedPatchArray = [];
+		$skippedPatchArray = [];
 
-        foreach ($this->patchs as $patch) {
-            if ($patch->getStatus() === PatchInterface::STATUS_AWAITING || $patch->getStatus() === PatchInterface::STATUS_ERROR) {
-                $type = $patch->getPatchType()->getName();
-                if ($type === '' || in_array($type, $types, true)) {
-                    $this->apply($patch->getUniqueName());
-                    if (!isset($appliedPatchArray[$type])) {
-                        $appliedPatchArray[$type] = 0;
-                    }
-                    $appliedPatchArray[$type]++;
-                } else {
-                    $this->skip($patch->getUniqueName());
-                    if (!isset($skippedPatchArray[$type])) {
-                        $skippedPatchArray[$type] = 0;
-                    }
-                    $skippedPatchArray[$type]++;
-                }
-            }
-        }
+		foreach ($this->patchs as $patch) {
+			if ($patch->getStatus() === PatchInterface::STATUS_AWAITING || $patch->getStatus() === PatchInterface::STATUS_ERROR) {
+				$type = $patch->getPatchType()->getName();
+				if ($type === '' || in_array($type, $types, true)) {
+					$this->apply($patch->getUniqueName());
+					if (!isset($appliedPatchArray[$type])) {
+						$appliedPatchArray[$type] = 0;
+					}
+					$appliedPatchArray[$type]++;
+				} else {
+					$this->skip($patch->getUniqueName());
+					if (!isset($skippedPatchArray[$type])) {
+						$skippedPatchArray[$type] = 0;
+					}
+					$skippedPatchArray[$type]++;
+				}
+			}
+		}
 
-        return [
-            'applied' => $appliedPatchArray,
-            'skipped' => $skippedPatchArray
-        ];
-    }
+		return [
+			'applied' => $appliedPatchArray,
+			'skipped' => $skippedPatchArray
+		];
+	}
 
-    /**
-     * Reset all patches to a not applied state.
-     *
-     * Note: this does NOT run the "revert" method on each patch but DOES trigger a "reset" event.
-     */
+	/**
+	 * Reset all patches to a not applied state.
+	 *
+	 * Note: this does NOT run the "revert" method on each patch but DOES trigger a "reset" event.
+	 */
 	public function reset(): void {
-        foreach ($this->listeners as $listener) {
-            $listener->onReset();
-        }
-    }
+		foreach ($this->listeners as $listener) {
+			$listener->onReset();
+		}
+	}
 }

src/Mouf/Utils/Patcher/Controllers/PatchController.php

Indentation +96 added lines, -97 removed lines

@@ -20,7 +20,6 @@ 
 
 /**
  * The controller to track which patchs have been applied.
-
  */
 class PatchController extends AbstractMoufInstanceController {
 	
@@ -99,115 +98,115 @@ 
 		header('Location: .?name='.urlencode($name));
 	}
 
-    /**
-     * Displays the page to select the patch types to be applied.
-     *
-     * @Action
-     * @Logged
-     * @param string $name
-     * @param string $selfedit
-     * @param string $action One of "reset" or "apply"
-     */
-    public function runAllPatches($name, $selfedit, $action) {
-        $this->initController($name, $selfedit);
-
-        $patchService = new InstanceProxy($name, $selfedit == "true");
-        $this->patchesArray = $patchService->getView();
-
-        $types = $patchService->_getSerializedTypes();
-
-        foreach ($types as $type) {
-            $this->nbPatchesByType[$type['name']] = 0;
-        }
-
-        $nbNoneDefaultPatches = 0;
-
-        foreach ($this->patchesArray as $patch) {
-            if ($action === 'reset' || $patch['status'] === PatchInterface::STATUS_AWAITING || $patch['status'] === PatchInterface::STATUS_ERROR) {
-                $type = $patch['patch_type'];
-                if ($type !== '') {
-                    $nbNoneDefaultPatches++;
-                }
-                $this->nbPatchesByType[$type]++;
-            }
-        }
-
-        // If all patches to be applied are default patches, let's do this right now.
-        if ($nbNoneDefaultPatches === 0) {
-            $this->applyAllPatches($name, [''], $action, $selfedit);
-            return;
-        }
-
-        ksort($this->nbPatchesByType);
-
-        $this->action = $action;
-
-        // Otherwise, let's display a screen to select the patch types to be applied.
-        $this->content->addFile(__DIR__."/../../../../views/applyPatches.php", $this);
-        $this->template->toHtml();
-    }
-
-
-    /**
-     * Runs all patches in a row.
-     *
-     * @Action
-     * @Logged
-     * @param string $name
-     * @param string[] $types
-     * @param string $action One of "reset" or "apply"
-     * @param string $selfedit
-     */
+	/**
+	 * Displays the page to select the patch types to be applied.
+	 *
+	 * @Action
+	 * @Logged
+	 * @param string $name
+	 * @param string $selfedit
+	 * @param string $action One of "reset" or "apply"
+	 */
+	public function runAllPatches($name, $selfedit, $action) {
+		$this->initController($name, $selfedit);
+
+		$patchService = new InstanceProxy($name, $selfedit == "true");
+		$this->patchesArray = $patchService->getView();
+
+		$types = $patchService->_getSerializedTypes();
+
+		foreach ($types as $type) {
+			$this->nbPatchesByType[$type['name']] = 0;
+		}
+
+		$nbNoneDefaultPatches = 0;
+
+		foreach ($this->patchesArray as $patch) {
+			if ($action === 'reset' || $patch['status'] === PatchInterface::STATUS_AWAITING || $patch['status'] === PatchInterface::STATUS_ERROR) {
+				$type = $patch['patch_type'];
+				if ($type !== '') {
+					$nbNoneDefaultPatches++;
+				}
+				$this->nbPatchesByType[$type]++;
+			}
+		}
+
+		// If all patches to be applied are default patches, let's do this right now.
+		if ($nbNoneDefaultPatches === 0) {
+			$this->applyAllPatches($name, [''], $action, $selfedit);
+			return;
+		}
+
+		ksort($this->nbPatchesByType);
+
+		$this->action = $action;
+
+		// Otherwise, let's display a screen to select the patch types to be applied.
+		$this->content->addFile(__DIR__."/../../../../views/applyPatches.php", $this);
+		$this->template->toHtml();
+	}
+
+
+	/**
+	 * Runs all patches in a row.
+	 *
+	 * @Action
+	 * @Logged
+	 * @param string $name
+	 * @param string[] $types
+	 * @param string $action One of "reset" or "apply"
+	 * @param string $selfedit
+	 */
 	public function applyAllPatches($name, array $types, $action, $selfedit) {
 		$patchService = new InstanceProxy($name, $selfedit == "true");
 		/* @var $patchService PatchService */
 
-        if ($action === 'reset') {
-            $patchService->reset();
-        }
-        try {
+		if ($action === 'reset') {
+			$patchService->reset();
+		}
+		try {
 
-            [
-                'applied' => $appliedPatchArray,
-                'skipped' => $skippedPatchArray
-            ] = $patchService->applyAll($types);
+			[
+				'applied' => $appliedPatchArray,
+				'skipped' => $skippedPatchArray
+			] = $patchService->applyAll($types);
 
 		} catch (\Exception $e) {
 			$htmlMessage = "An error occured while applying the patch: ".$e->getMessage();
 			set_user_message($htmlMessage);
 		}
 
-        $this->displayNotificationMessage($appliedPatchArray, $skippedPatchArray);
+		$this->displayNotificationMessage($appliedPatchArray, $skippedPatchArray);
 
-        header('Location: .?name='.urlencode($name));
+		header('Location: .?name='.urlencode($name));
 	}
 
 	private function displayNotificationMessage(array $appliedPatchArray, array $skippedPatchArray)
-    {
-        $nbPatchesApplied = array_sum($appliedPatchArray);
-        $nbPatchesSkipped = array_sum($skippedPatchArray);
-        $msg = '';
-        if ($nbPatchesApplied !== 0) {
-            $patchArr = [];
-            foreach ($appliedPatchArray as $name => $number) {
-                $name = $name ?: 'default';
-                $patchArr[] = plainstring_to_htmlprotected($name).': '.$number;
-            }
-
-            $msg .= sprintf('%d patch%s applied (%s)', $nbPatchesApplied, ($nbPatchesApplied > 1)?'es':'', implode(', ', $patchArr));
-        }
-        if ($nbPatchesSkipped !== 0) {
-            $patchArr = [];
-            foreach ($skippedPatchArray as $name => $number) {
-                $name = $name ?: 'default';
-                $patchArr[] = plainstring_to_htmlprotected($name).': '.$number;
-            }
-
-            $msg .= sprintf('%d patch%s skipped (%s)', $nbPatchesSkipped, ($nbPatchesSkipped > 1)?'es':'', implode(', ', $patchArr));
-        }
-
-        if ($msg !== '') {
-            set_user_message($msg, UserMessageInterface::SUCCESS);
-        }
-    }
+	{
+		$nbPatchesApplied = array_sum($appliedPatchArray);
+		$nbPatchesSkipped = array_sum($skippedPatchArray);
+		$msg = '';
+		if ($nbPatchesApplied !== 0) {
+			$patchArr = [];
+			foreach ($appliedPatchArray as $name => $number) {
+				$name = $name ?: 'default';
+				$patchArr[] = plainstring_to_htmlprotected($name).': '.$number;
+			}
+
+			$msg .= sprintf('%d patch%s applied (%s)', $nbPatchesApplied, ($nbPatchesApplied > 1)?'es':'', implode(', ', $patchArr));
+		}
+		if ($nbPatchesSkipped !== 0) {
+			$patchArr = [];
+			foreach ($skippedPatchArray as $name => $number) {
+				$name = $name ?: 'default';
+				$patchArr[] = plainstring_to_htmlprotected($name).': '.$number;
+			}
+
+			$msg .= sprintf('%d patch%s skipped (%s)', $nbPatchesSkipped, ($nbPatchesSkipped > 1)?'es':'', implode(', ', $patchArr));
+		}
+
+		if ($msg !== '') {
+			set_user_message($msg, UserMessageInterface::SUCCESS);
+		}
+	}
 }
\ No newline at end of file

src/Mouf/Utils/Patcher/Commands/ApplyAllPatchesCommand.php

Indentation +24 added lines, -24 removed lines

@@ -17,32 +17,32 @@
 {
 
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
-    {
-        $this
-        ->setName('patches:apply-all')
-        ->setDescription('Apply pending patches.')
-        ->setDefinition(array(
-
-        ))
-        ->setHelp(<<<EOT
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function configure()
+	{
+		$this
+		->setName('patches:apply-all')
+		->setDescription('Apply pending patches.')
+		->setDefinition(array(
+
+		))
+		->setHelp(<<<EOT
 Apply pending patches. You can select the type of patches to be applied using the options. Default patches are always applied.
 
 Use patches:apply if you want to cherry-pick a particular patch.
 EOT
-        );
-
-        $this->registerOptions();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
-    {
-        $this->applyAll($input, $output);
-    }
+		);
+
+		$this->registerOptions();
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$this->applyAll($input, $output);
+	}
 }

src/Mouf/Utils/Patcher/Commands/AbstractApplyAllCommand.php

Indentation +77 added lines, -77 removed lines

@@ -12,81 +12,81 @@
 
 class AbstractApplyAllCommand extends Command
 {
-    /**
-     * @var PatchService
-     */
-    protected $patchService;
-
-    public function __construct(PatchService $patchService)
-    {
-        $this->patchService = $patchService;
-        parent::__construct();
-    }
-
-    protected function registerOptions(): void
-    {
-        foreach ($this->patchService->getTypes() as $type) {
-            if ($type->getName() !== '') {
-                $this->addOption($type->getName(), null, InputOption::VALUE_NONE, 'Applies patches of type "'.$type->getName().'". '.$type->getDescription());
-            }
-        }
-    }
-
-    protected function applyAll(InputInterface $input, OutputInterface $output)
-    {
-        $types = [];
-        foreach ($this->patchService->getTypes() as $type) {
-            if ($type->getName() !== '' && $input->getOption($type->getName())) {
-                $types[] = $type->getName();
-            }
-        }
-
-        try {
-
-            [
-                'applied' => $appliedPatchArray,
-                'skipped' => $skippedPatchArray
-            ] = $this->patchService->applyAll($types);
-
-        } catch (\Exception $e) {
-            $output->writeln(sprintf(
-                'An error occurred while applying patch: <error>%s</error>', $e->getMessage()
-            ));
-            throw $e;
-        }
-
-        $msg = $this->getNotificationMessage($appliedPatchArray, $skippedPatchArray);
-        if ($msg) {
-            $output->writeln($msg);
-        } else {
-            $output->writeln('<info>No patches to apply</info>');
-        }
-    }
-
-    private function getNotificationMessage(array $appliedPatchArray, array $skippedPatchArray): string
-    {
-        $nbPatchesApplied = array_sum($appliedPatchArray);
-        $nbPatchesSkipped = array_sum($skippedPatchArray);
-        $msg = '';
-        if ($nbPatchesApplied !== 0) {
-            $patchArr = [];
-            foreach ($appliedPatchArray as $name => $number) {
-                $name = $name ?: 'default';
-                $patchArr[] = $name.': <info>'.$number.'</info>';
-            }
-
-            $msg .= sprintf('<info>%d</info> patch%s applied (%s)', $nbPatchesApplied, ($nbPatchesApplied > 1)?'es':'', implode(', ', $patchArr))."\n";
-        }
-        if ($nbPatchesSkipped !== 0) {
-            $patchArr = [];
-            foreach ($skippedPatchArray as $name => $number) {
-                $name = $name ?: 'default';
-                $patchArr[] = $name.': <info>'.$number.'</info>';
-            }
-
-            $msg .= sprintf('<info>%d</info><comment> patch%s skipped</comment> (%s)', $nbPatchesSkipped, ($nbPatchesSkipped > 1)?'es':'', implode(', ', $patchArr));
-        }
-
-        return $msg;
-    }
+	/**
+	 * @var PatchService
+	 */
+	protected $patchService;
+
+	public function __construct(PatchService $patchService)
+	{
+		$this->patchService = $patchService;
+		parent::__construct();
+	}
+
+	protected function registerOptions(): void
+	{
+		foreach ($this->patchService->getTypes() as $type) {
+			if ($type->getName() !== '') {
+				$this->addOption($type->getName(), null, InputOption::VALUE_NONE, 'Applies patches of type "'.$type->getName().'". '.$type->getDescription());
+			}
+		}
+	}
+
+	protected function applyAll(InputInterface $input, OutputInterface $output)
+	{
+		$types = [];
+		foreach ($this->patchService->getTypes() as $type) {
+			if ($type->getName() !== '' && $input->getOption($type->getName())) {
+				$types[] = $type->getName();
+			}
+		}
+
+		try {
+
+			[
+				'applied' => $appliedPatchArray,
+				'skipped' => $skippedPatchArray
+			] = $this->patchService->applyAll($types);
+
+		} catch (\Exception $e) {
+			$output->writeln(sprintf(
+				'An error occurred while applying patch: <error>%s</error>', $e->getMessage()
+			));
+			throw $e;
+		}
+
+		$msg = $this->getNotificationMessage($appliedPatchArray, $skippedPatchArray);
+		if ($msg) {
+			$output->writeln($msg);
+		} else {
+			$output->writeln('<info>No patches to apply</info>');
+		}
+	}
+
+	private function getNotificationMessage(array $appliedPatchArray, array $skippedPatchArray): string
+	{
+		$nbPatchesApplied = array_sum($appliedPatchArray);
+		$nbPatchesSkipped = array_sum($skippedPatchArray);
+		$msg = '';
+		if ($nbPatchesApplied !== 0) {
+			$patchArr = [];
+			foreach ($appliedPatchArray as $name => $number) {
+				$name = $name ?: 'default';
+				$patchArr[] = $name.': <info>'.$number.'</info>';
+			}
+
+			$msg .= sprintf('<info>%d</info> patch%s applied (%s)', $nbPatchesApplied, ($nbPatchesApplied > 1)?'es':'', implode(', ', $patchArr))."\n";
+		}
+		if ($nbPatchesSkipped !== 0) {
+			$patchArr = [];
+			foreach ($skippedPatchArray as $name => $number) {
+				$name = $name ?: 'default';
+				$patchArr[] = $name.': <info>'.$number.'</info>';
+			}
+
+			$msg .= sprintf('<info>%d</info><comment> patch%s skipped</comment> (%s)', $nbPatchesSkipped, ($nbPatchesSkipped > 1)?'es':'', implode(', ', $patchArr));
+		}
+
+		return $msg;
+	}
 }
\ No newline at end of file

src/Mouf/Utils/Patcher/Commands/ResetPatchesCommand.php

Indentation +22 added lines, -22 removed lines

@@ -15,34 +15,34 @@
  */
 class ResetPatchesCommand extends AbstractApplyAllCommand
 {
-    /**
-     * {@inheritdoc}
-     */
-    protected function configure()
-    {
-        $this
-        ->setName('patches:reset')
-        ->setDescription('Reset database and reapply all patches.')
-        ->setDefinition(array(
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function configure()
+	{
+		$this
+		->setName('patches:reset')
+		->setDescription('Reset database and reapply all patches.')
+		->setDefinition(array(
 
-        ))
-        ->setHelp(<<<EOT
+		))
+		->setHelp(<<<EOT
 Reset the database and reapplies all pending patches. You can select the type of patches to be applied using the options. Default patches are always applied.
 
 Use patches:apply-all if you want to apply remaining patches without resetting the database.
 EOT
-        );
+		);
 
-        $this->registerOptions();
-    }
+		$this->registerOptions();
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function execute(InputInterface $input, OutputInterface $output)
-    {
-        $this->patchService->reset();
+	/**
+	 * {@inheritdoc}
+	 */
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		$this->patchService->reset();
 
-        $this->applyAll($input, $output);
-    }
+		$this->applyAll($input, $output);
+	}
 }