reek 1.3.1 → 1.3.2

data/lib/reek/cli/reek_command.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'examiner')
+require 'reek/examiner'
 
 module Reek
   module Cli
@@ -8,13 +8,13 @@ module Reek
     # text report format.
     #
     class ReekCommand
-      def self.create(sources, report_class, config_files = [])
-        new(report_class, sources, config_files)
+      def self.create(sources, reporter, config_files = [])
+        new(reporter, sources, config_files)
       end
 
-      def initialize(report_class, sources, config_files = [])
+      def initialize(reporter, sources, config_files = [])
         @sources = sources
-        @report_class = report_class
+        @reporter = reporter
         @config_files = config_files
       end
 
@@ -22,9 +22,8 @@ module Reek
         had_smells = false
         @sources.each do |source|
           examiner = Examiner.new(source, @config_files)
-          rpt = @report_class.new(examiner)
           had_smells ||= examiner.smelly?
-          view.output(rpt.report)
+          view.output @reporter.report(examiner)
         end
         if had_smells
           view.report_smells

data/lib/reek/cli/report.rb

@@ -1,38 +1,47 @@
 module Reek
   module Cli
-
     module ReportFormatter
-      def header(desc, count)
-        result = "#{desc} -- #{count} warning"
+      def self.format_list(warnings, formatter = SimpleWarningFormatter)
+        warnings.map do |warning|
+          "  #{formatter.format warning}"
+        end.join("\n")
+      end
+
+      def self.header(examiner)
+        count = examiner.smells_count
+        result = "#{examiner.description} -- #{count} warning"
         result += 's' unless count == 1
         result
       end
+    end
 
-      def format_list(warnings)
-        warnings.map do |warning|
-          "  #{warning.context} #{warning.message} (#{warning.subclass})"
-        end.join("\n")
+    module SimpleWarningFormatter
+      def self.format(warning)
+        "#{warning.context} #{warning.message} (#{warning.subclass})"
       end
+    end
 
-      module_function :format_list
+    module WarningFormatterWithLineNumbers
+      def self.format(warning)
+        "#{warning.lines.inspect}:#{SimpleWarningFormatter.format(warning)}"
+      end
     end
 
     #
     # A report that lists every source, including those that have no smells.
     #
     class VerboseReport
-
-      include ReportFormatter
-
-      def initialize(examiner)
-        @examiner = examiner
+      def initialize(warning_formatter = SimpleWarningFormatter, report_formatter = ReportFormatter)
+        @warning_formatter = warning_formatter
+        @report_formatter = report_formatter
       end
 
-      def report
-        warnings = @examiner.smells
-        warning_count = warnings.length
-        result = header(@examiner.description, warning_count)
-        result += ":\n#{format_list(warnings)}" if warning_count > 0
+      def report(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 + "\n"
       end
     end
@@ -40,26 +49,13 @@ module Reek
     #
     # A report that lists a section for each source that has smells.
     #
-    class QuietReport
-
-      include ReportFormatter
-
-      def initialize(examiner)
-        @warnings = examiner.smells
-        @smell_count = @warnings.length
-        @desc = examiner.description
-      end
-
-      def report
-        @smell_count > 0 ? "#{header(@desc, @smell_count)}:\n#{format_list(@warnings)}\n" : ''
-      end
-    end
-
-    class ShowLineReport < VerboseReport
-      def format_list(warnings)
-        warnings.map do |warning|
-          "  #{warning.lines.inspect}:#{warning.context} #{warning.message} (#{warning.subclass})"
-        end.join("\n")
+    class QuietReport < VerboseReport
+      def report(examiner)
+        if examiner.smelly?
+          super
+        else
+          ''
+        end
       end
     end
   end

data/lib/reek/cli/version_command.rb

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

data/lib/reek/cli/yaml_command.rb

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

data/lib/reek/core/code_parser.rb

@@ -1,8 +1,8 @@
 require 'sexp'
-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')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'singleton_method_context')
+require 'reek/core/method_context'
+require 'reek/core/module_context'
+require 'reek/core/stop_context'
+require 'reek/core/singleton_method_context'
 
 module Reek
   module Core

data/lib/reek/core/hash_extensions.rb

@@ -17,11 +17,11 @@ class Hash
     end
     self
   end
-  
+
   def adopt(other)
     self.deep_copy.adopt!(other)
   end
-  
+
   def deep_copy
     YAML::load(YAML::dump(self))
   end

data/lib/reek/core/method_context.rb

@@ -1,5 +1,5 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'code_context')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'object_refs')
+require 'reek/core/code_context'
+require 'reek/core/object_refs'
 
 module Reek
   module Core

data/lib/reek/core/module_context.rb

@@ -1,7 +1,7 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'code_context')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'code_parser')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'sniffer')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'source', 'sexp_formatter')
+require 'reek/core/code_context'
+require 'reek/core/code_parser'
+require 'reek/core/sniffer'
+require 'reek/source/sexp_formatter'
 
 module Reek
   module Core

data/lib/reek/core/singleton_method_context.rb

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

data/lib/reek/core/smell_repository.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smells')
+require 'reek/smells'
 
 module Reek
   module Core
@@ -10,18 +10,19 @@ module Reek
           Smells::Attribute,
           Smells::BooleanParameter,
           Smells::ClassVariable,
-          Smells::ControlCouple,
+          Smells::ControlParameter,
           Smells::DataClump,
-          Smells::Duplication,
+          Smells::DuplicateMethodCall,
           Smells::FeatureEnvy,
           Smells::IrresponsibleModule,
-          Smells::LargeClass,
-          Smells::LongMethod,
           Smells::LongParameterList,
           Smells::LongYieldList,
           Smells::NestedIterators,
           Smells::NilCheck,
-          Smells::SimulatedPolymorphism,
+          Smells::RepeatedConditional,
+          Smells::TooManyInstanceVariables,
+          Smells::TooManyMethods,
+          Smells::TooManyStatements,
           Smells::UncommunicativeMethodName,
           Smells::UncommunicativeModuleName,
           Smells::UncommunicativeParameterName,

data/lib/reek/core/sniffer.rb

@@ -1,8 +1,8 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'code_parser')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'smell_repository')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'source', 'config_file')
+require 'reek/core/code_parser'
+require 'reek/core/smell_repository'
+require 'reek/source/config_file'
 require 'yaml'
-require File.join(File.dirname(File.expand_path(__FILE__)), 'hash_extensions')
+require 'reek/core/hash_extensions'
 
 module Reek
   module Core

data/lib/reek/examiner.rb

@@ -1,6 +1,6 @@
-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', 'source_repository')
+require 'reek/core/sniffer'
+require 'reek/core/warning_collector'
+require 'reek/source/source_repository'
 
 module Reek
 
@@ -44,6 +44,13 @@ module Reek
       @smells
     end
 
+    #
+    # Returns the number of smells found in the source
+    #
+    def smells_count
+      @smells.length
+    end
+
     #
     # True if and only if there are code smells in the source.
     #

data/lib/reek/smell_warning.rb

@@ -1,7 +1,5 @@
-
 module Reek
 
-
   #
   # Reports a warning that a smell has been found.
   # This object is essentially a DTO, and therefore contains a :reek:attribute or two.

data/lib/reek/smells.rb

@@ -1,24 +1,25 @@
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'attribute')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'boolean_parameter')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'class_variable')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'control_couple')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'data_clump')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'duplication')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'feature_envy')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'irresponsible_module')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'large_class')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'long_method')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'long_parameter_list')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'long_yield_list')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'nested_iterators')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'nil_check')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'simulated_polymorphism')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'uncommunicative_method_name')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'uncommunicative_module_name')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'uncommunicative_parameter_name')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'uncommunicative_variable_name')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'unused_parameters')
-require File.join( File.dirname( File.expand_path(__FILE__)), 'smells', 'utility_function')
+require 'reek/smells/attribute'
+require 'reek/smells/boolean_parameter'
+require 'reek/smells/class_variable'
+require 'reek/smells/control_parameter'
+require 'reek/smells/data_clump'
+require 'reek/smells/duplicate_method_call'
+require 'reek/smells/feature_envy'
+require 'reek/smells/irresponsible_module'
+require 'reek/smells/long_parameter_list'
+require 'reek/smells/long_yield_list'
+require 'reek/smells/nested_iterators'
+require 'reek/smells/nil_check'
+require 'reek/smells/repeated_conditional'
+require 'reek/smells/too_many_instance_variables'
+require 'reek/smells/too_many_methods'
+require 'reek/smells/too_many_statements'
+require 'reek/smells/uncommunicative_method_name'
+require 'reek/smells/uncommunicative_module_name'
+require 'reek/smells/uncommunicative_parameter_name'
+require 'reek/smells/uncommunicative_variable_name'
+require 'reek/smells/unused_parameters'
+require 'reek/smells/utility_function'
 # SMELL: Duplication -- all these should be found automagically
 
 module Reek

data/lib/reek/smells/attribute.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__))), 'core', 'smell_configuration')
+require 'reek/smells/smell_detector'
+require 'reek/smell_warning'
+require 'reek/core/smell_configuration'
 
 module Reek
   module Smells
@@ -33,10 +33,6 @@ module Reek
         super.adopt(Core::SmellConfiguration::ENABLED_KEY => false)
       end
 
-      def initialize(source, config = Attribute.default_config)
-        super(source, config)
-      end
-
       #
       # Checks whether the given class declares any attributes.
       #
@@ -53,7 +49,7 @@ module Reek
       end
 
     private
-      
+
       def attributes_in(module_ctx)
         result = Set.new
         attr_defn_methods = [:attr, :attr_reader, :attr_writer, :attr_accessor]

data/lib/reek/smells/boolean_parameter.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

data/lib/reek/smells/class_variable.rb

@@ -1,6 +1,6 @@
 require 'set'
-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
@@ -17,6 +17,7 @@ module Reek
 
       SMELL_CLASS = self.name.split(/::/)[-1]
       SMELL_SUBCLASS = SMELL_CLASS
+
       VARIABLE_KEY = 'variable'
 
       def self.contexts      # :nodoc:

data/lib/reek/smells/{control_couple.rb → control_parameter.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
@@ -41,10 +41,10 @@ module Reek
     # that remains next to where the caller invokes it in
     # the source code.
     #
-    class ControlCouple < SmellDetector
+    class ControlParameter < SmellDetector
 
-      SMELL_CLASS = self.name.split(/::/)[-1]
-      SMELL_SUBCLASS = 'ControlParameter'
+      SMELL_CLASS = 'ControlCouple'
+      SMELL_SUBCLASS = self.name.split(/::/)[-1]
       PARAMETER_KEY = 'parameter'
 
       #

data/lib/reek/smells/data_clump.rb

@@ -1,15 +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')
-
-#
-# Extensions to +Array+ needed by Reek.
-#
-class Array
-  def intersection
-    self.inject { |res, elem| elem & res }
-  end
-end
+require 'reek/smells/smell_detector'
+require 'reek/smell_warning'
+require 'reek/source'
 
 module Reek
   module Smells
@@ -29,6 +20,7 @@ module Reek
     class DataClump < SmellDetector
 
       SMELL_CLASS = self.name.split(/::/)[-1]
+      SMELL_SUBCLASS = self.name.split(/::/)[-1]
 
       METHODS_KEY = 'methods'
       OCCURRENCES_KEY = 'occurrences'
@@ -58,15 +50,11 @@ module Reek
 
       def self.default_config
         super.adopt(
-                MAX_COPIES_KEY => DEFAULT_MAX_COPIES,
-                MIN_CLUMP_SIZE_KEY => DEFAULT_MIN_CLUMP_SIZE
+          MAX_COPIES_KEY => DEFAULT_MAX_COPIES,
+          MIN_CLUMP_SIZE_KEY => DEFAULT_MIN_CLUMP_SIZE
         )
       end
 
-      def initialize(source, config = DataClump.default_config)
-        super(source, config)
-      end
-
       #
       # Checks the given class or module for multiple identical parameter sets.
       #
@@ -76,14 +64,14 @@ module Reek
         @max_copies = value(MAX_COPIES_KEY, ctx, DEFAULT_MAX_COPIES)
         @min_clump_size = value(MIN_CLUMP_SIZE_KEY, ctx, DEFAULT_MIN_CLUMP_SIZE)
         MethodGroup.new(ctx, @min_clump_size, @max_copies).clumps.map do |clump, methods|
-          SmellWarning.new('DataClump', ctx.full_name,
+          SmellWarning.new(SMELL_CLASS, ctx.full_name,
                            methods.map {|meth| meth.line},
                            "takes parameters #{DataClump.print_clump(clump)} to #{methods.length} methods",
-                           @source, 'DataClump', {
-                          PARAMETERS_KEY => clump.map {|name| name.to_s},
-                          OCCURRENCES_KEY => methods.length,
-                          METHODS_KEY => methods.map {|meth| meth.name}
-                  })
+                           @source, SMELL_SUBCLASS, {
+                             PARAMETERS_KEY => clump.map {|name| name.to_s},
+                             OCCURRENCES_KEY => methods.length,
+                             METHODS_KEY => methods.map {|meth| meth.name}
+                           })
         end
       end
 
@@ -98,10 +86,6 @@ module Reek
   # @private
   class MethodGroup
 
-    def self.intersection_of_parameters_of(methods)
-      methods.map {|meth| meth.arg_names}.intersection
-    end
-
     def initialize(ctx, min_clump_size, max_copies)
       @min_clump_size = min_clump_size
       @max_copies = max_copies
@@ -114,7 +98,7 @@ module Reek
 
     def clumps_containing(method, methods, results)
       methods.each do |other_method|
-        clump = [method.arg_names, other_method.arg_names].intersection
+        clump = method.arg_names & other_method.arg_names
         if clump.length >= @min_clump_size
           others = methods.select { |other| clump - other.arg_names == [] }
           results[clump] += [method] + others