kevinrutherford-reek 1.1.3.2 → 1.1.3.3

data/History.txt

@@ -1,9 +1,11 @@
 == 1.1.4 (in git)
 
 === Minor Changes
-* LongMethod now counts statements deeper into each method (#25)
+* LongMethod now counts statements deeper into each method (fixed #25)
 * LongMethod no longer counts control structures, only their contained stmts
-* LargeClass is disabled when checking in-memory classes
+* LargeClass is disabled when checking in-memory classes (fixed #28)
+* Output now reports on all files examined, even if they have no smells
+* Smell warnings are indented in the report to distinguish them from file headers
 
 == 1.1.3 2009-05-19
 
@@ -11,7 +13,7 @@
 * No longer depends directly on the sexp_processor gem
 
 === Fixes
-* LargeClass now relies only on the given source code (#26)
+* LargeClass now relies only on the given source code (fixed #26)
 
 == 1.1.2 2009-05-18
 
@@ -22,7 +24,7 @@
 == 1.1.1 2009-05-08
 
 === Minor enhancements
-* LargeClass now also warns about any class with > 9 instance variables (#6)
+* LargeClass now also warns about any class with > 9 instance variables (fixed #6)
 * Now depends on ruby2ruby, to display code better
 * Duplication notices more repeated method calls
 * Smells within blocks are now reported better
@@ -30,7 +32,7 @@
 == 1.1.0 2009-04-10
 
 === Minor enhancements
-* Now possible to write 'MyClass.should_not reek' (#33)
+* Now possible to write 'MyClass.should_not reek' (fixed #33)
 
 === Fixes
 * Now counts attr assignments ([]= etc) in feature envy calculations
@@ -39,7 +41,7 @@
 == 1.0.1 2009-04-06
 
 === Fixes
-* Dir[...].to_source now creates a Report that can be browsed (#36)
+* Dir[...].to_source now creates a Report that can be browsed (fixed #36)
 
 == 1.0.0 2009-04-05
 

data/lib/reek/class_context.rb

@@ -15,6 +15,11 @@ module Reek
       ClassContext.new(res[0], res[1], exp[2])
     end
 
+    def ClassContext.from_s(src)
+      source = Source.from_s(src)
+      CodeParser.new(Sniffer.new).process_class(source.generate_syntax_tree)
+    end
+
     def initialize(outer, name, superclass = nil)
       super(outer, nil)
       @name = name

data/lib/reek/code_parser.rb

@@ -27,11 +27,11 @@ module Reek
 
   class CodeParser
 
-    # Creates a new Ruby code checker. Any smells discovered
-    # will be stored in +report+.
-    def initialize(report, smells, ctx = StopContext.new)
-      @report = report
-      @smells = smells
+    #
+    # Creates a new Ruby code checker.
+    #
+    def initialize(sniffer, ctx = StopContext.new)
+      @sniffer = sniffer
       @element = ctx
     end
 
@@ -127,9 +127,7 @@ module Reek
     end
 
     def process_while(exp)
-      count_clause(exp[2])
-      process_default(exp)
-      @element.count_statements(-1)
+      process_until(exp)
     end
 
     def process_until(exp)
@@ -140,19 +138,16 @@ module Reek
 
     def process_for(exp)
       count_clause(exp[3])
-      process_default(exp)
-      @element.count_statements(-1)
+      process_case(exp)
     end
 
     def process_rescue(exp)
       count_clause(exp[1])
-      process_default(exp)
-      @element.count_statements(-1)
+      process_case(exp)
     end
 
     def process_resbody(exp)
-      count_clause(exp[2])
-      process_default(exp)
+      process_when(exp)
     end
 
     def process_case(exp)
@@ -209,8 +204,7 @@ module Reek
     end
 
     def check_smells(type)
-      listeners = @smells[type]
-      listeners.each {|smell| smell.examine(@element, @report) } if listeners
+      @sniffer.examine(@element, type)
     end
 
     def push(context)

data/lib/reek/object_source.rb

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

data/lib/reek/report.rb

@@ -1,12 +1,15 @@
 require 'set'
+require 'reek/sniffer'
 require 'reek/smells/smell_detector'
 
 module Reek
   class Report
     include Enumerable
 
-    def initialize  # :nodoc:
+    def initialize(sniffer = nil)  # :nodoc:
+      @masked_smells = SortedSet.new
       @report = SortedSet.new
+      sniffer.report_on(self) if sniffer
     end
 
     #
@@ -20,6 +23,14 @@ module Reek
       @report << smell
       true
     end
+
+    def record_masked_smell(smell)
+      @masked_smells << smell
+    end
+
+    def num_masked_smells
+      @masked_smells.length
+    end
     
     def empty?
       @report.empty?
@@ -38,13 +49,22 @@ module Reek
     # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
     # this report, with a heading.
     def full_report(desc)
-      "\"#{desc}\" -- #{length} warnings:\n#{to_s}\n"
+      result = header(desc, @report.length)
+      result += ":\n#{to_s}\n" if length > 0
+      result
+    end
+
+    def header(desc, num_smells)
+      result = "\"#{desc}\" -- #{num_smells} warning"
+      result += 's' unless num_smells == 1
+      result += " (+#{@masked_smells.length} masked)" unless @masked_smells.empty?
+      result
     end
 
     # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
     # this report.
     def to_s
-      @report.map {|smell| smell.report}.join("\n")
+      @report.map {|smell| "  #{smell.report}"}.join("\n")
     end
   end
 
@@ -75,7 +95,7 @@ module Reek
     end
 
     def to_s
-      smelly_sources.map { |src| src.full_report }.join("\n")
+      @sources.map { |src| src.full_report }.join("\n")
     end
   end
 end

data/lib/reek/smells/control_couple.rb

@@ -49,12 +49,11 @@ module Reek
 
       #
       # Checks whether the given conditional statement relies on a control couple.
-      # Any smells found are added to the +report+.
+      # Remembers any smells found.
       #
-      def examine_context(cond, report)
+      def examine_context(cond)
         return unless cond.tests_a_parameter?
-        report << SmellWarning.new(self, cond,
-                    "is controlled by argument #{SexpFormatter.format(cond.if_expr)}")
+        found(cond, "is controlled by argument #{SexpFormatter.format(cond.if_expr)}")
       end
     end
   end

data/lib/reek/smells/duplication.rb

@@ -33,10 +33,9 @@ module Reek
         @max_calls = config[MAX_ALLOWED_CALLS_KEY]
       end
 
-      def examine_context(method, report)
+      def examine_context(method)
         smelly_calls(method).each do |call|
-          report << SmellWarning.new(self, method,
-                      "calls #{SexpFormatter.format(call)} multiple times")
+          found(method, "calls #{SexpFormatter.format(call)} multiple times")
         end
       end
       

data/lib/reek/smells/feature_envy.rb

@@ -45,12 +45,11 @@ module Reek
       #
       # Checks whether the given +context+ includes any code fragment that
       # might "belong" on another class.
-      # Any smells found are added to the +report+.
+      # Remembers any smells found.
       #
-      def examine_context(context, report)
+      def examine_context(context)
         context.envious_receivers.each do |ref|
-          report << SmellWarning.new(self, context,
-                      "refers to #{SexpFormatter.format(ref)} more than self")
+          found(context, "refers to #{SexpFormatter.format(ref)} more than self")
         end
       end
     end

data/lib/reek/smells/large_class.rb

@@ -42,27 +42,25 @@ module Reek
         @max_instance_variables = config[MAX_ALLOWED_IVARS_KEY]
       end
 
-      def check_num_methods(klass, report)  # :nodoc:
+      def check_num_methods(klass)  # :nodoc:
         count = klass.num_methods
         return if count <= @max_methods
-        report << SmellWarning.new(self, klass,
-                    "has at least #{count} methods")
+        found(klass, "has at least #{count} methods")
       end
 
-      def check_num_ivars(klass, report)  # :nodoc:
+      def check_num_ivars(klass)  # :nodoc:
         count = klass.variable_names.length
         return if count <= @max_instance_variables
-        report << SmellWarning.new(self, klass,
-                    "has at least #{count} instance variables")
+        found(klass, "has at least #{count} instance variables")
       end
 
       #
       # Checks +klass+ for too many methods or too many instance variables.
-      # Any smells found are added to the +report+.
+      # Remembers any smells found.
       #
-      def examine_context(klass, report)
-        check_num_methods(klass, report)
-        check_num_ivars(klass, report)
+      def examine_context(klass)
+        check_num_methods(klass)
+        check_num_ivars(klass)
       end
     end
   end

data/lib/reek/smells/long_method.rb

@@ -30,13 +30,12 @@ module Reek
 
       #
       # Checks the length of the given +method+.
-      # Any smells found are added to the +report+.
+      # Remembers any smells found.
       #
-      def examine_context(method, report)
+      def examine_context(method)
         num = method.num_statements
         return false if num <= @max_statements
-        report << SmellWarning.new(self, method,
-                    "has approx #{num} statements")
+        found(method, "has approx #{num} statements")
       end
     end
   end

data/lib/reek/smells/long_parameter_list.rb

@@ -30,13 +30,12 @@ module Reek
 
       #
       # Checks the number of parameters in the given scope.
-      # Any smells found are added to the +report+.
+      # Remembers any smells found.
       #
-      def examine_context(ctx, report)
+      def examine_context(ctx)
         num_params = ctx.parameters.length
         return false if num_params <= @max_params
-        report << SmellWarning.new(self, ctx,
-                    "#{@action} #{num_params} parameters")
+        found(ctx, "#{@action} #{num_params} parameters")
       end
     end
   end

data/lib/reek/smells/nested_iterators.rb

@@ -17,11 +17,11 @@ module Reek
 
       #
       # Checks whether the given +block+ is inside another.
-      # Any smells found are added to the +report+.
+      # Remembers any smells found.
       #
-      def examine_context(block, report)
+      def examine_context(block)
         return false unless block.nested_block?
-        report << SmellWarning.new(self, block, 'is nested')
+        found(block, 'is nested')
       end
     end
   end

data/lib/reek/smells/smell_detector.rb

@@ -37,20 +37,27 @@ module Reek
       def self.listen(hooks, config)
         detector = new(config[class_name])
         contexts.each { |ctx| hooks[ctx] << detector }
+        detector
       end
 
       def initialize(config)
         @enabled = config[ENABLED_KEY]
         @exceptions = config[EXCLUDE_KEY]
+        @smells_found = []
+        @masked = false
       end
 
-      def examine(context, report)
-        before = report.size
-        examine_context(context, report) if @enabled and !exception?(context)
-        report.length > before
+      def be_masked
+        @masked = true
       end
 
-      def examine_context(context, report)
+      def examine(context)
+        before = @smells_found.size
+        examine_context(context) if @enabled and !exception?(context)
+        @smells_found.length > before
+      end
+
+      def examine_context(context)
       end
       
       def exception?(context)
@@ -58,6 +65,22 @@ module Reek
         context.matches?(@exceptions)
       end
 
+      def found(scope, warning)
+        smell = SmellWarning.new(self, scope, warning)
+        @smells_found << smell
+        smell
+      end
+
+      def report_on(report)
+        @smells_found.each do |smell|
+          if @masked
+            report.record_masked_smell(smell)
+          else
+            report << smell
+          end
+        end
+      end
+
       def smell_name
         self.class.name_words.join(' ')
       end

data/lib/reek/smells/uncommunicative_name.rb

@@ -47,27 +47,25 @@ module Reek
 
       #
       # Checks the given +context+ for uncommunicative names.
-      # Any smells found are added to the +report+.
+      # Remembers any smells found.
       #
-      def examine_context(context, report)
-        consider_name(context, report)
-        consider_variables(context, report)
+      def examine_context(context)
+        consider_name(context)
+        consider_variables(context)
       end
 
-      def consider_variables(context, report) # :nodoc:
+      def consider_variables(context) # :nodoc:
         context.variable_names.each do |name|
           next unless is_bad_name?(name)
-          report << SmellWarning.new(self, context,
-                      "has the variable name '#{name}'")
+          found(context, "has the variable name '#{name}'")
         end
       end
 
-      def consider_name(context, report)  # :nodoc:
+      def consider_name(context)  # :nodoc:
         name = context.name
         return false if @accept.include?(context.to_s)  # TODO: fq_name() ?
         return false unless is_bad_name?(name)
-        report << SmellWarning.new(self, context,
-                      "has the name '#{name}'")
+        found(context, "has the name '#{name}'")
       end
 
       def is_bad_name?(name)  # :nodoc:

data/lib/reek/smells/utility_function.rb

@@ -20,14 +20,13 @@ module Reek
 
       #
       # Checks whether the given +method+ is a utility function.
-      # Any smells found are added to the +report+.
+      # Remembers any smells found.
       #
-      def examine_context(method, report)
+      def examine_context(method)
         return false if method.calls.keys.length == 0 or
           method.num_statements == 0 or
           method.depends_on_instance?
-        report << SmellWarning.new(self, method,
-                      "doesn't depend on instance state")
+        found(method, "doesn't depend on instance state")
       end
     end
   end

data/lib/reek/{smells/smells.rb → sniffer.rb}

@@ -37,7 +37,7 @@ class Hash
 end
 
 module Reek
-  class SmellConfig
+  class Sniffer
 
     SMELL_CLASSES = [
       Smells::ControlCouple,
@@ -53,22 +53,53 @@ module Reek
     ]
 
     def initialize
-      defaults_file = File.join(File.dirname(__FILE__), '..', '..', '..', 'config', 'defaults.reek')
+      defaults_file = File.join(File.dirname(__FILE__), '..', '..', 'config', 'defaults.reek')
       @config = YAML.load_file(defaults_file)
+      @detectors = nil
+      @listeners = []
     end
 
-    def smell_listeners()
-      result = Hash.new {|hash,key| hash[key] = [] }
-      SMELL_CLASSES.each { |smell| smell.listen(result, @config) }
-      return result
+    #
+    # Configures this sniffer using any *.reek config files found
+    # on the path to the named file. Config files are applied in order,
+    # "root-first", so that config files closer to the named file override
+    # those further up the path.
+    #
+    def configure_along_path(filename)
+      path = File.expand_path(File.dirname(filename))
+      all_reekfiles(path).each { |rfile| configure_with(rfile) }
+      self
+    end
+
+    #
+    # Overrides this sniffer's current settings with those in the named
+    # +config_file+.
+    #
+    def configure_with(config_file)
+      YAML.load_file(config_file).push_keys(@config)
+    end
+
+    def disable(smell)
+      @config[smell].adopt!({Reek::Smells::SmellDetector::ENABLED_KEY => false})
+    end
+
+    def report_on(report)
+      @listeners.each {|smell| smell.report_on(report)}
     end
 
-    def load_local(file)
-      path = File.expand_path(file)
-      all_reekfiles(path).each do |rfile|
-        YAML.load_file(rfile).push_keys(@config)
+    def examine(scope, type)
+      listeners = smell_listeners[type]
+      listeners.each {|smell| smell.examine(scope) } if listeners
+    end
+
+private
+
+    def smell_listeners()
+      unless @detectors
+        @detectors = Hash.new {|hash,key| hash[key] = [] }
+        SMELL_CLASSES.each { |smell| @listeners << smell.listen(@detectors, @config) }
       end
-      self
+      @detectors
     end
 
     def all_reekfiles(path)
@@ -77,9 +108,5 @@ module Reek
       return [] if path == parent
       all_reekfiles(parent) + Dir["#{path}/*.reek"]
     end
-
-    def disable(smell)
-      @config[smell].adopt!({'enabled' => false})
-    end
   end
 end

data/lib/reek/source.rb

@@ -1,6 +1,6 @@
 require 'reek/code_parser'
 require 'reek/report'
-require 'reek/smells/smells'
+require 'reek/sniffer'
 require 'ruby_parser'
 
 module Reek
@@ -46,7 +46,8 @@ module Reek
     #
     def self.from_path(filename)
       code = IO.readlines(filename).join
-      return new(code, filename, File.dirname(filename))
+      sniffer = Sniffer.new.configure_along_path(filename)
+      return new(code, filename, sniffer)
     end
 
     #
@@ -58,11 +59,10 @@ module Reek
       SourceList.new(sources)
     end
 
-    def initialize(code, desc, dir = nil)     # :nodoc:
+    def initialize(code, desc, sniffer = Sniffer.new)     # :nodoc:
       @source = code
       @desc = desc
-      @cf = SmellConfig.new
-      @cf = @cf.load_local(dir) if dir
+      @sniffer = sniffer
     end
 
     def generate_syntax_tree
@@ -76,9 +76,9 @@ module Reek
     #
     def report
       unless @report
-        @report = Report.new
-        parser = CodeParser.new(@report, @cf.smell_listeners)
+        parser = CodeParser.new(@sniffer)
         parser.process(generate_syntax_tree)
+        @report = Report.new(@sniffer)
       end
       @report
     end

data/lib/reek.rb

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

data/reek.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.1.3.2"
+  s.version = "1.1.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-06-13}
+  s.date = %q{2009-06-17}
   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.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/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/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/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.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.4}
   s.summary = %q{Code smell detector for Ruby}
 
   if s.respond_to? :specification_version then

data/spec/reek/report_spec.rb

@@ -27,11 +27,8 @@ describe Report, "to_s" do
     @report = rpt.to_s.split("\n")
   end
 
-  it 'should place each detailed report on a separate line' do
-    @report.should have_at_least(2).lines
-  end
-
   it 'should mention every smell name' do
+    @report.should have_at_least(2).lines
     @report[0].should match(/[Utility Function]/)
     @report[1].should match(/[Feature Envy]/)
   end

data/spec/reek/{smells/smell_spec.rb → smell_warning_spec.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper.rb'
+require File.dirname(__FILE__) + '/../spec_helper.rb'
 
 require 'reek/smells/smells'
 

data/spec/reek/smells/duplication_spec.rb

@@ -51,17 +51,17 @@ describe Duplication, '#examine' do
 
   it 'should return true when reporting a smell' do
     @mc.calls = {s(:call, nil, :other, s(:arglist)) => 47}
-    @dup.examine(@mc, []).should == true
+    @dup.examine(@mc).should == true
   end
   
   it 'should return false when not reporting a smell' do
     @mc.calls = []
-    @dup.examine(@mc, []).should == false
+    @dup.examine(@mc).should == false
   end
   
   it 'should return false when not reporting calls to new' do
     @mc.calls = {[:call, :Set, :new] => 4}
-    @dup.examine(@mc, []).should == false
+    @dup.examine(@mc).should == false
   end
 end
 
@@ -69,13 +69,11 @@ describe Duplication, 'when disabled' do
   before :each do
     @ctx = MethodContext.new(StopContext.new, [0, :double_thing])
     @dup = Duplication.new({SmellDetector::ENABLED_KEY => false})
-    @rpt = Report.new
   end
 
   it 'should not report repeated call' do
     @ctx.record_call_to([:fred])
     @ctx.record_call_to([:fred])
-    @dup.examine(@ctx, @rpt).should == false
-    @rpt.length.should == 0
+    @dup.examine(@ctx).should == false
   end
 end

data/spec/reek/smells/feature_envy_spec.rb

@@ -133,22 +133,6 @@ describe FeatureEnvy do
      end'.should_not reek
   end
 
-  it 'reports the most-used ivar' do
-    pending('bug')
-    'def func
-       @other.a
-       @other.b
-       @nother.c
-     end'.should reek_of(:FeatureEnvy, /@other/)
-    #
-    # def other.func(me)
-    #   a
-    #   b
-    #   me.nother_c
-    # end
-    #
-  end
-
   it 'ignores multiple ivars' do
     'def func
        @other.a
@@ -212,10 +196,10 @@ describe FeatureEnvy, '#examine' do
   it 'should return true when reporting a smell' do
     @context.refs.record_ref([:lvar, :thing])
     @context.refs.record_ref([:lvar, :thing])
-    @fe.examine(@context, []).should == true
+    @fe.examine(@context).should == true
   end
 
   it 'should return false when not reporting a smell' do
-    @fe.examine(@context, []).should == false
+    @fe.examine(@context).should == false
   end
 end

data/spec/reek/smells/large_class_spec.rb

@@ -55,7 +55,6 @@ end
 describe LargeClass, 'when exceptions are listed' do
 
   before(:each) do
-    @rpt = Report.new
     @ctx = ClassContext.create(StopContext.new, [0, :Humungous])
     30.times { |num| @ctx.record_method("method#{num}") }
     @config = LargeClass.default_config
@@ -64,43 +63,35 @@ describe LargeClass, 'when exceptions are listed' do
   it 'should ignore first excepted name' do
     @config[LargeClass::EXCLUDE_KEY] = ['Humungous']
     lc = LargeClass.new(@config)
-    lc.examine(@ctx, @rpt).should == false
-    @rpt.length.should == 0
+    lc.examine(@ctx).should == false
   end
 
   it 'should ignore second excepted name' do
     @config[LargeClass::EXCLUDE_KEY] = ['Oversized', 'Humungous']
     lc = LargeClass.new(@config)
-    lc.examine(@ctx, @rpt).should == false
-    @rpt.length.should == 0
+    lc.examine(@ctx).should == false
   end
 
   it 'should report non-excepted name' do
     @config[LargeClass::EXCLUDE_KEY] = ['SmellMe']
     lc = LargeClass.new(@config)
-    lc.examine(@ctx, @rpt).should == true
-    @rpt.length.should == 1
+    lc.examine(@ctx).should == true
   end
 end
 
 describe LargeClass, 'checking source code' do
 
-  def process_class(src)
-    source = Source.from_s(src)
-    CodeParser.new(nil, {}).process_class(source.generate_syntax_tree)
-  end
-
   describe 'counting instance variables' do
     it 'should not report empty class' do
-      process_class('class Empty;end').variable_names.length.should == 0
+      ClassContext.from_s('class Empty;end').should have(0).variable_names
     end
 
     it 'should count ivars in one method' do
-      process_class('class Empty;def ivars() @aa=@ab=@ac=@ad; end;end').variable_names.length.should == 4
+      ClassContext.from_s('class Empty;def ivars() @aa=@ab=@ac=@ad; end;end').should have(4).variable_names
     end
 
     it 'should count ivars in 2 methods' do
-      process_class('class Empty;def iv1() @aa=@ab; end;def iv2() @aa=@ac; end;end').variable_names.length.should == 3
+      ClassContext.from_s('class Empty;def iv1() @aa=@ab; end;def iv2() @aa=@ac; end;end').should have(3).variable_names
     end
 
     it 'should not report 9 ivars' do
@@ -122,15 +113,15 @@ EOS
 
   describe 'counting methods' do
     it 'should not report empty class' do
-      process_class('class Empty;end').num_methods.should == 0
+      ClassContext.from_s('class Empty;end').num_methods.should == 0
     end
 
     it 'should count 1 method' do
-      process_class('class Empty;def ivars() @aa=@ab; end;end').num_methods.should == 1
+      ClassContext.from_s('class Empty;def ivars() @aa=@ab; end;end').num_methods.should == 1
     end
 
     it 'should count 2 methods' do
-      process_class('class Empty;def meth1() @aa=@ab;end;def meth2() @aa=@ab;end;end').num_methods.should == 2
+      ClassContext.from_s('class Empty;def meth1() @aa=@ab;end;def meth2() @aa=@ab;end;end').num_methods.should == 2
     end
 
     it 'should not report 25 methods' do

data/spec/reek/smells/long_method_spec.rb

@@ -9,7 +9,7 @@ include Reek::Smells
 
 def process_method(src)
   source = Source.from_s(src)
-  CodeParser.new(nil, {}).process_defn(source.generate_syntax_tree)
+  CodeParser.new(Sniffer.new).process_defn(source.generate_syntax_tree)
 end
 
 describe LongMethod do

data/spec/reek/smells/smell_detector_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+require 'reek/report'
+require 'reek/smells/duplication'
+
+include Reek
+include Reek::Smells
+
+describe SmellDetector, 'when masked' do
+  before(:each) do
+    @detector = Duplication.new
+    @detector.be_masked
+    @detector.found(nil, 'help')
+  end
+
+  it 'reports smells as masked' do
+    rpt = Report.new
+    @detector.report_on(rpt)
+    rpt.length.should == 0
+    rpt.num_masked_smells.should == 1
+  end
+end
+

data/spec/reek/smells/uncommunicative_name_spec.rb

@@ -107,17 +107,16 @@ end
 
 describe UncommunicativeName, '#examine' do
   before :each do
-    @report = Report.new
     @uc = UncommunicativeName.new
   end
   
   it 'should return true when reporting a smell' do
     mc = MethodContext.new(StopContext.new, [:defn, :x, nil])
-    @uc.examine(mc, @report).should == true
+    @uc.examine(mc).should == true
   end
   
   it 'should return false when not reporting a smell' do
     mc = MethodContext.new(StopContext.new, [:defn, :not_bad, nil])
-    @uc.examine(mc, @report).should == false
+    @uc.examine(mc).should == false
   end
 end

data/spec/reek/smells/utility_function_spec.rb

@@ -39,20 +39,6 @@ describe UtilityFunction do
     end
     Son.should_not reek
   end
-
-  it 'should not report class method' do
-    pending('bug')
-    source = <<EOS
-class Cache
-  class << self
-    def create_unless_known(attributes)
-      Cache.create(attributes) unless Cache.known?
-    end
-  end
-end
-EOS
-    source.should_not reek
-  end
   
   it 'should recognise a deep call' do
     src = <<EOS

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevinrutherford-reek
 version: !ruby/object:Gem::Version 
-  version: 1.1.3.2
+  version: 1.1.3.3
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-13 00:00:00 -07:00
+date: 2009-06-17 00:00:00 -07:00
 default_executable: reek
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -85,9 +85,9 @@ files:
 - 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/sniffer.rb
 - lib/reek/source.rb
 - lib/reek/spec.rb
 - lib/reek/stop_context.rb
@@ -106,6 +106,7 @@ files:
 - 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
@@ -113,7 +114,7 @@ files:
 - 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/smell_detector_spec.rb
 - spec/reek/smells/uncommunicative_name_spec.rb
 - spec/reek/smells/utility_function_spec.rb
 - spec/slow/inline_spec.rb