reek 1.2.8 → 1.2.9

data/features/step_definitions/reek_steps.rb

@@ -31,13 +31,27 @@ Then /^the exit status indicates smells$/ do
 end
 
 Then /^it reports:$/ do |report|
-  @last_stdout.should == report
+  @last_stdout.chomp.should == report.chomp
+end
+
+Then /^it reports this yaml:$/ do |expected_yaml|
+  expected_warnings = YAML.load(expected_yaml.chomp)
+  actual_warnings = YAML.load(@last_stdout)
+  actual_warnings.should == expected_warnings
+end
+
+Then /^it reports something like: (.*)$/ do |line|
+  @last_stdout.chomp.should match Regexp.new(Regexp.escape(line))
 end
 
 Then /^stderr reports:$/ do |report|
   @last_stderr.should == report
 end
 
+Then /^it reports an error$/ do
+  @last_stderr.chomp.should_not be_empty
+end
+
 Then /^it reports the error ['"](.*)['"]$/ do |string|
   @last_stderr.chomp.should == string
 end

data/features/support/env.rb

@@ -2,7 +2,6 @@ $:.unshift 'lib'
 
 require 'rubygems'
 require 'tempfile'
-require 'spec/expectations'
 require 'fileutils'
 require 'reek/cli/application'
 

data/lib/reek.rb

@@ -1,9 +1,6 @@
 #
 # Reek's core functionality
 #
-module Reek
-  VERSION = '1.2.8'
-end
-
+require File.join(File.dirname(File.expand_path(__FILE__)), 'reek', 'version')
 require File.join(File.dirname(File.expand_path(__FILE__)), 'reek', 'examiner')
 require File.join(File.dirname(File.expand_path(__FILE__)), 'reek', 'smell_warning')

data/lib/reek/cli/command_line.rb

@@ -49,7 +49,7 @@ Examples:
 #{progname} -q lib
 cat my_class.rb | #{progname}
 
-See http://wiki.github.com/kevinrutherford/reek for detailed help.
+See http://wiki.github.com/troessner/reek for detailed help.
 
 EOB
       end
@@ -87,12 +87,13 @@ EOB
           HelpCommand.new(@parser)
         elsif @command_class == VersionCommand
           VersionCommand.new(@parser.program_name)
-        elsif @command_class == YamlCommand
-          sources = get_sources
-          YamlCommand.create(sources, @config_files)
         else
           sources = get_sources
-          ReekCommand.create(sources, @report_class, @config_files)
+          if @command_class == YamlCommand
+            YamlCommand.create(sources, @config_files)
+          else
+            ReekCommand.create(sources, @report_class, @config_files)
+          end
         end
       end
 

data/lib/reek/cli/report.rb

@@ -10,7 +10,7 @@ module Reek
 
       def format_list(warnings)
         warnings.map do |warning|
-          "  #{warning.context} #{warning.message} (#{warning.smell_class})"
+          "  #{warning.context} #{warning.message} (#{warning.subclass})"
         end.join("\n")
       end
 

data/lib/reek/core/hash_extensions.rb

@@ -0,0 +1,29 @@
+#
+# Extensions to +Hash+ needed by Reek.
+#
+class Hash
+  def push_keys(hash)
+    keys.each {|key| hash[key].adopt!(self[key]) }
+  end
+
+  def adopt!(other)
+    other.keys.each do |key|
+      ov = other[key]
+      if Array === ov and has_key?(key)
+        self[key] += ov
+      else
+        self[key] = ov
+      end
+    end
+    self
+  end
+  
+  def adopt(other)
+    self.deep_copy.adopt!(other)
+  end
+  
+  def deep_copy
+    YAML::load(YAML::dump(self))
+  end
+end
+

data/lib/reek/core/method_context.rb

@@ -24,19 +24,6 @@ module Reek
       def is_assignment_block?(param)
         Array === param and param[0] == :block
       end
-
-      def names
-        return @names if @names
-        @names = self[1..-1].select {|arg| is_arg?(arg)}.map {|arg| arg.to_s }
-      end
-
-      def length
-        names.length
-      end
-
-      def include?(name)
-        names.include?(name)
-      end
     end
 
     #
@@ -65,14 +52,14 @@ module Reek
         receiver ||= [:self]
         case receiver[0]
         when :lvar
-          @refs.record_ref(receiver) unless meth == :new
+          @refs.record_reference_to(receiver) unless meth == :new
         when :self
-          record_use_of_self
+          @refs.record_reference_to(:self)
         end
       end
 
       def record_use_of_self
-        @refs.record_reference_to_self
+        @refs.record_reference_to(:self)
       end
 
       def envious_receivers

data/lib/reek/core/object_refs.rb

@@ -9,24 +9,12 @@ module Reek
         @refs = Hash.new(0)
       end
 
-      def record_reference_to_self
-        record_ref(SELF_REF)
+      def record_reference_to(exp)
+        @refs[exp] += 1
       end
 
-      def record_ref(exp)
-        type = exp[0]
-        case type
-        when :gvar
-          return
-        when :self
-          record_reference_to_self
-        else
-          @refs[exp] += 1
-        end
-      end
-
-      def refs_to_self
-        @refs[SELF_REF]
+      def references_to(exp)
+        @refs[exp]
       end
 
       def max_refs
@@ -39,13 +27,8 @@ module Reek
       end
 
       def self_is_max?
-        max_keys.length == 0 || @refs[SELF_REF] == max_refs
+        max_keys.length == 0 || @refs[:self] == max_refs
       end
-
-    private
-
-      SELF_REF = Sexp.from_array([:lit, :self])
-
     end
   end
 end

data/lib/reek/core/smell_repository.rb

@@ -0,0 +1,65 @@
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smells')
+
+module Reek
+  module Core
+    class SmellRepository
+
+      def self.smell_classes
+        # SMELL: Duplication -- these should be loaded by listing the files
+        [
+         Smells::Attribute,
+         Smells::BooleanParameter,
+         Smells::ClassVariable,
+         Smells::ControlCouple,
+         Smells::DataClump,
+         Smells::Duplication,
+         Smells::FeatureEnvy,
+         Smells::IrresponsibleModule,
+         Smells::LargeClass,
+         Smells::LongMethod,
+         Smells::LongParameterList,
+         Smells::LongYieldList,
+         Smells::NestedIterators,
+         Smells::SimulatedPolymorphism,
+         Smells::UncommunicativeMethodName,
+         Smells::UncommunicativeModuleName,
+         Smells::UncommunicativeParameterName,
+         Smells::UncommunicativeVariableName,
+         Smells::UtilityFunction,
+        ]
+      end
+
+      def initialize source_description
+        @typed_detectors = nil
+        @detectors = Hash.new
+        SmellRepository.smell_classes.each do |klass|
+          @detectors[klass] = klass.new(source_description)
+        end
+      end
+
+      def configure(klass, config)
+        @detectors[klass].configure_with(config)
+      end
+
+      def report_on listener
+        @detectors.each_value { |detector| detector.report_on(listener) }
+      end
+
+      def examine(scope, node_type)
+        smell_listeners[node_type].each do |detector|
+          detector.examine(scope)
+        end
+      end
+
+      private
+
+      def smell_listeners()
+        unless @typed_detectors
+          @typed_detectors = Hash.new {|hash,key| hash[key] = [] }
+          @detectors.each_value { |detector| detector.register(@typed_detectors) }
+        end
+        @typed_detectors
+      end
+    end
+  end
+end

data/lib/reek/core/sniffer.rb

@@ -1,36 +1,8 @@
 require File.join(File.dirname(File.expand_path(__FILE__)), 'code_parser')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'smells')
+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 'yaml'
-
-#
-# Extensions to +Hash+ needed by Reek.
-#
-class Hash
-  def push_keys(hash)
-    keys.each {|key| hash[key].adopt!(self[key]) }
-  end
-
-  def adopt!(other)
-    other.keys.each do |key|
-      ov = other[key]
-      if Array === ov and has_key?(key)
-        self[key] += ov
-      else
-        self[key] = ov
-      end
-    end
-    self
-  end
-  
-  def adopt(other)
-    self.deep_copy.adopt!(other)
-  end
-  
-  def deep_copy
-    YAML::load(YAML::dump(self))
-  end
-end
+require File.join(File.dirname(File.expand_path(__FILE__)), 'hash_extensions')
 
 module Reek
   module Core
@@ -40,65 +12,24 @@ module Reek
     #
     class Sniffer
 
-      def self.smell_classes
-        # SMELL: Duplication -- these should be loaded by listing the files
-        [
-          Smells::Attribute,
-          Smells::BooleanParameter,
-          Smells::ClassVariable,
-          Smells::ControlCouple,
-          Smells::DataClump,
-          Smells::Duplication,
-          Smells::FeatureEnvy,
-          Smells::IrresponsibleModule,
-          Smells::LargeClass,
-          Smells::LongMethod,
-          Smells::LongParameterList,
-          Smells::LongYieldList,
-          Smells::NestedIterators,
-          Smells::SimulatedPolymorphism,
-          Smells::UncommunicativeMethodName,
-          Smells::UncommunicativeModuleName,
-          Smells::UncommunicativeParameterName,
-          Smells::UncommunicativeVariableName,
-          Smells::UtilityFunction,
-        ]
-      end
-
-      def initialize(src, config_files = [])
-        @typed_detectors = nil
-        @detectors = Hash.new
-        Sniffer.smell_classes.each do |klass|
-          @detectors[klass] = klass.new(src.desc)
-        end
+      def initialize(src, 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)
-        @detectors[klass].configure_with(config)
+        @smell_repository.configure klass, config
       end
 
       def report_on(listener)
         CodeParser.new(self).process(@source.syntax_tree)
-        @detectors.each_value { |detector| detector.report_on(listener) }
+        @smell_repository.report_on(listener)
       end
 
       def examine(scope, node_type)
-        smell_listeners[node_type].each do |detector|
-          detector.examine(scope)
-        end
-      end
-
-  private
-
-      def smell_listeners()
-        unless @typed_detectors
-          @typed_detectors = Hash.new {|hash,key| hash[key] = [] }
-          @detectors.each_value { |detector| detector.register(@typed_detectors) }
-        end
-        @typed_detectors
+        @smell_repository.examine scope, node_type
       end
     end
   end

data/lib/reek/core/warning_collector.rb

@@ -16,11 +16,7 @@ module Reek
       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
+        @warnings.to_a.sort
       end
     end
   end

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')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'source_repository')
 
 module Reek
 
@@ -28,18 +28,8 @@ module Reek
     #   each of which is opened and parsed for source code.
     #
     def initialize(source, config_files = [])
-      sources = case source
-      when Array
-        @description = 'dir'
-        Source::SourceLocator.new(source).all_sources
-      when Source::SourceCode
-        @description = source.desc
-        [source]
-      else
-        src = source.to_reek_source
-        @description = src.desc
-        [src]
-      end
+      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

data/lib/reek/rake/task.rb

@@ -124,8 +124,16 @@ module Reek
       end
 
       def ruby_options
-        lib_path = @libs.join(File::PATH_SEPARATOR)
-        @ruby_opts.clone << "-I\"#{lib_path}\""
+        if bundler?
+          %w(-S bundle exec)
+        else
+          lib_path = @libs.join(File::PATH_SEPARATOR)
+          @ruby_opts.clone << "-I\"#{lib_path}\""
+        end
+      end
+
+      def bundler?
+        File.exist?('./Gemfile')
       end
 
       def sort_option

data/lib/reek/smell_warning.rb

@@ -1,6 +1,7 @@
 
 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.