reek 1.1.3 → 1.2.0

data/lib/reek/sniffer.rb

@@ -0,0 +1,183 @@
+require 'reek/detector_stack'
+
+# SMELL: Duplication -- all these should be found automagically
+require 'reek/smells/control_couple'
+require 'reek/smells/data_clump'
+require 'reek/smells/duplication'
+require 'reek/smells/feature_envy'
+require 'reek/smells/large_class'
+require 'reek/smells/long_method'
+require 'reek/smells/long_parameter_list'
+require 'reek/smells/long_yield_list'
+require 'reek/smells/nested_iterators'
+require 'reek/smells/simulated_polymorphism'
+require 'reek/smells/uncommunicative_name'
+require 'reek/smells/utility_function'
+require 'reek/code_parser'
+require 'yaml'
+
+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
+
+module Reek
+  class Sniffer
+
+    def self.smell_classes
+      # SMELL: Duplication -- these should be loaded by listing the files
+      [
+        Smells::ControlCouple,
+        Smells::DataClump,
+        Smells::Duplication,
+        Smells::FeatureEnvy,
+        Smells::LargeClass,
+        Smells::LongMethod,
+        Smells::LongParameterList,
+        Smells::LongYieldList,
+        Smells::NestedIterators,
+        Smells::SimulatedPolymorphism,
+        Smells::UncommunicativeName,
+        Smells::UtilityFunction,
+      ]
+    end
+
+    def initialize(src)
+      @already_checked_for_smells = false
+      @typed_detectors = nil
+      @detectors = Hash.new
+      Sniffer.smell_classes.each { |klass| @detectors[klass] = DetectorStack.new(klass.new) }
+      @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)
+      @detectors[klass].push(config)
+    end
+
+    def report_on(report)
+      check_for_smells
+      @detectors.each_value { |stack| stack.report_on(report) }
+    end
+
+    def examine(scope, type)
+      listeners = smell_listeners[type]
+      listeners.each {|smell| smell.examine(scope) } if listeners
+    end
+
+    def smelly?
+      check_for_smells
+      @detectors.each_value { |stack| return true if stack.smelly? }
+      false
+    end
+
+    def num_smells
+      check_for_smells
+      total = 0
+      @detectors.each_value { |stack| total += stack.num_smells }
+      total
+    end
+
+    def desc
+      # SMELL: Special Case
+      # Only used in the Report tests, because they don't always create a Source.
+      @source ? @source.desc : "unknown"
+    end
+
+    #
+    # Checks for instances of +smell_class+, and returns +true+
+    # only if one of them has a report string matching all of the +patterns+.
+    #
+    def has_smell?(smell_class, patterns=[])
+      check_for_smells
+      stack = @detectors[Reek::Smells.const_get(smell_class)]      # SMELL: Duplication of code in ConfigFile
+      stack.has_smell?(patterns)
+    end
+
+    def smells_only_of?(klass, patterns)
+      num_smells == 1 and has_smell?(klass, patterns)
+    end
+
+    def sniff
+      self
+    end
+
+    def sniffers
+      [self]
+    end
+
+private
+
+    def smell_listeners()
+      unless @typed_detectors
+        @typed_detectors = Hash.new {|hash,key| hash[key] = [] }
+        @detectors.each_value { |stack| stack.listen_to(@typed_detectors) }
+      end
+      @typed_detectors
+    end
+  end
+
+  class SnifferSet
+
+    attr_reader :desc, :sniffers
+
+    def initialize(sniffers, desc)
+      @sniffers = sniffers
+      @desc = desc
+    end
+
+    def smelly?
+      @sniffers.any? {|sniffer| sniffer.smelly? }
+    end
+
+    #
+    # Checks for instances of +smell_class+, and returns +true+
+    # only if one of them has a report string matching all of the +patterns+.
+    #
+    def has_smell?(smell_class, patterns=[])
+      @sniffers.any? {|sniffer| sniffer.has_smell?(smell_class, patterns)}
+    end
+
+    def num_smells
+      total = 0
+      @sniffers.each {|sniffer| total += sniffer.num_smells}
+      total
+    end
+
+    def smells_only_of?(klass, patterns)
+      num_smells == 1 and has_smell?(klass, patterns)
+    end
+
+    def sniff
+      self
+    end
+
+  end
+end

data/reek.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.1.3"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-05-19}
+  s.date = %q{2009-09-20}
   s.default_executable = %q{reek}
   s.description = %q{Code smell detector for Ruby}
   s.email = ["kevin@rutherford-software.com"]
   s.executables = ["reek"]
-  s.extra_rdoc_files = ["History.txt", "README.txt"]
-  s.files = ["History.txt", "README.txt", "Rakefile", "bin/reek", "config/defaults.reek", "lib/reek.rb", "lib/reek/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/exceptions.reek", "lib/reek/if_context.rb", "lib/reek/method_context.rb", "lib/reek/module_context.rb", "lib/reek/name.rb", "lib/reek/object_refs.rb", "lib/reek/object_source.rb", "lib/reek/options.rb", "lib/reek/rake_task.rb", "lib/reek/report.rb", "lib/reek/sexp_formatter.rb", "lib/reek/singleton_method_context.rb", "lib/reek/smell_warning.rb", "lib/reek/smells/control_couple.rb", "lib/reek/smells/duplication.rb", "lib/reek/smells/feature_envy.rb", "lib/reek/smells/large_class.rb", "lib/reek/smells/long_method.rb", "lib/reek/smells/long_parameter_list.rb", "lib/reek/smells/long_yield_list.rb", "lib/reek/smells/nested_iterators.rb", "lib/reek/smells/smell_detector.rb", "lib/reek/smells/smells.rb", "lib/reek/smells/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/source.rb", "lib/reek/spec.rb", "lib/reek/stop_context.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "spec/reek/block_context_spec.rb", "spec/reek/class_context_spec.rb", "spec/reek/code_context_spec.rb", "spec/reek/code_parser_spec.rb", "spec/reek/config_spec.rb", "spec/reek/if_context_spec.rb", "spec/reek/method_context_spec.rb", "spec/reek/module_context_spec.rb", "spec/reek/name_spec.rb", "spec/reek/object_refs_spec.rb", "spec/reek/options_spec.rb", "spec/reek/report_spec.rb", "spec/reek/singleton_method_context_spec.rb", "spec/reek/smells/control_couple_spec.rb", "spec/reek/smells/duplication_spec.rb", "spec/reek/smells/feature_envy_spec.rb", "spec/reek/smells/large_class_spec.rb", "spec/reek/smells/long_method_spec.rb", "spec/reek/smells/long_parameter_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/smell_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/slow/inline_spec.rb", "spec/slow/optparse_spec.rb", "spec/slow/redcloth_spec.rb", "spec/slow/reek_source_spec.rb", "spec/slow/samples/inline.rb", "spec/slow/samples/optparse.rb", "spec/slow/samples/redcloth.rb", "spec/slow/script_spec.rb", "spec/slow/source_list_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/rspec.rake"]
+  s.extra_rdoc_files = ["History.txt", "License.txt", "README.rdoc"]
+  s.files = ["History.txt", "License.txt", "README.rdoc", "Rakefile", "bin/reek", "config/defaults.reek", "features/masking_smells.feature", "features/options.feature", "features/reports.feature", "features/samples.feature", "features/stdin.feature", "features/step_definitions/reek_steps.rb", "features/support/env.rb", "lib/reek.rb", "lib/reek/adapters/application.rb", "lib/reek/adapters/config_file.rb", "lib/reek/adapters/core_extras.rb", "lib/reek/adapters/object_source.rb", "lib/reek/adapters/rake_task.rb", "lib/reek/adapters/report.rb", "lib/reek/adapters/source.rb", "lib/reek/adapters/spec.rb", "lib/reek/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/command_line.rb", "lib/reek/configuration.rb", "lib/reek/detector_stack.rb", "lib/reek/exceptions.reek", "lib/reek/if_context.rb", "lib/reek/method_context.rb", "lib/reek/module_context.rb", "lib/reek/name.rb", "lib/reek/object_refs.rb", "lib/reek/sexp_formatter.rb", "lib/reek/singleton_method_context.rb", "lib/reek/smell_warning.rb", "lib/reek/smells/control_couple.rb", "lib/reek/smells/data_clump.rb", "lib/reek/smells/duplication.rb", "lib/reek/smells/feature_envy.rb", "lib/reek/smells/large_class.rb", "lib/reek/smells/long_method.rb", "lib/reek/smells/long_parameter_list.rb", "lib/reek/smells/long_yield_list.rb", "lib/reek/smells/nested_iterators.rb", "lib/reek/smells/simulated_polymorphism.rb", "lib/reek/smells/smell_detector.rb", "lib/reek/smells/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/sniffer.rb", "lib/reek/stop_context.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "spec/quality/reek_source_spec.rb", "spec/reek/adapters/report_spec.rb", "spec/reek/adapters/should_reek_of_spec.rb", "spec/reek/adapters/should_reek_only_of_spec.rb", "spec/reek/adapters/should_reek_spec.rb", "spec/reek/block_context_spec.rb", "spec/reek/class_context_spec.rb", "spec/reek/code_context_spec.rb", "spec/reek/code_parser_spec.rb", "spec/reek/config_spec.rb", "spec/reek/configuration_spec.rb", "spec/reek/if_context_spec.rb", "spec/reek/method_context_spec.rb", "spec/reek/module_context_spec.rb", "spec/reek/name_spec.rb", "spec/reek/object_refs_spec.rb", "spec/reek/object_source_spec.rb", "spec/reek/singleton_method_context_spec.rb", "spec/reek/smell_warning_spec.rb", "spec/reek/smells/control_couple_spec.rb", "spec/reek/smells/data_clump_spec.rb", "spec/reek/smells/duplication_spec.rb", "spec/reek/smells/feature_envy_spec.rb", "spec/reek/smells/large_class_spec.rb", "spec/reek/smells/long_method_spec.rb", "spec/reek/smells/long_parameter_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/simulated_polymorphism_spec.rb", "spec/reek/smells/smell_detector_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/reek/sniffer_spec.rb", "spec/samples/all_but_one_masked/clean_one.rb", "spec/samples/all_but_one_masked/dirty.rb", "spec/samples/all_but_one_masked/masked.reek", "spec/samples/clean_due_to_masking/clean_one.rb", "spec/samples/clean_due_to_masking/clean_three.rb", "spec/samples/clean_due_to_masking/clean_two.rb", "spec/samples/clean_due_to_masking/dirty_one.rb", "spec/samples/clean_due_to_masking/dirty_two.rb", "spec/samples/clean_due_to_masking/masked.reek", "spec/samples/corrupt_config_file/corrupt.reek", "spec/samples/corrupt_config_file/dirty.rb", "spec/samples/empty_config_file/dirty.rb", "spec/samples/empty_config_file/empty.reek", "spec/samples/exceptions.reek", "spec/samples/inline.rb", "spec/samples/masked/dirty.rb", "spec/samples/masked/masked.reek", "spec/samples/mixed_results/clean_one.rb", "spec/samples/mixed_results/clean_three.rb", "spec/samples/mixed_results/clean_two.rb", "spec/samples/mixed_results/dirty_one.rb", "spec/samples/mixed_results/dirty_two.rb", "spec/samples/not_quite_masked/dirty.rb", "spec/samples/not_quite_masked/masked.reek", "spec/samples/optparse.rb", "spec/samples/overrides/masked/dirty.rb", "spec/samples/overrides/masked/lower.reek", "spec/samples/overrides/upper.reek", "spec/samples/redcloth.rb", "spec/samples/three_clean_files/clean_one.rb", "spec/samples/three_clean_files/clean_three.rb", "spec/samples/three_clean_files/clean_two.rb", "spec/samples/two_smelly_files/dirty_one.rb", "spec/samples/two_smelly_files/dirty_two.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/test.rake"]
   s.homepage = %q{http://wiki.github.com/kevinrutherford/reek}
   s.post_install_message = %q{
 For more information on reek, see http://wiki.github.com/kevinrutherford/reek
@@ -20,7 +20,7 @@ For more information on reek, see http://wiki.github.com/kevinrutherford/reek
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{reek}
-  s.rubygems_version = %q{1.3.3}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Code smell detector for Ruby}
 
   if s.respond_to? :specification_version then

data/spec/quality/reek_source_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe 'Reek source code' do
+  it 'has no smells' do
+    Dir['lib/**/*.rb'].should_not reek
+  end
+
+  nucleus = Dir['lib/reek/**.rb'] - Dir['lib/reek/adapters/**/*.rb']
+  nucleus.each do |src|
+    it "#{src} contains no references from the nucleus out to the adapters" do
+      IO.readlines(src).grep(/adapters/).should be_empty
+    end
+  end
+
+end

data/spec/reek/adapters/report_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/adapters/core_extras'
+require 'reek/adapters/report'
+require 'reek/adapters/source'
+require 'reek/smells/feature_envy'
+
+include Reek
+
+describe ReportSection, " when empty" do
+  before(:each) do
+    @rpt = ReportSection.new(''.sniff)
+  end
+
+  it 'has an empty quiet_report' do
+    @rpt.quiet_report.should == ''
+  end
+end
+
+describe ReportSection, "smell_list" do
+  before(:each) do
+    rpt = ReportSection.new('def simple(a) a[3] end'.sniff)
+    @lines = rpt.smell_list.split("\n")
+  end
+
+  it 'should mention every smell name' do
+    @lines.should have_at_least(2).lines
+    @lines[0].should match(/[Utility Function]/)
+    @lines[1].should match(/[Feature Envy]/)
+  end
+end
+
+describe ReportSection, " as a SortedSet" do
+  it 'should only add a smell once' do
+    rpt = ReportSection.new(''.sniff)
+    rpt << SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!', false)
+    rpt << SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!', false)
+    lines = rpt.smell_list.split("\n")
+    lines.should have(1).lines
+  end
+
+  it 'should not count an identical masked smell' do
+    rpt = ReportSection.new(''.sniff)
+    # SMELL: Duplication -- the SmellWarning knows whether to call << or record_masked_smell
+    rpt << SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!', false)
+    rpt.record_masked_smell(SmellWarning.new(Smells::FeatureEnvy.new, "self", 'too many!', true))
+    rpt.header.should == 'string -- 1 warning'
+  end
+end

data/spec/reek/adapters/should_reek_of_spec.rb

@@ -0,0 +1,108 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/adapters/report'
+require 'reek/adapters/spec'
+
+include Reek
+include Reek::Spec
+
+describe ShouldReekOf, 'rdoc demo example' do
+  it 'works on a common source' do
+    ruby = 'def double_thing() @other.thing.foo + @other.thing.foo end'
+    ruby.should reek_of(:Duplication, /@other.thing[^\.]/)
+    ruby.should reek_of(:Duplication, /@other.thing.foo/)
+    ruby.should_not reek_of(:FeatureEnvy)
+  end
+
+  it 'works on a common sniffer' do
+    ruby = 'def double_thing() @other.thing.foo + @other.thing.foo end'.sniff
+    ruby.should reek_of(:Duplication, /@other.thing[^\.]/)
+    ruby.should reek_of(:Duplication, /@other.thing.foo/)
+    ruby.should_not reek_of(:FeatureEnvy)
+  end
+end
+
+describe ShouldReekOf, 'checking code in a string' do
+  before :each do
+    @clean_code = 'def good() true; end'
+    @smelly_code = 'def x() y = 4; end'
+    @matcher = ShouldReekOf.new(:UncommunicativeName, [/x/, /y/])
+  end
+
+  it 'matches a smelly String' do
+    @matcher.matches?(@smelly_code).should be_true
+  end
+
+  it 'doesnt match a fragrant String' do
+    @matcher.matches?(@clean_code).should be_false
+  end
+
+  it 'reports the smells when should_not fails' do
+    @matcher.matches?(@smelly_code).should be_true
+    @matcher.failure_message_for_should_not.should include(Report.new(@smelly_code.sniff).quiet_report)
+  end
+end
+
+describe ShouldReekOf, 'checking code in a Dir' do
+  before :each do
+    @clean_dir = Dir['spec/samples/three_clean_files/*.rb']
+    @smelly_dir = Dir['spec/samples/two_smelly_files/*.rb']
+    @matcher = ShouldReekOf.new(:UncommunicativeName, [/Dirty/, /@s/])
+  end
+
+  it 'matches a smelly String' do
+    @matcher.matches?(@smelly_dir).should be_true
+  end
+
+  it 'doesnt match a fragrant String' do
+    @matcher.matches?(@clean_dir).should be_false
+  end
+
+  it 'reports the smells when should_not fails' do
+    @matcher.matches?(@smelly_dir).should be_true
+    @matcher.failure_message_for_should_not.should include(Report.new(@smelly_dir.sniff.sniffers).quiet_report)
+  end
+end
+
+describe ShouldReekOf, 'checking code in a File' do
+  before :each do
+    @clean_file = File.new(Dir['spec/samples/three_clean_files/*.rb'][0])
+    @smelly_file = File.new(Dir['spec/samples/two_smelly_files/*.rb'][0])
+    @matcher = ShouldReekOf.new(:UncommunicativeName, [/Dirty/, /@s/])
+  end
+
+  it 'matches a smelly String' do
+    @matcher.matches?(@smelly_file).should be_true
+  end
+
+  it 'doesnt match a fragrant String' do
+    @matcher.matches?(@clean_file).should be_false
+  end
+
+  it 'reports the smells when should_not fails' do
+    @matcher.matches?(@smelly_file).should be_true
+    @matcher.failure_message_for_should_not.should include(Report.new(@smelly_file.sniff).quiet_report)
+  end
+end
+
+describe ShouldReekOf, 'report formatting' do
+  before :each do
+    sn_clean = 'def clean() @thing = 4; end'.sniff
+    sn_dirty = 'def dirty() thing.cool + thing.cool; end'.sniff
+    sniffers = SnifferSet.new([sn_clean, sn_dirty], '')
+    @matcher = ShouldReekOf.new(:UncommunicativeName, [/Dirty/, /@s/])
+    @matcher.matches?(sniffers)
+    @lines = @matcher.failure_message_for_should_not.split("\n").map {|str| str.chomp}
+    @error_message = @lines.shift
+    @smells = @lines.grep(/^  /)
+    @headers = (@lines - @smells)
+  end
+
+  it 'mentions every smell in the report' do
+    @smells.should have(2).warnings
+  end
+
+  it 'doesnt mention the clean source' do
+    @headers.should have(1).headers
+  end
+end

data/spec/reek/adapters/should_reek_only_of_spec.rb

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/adapters/report'
+require 'reek/adapters/spec'
+
+include Reek
+include Reek::Spec
+
+describe ShouldReekOnlyOf, 'checking code in a string' do
+  before :each do
+    @clean_code = 'def good() true; end'
+    @smelly_code = 'def fine() y = 4; end'
+    @matcher = ShouldReekOnlyOf.new(:UncommunicativeName, [/y/])
+  end
+
+  it 'matches a smelly String' do
+    @matcher.matches?(@smelly_code).should be_true
+  end
+
+  it 'doesnt match a fragrant String' do
+    @matcher.matches?(@clean_code).should be_false
+  end
+
+  it 'reports the smells when should_not fails' do
+    @matcher.matches?(@smelly_code).should be_true
+    @matcher.failure_message_for_should_not.should include('UncommunicativeName')
+  end
+end
+
+describe ShouldReekOnlyOf, 'checking code in a Dir' do
+  before :each do
+    @clean_dir = Dir['spec/samples/three_clean_files/*.rb']
+    @smelly_dir = Dir['spec/samples/all_but_one_masked/*.rb']
+    @matcher = ShouldReekOnlyOf.new(:NestedIterators, [/Dirty\#a/])
+  end
+
+  it 'matches a smelly String' do
+    @matcher.matches?(@smelly_dir).should be_true
+  end
+
+  it 'doesnt match a fragrant String' do
+    @matcher.matches?(@clean_dir).should be_false
+  end
+
+  it 'reports the smells when should_not fails' do
+    @matcher.matches?(@smelly_dir).should be_true
+    @matcher.failure_message_for_should.should include(Report.new(@smelly_dir.sniff.sniffers).quiet_report)
+  end
+end
+
+describe ShouldReekOnlyOf, 'checking code in a File' do
+  before :each do
+    @clean_file = File.new(Dir['spec/samples/three_clean_files/*.rb'][0])
+    @smelly_file = File.new(Dir['spec/samples/all_but_one_masked/d*.rb'][0])
+    @matcher = ShouldReekOnlyOf.new(:NestedIterators, [/Dirty\#a/])
+  end
+
+  it 'matches a smelly String' do
+    @matcher.matches?(@smelly_file).should be_true
+  end
+
+  it 'doesnt match a fragrant String' do
+    @matcher.matches?(@clean_file).should be_false
+  end
+
+  it 'reports the smells when should_not fails' do
+    @matcher.matches?(@smelly_file).should be_true
+    @matcher.failure_message_for_should.should include(Report.new(@smelly_file.sniff).quiet_report)
+  end
+end
+
+describe ShouldReekOnlyOf, 'report formatting' do
+  before :each do
+    @smelly_dir = Dir['spec/samples/all_but_one_masked/*.rb']
+    @matcher = ShouldReekOnlyOf.new(:NestedIterators, [/Dirty\#a/])
+    @matcher.matches?(@smelly_dir)
+    @lines = @matcher.failure_message_for_should.split("\n").map {|str| str.chomp}
+    @error_message = @lines.shift
+    @smells = @lines.grep(/^  /)
+    @headers = (@lines - @smells)
+  end
+
+  it 'doesnt mention the clean files' do
+    @headers.should have(1).header
+    @headers.should_not include('clean')
+  end
+end