Refactoring to Clean Code
This book is 90% complete
Last updated on 2018-07-15
About the Book
Are you suffering from maintaining extremely poor application code with tons of technical debt? Are you leading a new team and want to start clean, and not hit the same wall again?! Are you transitioning to Agile, and started feeling the pains of shorter iterations with limited time for regression testing? Are you puzzled with prioritizing which refactorings to apply on which code and having hard time convincing managers with the value of refactoring?
If the answer is yes, this book is for you. This book is an attempt to cross the chasm and introduce order to the chaos of developing and maintaining software products.
This book is an accumulation of years of experiments to refactor software products and make them easier to understand and cheaper to modify. In early attempts, we achieved limited success and many failures. During that period, I had a strong feeling that there must be a better way to handle the mountains of technical debt in a systematic and sustainable way. Later on, I've changed my way of thinking and took into consideration two important factors:
- Starting with simple and least risky refactorings
- Keep it sustainable for developers, managers, and users
For the next set of the projects, we achieved better results. We kept experimenting and fine-tuning the roadmap till we reached what we believe to be a better way of refactoring poor code and systematically reduce the technical debt in a sustainable and stepwise manner.
This is not a book about refactoring, although you'll learn a lot of useful refactoring ideas. It's also not a book about software design, although it teaches you some very important principles about good design. Rather, it's a book about good development habits and clean coding, including refactoring techniques, design principles, test automation, technical debt management, and many more.
All these ideas are put into a roadmap which takes you step-by-step towards your goal. This roadmap divides the effort to refactor poor code into three stages:
- Quick-wins; simple and least risky enhancements
- Divide-and-conquer the code into functional, utility, and architectural components, with identified and clear component interfaces
- Inject-quality-in the code by wrapping components with automated tests
For every stage, the book lists techniques and tools that you can use. It offers hints, tips, and tricks which you may consider along the way. And most important, it gives you some ideas about how to measure your code quality, and how to show progress and share achievement with your busy managers to gain their support.
Practices & Techniques
The book introduces some basic clean coding practices and techniques. These practices are presented in an order which most suites stepwise refactoring of existing code. However, they are equally useful for green field development and establishes grounds for becoming a professional programmer.
Five copies of the book
The Book for your team + One hour discussion with the author
With this package, you will receive the book in electronic format and the authorization to share it with your 20 members of your team. You will also have one hour of discussion with the author.
Introduction and Background
- Why refactoring matters?
- How to refactor - the “old” way
- Why refactoring fails?
- Is there a better way?
1. Before You Start - Prepare a Healthy Environment
- 1.1 Work item tracking
- 1.2 End-to-end traceability
- 1.3 Continuous integration
- 1.4 Starting with characterization (aka pin-down) tests
- 1.5 Ground rules for sustainable refactoring
- 2. Refactoring Roadmap Overview
3. Stage 1: Quick-Wins
- 3.1 Remove dead code
- 3.2 Remove code duplicates
- 3.3 Reduce method size
- 3.4 Enhance identifier naming
- 3.5 Considerations related to the quick-wins stage
4. Stage 2: Divide and Conquer
- 4.1 Coupling and Cohesion
- 4.2 Modules, components, services, or micro-services?
- 4.3 Moving from spaghetti to structured code
- 4.4 Types of software components - Strategies for code decomposition
- 4.5 Considerations while breaking code apart
5. Stage 3: Inject Quality In
- 5.1 Which type of tests?
- 5.2 Tracking coverage
6. Continuous Inspection Throughout the Roadmap
- 6.1 Why continuous inspection is important?
- 6.2 Which conventions should be put under continuous inspection?
- 6.3 Example: Using Jenkins and ConQAT to enable continuous clone detection
7. Measuring Code Quality and Reporting Progress
- 7.1 Useful code metrics
- 7.2 Making sense of code metrics
- 7.3 Examples of progress/quality indicators
- 7.4 Using code metrics for team evaluation
- 8. Starting a New Project? Important Considerations
- 9. Tools of Great Help
Catalogue of Useful Refactorings
- Quick-wins stage
- Divide and conquer stage
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms...