microformats-ruby icon indicating copy to clipboard operation
microformats-ruby copied to clipboard

Published 20 hours ago • verified publisher icon microformats

Improve code clarity

Open dissolve opened this issue 8 years ago • 3 comments

getting a code climate score of 0.7, which is pretty abysmal. While i don't agree with all of the rules they use, there is a lot of work that can be done to improve the readability of the code base.

dissolve avatar May 22 '17 14:05 dissolve

i have a branch called rubocop-cleanup which is tackling this.

However I wanted to discuss with @jgarber623 the thoughts on what defines a breaking change.

I am adding a new class that all of the results classes inherit from. technically someone could be testing for the name of the class's direct parent. It would be very foolish to do so, but this could potentially break things for them. It seems like a really obscure case that should not be done anyway.

dissolve avatar Aug 23 '18 10:08 dissolve

Version numbers are cheap, so I'm totally fine if we want to play it safe and flag to users of the gem the potential for breakage (edge case usage notwithstanding).

Good refactoring on that results class, too. 👍

jgarber623 avatar Aug 23 '18 19:08 jgarber623

☝🏻 The implication there being that the next release of the gem would be 5.0.0.

jgarber623 avatar Aug 23 '18 20:08 jgarber623