SearchAndNotifyUser::logErrorsFromCollection() - Code Metrics - Inspection of "Searches" - jobapis/jobs-to-mail - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#11)

by Karl

created 2016-10-15 14:22 UTC

SearchAndNotifyUser::logErrorsFromCollection() A

↳ Parent: SearchAndNotifyUser

Complexity

Conditions	3
Paths	3

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
ccs	5
cts	5
cp	1
cc	3
eloc	4
nc	3
nop	1
crap	3

<?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) {

            $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
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @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);
    }
}


1		<?php namespace JobApis\JobsToMail\Jobs;
2
3		use Illuminate\Bus\Queueable;
4		use Illuminate\Queue\SerializesModels;
5		use Illuminate\Queue\InteractsWithQueue;
6		use Illuminate\Contracts\Queue\ShouldQueue;
7		use Illuminate\Support\Facades\Log;
8		use JobApis\Jobs\Client\Collection;
9		use JobApis\Jobs\Client\JobsMulti;
10		use JobApis\JobsToMail\Models\Search;
11		use JobApis\JobsToMail\Notifications\JobsCollected;
12
13		class SearchAndNotifyUser implements ShouldQueue
14		{
15		use InteractsWithQueue, Queueable, SerializesModels;
16
17		/**
18		* @var Search search to conduct
19		*/
20		protected $search;
21
22		/**
23		* The maximum number of jobs to return
24		*/
25		const MAX_JOBS = 50;
26
27		/**
28		* The maximum number of jobs from each provider
29		*/
30		const MAX_JOBS_FROM_PROVIDER = 10;
31
32		/**
33		* The maximum age of a job to be included
34		*/
35		const MAX_DAYS_OLD = 14;
36
37		/**
38		* Create a new job instance.
39		*/
40	6	public function __construct(Search $search)
41		{
42	6	$this->search = $search;
43	6	}
44
45		/**
46		* Collect and sort jobs from multiple APIs using the JobsMulti client.
47		*
48		* @param JobsMulti $jobsClient
49		*
50		* @return array
51		*/
52	6	public function handle(JobsMulti $jobsClient)
53		{
54		// Collect jobs based on the Search keyword and location
55	6	$jobsByProvider = $jobsClient->setKeyword($this->search->keyword)
56	6	->setLocation($this->search->location)
57	6	->setPage(1, self::MAX_JOBS_FROM_PROVIDER)
58	6	->getAllJobs();
59
60		// Sort jobs into one array
61	6	$jobs = $this->getJobsFromCollections($jobsByProvider);
62	6	$jobs = $this->sortJobs($jobs);
63
64		// Trigger notification to user
65	6	if ($jobs) {
		0 ignored issues – show Bug Best Practice introduced 2016-09-25 08:43 UTC by Report Bug Copy Issue Report 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 check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
66	5	$this->search->user->notify(new JobsCollected($jobs, $this->search));
67		} else {
68	1	Log::info("No jobs found for search {$this->search->id}");
69		}
70	6	return $jobs;
71		}
72
73		/**
74		* Convert the array of collections to one large array
75		*
76		* @param array $collectionsArray
77		*
78		* @return array
79		*/
80	6	protected function getJobsFromCollections($collectionsArray = [])
81		{
82	6	$jobs = [];
83	6	array_walk_recursive(
84		$collectionsArray,
85		function (Collection $collection) use (&$jobs) {
86	6	$this->logErrorsFromCollection($collection);
87	6	$jobListings = array_slice(
88	6	$collection->all(),
89	6	0,
90	6	self::MAX_JOBS_FROM_PROVIDER
91		);
92	6	foreach ($jobListings as $jobListing) {
93	5	$jobs[] = $jobListing;
94		}
95	6	}
96		);
97	6	return $jobs;
98		}
99
100		/**
101		* Logs all the errors attached to a collection
102		*
103		* @param array $jobsByProvider
		0 ignored issues – show Bug introduced 2016-10-14 18:08 UTC by Report Bug Copy Issue Report There is no parameter named `$jobsByProvider`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
104		*
105		* @return void
106		*/
107	6	protected function logErrorsFromCollection(Collection $collection)
108		{
109	6	if ($collection->getErrors()) {
110	1	foreach ($collection->getErrors() as $error) {
111	1	Log::error($error);
112		}
113		}
114	6	}
115
116		/**
117		* Sort jobs by date posted, desc
118		*
119		* @param array $jobs
120		*
121		* @return array
122		*/
123	6	protected function sortJobs($jobs = [])
124		{
125		// Sort by date
126		usort($jobs, function ($item1, $item2) {
127	5	return $item2->datePosted <=> $item1->datePosted;
128	6	});
129		// Filter any older than max age
130	6	$jobs = array_filter($jobs, function ($job) {
131	5	return $job->datePosted > new \DateTime(self::MAX_DAYS_OLD.' days ago');
132	6	});
133		// Truncate to the max number of results
134	6	return array_slice($jobs, 0, self::MAX_JOBS);
135		}
136		}
137

jobapis / jobs-to-mail

Pull Request — master (#11)

SearchAndNotifyUser::logErrorsFromCollection() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like