reek 1.2.1 → 1.2.2

data/History.txt

@@ -1,3 +1,9 @@
+== 1.2.2 (under development in github)
+
+=== Minor Changes
+* New smell: Attribute (disabled by default)
+* Removed support for MyClass.should_not reek due to ParseTree EOL
+
 == 1.2.1 (2009-10-02)
 
 === Minor Changes

data/config/defaults.reek

@@ -48,6 +48,10 @@ UtilityFunction:
   exclude: []
 
   enabled: true
+Attribute: 
+  exclude: []
+
+  enabled: false
 SimulatedPolymorphism: 
   exclude: []
 

data/lib/reek.rb

@@ -1,5 +1,5 @@
 $:.unshift File.dirname(__FILE__)
 
 module Reek # :doc:
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

data/lib/reek/adapters/core_extras.rb

@@ -10,14 +10,6 @@ class Object
   def sniff
     Reek::Sniffer.new(self.to_reek_source)
   end
-
-  #
-  # Constructs a Sniffer which examines this object for code smells.
-  # (This feature is only enabled if you have the ParseTree gem installed.)
-  #
-  def to_reek_source
-    ObjectSource.new(self, self.to_s)
-  end
 end
 
 class File

data/lib/reek/adapters/spec.rb

@@ -1,6 +1,5 @@
 require 'reek/sniffer'
 require 'reek/adapters/core_extras'
-require 'reek/adapters/object_source'
 require 'reek/adapters/report'
 
 module Reek

data/lib/reek/class_context.rb

@@ -24,7 +24,7 @@ module Reek
       CodeParser.new(sniffer).process_class(source.syntax_tree)
     end
 
-    attr_reader :conditionals, :parsed_methods, :class_variables
+    attr_reader :conditionals, :parsed_methods, :class_variables, :attributes
 
     # SMELL: inconsistent with other contexts (not linked to the sexp)
     def initialize(outer, name, superclass = nil)
@@ -34,6 +34,7 @@ module Reek
       @parsed_methods = []
       @instance_variables = Set.new
       @conditionals = []
+      @attributes = Set.new
       @class_variables = Set.new
     end
 
@@ -59,6 +60,16 @@ module Reek
       @parsed_methods.length
     end
 
+    def check_for_attribute_declaration(exp)
+      if [:attr, :attr_reader, :attr_writer, :attr_accessor].include? exp[2]
+        exp[3][1..-1].each {|arg| record_attribute(arg[1])}
+      end
+    end
+
+    def record_attribute(attr)
+      @attributes << Name.new(attr)
+    end
+
     def record_class_variable(cvar)
       @class_variables << Name.new(cvar)
     end

data/lib/reek/code_parser.rb

@@ -119,6 +119,7 @@ module Reek
 
     def process_call(exp)
       @element.record_call_to(exp)
+      @element.check_for_attribute_declaration(exp)
       process_default(exp)
     end
 

data/lib/reek/method_context.rb

@@ -85,6 +85,11 @@ module Reek
 
     def record_call_to(exp)
       @calls[exp] += 1
+      record_receiver(exp)
+      check_for_attribute_declaration(exp)
+    end
+
+    def record_receiver(exp)
       receiver, meth = exp[1..2]
       receiver ||= [:self]
       case receiver[0]

data/lib/reek/module_context.rb

@@ -14,14 +14,21 @@ module Reek
       CodeParser.new(sniffer).process_module(source.syntax_tree)
     end
 
-    attr_reader :class_variables
+    attr_reader :class_variables, :attributes
 
     def initialize(outer, name)
       super(outer, nil)
       @name = name
+      @attributes = Set.new
       @class_variables = Set.new
     end
 
+    def check_for_attribute_declaration(exp)
+      if [:attr, :attr_reader, :attr_writer, :attr_accessor].include? exp[2]
+        exp[3][1..-1].each {|arg| record_attribute(arg[1])}
+      end
+    end
+
     def myself
       @myself ||= @outer.find_module(@name)
     end
@@ -35,6 +42,10 @@ module Reek
       "#{@outer.outer_name}#{@name}::"
     end
 
+    def record_attribute(attr)
+      @attributes << Name.new(attr)
+    end
+
     def record_class_variable(cvar)
       @class_variables << Name.new(cvar)
     end

data/lib/reek/smells/attribute.rb

@@ -0,0 +1,48 @@
+require 'reek/smells/smell_detector'
+
+module Reek
+  module Smells
+
+    #
+    # A class that publishes a getter or setter for an instance variable
+    # invites client classes to become too intimate with its inner workings,
+    # and in particular with its representation of state.
+    #
+    # Currently this detector raises a warning for every +attr+,
+    # +attr_reader+, +attr_writer+ and +attr_accessor+ -- including those
+    # that are private.
+    #
+    # TODO:
+    # * eliminate private attributes
+    # * catch attributes declared "by hand"
+    #
+    class Attribute < SmellDetector
+
+      def self.contexts      # :nodoc:
+        [:class, :module]
+      end
+
+      def self.default_config
+        super.adopt(SmellConfiguration::ENABLED_KEY => false)
+      end
+
+      def initialize(config = Attribute.default_config)
+        super(config)
+      end
+
+      #
+      # Checks whether the given class declares any attributes.
+      # Remembers any smells found.
+      #
+      def examine_context(mod)
+        # SMELL: Duplication
+        # MethodContext, ClassContext and ModuleContext all know which
+        # calls constitute attribute declarations. Need a method on
+        # ModuleContext: each_public_call.select [names] {...}
+        mod.attributes.each do |attr|
+          found(mod, "declares the attribute #{attr}")
+        end
+      end
+    end
+  end
+end

data/lib/reek/sniffer.rb

@@ -1,6 +1,7 @@
 require 'reek/detector_stack'
 
 # SMELL: Duplication -- all these should be found automagically
+require 'reek/smells/attribute'
 require 'reek/smells/class_variable'
 require 'reek/smells/control_couple'
 require 'reek/smells/data_clump'
@@ -49,6 +50,7 @@ module Reek
     def self.smell_classes
       # SMELL: Duplication -- these should be loaded by listing the files
       [
+        Smells::Attribute,
         Smells::ClassVariable,
         Smells::ControlCouple,
         Smells::DataClump,

data/reek.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.2.1"
+  s.version = "1.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-10-03}
+  s.date = %q{2009-10-06}
   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", "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/command_line.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/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/class_variable.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/class_variable_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/reek/stop_context_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.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/command_line.rb", "lib/reek/adapters/config_file.rb", "lib/reek/adapters/core_extras.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/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/attribute.rb", "lib/reek/smells/class_variable.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/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/attribute_spec.rb", "spec/reek/smells/behaves_like_variable_detector.rb", "spec/reek/smells/class_variable_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/reek/stop_context_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

data/spec/reek/adapters/should_reek_of_spec.rb

@@ -8,8 +8,14 @@ include Reek::Spec
 
 # belongs in its own spec file
 describe ReekMatcher do
+  before :each do
+    smelly_code = Dir['spec/samples/two_smelly_files/*.rb']
+    @sniffers = smelly_code.sniff.sniffers
+    @full = FullReport.new(@sniffers, '%c %w (%s)', false).report
+  end
+
   it 'reports quietly' do
-    @smelly_code = 'def x() y = 4; end'
+    ReekMatcher.create_reporter(@sniffers).should_not == @full
   end
 end
 

data/spec/reek/code_parser_spec.rb

@@ -5,22 +5,22 @@ require 'reek/code_parser'
 include Reek
 
 describe CodeParser, "with no method definitions" do
-  it 'should report no problems for empty source code' do
+  it 'reports no problems for empty source code' do
     ''.should_not reek
   end
-  it 'should report no problems for empty class' do
+  it 'reports no problems for empty class' do
     'class Fred; end'.should_not reek
   end
 end
 
 describe CodeParser, 'with a global method definition' do
-  it 'should report no problems for simple method' do
+  it 'reports no problems for simple method' do
     'def Outermost::fred() true; end'.should_not reek
   end
 end
 
 describe CodeParser, 'when a yield is the receiver' do
-  it 'should report no problems' do
+  it 'reports no problems' do
     source = 'def values(*args)
   @to_sql += case
     when block_given? then " #{yield.to_sql}"
@@ -140,4 +140,90 @@ describe CodeParser do
       it_should_behave_like 'one variable found'
     end
   end
+
+  context 'with no attributes' do
+    it 'records nothing in the class' do
+      klass = ClassContext.from_s('class Fred; end')
+      klass.attributes.should be_empty
+    end
+    it 'records nothing in the module' do
+      ctx = ModuleContext.from_s('module Fred; end')
+      ctx.attributes.should be_empty
+    end
+  end
+
+  context 'with one attribute' do
+    shared_examples_for 'one attribute found' do
+      it 'records the attribute' do
+        @ctx.attributes.should include(Name.new(:property))
+      end
+      it 'records only that attribute' do
+        @ctx.attributes.length.should == 1
+      end
+    end
+
+    context 'declared in a class' do
+      before :each do
+        @ctx = ClassContext.from_s('class Fred; attr :property; end')
+      end
+
+      it_should_behave_like 'one attribute found'
+    end
+
+    context 'reader in a class' do
+      before :each do
+        @ctx = ClassContext.from_s('class Fred; attr_reader :property; end')
+      end
+
+      it_should_behave_like 'one attribute found'
+    end
+
+    context 'writer in a class' do
+      before :each do
+        @ctx = ClassContext.from_s('class Fred; attr_writer :property; end')
+      end
+
+      it_should_behave_like 'one attribute found'
+    end
+
+    context 'accessor in a class' do
+      before :each do
+        @ctx = ClassContext.from_s('class Fred; attr_accessor :property; end')
+      end
+
+      it_should_behave_like 'one attribute found'
+    end
+
+    context 'declared in a module' do
+      before :each do
+        @ctx = ModuleContext.from_s('module Fred; attr :property; end')
+      end
+
+      it_should_behave_like 'one attribute found'
+    end
+
+    context 'reader in a module' do
+      before :each do
+        @ctx = ModuleContext.from_s('module Fred; attr_reader :property; end')
+      end
+
+      it_should_behave_like 'one attribute found'
+    end
+
+    context 'writer in a module' do
+      before :each do
+        @ctx = ModuleContext.from_s('module Fred; attr_writer :property; end')
+      end
+
+      it_should_behave_like 'one attribute found'
+    end
+
+    context 'accessor in a module' do
+      before :each do
+        @ctx = ModuleContext.from_s('module Fred; attr_accessor :property; end')
+      end
+
+      it_should_behave_like 'one attribute found'
+    end
+  end
 end

data/spec/reek/smells/attribute_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/smells/attribute'
+require 'reek/class_context'
+
+require 'spec/reek/smells/behaves_like_variable_detector'
+
+include Reek
+include Reek::Smells
+
+describe Attribute do
+  before :each do
+    @detector = Attribute.new
+    @record_variable = :record_attribute
+  end
+
+  [ClassContext, ModuleContext].each do |klass|
+    context "in a #{klass}" do
+      before :each do
+        @ctx = klass.create(StopContext.new, "Fred")
+      end
+
+      it_should_behave_like 'a variable detector'
+    end
+  end
+end

data/spec/reek/smells/behaves_like_variable_detector.rb

@@ -0,0 +1,39 @@
+shared_examples_for 'a variable detector' do
+  context 'with no variables' do
+    it "doesn't record a smell" do
+      @detector.examine_context(@ctx)
+      @detector.num_smells.should == 0
+    end
+  end
+
+  context 'with one variable encountered twice' do
+    before :each do
+      @ctx.send(@record_variable, :something)
+      @ctx.send(@record_variable, :something)
+      @detector.examine_context(@ctx)
+    end
+
+    it 'records only one smell' do
+      @detector.num_smells.should == 1
+    end
+    it 'mentions the variable name in the report' do
+      @detector.should have_smell([/something/])
+    end
+  end
+
+  context 'with two variables' do
+    before :each do
+      @ctx.send(@record_variable, :something)
+      @ctx.send(@record_variable, :something_else)
+      @detector.examine_context(@ctx)
+    end
+
+    it 'records both smells' do
+      @detector.num_smells.should == 2
+    end
+    it 'mentions both variable names in the report' do
+      @detector.should have_smell([/something/])
+      @detector.should have_smell([/something_else/])
+    end
+  end
+end

data/spec/reek/smells/class_variable_spec.rb

@@ -3,79 +3,24 @@ require File.dirname(__FILE__) + '/../../spec_helper.rb'
 require 'reek/smells/class_variable'
 require 'reek/class_context'
 
+require 'spec/reek/smells/behaves_like_variable_detector'
+
 include Reek
 include Reek::Smells
 
 describe ClassVariable do
-  shared_examples_for 'a class variable container' do
-    context 'no class variables' do
-      it "doesn't record a smell" do
-        @detector.examine_context(@ctx)
-        @detector.num_smells.should == 0
-      end
-    end
-
-    context 'one class variable' do
-      before :each do
-        @ctx.record_class_variable(:@@cvar)
-        @detector.examine_context(@ctx)
-      end
-
-      it 'records a smell' do
-        @detector.num_smells.should == 1
-      end
-      it 'mentions the variable name in the report' do
-        @detector.should have_smell([/@@cvar/])
-      end
-    end
-
-    context 'one class variable encountered twice' do
-      before :each do
-        @ctx.record_class_variable(:@@cvar)
-        @ctx.record_class_variable(:@@cvar)
-        @detector.examine_context(@ctx)
-      end
-
-      it 'records only one smell' do
-        @detector.num_smells.should == 1
-      end
-      it 'mentions the variable name in the report' do
-        @detector.should have_smell([/@@cvar/])
-      end
-    end
+  before :each do
+    @detector = ClassVariable.new
+    @record_variable = :record_class_variable
+  end
 
-    context 'two class variables' do
+  [ClassContext, ModuleContext].each do |klass|
+    context "in a #{klass}" do
       before :each do
-        @ctx.record_class_variable(:@@cvar)
-        @ctx.record_class_variable(:@@another)
-        @detector.examine_context(@ctx)
-      end
-
-      it 'records a smell' do
-        @detector.num_smells.should == 2
-      end
-      it 'mentions both variable names in the report' do
-        @detector.should have_smell([/@@cvar/])
-        @detector.should have_smell([/@@another/])
+        @ctx = klass.create(StopContext.new, "Fred")
       end
-    end
-  end
 
-  context 'in a class' do
-    before :each do
-      @ctx = ClassContext.create(StopContext.new, "Fred")
-      @detector = ClassVariable.new
+      it_should_behave_like 'a variable detector'
     end
-
-    it_should_behave_like 'a class variable container'
-  end
-
-  context 'in a module' do
-    before :each do
-      @ctx = ModuleContext.create(StopContext.new, "Fred")
-      @detector = ClassVariable.new
-    end
-
-    it_should_behave_like 'a class variable container'
   end
 end

data/spec/reek/smells/large_class_spec.rb

@@ -8,57 +8,6 @@ require 'reek/smells/large_class'
 include Reek
 include Reek::Smells
 
-describe LargeClass, 'checking Class objects' do
-
-  it 'should not report class with 26 methods' do
-    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
-    class BigOne
-      26.times do |i|
-        define_method "method#{i}x".to_sym do
-          @melting
-        end
-      end
-    end
-    BigOne.should_not reek
-  end
-
-  it 'should not report short class' do
-    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
-    class ShortClass
-      def method_a() @var_a; end
-      def method_b() @var_b; end
-      def method_c() @var_c; end
-      def method_d() @var_d; end
-      def method_e() @var_e; end
-      def method_f() @var_f; end
-    end
-    ShortClass.should_not reek
-  end
-
-  describe LargeClass, 'counting instance variables' do
-    it 'should not report class with 10 ivars' do
-      pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
-      class ManyIvars
-        def meth
-          @vara = @varb = @varc = @vard = @vare
-          @varf = @varg = @varh = @vari = @varj
-        end
-      end
-      ManyIvars.should_not reek
-    end
-
-    it 'ignores class with only a couple of ivars' do
-      pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
-      LargeClass.should_not reek_of(:LargeClass)
-    end
-
-    it 'ignores fq class with only a couple of ivars' do
-    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
-      Reek::Smells::LargeClass.should_not reek_of(:LargeClass)
-    end
-  end
-end
-
 describe LargeClass, 'when exceptions are listed' do
 
   before(:each) do

data/spec/reek/smells/long_parameter_list_spec.rb

@@ -53,18 +53,6 @@ describe LongParameterList do
         'def simple(aarg, polly=2, yep=true, zero=nil) f(3);false end'.should reek_only_of(:LongParameterList, /4 parameters/)
       end
     end
-    
-    describe 'in a class' do
-      class InnerTest
-        def xyzero(arga,argb) f(3);true end
-        def abc(argx,yep,zero,argm) f(3);false end
-      end
-
-      it 'should only report long param list' do
-        pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
-        InnerTest.should reek_only_of(:LongParameterList, /abc/)
-      end
-    end
   end
   
   describe 'yield' do

data/spec/reek/smells/utility_function_spec.rb

@@ -79,24 +79,3 @@ EOS
     end
   end
 end
-
-describe UtilityFunction do
-  it 'should not report attrset' do
-    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
-    class Fred
-      attr_writer :xyz
-    end
-    Fred.should_not reek
-  end
-
-  it 'should not report overriding methods' do
-    pending('test requires ParseTree') unless ObjectSource.can_parse_objects?
-    class Father
-      def thing(ff); @kids = 0; end
-    end
-    class Son < Father
-      def thing(ff); ff; end
-    end
-    Son.should_not reek
-  end
-end

data/tasks/test.rake

@@ -6,7 +6,6 @@ require 'spec/rake/spectask'
 
 namespace 'test' do
   UNIT_TESTS = FileList['spec/reek/**/*_spec.rb']
-  QUALITY_TESTS = FileList['spec/quality/**/*_spec.rb']
 
   Spec::Rake::SpecTask.new('spec') do |t|
     t.spec_files = UNIT_TESTS
@@ -16,7 +15,7 @@ namespace 'test' do
   end
 
   Spec::Rake::SpecTask.new('quality') do |t|
-    t.spec_files = QUALITY_TESTS
+    t.spec_files = FileList['quality/**/*_spec.rb']
     t.spec_opts = ['--color']
     t.ruby_opts = ['-Ilib']
     t.rcov = false
@@ -24,7 +23,7 @@ namespace 'test' do
 
   desc 'Runs all unit tests under RCov'
   Spec::Rake::SpecTask.new('rcov') do |t|
-    t.spec_files = UNIT_TESTS + QUALITY_TESTS
+    t.spec_files = UNIT_TESTS
     t.rcov = true
     t.rcov_dir = 'build/coverage'
   end
@@ -39,7 +38,7 @@ namespace 'test' do
   end
 
   desc 'Runs all unit tests, acceptance tests and quality checks'
-  task 'all' => ['test:spec', 'test:features', 'test:quality', 'test:multiruby']
+  task 'all' => ['test:spec', 'test:features', 'test:multiruby']
 end
 
 task 'clobber_rcov' => 'test:clobber_rcov'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reek
 version: !ruby/object:Gem::Version 
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-03 00:00:00 +01:00
+date: 2009-10-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,7 +72,6 @@ files:
 - lib/reek/adapters/command_line.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
@@ -92,6 +91,7 @@ files:
 - lib/reek/sexp_formatter.rb
 - lib/reek/singleton_method_context.rb
 - lib/reek/smell_warning.rb
+- lib/reek/smells/attribute.rb
 - lib/reek/smells/class_variable.rb
 - lib/reek/smells/control_couple.rb
 - lib/reek/smells/data_clump.rb
@@ -110,7 +110,6 @@ files:
 - 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
@@ -129,6 +128,8 @@ files:
 - spec/reek/object_source_spec.rb
 - spec/reek/singleton_method_context_spec.rb
 - spec/reek/smell_warning_spec.rb
+- spec/reek/smells/attribute_spec.rb
+- spec/reek/smells/behaves_like_variable_detector.rb
 - spec/reek/smells/class_variable_spec.rb
 - spec/reek/smells/control_couple_spec.rb
 - spec/reek/smells/data_clump_spec.rb

data/lib/reek/adapters/object_source.rb

@@ -1,52 +0,0 @@
-require 'reek/adapters/source'
-require 'reek/configuration'
-require 'reek/smells/large_class'
-
-include Reek::Smells
-
-module Reek
-  class ObjectSource < Source   # :nodoc:
-
-    def self.unify(sexp)   # :nodoc:
-      unifier = Unifier.new
-      unifier.processors.each do |proc|
-        proc.unsupported.delete :cfunc # HACK
-      end
-      return unifier.process(sexp[0])
-    end
-
-    def configure(sniffer)
-      super
-      disabled_config = {Reek::SmellConfiguration::ENABLED_KEY => false}
-      sniffer.configure(LargeClass, disabled_config)
-    end
-
-    def self.can_parse_objects?
-      return true if Object.const_defined?(:ParseTree)
-      begin
-        require 'parse_tree'
-        true
-      rescue LoadError
-        false
-      end
-    end
-
-    def syntax_tree
-      if ObjectSource.can_parse_objects?
-        ObjectSource.unify(ParseTree.new.parse_tree(@source))
-      else
-        throw ArgumentError.new('You must install the ParseTree gem to use this feature')
-      end
-    end
-  end
-end
-
-class Object
-  #
-  # Constructs a Sniffer which examines this object for code smells.
-  # (This feature is only enabled if you have the ParseTree gem installed.)
-  #
-  def to_reek_source
-    ObjectSource.new(self, self.to_s)
-  end
-end

data/spec/quality/reek_source_spec.rb

@@ -1,15 +0,0 @@
-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 == []
-    end
-  end
-
-end