reek 1.3.1 → 1.3.2

data/lib/reek/smells/{long_method.rb → too_many_statements.rb}

@@ -1,5 +1,5 @@
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smell_detector')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smell_warning')
+require 'reek/smells/smell_detector'
+require 'reek/smell_warning'
 
 module Reek
   module Smells
@@ -7,13 +7,12 @@ module Reek
     #
     # A Long Method is any method that has a large number of lines.
     #
-    # Currently +LongMethod+ reports any method with more than
-    # 5 statements.
+    # +TooManyStatements+ reports any method with more than 5 statements.
     #
-    class LongMethod < SmellDetector
+    class TooManyStatements < SmellDetector
 
-      SMELL_CLASS = self.name.split(/::/)[-1]
-      SUBCLASS_TOO_MANY_STATEMENTS = 'TooManyStatements'
+      SMELL_CLASS = 'LongMethod'
+      SMELL_SUBCLASS = self.name.split(/::/)[-1]
 
       STATEMENT_COUNT_KEY = 'statement_count'
 
@@ -30,10 +29,6 @@ module Reek
         )
       end
 
-      def initialize(source, config = LongMethod.default_config)
-        super(source, config)
-      end
-
       #
       # Checks the length of the given +method+.
       #
@@ -45,7 +40,7 @@ module Reek
         return [] if num <= @max_allowed_statements
         smell = SmellWarning.new(SMELL_CLASS, ctx.full_name, [ctx.exp.line],
           "has approx #{num} statements",
-          @source, SUBCLASS_TOO_MANY_STATEMENTS,
+          @source, SMELL_SUBCLASS,
           {STATEMENT_COUNT_KEY => num})
         [smell]
       end

data/lib/reek/smells/uncommunicative_method_name.rb

@@ -1,5 +1,5 @@
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smell_detector')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smell_warning')
+require 'reek/smells/smell_detector'
+require 'reek/smell_warning'
 
 module Reek
   module Smells
@@ -28,7 +28,7 @@ module Reek
       REJECT_KEY = 'reject'
 
       DEFAULT_REJECT_SET = [/^[a-z]$/, /[0-9]$/, /[A-Z]/]
-      
+
       # The name of the config field that lists the specific names that are
       # to be treated as exceptions; these names will not be reported as
       # uncommunicative.
@@ -47,10 +47,6 @@ module Reek
         [:defn, :defs]
       end
 
-      def initialize(source, config = UncommunicativeMethodName.default_config)
-        super(source, config)
-      end
-
       #
       # Checks the given +context+ for uncommunicative names.
       #

data/lib/reek/smells/uncommunicative_module_name.rb

@@ -1,5 +1,5 @@
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smell_detector')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smell_warning')
+require 'reek/smells/smell_detector'
+require 'reek/smell_warning'
 
 module Reek
   module Smells
@@ -28,7 +28,7 @@ module Reek
       REJECT_KEY = 'reject'
 
       DEFAULT_REJECT_SET = [/^.$/, /[0-9]$/]
-      
+
       # The name of the config field that lists the specific names that are
       # to be treated as exceptions; these names will not be reported as
       # uncommunicative.
@@ -47,10 +47,6 @@ module Reek
         [:module, :class]
       end
 
-      def initialize(source, config = UncommunicativeModuleName.default_config)
-        super(source, config)
-      end
-
       #
       # Checks the given +context+ for uncommunicative names.
       #

data/lib/reek/smells/uncommunicative_parameter_name.rb

@@ -1,5 +1,5 @@
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smell_detector')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smell_warning')
+require 'reek/smells/smell_detector'
+require 'reek/smell_warning'
 
 module Reek
   module Smells
@@ -38,8 +38,8 @@ module Reek
 
       def self.default_config
         super.adopt(
-                REJECT_KEY => DEFAULT_REJECT_SET,
-                ACCEPT_KEY => DEFAULT_ACCEPT_SET
+          REJECT_KEY => DEFAULT_REJECT_SET,
+          ACCEPT_KEY => DEFAULT_ACCEPT_SET
         )
       end
 
@@ -47,10 +47,6 @@ module Reek
         [:defn, :defs]
       end
 
-      def initialize(source, config = UncommunicativeParameterName.default_config)
-        super(source, config)
-      end
-
       #
       # Checks the given +context+ for uncommunicative names.
       #

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -1,5 +1,5 @@
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smell_detector')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smell_warning')
+require 'reek/smells/smell_detector'
+require 'reek/smell_warning'
 
 module Reek
   module Smells
@@ -38,8 +38,8 @@ module Reek
 
       def self.default_config
         super.adopt(
-                REJECT_KEY => DEFAULT_REJECT_SET,
-                ACCEPT_KEY => DEFAULT_ACCEPT_SET
+          REJECT_KEY => DEFAULT_REJECT_SET,
+          ACCEPT_KEY => DEFAULT_ACCEPT_SET
         )
       end
 
@@ -47,10 +47,6 @@ module Reek
         [:module, :class, :defn, :defs]
       end
 
-      def initialize(source, config = UncommunicativeVariableName.default_config)
-        super(source, config)
-      end
-
       #
       # Checks the given +context+ for uncommunicative names.
       #
@@ -78,7 +74,7 @@ module Reek
         result = Hash.new {|hash, key| hash[key] = []}
         find_assignment_variable_names(exp, result)
         find_block_argument_variable_names(exp, result)
-        result
+        result.to_a.sort_by {|name, _| name.to_s}
       end
 
       def find_assignment_variable_names(exp, accumulator)

data/lib/reek/smells/unused_parameters.rb

@@ -1,37 +1,86 @@
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smell_detector')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smell_warning')
+require 'reek/smells/smell_detector'
+require 'reek/smell_warning'
 
 module Reek
   module Smells
 
     #
     # Methods should use their parameters.
-    # 
+    #
     class UnusedParameters < SmellDetector
 
-      SMELL_CLASS = 'ControlCouple'
+      SMELL_CLASS = 'UnusedCode'
       SMELL_SUBCLASS = name.split(/::/)[-1]
 
       PARAMETER_KEY = 'parameter'
 
+      EMPTY_ARRAY  = [].freeze
+      EMPTY_STRING = ''.freeze
+      SPLAT_MATCH  = /^\*/.freeze
+      UNDERSCORE   = '_'.freeze
+
       #
       # Checks whether the given method has any unused parameters.
       #
       # @return [Array<SmellWarning>]
       #
       def examine_context(method_ctx)
-        params = method_ctx.exp.arg_names || []
-        params.select do |param|
-          param = param.to_s.sub(/^\*/, '')
-          !["", "_"].include?(param) &&
-            !method_ctx.local_nodes(:lvar).include?(Sexp.new(:lvar, param.to_sym))
-        end.map do |param|
-          SmellWarning.new(SMELL_CLASS, method_ctx.full_name, [method_ctx.exp.line],
-                           "has unused parameter '#{param.to_s}'",
-                           @source, SMELL_SUBCLASS, {PARAMETER_KEY => param.to_s})
+        return EMPTY_ARRAY if zsuper?(method_ctx)
+        unused_params(method_ctx).map do |param|
+          smell_warning(method_ctx, param)
+        end
+      end
+
+      private
+
+      def unused_params(method_ctx)
+        params(method_ctx).select do |param|
+          param = sanitized_param(param)
+          next if skip?(param)
+          unused?(method_ctx, param)
         end
       end
 
+      def skip?(param)
+        anonymous_splat?(param) || marked_unused?(param)
+      end
+
+      def unused?(method_ctx, param)
+        !method_ctx.local_nodes(:lvar).include?(Sexp.new(:lvar, param.to_sym))
+      end
+
+      def params(method_ctx)
+        method_ctx.exp.arg_names || EMPTY_ARRAY
+      end
+
+      def sanitized_param(param)
+        param.to_s.sub(SPLAT_MATCH, EMPTY_STRING)
+      end
+
+      def marked_unused?(param)
+        param.start_with?(UNDERSCORE)
+      end
+
+      def anonymous_splat?(param)
+        param == EMPTY_STRING
+      end
+
+      def zsuper?(method_ctx)
+        method_ctx.exp.body.find_node :zsuper
+      end
+
+      def smell_warning(method_ctx, param)
+        SmellWarning.new(
+          SMELL_CLASS,
+          method_ctx.full_name,
+          [ method_ctx.exp.line ],
+          "has unused parameter '#{param.to_s}'",
+          @source,
+          SMELL_SUBCLASS,
+          { PARAMETER_KEY => param.to_s }
+        )
+      end
+
     end
   end
 end

data/lib/reek/smells/utility_function.rb

@@ -1,6 +1,6 @@
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smell_detector')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smell_warning')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'source', 'reference_collector')
+require 'reek/smells/smell_detector'
+require 'reek/smell_warning'
+require 'reek/source/reference_collector'
 
 module Reek
   module Smells
@@ -55,10 +55,6 @@ module Reek
         end
       end
 
-      def initialize(source, config = UtilityFunction.default_config)
-        super(source, config)
-      end
-
       #
       # Checks whether the given +method+ is a utility function.
       #

data/lib/reek/source.rb

@@ -1,11 +1,11 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'code_comment')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'config_file')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'core_extras')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'sexp_formatter')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'source_code')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'source_file')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'source_locator')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'tree_dresser')
+require 'reek/source/code_comment'
+require 'reek/source/config_file'
+require 'reek/source/core_extras'
+require 'reek/source/sexp_formatter'
+require 'reek/source/source_code'
+require 'reek/source/source_file'
+require 'reek/source/source_locator'
+require 'reek/source/tree_dresser'
 
 module Reek
 

data/lib/reek/source/core_extras.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'source_code')
+require 'reek/source/source_code'
 
 #
 # Extensions to +File+ needed by Reek.

data/lib/reek/source/source_code.rb

@@ -1,6 +1,6 @@
 require 'ruby_parser'
-require File.join(File.dirname(File.expand_path(__FILE__)), 'config_file')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'tree_dresser')
+require 'reek/source/config_file'
+require 'reek/source/tree_dresser'
 
 module Reek
   module Source

data/lib/reek/source/source_file.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'source_code')
+require 'reek/source/source_code'
 
 module Reek
   module Source
@@ -25,7 +25,7 @@ module Reek
         return [] unless File.exist?(path)
         parent = File.dirname(path)
         return [] if path == parent
-        all_config_files(parent) + Dir["#{path}/*.reek"]
+        all_config_files(parent) + Dir["#{path}/*.reek", "#{path}/.reek"]
       end
     end
   end

data/lib/reek/source/source_locator.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'core_extras')
+require 'reek/source/core_extras'
 
 module Reek
   module Source

data/lib/reek/source/source_repository.rb

@@ -1,4 +1,6 @@
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'source')
+require 'reek/source/core_extras'
+require 'reek/source/source_code'
+require 'reek/source/source_locator'
 
 module Reek
   module Source
@@ -24,7 +26,7 @@ module Reek
       end
 
       def each &block
-        @sources.each &block
+        @sources.each(&block)
       end
     end
   end

data/lib/reek/spec.rb

@@ -1,6 +1,6 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'spec', 'should_reek')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'spec', 'should_reek_of')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'spec', 'should_reek_only_of')
+require 'reek/spec/should_reek'
+require 'reek/spec/should_reek_of'
+require 'reek/spec/should_reek_only_of'
 
 module Reek
 
@@ -49,3 +49,9 @@ if Object.const_defined?(:Spec)
     config.include(Reek::Spec)
   end
 end
+
+if Object.const_defined?(:RSpec)
+  RSpec.configure do |config|
+    config.include(Reek::Spec)
+  end
+end

data/lib/reek/spec/should_reek.rb

@@ -1,5 +1,5 @@
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'examiner')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'cli', 'report')
+require 'reek/examiner'
+require 'reek/cli/report'
 
 module Reek
   module Spec

data/lib/reek/spec/should_reek_of.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'examiner')
+require 'reek/examiner'
 
 module Reek
   module Spec

data/lib/reek/spec/should_reek_only_of.rb

@@ -1,5 +1,5 @@
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'examiner')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'cli', 'report')
+require 'reek/examiner'
+require 'reek/cli/report'
 
 module Reek
   module Spec

data/lib/reek/version.rb

@@ -1,3 +1,3 @@
 module Reek
-  VERSION = '1.3.1'
+  VERSION = '1.3.2'
 end

data/reek.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
-require File.join(File.dirname(__FILE__), 'lib/reek/version.rb')
+$:.push File.join(File.dirname(__FILE__), "lib")
+require 'reek/version'
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
@@ -33,5 +34,6 @@ and reports any code smells it finds.
   s.add_development_dependency(%q<rake>)
   s.add_development_dependency(%q<cucumber>)
   s.add_development_dependency(%q<rspec>, ["~> 2.12"])
+  s.add_development_dependency(%q<flay>)
   s.add_development_dependency(%q<yard>)
 end

data/spec/gem/updates_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'spec_helper')
+require 'spec_helper'
 require 'find'
 
 release_timestamp_file = 'build/.last-release'

data/spec/gem/yard_spec.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'spec_helper')
+require 'spec_helper'
 require 'tempfile'
 
 describe 'yardoc' do

data/spec/matchers/smell_of_matcher.rb

@@ -16,34 +16,68 @@ module SmellOfMatcher
 
     def matches?(src)
       @source = src.to_reek_source
+
+      detect_smells
+
+      return false if no_smells_found?
+      return false if wrong_smell_class_found?
+      return false if wrong_number_of_smells_found?
+      return false if wrong_smell_details_found?
+
+      true
+    end
+
+    def with_config(options)
+      @config = options
+      self
+    end
+
+    private
+
+    def detect_smells
       ctx = MethodContext.new(nil, @source.syntax_tree)
       detector = @klass.new(@source.desc, @klass.default_config.merge(@config))
       detector.examine(ctx)
-      actual_smells = detector.smells_found.to_a
-      if actual_smells.empty?
+      @actual_smells = detector.smells_found.to_a
+    end
+
+    def no_smells_found?
+      if @actual_smells.empty?
         @reason = 'no smells found by detector'
-        return false
+        return true
       end
-      return false if actual_smells.any? do |expected_smell|
-        @reason = "Found #{expected_smell.smell_class}/#{expected_smell.subclass}" &&
-        expected_smell.smell_class != @klass::SMELL_CLASS &&
-          expected_smell.subclass != @klass::SMELL_SUBCLASS
-      end
-      return actual_smells.length == 1 if @expected_smells.empty?
-      return false unless @expected_smells.length == actual_smells.length
-      @expected_smells.each_with_index do |expected_smell,index|
-        expected_smell.each do |(key,value)|
-          if actual_smells[index].smell[key] != value
-            @reason = "#{key} != #{value}"
-          end
+    end
+
+    def wrong_smell_class_found?
+      @actual_smells.each do |smell|
+        if smell.smell_class != @klass::SMELL_CLASS ||
+          smell.subclass != @klass::SMELL_SUBCLASS
+          @reason = "Found #{smell.smell_class}/#{smell.subclass}"
+          return true
         end
       end
-      true
+      false
     end
 
-    def with_config(options)
-      @config = options
-      self
+    def wrong_number_of_smells_found?
+      expected_number_of_smells = @expected_smells.empty? ? 1 : @expected_smells.length
+      if expected_number_of_smells != @actual_smells.length
+        @reason = "expected #{expected_number_of_smells} smell(s), found #{@actual_smells.length}"
+        true
+      end
+    end
+
+    def wrong_smell_details_found?
+      @expected_smells.zip(@actual_smells).each do |expected_smell, actual_smell|
+        expected_smell.each do |key, value|
+          actual_value = actual_smell.smell[key]
+          if actual_value != value
+            @reason = "expected #{key} to be #{value}, was #{actual_value}"
+            return true
+          end
+        end
+      end
+      false
     end
   end