reek 2.1.0 → 2.2.0

data/lib/reek/smells.rb

@@ -1,6 +1,8 @@
-require 'require_all'
+require 'pathname'
 
-require_rel 'smells'
+(Pathname.new(__FILE__).dirname + 'smells').children.each do |path|
+  require_relative "smells/#{path.basename('.rb')}"
+end
 
 module Reek
   #

data/lib/reek/smells/attribute.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 require_relative '../core/smell_configuration'
 
 module Reek
@@ -13,10 +12,20 @@ module Reek
     # +attr_reader+, +attr_writer+ and +attr_accessor+ -- including those
     # that are private.
     #
-    # TODO: Eliminate private attributes
     # TODO: Catch attributes declared "by hand"
+    # See docs/Attribute for details.
     #
     class Attribute < SmellDetector
+      ATTR_DEFN_METHODS = [:attr, :attr_reader, :attr_writer, :attr_accessor]
+      VISIBILITY_MODIFIERS = [:private, :public, :protected]
+
+      def initialize(*args)
+        @visiblity_tracker = {}
+        @visiblity_mode = :public
+        @result = Set.new
+        super
+      end
+
       def self.contexts # :nodoc:
         [:class, :module]
       end
@@ -43,14 +52,33 @@ module Reek
       private
 
       def attributes_in(module_ctx)
-        result = Set.new
-        attr_defn_methods = [:attr, :attr_reader, :attr_writer, :attr_accessor]
         module_ctx.local_nodes(:send) do |call_node|
-          if attr_defn_methods.include?(call_node.method_name)
-            call_node.arg_names.each { |arg| result << [arg, call_node.line] }
+          if visibility_modifier?(call_node)
+            track_visibility(call_node)
+          elsif ATTR_DEFN_METHODS.include?(call_node.method_name)
+            call_node.arg_names.each do |arg|
+              @visiblity_tracker[arg] = @visiblity_mode
+              @result << [arg, call_node.line]
+            end
           end
         end
-        result
+        @result.select { |args| recorded_public_methods.include?(args[0]) }
+      end
+
+      def visibility_modifier?(call_node)
+        VISIBILITY_MODIFIERS.include?(call_node.method_name)
+      end
+
+      def track_visibility(call_node)
+        if call_node.arg_names.any?
+          call_node.arg_names.each { |arg| @visiblity_tracker[arg] = call_node.method_name }
+        else
+          @visiblity_mode = call_node.method_name
+        end
+      end
+
+      def recorded_public_methods
+        @visiblity_tracker.select { |_, visbility| visbility == :public }
       end
     end
   end

data/lib/reek/smells/boolean_parameter.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -11,6 +10,7 @@ module Reek
     # Currently Reek can only detect a Boolean parameter when it has a
     # default initializer.
     #
+    # See docs/Boolean-Parameter for details.
     class BooleanParameter < SmellDetector
       def self.smell_category
         'ControlCouple'

data/lib/reek/smells/class_variable.rb

@@ -1,6 +1,5 @@
 require 'set'
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -12,6 +11,7 @@ module Reek
     # In particular, class variables can make it hard to set up tests (because
     # the context of the test includes all global state).
     #
+    # See docs/Class-Variable for details.
     class ClassVariable < SmellDetector
       def self.contexts # :nodoc:
         [:class, :module]

data/lib/reek/smells/control_parameter.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -40,6 +39,7 @@ module Reek
     # that remains next to where the caller invokes it in
     # the source code.
     #
+    # See docs/Control-Parameter for details.
     class ControlParameter < SmellDetector
       def self.smell_category
         'ControlCouple'

data/lib/reek/smells/data_clump.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -15,6 +14,7 @@ module Reek
     # Currently Reek looks for a group of two or more parameters with
     # the same names that are expected by three or more methods of a class.
     #
+    # See docs/Data-Clump for details.
     class DataClump < SmellDetector
       #
       # The name of the config field that sets the maximum allowed

data/lib/reek/smells/duplicate_method_call.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -16,6 +15,7 @@ module Reek
     #     @other.thing + @other.thing
     #   end
     #
+    # See docs/Duplicate-Method-Call for details.
     class DuplicateMethodCall < SmellDetector
       # The name of the config field that sets the maximum number of
       # identical calls to be permitted within any single method.
@@ -70,7 +70,7 @@ module Reek
         end
 
         def call
-          @call ||= @call_node.format_ruby
+          @call ||= @call_node.format_to_ruby
         end
 
         def occurs
@@ -106,8 +106,8 @@ module Reek
 
         def collect_calls(result)
           context.each_node(:send, [:mlhs]) do |call_node|
-            next if call_node.method_name == :new
-            next if !call_node.receiver && call_node.args.empty?
+            next if initializer_call? call_node
+            next if simple_method_call? call_node
             result[call_node].record(call_node)
           end
           context.local_nodes(:block) do |call_node|
@@ -119,6 +119,14 @@ module Reek
           found_call.occurs > @max_allowed_calls && !allow_calls?(found_call.call)
         end
 
+        def simple_method_call?(call_node)
+          !call_node.receiver && call_node.args.empty?
+        end
+
+        def initializer_call?(call_node)
+          call_node.method_name == :new
+        end
+
         def allow_calls?(method)
           @allow_calls.any? { |allow| /#{allow}/ =~ method }
         end

data/lib/reek/smells/feature_envy.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -33,6 +32,7 @@ module Reek
     # If the method doesn't reference self at all, +UtilityFunction+ is
     # reported instead.
     #
+    # See docs/Feature-Envy for details.
     class FeatureEnvy < SmellDetector
       def self.smell_category
         'LowCohesion'

data/lib/reek/smells/irresponsible_module.rb

@@ -1,6 +1,5 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
-require_relative '../source/code_comment'
+require_relative '../core/code_comment'
 
 module Reek
   module Smells
@@ -8,6 +7,7 @@ module Reek
     # It is considered good practice to annotate every class and module
     # with a brief comment outlining its responsibilities.
     #
+    # See docs/Irresponsible-Module for details.
     class IrresponsibleModule < SmellDetector
       def self.contexts # :nodoc:
         [:class]
@@ -23,7 +23,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def examine_context(ctx)
-        comment = Source::CodeComment.new(ctx.exp.comments)
+        comment = Core::CodeComment.new(ctx.exp.comments)
         return [] if self.class.descriptive[ctx.full_name] ||= comment.descriptive?
         [SmellWarning.new(self,
                           context: ctx.full_name,

data/lib/reek/smells/long_parameter_list.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 require_relative '../core/smell_configuration'
 
 module Reek
@@ -12,6 +11,7 @@ module Reek
     # Currently +LongParameterList+ reports any method or block with too
     # many parameters.
     #
+    # See docs/Long-Parameter-List for details.
     class LongParameterList < SmellDetector
       # The name of the config field that sets the maximum number of
       # parameters permitted in any method or block.

data/lib/reek/smells/long_yield_list.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -7,6 +6,7 @@ module Reek
     # A variant on LongParameterList that checks the number of items
     # passed to a block by a +yield+ call.
     #
+    # See docs/Long-Yield-List for details.
     class LongYieldList < SmellDetector
       # The name of the config field that sets the maximum number of
       # parameters permitted in any method or block.

data/lib/reek/smells/module_initialize.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -8,6 +7,7 @@ module Reek
     # hard to tell initialization order and parameters so having 'initialize'
     # in a module is usually a bad idea
     #
+    # See docs/Module-Initialize for details.
     class ModuleInitialize < SmellDetector
       def self.contexts # :nodoc:
         [:module]

data/lib/reek/smells/nested_iterators.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -8,6 +7,7 @@ module Reek
     #
     # +NestedIterators+ reports failing methods only once.
     #
+    # See docs/Nested-Iterators for details.
     class NestedIterators < SmellDetector
       # The name of the config field that sets the maximum depth
       # of nested iterators to be permitted within any single method.

data/lib/reek/smells/nil_check.rb

@@ -1,10 +1,11 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
     # Checking for nil is a special kind of type check, and therefore a case of
     # SimulatedPolymorphism.
+    #
+    # See docs/Nil-Check for details.
     class NilCheck < SmellDetector
       def self.smell_category
         'SimulatedPolymorphism'
@@ -19,7 +20,7 @@ module Reek
           SmellWarning.new self,
                            context: ctx.full_name,
                            lines: [node.line],
-                           message: 'performs a nil-check.'
+                           message: 'performs a nil-check'
         end
       end
 

data/lib/reek/smells/prima_donna_method.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -22,6 +21,7 @@ module Reek
     #
     # Such a method is called PrimaDonnaMethod and is reported as a smell.
     #
+    # See docs/Prima-Donna-Method for details.
     class PrimaDonnaMethod < SmellDetector
       def self.contexts # :nodoc:
         [:class]
@@ -29,18 +29,25 @@ module Reek
 
       def examine_context(ctx)
         ctx.node_instance_methods.map do |method_sexp|
-          next unless method_sexp.ends_with_bang?
+          check_for_smells(method_sexp, ctx)
+        end.compact
+      end
 
-          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
+      private
 
-          SmellWarning.new self,
-                           context: ctx.full_name,
-                           lines: [ctx.exp.line],
-                           message: "has prima donna method `#{method_sexp.name}`"
-        end.compact
+      def check_for_smells(method_sexp, ctx)
+        return 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
+
+        return if version_without_bang
+
+        SmellWarning.new self,
+                         context: ctx.full_name,
+                         lines: [ctx.exp.line],
+                         message: "has prima donna method `#{method_sexp.name}`"
       end
     end
   end

data/lib/reek/smells/repeated_conditional.rb

@@ -1,6 +1,5 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
-require_relative '../source/ast_node'
+require_relative '../core/ast_node'
 
 module Reek
   module Smells
@@ -23,6 +22,7 @@ module Reek
     # +RepeatedConditional+ checks for multiple conditionals
     # testing the same value throughout a single class.
     #
+    # See docs/Repeated-Conditional for details.
     class RepeatedConditional < SmellDetector
       # The name of the config field that sets the maximum number of
       # identical conditionals permitted within any single class.
@@ -54,7 +54,7 @@ module Reek
           lines.length > @max_identical_ifs
         end.map do |key, lines|
           occurs = lines.length
-          expression = key.format_ruby
+          expression = key.format_to_ruby
           SmellWarning.new self,
                            context: ctx.full_name,
                            lines: lines,

data/lib/reek/smells/smell_detector.rb

@@ -1,5 +1,4 @@
 require 'set'
-require_relative '../smell_warning'
 require_relative '../core/smell_configuration'
 
 module Reek
@@ -7,6 +6,11 @@ module Reek
     #
     # Shared responsibilities of all smell detectors.
     #
+    # See
+    #   - docs/Basic-Smell-Options
+    #   - docs/Code-Smells
+    #   - docs/Configuration-Files
+    # for details.
     class SmellDetector
       attr_reader :source
 

data/lib/reek/smells/smell_warning.rb

@@ -0,0 +1,99 @@
+require 'forwardable'
+
+module Reek
+  module Smells
+    #
+    # Reports a warning that a smell has been found.
+    #
+    class SmellWarning
+      include Comparable
+      extend Forwardable
+      attr_accessor :smell_detector, :context, :lines, :message, :parameters
+      def_delegators :smell_detector, :smell_category, :smell_type, :source
+
+      def initialize(smell_detector, options = {})
+        self.smell_detector = smell_detector
+        self.context        = options.fetch(:context, '').to_s
+        self.lines          = options.fetch(:lines)
+        self.message        = options.fetch(:message)
+        self.parameters     = options.fetch(:parameters, {})
+      end
+
+      def smell_classes
+        [smell_detector.smell_category, smell_detector.smell_type]
+      end
+
+      def hash
+        sort_key.hash
+      end
+
+      def <=>(other)
+        sort_key <=> other.sort_key
+      end
+
+      def eql?(other)
+        (self <=> other) == 0
+      end
+
+      def matches?(klass, other_parameters = {})
+        smell_classes.include?(klass.to_s) && common_parameters_equal?(other_parameters)
+      end
+
+      def report_on(listener)
+        listener.found_smell(self)
+      end
+
+      def yaml_hash(warning_formatter = nil)
+        stringified_params = Hash[parameters.map { |key, val| [key.to_s, val] }]
+        core_yaml_hash.
+          merge(stringified_params).
+          merge(wiki_link_hash(warning_formatter))
+      end
+
+      protected
+
+      def sort_key
+        [context, message, smell_category]
+      end
+
+      private
+
+      def common_parameters_equal?(other_parameters)
+        other_parameters.keys.each do |key|
+          unless parameters.key?(key)
+            raise ArgumentError, "The parameter #{key} you want to check for doesn't exist"
+          end
+        end
+
+        # Why not check for strict parameter equality instead of just the common ones?
+        #
+        # In `self`, `parameters` might look like this:  {:name=>"@other.thing", :count=>2}
+        # Coming from specs, 'other_parameters' might look like this, e.g.:
+        # {:name=>"@other.thing"}
+        # So in this spec we are just specifying the "name" parameter but not the "count".
+        # In order to allow for this kind of leniency we just test for common parameter equality,
+        # not for a strict one.
+        parameters.values_at(*other_parameters.keys) == other_parameters.values
+      end
+
+      def core_yaml_hash
+        {
+          'context'        => context,
+          'lines'          => lines,
+          'message'        => message,
+          'smell_category' => smell_detector.smell_category,
+          'smell_type'     => smell_detector.smell_type,
+          'source'         => smell_detector.source
+        }
+      end
+
+      def wiki_link_hash(warning_formatter)
+        if warning_formatter.respond_to?(:explanatory_link)
+          { 'wiki_link' => warning_formatter.explanatory_link(smell_detector) }
+        else
+          {}
+        end
+      end
+    end
+  end
+end