JobApis\JobsToMail\Jobs\SearchAndNotifyUser

Complexity

Total Complexity

9

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	handle()	0	20	2
A	getJobsFromCollections()	0	19	2
A	logErrorsFromCollection()	0	8	3
A	sortJobs()	0	13	1

<?php namespace JobApis\JobsToMail\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Queue\SerializesModels;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Support\Facades\Log;
use JobApis\Jobs\Client\Collection;
use JobApis\Jobs\Client\JobsMulti;
use JobApis\JobsToMail\Models\Search;
use JobApis\JobsToMail\Notifications\JobsCollected;

class SearchAndNotifyUser implements ShouldQueue
{
    use InteractsWithQueue, Queueable, SerializesModels;

    /**
     * @var Search search to conduct
     */
    protected $search;

    /**
     * The maximum number of jobs to return
     */
    const MAX_JOBS = 50;

    /**
     * The maximum number of jobs from each provider
     */
    const MAX_JOBS_FROM_PROVIDER = 10;

    /**
     * The maximum age of a job to be included
     */
    const MAX_DAYS_OLD = 14;

    /**
     * Create a new job instance.
     */
    public function __construct(Search $search)
    {
        $this->search = $search;
    }

    /**
     * Collect and sort jobs from multiple APIs using the JobsMulti client.
     *
     * @param JobsMulti $jobsClient
     *
     * @return array
     */
    public function handle(JobsMulti $jobsClient)
    {
        // Collect jobs based on the Search keyword and location
        $jobsByProvider = $jobsClient->setKeyword($this->search->keyword)
            ->setLocation($this->search->location)
            ->setPage(1, self::MAX_JOBS_FROM_PROVIDER)
            ->getAllJobs();

        // Sort jobs into one array
        $jobs = $this->getJobsFromCollections($jobsByProvider);
        $jobs = $this->sortJobs($jobs);

        // Trigger notification to user
        if ($jobs) {

The expression $jobs of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            $this->search->user->notify(new JobsCollected($jobs, $this->search));
        } else {
            Log::info("No jobs found for search {$this->search->id}");
        }
        return $jobs;
    }

    /**
     * Convert the array of collections to one large array
     *
     * @param array $collectionsArray
     *
     * @return array
     */
    protected function getJobsFromCollections($collectionsArray = [])
    {
        $jobs = [];
        array_walk_recursive(
            $collectionsArray,
            function (Collection $collection) use (&$jobs) {
                $this->logErrorsFromCollection($collection);
                $jobListings = array_slice(
                    $collection->all(),
                    0,
                    self::MAX_JOBS_FROM_PROVIDER
                );
                foreach ($jobListings as $jobListing) {
                    $jobs[] = $jobListing;
                }
            }
        );
        return $jobs;
    }

    /**
     * Logs all the errors attached to a collection
     *
     * @param array $jobsByProvider

There is no parameter named $jobsByProvider. Was it maybe removed?

     *
     * @return void
     */
    protected function logErrorsFromCollection(Collection $collection)
    {
        if ($collection->getErrors()) {
            foreach ($collection->getErrors() as $error) {
                Log::error($error);
            }
        }
    }

    /**
     * Sort jobs by date posted, desc
     *
     * @param array $jobs
     *
     * @return array
     */
    protected function sortJobs($jobs = [])
    {
        // Sort by date
        usort($jobs, function ($item1, $item2) {
            return $item2->datePosted <=> $item1->datePosted;
        });
        // Filter any older than max age
        $jobs = array_filter($jobs, function ($job) {
            return $job->datePosted > new \DateTime(self::MAX_DAYS_OLD.' days ago');
        });
        // Truncate to the max number of results
        return array_slice($jobs, 0, self::MAX_JOBS);
    }
}