Skip to content

Commit e5ff03e

Browse files
ScreamingDevScreamingDev
committed
#87 better code assertions
1 parent e0cf3cc commit e5ff03e

File tree

11 files changed

+88
-24
lines changed

11 files changed

+88
-24
lines changed

‎app/code/community/LeMike/DevMode/Helper/Auth.php

+20-5
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,10 @@ public function getBackendUrl($route, $params = array())
4141
{
4242
$params[Mage_Adminhtml_Model_Url::SECRET_KEY_PARAM_NAME] = "lemike_devmode";
4343

44-
return (string) Mage::getModel('adminhtml/url')->getUrl($route, $params);
44+
/** @var Mage_Adminhtml_Model_Url $adminhtmlUrl */
45+
$adminhtmlUrl = Mage::getModel('adminhtml/url');
46+
47+
return (string) $adminhtmlUrl->getUrl($route, $params);
4548
}
4649

4750

@@ -55,7 +58,10 @@ public function getBackendUrl($route, $params = array())
5558
*/
5659
public function getSecretKey($controller = null, $action = null)
5760
{
58-
$salt = Mage::getSingleton('core/session')->getFormKey();
61+
/** @var Mage_Core_Model_Session $coreSession */
62+
$coreSession = Mage::getSingleton('core/session');
63+
64+
$salt = $coreSession->getFormKey();
5965
$request = Mage::app()->getRequest();
6066

6167
$p = explode('/', trim($request->getOriginalPathInfo(), '/'));
@@ -70,7 +76,10 @@ public function getSecretKey($controller = null, $action = null)
7076

7177
$secret = $controller . $action . $salt;
7278

73-
return Mage::helper('core')->getHash($secret);
79+
/** @var Mage_Core_Helper_Data $helper */
80+
$helper = Mage::helper('core');
81+
82+
return $helper->getHash($secret);
7483
}
7584

7685

@@ -81,13 +90,19 @@ public function getSecretKey($controller = null, $action = null)
8190
*/
8291
public function isDevAllowed()
8392
{
84-
if (!Mage::helper('lemike_devmode/config')->generalSecurityAllowRestrictedIpOnly()
93+
/** @var LeMike_DevMode_Helper_Config $helperConfig */
94+
$helperConfig = Mage::helper('lemike_devmode/config');
95+
96+
if (!$helperConfig->generalSecurityAllowRestrictedIpOnly()
8597
|| Mage::getIsDeveloperMode()
8698
)
8799
{ // no restrictions or is dev mode: allow all
88100
return true;
89101
}
90102

91-
return (bool) Mage::helper('core')->isDevAllowed();
103+
/** @var Mage_Core_Helper_Data $helperCore */
104+
$helperCore = Mage::helper('core');
105+
106+
return (bool) $helperCore->isDevAllowed();
92107
}
93108
}

‎app/code/community/LeMike/DevMode/Model/Core/Email.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@ class LeMike_DevMode_Model_Core_Email extends Mage_Core_Model_Email
4343
*/
4444
public function send()
4545
{
46-
Mage::helper('lemike_devmode/core')->handleMail($this);
46+
/** @var LeMike_DevMode_Helper_Core $helper */
47+
$helper = Mage::helper('lemike_devmode/core');
48+
$helper->handleMail($this);
4749

4850
return parent::send();
4951
}

‎app/code/community/LeMike/DevMode/Test/Block/ToolboxTest.php

+1
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ public function testQuickLinkToOpenTheControllerOrActionInYourIDE()
4545
*/
4646

4747
// config
48+
/** @var LeMike_DevMode_Helper_Config $configHelper */
4849
$configHelper = Mage::helper('lemike_devmode/config');
4950
$this->assertTrue($configHelper->isIdeRemoteCallEnabled());
5051
$this->assertNotEmpty($configHelper->getRemoteCallUrlTemplate());

‎app/code/community/LeMike/DevMode/Test/Controller/Adminhtml/LeMike/DevMode/Menu/CoreController_RunTest.php

+24-7
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,10 @@ public function testRunAction()
5151

5252
$this->assertRequestRoute($route);
5353

54+
/** @var Mage_Adminhtml_Model_Session $adminhtmlSession */
55+
$adminhtmlSession = Mage::getSingleton('adminhtml/session');
5456
/** @var Mage_Core_Model_Message_Collection $messages */
55-
$messages = Mage::getSingleton('adminhtml/session')->getMessages();
57+
$messages = $adminhtmlSession->getMessages();
5658
$this->assertSame(2, $messages->count());
5759
$this->assertSame(1, $messages->count('notice'));
5860
$this->assertSame(1, $messages->count('success'));
@@ -63,13 +65,16 @@ public function testRunAction()
6365
);
6466

6567
// version
68+
/** @var LeMike_DevMode_Model_Core_Resource $model */
6669
$model = Mage::getModel('lemike_devmode/core_resource');
70+
/** @var LeMike_DevMode_Helper_Core $helper */
6771
$helper = Mage::helper('lemike_devmode/core');
68-
$resName = $helper->getResourceName($moduleName);
6972

7073
$this->assertSame(
7174
LeMike_DevMode_Model_Core_Resource::RESET_VERSION,
72-
$model->getDbVersion($resName)
75+
$model->getDbVersion(
76+
$helper->getResourceName($moduleName)
77+
)
7378
);
7479
}
7580

@@ -81,8 +86,10 @@ public function testRunAction()
8186
*/
8287
public function testRunAction_DisallowMageAdmin()
8388
{
89+
/** @var Mage_Index_Model_Indexer $indexIndexer */
90+
$indexIndexer = Mage::getSingleton('index/indexer');
8491
/** @var Mage_Index_Model_Resource_Process_Collection $object */
85-
$object = Mage::getSingleton('index/indexer')->getProcessesCollection();
92+
$object = $indexIndexer->getProcessesCollection();
8693
$object->getSelect()->reset('from');
8794

8895
$this->assertPreConditions();
@@ -97,6 +104,7 @@ public function testRunAction_DisallowMageAdmin()
97104

98105
$this->assertRequestRoute($route);
99106

107+
/** @var Mage_Adminhtml_Model_Session $session */
100108
$session = Mage::getSingleton('adminhtml/session');
101109
$this->assertSame(
102110
'Reinstall Mage_Admin is not allowed.',
@@ -114,8 +122,10 @@ public function testRunAction_DisallowMageAdmin()
114122
*/
115123
public function testRunAction_NoModule()
116124
{
125+
/** @var Mage_Index_Model_Indexer $indexIndexer */
126+
$indexIndexer = Mage::getSingleton('index/indexer');
117127
/** @var Mage_Index_Model_Resource_Process_Collection $object */
118-
$object = Mage::getSingleton('index/indexer')->getProcessesCollection();
128+
$object = $indexIndexer->getProcessesCollection();
119129
$object->getSelect()->reset('from');
120130

121131
$this->assertPreConditions();
@@ -130,7 +140,10 @@ public function testRunAction_NoModule()
130140

131141
$this->assertRequestRoute($route);
132142

133-
$messages = Mage::getSingleton('adminhtml/session')->getMessages();
143+
/** @var Mage_Adminhtml_Model_Session $adminhtmlSession */
144+
$adminhtmlSession = Mage::getSingleton('adminhtml/session');
145+
/** @var Mage_Core_Model_Message_Collection $messages */
146+
$messages = $adminhtmlSession->getMessages();
134147
$this->assertSame(
135148
'No module provided. Please add a module name.',
136149
$messages->getLastAddedMessage()->getCode()
@@ -159,6 +172,7 @@ public function testRunAction_UnknownModule()
159172

160173
$this->assertRequestRoute($route);
161174

175+
/** @var Mage_Adminhtml_Model_Session $session */
162176
$session = Mage::getSingleton('adminhtml/session');
163177
$this->assertSame(
164178
'Could not find Som_eStrange in core_resource.',
@@ -174,8 +188,11 @@ public function testRunAction_UnknownModule()
174188
*/
175189
protected function assertPreConditions()
176190
{
191+
/** @var Mage_Adminhtml_Model_Session $adminhtmlSession */
192+
$adminhtmlSession = Mage::getSingleton('adminhtml/session');
177193
/** @var Mage_Core_Model_Message_Collection $messages */
178-
$messages = Mage::getSingleton('adminhtml/session')->getMessages();
194+
$messages = $adminhtmlSession->getMessages();
195+
179196
$messages->clear();
180197

181198
// no messages in session

‎app/code/community/LeMike/DevMode/Test/Helper/CoreTest.php

+24-6
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ class LeMike_DevMode_Test_Helper_CoreTest extends EcomDev_PHPUnit_Test_Case
3737
public function mockHelperDataStop()
3838
{
3939
// mock Helper_Data::stop prevent exit
40+
/** @var LeMike_DevMode_Helper_Data|PHPUnit_Framework_MockObject_MockBuilder $mock */
4041
$mock = $this->mockHelper('lemike_devmode', array('stop'));
4142

4243
$this->assertInstanceOf('LeMike_DevMode_Helper_Data', $mock->getMock());
@@ -60,7 +61,10 @@ public function mockHelperDataStop()
6061
*/
6162
public function testGetAvailableVersion()
6263
{
63-
$version = Mage::helper('lemike_devmode/core')->getAvailableVersion('LeMike_DevMode');
64+
/** @var LeMike_DevMode_Helper_Core $helperCore */
65+
$helperCore = Mage::helper('lemike_devmode/core');
66+
67+
$version = $helperCore->getAvailableVersion('LeMike_DevMode');
6468
$this->assertNotEmpty($version);
6569
$this->assertEquals('0.4.0', $version);
6670

@@ -75,7 +79,10 @@ public function testGetAvailableVersion()
7579
*/
7680
public function testGetAvailableVersion_UnknownModule()
7781
{
78-
$version = Mage::helper('lemike_devmode/core')->getAvailableVersion(uniqid());
82+
/** @var LeMike_DevMode_Helper_Core $helperCore */
83+
$helperCore = Mage::helper('lemike_devmode/core');
84+
85+
$version = $helperCore->getAvailableVersion(uniqid());
7986
$this->assertEquals('', $version);
8087

8188
return null;
@@ -95,6 +102,7 @@ public function testGetResourceName()
95102
* }}} preconditions {{{
96103
*/
97104
$moduleName = 'Mage_Customer';
105+
/** @var LeMike_DevMode_Helper_Core $coreHelper */
98106
$coreHelper = Mage::helper('lemike_devmode/core');
99107

100108
$this->assertNotNull($coreHelper);
@@ -125,6 +133,7 @@ public function testGetResourceName_UnknownModule()
125133
* }}} preconditions {{{
126134
*/
127135
$moduleName = uniqid('L') . '_' . uniqid('D');
136+
/** @var LeMike_DevMode_Helper_Core $coreHelper */
128137
$coreHelper = Mage::helper('lemike_devmode/core');
129138

130139
$this->assertNotNull($coreHelper);
@@ -150,7 +159,10 @@ public function testGetResourceName_UnknownModule()
150159
public function testHandleMail_ExceptionNoContent()
151160
{
152161
$this->setExpectedException('Exception');
153-
Mage::helper('lemike_devmode/core')->handleMail(new Mage_Core_Model_Email_Template, null);
162+
163+
/** @var LeMike_DevMode_Helper_Core $helperCore */
164+
$helperCore = Mage::helper('lemike_devmode/core');
165+
$helperCore->handleMail(new Mage_Core_Model_Email_Template, null);
154166

155167
return null;
156168
}
@@ -171,7 +183,9 @@ public function testHandleMail_VarienObject()
171183
$assertion = 'this is some body' . uniqid(__FUNCTION__);
172184

173185
// config is correct
174-
$this->assertFalse(Mage::helper('lemike_devmode/config')->isMailAllowed());
186+
/** @var LeMike_DevMode_Helper_Config $helperConfig */
187+
$helperConfig = Mage::helper('lemike_devmode/config');
188+
$this->assertFalse($helperConfig->isMailAllowed());
175189

176190
// create object
177191
$object = new Varien_Object();
@@ -186,7 +200,9 @@ public function testHandleMail_VarienObject()
186200
* }}} main {{{
187201
*/
188202
ob_start();
189-
$this->assertFalse(Mage::helper('lemike_devmode/core')->handleMail($object));
203+
/** @var LeMike_DevMode_Helper_Core $helperCore */
204+
$helperCore = Mage::helper('lemike_devmode/core');
205+
$this->assertFalse($helperCore->handleMail($object));
190206
$output = ob_get_clean();
191207

192208
$this->assertEquals($assertion, $output);
@@ -226,7 +242,9 @@ public function testHandleMail_ZendMail()
226242
* }}} main {{{
227243
*/
228244
ob_start();
229-
$this->assertFalse(Mage::helper('lemike_devmode/core')->handleMail($zendMail));
245+
/** @var LeMike_DevMode_Helper_Core $helperCore */
246+
$helperCore = Mage::helper('lemike_devmode/core');
247+
$this->assertFalse($helperCore->handleMail($zendMail));
230248
$output = ob_get_clean();
231249

232250
$this->assertEquals($assertion, $output);

‎app/code/community/LeMike/DevMode/Test/Model/Admin/System/Config/AdminTest.php

+1-2
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ public function testChooseBetweenDifferentAdminUsersToLoginAsInTheConfig()
4646
*/
4747

4848
// get the model
49+
/** @var LeMike_DevMode_Model_Admin_System_Config_Admin $model */
4950
$model = Mage::getModel('lemike_devmode/admin_system_config_admin');
5051

5152
$this->assertInstanceOf(
@@ -85,8 +86,6 @@ public function testChooseBetweenDifferentAdminUsersToLoginAsInTheConfig()
8586
$entry->getEmail()
8687
);
8788

88-
$message = sprintf('Admin %s failed assertion for option array.', $entry->getId());
89-
9089
switch ($entry->getIsActive())
9190
{
9291
case 0:

‎shell/coreConfig_listCron.php

+4-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,10 @@ public function run()
4242

4343
echo "\r" . str_repeat(' ', strlen(self::LOADING_MAGENTO)) . "\r";
4444

45-
$data = Mage::getModel('lemike_devmode/core_config')->getCrontabJobs();
45+
/** @var LeMike_DevMode_Model_Core_Config $modelCoreConfig */
46+
$modelCoreConfig = Mage::getModel('lemike_devmode/core_config');
47+
48+
$data = $modelCoreConfig->getCrontabJobs();
4649

4750
$table = new LeMike_DevMode_Block_Shell_Table(
4851
array("alias" => 'Alias',

‎shell/coreConfig_listObserver.php

+4-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,10 @@ public function run()
4242

4343
echo "\r" . str_repeat(' ', strlen(self::LOADING_MAGENTO)) . "\r";
4444

45-
$data = Mage::getModel('lemike_devmode/core_config')->getObserver();
45+
/** @var LeMike_DevMode_Model_Core_Config $modelCoreConfig */
46+
$modelCoreConfig = Mage::getModel('lemike_devmode/core_config');
47+
48+
$data = $modelCoreConfig->getObserver();
4649

4750
$table = new LeMike_DevMode_Block_Shell_Table(
4851
array(

‎shell/coreConfig_listRewrites.php

+4-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,10 @@ public function run()
4040

4141
Mage::app();
4242

43-
$pathToClassName = Mage::getModel('lemike_devmode/core_config')->getRewritePathToClassName();
43+
/** @var LeMike_DevMode_Model_Core_Config $coreConfig */
44+
$coreConfig = Mage::getModel('lemike_devmode/core_config');
45+
46+
$pathToClassName = $coreConfig->getRewritePathToClassName();
4447

4548
$longestPath = 0;
4649
$longestValue = 0;

‎shell/core_modules.php

+1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ public function run()
4141

4242
echo "\r" . str_repeat(' ', strlen(LOADING_MAGENTO)) . "\r";
4343

44+
/** @var LeMike_DevMode_Model_Core_Resource $model */
4445
$model = Mage::getSingleton('lemike_devmode/core_resource');
4546
$moduleSet = $model->getModuleSet();
4647
$moduleSet = $this->_filterCodePool($moduleSet);

‎shell/delete.php

+2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@ public function run()
4343
return;
4444
}
4545

46+
/** @var LeMike_DevMode_Helper_Data $helper */
4647
$helper = Mage::helper('lemike_devmode');
48+
/** @var LeMike_DevMode_Helper_Cli $cli */
4749
$cli = Mage::helper('lemike_devmode/cli');
4850
$answer = $cli->ask($cli->__("Delete %s? [y/n] ", implode(' & ', array_keys($this->_args))));
4951

0 commit comments

Comments
 (0)