Add Interfaces

Author: SimpleCorey

src/QrCodeGenerator.php src/BaconQrCodeGenerator.phpsrc/QrCodeGenerator.php renamed to src/BaconQrCodeGenerator.php

@@ -19,7 +19,7 @@
 use BaconQrCode\Encoder\Encoder;
 use BaconQrCode\Common\ErrorCorrectionLevel;
 
-class QrCodeGenerator {
+class BaconQrCodeGenerator implements QrCodeInterface {
 
     /**
      * Holds the BaconQrCode Writer Object

src/QrCodeInterface.php

@@ -0,0 +1,64 @@
+<?php namespace SimpleSoftwareIO\QrCode;
+
+interface QrCodeInterface {
+    /**
+     * Generates a QrCode
+     *
+     * @param string $text The text to be converted into a QrCode
+     * @param null|string $filename The filename and path to save the QrCode file
+     * @return string|void Returns a QrCode string depending on the format, or saves to a file.
+     */
+    public function generate($text, $filename = null);
+
+    /**
+     * Switches the format of the outputted QrCode or defaults to SVG
+     *
+     * @param string $format
+     * @return $this
+     */
+    public function format($format);
+
+    /**
+     * Changes the size of the QrCode
+     *
+     * @param int $pixels The size of the QrCode in pixels
+     * @return $this
+     */
+    public function size($pixels);
+
+    /**
+     * Changes the foreground color of a QrCode
+     *
+     * @param int $red
+     * @param int $green
+     * @param int $blue
+     * @return $this
+     */
+    public function color($red, $green, $blue);
+
+    /**
+     * Changes the background color of a QrCode
+     *
+     * @param int $red
+     * @param int $green
+     * @param int $blue
+     * @return $this
+     */
+    public function backgroundColor($red, $green, $blue);
+
+    /**
+     * Changes the error correction level of a QrCode
+     *
+     * @param string $level Desired error correction level.  L = 7% M = 15% Q = 25% H = 30%
+     * @return $this
+     */
+    public function errorCorrection($level);
+
+    /**
+     * Creates a margin around the QrCode
+     *
+     * @param int $margin The desired margin in pixels around the QrCode
+     * @return $this
+     */
+    public function margin($margin);
+}

src/QrCodeServiceProvider.php

@@ -26,7 +26,10 @@ class QrCodeServiceProvider extends ServiceProvider {
 	 */
 	public function register()
 	{
-		$this->app->bindShared('qrcode', function() { return new QrCodeGenerator; });
+		$this->app->bindShared('qrcode', function()
+        {
+            return new BaconQrCodeGenerator;
+        });
 	}
 
 	/**

tests/QrCodeGeneratorTest.php tests/BaconQrCodeGeneratorTest.phptests/QrCodeGeneratorTest.php renamed to tests/BaconQrCodeGeneratorTest.php

@@ -1,8 +1,8 @@
 <?php
 use Mockery as m;
-use SimpleSoftwareIO\QrCode\QrCodeGenerator;
+use SimpleSoftwareIO\QrCode\BaconQrCodeGenerator;
 
-class QrCodeGeneratorTest extends \PHPUnit_Framework_TestCase {
+class BaconQrCodeGeneratorTest extends \PHPUnit_Framework_TestCase {
 
     public function tearDown()
     {
@@ -13,6 +13,7 @@ public function setUp()
     {
         $this->writer = m::mock('\BaconQrCode\Writer');
         $this->format = m::mock('\BaconQrCode\Renderer\Image\RendererInterface');
+        $this->qrCode = new BaconQrCodeGenerator($this->writer, $this->format);
     }
 
     public function testSetMargin()
@@ -25,7 +26,7 @@ public function testSetMargin()
             ->once()
             ->andReturn($this->format);
 
-        $qrCode = new QrCodeGenerator($this->writer, $this->format);
+        $qrCode = new BaconQrCodeGenerator($this->writer, $this->format);
         $qrCode->margin(50);
     }
 
@@ -38,8 +39,7 @@ public function testSetBackgroundColor()
             ->once()
             ->andReturn($this->format);
 
-        $qrCode = new QrCodeGenerator($this->writer, $this->format);
-        $qrCode->backgroundColor(255,255,255);
+        $this->qrCode->backgroundColor(255,255,255);
     }
 
     public function testSetColor()
@@ -51,8 +51,7 @@ public function testSetColor()
             ->once()
             ->andReturn($this->format);
 
-        $qrCode = new QrCodeGenerator($this->writer, $this->format);
-        $qrCode->color(255,255,255);
+        $this->qrCode->color(255,255,255);
     }
 
     public function testSetSize()
@@ -68,8 +67,7 @@ public function testSetSize()
             ->twice()
             ->andReturn($this->format);
 
-        $qrCode = new QrCodeGenerator($this->writer, $this->format);
-        $qrCode->size(50);
+        $this->qrCode->size(50);
     }
 
     public function testSetFormatPng()
@@ -78,8 +76,7 @@ public function testSetFormatPng()
             ->with('BaconQrCode\Renderer\Image\Png')
             ->once();
 
-        $qrCode = new QrCodeGenerator($this->writer, $this->format);
-        $qrCode->format('png');
+        $this->qrCode->format('png');
     }
 
     public function testSetFormatEps()
@@ -88,8 +85,7 @@ public function testSetFormatEps()
             ->with('BaconQrCode\Renderer\Image\Eps')
             ->once();
 
-        $qrCode = new QrCodeGenerator($this->writer, $this->format);
-        $qrCode->format('eps');
+        $this->qrCode->format('eps');
     }
 
     public function testSetFormatSvg()
@@ -98,8 +94,7 @@ public function testSetFormatSvg()
             ->with('BaconQrCode\Renderer\Image\Svg')
             ->once();
 
-        $qrCode = new QrCodeGenerator($this->writer, $this->format);
-        $qrCode->format('svg');
+        $this->qrCode->format('svg');
     }
 
     public function testSetFormatUnknown()
@@ -108,8 +103,7 @@ public function testSetFormatUnknown()
             ->with('BaconQrCode\Renderer\Image\Svg')
             ->once();
 
-        $qrCode = new QrCodeGenerator($this->writer, $this->format);
-        $qrCode->format('random');
+        $this->qrCode->format('random');
     }
 
     public function testGenerate()
@@ -118,8 +112,7 @@ public function testGenerate()
             ->with('qrCode', m::type('string'), m::type('int'))
             ->once();
 
-        $qrCode = new QrCodeGenerator($this->writer, $this->format);
-        $qrCode->generate('qrCode');
+        $this->qrCode->generate('qrCode');
     }
 
     public function testGenerateFile()
@@ -128,8 +121,7 @@ public function testGenerateFile()
             ->with('qrCode', 'foo.txt', m::type('string'), m::type('int'))
             ->once();
 
-        $qrCode = new QrCodeGenerator($this->writer, $this->format);
-        $qrCode->generate('qrCode', 'foo.txt');
+        $this->qrCode->generate('qrCode', 'foo.txt');
     }
 }