Add scenarios and tests

coderius · coderius · commit 1238b7d9a252 · 2020-08-24T22:06:34.000+03:00
diff --git a/src/UploadFileBehavior.php b/src/UploadFileBehavior.php
@@ -52,7 +52,9 @@
  *                    'uploadFileBehavior' => [
  *                        'class' => UploadFileBehavior::className(),
  *                        'nameOfAttributeStorage' => 'img_src',
- *                        'directories' => [
+                    
+                    
+ *                        'targets' => [
  *                            
  *                            [
  *                                'path' => function($attributes){
@@ -119,7 +121,7 @@ class UploadFileBehavior extends Behavior
      *
      * @var [string]
      */
-    public $newFileName;
+    public $newFileName = false;
 
     /**
      * Configuretion array for setting target paths to folders and uploading hendlers like in example:
@@ -137,8 +139,22 @@ class UploadFileBehavior extends Behavior
      *
      * @var [array]
      */
-    public $directories;
+    public $targets;
 
+
+    /**
+     * 'default' scenario set by default. 
+     * @var array the scenarios in which the behavior will be triggered
+     */
+    public $scenarios = [];
+
+    /**
+     * Flag for delete file with related item in db. Default set to true.
+     *
+     * @var boolean
+     */
+    public $deleteImageWithRecord = true;
+    
     /**
      * File instance populated by yii\web\UploadedFile::getInstance
      *
@@ -164,12 +180,16 @@ public function init()
             throw new NotSupportedException("Yii2-imagine extension is required to use the UploadImageBehavior");
         }
 
-        if ($this->directories === null) {
-            throw new InvalidConfigException('The "directories" property must be set.');
+        if ($this->targets == null || $this->targets == false || empty($this->targets)) {
+            throw new InvalidConfigException('The "targets" property must be set.');
         }
-        if (!is_array($this->directories)) {
-            throw new InvalidConfigException('The "directories" property must be an array.');
+        if (!is_array($this->targets)) {
+            throw new InvalidConfigException('The "targets" property must be an array.');
         }
+        if (empty($this->scenarios)) {
+            $this->scenarios[] = 'default';
+        }
+
     }
 
     /**
@@ -190,9 +210,10 @@ public function events()
     {
         return [
             ActiveRecord::EVENT_BEFORE_INSERT => 'loadFile',
-            ActiveRecord::EVENT_BEFORE_INSERT => 'loadFile',
+            ActiveRecord::EVENT_BEFORE_UPDATE => 'loadFile',
             ActiveRecord::EVENT_AFTER_INSERT => 'afterInsertHendler',
             ActiveRecord::EVENT_AFTER_UPDATE => 'afterUpdateHendler',
+            ActiveRecord::EVENT_AFTER_DELETE => 'afterDelete'
         ];
     }
 
@@ -232,6 +253,27 @@ public function afterUpdateHendler($event)
         $this->hendlersReducer(false);
     }          
     
+    /**
+     * Undocumented function
+     *
+     * @param [type] $event
+     * @return void
+     */
+    public function afterDelete($event)
+    {
+        if($this->deleteImageWithRecord){
+            foreach($this->targets as $target){
+                if ($target['path'] instanceof Closure || (is_array($target['path']) && is_callable($target['path']))) {
+                    $dirPath = $target['path']($this->owner->attributes);
+                }else{
+                    throw new InvalidCallException('Param `path` mast be instanceof Closure or callable method.');
+                }
+                FileHelper::removeDirectory($dirPath);
+            }    
+            
+        }
+    } 
+
 
     /**
      * Undocumented function
@@ -241,11 +283,11 @@ public function afterUpdateHendler($event)
      */
     protected function hendlersReducer($insert)
     {
-        if ($this->isFile())
+        if ($this->isFile() && $this->inScenario())
         {
-            foreach($this->directories as $dir){
-                if ($dir['path'] instanceof Closure || (is_array($dir['path']) && is_callable($dir['path']))) {
-                    $dirPath = $dir['path']($this->owner->attributes);
+            foreach($this->targets as $target){
+                if ($target['path'] instanceof Closure || (is_array($target['path']) && is_callable($target['path']))) {
+                    $dirPath = $target['path']($this->owner->attributes);
                 }else{
                     throw new InvalidCallException('Param `path` mast be instanceof Closure or callable method.');
                 }
@@ -257,8 +299,8 @@ protected function hendlersReducer($insert)
                 FileHelper::createDirectory($dirPath);
                 $newFilePath = $dirPath . $this->getNewFileName();
 
-                if ($dir['hendler'] instanceof Closure || (is_array($dir['hendler']) && is_callable($dir['hendler']))) {
-                    $dir['hendler']($this->getFileInstance()->tempName, $newFilePath);
+                if ($target['hendler'] instanceof Closure || (is_array($target['hendler']) && is_callable($target['hendler']))) {
+                    $target['hendler']($this->getFileInstance()->tempName, $newFilePath);
                 }else{
                     throw new InvalidCallException('Param `hendler` mast be instanceof Closure or callable method.');
                 }
@@ -314,4 +356,15 @@ protected function isFile()
         return  $this->getFileInstance() && $this->getFileInstance()->tempName;
     }
 
+    /**
+     * Detect if current model scenario in allowed by behavior
+     *
+     * @return void
+     */
+    protected function inScenario()
+    {
+        $model = $this->owner;
+        return in_array($model->scenario, $this->scenarios);
+    }
+
 }
diff --git a/tests/data/model/Article.php b/tests/data/model/Article.php
@@ -20,6 +20,10 @@
 class Article extends \yii\db\ActiveRecord
 {
     public $file;
+
+    const BIG_SIZE_DIR    = "/big/";
+    const MIDDLE_SIZE_DIR = "/middle/";
+    const SMALL_SIZE_DIR  = "/small/";
     
     /**
      * {@inheritdoc}
@@ -36,7 +40,7 @@ public function rules()
     {
         return [
             ['text', 'required'],
-            [['img_src'], 'safe'],
+            [['img_src', 'file'], 'safe'],
         ];
     }
 
@@ -45,12 +49,12 @@ public function behaviors()
         return [
             'uploadFileBehavior' => [
                 'class' => UploadFileBehavior::className(),
-                // 'nameOfAttributeStorage' => 'img_src',
-                'directories' => [
+                'nameOfAttributeStorage' => 'img_src',
+                'targets' => [
                     
                     [
                         'path' => function($attributes){
-                            return \Yii::getAlias('@uploadsPath/' . $attributes['id'] . '/big/');
+                            return \Yii::getAlias('@uploadsPath/' . $attributes['id'] . self::BIG_SIZE_DIR);
                         },
                         'hendler' => function($fileTempName, $newFilePath){
                             Image::thumbnail($fileTempName, 900, 900*2/3)
@@ -62,7 +66,7 @@ public function behaviors()
                     ],
                     [
                         'path' => function($attributes){
-                            return \Yii::getAlias('@uploadsPath/' . $attributes['id'] . '/middle/');
+                            return \Yii::getAlias('@uploadsPath/' . $attributes['id'] . self::MIDDLE_SIZE_DIR );
                         },
                         'hendler' => function($fileTempName, $newFilePath){
                             Image::thumbnail($fileTempName, 400, 400*2/3)
@@ -72,7 +76,7 @@ public function behaviors()
                     ],
                     [
                         'path' => function($attributes){
-                            return \Yii::getAlias('@portfoleoPhotosPath/' . $attributes['id'] . '/small/');
+                            return \Yii::getAlias('@uploadsPath/' . $attributes['id'] . self::SMALL_SIZE_DIR );
                         },
                         'hendler' => function($fileTempName, $newFilePath){
                             Image::thumbnail($fileTempName, 150, 150*2/3)
diff --git a/tests/unit/UploadFileBehaviorTest.php b/tests/unit/UploadFileBehaviorTest.php
@@ -8,47 +8,60 @@
 use tests\data\model;
 use tests\data\model\Article;
 use coderius\yii2UploadFileBehavior\UploadFileBehavior;
+use yii\helpers\FileHelper;
+use yii\base\InvalidConfigException;
 
 class UploadFileBehaviorTest extends \tests\TestCase
 {
   
    /**
-     * @inheritdoc
-     */
-    public static function setUpBeforeClass()
-    {
-        parent::setUpBeforeClass();
-
-        $_FILES = [
-            'User[image]' => [
-                'name' => 'test-image.jpg',
-                'type' => 'image/jpeg',
-                'size' => 74463,
-                'tmp_name' => __DIR__ . '/data/test-image.jpg',
-                'error' => 0,
-            ],
-        ];
-    }
+   * @inheritdoc
+   */
+  public static function setUpBeforeClass()
+  {
+      parent::setUpBeforeClass();
 
-  public function testGetFileInstance()
+      $_FILES = [
+          'Article[file]' => [
+              'name' => 'test-image.jpg',
+              'type' => 'image/jpeg',
+              'size' => 74463,
+              'tmp_name' => __DIR__ . '/../data/test-image.jpg',
+              'error' => 0,
+          ],
+      ];
+  }
+
+  /**
+   * Undocumented function
+   *
+   * @return void
+   */
+  public static function tearDownAfterClass()
   {
-      $file = UploadedFile::getInstanceByName('User[image]');
-      $this->assertTrue($file instanceof UploadedFile);
+      fwrite(STDOUT, __METHOD__ . "\n");
+      FileHelper::removeDirectory(Yii::getAlias('@uploadsPath'));
   }
 
   public function testIsFile()
   {
-      $file = UploadedFile::getInstanceByName('User[image]');
+      $file = UploadedFile::getInstanceByName('Article[file]');
       $this->assertTrue($file && $file->tempName);
   }
 
+  public function testGetFileInstance()
+  {
+      $file = UploadedFile::getInstanceByName('Article[file]');
+      $this->assertTrue($file instanceof UploadedFile);
+  }
+
   /**
   * @dataProvider additionProvider
   */
   public function testGetNewFileName($name, $filename, $time)
   {
       $newFileName = "name";
-      $file = UploadedFile::getInstanceByName('User[image]');
+      $file = UploadedFile::getInstanceByName('Article[file]');
       $baseName = $file->baseName;
       $ext = $file->extension;
         
@@ -58,7 +71,15 @@ public function testGetNewFileName($name, $filename, $time)
 
       $this->assertEquals($filename, $result);  
   }
-  
+
+  // /**
+  // * @dataProvider additionProvider
+  // */
+  // public static function testClasst($name, $filename, $time)
+  // {
+  //     fwrite(STDOUT, $filename . "\n");
+  // }
+
   public function additionProvider()
   {
       $time = time();
@@ -70,22 +91,80 @@ public function additionProvider()
       ];
   }
 
-  public function testUploadImageSaveTrue()
+  public function testUploadImageSaveRecord()
   {
     $article = new Article();
+    $article->text = 'some text';
+    $article->file = UploadedFile::getInstanceByName('Article[file]');
+    $res = $article->save();
+
+    $this->assertTrue($res);
+    $lastRecord = Article::findOne($article->id);
+
+    $this->assertTrue($lastRecord !== null);
+
     
-    // $data = [
-    //   'text' => 'some text',
-    //   'img_src' => UploadedFile::getInstanceByName('User[image]')
-    // ];
+  }
 
+  public function testUploadImageFindSavedFile()
+  {
+    $article = new Article();
     $article->text = 'some text';
-    $article->file = UploadedFile::getInstanceByName('User[image]');
+    $article->file = UploadedFile::getInstanceByName('Article[file]');
     $res = $article->save();
+    $path = Yii::getAlias('@uploadsPath/' . $article->id . '/' . Article::BIG_SIZE_DIR . '/' . $article->img_src);
+    
+    $this->assertTrue(is_file($path));
+  }
 
-    // $this->assertEquals($article->img_src, 'test-image.jpg'); 
-    $this->assertTrue($res);
+  /**
+  * @dataProvider directoriesProvider
+  */
+  public function testExceptionNotSetDirectoryConfigNotSet($targets, $ex, $mes)
+  {
+      $this->expectException($ex);
+      $this->expectExceptionMessage($mes);
+      $article = new Article();
+      $article->detachBehaviors();
+      $article->attachBehavior('myBehavior', [
+          'class' => UploadFileBehavior::className(),
+          'nameOfAttributeStorage' => 'img_src',
+          'targets' => $targets
+      ]);
   }
 
+  public function directoriesProvider()
+  {
+      $time = time();
+
+      return [
+          [null, InvalidConfigException::class, 'The "targets" property must be set.'],
+          [false,InvalidConfigException::class, 'The "targets" property must be set.'],
+          ['',   InvalidConfigException::class, 'The "targets" property must be set.'],
+          ['123',InvalidConfigException::class, 'The "targets" property must be an array.'],
+      ];
+  }
+
+  public function testDefaultDeleteImageWithRecord()
+  {
+      $article = new Article();
+      $article->text = 'some text';
+      $article->file = UploadedFile::getInstanceByName('Article[file]');
+      $res = $article->save();
+      $lastRecord = Article::findOne($article->id);
+      $path = Yii::getAlias('@uploadsPath/' . $article->id . '/' . Article::BIG_SIZE_DIR . '/' . $article->img_src);
+      $this->assertTrue(is_file($path));
+      $article->delete();
+      $this->assertTrue(!is_file($path));
+  }
+  
+  public function testDefaultBehavior()
+  {
+      $defaultScenario = 'default';
+      $article = new Article();
+      $behavior = $article->getBehavior('uploadFileBehavior');
+
+      $this->assertEquals($defaultScenario, $behavior->scenarios[0]);
+  }
 
 }
