reek 1.3.8 → 1.4.0

data/lib/reek/cli/report/strategy.rb

@@ -0,0 +1,63 @@
+module Reek
+  module Cli
+    module Report
+      module Strategy
+        #
+        # Base class for report startegies.
+        # Each gathers results according to strategy chosen
+        #
+        class Base
+          attr_reader :report_formatter, :warning_formatter, :examiners
+
+          def initialize(report_formatter, warning_formatter, examiners)
+            @report_formatter = report_formatter
+            @warning_formatter = warning_formatter
+            @examiners = examiners
+          end
+
+          def summarize_single_examiner(examiner)
+            result = report_formatter.header examiner
+            if examiner.smelly?
+              formatted_list = report_formatter.format_list examiner.smells, warning_formatter
+              result += ":\n#{formatted_list}"
+            end
+            result
+          end
+        end
+
+        #
+        # Lists out each examiner, even if it has no smell
+        #
+        class Verbose < Base
+          def gather_results
+            examiners.each_with_object([]) do |examiner, result|
+              result << summarize_single_examiner(examiner)
+            end
+          end
+        end
+
+        #
+        # Lists only smelly examiners
+        #
+        class Quiet < Base
+          def gather_results
+            examiners.each_with_object([]) do |examiner, result|
+              result << summarize_single_examiner(examiner) if examiner.smelly?
+            end
+          end
+        end
+
+        #
+        # Lists smells without summarization
+        # Used for yaml and html reports
+        #
+        class Normal < Base
+          def gather_results
+            examiners.each_with_object([]) { |examiner, smells| smells << examiner.smells }.
+                             flatten
+          end
+        end
+      end
+    end
+  end
+end

data/lib/reek/cli/version_command.rb

@@ -1,17 +1,14 @@
 require 'reek'
+require 'reek/cli/command'
 
 module Reek
   module Cli
-
     #
     # A command to report the application's current version number.
     #
-    class VersionCommand
-      def initialize(progname)
-        @progname = progname
-      end
+    class VersionCommand < Command
       def execute(view)
-        view.output("#{@progname} #{Reek::VERSION}\n")
+        view.output("#{@parser.program_name} #{Reek::VERSION}\n")
         view.report_success
       end
     end

data/lib/reek/config_file_exception.rb

@@ -3,6 +3,5 @@ module Reek
   # An exception that occured when loading the configuration file.
   #
   class ConfigFileException < RuntimeError
-
   end
 end

data/lib/reek/core/code_context.rb

@@ -1,7 +1,6 @@
 
 module Reek
   module Core
-
     #
     # Superclass for all types of source code context. Each instance represents
     # a code element of some kind, and each provides behaviour relevant to that
@@ -9,7 +8,6 @@ module Reek
     # with each context holding a reference to a unique outer context.
     #
     class CodeContext
-
       attr_reader :exp
 
       def initialize(outer, exp)
@@ -35,7 +33,7 @@ module Reek
 
       def matches?(candidates)
         my_fq_name = full_name
-        candidates.any? {|str| /#{str}/ === my_fq_name }
+        candidates.any? { |str| /#{str}/ =~ my_fq_name }
       end
 
       #

data/lib/reek/core/code_parser.rb

@@ -6,26 +6,27 @@ require 'reek/core/singleton_method_context'
 
 module Reek
   module Core
-
     #
     # Traverses a Sexp abstract syntax tree and fires events whenever
     # it encounters specific node types.
     #
+    # SMELL: This class is responsible for counting statements and for feeding
+    # each context to the smell repository.
     class CodeParser
-      def initialize(sniffer, ctx = StopContext.new)
-        @sniffer = sniffer
+      def initialize(smell_repository, ctx = StopContext.new)
+        @smell_repository = smell_repository
         @element = ctx
       end
 
       def process(exp)
         meth = "process_#{exp[0]}"
         meth = :process_default unless self.respond_to?(meth)
-        self.send(meth, exp)
+        send(meth, exp)
         @element
       end
 
       def process_default(exp)
-        exp.each { |sub| process(sub) if Array === sub }
+        exp.each { |sub| process(sub) if sub.is_a? Array }
       end
 
       def process_module(exp)
@@ -34,7 +35,7 @@ module Reek
         end
       end
 
-      alias process_class process_module
+      alias_method :process_class, :process_module
 
       def process_defn(exp)
         inside_new_context(MethodContext, exp) do
@@ -61,21 +62,21 @@ module Reek
         process_default(exp)
       end
 
-      alias process_attrasgn process_call
-      alias process_op_asgn1 process_call
+      alias_method :process_attrasgn, :process_call
+      alias_method :process_op_asgn1, :process_call
 
       def process_ivar(exp)
         @element.record_use_of_self
         process_default(exp)
       end
 
-      alias process_iasgn process_ivar
+      alias_method :process_iasgn, :process_ivar
 
       def process_self(_)
         @element.record_use_of_self
       end
 
-      alias process_zsuper process_self
+      alias_method :process_zsuper, :process_self
 
       #
       # Statement counting
@@ -105,7 +106,7 @@ module Reek
         process_default(exp)
       end
 
-      alias process_until process_while
+      alias_method :process_until, :process_while
 
       def process_for(exp)
         count_clause(exp[3])
@@ -156,7 +157,7 @@ module Reek
       end
 
       def check_smells(type)
-        @sniffer.examine(@element, type)
+        @smell_repository.examine(@element, type)
       end
 
       def push(scope)

data/lib/reek/core/method_context.rb

@@ -3,7 +3,6 @@ require 'reek/core/object_refs'
 
 module Reek
   module Core
-
     #
     # The parameters in a method's definition.
     #
@@ -11,7 +10,7 @@ module Reek
       def default_assignments
         result = []
         self[1..-1].each do |exp|
-          result << exp[1..2] if Sexp === exp && exp[0] == :lasgn
+          result << exp[1..2] if exp.is_a?(Sexp) && exp[0] == :lasgn
         end
         result
       end
@@ -61,6 +60,18 @@ module Reek
       def uses_param?(param)
         local_nodes(:lvar).include?(Sexp.new(:lvar, param.to_sym))
       end
+
+      def unused_params
+        exp.arguments.select do |param|
+          next if param.anonymous_splat?
+          next if param.marked_unused?
+          !uses_param? param.plain_name
+        end
+      end
+
+      def uses_super_with_implicit_arguments?
+        exp.body.contains_nested_node? :zsuper
+      end
     end
   end
 end

data/lib/reek/core/module_context.rb

@@ -1,16 +1,12 @@
 require 'reek/core/code_context'
-require 'reek/core/code_parser'
-require 'reek/core/sniffer'
 require 'reek/source/sexp_formatter'
 
 module Reek
   module Core
-
     #
     # A context wrapper for any module found in a syntax tree.
     #
     class ModuleContext < CodeContext
-
       def initialize(outer, exp)
         super(outer, exp)
         @name = Source::SexpFormatter.format(exp[1])

data/lib/reek/core/object_refs.rb

@@ -1,6 +1,5 @@
 module Reek
   module Core
-
     #
     # Manages and counts the references out of a method to other objects.
     #
@@ -18,12 +17,12 @@ module Reek
       end
 
       def max_refs
-        @refs.values.max or 0
+        @refs.values.max || 0
       end
 
       def max_keys
         max = max_refs
-        @refs.reject {|key,val| val != max}
+        @refs.select { |_key, val| val == max }
       end
 
       def self_is_max?

data/lib/reek/core/singleton_method_context.rb

@@ -2,12 +2,10 @@ require 'reek/core/method_context'
 
 module Reek
   module Core
-
     #
     # A context wrapper for any singleton method definition found in a syntax tree.
     #
     class SingletonMethodContext < MethodContext
-
       def initialize(outer, exp)
         super(outer, exp)
       end

data/lib/reek/core/smell_configuration.rb

@@ -1,11 +1,9 @@
 module Reek
   module Core
-
     #
     # Represents a single set of configuration options for a smell detector
     #
     class SmellConfiguration
-
       # The name of the config field that specifies whether a smell is
       # enabled. Set to +true+ or +false+.
       ENABLED_KEY = 'enabled'
@@ -39,8 +37,8 @@ module Reek
       # Returns +fall_back+ if this config has no value for the key.
       #
       def value(key, context, fall_back)
-        overrides_for(context).each { |conf| return conf[key] if conf.has_key?(key) }
-        return @options.fetch(key, fall_back)
+        overrides_for(context).each { |conf| return conf[key] if conf.key?(key) }
+        @options.fetch(key, fall_back)
       end
     end
 
@@ -54,7 +52,7 @@ module Reek
 
       # Find any overrides that match the supplied context
       def for_context(context)
-        contexts = @hash.keys.select {|ckey| context.matches?([ckey])}
+        contexts = @hash.keys.select { |ckey| context.matches?([ckey]) }
         contexts.map { |exc| @hash[exc] }
       end
     end

data/lib/reek/core/smell_repository.rb

@@ -6,7 +6,6 @@ module Reek
     # Contains all the existing smells and exposes operations on them.
     #
     class SmellRepository
-
       def self.smell_classes
         # SMELL: Duplication -- these should be loaded by listing the files
         [
@@ -36,19 +35,19 @@ module Reek
         ]
       end
 
-      def initialize source_description
+      def initialize(source_description, smell_classes = SmellRepository.smell_classes)
         @typed_detectors = nil
-        @detectors = Hash.new
-        SmellRepository.smell_classes.each do |klass|
+        @detectors = {}
+        smell_classes.each do |klass|
           @detectors[klass] = klass.new(source_description)
         end
       end
 
       def configure(klass, config)
-        @detectors[klass].configure_with(config)
+        @detectors[klass].configure_with(config) if @detectors[klass]
       end
 
-      def report_on listener
+      def report_on(listener)
         @detectors.each_value { |detector| detector.report_on(listener) }
       end
 
@@ -60,9 +59,9 @@ module Reek
 
       private
 
-      def smell_listeners()
+      def smell_listeners
         unless @typed_detectors
-          @typed_detectors = Hash.new {|hash,key| hash[key] = [] }
+          @typed_detectors = Hash.new { |hash, key| hash[key] = [] }
           @detectors.each_value { |detector| detector.register(@typed_detectors) }
         end
         @typed_detectors

data/lib/reek/core/sniffer.rb

@@ -1,29 +1,23 @@
 require 'reek/core/code_parser'
 require 'reek/core/smell_repository'
 require 'reek/source/config_file'
-require 'yaml'
 
 module Reek
   module Core
-
     #
     # Configures all available smell detectors and applies them to a source.
     #
     class Sniffer
-
-      def initialize(src, config_files = [], smell_repository=Core::SmellRepository.new(src.desc))
+      def initialize(src, extra_config_files = [], smell_repository = Core::SmellRepository.new(src.desc))
         @smell_repository = smell_repository
-        config_files.each{ |cf| Reek::Source::ConfigFile.new(cf).configure(self) }
         @source = src
-        src.configure(self)
-      end
 
-      def configure(klass, config)
-        @smell_repository.configure klass, config
+        config_files = extra_config_files + @source.relevant_config_files
+        config_files.each { |cf| Reek::Source::ConfigFile.new(cf).configure(@smell_repository) }
       end
 
       def report_on(listener)
-        CodeParser.new(self).process(@source.syntax_tree)
+        CodeParser.new(@smell_repository).process(@source.syntax_tree)
         @smell_repository.report_on(listener)
       end
 

data/lib/reek/core/stop_context.rb

@@ -1,16 +1,14 @@
 module Reek
   module Core
-
     #
     # A context wrapper representing the root of an abstract syntax tree.
     #
     class StopContext
-
       def initialize
         @name = ''
       end
 
-      def method_missing(method, *args)
+      def method_missing(_method, *_args)
         nil
       end
 
@@ -18,7 +16,7 @@ module Reek
         {}
       end
 
-      def count_statements(num)
+      def count_statements(_num)
         0
       end
 

data/lib/reek/core/warning_collector.rb

@@ -2,7 +2,6 @@ require 'set'
 
 module Reek
   module Core
-
     #
     # Collects and sorts smells warnings.
     #

data/lib/reek/examiner.rb

@@ -3,12 +3,10 @@ require 'reek/core/warning_collector'
 require 'reek/source/source_repository'
 
 module Reek
-
   #
   # Finds the active code smells in Ruby source code.
   #
   class Examiner
-
     #
     # A simple description of the source being analysed for smells.
     # If the source is a single File, this will be the file's path.
@@ -27,12 +25,20 @@ module Reek
     #   and if it is an Array, it is assumed to be a list of file paths,
     #   each of which is opened and parsed for source code.
     #
-    def initialize(source, config_files = [])
+    def initialize(source, config_files = [], smell_names = [])
       sources = Source::SourceRepository.parse(source)
       @description = sources.description
-      collector = Core::WarningCollector.new
-      sources.each { |src| Core::Sniffer.new(src, config_files).report_on(collector) }
-      @smells = collector.warnings
+      @collector = Core::WarningCollector.new
+
+      smell_classes = Core::SmellRepository.smell_classes
+      if smell_names.any?
+        smell_classes.select! { |klass| smell_names.include? klass.smell_class_name }
+      end
+
+      sources.each do |src|
+        repository = Core::SmellRepository.new(src.desc, smell_classes)
+        Core::Sniffer.new(src, config_files, repository).report_on(@collector)
+      end
     end
 
     #
@@ -41,21 +47,21 @@ module Reek
     # @return [Array<SmellWarning>]
     #
     def smells
-      @smells
+      @smells ||= @collector.warnings
     end
 
     #
     # Returns the number of smells found in the source
     #
     def smells_count
-      @smells.length
+      smells.length
     end
 
     #
     # True if and only if there are code smells in the source.
     #
     def smelly?
-      not @smells.empty?
+      !smells.empty?
     end
 
     #
@@ -64,9 +70,7 @@ module Reek
     #
     # @deprecated Use #smells instead.
     #
-    def all_active_smells
-      @smells
-    end
+    alias_method :all_active_smells, :smells
 
     #
     # Returns an Array of SmellWarning objects, one for each smell
@@ -76,17 +80,15 @@ module Reek
     #
     # @deprecated Use #smells instead.
     #
-    def all_smells
-      @smells
-    end
+    alias_method :all_smells, :smells
 
     #
     # Returns the number of non-masked smells in the source.
     #
-    # @deprecated Use #smells instead.
+    # @deprecated Use #smells_count instead.
     #
     def num_active_smells
-      @smells.length
+      smells.length
     end
 
     #