Sha256: fde78f884d51b95d99ab8a70114a92dfae5a2496c7d97681e700567c4d034193
Contents?: true
Size: 1.81 KB
Versions: 3
Compression:
Stored size: 1.81 KB
Contents
require 'reek/smells/smell_detector' require 'reek/smell_warning' module Reek module Smells # Excerpt from: # http://dablog.rubypal.com/2007/8/15/bang-methods-or-danger-will-rubyist # since this sums it up really well: # # The ! in method names that end with ! means, "This method is dangerous" # -- or, more precisely, this method is the "dangerous" version of an # equivalent method, with the same name minus the !. "Danger" is # relative; the ! doesn't mean anything at all unless the method name # it's in corresponds to a similar but bang-less method name. # # Don't add ! to your destructive (receiver-changing) methods' names, # unless you consider the changing to be "dangerous" and you have a # "non-dangerous" equivalent method without the !. If some arbitrary # subset of destructive methods end with !, then the whole point of ! # gets distorted and diluted, and ! ceases to convey any information # whatsoever. # # Such a method is called PrimaDonnaMethod and is reported as a smell. # class PrimaDonnaMethod < SmellDetector SMELL_CLASS = smell_class_name SMELL_SUBCLASS = smell_class_name def self.contexts [:class] end def examine_context(ctx) ctx.node_instance_methods.map do |method_sexp| next unless method_sexp.ends_with_bang? version_without_bang = ctx.node_instance_methods.find do |sexp_item| sexp_item.name.to_s == method_sexp.name_without_bang end next if version_without_bang SmellWarning.new(SMELL_CLASS, ctx.full_name, [ctx.exp.line], "has prima donna method `#{method_sexp.name}`", @source, SMELL_SUBCLASS) end.compact end end end end
Version data entries
3 entries across 3 versions & 1 rubygems
Version | Path |
---|---|
reek-1.5.1 | lib/reek/smells/prima_donna_method.rb |
reek-1.5.0 | lib/reek/smells/prima_donna_method.rb |
reek-1.4.0 | lib/reek/smells/prima_donna_method.rb |