Workshop: Refactoring Legacy PHP: The Complete Guide
0 likes253 views
The document provides a comprehensive overview of best practices for refactoring legacy PHP code, emphasizing the importance of automated testing, design principles, and continuous integration. It includes resources, code samples, and protocols for API testing, along with SOLID principles that guide software design. Overall, it promotes maintaining clean, concise code to facilitate easier modifications and enhance system reliability.
![API Testing: Base Class
<?php
class UserAgentTest extends PHPUnit_Framework_TestCase
{
private $http;
public function setUp()
{
$this->http = new GuzzleHttpClient(['base_uri' => 'https://httpbin.org/']);
}
public function tearDown() {
$this->http = null;
}
}](https://image.slidesharecdn.com/phpconfasia2018-refactoringlegacyphp-180928051159/85/Workshop-Refactoring-Legacy-PHP-The-Complete-Guide-29-320.jpg)
![API Testing: Testing HTTP GET Methods
public function testGet()
{
$response = $this->http->request('GET', 'user-agent');
$this->assertEquals(200, $response->getStatusCode());
$contentType = $response->getHeaders()["Content-Type"][0];
$this->assertEquals("application/json", $contentType);
$userAgent = json_decode($response->getBody())->{"user-agent"};
$this->assertRegexp('/Guzzle/', $userAgent);
}](https://image.slidesharecdn.com/phpconfasia2018-refactoringlegacyphp-180928051159/85/Workshop-Refactoring-Legacy-PHP-The-Complete-Guide-30-320.jpg)
![API Testing: Testing HTTP PUT Methods
public function testPut()
{
$response = $this->http->request('PUT', 'user-agent', ['http_errors' => false]);
$this->assertEquals(405, $response->getStatusCode());
}](https://image.slidesharecdn.com/phpconfasia2018-refactoringlegacyphp-180928051159/85/Workshop-Refactoring-Legacy-PHP-The-Complete-Guide-31-320.jpg)
Workshop: Refactoring Legacy PHP: The Complete Guide
- 1. Refactoring Legacy PHP Junade Ali - @IcyApril
- 2. Resources ● Code Samples ○ https://github.com/IcyApril/phpasia-examples ○ git clone git@github.com:IcyApril/phpasia-examples.git ● Slides ○ https://www.slideshare.net/JunadeAli ● Free Book: “Object-Oriented PHP” ○ https://ju.je/free-book-phpasia ○ Link valid for attendees only ○ Please be considerate, don’t share/sell/upload
- 3. Human Error
- 4. Huamn Erorr: Tehse wrods may look lkie nosnesne, but yuo can raed tehm, cna't yuo?
- 6. Design Stamina Hypothesis - Martin Fowler
- 7. Clean Code
- 14. BeckDesignRules - Martin Fowler (www.martinfowler.com)
- 15. BeckDesignRules - Martin Fowler (www.martinfowler.com)
- 19. Installing PHPUnit composer require --dev phpunit/phpunit ^7 ./vendor/bin/phpunit --version
- 20. phpunit.xml
- 21. Running PHPUnit php ./vendor/bin/phpunit --configuration ./phpunit.xml
- 26. Testing Legacy ● It’s hard to apply unit tests before refactoring ● Instead we can start automating things like GUI tests or API tests ● PHPUnit has support for Selenium WebDriver ● Means you can refactor in a reliable way ● With such tests, refactoring becomes easier
- 27. API Testing: Installing PHPUnit + Guzzle composer require phpunit/phpunit composer require guzzlehttp/guzzle composer update
- 28. API Testing: Installing PHPUnit + Guzzle composer require phpunit/phpunit composer require guzzlehttp/guzzle composer update
- 29. API Testing: Base Class <?php class UserAgentTest extends PHPUnit_Framework_TestCase { private $http; public function setUp() { $this->http = new GuzzleHttpClient(['base_uri' => 'https://httpbin.org/']); } public function tearDown() { $this->http = null; } }
- 30. API Testing: Testing HTTP GET Methods public function testGet() { $response = $this->http->request('GET', 'user-agent'); $this->assertEquals(200, $response->getStatusCode()); $contentType = $response->getHeaders()["Content-Type"][0]; $this->assertEquals("application/json", $contentType); $userAgent = json_decode($response->getBody())->{"user-agent"}; $this->assertRegexp('/Guzzle/', $userAgent); }
- 31. API Testing: Testing HTTP PUT Methods public function testPut() { $response = $this->http->request('PUT', 'user-agent', ['http_errors' => false]); $this->assertEquals(405, $response->getStatusCode()); }
- 33. PHPMD + PHP Code Sniffer
- 34. Installing PHPMD + PHPCS composer require --dev phpmd/phpmd composer require --dev friendsofphp/php-cs-fixer
- 35. Makefile
- 36. .php_cs
- 40. “Else is never necessary” “The method validateEmail uses an else expression. Else is never necessary and you can simplify the code to work without else.”
- 42. Installing PhpDeal composer require php-deal/framework Recommended PHPStorm plugin: Go! AOP Framework
- 52. Makefile
- 53. .travis.yml
- 55. SOLID Principles
- 56. Single Responsibility Principle Robert C. Martin expresses the principle as, "A class should have only one reason to change."
- 57. Open/Closed Principle The Open/Closed Principle states “software entities (classes, modules, functions, etc.) should be open for extension, but closed for modification”.We should be able to extended a given piece of software without needing to modify it’s source code. ● “Open for Extension” - we can make the class behave in new ways as the requirements for what the class needs to do evolves ● “Closed for Modification” - you cannot change the source code of the class itself, it is considered inviolable
- 59. Liscov Substitution Principle In it’s simplified form: “Functions that use pointers or references to base classes must be able to use objects of derived classes without knowing it”. Any class should be substitutable for it’s base class or interface. Any of the sub-classes of Staff should be substitutable for the Staff class.
- 60. Interface Segregation Principle The Interface Segregation Principle states that no client should be forced to depend on methods it does not use. This principle essentially outlines that we should favour small, specific interfaces over large bloated ones. All classes should only have to implement the methods they need - this helps keep our system decoupled.
- 63. Dependency-Inversion Principle The Dependency-Inversion Principle is stated in two parts: ● High-level modules should not depend on low-level modules. Both should depend on abstractions. ● Abstractions should not depend on details. Details should depend on abstractions.
- 66. Delivering Value
- 67. - “Refactor Mercilessly” - Extreme Programming http://www.extremeprogramming.org/rules/refactor.html Refactor mercilessly to keep the design simple as you go and to avoid needless clutter and complexity. Keep your code clean and concise so it is easier to understand, modify, and extend. Make sure everything is expressed once and only once. In the end it takes less time to produce a system that is well groomed.
- 69. Five Focusing Steps - Theory of Constraints https://www.leanproduction.com/theory-of-constraints.html
- 71. Software Engineering Workflow ● Enshrine all your requirements in automated acceptance tests with CI builds ● “Boy Scout Principle” - Leave the codebase cleaner everytime you push ● Use short iterations to prevent task switching