[BC BREAK] Remove captcha

Author: Danielss89

composer.json

@@ -1,10 +1,11 @@
 {
     "name": "zf-commons/zfc-user",
-    "description": "A generic user registration and authentication module for ZF2. Supports Zend\\Db and Doctrine2.",
+    "description": "A generic user registration and authentication module for ZF2. Supports multiple adapters with built-in support for Zend\\Db.",
     "type": "library",
     "license": "BSD-3-Clause",
     "keywords": [
-        "zf2"
+        "zf2",
+        "authentication"
     ],
     "homepage": "https://github.com/ZF-Commons/ZfcUser",
     "authors": [
@@ -48,11 +49,7 @@
     },
     "require-dev" : {
         "phpunit/phpunit" : ">=3.7,<4",
-        "squizlabs/php_codesniffer" : "1.4.*",
-        "zendframework/zend-captcha" : "~2.1"
-    },
-    "suggest": {
-        "zendframework/zend-captcha" : "Zend\\Captcha if you want to use the captcha component"
+        "squizlabs/php_codesniffer" : "1.4.*"
     },
     "autoload": {
         "psr-0": {

src/ZfcUser/Form/Base.php

@@ -61,17 +61,6 @@ public function __construct()
             ),
         ));
 
-        if ($this->getRegistrationOptions()->getUseRegistrationFormCaptcha()) {
-            $this->add(array(
-                'name' => 'captcha',
-                'type' => 'Zend\Form\Element\Captcha',
-                'options' => array(
-                    'label' => 'Please type the following text',
-                    'captcha' => $this->getRegistrationOptions()->getFormCaptchaOptions(),
-                ),
-            ));
-        }
-
         $submitElement = new Element\Button('submit');
         $submitElement
             ->setLabel('Submit')

src/ZfcUser/Form/Register.php

@@ -2,13 +2,10 @@
 
 namespace ZfcUser\Form;
 
-use Zend\Form\Element\Captcha as Captcha;
 use ZfcUser\Options\RegistrationOptionsInterface;
 
 class Register extends Base
 {
-    protected $captchaElement= null;
-
     /**
      * @var RegistrationOptionsInterface
      */
@@ -30,18 +27,10 @@ public function __construct($name, RegistrationOptionsInterface $options)
         if (!$this->getRegistrationOptions()->getEnableDisplayName()) {
             $this->remove('display_name');
         }
-        if ($this->getRegistrationOptions()->getUseRegistrationFormCaptcha() && $this->captchaElement) {
-            $this->add($this->captchaElement, array('name'=>'captcha'));
-        }
         $this->get('submit')->setLabel('Register');
         $this->getEventManager()->trigger('init', $this);
     }
 
-    public function setCaptchaElement(Captcha $captchaElement)
-    {
-        $this->captchaElement= $captchaElement;
-    }
-
     /**
      * Set Registration Options
      *

src/ZfcUser/Options/ModuleOptions.php

@@ -91,11 +91,6 @@ class ModuleOptions extends AbstractOptions implements UserControllerOptionsInte
      */
     protected $enableDisplayName = false;
 
-    /**
-     * @var bool
-     */
-    protected $useRegistrationFormCaptcha = false;
-
     /**
      * @var int
      */
@@ -107,17 +102,6 @@ class ModuleOptions extends AbstractOptions implements UserControllerOptionsInte
 
     protected $tableName = 'user';
 
-    /**
-     * @var array
-     */
-    protected $formCaptchaOptions = array(
-        'class'   => 'figlet',
-        'options' => array(
-            'wordLen'    => 5,
-            'expiration' => 300,
-            'timeout'    => 300,
-        ),
-    );
 
     /**
      * set login redirect route
@@ -449,28 +433,6 @@ public function getEnableDisplayName()
         return $this->enableDisplayName;
     }
 
-    /**
-     * set use a captcha in registration form
-     *
-     * @param bool $useRegistrationFormCaptcha
-     * @return ModuleOptions
-     */
-    public function setUseRegistrationFormCaptcha($useRegistrationFormCaptcha)
-    {
-        $this->useRegistrationFormCaptcha = $useRegistrationFormCaptcha;
-        return $this;
-    }
-
-    /**
-     * get use a captcha in registration form
-     *
-     * @return bool
-     */
-    public function getUseRegistrationFormCaptcha()
-    {
-        return $this->useRegistrationFormCaptcha;
-    }
-
     /**
      * set user entity class name
      *
@@ -534,26 +496,4 @@ public function getTableName()
     {
         return $this->tableName;
     }
-
-    /**
-     * set form CAPTCHA options
-     *
-     * @param array $formCaptchaOptions
-     * @return ModuleOptions
-     */
-    public function setFormCaptchaOptions($formCaptchaOptions)
-    {
-        $this->formCaptchaOptions = $formCaptchaOptions;
-        return $this;
-    }
-
-    /**
-     * get form CAPTCHA options
-     *
-     * @return array
-     */
-    public function getFormCaptchaOptions()
-    {
-        return $this->formCaptchaOptions;
-    }
 }

src/ZfcUser/Options/RegistrationOptionsInterface.php

@@ -62,21 +62,6 @@ public function setUserFormTimeout($userFormTimeout);
      */
     public function getUserFormTimeout();
 
-    /**
-     * set use a captcha in registration form
-     *
-     * @param bool $useRegistrationFormCaptcha
-     * @return ModuleOptions
-     */
-    public function setUseRegistrationFormCaptcha($useRegistrationFormCaptcha);
-
-    /**
-     * get use a captcha in registration form
-     *
-     * @return bool
-     */
-    public function getUseRegistrationFormCaptcha();
-
     /**
      * set login after registration
      *
@@ -91,19 +76,4 @@ public function setLoginAfterRegistration($loginAfterRegistration);
      * @return bool
      */
     public function getLoginAfterRegistration();
-
-    /**
-     * set form CAPTCHA options
-     *
-     * @param array $formCaptchaOptions
-     * @return ModuleOptions
-     */
-    public function setFormCaptchaOptions($formCaptchaOptions);
-
-    /**
-     * get form CAPTCHA options
-     *
-     * @return array
-     */
-    public function getFormCaptchaOptions();
 }

tests/ZfcUserTest/Form/BaseTest.php

@@ -6,26 +6,9 @@
 
 class BaseTest extends \PHPUnit_Framework_TestCase
 {
-    /**
-     * @dataProvider providerTestConstruct
-     */
-    public function testConstruct($useCaptcha = false)
+    public function testConstruct()
     {
         $options = $this->getMock('ZfcUser\Options\RegistrationOptionsInterface');
-        $options->expects($this->once())
-                ->method('getUseRegistrationFormCaptcha')
-                ->will($this->returnValue($useCaptcha));
-
-        if ($useCaptcha) {
-            if (!class_exists('\Zend\Captcha\AbstractAdapter')) {
-                $this->markTestSkipped('we need zendframework/zend-captcha to cover this');
-            }
-            $captcha = $this->getMockForAbstractClass('\Zend\Captcha\AbstractAdapter');
-
-            $options->expects($this->once())
-                    ->method('getFormCaptchaOptions')
-                    ->will($this->returnValue($captcha));
-        }
 
         $form = new Form($options);
 
@@ -39,12 +22,4 @@ public function testConstruct($useCaptcha = false)
         $this->assertArrayHasKey('submit', $elements);
         $this->assertArrayHasKey('userId', $elements);
     }
-
-    public function providerTestConstruct()
-    {
-        return array(
-            array(true),
-            array(false)
-        );
-    }
 }

tests/ZfcUserTest/Form/RegisterTest.php

@@ -51,29 +51,6 @@ public function testSetGetRegistrationOptions()
         $this->assertSame($optionsNew, $form->getRegistrationOptions());
     }
 
-    public function testSetCaptchaElement()
-    {
-        $options = $this->getMock('ZfcUser\Options\RegistrationOptionsInterface');
-        $options->expects($this->once())
-                ->method('getEnableUsername')
-                ->will($this->returnValue(false));
-        $options->expects($this->once())
-                ->method('getEnableDisplayName')
-                ->will($this->returnValue(false));
-        $options->expects($this->any())
-                ->method('getUseRegistrationFormCaptcha')
-                ->will($this->returnValue(false));
-
-        $captcha = $this->getMock('\Zend\Form\Element\Captcha');
-        $form = new Form(null, $options);
-
-        $form->setCaptchaElement($captcha);
-
-        $reflection = $this->helperMakePropertyAccessable($form, 'captchaElement');
-        $this->assertSame($captcha, $reflection->getValue($form));
-    }
-
-
     /**
      *
      * @param mixed $objectOrClass

tests/ZfcUserTest/Options/ModuleOptionsTest.php

@@ -287,24 +287,6 @@ public function testGetEnableDisplayName()
         $this->assertFalse($this->options->getEnableDisplayName());
     }
 
-    /**
-     * @covers ZfcUser\Options\ModuleOptions::getUseRegistrationFormCaptcha
-     * @covers ZfcUser\Options\ModuleOptions::setUseRegistrationFormCaptcha
-     */
-    public function testSetGetUseRegistrationFormCaptcha()
-    {
-        $this->options->setUseRegistrationFormCaptcha(true);
-        $this->assertTrue($this->options->getUseRegistrationFormCaptcha());
-    }
-
-    /**
-     * @covers ZfcUser\Options\ModuleOptions::getUseRegistrationFormCaptcha
-     */
-    public function testGetUseRegistrationFormCaptcha()
-    {
-        $this->assertFalse($this->options->getUseRegistrationFormCaptcha());
-    }
-
     /**
      * @covers ZfcUser\Options\ModuleOptions::getUserEntityClass
      * @covers ZfcUser\Options\ModuleOptions::setUserEntityClass
@@ -358,36 +340,4 @@ public function testGetTableName()
     {
         $this->assertEquals('user', $this->options->getTableName());
     }
-
-    /**
-     * @covers ZfcUser\Options\ModuleOptions::getFormCaptchaOptions
-     * @covers ZfcUser\Options\ModuleOptions::setFormCaptchaOptions
-     */
-    public function testSetGetFormCaptchaOptions()
-    {
-        $expected = array(
-            'class'   => 'someClass',
-            'options' => array(
-                'anOption' => 3,
-            ),
-        );
-        $this->options->setFormCaptchaOptions($expected);
-        $this->assertEquals($expected, $this->options->getFormCaptchaOptions());
-    }
-
-    /**
-     * @covers ZfcUser\Options\ModuleOptions::getFormCaptchaOptions
-     */
-    public function testGetFormCaptchaOptions()
-    {
-        $expected = array(
-            'class'   => 'figlet',
-            'options' => array(
-                'wordLen'    => 5,
-                'expiration' => 300,
-                'timeout'    => 300,
-            ),
-        );
-        $this->assertEquals($expected, $this->options->getFormCaptchaOptions());
-    }
 }