reek 2.0.4 → 2.1.0

data/lib/reek/smells/duplicate_method_call.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/feature_envy.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -30,6 +30,9 @@ module Reek
     # Currently +FeatureEnvy+ reports any method that refers to self less
     # often than it refers to (ie. send messages to) some other object.
     #
+    # If the method doesn't reference self at all, +UtilityFunction+ is
+    # reported instead.
+    #
     class FeatureEnvy < SmellDetector
       def self.smell_category
         'LowCohesion'
@@ -42,6 +45,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def examine_context(method_ctx)
+        return [] unless method_ctx.references_self?
         method_ctx.envious_receivers.map do |ref, occurs|
           target = ref.to_s
           SmellWarning.new self,

data/lib/reek/smells/irresponsible_module.rb

@@ -1,6 +1,6 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
-require 'reek/source/code_comment'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
+require_relative '../source/code_comment'
 
 module Reek
   module Smells

data/lib/reek/smells/long_parameter_list.rb

@@ -1,6 +1,6 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
-require 'reek/core/smell_configuration'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
+require_relative '../core/smell_configuration'
 
 module Reek
   module Smells

data/lib/reek/smells/long_yield_list.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/module_initialize.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/nested_iterators.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/nil_check.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/prima_donna_method.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/repeated_conditional.rb

@@ -1,5 +1,6 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
+require_relative '../source/ast_node'
 
 module Reek
   module Smells

data/lib/reek/smells/smell_detector.rb

@@ -1,6 +1,6 @@
 require 'set'
-require 'reek/smell_warning'
-require 'reek/core/smell_configuration'
+require_relative '../smell_warning'
+require_relative '../core/smell_configuration'
 
 module Reek
   module Smells

data/lib/reek/smells/too_many_instance_variables.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/too_many_methods.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/too_many_statements.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/uncommunicative_method_name.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/uncommunicative_module_name.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/uncommunicative_parameter_name.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/unused_parameters.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/utility_function.rb

@@ -1,6 +1,6 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
-require 'reek/source/reference_collector'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
+require_relative '../source/reference_collector'
 
 module Reek
   module Smells
@@ -32,13 +32,16 @@ module Reek
     # reified into a class, and the utility method will most
     # likely belong there.
     #
+    # If the method does refer to self, but refers to some other object more,
+    # +FeatureEnvy+ is reported instead.
+    #
     class UtilityFunction < SmellDetector
       # The name of the config field that sets the maximum number of
       # calls permitted within a helper method. Any method with more than
       # this number of method calls on other objects will be considered a
       # candidate Utility Function.
       HELPER_CALLS_LIMIT_KEY = 'max_helper_calls'
-      DEFAULT_HELPER_CALLS_LIMIT = 1
+      DEFAULT_HELPER_CALLS_LIMIT = 0
 
       def self.smell_category
         'LowCohesion'
@@ -61,7 +64,7 @@ module Reek
       #
       def examine_context(method_ctx)
         return [] if method_ctx.num_statements == 0
-        return [] if depends_on_instance?(method_ctx.exp)
+        return [] if method_ctx.references_self?
         return [] if num_helper_methods(method_ctx) <= value(HELPER_CALLS_LIMIT_KEY,
                                                              method_ctx,
                                                              DEFAULT_HELPER_CALLS_LIMIT)
@@ -75,10 +78,6 @@ module Reek
 
       private
 
-      def depends_on_instance?(exp)
-        Reek::Source::ReferenceCollector.new(exp).num_refs_to_self > 0
-      end
-
       def num_helper_methods(method_ctx)
         method_ctx.local_nodes(:send).length
       end

data/lib/reek/source/ast_node.rb

@@ -4,7 +4,7 @@ module Reek
   module Source
     # Base class for AST nodes extended with utility methods. Contains some
     # methods to ease the transition from Sexp to AST::Node.
-    class AstNode < Parser::AST::Node
+    class ASTNode < Parser::AST::Node
       def initialize(type, children = [], options = {})
         @comments = options.fetch(:comments, [])
         super

data/lib/reek/source/ast_node_class_map.rb

@@ -1,12 +1,12 @@
-require 'reek/source/ast_node'
-require 'reek/source/sexp_node'
-require 'reek/source/sexp_extensions'
+require_relative 'ast_node'
+require_relative 'sexp_node'
+require_relative 'sexp_extensions'
 
 module Reek
   module Source
-    # Maps AST node types to sublasses of AstNode extended with the relevant
+    # Maps AST node types to sublasses of ASTNode extended with the relevant
     # utility modules.
-    class AstNodeClassMap
+    class ASTNodeClassMap
       def initialize
         @klass_map = {}
       end
@@ -14,7 +14,7 @@ module Reek
       def klass_for(type)
         @klass_map[type] ||=
           begin
-            klass = Class.new(AstNode)
+            klass = Class.new(ASTNode)
             klass.send :include, extension_map[type] if extension_map[type]
             klass.send :include, SexpNode
           end

data/lib/reek/source/sexp_extensions.rb

@@ -1,9 +1,10 @@
-require 'reek/source/sexp_node'
+require_relative 'sexp_node'
+require_relative 'reference_collector'
 
 module Reek
   module Source
     #
-    # Extension modules providing utility methods to AstNode objects, depending
+    # Extension modules providing utility methods to ASTNode objects, depending
     # on their type.
     #
     module SexpExtensions
@@ -239,6 +240,10 @@ module Reek
           prefix = outer == '' ? '' : "#{outer}#"
           "#{prefix}#{name}"
         end
+
+        def depends_on_instance?
+          ReferenceCollector.new(self).num_refs_to_self > 0
+        end
       end
 
       # Utility methods for :defs nodes.
@@ -256,6 +261,10 @@ module Reek
           prefix = outer == '' ? '' : "#{outer}#"
           "#{prefix}#{SexpNode.format(receiver)}.#{name}"
         end
+
+        def depends_on_instance?
+          false
+        end
       end
 
       # Utility methods for :if nodes.

data/lib/reek/source/source_code.rb

@@ -1,8 +1,8 @@
 old_verbose, $VERBOSE = $VERBOSE, nil
 require 'parser/current'
 $VERBOSE = old_verbose
-require 'reek/source/tree_dresser'
-require 'reek/source/ast_node'
+require_relative 'tree_dresser'
+require_relative 'ast_node'
 
 module Reek
   module Source
@@ -18,6 +18,14 @@ module Reek
         @parser = parser
       end
 
+      def self.from(source)
+        case source
+        when File   then new(source.read, source.path)
+        when IO     then new(source.readlines.join, 'STDIN')
+        when String then new(source, 'string')
+        end
+      end
+
       def syntax_tree
         @syntax_tree ||=
           begin

data/lib/reek/source/source_locator.rb

@@ -1,5 +1,3 @@
-require 'reek/source/core_extras'
-
 module Reek
   module Source
     #
@@ -11,7 +9,7 @@ module Reek
       end
 
       def all_sources
-        valid_paths.map { |path| File.new(path).to_reek_source }
+        valid_paths.map { |path| Source::SourceCode.from File.new(path) }
       end
 
       private

data/lib/reek/source/source_repository.rb

@@ -1,6 +1,5 @@
-require 'reek/source/core_extras'
-require 'reek/source/source_code'
-require 'reek/source/source_locator'
+require_relative 'source_code'
+require_relative 'source_locator'
 
 module Reek
   module Source
@@ -24,7 +23,7 @@ module Reek
         when Source::SourceCode
           new source.desc, [source]
         else
-          src = source.to_reek_source
+          src = Source::SourceCode.from source
           new src.desc, [src]
         end
       end

data/lib/reek/source/tree_dresser.rb

@@ -1,4 +1,4 @@
-require 'reek/source/ast_node_class_map'
+require_relative 'ast_node_class_map'
 
 module Reek
   module Source
@@ -7,7 +7,7 @@ module Reek
     # the tree more understandable and less implementation-dependent.
     #
     class TreeDresser
-      def initialize(klass_map = AstNodeClassMap.new)
+      def initialize(klass_map = ASTNodeClassMap.new)
         @klass_map = klass_map
       end
 

data/lib/reek/spec.rb

@@ -1,6 +1,6 @@
-require 'reek/spec/should_reek'
-require 'reek/spec/should_reek_of'
-require 'reek/spec/should_reek_only_of'
+require_relative 'spec/should_reek'
+require_relative 'spec/should_reek_of'
+require_relative 'spec/should_reek_only_of'
 
 module Reek
   #

data/lib/reek/spec/should_reek.rb

@@ -1,5 +1,5 @@
-require 'reek/examiner'
-require 'reek/cli/report/formatter'
+require_relative '../examiner'
+require_relative '../cli/report/formatter'
 
 module Reek
   module Spec
@@ -17,7 +17,7 @@ module Reek
       end
 
       def failure_message_when_negated
-        rpt = Cli::Report::Formatter.format_list(@examiner.smells)
+        rpt = CLI::Report::Formatter.format_list(@examiner.smells)
         "Expected no smells, but got:\n#{rpt}"
       end
     end

data/lib/reek/spec/should_reek_of.rb

@@ -1,4 +1,4 @@
-require 'reek/examiner'
+require_relative '../examiner'
 
 module Reek
   module Spec

data/lib/reek/spec/should_reek_only_of.rb

@@ -1,5 +1,5 @@
-require 'reek/examiner'
-require 'reek/cli/report/formatter'
+require_relative '../examiner'
+require_relative '../cli/report/formatter'
 
 module Reek
   module Spec
@@ -20,7 +20,7 @@ module Reek
       end
 
       def failure_message
-        rpt = Cli::Report::Formatter.format_list(@warnings)
+        rpt = CLI::Report::Formatter.format_list(@warnings)
         "Expected #{@examiner.description} to reek only of #{@smell_category}, but got:\n#{rpt}"
       end
 

data/lib/reek/version.rb

@@ -3,6 +3,6 @@ module Reek
   # This module holds the Reek version informations
   #
   module Version
-    STRING = '2.0.4'
+    STRING = '2.1.0'
   end
 end