reek 0.2.3 → 0.3.0

data/History.txt

@@ -1,3 +1,15 @@
+== 0.2.x 2008-??-??
+
+* Minor enhancements:
+  * New smell: first naive checks for Control Couple
+  * reek now only checks sources passed on the command line
+  * Code snippets can be supplied on the commandline
+  * Added headings and warnings count when smells in multiple files
+  * Added Reek::RakeTask to run reek from rakefiles
+* Tweaks:
+  * Fixed: Returns exit status 2 when smells are reported
+  * Fixed: no longer claims an empty method is a Utility Function
+
 == 0.2.3 2008-09-22
 
 * Minor enhancements:

data/README.txt

@@ -1,8 +1,7 @@
 = reek
 
 * http://rubyforge.org/projects/reek/
-* http://www.refactoring-workbook.com/reek
-* kevin@rutherford-software.com
+* mailto:kevin@rutherford-software.com
 
 == DESCRIPTION:
 
@@ -11,6 +10,8 @@ reports any code smells it finds.
 
 === SUPPORTED CODE SMELLS:
 
+Reek currently includes very naive checks for the following smells:
+
 * Long Method
 * Large Class
 * Feature Envy
@@ -18,6 +19,7 @@ reports any code smells it finds.
 * Long Parameter List
 * Utility Function
 * Nested Iterators
+* Control Couple
 
 == FEATURES/PROBLEMS:
 
@@ -28,13 +30,16 @@ reports any code smells it finds.
 
 == SYNOPSIS:
 
-  $ reek [options] [source_files]
+  $ reek [options] sources
 
 (See `reek --help` for details.)
 
-== REQUIREMENTS:
+== DEPENDENCIES:
+
+Reek makes use of the following other gems:
 
 * ParseTree
+* sexp_processor
 
 == INSTALL:
 
@@ -42,7 +47,7 @@ Get the latest version of the gem:
 
     $ gem install reek
 
-Or get the latest unpackaged source code:
+Or get the latest source code from:
 
     $ git clone git://github.com/kevinrutherford/reek.git
 

data/bin/reek

@@ -2,9 +2,24 @@
 #
 #  Created on 2008-2-17.
 #  Copyright (c) 2008 Kevin Rutherford, Rutherford Software Ltd. All rights reserved.
+#
+
+require File.join(File.dirname(__FILE__), '../lib/', 'reek')
+require File.join(File.dirname(__FILE__), '../lib/', 'reek/options')
 
-require 'reek'
-require 'reek/options'
+sources = Reek::Options.parse(ARGV)
+exitstatus = 0
+sources.each do |src|
+  smells = Reek.analyse(src)
+  next if smells.empty?
+  if sources.size == 1
+    puts smells.to_s
+  else
+    puts "\"#{src}\" -- #{smells.length} warnings:"
+    puts smells.to_s
+    puts
+  end
+  exitstatus = 2
+end
 
-files = Reek::Options.parse(ARGV)
-puts Reek.analyse(*files).to_s
+exit(exitstatus)

data/lib/reek.rb

@@ -5,16 +5,22 @@ require 'reek/report'
 
 module Reek # :doc:
 
-    #
-    # Analyse the given source files, looking for code smells.
-    # Returns a +Report+ listing the smells found.
-    #
-    def self.analyse(*files)  # :doc:
-      report = Report.new
-      files.each do |file|
-        source = IO.readlines(file).join
-        FileChecker.new(report).check_source(source)
-      end
-      report
-    end    
+  #
+  # Analyse the given source files, looking for code smells.
+  # Returns a +Report+ listing the smells found.
+  #
+  def self.analyse(*files)  # :doc:
+    report = Report.new
+    files.each do |file|
+      source = Reek.read(file)
+      FileChecker.new(report).check_source(source)
+    end
+    report
+  end
+
+private
+
+  def self.read(file)
+    File.exists?(file) ? IO.readlines(file).join : file
+  end
 end

data/lib/reek/method_checker.rb

@@ -29,6 +29,7 @@ module Reek
     def process_args(exp)
       LongParameterList.check(exp, self)
       exp.each { |arg| UncommunicativeName.check(arg, self, 'parameter') }
+      @args = exp[1..-1]
       s(exp)
     end
 
@@ -95,6 +96,14 @@ module Reek
       s(exp)
     end
 
+    def process_if(exp)
+      process(exp[1])
+      process(exp[2])
+      process(exp[3]) if exp[3]
+      ControlCouple.check(exp[1], self, @args)
+      s(exp)
+    end
+
     def process_ivar(exp)
       UncommunicativeName.check(exp[1], self, 'field')
       @depends_on_self = true
@@ -127,6 +136,7 @@ module Reek
     def self.count_statements(exp)
       result = exp.length - 1
       result -= 1 if Array === exp[1] and exp[1][0] == :args
+      result -= 1 if exp[2] == s(:nil)
       result
     end
 
@@ -155,7 +165,7 @@ module Reek
     def check_method_properties
       @lvars.each {|lvar| UncommunicativeName.check(lvar, self, 'local variable') }
       @depends_on_self = true if is_override?
-      FeatureEnvy.check(@refs, self) unless UtilityFunction.check(@depends_on_self, self)
+      FeatureEnvy.check(@refs, self) unless UtilityFunction.check(@depends_on_self, self, @num_statements)
       LongMethod.check(@num_statements, self) unless method_name == 'initialize'
     end
   end

data/lib/reek/options.rb

@@ -10,7 +10,10 @@ module Reek
 
   class Options
     def self.default_options
-      {:sort_order => Report::SORT_ORDERS[:context]}
+      {
+        :sort_order => Report::SORT_ORDERS[:context],
+        :expressions => []
+      }
     end
     
     @@opts = default_options
@@ -22,24 +25,26 @@ module Reek
     def self.parse_args(args)
       result = default_options
       parser = OptionParser.new do |opts|
-        opts.banner = "Usage: #{File.basename($0)} [options] [files]"
+        opts.banner = <<EOB
+Usage: #{File.basename($0)} [options] SOURCES
+
+The SOURCES may be any combination of file paths and Ruby source code.
+EOB
 
         opts.separator ""
-        opts.separator "Specific options:"
+        opts.separator "Options:"
+
+        opts.on("-h", "--help", "Show this message") do
+          puts opts
+          exit(0)
+        end
 
         opts.on('-s', "--sort ORDER", Report::SORT_ORDERS.keys,
           "Select sort order for report (#{Report::SORT_ORDERS.keys.join(', ')})") do |arg|
           result[:sort_order] = Report::SORT_ORDERS[arg] unless arg.nil?
         end
 
-        opts.separator ""
-        opts.separator "Common options:"
-        opts.on_tail("-h", "--help", "Show this message") do
-          puts opts
-          exit(0)
-        end
-
-        opts.on_tail("-v", "--version", "Show version") do
+        opts.on("-v", "--version", "Show version") do
           puts "#{File.basename($0)} #{Reek::VERSION::STRING}"
           exit(0)
         end
@@ -58,10 +63,7 @@ module Reek
     def self.parse(args)
       begin
         @@opts = parse_args(args)
-        files = ARGV
-        files = Dir['**/*.rb'] if files.empty?
-        fatal_error('no source files specified') if files.empty?
-        files
+        ARGV
       rescue OptionParser::ParseError => e
         fatal_error(e)
       end

data/lib/reek/rake_task.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+
+# Define a task library for running reek.
+
+require 'rake'
+require 'rake/tasklib'
+
+module Reek
+
+  # A Rake task that runs reek on a set of source files.
+  #
+  # Example:
+  #
+  #   Reek::RakeTask.new do |t|
+  #     t.fail_on_error = false
+  #   end
+  #
+  # This will create a task that can be run with:
+  #
+  #   rake reek
+  #
+  # If rake is invoked with a "SPEC=filename" command line option,
+  # then the list of spec files will be overridden to include only the
+  # filename specified on the command line.  This provides an easy way
+  # to run just one spec.
+  #
+  # If rake is invoked with a "REEK_SORT=order" command line option,
+  # then the given sort order will override the value of the +sort+
+  # attribute.
+  #
+  # Examples:
+  #
+  #   rake reek                                      # run specs normally
+  #   rake reek SPEC=just_one_file.rb                # run just one spec file.
+  #   rake reek REEK_SORT=smell                      # sort warnings by smell
+  #
+  class RakeTask < ::Rake::TaskLib
+
+    # Name of reek task. (default is :reek)
+    attr_accessor :name
+
+    # Array of directories to be added to $LOAD_PATH before running reek.
+    # Defaults to ['<the absolute path to reek's lib directory>']
+    attr_accessor :libs
+
+    # Glob pattern to match source files. (default is 'lib/**/*.rb')
+    # Setting the REEK_SRC environment variable overrides this.
+    attr_accessor :source_files
+
+    # Set the sort order for reported smells (see 'reek --help' for possible values).
+    # Setting the REEK_SORT environment variable overrides this.
+    attr_accessor :sort
+
+    # Array of commandline options to pass to ruby. Defaults to [].
+    attr_accessor :ruby_opts
+
+    # Whether or not to fail Rake when an error occurs (typically when specs fail).
+    # Defaults to true.
+    attr_accessor :fail_on_error
+
+    # Use verbose output. If this is set to true, the task will print
+    # the reek command to stdout. Defaults to false.
+    attr_accessor :verbose
+
+    # Defines a new task, using the name +name+.
+    def initialize(name = :reek)
+      @name = name
+      @libs = [File.expand_path(File.dirname(__FILE__) + '/../../../lib')]
+      @source_files = nil
+      @ruby_opts = []
+      @fail_on_error = true
+      @sort = nil
+
+      yield self if block_given?
+      @source_files ||= 'lib/**/*.rb'
+      define
+    end
+
+    def define # :nodoc:
+      desc "Check for code smells" unless ::Rake.application.last_comment
+      task(name) { run_task }
+      self
+    end
+    
+    def run_task
+      return if source_file_list.empty?
+      cmd = cmd_words.join(' ')
+      puts cmd if @verbose
+      raise("Smells found!") if !system(cmd) and fail_on_error
+    end
+    
+    def self.reek_script
+      File.expand_path(File.dirname(__FILE__) + '/../../bin/reek')
+    end
+
+    def self.ruby_exe
+      File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
+    end
+
+    def cmd_words
+      [self.class.ruby_exe] +
+          ruby_options +
+          [ %Q|"#{self.class.reek_script}"| ] +
+          [sort_option] +
+          source_file_list.collect { |fn| %["#{fn}"] }
+    end
+
+    def ruby_options
+      lib_path = @libs.join(File::PATH_SEPARATOR)
+      @ruby_opts.clone << "-I\"#{lib_path}\""
+    end
+    
+    def sort_option
+      env_sort = ENV['REEK_SORT']
+      return "--sort #{env_sort}" if env_sort
+      return "--sort #{@sort}" if @sort
+      ''
+    end
+
+    def source_file_list # :nodoc:
+      env_src = ENV['REEK_SRC']
+      return env_src if env_src
+      return FileList[@source_files] if @source_files
+      []
+    end
+
+  end
+end

data/lib/reek/smells.rb

@@ -109,8 +109,13 @@ module Reek
   end
 
   class UtilityFunction < Smell
+    def initialize(context, num_stmts)
+      super
+      @num_stmts = num_stmts
+    end
+
     def recognise?(depends_on_self)
-      !depends_on_self
+      @num_stmts > 0 and !depends_on_self
     end
 
     def detailed_report
@@ -168,4 +173,20 @@ module Reek
       "#{@context} has nested iterators"
     end
   end
+
+  class ControlCouple < Smell
+    def initialize(context, args)
+      super
+      @args = args
+    end
+
+    def recognise?(cond)
+      @couple = cond
+      cond[0] == :lvar and @args.include?(@couple[1])
+    end
+
+    def detailed_report
+      "#{@context} is controlled by argument #{Printer.print(@couple)}"
+    end
+  end
 end

data/lib/reek/version.rb

@@ -1,8 +1,8 @@
 module Reek #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 2
-    TINY  = 3
+    MINOR = 3
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/integration_spec.rb

@@ -1,15 +1,5 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
-require 'reek/version'
-
-describe 'Reek version number' do
-  it 'should report the correct value' do
-    actual = `ruby -Ilib bin/reek --version`.split
-    actual[0].should == 'reek'
-    actual[1].should == Reek::VERSION::STRING
-  end
-end
-
 describe 'Integration test:' do
   Dir['spec/samples/*.rb'].each do |source|
     describe source do

data/spec/reek/control_couple_spec.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+require 'reek/method_checker'
+require 'reek/report'
+
+include Reek
+
+describe MethodChecker, "(Control Couple)" do
+
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it 'should report a ternary check on a parameter' do
+    @cchk.check_source('def simple(arga) arga ? @ivar : 3 end')
+    @rpt.length.should == 1
+    ControlCouple.should === @rpt[0]
+    @rpt[0].to_s.should match(/arga/)
+  end
+
+  it 'should not report a ternary check on an ivar' do
+    @cchk.check_source('def simple(arga) @ivar ? arga : 3 end')
+    @rpt.should be_empty
+  end
+
+  it 'should not report a ternary check on a lvar' do
+    @cchk.check_source('def simple(arga) lvar = 27; lvar ? arga : @ivar end')
+    @rpt.should be_empty
+  end
+end

data/spec/reek/feature_envy_spec.rb

@@ -186,8 +186,8 @@ describe FeatureEnvy, 'when the receiver is a dvar' do
     @cchk = MethodChecker.new(@rpt, 'Thing')
   end
 
-  it "should not report method with successive iterators" do
-    pending('this is a bug!')
+  it "should count each scope separately" do
+    pending('bug')
     source =<<EOS
 def bad(fred)
   @fred.each {|item| item.each }
@@ -198,3 +198,25 @@ EOS
     @rpt.should be_empty
   end  
 end
+
+describe FeatureEnvy, 'when the receiver is a message chain keyed on self' do
+  before(:each) do
+    @rpt = Report.new
+    @cchk = MethodChecker.new(@rpt, 'Thing')
+  end
+
+  it "count the references correctly" do
+    pending('bug')
+    source =<<EOS
+class Parcel
+  def addressee
+    "#{self.person.first_name} #{self.person.last_name}"
+  end
+end
+EOS
+    @chk.check_source(source)
+    @rpt.length.should == 1
+    FeatureEnvy.should === @rpt[0]
+    @rpt[0].to_s.should match(/self.person/)
+  end  
+end

data/spec/reek/options_spec.rb

@@ -7,7 +7,7 @@ include Reek
 describe Options, ' when given no arguments' do
   it "should retain the default sort order" do
     default_order = Options[:sort_order]
-    Options.parse []
+    Options.parse ['nosuchfile.rb']
     Options[:sort_order].should == default_order
   end
 end
@@ -23,12 +23,12 @@ describe Options, ' when --sort_order is specified' do
   end
 
   it "should allow sort by smell" do
-    Options.parse %w{-s smell}
+    Options.parse %w{-s smell xx}
     Options[:sort_order].should == Report::SORT_ORDERS[:smell]
   end
 
   it "should allow sort by context" do
-    Options.parse %w{-s context}
+    Options.parse %w{-s context xx}
     Options[:sort_order].should == Report::SORT_ORDERS[:context]
   end
 

data/spec/reek/report_spec.rb

@@ -41,9 +41,9 @@ end
 describe Report, " as a SortedSet" do
   it 'should only add a smell once' do
     rpt = Report.new
-    rpt << UtilityFunction.new(self)
+    rpt << UtilityFunction.new(self, 1)
     rpt.length.should == 1
-    rpt << UtilityFunction.new(self)
+    rpt << UtilityFunction.new(self, 1)
     rpt.length.should == 1
   end
 end

data/spec/reek/smell_spec.rb

@@ -17,17 +17,17 @@ end
 
 describe Smell, ' in comparisons' do
   it 'should hash equal when the smell is the same' do
-    UtilityFunction.new(self).hash.should == UtilityFunction.new(self).hash
+    UtilityFunction.new(self, 2).hash.should == UtilityFunction.new(self, 2).hash
     NestedIterators.new(self).hash.should == NestedIterators.new(self).hash
   end
 
   it 'should compare equal when the smell is the same' do
-    UtilityFunction.new(self).should == UtilityFunction.new(self)
+    UtilityFunction.new(self, 2).should == UtilityFunction.new(self, 2)
     NestedIterators.new(self).should == NestedIterators.new(self)
   end
 
   it 'should compare equal when using <=>' do
-    (UtilityFunction.new(self) <=> UtilityFunction.new(self)).should == 0
+    (UtilityFunction.new(self, 2) <=> UtilityFunction.new(self, 2)).should == 0
     (NestedIterators.new(self) <=> NestedIterators.new(self)).should == 0
   end
 end

data/spec/reek/utility_function_spec.rb

@@ -12,6 +12,11 @@ describe MethodChecker, "(Utility Function)" do
     @cchk = MethodChecker.new(@rpt, 'Thing')
   end
 
+  it 'should not report empty method' do
+    @cchk.check_source('def simple(arga) end')
+    @rpt.should be_empty
+  end
+
   it 'should not report instance variable reference' do
     @cchk.check_source('def simple(arga) @yellow end')
     @rpt.should be_empty
@@ -29,7 +34,7 @@ describe MethodChecker, "(Utility Function)" do
     @cchk.check_object(Fred)
     @rpt.should be_empty
   end
-  
+
   it 'should not report references to self' do
     @cchk.check_source('def into; self; end')
     @rpt.should be_empty
@@ -54,7 +59,7 @@ describe MethodChecker, "(Utility Function)" do
   it 'should report simple parameter call' do
     @cchk.check_source('def simple(arga) arga.to_s end')
     @rpt.length.should == 1
-    @rpt[0].should == UtilityFunction.new(@cchk)
+    @rpt[0].should == UtilityFunction.new(@cchk, 1)
   end
 
   it 'should report message chain' do
@@ -72,4 +77,19 @@ describe MethodChecker, "(Utility Function)" do
     ClassChecker.new(@rpt).check_object(Son)
     @rpt.should be_empty
   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
+    @cchk.check_source(source)
+    @rpt.should be_empty
+  end
 end

data/spec/reek_source_spec.rb

@@ -4,7 +4,8 @@ describe 'Reek source code:' do
   Dir['lib/**/*.rb'].each do |source|
     describe source do
       it 'should report no smells' do
-        `ruby -Ilib bin/reek #{source}`.should == "\n"
+        `ruby -Ilib bin/reek #{source}`.should == ''
+        $?.exitstatus.should == 0
       end
     end
   end

data/spec/samples/inline.reek

@@ -11,7 +11,9 @@
 [Nested Iterators] C#module_name has nested iterators
 [Feature Envy] C#module_name uses md5 more than self
 [Long Method] C#parse_signature has approx 15 statements
+[Control Couple] C#parse_signature is controlled by argument raw
 [Utility Function] C#strip_comments doesn't depend on instance state
 [Large Class] Dir has 31 methods
 [Large Class] Module has 34 methods
 [Long Method] Module#inline has approx 12 statements
+[Control Couple] Module#inline is controlled by argument options

data/spec/samples/optparse.reek

@@ -1,5 +1,4 @@
 [Large Class] AmbiguousArgument has 52 methods
-[Long Method] AmbiguousArgument#options has approx 6 statements
 [Long Parameter List] CompletingHash#complete has 4 parameters
 [Nested Iterators] CompletingHash#complete has nested iterators
 [Long Method] CompletingHash#getopts has approx 17 statements
@@ -13,11 +12,13 @@
 [Nested Iterators] CompletingHash#match has nested iterators
 [Feature Envy] CompletingHash#order uses argv more than self
 [Feature Envy] CompletingHash#parse uses argv more than self
-[Long Method] CompletingHash#parse_in_order has approx 31 statements
+[Long Method] CompletingHash#parse_in_order has approx 30 statements
 [Nested Iterators] CompletingHash#parse_in_order has nested iterators
+[Control Couple] CompletingHash#parse_in_order is controlled by argument setter
 [Feature Envy] CompletingHash#permute uses argv more than self
 [Long Parameter List] CompletingHash#summarize has 4 parameters
 [Uncommunicative Name] CompletingHash#ver uses the local variable name 'v'
+[Control Couple] List#accept is controlled by argument pat
 [Feature Envy] List#accept uses pat more than self
 [Uncommunicative Name] List#accept uses the parameter name 't'
 [Feature Envy] List#add_banner uses opt more than self
@@ -27,13 +28,19 @@
 [Feature Envy] List#summarize uses opt more than self
 [Long Parameter List] List#update has 5 parameters
 [Long Method] List#update has approx 6 statements
+[Control Couple] List#update is controlled by argument lopts
+[Control Couple] List#update is controlled by argument sopts
 [Uncommunicative Name] List#update uses the local variable name 'o'
+[Control Couple] NoArgument#parse is controlled by argument arg
 [Long Method] OptionParser#complete has approx 23 statements
 [Feature Envy] OptionParser#complete uses candidates more than self
 [Uncommunicative Name] OptionParser#complete uses the local variable name 'k'
 [Uncommunicative Name] OptionParser#complete uses the local variable name 'v'
 [Utility Function] OptionParser#convert doesn't depend on instance state
+[Control Couple] OptionalArgument#parse is controlled by argument arg
+[Control Couple] ParseError#set_option is controlled by argument eq
 [Long Method] PlacedArgument#parse has approx 6 statements
+[Control Couple] RequiredArgument#parse is controlled by argument arg
 [Uncommunicative Name] Switch#add_banner uses the local variable name 's'
 [Long Parameter List] Switch#initialize has 7 parameters
 [Long Method] Switch#parse_arg has approx 12 statements

data/spec/samples/redcloth.reek

@@ -1,5 +1,4 @@
 [Long Method] RedCloth#block_markdown_bq has approx 6 statements
-[Utility Function] RedCloth#block_markdown_lists doesn't depend on instance state
 [Utility Function] RedCloth#block_markdown_rule doesn't depend on instance state
 [Long Method] RedCloth#block_textile_lists has approx 21 statements
 [Nested Iterators] RedCloth#block_textile_lists has nested iterators
@@ -8,6 +7,8 @@
 [Nested Iterators] RedCloth#block_textile_table has nested iterators
 [Long Method] RedCloth#blocks has approx 17 statements
 [Nested Iterators] RedCloth#blocks has nested iterators
+[Control Couple] RedCloth#blocks is controlled by argument deep_code
+[Control Couple] RedCloth#check_refs is controlled by argument text
 [Utility Function] RedCloth#clean_html doesn't depend on instance state
 [Long Method] RedCloth#clean_html has approx 14 statements
 [Nested Iterators] RedCloth#clean_html has nested iterators
@@ -29,13 +30,18 @@
 [Utility Function] RedCloth#lT doesn't depend on instance state
 [Utility Function] RedCloth#no_textile doesn't depend on instance state
 [Long Method] RedCloth#pba has approx 22 statements
+[Control Couple] RedCloth#pba is controlled by argument text_in
 [Feature Envy] RedCloth#pba uses style and text more than self
 [Long Method] RedCloth#rip_offtags has approx 22 statements
 [Feature Envy] RedCloth#rip_offtags uses codepre more than self
 [Feature Envy] RedCloth#shelve uses @shelf more than self
 [Feature Envy] RedCloth#smooth_offtags uses @pre_list more than self
 [Long Parameter List] RedCloth#textile_bq has 4 parameters
+[Control Couple] RedCloth#textile_bq is controlled by argument atts
+[Control Couple] RedCloth#textile_bq is controlled by argument cite
 [Long Parameter List] RedCloth#textile_fn_ has 5 parameters
+[Control Couple] RedCloth#textile_fn_ is controlled by argument atts
 [Long Parameter List] RedCloth#textile_p has 4 parameters
+[Control Couple] RedCloth#textile_p is controlled by argument atts
 [Long Method] RedCloth#to_html has approx 24 statements
 [Utility Function] RedCloth#v_align doesn't depend on instance state

data/spec/script_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require 'reek/version'
+
+describe 'version number' do
+  it 'should report the correct value' do
+    actual = `ruby -Ilib bin/reek --version`.split
+    $?.exitstatus.should == 0
+    actual[0].should == 'reek'
+    actual[1].should == Reek::VERSION::STRING
+  end
+end
+
+describe 'exit status', 'when reek is used incorrectly' do
+  it 'should return non-zero status on bad option' do
+    `ruby -Ilib bin/reek --no-such-option`
+    $?.exitstatus.should == 1
+  end
+
+  it 'should not complain about missing file' do
+    `ruby -Ilib bin/reek nosuchfile.rb 2>/dev/null`
+    $?.exitstatus.should == 0
+  end
+
+  it 'should return non-zero status on missing argument' do
+    `ruby -Ilib bin/reek -s 2>/dev/null`
+    $?.exitstatus.should == 1
+  end
+
+  it 'should not complain when no source given' do
+    `ruby -Ilib bin/reek 2>/dev/null`
+    $?.exitstatus.should == 0
+  end
+end
+
+describe 'exit status', 'when reek is used correctly' do
+  it 'should return non-zero status when smells are reported' do
+    `ruby -Ilib bin/reek "def x() 3; end"`
+    $?.exitstatus.should == 2
+  end
+
+  it 'should return zero status with no smells' do
+    `ruby -Ilib bin/reek "def simple() @fred = 3 end"`
+    $?.exitstatus.should == 0
+  end
+end
+
+describe 'report format', 'with no sources' do
+  it 'should output nothing' do
+    `ruby -Ilib bin/reek`.should be_empty
+  end
+end
+
+describe 'report format', 'with one source' do
+  it 'should output nothing with empty source' do
+    `ruby -Ilib bin/reek ""`.should be_empty
+  end
+
+  it 'should output nothing when no smells' do
+    `ruby -Ilib bin/reek "def simple() @fred = 3; end"`.should be_empty
+  end
+
+  it 'should not adorn the list of warnings' do
+    report = `ruby -Ilib bin/reek "def y() @x = 3; end"`
+    report.split(/\n/).length.should == 1
+    report.should_not match(/\n\n/)
+  end
+end

data/tasks/reek.rake

@@ -0,0 +1,7 @@
+require 'reek/rake_task'
+
+Reek::RakeTask.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+#  t.sort = 'smell'
+end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>reek</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/reek"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/reek" class="numbers">0.2.2</a>
+      <a href="http://rubyforge.org/projects/reek" class="numbers">0.3.0</a>
     </div>
     <p>Reek is a tool that examines Ruby classes, modules and methods and reports any code smells it finds.</p>
 <h2>Installing</h2>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reek
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-22 00:00:00 +01:00
+date: 2008-11-02 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -18,9 +18,19 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sexp_processor
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.2.0
+        version: "3.0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -30,9 +40,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.7.0
+        version: 1.8.2
     version: 
-description: detects smells in your Ruby code
+description: detects smells in Ruby code
 email: 
 - kevin@rutherford-software.com
 executables: 
@@ -56,12 +66,14 @@ files:
 - lib/reek/object_refs.rb
 - lib/reek/options.rb
 - lib/reek/printer.rb
+- lib/reek/rake_task.rb
 - lib/reek/report.rb
 - lib/reek/smells.rb
 - lib/reek/version.rb
 - setup.rb
 - spec/integration_spec.rb
 - spec/reek/class_checker_spec.rb
+- spec/reek/control_couple_spec.rb
 - spec/reek/feature_envy_spec.rb
 - spec/reek/large_class_spec.rb
 - spec/reek/long_method_spec.rb
@@ -87,8 +99,10 @@ files:
 - spec/samples/optparse/version.rb
 - spec/samples/redcloth.rb
 - spec/samples/redcloth.reek
+- spec/script_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- tasks/reek.rake
 - tasks/rspec.rake
 - tasks/samples.rake
 - website/index.html
@@ -122,6 +136,6 @@ rubyforge_project: reek
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: detects smells in your Ruby code
+summary: detects smells in Ruby code
 test_files: []