View GitHub Repository gcconnex

Schedule Inspection
Subscribe
Completed
Push — master ( d21053...c59b30 )
by
unknown
08:11
created

MissionDatabaseTest   A

↳ Parent: Project

Complexity

Total Complexity 13

Size/Duplication

Total Lines 179
Duplicated Lines 3.35 %

Coupling/Cohesion

Components 0
Dependencies 0

Importance

Changes 0
Metric Value
dl 6
loc 179
rs 10
c 0
b 0
f 0
wmc 13
lcom 0
cbo 0

22 Methods

Rating   Name   Duplication   Size   Complexity  
A setUp() 6 6 1
A tearDown() 0 3 1
A testForEachMission() 0 40 4
A testMissionNameMustNotBeEmpty() 0 3 1
A testMissionDepartmentMustNotBeEmpty() 0 3 1
A testMissionEmailMustBeValid() 0 8 2
A testMissionPhoneMustBeValid() 0 6 2
A testMissionJobTitleMustNotBeEmpty() 0 3 1
A testMissionJobTypeMustNotBeEmpty() 0 3 1
A testMissionJobTypeMustBeInList() 0 5 1
A testMissionNumberMustBeValid() 0 6 2
A testMissionStartMustBeValid() 0 7 2
A testMissionCompletionMustBeValid() 0 7 2
A testMissionDeadlineMustBeValid() 0 6 2
A testMissionStartMustBeBeforeCompletionAndDeadline() 0 6 1
A testMissionLocationMustNotBeEmpty() 0 3 1
A testMissionLocationMustBeInList() 0 5 1
A testMissionSecurityMustBeInList() 0 5 2
A testMissionTimeCommitmentMustBeValid() 0 9 2
A testMissionTimeIntervalMustBeInList() 0 5 1
A testMissionTimezoneMustBeInList() 0 5 2
A testMissionTimezoneMustNotBeEmpty() 0 3 1

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1 
<?php
2 
class MissionDatabaseTest extends ElggCoreUnitTest {
3
4 
	private $list_of_missions = array();
5
6 View Code Duplication 
	function setUp() {
0 ignored issues
– show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
7 
		$options['type'] = 'object';
0 ignored issues
– show
Coding Style Comprehensibility introduced by
$options was never initialized. Although not strictly required by PHP, it is generally a good practice to add $options = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
8 
		$options['subtype'] = 'mission';
9 
		$options['limit'] = 0;
10 
		$this->list_of_missions = elgg_get_entities_from_metadata($options);
0 ignored issues
– show
Documentation Bug introduced by
It seems like elgg_get_entities_from_metadata($options) of type * is incompatible with the declared type array of property $list_of_missions.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
11 
	}
12
13 
	function tearDown() {
14 
		unset($this->list_of_missions);
15 
	}
16
17 
	public function testForEachMission() {
18 
		$this->assertTrue((count($this->list_of_missions) > 0), elgg_echo('missions:diagnostic_suite:no_missions_in_db'));
19
20 
		foreach($this->list_of_missions as $mission) {
21 
			$this->testMissionNameMustNotBeEmpty($mission);
22
23 
			$this->testMissionEmailMustBeValid($mission);
24
25 
			$this->testMissionPhoneMustBeValid($mission);
26
27 
			$this->testMissionJobTitleMustNotBeEmpty($mission);
28
29 
			$this->testMissionJobTypeMustNotBeEmpty($mission);
30 
			$this->testMissionJobTypeMustBeInList($mission);
31
32 
			//$this->testMissionProgramAreaMustBeInList($mission);
33
34 
			$this->testMissionNumberMustBeValid($mission);
35
36 
			$this->testMissionStartMustBeValid($mission);
37 
			$this->testMissionCompletionMustBeValid($mission);
38 
			$this->testMissionDeadlineMustBeValid($mission);
39 
			if(trim($mission->completion_date) != '') {
40 
				$this->testMissionStartMustBeBeforeCompletionAndDeadline($mission);
41 
			}
42
43 
			$this->testMissionLocationMustNotBeEmpty($mission);
44 
			$this->testMissionLocationMustBeInList($mission);
45
46 
			$this->testMissionSecurityMustBeInList($mission);
47
48 
			$this->testMissionTimeCommitmentMustBeValid($mission);
49 
			$this->testMissionTimeIntervalMustBeInList($mission);
50
51 
			$this->testMissionTimezoneMustBeInList($mission);
52 
			if(mm_check_days_for_start_or_duration($mission)) {
53 
				$this->testMissionTimezoneMustNotBeEmpty($mission);
54 
			}
55 
		}
56 
	}
57
58 
	private function testMissionNameMustNotBeEmpty($mission) {
59 
		$this->assertTrue((trim($mission->name) != ''), elgg_echo('missions:diagnostic_suite:no_manager_name', array($mission->guid)));
60 
	}
61
62 
	private function testMissionDepartmentMustNotBeEmpty($mission) {
0 ignored issues
– show
Unused Code introduced by
This method is not used, and could be removed.
Loading history...
63 
		$this->assertTrue((trim($mission->department) != ''), elgg_echo('missions:diagnostic_suite:no_department', array($mission->guid)));
64 
	}
65
66 
	private function testMissionEmailMustBeValid($mission) {
67 
		$result = $this->assertTrue(filter_var($mission->email, FILTER_VALIDATE_EMAIL),
68 
				elgg_echo('missions:diagnostic_suite:invalid_email_format', array($mission->guid, $mission->email)));
69 
		if($result) {
70 
			$returned_users = get_user_by_email($mission->email);
71 
			$this->assertTrue(count($returned_users), elgg_echo('missions:diagnostic_suite:no_account_has_email', array($mission->guid, $mission->email)));
72 
		}
73 
	}
74
75 
	private function testMissionPhoneMustBeValid($mission) {
76 
		if($mission->phone != '') {
77 
			$result = $this->assertTrue(mm_is_valid_phone_number($mission->phone),
78 
					elgg_echo('missions:diagnostic_suite:invalid_phone_format', array($mission->guid, $mission->phone)));
79 
		}
80 
	}
81
82 
	private function testMissionJobTitleMustNotBeEmpty($mission) {
83 
		$this->assertTrue((trim($mission->job_title) != ''), elgg_echo('missions:diagnostic_suite:no_mission_title', array($mission->guid)));
84 
	}
85
86 
	private function testMissionJobTypeMustNotBeEmpty($mission) {
87 
		$this->assertTrue((trim($mission->job_type) != ''), elgg_echo('missions:diagnostic_suite:no_mission_type', array($mission->guid)));
88 
	}
89
90 
	private function testMissionJobTypeMustBeInList($mission) {
91 
		$list_array = explode(',', elgg_get_plugin_setting('opportunity_type_string', 'missions'));
92 
		$this->assertTrue((array_search($mission->job_type, $list_array) !== false),
93 
				elgg_echo('missions:diagnostic_suite:job_type_not_in_list', array($mission->guid, $mission->job_type)));
94 
	}
95
96 
	/*private function testMissionProgramAreaMustBeInList($mission) {
97 
		$list = elgg_get_plugin_setting('program_area_string', 'missions');
98 
		$this->assertTrue(mm_get_translation_key_from_setting_string($mission->program_area, $list) != false,
99 
				elgg_echo('missions:diagnostic_suite:program_area_not_in_list', array($mission->guid, $mission->program_area)));
100 
	}*/
101
102 
	private function testMissionNumberMustBeValid($mission) {
103 
		$result = $this->assertTrue((trim($mission->number) != ''), elgg_echo('missions:diagnostic_suite:no_number', array($mission->guid)));
104 
		if($result) {
105 
			$this->assertTrue(($mission->number > 0), elgg_echo('missions:diagnostic_suite:number_less_than_one', array($mission->guid, $mission->number)));
106 
		}
107 
	}
108
109 
	private function testMissionStartMustBeValid($mission) {
110 
		$result = $this->assertTrue((trim($mission->start_date) != ''), elgg_echo('missions:diagnostic_suite:no_start_date', array($mission->guid)));
111 
		if($result) {
112 
			$this->assertTrue(mm_is_valid_date($mission->start_date),
113 
					elgg_echo('missions:diagnostic_suite:invalid_start_date', array($mission->guid, $mission->start_date)));
114 
		}
115 
	}
116
117 
	private function testMissionCompletionMustBeValid($mission) {
118 
		//$result = $this->assertTrue((trim($mission->completion_date) != ''), elgg_echo('missions:diagnostic_suite:no_completion_date', array($mission->guid)));
119 
		if(trim($mission->completion_date) != '') {
120 
			$this->assertTrue(mm_is_valid_date($mission->completion_date),
121 
					elgg_echo('missions:diagnostic_suite:invalid_completion_date', array($mission->guid, $mission->completion_date)));
122 
		}
123 
	}
124
125 
	private function testMissionDeadlineMustBeValid($mission) {
126 
		$result = $this->assertTrue((trim($mission->deadline) != ''), elgg_echo('missions:diagnostic_suite:no_deadline', array($mission->guid)));
127 
		if($result) {
128 
			$this->assertTrue(mm_is_valid_date($mission->deadline), elgg_echo('missions:diagnostic_suite:invalid_deadline', array($mission->guid, $mission->deadline)));
129 
		}
130 
	}
131
132 
	private function testMissionStartMustBeBeforeCompletionAndDeadline($mission) {
133 
		$this->assertTrue((strtotime($mission->start_date) <= strtotime($mission->completion_date)),
134 
				elgg_echo('missions:diagnostic_suite:start_after_completion', array($mission->guid, $mission->start_date, $mission->completion_date)));
135 
		$this->assertTrue((strtotime($mission->deadline) <= strtotime($mission->completion_date)),
136 
				elgg_echo('missions:diagnostic_suite:deadline_after_completion', array($mission->guid, $mission->deadline, $mission->completion_date)));
137 
	}
138
139 
	private function testMissionLocationMustNotBeEmpty($mission) {
140 
		$this->assertTrue((trim($mission->location) != ''), elgg_echo('missions:diagnostic_suite:no_location', array($mission->guid)));
141 
	}
142
143 
	private function testMissionLocationMustBeInList($mission) {
144 
		$list_array = explode(',', elgg_get_plugin_setting('province_string', 'missions'));
145 
		$this->assertTrue((array_search($mission->location, $list_array) !== false),
146 
				elgg_echo('missions:diagnostic_suite:location_not_in_list', array($mission->guid, $mission->location)));
147 
	}
148
149 
	private function testMissionSecurityMustBeInList($mission) {
150 
		$list_array = explode(',', elgg_get_plugin_setting('security_string', 'missions'));
151 
		$this->assertTrue((array_search($mission->security, $list_array) !== false || $mission->security === ''),
152 
				elgg_echo('missions:diagnostic_suite:security_not_in_list', array($mission->guid, $mission->security)));
153 
	}
154
155 
	private function testMissionTimeCommitmentMustBeValid($mission) {
156 
		$result = $this->assertTrue((trim($mission->time_commitment) != ''), elgg_echo('missions:diagnostic_suite:no_time_commitment', array($mission->guid)));
157 
		if($result) {
158 
			$this->assertTrue(($mission->time_commitment < 100),
159 
					elgg_echo('missions:diagnostic_suite:time_commitment_greater', array($mission->guid, $mission->time_commitment)));
160 
			$this->assertTrue(($mission->time_commitment > 0),
161 
					elgg_echo('missions:diagnostic_suite:time_commitment_negative_or_zero', array($mission->guid, $mission->time_commitment)));
162 
		}
163 
	}
164
165 
	private function testMissionTimeIntervalMustBeInList($mission) {
166 
		$list_array = explode(',', elgg_get_plugin_setting('time_rate_string', 'missions'));
167 
		$this->assertTrue((array_search($mission->time_interval, $list_array) !== false),
168 
				elgg_echo('missions:diagnostic_suite:time_interval_not_in_list', array($mission->guid, $mission->time_interval)));
169 
	}
170
171 
	private function testMissionTimezoneMustBeInList($mission) {
172 
		$list_array = explode(',', elgg_get_plugin_setting('timezone_string', 'missions'));
173 
		$this->assertTrue((array_search($mission->timezone, $list_array) !== false || $mission->timezone === ''),
174 
				elgg_echo('missions:diagnostic_suite:timezone_not_in_list', array($mission->guid, $mission->timezone)));
175 
	}
176
177 
	private function testMissionTimezoneMustNotBeEmpty($mission) {
178 
		$this->assertTrue((trim($mission->timezone) != ''), elgg_echo('missions:diagnostic_suite:no_timezone', array($mission->guid)));
179 
	}
180 
}