Kasper Timm Hansen / is on Nostr

On the Rails core team 2016-2022, now helping Rails shops upgrade their code quality

github: https://github.com/kaspth
discord: http://discord.gg/NNN3TAD5jQ

Last Notes

2024-06-11 20:00:05

- reply

oh I wasn't gonna suggest a comment based construct. I just meant the `def section` method I've been talking about 😊

2024-06-11 14:19:43

- reply

That's really interesting! I think that kind of stuff might be easier to do with having the construct in Ruby itself — but I keep dawdling on trying to submit section to Ruby.

2024-06-11 14:19:43

- reply

That's really interesting! I think that kind of stuff might be easier to do with having the construct in Ruby itself — but I keep dawdling on trying to submit section to Ruby.

2024-06-09 18:02:05

- reply

I didn't know YARD groups existed 😄
In my case I purposefully didn't want to use comments/documentation for this, since when I'm just trying to get the lay of the land in a new file and I'm skimming/parsing methods and their overall structure, my eye would skip over them.

2024-06-09 18:02:05

- reply

2024-06-09 17:25:06

- reply

I find all of what you said really interesting!
Another alternative I've been exploring is a purely decorative method that I call `section`: https://github.com/kaspth/oaken/blob/74488f7b2656ea09cae68b844816c8db0bb5e98b/lib/oaken/seeds.rb#L70
In addition to the documentation suggestion above, I'm also playing around with them in here: https://github.com/kaspth/oaken/blob/74488f7b2656ea09cae68b844816c8db0bb5e98b/test/dummy/db/seeds/accounts/kaspers_donuts.rb
You can deeply-nest `section`s too, maybe that'd help with your second/third level of importance?

2024-06-09 17:25:06

- reply

2024-06-08 15:51:02

- reply

I've also been liking endless methods to help communicate if a helper method is really only intended to be used be another method, similar to the Keygen getter/setter example. Like this:
private
def verifier
MessageVerifier.new key
end
def key = Rails.application.key_generator.generate_key("name")

2024-06-06 21:56:51

- reply

I love all the varied examples!
I've started liking it for methods with an outer block too:
def run = transaction do
other_code
end
It feels really good to save the extra indentation layer