XlsHandler::setProject() - Code Metrics - Inspection of "Misc: increment version & update changes doc" - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 91f8d9...64265e )

by Mohamed

created 2016-05-23 07:25 UTC

XlsHandler::setProject() A

↳ Parent: XlsHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/*
 * This file is part of the Tinyissue package.
 *
 * (c) Mohamed Alsharaf <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Tinyissue\Export\Project\Issue;

use Maatwebsite\Excel\Classes\LaravelExcelWorksheet;
use Maatwebsite\Excel\Writers\CellWriter;
use Tinyissue\Model\Project;
use Tinyissue\Services\Exporter;

/**
 * XlsHandler is an export class for exporting a project issues into a Xls or Xlsx file.
 *
 * @author Mohamed Alsharaf <[email protected]>
 */
class XlsHandler
{
    /**
     * Instance of the project.
     *
     * @var Project
     */
    protected $project;

    /**
     * Collection of project issues.
     *
     * @var Project\Issue[]
     */
    protected $issues;

    /**
     * Columns to export from the issues table.
     *
     * @var array
     */
    protected $columns = [
        'id'         => '',
        'title'      => '',
        'time_quote' => '',
        'created_at' => '',
        'updated_at' => '',
        'closed_at'  => '',
        'status'     => '',
    ];

    /**
     * Columns in the output file.
     *
     * @var array
     */
    protected $header = [
        'tinyissue.id',
        'tinyissue.title',
        'tinyissue.time_quote',
        'tinyissue.label_created',
        'tinyissue.updated',
        'tinyissue.label_closed',
        'tinyissue.status',
    ];

    /**
     * Set an instance of a project model.
     *
     * @param Project $project
     *
     * @return $this
     */
    public function setProject(Project $project)
    {
        $this->project = $project;

        return $this;
    }

    /**
     * @param Exporter $exporter
     *
     * @return void
     */
    public function handle(Exporter $exporter)
    {
        $params = $exporter->getParams();

        $this->setProject($exporter->getParams('route.project'));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $query = $this->project->issues()->select(array_keys($this->columns));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        // Filter issues
        $this->project->filterTitleOrBody($query, $params['keyword']);
        $this->project->filterAssignTo($query, $params['keyword']);
        $this->project->filterTitleOrBody($query, $params['keyword']);

        // Fetch issues
        $this->issues = $query->get();

        // Create CSV file
        $exporter->sheet($this->project->name, function (LaravelExcelWorksheet $sheet) {

            // Global sheet styles
            $this->globalStyle($sheet);

            // Title
            $sheet->mergeCells('A1:G1');
            $sheet->setHeight(1, 50);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $sheet->cell('A1', function (CellWriter $cell) {
                $this->sheetTitle($cell);
            });

            // Header
            $sheet->row(2, array_map('trans', $this->header));

            // Rows
            $index = 3;
            foreach ($this->issues as $issue) {
                $this->sheetRow($sheet, $index, $issue);
                ++$index;
            }
        });
    }

    /**
     * Setup sheet global styles.
     *
     * @param LaravelExcelWorksheet $sheet
     *
     * @return void
     */
    protected function globalStyle(LaravelExcelWorksheet $sheet)
    {
        // Font size & family
        $sheet->setFontSize(15);
        $sheet->setFontFamily('Calibri');
    }

    /**
     * Sheet title in the first row.
     *
     * @param CellWriter $cell
     *
     * @return void
     */
    public function sheetTitle(CellWriter $cell)
    {
        $cell->setFontWeight('bold');
        $cell->setBorder('none', 'none', 'none', 'thin');
        $title = trans('tinyissue.export_xls_title', ['name' => $this->project->name, 'count' => count($this->issues)]);
        $cell->setValue($title);
    }

    /**
     * Sheet data row.
     *
     * @param LaravelExcelWorksheet $sheet
     * @param int                   $index
     * @param Project\Issue         $issue
     *
     * @return void
     */
    protected function sheetRow(LaravelExcelWorksheet $sheet, $index, Project\Issue $issue)
    {
        // Setup row data
        array_walk($this->columns, function (&$column, $key, Project\Issue $issue) {
            $column = (string) $issue->$key;
            if ($key === 'status') {
                $column = (int) $issue->status === Project\Issue::STATUS_OPEN ? 'open' : 'closed';
                $column = trans('tinyissue.' . $column);
            }
        }, $issue);

        // Write row
        $sheet->row($index, $this->columns);

        // Format last cell
        $sheet->cell('G' . $index, function (CellWriter $cell) use ($issue) {
            $color = (int) $issue->status === Project\Issue::STATUS_CLOSED ? '#FF0000' : '#00FF00';
            $cell->setBackground($color);
        });
    }
}


1		<?php
2
3		/*
4		* This file is part of the Tinyissue package.
5		*
6		* (c) Mohamed Alsharaf <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Tinyissue\Export\Project\Issue;
13
14		use Maatwebsite\Excel\Classes\LaravelExcelWorksheet;
15		use Maatwebsite\Excel\Writers\CellWriter;
16		use Tinyissue\Model\Project;
17		use Tinyissue\Services\Exporter;
18
19		/**
20		* XlsHandler is an export class for exporting a project issues into a Xls or Xlsx file.
21		*
22		* @author Mohamed Alsharaf <[email protected]>
23		*/
24		class XlsHandler
25		{
26		/**
27		* Instance of the project.
28		*
29		* @var Project
30		*/
31		protected $project;
32
33		/**
34		* Collection of project issues.
35		*
36		* @var Project\Issue[]
37		*/
38		protected $issues;
39
40		/**
41		* Columns to export from the issues table.
42		*
43		* @var array
44		*/
45		protected $columns = [
46		'id' => '',
47		'title' => '',
48		'time_quote' => '',
49		'created_at' => '',
50		'updated_at' => '',
51		'closed_at' => '',
52		'status' => '',
53		];
54
55		/**
56		* Columns in the output file.
57		*
58		* @var array
59		*/
60		protected $header = [
61		'tinyissue.id',
62		'tinyissue.title',
63		'tinyissue.time_quote',
64		'tinyissue.label_created',
65		'tinyissue.updated',
66		'tinyissue.label_closed',
67		'tinyissue.status',
68		];
69
70		/**
71		* Set an instance of a project model.
72		*
73		* @param Project $project
74		*
75		* @return $this
76		*/
77	1	public function setProject(Project $project)
78		{
79	1	$this->project = $project;
80
81	1	return $this;
82		}
83
84		/**
85		* @param Exporter $exporter
86		*
87		* @return void
88		*/
89	1	public function handle(Exporter $exporter)
90		{
91	1	$params = $exporter->getParams();
92
93	1	$this->setProject($exporter->getParams('route.project'));
		0 ignored issues – show Documentation introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report `$exporter->getParams('route.project')` is of type `string\|object<Illuminate...se\Eloquent\Model>\|null`, but the function expects a `object<Tinyissue\Model\Project>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
94
95	1	$query = $this->project->issues()->select(array_keys($this->columns));
		0 ignored issues – show Bug introduced 2015-12-15 16:27 UTC by Report Bug Copy Issue Report It seems like `select()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
96
97		// Filter issues
98	1	$this->project->filterTitleOrBody($query, $params['keyword']);
99	1	$this->project->filterAssignTo($query, $params['keyword']);
100	1	$this->project->filterTitleOrBody($query, $params['keyword']);
101
102		// Fetch issues
103	1	$this->issues = $query->get();
104
105		// Create CSV file
106		$exporter->sheet($this->project->name, function (LaravelExcelWorksheet $sheet) {
107
108		// Global sheet styles
109	1	$this->globalStyle($sheet);
110
111		// Title
112	1	$sheet->mergeCells('A1:G1');
113	1	$sheet->setHeight(1, 50);
		1 ignored issue – show Documentation introduced 2016-02-06 09:03 UTC by Report Bug Copy Issue Report `50` is of type `integer`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
114		$sheet->cell('A1', function (CellWriter $cell) {
115	1	$this->sheetTitle($cell);
116	1	});
117
118		// Header
119	1	$sheet->row(2, array_map('trans', $this->header));
120
121		// Rows
122	1	$index = 3;
123	1	foreach ($this->issues as $issue) {
124	1	$this->sheetRow($sheet, $index, $issue);
125	1	++$index;
126		}
127	1	});
128	1	}
129
130		/**
131		* Setup sheet global styles.
132		*
133		* @param LaravelExcelWorksheet $sheet
134		*
135		* @return void
136		*/
137	1	protected function globalStyle(LaravelExcelWorksheet $sheet)
138		{
139		// Font size & family
140	1	$sheet->setFontSize(15);
141	1	$sheet->setFontFamily('Calibri');
142	1	}
143
144		/**
145		* Sheet title in the first row.
146		*
147		* @param CellWriter $cell
148		*
149		* @return void
150		*/
151	1	public function sheetTitle(CellWriter $cell)
152		{
153	1	$cell->setFontWeight('bold');
154	1	$cell->setBorder('none', 'none', 'none', 'thin');
155	1	$title = trans('tinyissue.export_xls_title', ['name' => $this->project->name, 'count' => count($this->issues)]);
156	1	$cell->setValue($title);
157	1	}
158
159		/**
160		* Sheet data row.
161		*
162		* @param LaravelExcelWorksheet $sheet
163		* @param int $index
164		* @param Project\Issue $issue
165		*
166		* @return void
167		*/
168	1	protected function sheetRow(LaravelExcelWorksheet $sheet, $index, Project\Issue $issue)
169		{
170		// Setup row data
171		array_walk($this->columns, function (&$column, $key, Project\Issue $issue) {
172	1	$column = (string) $issue->$key;
173	1	if ($key === 'status') {
174	1	$column = (int) $issue->status === Project\Issue::STATUS_OPEN ? 'open' : 'closed';
175	1	$column = trans('tinyissue.' . $column);
176		}
177	1	}, $issue);
178
179		// Write row
180	1	$sheet->row($index, $this->columns);
181
182		// Format last cell
183	1	$sheet->cell('G' . $index, function (CellWriter $cell) use ($issue) {
184	1	$color = (int) $issue->status === Project\Issue::STATUS_CLOSED ? '#FF0000' : '#00FF00';
185	1	$cell->setBackground($color);
186	1	});
187	1	}
188		}
189

satrun77 / tinyissue

Push — master ( 91f8d9...64265e )

XlsHandler::setProject() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like