Move contributte/wordcha

.docs/README.md

@@ -8,6 +8,8 @@
   - [StandaloneFormFactoryExtension](#standalone-form-factory) (Nette\Forms\Form)
 - Controls
   - [Date/time inputs](#date-time-inputs) (DateTimeInput, DateInput, TimeInput)
+- Captcha
+  - [Wordcha](#wordcha) (Question-based captcha)
 
 ## Setup
 
@@ -346,3 +348,72 @@ $control->setValueAs(DateTime::class); // value in input timezone as \DateTime
 $control->setValueInTzAs(DateTime::class); // value in server default timezone as \DateTime
 $control->setValueInTzAs(DateTime::class, new DateTimeZone('Americe/New_York')); // value in given timezone as \DateTime
 ```
+
+## Captcha
+
+### Wordcha
+
+Question-based captcha for Nette Framework / Forms.
+
+#### Wordcha Setup
+
+Register extension
+
+```yaml
+extensions:
+    wordcha: Contributte\Forms\Captcha\Wordcha\DI\WordchaExtension
+```
+
+#### Wordcha Configuration
+
+At the beginning you should pick the right datasource.
+
+##### Numeric datasource
+
+```yaml
+wordcha:
+    datasource: numeric
+```
+
+##### Question datasource
+
+```yaml
+wordcha:
+    datasource: questions
+    questions:
+        "Question a?": "a"
+        "Question b?": "b"
+```
+
+#### Wordcha Form Usage
+
+```php
+use Nette\Application\UI\Form;
+
+protected function createComponentForm()
+{
+    $form = new Form();
+
+    $form->addWordcha('wordcha')
+        ->getQuestion()
+        ->setRequired('Please answer antispam question');
+
+    $form->addSubmit('send');
+
+    $form->onValidate[] = function (Form $form) {
+        if ($form['wordcha']->verify() !== TRUE) {
+            $form->addError('Are you robot?');
+        }
+    };
+
+    $form->onSuccess[] = function (Form $form) {
+        dump($form['wordcha']);
+    };
+
+    return $form;
+}
+```
+
+#### Wordcha Example
+
+![captcha](wordcha.png)

src/Captcha/Wordcha/DI/FormBinder.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Forms\Captcha\Wordcha\DI;
+
+use Contributte\Forms\Captcha\Wordcha\Factory;
+use Contributte\Forms\Captcha\Wordcha\Form\WordchaContainer;
+use Nette\Forms\Container;
+
+final class FormBinder
+{
+
+	public static function bind(Factory $factory): void
+	{
+		Container::extensionMethod(
+			'addWordcha',
+			fn (Container $container, string $name = 'captcha', string $label = 'Captcha'): WordchaContainer => $container[$name] = new WordchaContainer($factory) // @phpcs:ignore
+		);
+	}
+
+}

src/Captcha/Wordcha/DI/WordchaExtension.php

@@ -0,0 +1,94 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Forms\Captcha\Wordcha\DI;
+
+use Contributte\Forms\Captcha\Wordcha\DataSource\DataSource;
+use Contributte\Forms\Captcha\Wordcha\DataSource\NumericDataSource;
+use Contributte\Forms\Captcha\Wordcha\DataSource\QuestionDataSource;
+use Contributte\Forms\Captcha\Wordcha\Factory;
+use Contributte\Forms\Captcha\Wordcha\WordchaFactory;
+use Contributte\Forms\Captcha\Wordcha\WordchaUniqueFactory;
+use Nette\DI\CompilerExtension;
+use Nette\PhpGenerator\ClassType;
+use Nette\PhpGenerator\Literal;
+use Nette\Schema\Expect;
+use Nette\Schema\Schema;
+use Nette\Utils\AssertionException;
+use stdClass;
+
+/**
+ * @property-read stdClass $config
+ */
+final class WordchaExtension extends CompilerExtension
+{
+
+	public const DATASOURCE_NUMERIC = 'numeric';
+	public const DATASOURCE_QUESTIONS = 'questions';
+
+	public const DATASOURCES = [
+		self::DATASOURCE_NUMERIC,
+		self::DATASOURCE_QUESTIONS,
+	];
+
+	private bool $debugMode;
+
+	public function __construct(bool $debugMode = false)
+	{
+		$this->debugMode = $debugMode;
+	}
+
+	public function getConfigSchema(): Schema
+	{
+		return Expect::structure([
+			'auto' => Expect::bool()->default(true),
+			'datasource' => Expect::anyOf(...self::DATASOURCES)->default(self::DATASOURCE_NUMERIC),
+			'questions' => Expect::listOf('string'),
+		]);
+	}
+
+	/**
+	 * Register services
+	 *
+	 * @throws AssertionException
+	 */
+	public function loadConfiguration(): void
+	{
+		$builder = $this->getContainerBuilder();
+
+		// Add datasource
+		$dataSource = $builder->addDefinition($this->prefix('dataSource'))
+			->setType(DataSource::class);
+
+		if ($this->config->datasource === self::DATASOURCE_NUMERIC) {
+			$dataSource->setFactory(NumericDataSource::class);
+		} elseif ($this->config->datasource === self::DATASOURCE_QUESTIONS) {
+			$dataSource->setFactory(QuestionDataSource::class, [$this->config->questions]);
+		}
+
+		// Add factory
+		$factory = $builder->addDefinition($this->prefix('factory'))
+			->setType(Factory::class);
+		if ($this->debugMode) {
+			$factory->setFactory(WordchaFactory::class, [$dataSource]);
+		} else {
+			$uniqueKey = sha1(random_bytes(10) . microtime(true));
+			$factory->setFactory(WordchaUniqueFactory::class, [$dataSource, $uniqueKey]);
+		}
+	}
+
+	public function afterCompile(ClassType $class): void
+	{
+		if ($this->config->auto === true) {
+
+			$method = $class->getMethod('initialize');
+			$method->addBody(
+				'?::bind($this->getService(?));',
+				[
+					new Literal(FormBinder::class),
+					$this->prefix('factory'),
+				]
+			);
+		}
+	}
+
+}

src/Captcha/Wordcha/DataSource/DataSource.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Forms\Captcha\Wordcha\DataSource;
+
+interface DataSource
+{
+
+	public function get(): Pair;
+
+}

src/Captcha/Wordcha/DataSource/NumericDataSource.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Forms\Captcha\Wordcha\DataSource;
+
+use Contributte\Forms\Captcha\Wordcha\Exception\LogicalException;
+
+class NumericDataSource implements DataSource
+{
+
+	private int $min;
+
+	private int $max;
+
+	public function __construct(int $min = 0, int $max = 10)
+	{
+		if ($min > $max) {
+			throw new LogicalException(sprintf('Min (%d) must be less than or equal to max (%d)', $min, $max));
+		}
+
+		$this->min = $min;
+		$this->max = $max;
+	}
+
+	public function get(): Pair
+	{
+		$numberA = $this->generateNumber();
+		$numberB = $this->generateNumber();
+
+		$question = sprintf('%s + %s', $numberA, $numberB);
+		$answer = $numberA + $numberB;
+
+		return new Pair($question, (string) $answer);
+	}
+
+	private function generateNumber(): int
+	{
+		return random_int($this->min, $this->max);
+	}
+
+}

src/Captcha/Wordcha/DataSource/Pair.php

@@ -0,0 +1,28 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Forms\Captcha\Wordcha\DataSource;
+
+class Pair
+{
+
+	private string $question;
+
+	private string $answer;
+
+	public function __construct(string $question, string $answer)
+	{
+		$this->question = $question;
+		$this->answer = $answer;
+	}
+
+	public function getQuestion(): string
+	{
+		return $this->question;
+	}
+
+	public function getAnswer(): string
+	{
+		return $this->answer;
+	}
+
+}

src/Captcha/Wordcha/DataSource/QuestionDataSource.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Forms\Captcha\Wordcha\DataSource;
+
+use Contributte\Forms\Captcha\Wordcha\Exception\LogicalException;
+use Exception;
+
+class QuestionDataSource implements DataSource
+{
+
+	/** @var array<string, string> Pairs of question:answer */
+	private array $questions;
+
+	/**
+	 * @param array<string, string> $questions
+	 */
+	public function __construct(array $questions)
+	{
+		$this->questions = $questions;
+	}
+
+	/**
+	 * @throws Exception
+	 */
+	public function get(): Pair
+	{
+		if ($this->questions === []) {
+			throw new LogicalException('Questions are empty');
+		}
+
+		$question = array_rand($this->questions);
+		$answer = $this->questions[$question];
+
+		return new Pair($question, $answer);
+	}
+
+}

src/Captcha/Wordcha/Exception/LogicalException.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Forms\Captcha\Wordcha\Exception;
+
+class LogicalException extends \LogicException
+{
+
+}

src/Captcha/Wordcha/Exception/RuntimeException.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Forms\Captcha\Wordcha\Exception;
+
+class RuntimeException extends \RuntimeException
+{
+
+}

src/Captcha/Wordcha/Factory.php

@@ -0,0 +1,15 @@
+<?php declare(strict_types = 1);
+
+namespace Contributte\Forms\Captcha\Wordcha;
+
+use Contributte\Forms\Captcha\Wordcha\Generator\Generator;
+use Contributte\Forms\Captcha\Wordcha\Validator\Validator;
+
+interface Factory
+{
+
+	public function createValidator(): Validator;
+
+	public function createGenerator(): Generator;
+
+}