reek 1.2.7.3 → 1.2.8

data/lib/reek/smells/uncommunicative_parameter_name.rb

@@ -19,12 +19,16 @@ module Reek
     #
     class UncommunicativeParameterName < SmellDetector
 
+      SMELL_CLASS = 'UncommunicativeName'
+      SMELL_SUBCLASS = self.name.split(/::/)[-1]
+      PARAMETER_NAME_KEY = 'parameter_name'
+
       # The name of the config field that lists the regexps of
       # smelly names to be reported.
       REJECT_KEY = 'reject'
 
       DEFAULT_REJECT_SET = [/^.$/, /[0-9]$/, /[A-Z]/]
-      
+
       # The name of the config field that lists the specific names that are
       # to be treated as exceptions; these names will not be reported as
       # uncommunicative.
@@ -34,8 +38,8 @@ module Reek
 
       def self.default_config
         super.adopt(
-          REJECT_KEY => DEFAULT_REJECT_SET,
-          ACCEPT_KEY => DEFAULT_ACCEPT_SET
+                REJECT_KEY => DEFAULT_REJECT_SET,
+                ACCEPT_KEY => DEFAULT_ACCEPT_SET
         )
       end
 
@@ -49,23 +53,26 @@ module Reek
 
       #
       # Checks the given +context+ for uncommunicative names.
-      # Remembers any smells found.
       #
-      def examine_context(context)
-        context.exp.parameter_names.each do |name|
-          next unless is_bad_name?(name, context)
-          smell = SmellWarning.new('UncommunicativeName', context.full_name, [context.exp.line],
-            "has the parameter name '#{name}'",
-            @source, 'UncommunicativeParameterName', {'parameter_name' => name.to_s})
-          @smells_found << smell
-          #SMELL: serious duplication
+      # @return [Array<SmellWarning>]
+      #
+      def examine_context(ctx)
+        @reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
+        @accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
+        ctx.exp.parameter_names.select do |name|
+          is_bad_name?(name, ctx)
+        end.map do |name|
+          smell = SmellWarning.new(SMELL_CLASS, ctx.full_name, [ctx.exp.line],
+                                   "has the parameter name '#{name}'",
+                                   @source, SMELL_SUBCLASS, {PARAMETER_NAME_KEY => name.to_s})
+          smell
         end
       end
 
-      def is_bad_name?(name, context)  # :nodoc:
+      def is_bad_name?(name, ctx)
         var = name.to_s.gsub(/^[@\*\&]*/, '')
-        return false if var == '*' or value(ACCEPT_KEY, context, DEFAULT_ACCEPT_SET).include?(var)
-        value(REJECT_KEY, context, DEFAULT_REJECT_SET).detect {|patt| patt === var}
+        return false if var == '*' or @accept_names.include?(var)
+        @reject_names.detect {|patt| patt === var}
       end
     end
   end

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -19,12 +19,16 @@ module Reek
     #
     class UncommunicativeVariableName < SmellDetector
 
+      SMELL_CLASS = 'UncommunicativeName'
+      SMELL_SUBCLASS = self.name.split(/::/)[-1]
+      VARIABLE_NAME_KEY = 'variable_name'
+
       # The name of the config field that lists the regexps of
       # smelly names to be reported.
       REJECT_KEY = 'reject'
 
       DEFAULT_REJECT_SET = [/^.$/, /[0-9]$/, /[A-Z]/]
-      
+
       # The name of the config field that lists the specific names that are
       # to be treated as exceptions; these names will not be reported as
       # uncommunicative.
@@ -34,8 +38,8 @@ module Reek
 
       def self.default_config
         super.adopt(
-          REJECT_KEY => DEFAULT_REJECT_SET,
-          ACCEPT_KEY => DEFAULT_ACCEPT_SET
+                REJECT_KEY => DEFAULT_REJECT_SET,
+                ACCEPT_KEY => DEFAULT_ACCEPT_SET
         )
       end
 
@@ -49,32 +53,34 @@ module Reek
 
       #
       # Checks the given +context+ for uncommunicative names.
-      # Remembers any smells found.
       #
-      def examine_context(context)
-        variable_names(context.exp).each do |name, lines|
-          next unless is_bad_name?(name, context)
-          smell = SmellWarning.new('UncommunicativeName', context.full_name, lines,
-            "has the variable name '#{name}'",
-            @source, 'UncommunicativeVariableName', {'variable_name' => name.to_s})
-          @smells_found << smell
-          #SMELL: serious duplication
+      # @return [Array<SmellWarning>]
+      #
+      def examine_context(ctx)
+        @reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
+        @accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
+        variable_names(ctx.exp).select do |name, lines|
+          is_bad_name?(name, ctx)
+        end.map do |name, lines|
+          SmellWarning.new(SMELL_CLASS, ctx.full_name, lines,
+                           "has the variable name '#{name}'",
+                           @source, SMELL_SUBCLASS, {VARIABLE_NAME_KEY => name.to_s})
         end
       end
 
-      def is_bad_name?(name, context)  # :nodoc:
+      def is_bad_name?(name, ctx)
         var = name.to_s.gsub(/^[@\*\&]*/, '')
-        return false if value(ACCEPT_KEY, context, DEFAULT_ACCEPT_SET).include?(var)
-        value(REJECT_KEY, context, DEFAULT_REJECT_SET).detect {|patt| patt === var}
+        return false if @accept_names.include?(var)
+        @reject_names.detect {|patt| patt === var}
       end
 
       def variable_names(exp)
         assignment_nodes = exp.each_node(:lasgn, [:class, :module, :defs, :defn])
         case exp.first
-        when :class, :module
-          assignment_nodes += exp.each_node(:iasgn, [:class, :module])
+          when :class, :module
+            assignment_nodes += exp.each_node(:iasgn, [:class, :module])
         end
-        result = Hash.new {|hash,key| hash[key] = []}
+        result = Hash.new {|hash, key| hash[key] = []}
         assignment_nodes.each {|asgn| result[asgn[1]].push(asgn.line) }
         result
       end

data/lib/reek/smells/utility_function.rb

@@ -61,18 +61,18 @@ module Reek
 
       #
       # Checks whether the given +method+ is a utility function.
-      # Remembers any smells found.
+      #
+      # @return [Array<SmellWarning>]
       #
       def examine_context(method_ctx)
-        return false if method_ctx.num_statements == 0
-        return false if depends_on_instance?(method_ctx.exp)
-        return false if num_helper_methods(method_ctx) <= value(HELPER_CALLS_LIMIT_KEY, method_ctx, DEFAULT_HELPER_CALLS_LIMIT)
+        return [] if method_ctx.num_statements == 0
+        return [] if depends_on_instance?(method_ctx.exp)
+        return [] if num_helper_methods(method_ctx) <= value(HELPER_CALLS_LIMIT_KEY, method_ctx, DEFAULT_HELPER_CALLS_LIMIT)
           # SMELL: loads of calls to value{} with the above pattern
         smell = SmellWarning.new(SMELL_CLASS, method_ctx.full_name, [method_ctx.exp.line],
           "doesn't depend on instance state",
           @source, SMELL_SUBCLASS)
-        @smells_found << smell
-        #SMELL: serious duplication
+        [smell]
       end
 
     private

data/lib/reek/source/code_comment.rb

@@ -7,13 +7,31 @@ module Reek
     # module, class and method definitions.
     #
     class CodeComment
+      CONFIG_REGEX = /:reek:(\w+)(:\s*\{.*?\})?/
 
       def initialize(text)
-        @text = text.gsub(/#/, '').gsub(/\n/, '').strip
+        @config =  Hash.new { |hash,key| hash[key] = {} }
+        @text = text.gsub(CONFIG_REGEX) do |m|
+          add_to_config($1, $2)
+          ''
+        end.gsub(/#/, '').gsub(/\n/, '').strip
       end
+
+      def config
+        @config
+      end
+
       def is_descriptive?
         @text.split(/\s+/).length >= 2
       end
+
+    protected
+      def add_to_config(smell, options)
+        options ||= ': { enabled: false }'
+        @config.merge! YAML.load(smell.gsub(/(?:^|_)(.)/) { $1.upcase } + options)
+        # extend this to all configs --------------------------^
+        # extend to allow configuration of whole smell class, not just subclass
+      end
     end
   end
 end

data/lib/reek/source/tree_dresser.rb

@@ -6,6 +6,17 @@ module Reek
     # syntax tree more easily.
     #
     module SexpNode
+      def self.format(expr)
+        case expr
+        when Sexp then expr.format_ruby
+        else expr.to_s
+        end
+      end
+
+      def hash
+        self.inspect.hash
+      end
+
       def is_language_node?
         first.class == Symbol
       end
@@ -37,7 +48,7 @@ module Reek
         end
         blk.call(self) if first == target_type
       end
-      def format
+      def format_ruby
         return self[0].to_s unless Array === self
         Ruby2Ruby.new.process(deep_copy)
       end
@@ -64,15 +75,6 @@ module Reek
         end
       end
 
-      module ClassNode
-        def name() self[1] end
-        def superclass() self[2] end
-        def full_name(outer)
-          prefix = outer == '' ? '' : "#{outer}::"
-          "#{prefix}#{name}"
-        end
-      end
-
       module CvarNode
         def name() self[1] end
       end
@@ -80,24 +82,29 @@ module Reek
       CvasgnNode = CvarNode
       CvdeclNode = CvarNode
 
-      module DefnNode
-        def name() self[1] end
+      module MethodNode
         def arg_names
           unless @args
-            @args = self[2][1..-1].reject {|param| Sexp === param or param.to_s =~ /^&/}
+            @args = argslist[1..-1].reject {|param| Sexp === param or param.to_s =~ /^&/}
           end
           @args
         end
         def parameters()
           unless @params
-            @params = self[2].reject {|param| Sexp === param}
+            @params = argslist.reject {|param| Sexp === param}
           end
           @params
         end
         def parameter_names
           parameters[1..-1]
         end
+      end
+
+      module DefnNode
+        def name() self[1] end
+        def argslist() self[2] end
         def body() self[3] end
+        include MethodNode
         def full_name(outer)
           prefix = outer == '' ? '' : "#{outer}#"
           "#{prefix}#{name}"
@@ -107,16 +114,12 @@ module Reek
       module DefsNode
         def receiver() self[1] end
         def name() self[2] end
-        def parameters
-          self[3].reject {|param| Sexp === param}
-        end
-        def parameter_names
-          parameters[1..-1]
-        end
+        def argslist() self[3] end
         def body() self[4] end
+        include MethodNode
         def full_name(outer)
           prefix = outer == '' ? '' : "#{outer}#"
-          "#{prefix}#{receiver.format}.#{name}"
+          "#{prefix}#{SexpNode.format(receiver)}.#{name}"
         end
       end
 
@@ -148,12 +151,27 @@ module Reek
 
       module ModuleNode
         def name() self[1] end
+        def simple_name
+          expr = name
+          while Sexp === expr and expr[0] == :colon2
+            expr = expr[2]
+          end
+          expr
+        end
         def full_name(outer)
           prefix = outer == '' ? '' : "#{outer}::"
-          "#{prefix}#{name}"
+          "#{prefix}#{text_name}"
+        end
+        def text_name
+          SexpNode.format(name)
         end
       end
 
+      module ClassNode
+        include ModuleNode
+        def superclass() self[2] end
+      end
+
       module YieldNode
         def args() self[1..-1] end
         def arg_names

data/reek.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.2.7.3"
+  s.version = "1.2.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2010-03-29}
+  s.date = %q{2010-04-26}
   s.default_executable = %q{reek}
   s.description = %q{Reek is a tool that examines Ruby classes, modules and methods
 and reports any code smells it finds.
@@ -14,10 +14,12 @@ and reports any code smells it finds.
   s.email = ["kevin@rutherford-software.com"]
   s.executables = ["reek"]
   s.extra_rdoc_files = ["History.txt", "License.txt"]
-  s.files = [".yardopts", "History.txt", "License.txt", "README.md", "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", "features/yaml.feature", "lib/reek.rb", "lib/reek/cli/application.rb", "lib/reek/cli/command_line.rb", "lib/reek/cli/help_command.rb", "lib/reek/cli/reek_command.rb", "lib/reek/cli/report.rb", "lib/reek/cli/version_command.rb", "lib/reek/cli/yaml_command.rb", "lib/reek/core/code_context.rb", "lib/reek/core/code_parser.rb", "lib/reek/core/method_context.rb", "lib/reek/core/module_context.rb", "lib/reek/core/object_refs.rb", "lib/reek/core/singleton_method_context.rb", "lib/reek/core/smell_configuration.rb", "lib/reek/core/sniffer.rb", "lib/reek/core/stop_context.rb", "lib/reek/core/warning_collector.rb", "lib/reek/examiner.rb", "lib/reek/rake/task.rb", "lib/reek/smell_warning.rb", "lib/reek/smells.rb", "lib/reek/smells/attribute.rb", "lib/reek/smells/boolean_parameter.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/irresponsible_module.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_method_name.rb", "lib/reek/smells/uncommunicative_module_name.rb", "lib/reek/smells/uncommunicative_parameter_name.rb", "lib/reek/smells/uncommunicative_variable_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/source.rb", "lib/reek/source/code_comment.rb", "lib/reek/source/config_file.rb", "lib/reek/source/core_extras.rb", "lib/reek/source/reference_collector.rb", "lib/reek/source/sexp_formatter.rb", "lib/reek/source/source_code.rb", "lib/reek/source/source_file.rb", "lib/reek/source/source_locator.rb", "lib/reek/source/tree_dresser.rb", "lib/reek/spec.rb", "lib/reek/spec/should_reek.rb", "lib/reek/spec/should_reek_of.rb", "lib/reek/spec/should_reek_only_of.rb", "reek.gemspec", "spec/reek/cli/help_command_spec.rb", "spec/reek/cli/reek_command_spec.rb", "spec/reek/cli/report_spec.rb", "spec/reek/cli/version_command_spec.rb", "spec/reek/cli/yaml_command_spec.rb", "spec/reek/core/code_context_spec.rb", "spec/reek/core/code_parser_spec.rb", "spec/reek/core/config_spec.rb", "spec/reek/core/method_context_spec.rb", "spec/reek/core/module_context_spec.rb", "spec/reek/core/object_refs_spec.rb", "spec/reek/core/singleton_method_context_spec.rb", "spec/reek/core/smell_configuration_spec.rb", "spec/reek/core/stop_context_spec.rb", "spec/reek/core/warning_collector_spec.rb", "spec/reek/examiner_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/boolean_parameter_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/irresponsible_module_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/long_yield_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/simulated_polymorphism_spec.rb", "spec/reek/smells/smell_detector_shared.rb", "spec/reek/smells/uncommunicative_method_name_spec.rb", "spec/reek/smells/uncommunicative_module_name_spec.rb", "spec/reek/smells/uncommunicative_parameter_name_spec.rb", "spec/reek/smells/uncommunicative_variable_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/reek/source/code_comment_spec.rb", "spec/reek/source/object_source_spec.rb", "spec/reek/source/reference_collector_spec.rb", "spec/reek/source/source_code_spec.rb", "spec/reek/source/tree_dresser_spec.rb", "spec/reek/spec/should_reek_of_spec.rb", "spec/reek/spec/should_reek_only_of_spec.rb", "spec/reek/spec/should_reek_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 = [".yardopts", "History.txt", "License.txt", "README.md", "Rakefile", "bin/reek", "config/defaults.reek", "features/api.feature", "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", "features/yaml.feature", "lib/reek.rb", "lib/reek/cli/application.rb", "lib/reek/cli/command_line.rb", "lib/reek/cli/help_command.rb", "lib/reek/cli/reek_command.rb", "lib/reek/cli/report.rb", "lib/reek/cli/version_command.rb", "lib/reek/cli/yaml_command.rb", "lib/reek/core/code_context.rb", "lib/reek/core/code_parser.rb", "lib/reek/core/method_context.rb", "lib/reek/core/module_context.rb", "lib/reek/core/object_refs.rb", "lib/reek/core/singleton_method_context.rb", "lib/reek/core/smell_configuration.rb", "lib/reek/core/sniffer.rb", "lib/reek/core/stop_context.rb", "lib/reek/core/warning_collector.rb", "lib/reek/examiner.rb", "lib/reek/rake/task.rb", "lib/reek/smell_warning.rb", "lib/reek/smells.rb", "lib/reek/smells/attribute.rb", "lib/reek/smells/boolean_parameter.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/irresponsible_module.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_method_name.rb", "lib/reek/smells/uncommunicative_module_name.rb", "lib/reek/smells/uncommunicative_parameter_name.rb", "lib/reek/smells/uncommunicative_variable_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/source.rb", "lib/reek/source/code_comment.rb", "lib/reek/source/config_file.rb", "lib/reek/source/core_extras.rb", "lib/reek/source/reference_collector.rb", "lib/reek/source/sexp_formatter.rb", "lib/reek/source/source_code.rb", "lib/reek/source/source_file.rb", "lib/reek/source/source_locator.rb", "lib/reek/source/tree_dresser.rb", "lib/reek/spec.rb", "lib/reek/spec/should_reek.rb", "lib/reek/spec/should_reek_of.rb", "lib/reek/spec/should_reek_only_of.rb", "reek.gemspec", "spec/matchers/smell_of_matcher.rb", "spec/reek/cli/help_command_spec.rb", "spec/reek/cli/reek_command_spec.rb", "spec/reek/cli/report_spec.rb", "spec/reek/cli/version_command_spec.rb", "spec/reek/cli/yaml_command_spec.rb", "spec/reek/core/code_context_spec.rb", "spec/reek/core/code_parser_spec.rb", "spec/reek/core/config_spec.rb", "spec/reek/core/method_context_spec.rb", "spec/reek/core/module_context_spec.rb", "spec/reek/core/object_refs_spec.rb", "spec/reek/core/singleton_method_context_spec.rb", "spec/reek/core/smell_configuration_spec.rb", "spec/reek/core/stop_context_spec.rb", "spec/reek/core/warning_collector_spec.rb", "spec/reek/examiner_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/boolean_parameter_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/irresponsible_module_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/long_yield_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/simulated_polymorphism_spec.rb", "spec/reek/smells/smell_detector_shared.rb", "spec/reek/smells/uncommunicative_method_name_spec.rb", "spec/reek/smells/uncommunicative_module_name_spec.rb", "spec/reek/smells/uncommunicative_parameter_name_spec.rb", "spec/reek/smells/uncommunicative_variable_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/reek/source/code_comment_spec.rb", "spec/reek/source/object_source_spec.rb", "spec/reek/source/reference_collector_spec.rb", "spec/reek/source/source_code_spec.rb", "spec/reek/source/tree_dresser_spec.rb", "spec/reek/spec/should_reek_of_spec.rb", "spec/reek/spec/should_reek_only_of_spec.rb", "spec/reek/spec/should_reek_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/config/allow_duplication.reek", "spec/samples/config/deeper_nested_iterators.reek", "spec/samples/corrupt_config_file/corrupt.reek", "spec/samples/corrupt_config_file/dirty.rb", "spec/samples/demo/demo.rb", "spec/samples/empty_config_file/dirty.rb", "spec/samples/empty_config_file/empty.reek", "spec/samples/exceptions.reek", "spec/samples/inline_config/dirty.rb", "spec/samples/inline_config/masked.reek", "spec/samples/inline.rb", "spec/samples/mask_some/dirty.rb", "spec/samples/mask_some/some.reek", "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
+Thank you for downloading Reek. For info:
+  - see the reek wiki http://wiki.github.com/kevinrutherford/reek
+  - follow @rubyreek on twitter
 }
   s.rdoc_options = ["--main", "README.md"]
   s.require_paths = ["lib"]

data/spec/matchers/smell_of_matcher.rb

@@ -0,0 +1,58 @@
+module SmellOfMatcher
+  class SmellOf
+    def initialize(klass, *expected_smells)
+      @klass = klass
+      @expected_smells = expected_smells
+      @config = {}
+    end
+
+    def failure_message_for_should
+      "Expected #{@source.desc} to smell of #{@klass}, but it didn't: #{@reason}"
+    end
+
+    def failure_message_for_should_not
+      "Expected #{@source.desc} not to smell of #{@klass}, but it did"
+    end
+
+    def matches?(src)
+      @source = src.to_reek_source
+      ctx = MethodContext.new(nil, @source.syntax_tree)
+      detector = @klass.new(@source.desc, @klass.default_config.merge(@config))
+      detector.examine(ctx)
+      actual_smells = detector.smells_found.to_a
+      if actual_smells.empty?
+        @reason = 'no smells found by detector'
+        return false
+      end
+      return false if actual_smells.any? do |expected_smell|
+        @reason = "Found #{expected_smell.smell_class}/#{expected_smell.subclass}" &&
+        expected_smell.smell_class != @klass::SMELL_CLASS &&
+          expected_smell.subclass != @klass::SMELL_SUBCLASS
+      end
+      return actual_smells.length == 1 if @expected_smells.empty?
+      return false unless @expected_smells.length == actual_smells.length
+      @expected_smells.each_with_index do |expected_smell,index|
+        expected_smell.each do |(key,value)|
+          if actual_smells[index].smell[key] != value
+            @reason = "#{key} != #{value}"
+            return false
+          end
+        end
+      end
+      true
+    end
+
+    def with_config(options)
+      @config = options
+      self
+    end
+  end
+
+  def smell_of(klass, *smells)
+    SmellOf.new(klass, *smells)
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include(SmellOfMatcher)
+end

data/spec/reek/core/code_context_spec.rb

@@ -13,6 +13,7 @@ describe CodeContext do
       @exp = mock('exp')
       @exp.should_receive(:name).any_number_of_times.and_return(@exp_name)
       @exp.should_receive(:full_name).any_number_of_times.and_return(@full_name)
+      @exp.should_receive(:comments).any_number_of_times.and_return('')
       @ctx = CodeContext.new(nil, @exp)
     end
     it 'gets its short name from the exp' do
@@ -36,6 +37,7 @@ describe CodeContext do
         @outer_name = 'another_random sting'
         outer = mock('outer')
         outer.should_receive(:full_name).at_least(:once).and_return(@outer_name)
+        outer.should_receive(:config).and_return({})
         @ctx = CodeContext.new(outer, @exp)
       end
       it 'creates the correct full name' do
@@ -54,8 +56,8 @@ describe CodeContext do
     it 'should pass unknown method calls down the stack' do
       stop = StopContext.new
       def stop.bananas(arg1, arg2) arg1 + arg2 + 43 end
-      element = ModuleContext.new(stop, 'mod', s(:module, :mod, nil))
-      element = MethodContext.new(element, [0, :bad])
+      element = ModuleContext.new(stop, 'mod', ast(:module, :mod, nil))
+      element = MethodContext.new(element, ast(:defn, :bad))
       element.bananas(17, -5).should == 55
     end
   end

data/spec/reek/core/code_parser_spec.rb

@@ -15,7 +15,8 @@ end
 
 describe CodeParser, 'with a global method definition' do
   it 'reports no problems for simple method' do
-    'def Outermost::fred() true; end'.should_not reek
+    src = 'def Outermost::fred() true; end'
+    src.should_not reek
   end
 end