Feature: Implemented batch for better management of large generations

Author: pix-art

Entity/SmartCode.php

@@ -85,10 +85,17 @@ class SmartCode implements SmartCodeInterface
      */
     protected $createdAt;
 
+    /**
+     * @ORM\Column(type="string", length=255)
+     *
+     * @var string
+     */
+    protected $batch;
+
     /**
      * @ORM\ManyToMany(targetEntity="Intracto\SmartCodeBundle\Entity\SubjectInterface", mappedBy="smartCodes", fetch="EXTRA_LAZY")
      **/
-    private $subjects;
+    protected $subjects;
 
     public function __construct(PayloadInterface $payload)
     {
@@ -257,6 +264,22 @@ public function setSubjects($subjects)
         $this->subjects = $subjects;
     }
 
+    /**
+     * @return string
+     */
+    public function getBatch()
+    {
+        return $this->batch;
+    }
+
+    /**
+     * @param string $batch
+     */
+    public function setBatch($batch)
+    {
+        $this->batch = $batch;
+    }
+
     /**
      * {@inheritdoc}
      */

Generator/SmartCodeGenerator.php

@@ -5,6 +5,7 @@
 use Doctrine\ORM\EntityManagerInterface;
 use Intracto\SmartCodeBundle\Entity\SmartCode;
 use Intracto\SmartCodeBundle\Entity\PayloadInterface;
+use Symfony\Component\Config\Tests\Loader\Validator;
 
 /**
  * Default smart code generator.
@@ -36,6 +37,7 @@ public function generate(PayloadInterface $payload, SmartCodeOptions $options)
             $smartCode->setUsageLimit($options->getUsageLimit());
             $smartCode->setExpiresAt($options->getExpiresAt());
             $smartCode->setStartsAt($options->getStartsAt());
+            $smartCode->setBatch($options->getBatch());
 
             $codes[] = $smartCode;
             $this->manager->persist($smartCode);

Generator/SmartCodeOptions.php

@@ -2,18 +2,56 @@
 
 namespace Intracto\SmartCodeBundle\Generator;
 
+use Symfony\Component\Validator\Constraints as Assert;
+
 class SmartCodeOptions
 {
+    /**
+     * @Assert\NotBlank()
+     * @Assert\GreaterThan(value = 0)
+     * @Assert\Type(
+     *     type="numeric",
+     *     message="The value {{ value }} is not a valid {{ type }}."
+     * )
+     */
     protected $amount;
+
+    /**
+     * @Assert\NotBlank()
+     * @Assert\Length(
+     *      max = 255,
+     *      maxMessage = "The title cannot be longer than {{ limit }} characters"
+     * )
+     */
+    protected $batch;
+
+    /**
+     * @Assert\NotBlank()
+     * @Assert\GreaterThan(value = 0)
+     * @Assert\Type(
+     *     type="numeric",
+     *     message="The value {{ value }} is not a valid {{ type }}."
+     * )
+     */
     protected $usageLimit;
+
+    /**
+     * @Assert\DateTime()
+     */
     protected $expiresAt;
+
+    /**
+     * @Assert\DateTime()
+     */
     protected $startsAt;
 
     public function __construct()
     {
+        $now = new \DateTime();
         $this->amount = 1;
         $this->usageLimit = 1;
-        $this->startsAt = new \DateTime();
+        $this->startsAt = $now;
+        $this->batch = $now->format('d-m-Y H:i:s');
     }
 
     public function getAmount()
@@ -63,4 +101,14 @@ public function setStartsAt($startsAt)
 
         return $this;
     }
+
+    public function getBatch()
+    {
+        return $this->batch;
+    }
+
+    public function setBatch($batch)
+    {
+        $this->batch = $batch;
+    }
 }

README.md

@@ -86,6 +86,7 @@ containing all your options.
         protected $usageLimit;
         protected $expiresAt;
         protected $startsAt;
+        protected $batch;
         
         ...
     }
@@ -95,6 +96,7 @@ containing all your options.
 - **UsageLimit**: The amount of times a smart code can be used.
 - **ExpiresAt**: The expiry date for a smart code.
 - **StartsAt**: The date a smart code can start being used.
+- **Batch**: A name or description you want to give the current generation.
 
 The last thing you would probably want to do is to be able to use these smart codes you just generated.
 This is possible via the SmartCodeAction service, which you can also overwrite by implementing the SmartCodeActionInterface.

Repository/SmartCodeRepository.php

@@ -7,32 +7,32 @@
 
 class SmartCodeRepository extends EntityRepository
 {
-    public function findAllCreationDatesForPayload(PayloadInterface $payload)
+    public function findAllBatchesForPayload(PayloadInterface $payload)
     {
         return $this->getEntityManager()
             ->createQuery(
-                'SELECT sc.createdAt, sc.usageLimit, sc.startsAt, sc.expiresAt, count(sc.id) as total
+                'SELECT sc.batch, sc.createdAt, sc.usageLimit, sc.startsAt, sc.expiresAt, count(sc.id) as total
                  FROM SmartCodeBundle:SmartCode sc
                  WHERE sc.payload = :payload
-                 GROUP BY sc.createdAt
+                 GROUP BY sc.batch
                  ORDER BY sc.id ASC'
             )
             ->setParameter('payload', $payload)
             ->getResult();
     }
 
-    public function findAllByCreationDate(\DateTime $creationDate, PayloadInterface $payload)
+    public function findAllByBatch($batch, PayloadInterface $payload)
     {
         return $this->getEntityManager()
             ->createQuery(
                 'SELECT sc
                  FROM SmartCodeBundle:SmartCode sc
-                 WHERE sc.createdAt = :creationDate
+                 WHERE sc.batch = :batch
                  AND sc.payload = :payload
                  ORDER BY sc.id ASC'
             )
             ->setParameter('payload', $payload)
-            ->setParameter('creationDate', $creationDate)
+            ->setParameter('batch', $batch)
             ->getResult();
     }
 }

Tests/Generator/SmartCodeOptionsTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Intracto\SmartCodeBundle\Tests\Generator;
+
+use Intracto\SmartCodeBundle\Generator\SmartCodeOptions;
+use Intracto\SmartCodeBundle\Tests\BaseTest;
+use Symfony\Component\Validator\Validation;
+
+class SmartCodeOptionsTest extends BaseTest
+{
+    private $validator;
+    
+    public function setUp()
+    {
+
+        $this->validator = Validation::createValidatorBuilder()
+                                    ->enableAnnotationMapping()
+                                    ->getValidator();
+    }
+
+    public function testSmartCodeOptionsCorrect()
+    {
+        $options = new SmartCodeOptions();
+        $options->setAmount(500);
+        $options->setBatch("Test batch");
+
+        $violations = $this->validator->validate($options);
+
+        $this->assertCount(0, $violations);
+    }
+
+    public function testSmartCodeOptionsFailed()
+    {
+        $options = new SmartCodeOptions();
+        $options->setAmount(-1);
+        $options->setBatch("Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.");
+        $options->setUsageLimit(0);
+        $options->setExpiresAt("Test failure");
+
+        $violations = $this->validator->validate($options);
+
+        $this->assertCount(4, $violations);
+    }
+}

Tests/bootstrap.php

@@ -0,0 +1,4 @@
+<?php
+include __DIR__ . '/../vendor/autoload.php';
+
+\Doctrine\Common\Annotations\AnnotationRegistry::registerLoader('class_exists');

composer.json

@@ -15,7 +15,8 @@
     "require": {
         "php":                             ">=5.3.9",        
         "doctrine/orm":                    "~2.2",
-        "symfony/framework-bundle":        "~2.1"
+        "symfony/framework-bundle":        "~2.3",
+        "symfony/validator":               "~2.3"
     },
 
     "config": {

phpunit.xml.dist

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<phpunit bootstrap="./vendor/autoload.php">
+<phpunit bootstrap="./Tests/bootstrap.php">
 
     <testsuites>
         <testsuite name="SmartCodeTestSuite">