· 3 min read
When objects become super objects
A pencil. We use a pencil to write. And that’s it. (Let’s forget about some pencils that come with an eraser in one end, in this world they don’t exist)
We are in the “digital transformation” era, right? So I came up with the idea of including a simple scanner in the body of the pencil, to be able to digitalize everything written with the pencil. It’s really handy!
I always struggled to share my technical drawings when exchanging thoughts in groups, so I think a mini projector on top of the pencil would be a great addition. It’s amazing, I can show my drawings directly in the wall, no need for any external projector!
Oh, and a laser pointer on it. You know, everyone loves playing with lasers.
We call it The Pencil 3000 ™
Let’s stop here. I’ve experienced this very same line of thinking when creating/updating classes.
Multiple responsibility classes: Real life examples
These are the places where I’ve encountered myself working with this approach:
CTMPS means “comment to my past self”.
Several times I wrote methods in the model that were only being used in the views. CTMPS: It’d be better to use a presenter object for those.
Numerous times I found myself writing callback methods in the model, with the purpose of sending emails or adding default values in the model. CTMPS: Sending emails seems like a side effect of a user action, why don’t trigger them in the controller instead? And about setting default values, what about setting them using the ActiveRecord::Attributes API?
Don’t get me started with inline validation methods. This I one I abused. I’m sorry. CTMPS: There are no taxes for new classes, create a validator class and be done with it. Peace out.
2. Form objects
Select tags with options that are not DB backed. Guilty. I more than once wrote a method in the form object to provide the options to be used in the select tag, in the view. CTMPS: It’s ok no big deal, but what about using a presenter object for this? Given it’s a view-only matter.
At this point it feels like I’m seeking absolution from my sins. Hopefully you haven’t experienced any of these. But in any case, let me share you one more example.
3. Page objects
Testing usually requires 4 steps: setup, exercise, assertions and teardown. And when testing web applications, end users interact with HTML documents. Enter page objects. So we use page objects to wrap the HTML and provide a meaningful API to be used in test code. This includes the exercise and assertion steps of testing. But I gotta be honest, it is so easy and pleasant to just write a new method into the page object to do the setup and create instances, update stuff, set up environment variables and whatever needed for our tests to run. CTMPS: It’s as easy and pleasant to extract the creational part into a support module in your specs, and keep your page objects fulfilling their true purpose.
Remember The Pencil 3000™? I can’t imagine how would I sharp the pencil, with all that stuff around it.
“[…] each software module should have one and only one reason to change.” Better read it from here