new module Sequence added

Author: davert

src/Codeception/Module/Sequence.php

@@ -0,0 +1,66 @@
+<?php
+namespace Codeception\Module;
+use Codeception\Exception\Module;
+use Codeception\TestCase;
+
+/**
+ * Sequence solves data cleanup issue in alternative way.
+ * Instead cleaning up the database between tests,
+ * you can use generated unique names, that should not conflict.
+ * When you create article on a site, for instance, you can assign it a unique name and then check it.
+ *
+ * This module has no actions, but introduces a function `sq` for generating unique sequences.
+ *
+ * ### Usage
+ *
+ * Function `sq` generates sequence, the only parameter it takes, is id.
+ * You can get back to previously generated sequence using that id:
+ *
+ * ``` php
+ * <?php
+ * 'post'.sq(1); // post_521fbc63021eb
+ * 'post'.sq(2); // post_521fbc6302266
+ * 'post'.sq(1); // post_521fbc63021eb
+ * ?>
+ * ```
+ *
+ * Example:
+ *
+ * ``` php
+ * <?php
+ * $I->wantTo('create article');
+ * $I->click('New Article');
+ * $I->fillField('Title', 'Article'.sq('name'));
+ * $I->fillField('Body', 'Demo article with Lorem Ipsum');
+ * $I->click('save');
+ * $I->see('Article'.sq('name') ,'#articles')
+ * ?>
+ * ```
+ *
+ * Populating Database:
+ *
+ * ``` php
+ * <?php
+ *
+ * for ($i = 0; $i<10; $i++) {
+ *      $I->haveInDatabase('users', array('login' => 'user'.sq($i), 'email' => 'user'.sq($i).'@email.com');
+ * }
+ * ?>
+ * ```
+ *
+ */
+class Sequence {
+
+    static $hash = array();
+
+    public function _after(TestCase $t)
+    {
+        self::$hash = array();
+    }
+}
+
+if (!function_exists('sq')) {
+    require_once __DIR__.'/../Util/sq.php';
+} else {
+    throw new Module('Codeception\Module\Sequence', "function 'sq' already defiend");
+}

src/Codeception/Util/sq.php

@@ -0,0 +1,10 @@
+<?php
+use \Codeception\Module\Sequence;
+
+function sq($id = null)
+{
+    if ($id and isset(Sequence::$hash[$id])) return Sequence::$hash[$id];
+    $sequence = '_'.uniqid();
+    if ($id) Sequence::$hash[$id] = $sequence;
+    return $sequence;
+}

tests/unit/Codeception/Module/SequenceTest.php

@@ -0,0 +1,17 @@
+<?php
+
+class SequenceTest extends Codeception\TestCase\Test
+{
+    // tests
+    public function testSequences()
+    {
+        $module = new \Codeception\Module\Sequence();
+        $this->assertNotEquals(sq(), sq());
+        $this->assertNotEquals(sq(1), sq(2));
+        $this->assertEquals(sq(1), sq(1));
+        $old = sq(1);
+        $module->_after($this);
+        $this->assertNotEquals($old, sq(1));
+    }
+
+}