kevinrutherford-reek 1.1.3.7 → 1.1.3.8

data/History.txt

@@ -7,6 +7,8 @@
 ** Output now reports on all files examined, even if they have no smells
 ** Smell warnings are indented in the report; file summary headers are not
 ** Reports for multiple sources are run together; no more blank lines
+* The smells masked by *.reek config files can now be seen:
+** The header for each source file now counts masked smells
 
 === Minor Changes
 * Several changes to the LongMethod counting algorithm:

data/features/masking_smells.feature

@@ -22,7 +22,7 @@ Feature: Masking smells using config files
   Scenario: corrupt config file prevents normal output
     When I run reek spec/samples/corrupt_config_file/dirty.rb
     Then it fails with exit status 1
-    And it reports the error 'Error: invalid configuration file "corrupt.reek"'
+    And it reports the error 'Error: Invalid configuration file "corrupt.reek" -- not a Hash'
 
   Scenario: missing source file is an error
     When I run reek no_such_file.rb
@@ -34,7 +34,7 @@ Feature: Masking smells using config files
     Then it fails with exit status 2
     And it reports:
       """
-      spec/samples/masked/dirty.rb -- 3 warnings:
+      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
         Dirty#a calls @s.title multiple times (Duplication)
         Dirty#a calls puts(@s.title) multiple times (Duplication)
         Dirty#a/block/block is nested (Nested Iterators)

data/lib/reek/config_file.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+module Reek
+  class ConfigFile
+
+    def initialize(file_path)
+      @file_path = file_path
+      @hash = YAML.load_file(@file_path) || {}
+      problem('not a Hash') unless Hash === @hash
+    end
+
+    #
+    # Configure the given sniffer using the contents of the config file.
+    #
+    def configure(sniffer)
+      @hash.each { |klass_name, config|
+        sniffer.configure(find_class(klass_name), config)
+      }
+    end
+
+    def find_class(name)
+      klass = Reek::Smells.const_get(name)
+      problem("#{name} is not a code smell") unless klass
+      klass
+    end
+
+    def problem(reason)
+      raise "Invalid configuration file \"#{File.basename(@file_path)}\" -- #{reason}"
+    end
+  end
+end

data/lib/reek/detector_stack.rb

@@ -0,0 +1,24 @@
+
+module Reek
+  class DetectorStack
+
+    def initialize(default_detector)
+      @detectors = [default_detector]
+    end
+
+    def push(config)
+      det = @detectors[0].copy
+      det.configure_with(config)
+      @detectors.each {|smell| smell.be_masked}
+      @detectors << det
+    end
+
+    def listen_to(hooks)
+      @detectors.each { |smell| smell.listen_to(hooks) }
+    end
+
+    def report_on(report)
+      @detectors.each { |smell| smell.report_on(report) }
+    end
+  end
+end

data/lib/reek/object_source.rb

@@ -22,7 +22,7 @@ module Reek
 
     def initialize(code, desc)     # :nodoc:
       super
-      @sniffer.disable('LargeClass')
+      @sniffer.disable(LargeClass)
     end
 
     def can_parse_objects?

data/lib/reek/smells/duplication.rb

@@ -29,8 +29,7 @@ module Reek
       end
 
       def initialize(config = Duplication.default_config)
-        super
-        @max_calls = config[MAX_ALLOWED_CALLS_KEY]
+        super(config)
       end
 
       def examine_context(method)
@@ -41,7 +40,7 @@ module Reek
       
       def smelly_calls(method)   # :nodoc:
         method.calls.select do |key,val|
-          val > @max_calls and key[2] != :new
+          val > @config[MAX_ALLOWED_CALLS_KEY] and key[2] != :new
         end.map { |call_exp| call_exp[0] }
       end
     end

data/lib/reek/smells/large_class.rb

@@ -37,20 +37,18 @@ module Reek
       end
 
       def initialize(config = LargeClass.default_config)
-        super
-        @max_methods = config[MAX_ALLOWED_METHODS_KEY]
-        @max_instance_variables = config[MAX_ALLOWED_IVARS_KEY]
+        super(config)
       end
 
       def check_num_methods(klass)  # :nodoc:
         count = klass.num_methods
-        return if count <= @max_methods
+        return if count <= @config[MAX_ALLOWED_METHODS_KEY]
         found(klass, "has at least #{count} methods")
       end
 
       def check_num_ivars(klass)  # :nodoc:
         count = klass.variable_names.length
-        return if count <= @max_instance_variables
+        return if count <= @config[MAX_ALLOWED_IVARS_KEY]
         found(klass, "has at least #{count} instance variables")
       end
 

data/lib/reek/smells/long_method.rb

@@ -23,9 +23,14 @@ module Reek
         )
       end
 
+      attr_reader :max_statements
+
       def initialize(config = LongMethod.default_config)
-        super
-        @max_statements = config[MAX_ALLOWED_STATEMENTS_KEY]
+        super(config)
+      end
+
+      def max_statements
+        @config['max_statements']
       end
 
       #
@@ -34,7 +39,7 @@ module Reek
       #
       def examine_context(method)
         num = method.num_statements
-        return false if num <= @max_statements
+        return false if num <= max_statements
         found(method, "has approx #{num} statements")
       end
     end

data/lib/reek/smells/long_parameter_list.rb

@@ -22,9 +22,8 @@ module Reek
         super.adopt(MAX_ALLOWED_PARAMS_KEY => 3)
       end
 
-      def initialize(config)
-        super
-        @max_params = config['max_params']
+      def initialize(config = LongParameterList.default_config)
+        super(config)
         @action = 'has'
       end
 
@@ -34,7 +33,7 @@ module Reek
       #
       def examine_context(ctx)
         num_params = ctx.parameters.length
-        return false if num_params <= @max_params
+        return false if num_params <= @config['max_params']
         found(ctx, "#{@action} #{num_params} parameters")
       end
     end

data/lib/reek/smells/long_yield_list.rb

@@ -9,7 +9,7 @@ module Reek
         [:yield]
       end
 
-      def initialize(config)
+      def initialize(config = LongYieldList.default_config)
         super
         @action = 'yields'
       end

data/lib/reek/smells/smell_detector.rb

@@ -40,23 +40,26 @@ module Reek
 
       def self.listen(hooks, config)
         detector = create(config)
-        contexts.each { |ctx| hooks[ctx] << detector }
+        detector.listen_to(hooks)
         detector
       end
 
-      def initialize(config)
-        @enabled = config[ENABLED_KEY]
-        @exceptions = config[EXCLUDE_KEY]
+      def initialize(config = SmellDetector.default_config)
+        @config = config
         @smells_found = []
         @masked = false
       end
 
+      def listen_to(hooks)
+        self.class.contexts.each { |ctx| hooks[ctx] << self }
+      end
+
       def be_masked
         @masked = true
       end
 
       def enabled?
-        @enabled
+        @config[ENABLED_KEY]
       end
 
       def configure(config)
@@ -66,12 +69,16 @@ module Reek
       end
 
       def configure_with(config)
-        @enabled = config[ENABLED_KEY]  # if config.has_key?(ENABLED_KEY)
+        @config.adopt!(config)
+      end
+
+      def copy
+        self.class.new(@config.deep_copy)
       end
 
       def examine(context)
         before = @smells_found.size
-        examine_context(context) if @enabled and !exception?(context)
+        examine_context(context) if enabled? and !exception?(context)
         @smells_found.length > before
       end
 
@@ -79,8 +86,7 @@ module Reek
       end
       
       def exception?(context)
-        return false if @exceptions.nil? or @exceptions.length == 0
-        context.matches?(@exceptions)
+        context.matches?(@config[EXCLUDE_KEY])
       end
 
       def found(scope, warning)

data/lib/reek/smells/uncommunicative_name.rb

@@ -40,9 +40,7 @@ module Reek
       end
 
       def initialize(config = UncommunicativeName.default_config)
-        super
-        @reject = config[REJECT_KEY]
-        @accept = config[ACCEPT_KEY]
+        super(config)
       end
 
       #
@@ -63,15 +61,15 @@ module Reek
 
       def consider_name(context)  # :nodoc:
         name = context.name
-        return false if @accept.include?(context.to_s)  # TODO: fq_name() ?
+        return false if @config[ACCEPT_KEY].include?(context.to_s)  # TODO: fq_name() ?
         return false unless is_bad_name?(name)
         found(context, "has the name '#{name}'")
       end
 
       def is_bad_name?(name)  # :nodoc:
         var = name.effective_name
-        return false if var == '*' or @accept.include?(var)
-        @reject.detect {|patt| patt === var}
+        return false if var == '*' or @config[ACCEPT_KEY].include?(var)
+        @config[REJECT_KEY].detect {|patt| patt === var}
       end
     end
   end

data/lib/reek/sniffer.rb

@@ -1,3 +1,4 @@
+require 'reek/detector_stack'
 require 'reek/smells/control_couple'
 require 'reek/smells/duplication'
 require 'reek/smells/feature_envy'
@@ -8,6 +9,7 @@ require 'reek/smells/long_yield_list'
 require 'reek/smells/nested_iterators'
 require 'reek/smells/uncommunicative_name'
 require 'reek/smells/utility_function'
+require 'reek/config_file'
 require 'yaml'
 
 class Hash
@@ -55,7 +57,9 @@ module Reek
     def initialize
       defaults_file = File.join(File.dirname(__FILE__), '..', '..', 'config', 'defaults.reek')
       @config = YAML.load_file(defaults_file)
-      @detectors = nil
+      @typed_detectors = nil
+      @detectors = Hash.new
+      SMELL_CLASSES.each { |klass| @detectors[klass] = DetectorStack.new(klass.new) }
       @listeners = []
     end
 
@@ -67,27 +71,21 @@ module Reek
     #
     def configure_along_path(filename)
       path = File.expand_path(File.dirname(filename))
-      all_reekfiles(path).each { |rfile| configure_with(rfile) }
+      all_reekfiles(path).each { |config_file| ConfigFile.new(config_file).configure(self) }
       self
     end
 
-    #
-    # Overrides this sniffer's current settings with those in the named
-    # +config_file+.
-    #
-    def configure_with(config_file)
-      hash = YAML.load_file(config_file)
-      return unless hash
-      raise "invalid configuration file \"#{File.basename(config_file)}\"" unless Hash === hash
-      hash.push_keys(@config)
+    def configure(klass, config)
+      @detectors[klass].push(config)
     end
 
-    def disable(smell)
-      @config[smell].adopt!({Reek::Smells::SmellDetector::ENABLED_KEY => false})
+    def disable(klass)
+      disabled_config = {Reek::Smells::SmellDetector::ENABLED_KEY => false}
+      @detectors[klass].push(disabled_config)
     end
 
     def report_on(report)
-      @listeners.each {|smell| smell.report_on(report)}
+      @detectors.each_value { |stack| stack.report_on(report) }
     end
 
     def examine(scope, type)
@@ -98,11 +96,11 @@ module Reek
 private
 
     def smell_listeners()
-      unless @detectors
-        @detectors = Hash.new {|hash,key| hash[key] = [] }
-        SMELL_CLASSES.each { |smell| @listeners << smell.listen(@detectors, @config) }
+      unless @typed_detectors
+        @typed_detectors = Hash.new {|hash,key| hash[key] = [] }
+        @detectors.each_value { |stack| stack.listen_to(@typed_detectors) }
       end
-      @detectors
+      @typed_detectors
     end
 
     def all_reekfiles(path)

data/lib/reek.rb

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

data/reek.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.1.3.7"
+  s.version = "1.1.3.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-07-02}
+  s.date = %q{2009-07-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", "README.txt"]
-  s.files = ["History.txt", "README.txt", "Rakefile", "bin/reek", "config/defaults.reek", "features/masking_smells.feature", "features/options.feature", "features/rake_task.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/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/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/sniffer.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/object_source_spec.rb", "spec/reek/options_spec.rb", "spec/reek/report_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/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_detector_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/reek/spec_spec.rb", "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/inline.rb", "spec/samples/masked/dirty.rb", "spec/samples/masked/masked.reek", "spec/samples/optparse.rb", "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/slow/inline_spec.rb", "spec/slow/optparse_spec.rb", "spec/slow/redcloth_spec.rb", "spec/slow/reek_source_spec.rb", "spec/slow/source_list_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/test.rake"]
+  s.files = ["History.txt", "README.txt", "Rakefile", "bin/reek", "config/defaults.reek", "features/masking_smells.feature", "features/options.feature", "features/rake_task.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/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/config_file.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/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/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/sniffer.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/object_source_spec.rb", "spec/reek/options_spec.rb", "spec/reek/report_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/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_detector_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/reek/spec_spec.rb", "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/inline.rb", "spec/samples/masked/dirty.rb", "spec/samples/masked/masked.reek", "spec/samples/optparse.rb", "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/slow/inline_spec.rb", "spec/slow/optparse_spec.rb", "spec/slow/redcloth_spec.rb", "spec/slow/reek_source_spec.rb", "spec/slow/source_list_spec.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/smells/duplication_spec.rb

@@ -41,26 +41,23 @@ describe Duplication, "non-repeated method calls" do
   end
 end
 
-require 'ostruct'
-
 describe Duplication, '#examine' do
   before :each do
-    @mc = OpenStruct.new
+    @mc = MethodContext.new(StopContext.new, s(:defn, :fred))
     @dup = Duplication.new
   end
 
   it 'should return true when reporting a smell' do
-    @mc.calls = {s(:call, nil, :other, s(:arglist)) => 47}
+    3.times { @mc.record_call_to(s(:call, nil, :other, s(:arglist)))}
     @dup.examine(@mc).should == true
   end
-  
+
   it 'should return false when not reporting a smell' do
-    @mc.calls = []
     @dup.examine(@mc).should == false
   end
-  
+
   it 'should return false when not reporting calls to new' do
-    @mc.calls = {[:call, :Set, :new] => 4}
+    4.times { @mc.record_call_to(s(:call, s(:Set), :new, s(:arglist)))}
     @dup.examine(@mc).should == false
   end
 end

data/spec/reek/smells/smell_detector_spec.rb

@@ -7,6 +7,34 @@ require 'reek/smells/large_class'
 include Reek
 include Reek::Smells
 
+describe SmellDetector, 'configuration' do
+  before:each do
+    @detector = LongMethod.new
+  end
+
+  it 'adopts new max_statements value' do
+    @detector.configure_with('max_statements' => 25)
+    @detector.max_statements.should == 25
+  end
+end
+
+describe SmellDetector, 'when copied' do
+  before :each do
+    @detector = LongMethod.new
+    @copy = @detector.copy
+  end
+
+  it 'should have the same state' do
+    @copy.max_statements.should == @detector.max_statements
+  end
+
+  it 'should change independently of its parent' do
+    default_max = @detector.max_statements
+    @copy.configure_with('max_statements' => 25)
+    @detector.max_statements.should == default_max
+  end
+end
+
 describe SmellDetector, 'when masked' do
   before(:each) do
     @detector = Duplication.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevinrutherford-reek
 version: !ruby/object:Gem::Version 
-  version: 1.1.3.7
+  version: 1.1.3.8
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-02 00:00:00 -07:00
+date: 2009-07-06 00:00:00 -07:00
 default_executable: reek
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,8 @@ files:
 - lib/reek/class_context.rb
 - lib/reek/code_context.rb
 - lib/reek/code_parser.rb
+- lib/reek/config_file.rb
+- lib/reek/detector_stack.rb
 - lib/reek/exceptions.reek
 - lib/reek/if_context.rb
 - lib/reek/method_context.rb