reek 1.3.6 → 1.3.7

data/lib/reek/smells/data_clump.rb

@@ -49,7 +49,7 @@ module Reek
       DEFAULT_MIN_CLUMP_SIZE = 2
 
       def self.default_config
-        super.adopt(
+        super.merge(
           MAX_COPIES_KEY => DEFAULT_MAX_COPIES,
           MIN_CLUMP_SIZE_KEY => DEFAULT_MIN_CLUMP_SIZE
         )

data/lib/reek/smells/duplicate_method_call.rb

@@ -38,7 +38,7 @@ module Reek
       DEFAULT_ALLOW_CALLS = []
 
       def self.default_config
-        super.adopt(
+        super.merge(
           MAX_ALLOWED_CALLS_KEY => DEFAULT_MAX_CALLS,
           ALLOW_CALLS_KEY => DEFAULT_ALLOW_CALLS
         )

data/lib/reek/smells/long_parameter_list.rb

@@ -29,7 +29,7 @@ module Reek
       DEFAULT_MAX_ALLOWED_PARAMS = 3
 
       def self.default_config
-        super.adopt(
+        super.merge(
           MAX_ALLOWED_PARAMS_KEY => DEFAULT_MAX_ALLOWED_PARAMS,
           Core::SmellConfiguration::OVERRIDES_KEY => {
             "initialize" => {MAX_ALLOWED_PARAMS_KEY => 5}

data/lib/reek/smells/long_yield_list.rb

@@ -24,7 +24,7 @@ module Reek
       PARAMETER_COUNT_KEY = 'parameter_count'
 
       def self.default_config
-        super.adopt(
+        super.merge(
           MAX_ALLOWED_PARAMS_KEY => DEFAULT_MAX_ALLOWED_PARAMS
         )
       end

data/lib/reek/smells/nested_iterators.rb

@@ -29,7 +29,7 @@ module Reek
       DEFAULT_IGNORE_ITERATORS = []
 
       def self.default_config
-        super.adopt(
+        super.merge(
           MAX_ALLOWED_NESTING_KEY => DEFAULT_MAX_ALLOWED_NESTING,
           IGNORE_ITERATORS_KEY => DEFAULT_IGNORE_ITERATORS
         )

data/lib/reek/smells/nil_check.rb

@@ -12,13 +12,9 @@ module Reek
       SMELL_SUBCLASS = self.name.split(/::/)[-1]
 
       def examine_context(ctx)
-
         call_nodes = CallNodeFinder.new(ctx)
         case_nodes = CaseNodeFinder.new(ctx)
-        smelly_calls = call_nodes.smelly
-        smelly_cases = case_nodes.smelly
-
-        smelly_nodes = smelly_calls + smelly_cases
+        smelly_nodes = call_nodes.smelly + case_nodes.smelly
 
         smelly_nodes.map do |node|
           SmellWarning.new(SMELL_CLASS, ctx.full_name, Array(node.line),
@@ -27,6 +23,9 @@ module Reek
         end
       end
 
+      #
+      # A base class that allows to work on all nodes of a certain type.
+      #
       class NodeFinder
         SEXP_NIL = Sexp.new(:nil)
         def initialize(ctx, type)
@@ -34,6 +33,9 @@ module Reek
         end
       end
 
+      #
+      # Find call nodes which perform a nil check.
+      #
       class CallNodeFinder < NodeFinder
         def initialize(ctx)
           super(ctx, :call)
@@ -62,6 +64,9 @@ module Reek
         end
       end
 
+      #
+      # Finds when statements that perform a nil check.
+      #
       class CaseNodeFinder < NodeFinder
         CASE_NIL_NODE = Sexp.new(:array, SEXP_NIL)
 

data/lib/reek/smells/repeated_conditional.rb

@@ -37,7 +37,7 @@ module Reek
       DEFAULT_MAX_IFS = 2
 
       def self.default_config
-        super.adopt(MAX_IDENTICAL_IFS_KEY => DEFAULT_MAX_IFS)
+        super.merge(MAX_IDENTICAL_IFS_KEY => DEFAULT_MAX_IFS)
       end
 
       #

data/lib/reek/smells/smell_detector.rb

@@ -7,7 +7,7 @@ module Reek
 
     module ExcludeInitialize
       def self.default_config
-        super.adopt(EXCLUDE_KEY => ['initialize'])
+        super.merge(EXCLUDE_KEY => ['initialize'])
       end
     end
 
@@ -85,8 +85,7 @@ module Reek
       end
 
       def config_for(ctx)
-        ctx.config[self.class.name.split(/::/)[-1]] || {}
-        # BUG: needs to consider smell class AND subclass
+        ctx.config_for(self.class)
       end
     end
   end

data/lib/reek/smells/too_many_instance_variables.rb

@@ -28,7 +28,7 @@ module Reek
       end
 
       def self.default_config
-        super.adopt(
+        super.merge(
           MAX_ALLOWED_IVARS_KEY => DEFAULT_MAX_IVARS,
           EXCLUDE_KEY => []
         )

data/lib/reek/smells/too_many_methods.rb

@@ -30,7 +30,7 @@ module Reek
       end
 
       def self.default_config
-        super.adopt(
+        super.merge(
           MAX_ALLOWED_METHODS_KEY => DEFAULT_MAX_METHODS,
           EXCLUDE_KEY => []
         )

data/lib/reek/smells/too_many_statements.rb

@@ -23,7 +23,7 @@ module Reek
       DEFAULT_MAX_STATEMENTS = 5
 
       def self.default_config
-        super.adopt(
+        super.merge(
           MAX_ALLOWED_STATEMENTS_KEY => DEFAULT_MAX_STATEMENTS,
           EXCLUDE_KEY => ['initialize']
         )

data/lib/reek/smells/uncommunicative_method_name.rb

@@ -37,7 +37,7 @@ module Reek
       DEFAULT_ACCEPT_SET = []
 
       def self.default_config
-        super.adopt(
+        super.merge(
           REJECT_KEY => DEFAULT_REJECT_SET,
           ACCEPT_KEY => DEFAULT_ACCEPT_SET
         )
@@ -55,14 +55,14 @@ module Reek
       def examine_context(ctx)
         @reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
         @accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
-        name = ctx.name
+        name = ctx.name.to_s
         return [] if @accept_names.include?(ctx.full_name)
-        var = name.to_s.gsub(/^[@\*\&]*/, '')
+        var = name.gsub(/^[@\*\&]*/, '')
         return [] if @accept_names.include?(var)
         return [] unless @reject_names.detect {|patt| patt === var}
         smell = SmellWarning.new('UncommunicativeName', ctx.full_name, [ctx.exp.line],
           "has the name '#{name}'",
-          @source, 'UncommunicativeMethodName', {METHOD_NAME_KEY => name.to_s})
+          @source, 'UncommunicativeMethodName', {METHOD_NAME_KEY => name})
         [smell]
       end
     end

data/lib/reek/smells/uncommunicative_module_name.rb

@@ -37,7 +37,7 @@ module Reek
       DEFAULT_ACCEPT_SET = ['Inline::C']
 
       def self.default_config
-        super.adopt(
+        super.merge(
           REJECT_KEY => DEFAULT_REJECT_SET,
           ACCEPT_KEY => DEFAULT_ACCEPT_SET
         )
@@ -58,14 +58,14 @@ module Reek
         @accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
         exp = ctx.exp
         full_name = ctx.full_name
-        name = exp.simple_name
+        name = exp.simple_name.to_s
         return [] if @accept_names.include?(full_name)
-        var = name.to_s.gsub(/^[@\*\&]*/, '')
+        var = name.gsub(/^[@\*\&]*/, '')
         return [] if @accept_names.include?(var)
         return [] unless @reject_names.detect {|patt| patt === var}
         smell = SmellWarning.new(SMELL_CLASS, full_name, [exp.line],
           "has the name '#{name}'",
-          @source, SMELL_SUBCLASS, {MODULE_NAME_KEY => name.to_s})
+          @source, SMELL_SUBCLASS, {MODULE_NAME_KEY => name})
         [smell]
       end
     end

data/lib/reek/smells/uncommunicative_parameter_name.rb

@@ -27,7 +27,7 @@ module Reek
       # smelly names to be reported.
       REJECT_KEY = 'reject'
 
-      DEFAULT_REJECT_SET = [/^.$/, /[0-9]$/, /[A-Z]/]
+      DEFAULT_REJECT_SET = [/^.$/, /[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
@@ -37,7 +37,7 @@ module Reek
       DEFAULT_ACCEPT_SET = []
 
       def self.default_config
-        super.adopt(
+        super.merge(
           REJECT_KEY => DEFAULT_REJECT_SET,
           ACCEPT_KEY => DEFAULT_ACCEPT_SET
         )
@@ -55,17 +55,17 @@ module Reek
       def examine_context(ctx)
         @reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
         @accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
-        ctx.exp.parameter_names.select do |name|
-          is_bad_name?(name, ctx)
+        context_expression = ctx.exp
+        context_expression.parameter_names.select do |name|
+          is_bad_name?(name) && ctx.uses_param?(name)
         end.map do |name|
-          smell = SmellWarning.new(SMELL_CLASS, ctx.full_name, [ctx.exp.line],
-                                   "has the parameter name '#{name}'",
-                                   @source, SMELL_SUBCLASS, {PARAMETER_NAME_KEY => name.to_s})
-          smell
+          SmellWarning.new(SMELL_CLASS, ctx.full_name, [context_expression.line],
+                           "has the parameter name '#{name}'",
+                           @source, SMELL_SUBCLASS, {PARAMETER_NAME_KEY => name.to_s})
         end
       end
 
-      def is_bad_name?(name, ctx)
+      def is_bad_name?(name)
         var = name.to_s.gsub(/^[@\*\&]*/, '')
         return false if var == '*' or @accept_names.include?(var)
         @reject_names.detect {|patt| patt === var}

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -37,7 +37,7 @@ module Reek
       DEFAULT_ACCEPT_SET = ['_']
 
       def self.default_config
-        super.adopt(
+        super.merge(
           REJECT_KEY => DEFAULT_REJECT_SET,
           ACCEPT_KEY => DEFAULT_ACCEPT_SET
         )

data/lib/reek/smells/unused_parameters.rb

@@ -37,7 +37,7 @@ module Reek
         params(method_ctx).select do |param|
           param = sanitized_param(param)
           next if skip?(param)
-          unused?(method_ctx, param)
+          !method_ctx.uses_param?(param)
         end
       end
 
@@ -45,10 +45,6 @@ module Reek
         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
@@ -66,7 +62,7 @@ module Reek
       end
 
       def zsuper?(method_ctx)
-        method_ctx.exp.body.find_node :zsuper
+        method_ctx.exp.body.has_nested_node? :zsuper
       end
 
       def smell_warning(method_ctx, param)

data/lib/reek/smells/utility_function.rb

@@ -51,7 +51,7 @@ module Reek
           [:defn]
         end
         def default_config
-          super.adopt(HELPER_CALLS_LIMIT_KEY => DEFAULT_HELPER_CALLS_LIMIT)
+          super.merge(HELPER_CALLS_LIMIT_KEY => DEFAULT_HELPER_CALLS_LIMIT)
         end
       end
 

data/lib/reek/source/code_comment.rb

@@ -11,7 +11,7 @@ module Reek
 
       def initialize(text)
         @config =  Hash.new { |hash,key| hash[key] = {} }
-        @text = text.gsub(CONFIG_REGEX) do |m|
+        @text = text.gsub(CONFIG_REGEX) do
           add_to_config($1, $2)
           ''
         end.gsub(/#/, '').gsub(/\n/, '').strip

data/lib/reek/source/config_file.rb

@@ -9,7 +9,6 @@ module Reek
     # any or all of the smell detectors.
     #
     class ConfigFile
-      @@bad_config_files = []
 
       #
       # Load the YAML config file from the supplied +file_path+.
@@ -39,7 +38,7 @@ module Reek
         rescue
           klass = nil
         end
-        problem("\"#{name}\" is not a code smell") unless klass
+        report_problem("\"#{name}\" is not a code smell") unless klass
         klass
       end
 
@@ -50,26 +49,28 @@ module Reek
       #
       def load
         if File.size(@file_path) == 0
-          problem('Empty file')
+          report_problem('Empty file')
           return {}
         end
 
         begin
           result = YAML.load_file(@file_path) || {}
-        rescue => e
-          error(e.to_s)
+        rescue => error
+          report_error(error.to_s)
         end
 
-        error('Not a hash') unless Hash === result
+        report_error('Not a hash') unless Hash === result
 
         result
       end
 
+      private
+
       #
       # Report invalid configuration file to standard
       # Error.
       #
-      def problem(reason)
+      def report_problem(reason)
         $stderr.puts "Warning: #{message(reason)}"
       end
 
@@ -77,7 +78,7 @@ module Reek
       # Report invalid configuration file to standard
       # Error.
       #
-      def error(reason)
+      def report_error(reason)
         raise ConfigFileException.new message(reason)
       end
 

data/lib/reek/source/sexp_extensions.rb

@@ -4,11 +4,11 @@ module Reek
   module Source
     module SexpExtensions
       module AndNode
-        def condition() self[1..2].tap {|b| b.extend SexpNode } end
+        def condition() self[1..2].tap {|node| node.extend SexpNode } end
       end
 
       module OrNode
-        def condition() self[1..2].tap {|b| b.extend SexpNode } end
+        def condition() self[1..2].tap {|node| node.extend SexpNode } end
       end
 
       module AttrasgnNode

data/lib/reek/source/sexp_node.rb

@@ -43,15 +43,18 @@ module Reek
       # every Sexp of type +target_type+. The traversal ignores any node
       # whose type is listed in the Array +ignoring+.
       #
-      def look_for(target_type, ignoring, &blk)
-        each do |elem|
-          if Sexp === elem then
-            elem.look_for(target_type, ignoring, &blk) unless ignoring.include?(elem.first)
-          end
+      def look_for(target_type, ignoring = [], &blk)
+        each_sexp do |elem|
+          elem.look_for(target_type, ignoring, &blk) unless ignoring.include?(elem.first)
         end
         blk.call(self) if first == target_type
       end
 
+      def has_nested_node?(target_type)
+        look_for(target_type) { |elem| return true }
+        false
+      end
+
       def format_ruby
         Ruby2Ruby.new.process(deep_copy)
       end

data/lib/reek/source/source_repository.rb

@@ -4,6 +4,11 @@ require 'reek/source/source_locator'
 
 module Reek
   module Source
+    #
+    # A collection of source code. If the collection is initialized with an array
+    # it is assumed to be a list of file paths. Otherwise it is assumed to be a
+    # single unit of Ruby source code.
+    #
     class SourceRepository
       def self.parse source
         case source

data/lib/reek/version.rb

@@ -1,3 +1,3 @@
 module Reek
-  VERSION = '1.3.6'
+  VERSION = '1.3.7'
 end

data/reek.gemspec

@@ -26,9 +26,10 @@ and reports any code smells it finds.
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Code smell detector for Ruby}
 
-  s.add_runtime_dependency(%q<ruby_parser>, ["~> 3.2"])
+  s.add_runtime_dependency(%q<ruby_parser>, ["~> 3.3"])
   s.add_runtime_dependency(%q<sexp_processor>)
-  s.add_runtime_dependency(%q<ruby2ruby>, ["~> 2.0.7"])
+  s.add_runtime_dependency(%q<ruby2ruby>, ["~> 2.0.8"])
+  s.add_runtime_dependency(%q<rainbow>)
 
   s.add_development_dependency(%q<bundler>, ["~> 1.1"])
   s.add_development_dependency(%q<rake>)