reek 1.2.6 → 1.2.8

data/lib/reek/source/source_file.rb

@@ -0,0 +1,32 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), 'source_code')
+
+module Reek
+  module Source
+
+    #
+    # Represents a file of Ruby source, whose contents will be examined
+    # for code smells.
+    #
+    class SourceFile < SourceCode
+
+      def initialize(path)
+        @path = path
+        super(IO.readlines(@path).join, @path)
+      end
+
+      def configure(sniffer)
+        path = File.expand_path(File.dirname(@path))
+        all_config_files(path).each { |cf| ConfigFile.new(cf).configure(sniffer) }
+      end
+
+    private
+
+      def all_config_files(path)
+        return [] unless File.exist?(path)
+        parent = File.dirname(path)
+        return [] if path == parent
+        all_config_files(parent) + Dir["#{path}/*.reek"]
+      end
+    end
+  end
+end

data/lib/reek/source/source_locator.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), 'core_extras')
+
+module Reek
+  module Source
+
+    #
+    # Finds Ruby source files in a filesystem.
+    #
+    class SourceLocator
+      def initialize(paths)
+        @paths = paths
+      end
+
+      def all_sources
+        valid_paths.map {|path| File.new(path).to_reek_source }
+      end
+
+    private
+
+      def all_ruby_source_files(paths)
+        paths.map do |path|
+          if test 'd', path
+            all_ruby_source_files(Dir["#{path}/**/*.rb"])
+          else
+            path
+          end
+        end.flatten.sort
+      end
+
+      def valid_paths
+        all_ruby_source_files(@paths).select do |path|
+          if test 'f', path
+            true
+          else
+            $stderr.puts "Error: No such file - #{path}"
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/reek/source/tree_dresser.rb

@@ -0,0 +1,204 @@
+module Reek
+  module Source
+
+    #
+    # Extensions to +Sexp+ to allow +CodeParser+ to navigate the abstract
+    # 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
+
+      def has_type?(type)
+        is_language_node? and first == type
+      end
+
+      def each_node(type, ignoring, &blk)
+        if block_given?
+          look_for(type, ignoring, &blk)
+        else
+          result = []
+          look_for(type, ignoring) {|exp| result << exp}
+          result
+        end
+      end
+
+      #
+      # Carries out a depth-first traversal of this syntax tree, yielding
+      # every Sexp of type +target_type+. The traversal ignores any node
+      # whose type is listed in the Array +ignoring+.
+      #
+      def look_for(target_type, ignoring, &blk)
+        each do |elem|
+          if Sexp === elem then
+            elem.look_for(target_type, ignoring, &blk) unless ignoring.include?(elem.first)
+          end
+        end
+        blk.call(self) if first == target_type
+      end
+      def format_ruby
+        return self[0].to_s unless Array === self
+        Ruby2Ruby.new.process(deep_copy)
+      end
+      def deep_copy
+        YAML::load(YAML::dump(self))
+      end
+    end
+
+    module SexpExtensions
+      module AttrasgnNode
+        def args() self[3] end
+      end
+
+      module CaseNode
+        def condition() self[1] end
+      end
+
+      module CallNode
+        def receiver() self[1] end
+        def method_name() self[2] end
+        def args() self[3] end
+        def arg_names
+          args[1..-1].map {|arg| arg[1]}
+        end
+      end
+
+      module CvarNode
+        def name() self[1] end
+      end
+
+      CvasgnNode = CvarNode
+      CvdeclNode = CvarNode
+
+      module MethodNode
+        def arg_names
+          unless @args
+            @args = argslist[1..-1].reject {|param| Sexp === param or param.to_s =~ /^&/}
+          end
+          @args
+        end
+        def parameters()
+          unless @params
+            @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}"
+        end
+      end
+
+      module DefsNode
+        def receiver() self[1] end
+        def name() self[2] end
+        def argslist() self[3] end
+        def body() self[4] end
+        include MethodNode
+        def full_name(outer)
+          prefix = outer == '' ? '' : "#{outer}#"
+          "#{prefix}#{SexpNode.format(receiver)}.#{name}"
+        end
+      end
+
+      module IfNode
+        def condition() self[1] end
+      end
+
+      module IterNode
+        def call() self[1] end
+        def args() self[2] end
+        def block() self[3] end
+        def parameters() self[2] || [] end
+        def parameter_names
+          result = parameters
+          return case result[0]
+          when :lasgn
+            [result[1]]
+          when :masgn
+            result[1][1..-1].map {|lasgn| lasgn[1]}
+          else
+            []
+          end
+        end
+      end
+
+      module LitNode
+        def value() self[1] end
+      end
+
+      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}#{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
+          args.map {|arg| arg[1]}
+        end
+      end
+    end
+
+    #
+    # Adorns an abstract syntax tree with mix-in modules to make accessing
+    # the tree more understandable and less implementation-dependent.
+    #
+    class TreeDresser
+
+      def dress(sexp)
+        sexp.extend(SexpNode)
+        module_name = extensions_for(sexp.sexp_type)
+        if SexpExtensions.const_defined?(module_name)
+          sexp.extend(SexpExtensions.const_get(module_name))
+        end
+        sexp[0..-1].each { |sub| dress(sub) if Array === sub }
+        sexp
+      end
+
+      def extensions_for(node_type)
+        "#{node_type.to_s.capitalize}Node"
+      end
+    end
+  end
+end

data/lib/reek/source.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'code_comment')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'config_file')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'core_extras')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'sexp_formatter')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'source_code')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'source_file')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'source_locator')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'source', 'tree_dresser')
+
+module Reek
+
+  #
+  # This module contains a set of classes for interacting with Ruby
+  # source code and abstract syntax trees.
+  #
+  module Source    # :nodoc: all
+  end
+end

data/lib/reek/spec/should_reek.rb

@@ -0,0 +1,31 @@
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'examiner')
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'cli', 'report')
+
+module Reek
+  module Spec
+
+    #
+    # An rspec matcher that matches when the +actual+ has code smells.
+    #
+    class ShouldReek        # :nodoc:
+      def matches?(actual)
+        @examiner = Examiner.new(actual)
+        @examiner.smelly?
+      end
+      def failure_message_for_should
+        "Expected #{@examiner.description} to reek, but it didn't"
+      end
+      def failure_message_for_should_not
+        rpt = Cli::ReportFormatter.format_list(@examiner.smells)
+        "Expected no smells, but got:\n#{rpt}"
+      end
+    end
+
+    #
+    # Returns +true+ if and only if the target source code contains smells.
+    #
+    def reek
+      ShouldReek.new
+    end
+  end
+end

data/lib/reek/spec/should_reek_of.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'examiner')
+
+module Reek
+  module Spec
+
+    #
+    # An rspec matcher that matches when the +actual+ has the specified
+    # code smell.
+    #
+    class ShouldReekOf        # :nodoc:
+      def initialize(klass, patterns)
+        @klass = klass
+        @patterns = patterns
+      end
+      def matches?(actual)
+        @examiner = Examiner.new(actual)
+        @all_smells = @examiner.smells
+        @all_smells.any? {|warning| warning.matches?(@klass, @patterns)}
+      end
+      def failure_message_for_should
+        "Expected #{@examiner.description} to reek of #{@klass}, but it didn't"
+      end
+      def failure_message_for_should_not
+        "Expected #{@examiner.description} not to reek of #{@klass}, but it did"
+      end
+    end
+
+    #
+    # Checks the target source code for instances of +smell_class+,
+    # and returns +true+ only if one of them has a report string matching
+    # all of the +patterns+.
+    #
+    def reek_of(smell_class, *patterns)
+      ShouldReekOf.new(smell_class, patterns)
+    end
+  end
+end

data/lib/reek/spec/should_reek_only_of.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'examiner')
+require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'cli', 'report')
+
+module Reek
+  module Spec
+
+    #
+    # An rspec matcher that matches when the +actual+ has the specified
+    # code smell and no others.
+    #
+    class ShouldReekOnlyOf < ShouldReekOf        # :nodoc:
+      def matches?(actual)
+        matches_examiner?(Examiner.new(actual))
+      end
+      def matches_examiner?(examiner)
+        @examiner = examiner
+        @warnings = @examiner.smells
+        @warnings.length == 1 and @warnings[0].matches?(@klass, @patterns)
+      end
+      def failure_message_for_should
+        rpt = Cli::ReportFormatter.format_list(@warnings)
+        "Expected #{@examiner.description} to reek only of #{@klass}, but got:\n#{rpt}"
+      end
+      def failure_message_for_should_not
+        "Expected #{@examiner.description} not to reek only of #{@klass}, but it did"
+      end
+    end
+
+    #
+    # As for reek_of, but the matched smell warning must be the only warning of
+    # any kind in the target source code's Reek report.
+    #
+    def reek_only_of(smell_class, *patterns)
+      ShouldReekOnlyOf.new(smell_class, patterns)
+    end
+  end
+end

data/lib/reek/spec.rb

@@ -0,0 +1,51 @@
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec', 'should_reek')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec', 'should_reek_of')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'spec', 'should_reek_only_of')
+
+module Reek
+
+  #
+  # Provides matchers for Rspec, making it easy to check code quality.
+  #
+  # If you require this module somewhere within your spec (or in your spec_helper),
+  # Reek will arrange to update Spec::Runner's config so that it knows about the
+  # matchers defined here.
+  #
+  # === Examples
+  #
+  # Here's a spec that ensures there are no active code smells in the current project:
+  #
+  #  describe 'source code quality' do
+  #    Dir['lib/**/*.rb'].each do |path|
+  #      it "reports no smells in #{path}" do
+  #        File.new(path).should_not reek
+  #      end
+  #    end
+  #  end
+  #
+  # And here's an even simpler way to do the same:
+  #
+  #  it 'has no code smells' do
+  #    Dir['lib/**/*.rb'].should_not reek
+  #  end
+  #
+  # Here's a simple check of a code fragment:
+  #
+  #  'def equals(other) other.thing == self.thing end'.should_not reek
+  #
+  # To check for specific smells, use something like this:
+  # 
+  #   ruby = 'def double_thing() @other.thing.foo + @other.thing.foo end'
+  #   ruby.should reek_of(:Duplication, /@other.thing[^\.]/)
+  #   ruby.should reek_of(:Duplication, /@other.thing.foo/)
+  #   ruby.should_not reek_of(:FeatureEnvy)
+  #
+  module Spec
+  end
+end
+
+if Object.const_defined?(:Spec)
+  Spec::Runner.configure do |config|
+    config.include(Reek::Spec)
+  end
+end

data/lib/reek.rb

@@ -1,5 +1,9 @@
-$:.unshift File.dirname(__FILE__)
-
-module Reek # :doc:
-  VERSION = '1.2.6'
+#
+# Reek's core functionality
+#
+module Reek
+  VERSION = '1.2.8'
 end
+
+require File.join(File.dirname(File.expand_path(__FILE__)), 'reek', 'examiner')
+require File.join(File.dirname(File.expand_path(__FILE__)), 'reek', 'smell_warning')

data/reek.gemspec

@@ -2,27 +2,29 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.2.6"
+  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{2009-11-28}
+  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.
 }
   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/profile.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/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/help_command.rb", "lib/reek/if_context.rb", "lib/reek/masking_collection.rb", "lib/reek/method_context.rb", "lib/reek/module_context.rb", "lib/reek/name.rb", "lib/reek/object_refs.rb", "lib/reek/reek_command.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/tree_dresser.rb", "lib/reek/version_command.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/adapters/source_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/help_command_spec.rb", "spec/reek/if_context_spec.rb", "spec/reek/masking_collection_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/reek_command_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/reek/tree_dresser_spec.rb", "spec/reek/version_command_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.extra_rdoc_files = ["History.txt", "License.txt"]
+  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.rdoc"]
+  s.rdoc_options = ["--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{reek}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Code smell detector for Ruby}
 
   if s.respond_to? :specification_version then

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/{help_command_spec.rb → cli/help_command_spec.rb}

@@ -1,8 +1,7 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'cli', 'help_command')
 
-require 'reek/help_command'
-
-include Reek
+include Reek::Cli
 
 describe HelpCommand do
   before :each do

data/spec/reek/cli/reek_command_spec.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))), 'spec_helper')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'cli', 'reek_command')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'cli', 'report')
+require File.join(File.dirname(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__))))), 'lib', 'reek', 'examiner')
+
+include Reek
+include Reek::Cli
+
+describe ReekCommand do
+  before :each do
+    @view = mock('view', :null_object => true)
+  end
+
+  context 'with smells' do
+    before :each do
+      examiner = Examiner.new('def x(); end')
+      @cmd = ReekCommand.new(QuietReport, ['def x(); end'])
+    end
+
+    it 'displays the correct text on the view' do
+      @view.should_receive(:output).with(/UncommunicativeName/)
+      @cmd.execute(@view)
+    end
+
+    it 'tells the view it succeeded' do
+      @view.should_receive(:report_smells)
+      @cmd.execute(@view)
+    end
+  end
+
+  context 'with no smells' do
+    before :each do
+      @cmd = ReekCommand.new(QuietReport, ['def clean(); end'])
+    end
+
+    it 'displays nothing on the view' do
+      @view.should_receive(:output).with('')
+      @cmd.execute(@view)
+    end
+
+    it 'tells the view it succeeded' do
+      @view.should_receive(:report_success)
+      @cmd.execute(@view)
+    end
+  end
+end