Sha256: 7846b6e9b28a1f41edf08af4cd5f2bfd5d50ed76a3149cb3a71c613b99a837c9
Contents?: true
Size: 1.7 KB
Versions: 13
Compression:
Stored size: 1.7 KB
Contents
require 'set'
require_relative 'smell_detector'
require_relative '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).
#
# See {file:docs/Class-Variable.md} for details.
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 inspect(ctx)
class_variables_in(ctx.exp).map do |variable, lines|
smell_warning(
context: ctx,
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.
#
# :reek:TooManyStatements: { max_statements: 7 }
# :reek:FeatureEnvy
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
13 entries across 13 versions & 1 rubygems