Merge pull request #22 from 2amigos/master

master-->dev

.gitignore

@@ -13,3 +13,4 @@ index
 .composer.lock
 .phpunit.cache
 composer.lock
+PHP_CodeSniffer

README.md

@@ -1,7 +1,10 @@
 # Mailer 
-[![Build Status](https://img.shields.io/travis/2amigos/mailer-library/master.svg?style=flat-square)](https://travis-ci.org/2amigos/mailer-library)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/2amigos/mailer-library/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/2amigos/mailer-library/?branch=master)
-[![Code Coverage](https://scrutinizer-ci.com/g/2amigos/mailer-library/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/2amigos/mailer-library/?branch=master)
+[![tests](https://github.com/2amigos/mailer-library/actions/workflows/ci.yml/badge.svg)](https://github.com/2amigos/mailer-library/actions/workflows/ci.yml)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d0e8d6e968944592a95a0911d8f178ff)](https://app.codacy.com/gh/2amigos/mailer-library/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/d0e8d6e968944592a95a0911d8f178ff)](https://app.codacy.com/gh/2amigos/mailer-library/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
+[![Latest Stable Version](http://poser.pugx.org/2amigos/mailer/v)](https://packagist.org/packages/2amigos/mailer)
+[![Total Downloads](http://poser.pugx.org/2amigos/mailer/downloads)](https://packagist.org/packages/2amigos/mailer)
+[![PHP Version Require](http://poser.pugx.org/2amigos/mailer/require/php)](https://packagist.org/packages/2amigos/mailer)
 
 Many times we face a requirement to implement queue mail functionality in our projects. There are queue and  
 mailing libraries, but there seemed to be none that could actually suit our needs and moreover, we always had to sync their 

src/Builder/Buildable.php

@@ -20,5 +20,5 @@ protected static function getConfig()
      * @param $config
      * @return void
      */
-    public abstract static function make($config = null);
+    abstract public static function make($config = null);
 }

src/Builder/MailJobBuilder.php

@@ -24,7 +24,7 @@ public static function make($jobAttributes = null, ?string $broker = null): Mail
         $config = self::getConfig();
         $messageBroker = $broker ?? $config['config']['message_broker'];
 
-        switch($messageBroker) {
+        switch ($messageBroker) {
             case MessageBrokerEnum::BROKER_REDIS:
                 return new RedisMailJob($jobAttributes);
             case MessageBrokerEnum::BROKER_SQS:
@@ -35,7 +35,8 @@ public static function make($jobAttributes = null, ?string $broker = null): Mail
                 return new PdoMailJob($jobAttributes);
             case MessageBrokerEnum::BROKER_RABBITMQ:
                 return new RabbitMqJob($jobAttributes);
-            default: throw new UndefinedMessageBrokerException();
+            default:
+                throw new UndefinedMessageBrokerException();
         }
     }
 }

src/Builder/QueueBuilder.php

@@ -45,7 +45,7 @@ protected static function getBrokerAdapter($messageBroker)
         $config = self::getConfig();
         $connectionValues = $config['brokers'][$messageBroker] ?? [];
 
-        switch($messageBroker) {
+        switch ($messageBroker) {
             case MessageBrokerEnum::BROKER_REDIS:
                 return new RedisQueueStoreAdapter(
                     new RedisQueueStoreConnection($connectionValues)
@@ -66,7 +66,8 @@ protected static function getBrokerAdapter($messageBroker)
                 return new RabbitMqQueueStoreAdapter(
                     new RabbitMqQueueConnection($connectionValues)
                 );
-            default: throw new UndefinedMessageBrokerException();
+            default:
+                throw new UndefinedMessageBrokerException();
         }
     }
 }

src/Event/Event.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Da\Mailer\Event;
 
 use Da\Mailer\Exception\InvalidCallbackArgumentException;
@@ -9,16 +10,15 @@ class Event
      * @var object the class firing the event.
      */
     public $owner;
-    /**
+/**
      * @var array the collected arguments passed to the event
      */
     private $data;
-    /**
+/**
      * @var callable
      */
     private $handler;
-
-    /**
+/**
      * Callback constructor.
      *
      * @param callable $handler
@@ -37,7 +37,6 @@ public function __construct($handler)
     public function __invoke()
     {
         $this->data = func_get_args();
-
         return call_user_func($this->handler, $this);
     }
 

src/Event/EventHandlerTrait.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Da\Mailer\Event;
 
 trait EventHandlerTrait
@@ -7,8 +8,7 @@ trait EventHandlerTrait
      * @var array stack of events attached to the manager
      */
     protected $events = [];
-
-    /**
+/**
      * Adds an Event instance to the stack based on the name.
      *
      * @param string $name the identifier of the stack

src/Exception/InvalidCallException.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Da\Mailer\Exception;
 
 use BadMethodCallException;

src/Exception/InvalidCallbackArgumentException.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Da\Mailer\Exception;
 
 use InvalidArgumentException;

src/Exception/InvalidTransportTypeArgumentException.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Da\Mailer\Exception;
 
 use InvalidArgumentException;

src/Exception/UndefinedMessageBrokerException.php

@@ -6,5 +6,4 @@
 
 class UndefinedMessageBrokerException extends Exception
 {
-
 }

src/Exception/UnknownPropertyException.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Da\Mailer\Exception;
 
 use Exception;

src/Helper/ArrayHelper.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Da\Mailer\Helper;
 
 use Closure;
@@ -96,7 +97,6 @@ public static function remove(&$array, $key, $default = null)
         if (is_array($array) && (isset($array[$key]) || array_key_exists($key, $array))) {
             $value = $array[$key];
             unset($array[$key]);
-
             return $value;
         }
 

src/Helper/PhpViewFileHelper.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Da\Mailer\Helper;
 
 final class PhpViewFileHelper
@@ -20,7 +21,6 @@ public static function render($file, array $params = [])
         ob_implicit_flush(false);
         extract($params, EXTR_OVERWRITE);
         require $file;
-
         return ob_get_clean();
     }
 }

src/Helper/RecipientsHelper.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Da\Mailer\Helper;
 
 class RecipientsHelper

src/Mailer.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Da\Mailer;
 
 use Da\Mailer\Builder\MessageBuilder;
@@ -14,12 +15,11 @@ class Mailer
      * @var TransportInterface|null the transport used to send emails.
      */
     private $transport = null;
-    /**
+/**
      * @var bool
      */
     private $logging = true;
-
-    /**
+/**
      * Constructor.
      *
      * @param TransportInterface $transport the transport to use for sending emails.
@@ -103,7 +103,6 @@ public function setTransport(TransportInterface $transport)
     public function send(MailMessage $message, array $views = [], array $data = []): ?SentMessage
     {
         $message = MessageBuilder::make($message);
-
         return $this->getTransportInstance()->send($message);
     }
 
@@ -121,9 +120,7 @@ public static function fromMailMessage(MailMessage $mailMessage)
             'port' => $mailMessage->port,
             'options' => $mailMessage->transportOptions,
         ];
-
         $factory = TransportFactory::create($options, $mailMessage->transportType);
-
         return new Mailer($factory->create());
     }
 }

src/Model/AbstractMailObject.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Da\Mailer\Model;
 
 use Da\Mailer\Exception\InvalidCallException;

src/Model/MailJob.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Da\Mailer\Model;
 
 use Da\Mailer\Queue\Backend\MailJobInterface;
@@ -9,22 +10,21 @@ class MailJob extends AbstractMailObject implements MailJobInterface
      * @var mixed
      */
     private $id;
-    /**
+/**
      * @var MailMessage|string
      */
     private $message;
-    /**
+/**
      * @var int number of attempts. Every time a mail fails to be sent, the number of attempts could be incremented.
      *
      * @see `incrementAttempt()`
      */
     private $attempt = 0;
-    /**
+/**
      * @var bool whether the job has been completed
      */
     private $completed = false;
-
-    /**
+/**
      * {@inheritdoc}
      */
     public function __construct(array $config = [])