Sha256: 398417eb284559cfbb949a93732184ef176e607312a058c03262d46186a6ecf8
Contents?: true
Size: 1.65 KB
Versions: 12
Compression:
Stored size: 1.65 KB
Contents
require 'set'
require 'reek/smells/smell_detector'
require 'reek/smell_warning'
module Reek
module Smells
#
# Class variables form part of the global runtime state, and as such make
# it easy for one part of the system to accidentally or inadvertently
# depend on another part of the system. So the system becomes more prone to
# problems where changing something over here breaks something over there.
# In particular, class variables can make it hard to set up tests (because
# the context of the test includes all global state).
#
class ClassVariable < SmellDetector
def self.contexts # :nodoc:
[:class, :module]
end
#
# Checks whether the given class or module declares any class variables.
#
# @return [Array<SmellWarning>]
#
def examine_context(ctx)
class_variables_in(ctx.exp).map do |variable, lines|
SmellWarning.new self,
context: ctx.full_name,
lines: lines,
message: "declares the class variable #{variable}",
parameters: { name: variable.to_s }
end
end
#
# Collects the names of the class variables declared and/or used
# in the given module.
#
def class_variables_in(ast)
result = Hash.new { |hash, key| hash[key] = [] }
collector = proc do |cvar_node|
result[cvar_node.name].push(cvar_node.line)
end
[:cvar, :cvasgn, :cvdecl].each do |stmt_type|
ast.each_node(stmt_type, [:class, :module], &collector)
end
result
end
end
end
end
Version data entries
12 entries across 12 versions & 1 rubygems