Are we tired with code smells? Not yet! We see several symptoms and situations that make us doubt the quality of our development. Let's look at some possible . solutions Most of these smells are just hints of something that might be wrong. They are not rigid rules. This is part V. Part I can be found , Part II , Part III is , Part IV and (for now). here here here here the last one Let's continue... Code Smell 26 — Exceptions Polluting It is very nice to have lots of different exceptions. Your code is declarative and robust. Or not? Photo by Nick van den Berg on Unsplash Problems Over Design Namespace Pollution Solutions Avoid creating exceptions as globals. anemic Create exceptions only if they behave differently. Model exceptions with objects. Classes are handy for lazy programmers. Sample Code Wrong Right Detection New exceptions should override behavior methods. No. , , , etc are not behavioral. code description resumable Tags Abuser Naming Conclusion You would not create different classes for every Person instance, so they return different names. Why would you do it with exceptions. How often do you catch a specific exception?. Go out and check your code. Is it necessary to be a class? You are already coupled to the class. Couple to the description instead. Exception instances should NOT be . Singletons You will fall to ruin because you believe that exceptions to the rule make new rules. Pierce Brown Code Smell 27 — Associative Arrays [Key, values], magic, fast, malleable and error prune. Photo by Melissa Askew on Unsplash Problems Coupling Information Hiding Code Duplication Fail Fast Integrity Solutions Reify objects Create cohesive small objects. Don’t leave them anemic, find their cohesive relations. Sample Code Wrong Anemic Validated Right Degrees deserves reification Many people suffer from primitive obsession and believe this is over design. Designing software is about making decisions and comparing trade-offs. The performance argument is not valid nowadays since modern virtual machines can efficiently deal with small short-lived objects. Detection We cannot forbid Associative Arrays since they are very good as a first approach. They will be fine for exporting data, serialization, persistence and other accidental implementation issues. We should avoid them on our systems. Tags Primitive Conclusion When creating objects we must not think of them as . This is a common misconception. data We should stay loyal to our and discover real world objects. Bijection Most associative arrays have cohesion and represent real world entities, and we must treat them as first class objects. There’s nothing more permanent than a temporary hack. Kyle Simpson Code Smell 28 — Setters The first exercise junior programmers do. IDEs, tutorials and senior developers keep teaching them this anti-pattern. Photo by Victor Rodriguez on Unsplash Problems Mutability Information Hiding Anemic Models Fail Fast Integrity Duplicated Code Solutions Avoid Setters Set essential attributes on private initialization. Sample Code Wrong Mutation brings lots of problems Information Hiding Violated Right Detection First step will be to forbid public attributes (if language allows them). Secondly, we will search for methods , analyzing method structure (should be an assignment to attribute ). setXXXX() xxxx We should not forbid methods setting since this is valid. They should not be named since they ask the object to , but they don’t anything. accidental state setters change set Examples DTOs Exceptions Setting attributes is safe for attributes. non-essential is what distinguishes one object from another. Essential behavior It is related to behavior and not . It’s not a definition. data primary key Some patterns, like require setting the parts in a controlled, incremental way. Validations are done at the end and the requires it. Builder real entity metaphor Setting values has many drawbacks and considerations already mentioned. accidental Tags Mutation Information Hiding Conclusion Creating incomplete and anemic objects is a very bad practice violating mutability, fail fast principle and real world . bijections More Info Fail Fast Philosophy, Explained Here is the full discussion on Setters Nude Models - Part I : Setters Object-oriented programming languages support encapsulation, thereby improving the ability of software to be reused, refined, tested, maintained, and extended. The full benefit of this support can only be realized if encapsulation is maximized during the design process. Rebecca Wirfs-Brock Code Smell 29 — Settings/Configs Changing system behavior in a control board is the customer’s dream. And the software engineer’s nightmare. Problems Duplicated Code If Pollution Global usage Coupling Testability and explosion of testing scenarios. Complexity Solutions Avoid Settings Create polymorphic objects. Inject them externally. Sample Code Wrong Right Detection This is an architectural pattern so it should be controlled/avoided by design policies. Examples External Connection Settings User settings Feature Toggle Exceptions Sometimes we use Feature togging as a safeguard mechanism. This is acceptable in a legacy system. These toggles should be very short-lived in a system. CI/CD Hyper parameter settings should be managed by configuration objects. Tags Globals Conclusion Setting runtime behavior is great for software systems. We should configure our objects, so they can behave in different ways, and we should achieve it in an explicit way with explicit behavioral objects. In this way, our code will be more declarative, clean and testable. It is not as easy as adding an . This kind of lazy developers bring lots of coupling and unexpected issues on our systems. IF Statement A system with 300 Boolean configurations has more test combinations (2^300), than the number of atoms in the universe (10^80). Also known as Feature Toggles More Info How to Get Rid of Annoying IFs Forever Simplicity is the soul of efficiency. Austin Freeman Code Smell 30 — Mocking Business Mocking is a great aid when testing behavior. Like with many other tools, we are abusing them. Photo by Syed Ahmad on Unsplash Problems Complexity False sense of security. Parallel/Duplicated objects (Real and Mocks) Maintainability Solutions just non-business entities. Mock Remove mock if its interface has too much behavior. Sample Code Wrong Right Detection This is an architectural pattern. It will not be easy to create an automatic detection rule. Exceptions Mocking accidental problems (serialization, databases, APIs) is a very good practice to avoid coupling. Tags Abuser Conclusion Mocks, like many other test doubles are excellent tools. Choosing wisely when to use them is an art. Imagine a play in which each actor, instead of rehearsing with other actors, had to interact with 25 scriptwriters. The actors would never rehearse together. How would the result of the play be? Also Known as Faker The pesticide paradox. Every method you use to prevent or find bugs leaves a residue of subtler bugs against which those methods are ineffective. Boris Beizer This is a never ending article. I hope, in a couple of decades, this series could be a piece of ancient history and old deprecated memories.

Different

Keep

How to Find The Stinky Parts of Your Code (Part VII)

How to Find the Stinky Parts of Your Code (Part V)

Buy My Book

Share your ideas with me!

Read My Stories

Buy Me a Coffee

Too Long; Didn't Read

Make resilience your competitive advantage

How to Find The Stinky Parts of Your Code (Part VI)

How to Find The Stinky Parts of Your Code (Part VI)

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

Untitled Story

Code Smell 309 - Query Parameter API Versioning

106 Stories To Learn About Clean Code

100 Pieces of Programming Advice from the Book Clean Code by Robert Martin

110 Stories To Learn About Refactoring

3 Things Coding And Prose Writing Have In Common According To Cory House

Code Smell 309 - Query Parameter API Versioning

106 Stories To Learn About Clean Code

100 Pieces of Programming Advice from the Book Clean Code by Robert Martin

110 Stories To Learn About Refactoring

3 Things Coding And Prose Writing Have In Common According To Cory House

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps