Possible false positive on UtilityFunction

[guillermoap]

Hello,

The method process_file is triggering the UtilityFunction.
This is a helper module, why is it complaining about it not depending on the instance state?

module RepositoryHelper
  CLONE_PATH = Rails.root.join('tmp').to_s
  LOGGER = Rails.logger
  
  ...
  
  def process_file(path, pattern_name, sub_options = [])
    IO.write(path, File.open(path) { |file| file.read.gsub(*sub_options) })
    LOGGER.info("Substituted #{pattern_name} in #{path}")
  end
end

[troessner]

Yeah, that was a design decision we took a loooong time ago and it surely was a controversial one ;)
In short, we consider helper modules smelly by definition, hence Reek raises an alert. For more details see here.

You can either disable raising an alert for these methods via magic comment or if you want to disable it for that whole file tweak your Reek configuration like detailed here, e.g. in your case by adding

---
detectors:
  UtilityFunction:
    exclude:
      - "RepositoryHelper#process_file" 

[mvz]

Also see https://github.com/troessner/reek#working-with-rails

[guillermoap]

Didn't know that, thanks for the suggestion. I ended up disabling it.

Thanks for the help. Closing this