introduce RedirectChecker bundle

Author: honzavaclavik

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+composer.lock

README.md

@@ -1 +1,34 @@
-# redirect-checker
+# Redirect Checker
+Simple tool for checking if your **http redirects** work as you want.
+
+Installation
+-
+```
+$ composer require antstudiocz/redirect-checker
+```
+
+Register DI extension:
+```neon
+extensions: 
+    - Ant\RedirectChecker\DI\RedirectCheckerExtension
+```
+
+Add configuration:
+```neon    
+parameters: 
+    redirect-checker:
+        file: app/config/redirects.neon
+```
+
+Create file for example:
+```neon
+redirects:
+    "https://www.antstudio.cz": http://www.antstudio.cz
+```
+
+Usage
+-
+```
+$ php index.php app:redirect-checker:run
+```
+

composer.json

@@ -0,0 +1,22 @@
+{
+  "name": "antstudiocz/redirect-checker",
+  "license": "MIT",
+  "require": {
+    "nette/neon": "^2.4",
+    "nette/utils": "^2.4",
+    "ptcong/php-http-class": "^3.0",
+    "symfony/console": "^3.1",
+    "kdyby/console": "^2.6",
+    "adeira/compiler-extension": "^1.0"
+  },
+  "require-dev": {
+    "consistence/coding-standard": "^0.12.0",
+    "slevomat/coding-standard": "^1.0",
+    "nette/tester": "2.0.x-dev as v1.7"
+  },
+  "autoload": {
+    "psr-4": {
+      "Ant\\RedirectChecker\\": "src/"
+    }
+  }
+}

ruleset.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0"?>
+<ruleset name="ANT studio">
+
+    <!--
+        SEE:
+        - https://github.com/juzna/nette-coding-standard/blob/master/NetteStandard/ruleset.xml
+        - https://gist.github.com/jakubkulhan/b054b89cb207822fcb71
+        - https://github.com/consistence/coding-standard
+        - https://github.com/slevomat/coding-standard
+    -->
+
+    <description>The ANT studio coding standard.</description>
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+
+    <!-- Composer vendor: -->
+    <rule ref="./vendor/consistence/coding-standard/Consistence/ruleset.xml">
+        <exclude name="Generic.PHP.LowerCaseConstant"/>
+        <exclude name="Generic.Formatting.SpaceAfterCast"/>
+        <exclude name="Generic.Functions.OpeningFunctionBraceBsdAllman.BraceOnSameLine"/> <!-- better implementation already in: Squiz.Functions.MultiLineFunctionDeclaration.BraceOnSameLine -->
+        <exclude name="Squiz.Commenting.FunctionComment.MissingParamTag"/>
+        <exclude name="Squiz.Commenting.FunctionComment.WrongStyle"/>
+        <exclude name="Squiz.PHP.Heredoc.NotAllowed"/>
+        <exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar"/>
+    </rule>
+
+    <rule ref="./vendor/slevomat/coding-standard/SlevomatCodingStandard/ruleset.xml">
+        <exclude name="SlevomatCodingStandard.Files.TypeNameMatchesFileName"/>
+        <exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameAfterKeyword"/>
+        <exclude name="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly"/>
+        <exclude name="SlevomatCodingStandard.Namespaces.UseOnlyWhitelistedNamespaces"/>
+    </rule>
+
+    <rule ref="PSR1.Files.SideEffects.FoundWithSymbols">
+        <exclude-pattern>*.phpt</exclude-pattern>
+    </rule>
+
+    <rule ref="SlevomatCodingStandard.Classes.UnusedPrivateElements">
+        <properties>
+            <property name="alwaysUsedPropertiesAnnotations" type="array" value="@ORM\Column,@ORM\Embedded,@ORM\JoinColumn,@ORM\ManyToMany"/>
+        </properties>
+    </rule>
+
+    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
+        <properties>
+            <property name="searchAnnotations" value="true"/>
+        </properties>
+    </rule>
+
+    <rule ref="Generic.PHP.UpperCaseConstant"/>
+
+</ruleset>

src/Checker.php

@@ -0,0 +1,109 @@
+<?php
+
+namespace Ant\RedirectChecker;
+
+use Nette\Neon\Neon;
+
+class Checker
+{
+
+	const PASSED = 'ok';
+	const WARNING = 'warning';
+	const FAILED = 'failed';
+
+	private $configFile;
+
+	public function __construct($configFile = '')
+	{
+		$this->configFile = __DIR__ . '/../../' . $configFile;
+	}
+
+	public function run()
+	{
+		return $this->checkListFromNeon($this->configFile);
+	}
+
+	/**
+	 * Will check list from associative array of rules.
+	 * Index => origin url, Value => needed url
+	 *
+	 * @param [] $list
+	 *
+	 * @return array [OVERALL STATUS, [[SINGLE STATUS, [additional single info]]]]
+	 */
+	public function checkList($list)
+	{
+		$out = self::PASSED;
+		$responses = [];
+		foreach ($list as $originUrl => $finalUrl) {
+			list($result, $response) = $this->check($originUrl, $finalUrl);
+			switch ($result) {
+				case self::WARNING:
+					if ($out == self::PASSED) {
+						$out = $result;
+					}
+					break;
+				case self::FAILED:
+					if ($out !== self::FAILED) {
+						$out = $result;
+					}
+					break;
+			}
+			$responses[] = [$result, $response];
+		}
+		return [$out, $responses];
+	}
+
+	/**
+	 * Checks single url
+	 *
+	 * @param string $originUrl Full url with http://
+	 * @param string $finalUrl Full url with http://
+	 * @param integer $maxFollowRedirects
+	 *
+	 * @return array [STATUS, [additional info for output]]
+	 */
+	public function check($originUrl, $finalUrl, $maxFollowRedirects = 10)
+	{
+		$out = self::FAILED;
+		$client = \EasyRequest::create($originUrl, 'GET', ['follow_redirects' => $maxFollowRedirects]);
+		$client->send();
+		$outList = $list = $client->getRedirectedUrls();
+
+		if (empty($list)) {
+			if ($originUrl == $finalUrl) {
+				$out = self::PASSED;
+			}
+		} elseif (in_array($finalUrl, $list)) {
+			if (array_pop($list) == $finalUrl) {
+				$out = self::PASSED;
+			} else {
+				$out = self::WARNING;
+			}
+		}
+
+		array_shift($outList);
+		return [$out, ['from' => $originUrl, 'to' => $finalUrl, 'hops' => $outList, 'hopsCount' => count($outList)]];
+	}
+
+	/**
+	 * Will check list of rules from a neon file.
+	 *
+	 * @param string $filefilename
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function checkListFromNeon($filefilename)
+	{
+		if (!file_exists($filefilename)) {
+			throw new \Exception("File '$filefilename' not found.");
+		}
+		$configuration = Neon::decode(file_get_contents($filefilename));
+		if (!isset($configuration['redirects']) || empty($configuration['redirects'])) {
+			throw new \Exception("Section 'redirects' not found or empty in configuration file: '{$filefilename}'");
+		}
+		return $this->checkList($configuration['redirects']);
+	}
+
+}

src/Console/TestRedirects.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Ant\RedirectChecker\Console;
+
+use Ant\RedirectChecker\Checker;
+use Nette\Utils\Strings;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class TestRedirects extends \Symfony\Component\Console\Command\Command
+{
+
+	/** @var Checker @inject */
+	public $checker;
+
+	protected function configure()
+	{
+		$this->setName('app:redirect-checker:run');
+		$this->setDescription('Checks list of redirects');
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output)
+	{
+		try {
+			list($result, $data) = $this->checker->run();
+			foreach ($data as $resultRow) {
+				$row = $this->style(Strings::firstUpper($resultRow[0]), $resultRow[0]);
+				$output->writeln($row);
+				$output->writeln("\tFrom: " . $resultRow[1]['from']);
+				$output->writeln("\tTo: " . $resultRow[1]['to']);
+				$output->writeln("\tHops count: " . $resultRow[1]['hopsCount']);
+				if ($resultRow[0] !== Checker::PASSED || $resultRow[1]['hopsCount'] > 1) {
+					$output->writeln("\tHops: " . implode(' -> ', $resultRow[1]['hops']));
+				}
+				$output->writeln('');
+			}
+
+			$output->writeln('============================');
+			$output->writeln('Final result: ' . $this->style(Strings::firstUpper($result), $result));
+
+			return 0; // zero return code means everything is ok
+		} catch (\Exception $exc) {
+			$output->writeln('<error>' . $exc->getMessage() . '</error>');
+			return 1; // non-zero return code means error
+		}
+	}
+
+	protected function style($text, $state)
+	{
+		switch ($state) {
+			case Checker::FAILED:
+				$out = "<error>{$text}</error>";
+				break;
+			case Checker::WARNING:
+				$out = "<comment>{$text}</comment>";
+				break;
+			default:
+				$out = "<info>{$text}</info>";
+		}
+		return $out;
+
+	}
+
+}

src/DI/RedirectCheckerExtension.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Ant\RedirectChecker\DI;
+
+use Adeira\CompilerExtension;
+use Ant\RedirectChecker\Console\TestRedirects;
+
+class RedirectCheckerExtension extends CompilerExtension
+{
+
+	public function loadConfiguration()
+	{
+		$this->addConfig(__DIR__ . '/services.neon');
+
+		$builder = $this->getContainerBuilder();
+		$builder->addDefinition($this->prefix('command.testRedirects'))
+			->setClass(TestRedirects::class)
+			->addTag(\Kdyby\Console\DI\ConsoleExtension::TAG_COMMAND);
+	}
+
+}

src/DI/services.neon

@@ -0,0 +1,2 @@
+services:
+	- Ant\RedirectChecker\Checker(%redirect-checker.file%)