reek 1.2.7.2 → 1.2.7.3

data/features/stdin.feature

@@ -33,9 +33,9 @@ Feature: Reek reads from $stdin when no files are given
     And it reports:
       """
       $stdin -- 3 warnings:
-        Turn has no descriptive comment (Irresponsible Module)
-        Turn has the variable name '@x' (Uncommunicative Name)
-        Turn#y has the name 'y' (Uncommunicative Name)
+        Turn has no descriptive comment (IrresponsibleModule)
+        Turn has the variable name '@x' (UncommunicativeName)
+        Turn#y has the name 'y' (UncommunicativeName)
 
       """
 

data/lib/reek.rb

@@ -2,7 +2,7 @@
 # Reek's core functionality
 #
 module Reek
-  VERSION = '1.2.7.2'
+  VERSION = '1.2.7.3'
 end
 
 require File.join(File.dirname(File.expand_path(__FILE__)), 'reek', 'examiner')

data/lib/reek/cli/command_line.rb

@@ -18,7 +18,6 @@ module Reek
         @argv = argv
         @parser = OptionParser.new
         @report_class = VerboseReport
-        @collection_strategy = ActiveSmellsOnly
         @command_class = ReekCommand
         set_options
       end
@@ -36,7 +35,6 @@ module Reek
         # reek -v|--version        Output the tool's version number
         #
         # reek [options] files     List the smells in the given files
-        #      -a|--[no-]show-all  Report masked smells
         #      -q|-[no-]quiet      Only list files that have smells
         #      files               Names of files or dirs to be checked
         #
@@ -46,7 +44,7 @@ Usage: #{progname} [options] [files]
 Examples:
 
 #{progname} lib/*.rb
-#{progname} -q -a lib
+#{progname} -q lib
 cat my_class.rb | #{progname}
 
 See http://wiki.github.com/kevinrutherford/reek for detailed help.
@@ -65,9 +63,6 @@ EOB
         end
 
         @parser.separator "\nReport formatting:"
-        @parser.on("-a", "--[no-]show-all", "Show all smells, including those masked by config settings") do |opt|
-          @collection_strategy = opt ? ActiveAndMaskedSmells : ActiveSmellsOnly
-        end
         @parser.on("-q", "--[no-]quiet", "Suppress headings for smell-free source files") do |opt|
           @report_class = opt ? QuietReport : VerboseReport
         end
@@ -90,7 +85,7 @@ EOB
           YamlCommand.create(sources)
         else
           sources = get_sources
-          ReekCommand.create(sources, @report_class, @collection_strategy)
+          ReekCommand.create(sources, @report_class)
         end
       end
 

data/lib/reek/cli/reek_command.rb

@@ -8,19 +8,19 @@ module Reek
     # text report format.
     #
     class ReekCommand
-      def self.create(sources, report_class, strategy = ActiveSmellsOnly)
-        examiners = sources.map { |src| Examiner.new(src, strategy.new) }
-        new(examiners, report_class)
+      def self.create(sources, report_class)
+        new(report_class, sources)
       end
 
-      def initialize(examiners, report_class)
-        @examiners = examiners
+      def initialize(report_class, sources)
+        @sources = sources
         @report_class = report_class
       end
 
       def execute(view)
         had_smells = false
-        @examiners.each do |examiner|
+        @sources.each do |source|
+          examiner = Examiner.new(source)
           rpt = @report_class.new(examiner)
           had_smells ||= examiner.smelly?
           view.output(rpt.report)

data/lib/reek/cli/report.rb

@@ -1,67 +1,39 @@
 module Reek
   module Cli
 
-    #
-    # A section of a text report; has a heading that identifies the source
-    # and summarises the smell counts, and a body listing details of all
-    # smells found.
-    #
-    class ReportSection
-
-      SMELL_FORMAT = '%m%c %w (%s)'
-
-      def initialize(examiner)
-        @examiner = examiner
-      end
-
-      # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
-      # this report, with a heading.
-      def verbose_report
-        result = header
-        result += ":\n#{smell_list}" if should_report
-        result += "\n"
+    module ReportFormatter
+      def header(desc, count)
+        result = "#{desc} -- #{count} warning"
+        result += 's' unless count == 1
         result
       end
 
-      def quiet_report
-        return '' unless should_report
-        # SMELL: duplicate knowledge of the header layout
-        "#{header}:\n#{smell_list}\n"
-      end
-
-      def header
-        "#{@examiner.description} -- #{visible_header}"
-      end
-
-      # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
-      # this report.
-      def smell_list
-        @examiner.smells.map {|smell| "  #{smell.report(SMELL_FORMAT)}"}.join("\n")
+      def format_list(warnings)
+        warnings.map do |warning|
+          "  #{warning.context} #{warning.message} (#{warning.smell_class})"
+        end.join("\n")
       end
 
-    private
-
-      def should_report
-        @examiner.num_smells > 0
-      end
-
-      def visible_header
-        num_smells = @examiner.smells.length
-        result = "#{num_smells} warning"
-        result += 's' unless num_smells == 1
-        result
-      end
+      module_function :format_list
     end
 
     #
     # A report that lists every source, including those that have no smells.
     #
     class VerboseReport
+
+      include ReportFormatter
+
       def initialize(examiner)
-        @reporter = ReportSection.new(examiner)
+        @examiner = examiner
       end
+
       def report
-        @reporter.verbose_report
+        warnings = @examiner.smells
+        warning_count = warnings.length
+        result = header(@examiner.description, warning_count)
+        result += ":\n#{format_list(warnings)}" if warning_count > 0
+        result + "\n"
       end
     end
 
@@ -69,11 +41,17 @@ module Reek
     # A report that lists a section for each source that has smells.
     #
     class QuietReport
+
+      include ReportFormatter
+
       def initialize(examiner)
-        @reporter = ReportSection.new(examiner)
+        @warnings = examiner.smells
+        @smell_count = @warnings.length
+        @desc = examiner.description
       end
+
       def report
-        @reporter.quiet_report
+        @smell_count > 0 ? "#{header(@desc, @smell_count)}:\n#{format_list(@warnings)}\n" : ''
       end
     end
   end

data/lib/reek/core/code_parser.rb

@@ -1,5 +1,4 @@
 require 'sexp'
-require File.join(File.dirname(File.expand_path(__FILE__)), 'class_context')
 require File.join(File.dirname(File.expand_path(__FILE__)), 'method_context')
 require File.join(File.dirname(File.expand_path(__FILE__)), 'module_context')
 require File.join(File.dirname(File.expand_path(__FILE__)), 'stop_context')
@@ -26,24 +25,21 @@ module Reek
       end
 
       def process_default(exp)
-        exp[0..-1].each { |sub| process(sub) if Array === sub }
+        exp.each { |sub| process(sub) if Array === sub }
       end
 
-      def do_module_or_class(exp, context_class)
-        scope = context_class.create(@element, exp)
+      def process_module(exp)
+        name = Source::SexpFormatter.format(exp[1])
+        scope = ModuleContext.new(@element, name, exp)
         push(scope) do
-          process_default(exp) unless @element.is_struct?
+          process_default(exp) unless exp.superclass == [:const, :Struct]
           check_smells(exp[0])
         end
         scope
       end
 
-      def process_module(exp)
-        do_module_or_class(exp, ModuleContext)
-      end
-
       def process_class(exp)
-        do_module_or_class(exp, ClassContext)
+        process_module(exp)
       end
 
       def process_defn(exp)
@@ -122,11 +118,6 @@ module Reek
         process_iasgn(exp)
       end
 
-      def process_lasgn(exp)
-        @element.record_local_variable(exp[1])
-        process_default(exp)
-      end
-
       def process_iasgn(exp)
         @element.record_use_of_self
         process_default(exp)

data/lib/reek/core/method_context.rb

@@ -1,3 +1,4 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), 'code_context')
 require File.join(File.dirname(File.expand_path(__FILE__)), 'object_refs')
 
 module Reek
@@ -53,7 +54,6 @@ module Reek
         @parameters.extend(MethodParameters)
         @num_statements = 0
         @refs = ObjectRefs.new
-        @outer.record_method(self)    # SMELL: these could be found by tree walking
       end
 
       def count_statements(num)

data/lib/reek/core/module_context.rb

@@ -11,27 +11,9 @@ module Reek
     #
     class ModuleContext < CodeContext
 
-      class << self
-        def create(outer, exp)
-          res = Source::SexpFormatter.format(exp[1])
-          new(outer, res, exp)
-        end
-
-        def from_s(src)
-          source = src.to_reek_source
-          sniffer = Sniffer.new(source)
-          CodeParser.new(sniffer).do_module_or_class(source.syntax_tree, self)
-        end
-      end
-
       def initialize(outer, name, exp)
         super(outer, exp)
         @name = name
-        @parsed_methods = []
-      end
-
-      def record_method(meth)
-        @parsed_methods << meth
       end
     end
   end

data/lib/reek/core/smell_configuration.rb

@@ -22,10 +22,6 @@ module Reek
         @options.adopt!(options)
       end
 
-      def deep_copy
-        @options.deep_copy     # SMELL: Open Secret -- returns a Hash
-      end
-
       #
       # Is this smell detector active?
       #--

data/lib/reek/core/sniffer.rb

@@ -1,4 +1,3 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'detector_stack')
 require File.join(File.dirname(File.expand_path(__FILE__)), 'code_parser')
 require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smells')
 require 'yaml'
@@ -65,36 +64,29 @@ module Reek
         ]
       end
 
-      def initialize(src, config_strategy = ActiveSmellsOnly.new)   # SMELL: open secret -- need a Strategy
-        @config_strategy = config_strategy
-        @already_checked_for_smells = false
+      def initialize(src)
         @typed_detectors = nil
         @detectors = Hash.new
         Sniffer.smell_classes.each do |klass|
-          @detectors[klass] = DetectorStack.new(klass.new(src.desc))
+          @detectors[klass] = klass.new(src.desc)
         end
         @source = src
         src.configure(self)
       end
 
-      def check_for_smells
-        return if @already_checked_for_smells
-        CodeParser.new(self).process(@source.syntax_tree)
-        @already_checked_for_smells = true
-      end
-
       def configure(klass, config)
-        @config_strategy.configure(@detectors[klass], config)
+        @detectors[klass].configure_with(config)
       end
 
-      def report_on(report)
-        check_for_smells
-        @detectors.each_value { |stack| stack.report_on(report) }
+      def report_on(listener)
+        CodeParser.new(self).process(@source.syntax_tree)
+        @detectors.each_value { |detector| detector.report_on(listener) }
       end
 
-      def examine(scope, type)
-        listeners = smell_listeners[type]
-        listeners.each {|smell| smell.examine(scope) } if listeners
+      def examine(scope, node_type)
+        smell_listeners[node_type].each do |detector|
+          detector.examine(scope)
+        end
       end
 
   private
@@ -102,7 +94,7 @@ module Reek
       def smell_listeners()
         unless @typed_detectors
           @typed_detectors = Hash.new {|hash,key| hash[key] = [] }
-          @detectors.each_value { |stack| stack.listen_to(@typed_detectors) }
+          @detectors.each_value { |detector| detector.register(@typed_detectors) }
         end
         @typed_detectors
       end

data/lib/reek/core/warning_collector.rb

@@ -0,0 +1,27 @@
+require 'set'
+
+module Reek
+  module Core
+
+    #
+    # Collects and sorts smells warnings.
+    #
+    class WarningCollector
+      def initialize
+        @warnings = Set.new
+      end
+
+      def found_smell(warning)
+        @warnings.add(warning)
+      end
+
+      def warnings
+        @warnings.to_a.sort do |first,second|
+          first_sig = [first.context, first.message, first.smell_class]
+          second_sig = [second.context, second.message, second.smell_class]
+          first_sig <=> second_sig
+        end
+      end
+    end
+  end
+end

data/lib/reek/examiner.rb

@@ -1,29 +1,9 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'core', 'masking_collection')
 require File.join(File.dirname(File.expand_path(__FILE__)), 'core', 'sniffer')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'core', 'warning_collector')
 require File.join(File.dirname(File.expand_path(__FILE__)), 'source')
 
 module Reek
 
-  class ActiveSmellsOnly
-    def configure(detectors, config)
-      detectors.adopt(config)
-    end
-
-    def smells_in(sources)
-      Core::MaskingCollection.new.collect_from(sources, self).all_active_items.to_a
-    end
-  end
-
-  class ActiveAndMaskedSmells
-    def configure(detectors, config)
-      detectors.push(config)
-    end
-
-    def smells_in(sources)
-      Core::MaskingCollection.new.collect_from(sources, self).all_items
-    end
-  end
-
   #
   # Finds the active code smells in Ruby source code.
   #
@@ -47,13 +27,7 @@ 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.
     #
-    # @param [#smells_in]
-    #   The +collector+ will be asked to examine the sources and report
-    #   an array of SmellWarning objects. The default collector is an
-    #   instance of ActiveSmellsOnly, which completely ignores all smells
-    #   that have been masked by configuration options.
-    #
-    def initialize(source, collector = ActiveSmellsOnly.new)
+    def initialize(source)
       sources = case source
       when Array
         @description = 'dir'
@@ -66,12 +40,13 @@ module Reek
         @description = src.desc
         [src]
       end
-      @smells = collector.smells_in(sources)
+      collector = Core::WarningCollector.new
+      sources.each { |src| Core::Sniffer.new(src).report_on(collector) }
+      @smells = collector.warnings
     end
 
     #
-    # Returns an Array of SmellWarning objects, one for each active smell
-    # in the source.
+    # List the smells found in the source.
     #
     # @return [Array<SmellWarning>]
     #
@@ -79,18 +54,51 @@ module Reek
       @smells
     end
 
+    #
+    # True if and only if there are code smells in the source.
+    #
+    def smelly?
+      not @smells.empty?
+    end
+
+    #
+    # Returns an Array of SmellWarning objects, one for each non-masked smell
+    # in the source.
+    #
+    # @deprecated Use #smells instead.
+    #
+    def all_active_smells
+      @smells
+    end
+
+    #
+    # Returns an Array of SmellWarning objects, one for each smell
+    # in the source; includes active smells and masked smells.
+    #
+    # @return [Array<SmellWarning>]
+    #
+    # @deprecated Use #smells instead.
+    #
+    def all_smells
+      @smells
+    end
+
     #
     # Returns the number of non-masked smells in the source.
     #
-    def num_smells
+    # @deprecated Use #smells instead.
+    #
+    def num_active_smells
       @smells.length
     end
 
     #
-    # True if and only if there are non-masked code smells in the given source.
+    # Returns the number of masked smells in the source.
     #
-    def smelly?
-      not @smells.empty?
+    # @deprecated Masked smells are no longer reported; this method always returns 0.
+    #
+    def num_masked_smells
+      0
     end
   end
 end