reek 0.1.1 → 0.2.0

data/History.txt

@@ -1,3 +1,9 @@
+== 0.2.0 2008-09-10
+
+* Minor enhancements:
+  * Added --help, --version options
+  * Added --sort option to sort the report by smell or by code location
+
 == 0.1.1 2008-09-09
 
 * Some tweaks:

data/bin/reek

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 #
 #  Created on 2008-2-17.
-#  Copyright (c) 2008. All rights reserved.
+#  Copyright (c) 2008 Kevin Rutherford, Rutherford Software Ltd. All rights reserved.
 
 begin
   require 'rubygems'
@@ -10,6 +10,8 @@ rescue LoadError
 end
 
 require 'reek'
+require 'reek/options'
+require 'reek/version'
 
 def classes_currently_loaded
   result = []
@@ -17,6 +19,8 @@ def classes_currently_loaded
   result
 end
 
+Reek::Options.parse(ARGV)
+
 old_classes = classes_currently_loaded
 files = ARGV
 files = Dir['**/*.rb'] if files.empty?

data/lib/reek/options.rb

@@ -0,0 +1,61 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'reek/report'
+require 'optparse'
+
+include Reek
+
+module Reek
+
+  class Options
+    def self.default_options
+      {:sort_order => Report::SORT_ORDERS[:context]}
+    end
+    
+    @@opts = default_options
+
+    def self.[](key)
+      @@opts[key]
+    end
+
+    def self.parse_args(args)
+      result = default_options
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename($0)} [options] [files]"
+
+        opts.separator ""
+        opts.separator "Specific options:"
+
+        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
+          puts "#{File.basename($0)} #{Reek::VERSION::STRING}"
+          exit(0)
+        end
+      end
+
+      parser.parse!(args)
+      result
+    end
+    
+    def self.parse(args)
+      begin
+        @@opts = parse_args(args)
+      rescue OptionParser::ParseError => e
+        puts "Error: #{e}"
+        puts "Use '-h' for help."
+        exit(1)
+      end
+    end
+  end
+end

data/lib/reek/report.rb

@@ -4,7 +4,25 @@ require 'set'
 
 module Reek
 
+  class SortByContext
+    def compare(smell1, smell2)
+      smell1.detailed_report <=> smell2.detailed_report
+    end
+  end
+
+  class SortBySmell
+    def compare(smell1, smell2)
+      smell1.report <=> smell2.report
+    end
+  end
+
   class Report
+
+    SORT_ORDERS = {
+      :context => SortByContext.new,
+      :smell => SortBySmell.new
+    }
+
     def initialize  # :nodoc:
       @smells = SortedSet.new
     end
@@ -17,10 +35,6 @@ module Reek
       @smells.empty?
     end
 
-    def include?(obj)  # :nodoc:
-      @smells.include?(obj)
-    end
-
     def length  # :nodoc:
       @smells.length
     end
@@ -35,4 +49,5 @@ module Reek
       @smells.map {|smell| smell.report}.join("\n")
     end
   end
+
 end

data/lib/reek/smells.rb

@@ -1,6 +1,7 @@
 $:.unshift File.dirname(__FILE__)
 
 require 'reek/printer'
+require 'reek/options'
 
 module Reek
 
@@ -25,12 +26,10 @@ module Reek
     end
 
     def <=>(other)  # :nodoc:
-      self.report <=> other.report
+      Options[:sort_order].compare(self, other)
     end
 
-    def eql?(other)  # :nodoc:
-      self.report.eql?(other.report)
-    end
+    alias eql? <=>
     
     def name
       self.class.convert_camel_case(self.class.name.split(/::/)[1])
@@ -39,6 +38,10 @@ module Reek
     def report
       "[#{name}] #{detailed_report}"
     end
+
+    def to_s
+      report
+    end
   end
 
   class LongParameterList < Smell

data/lib/reek/version.rb

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

data/spec/reek/feature_envy_spec.rb

@@ -25,8 +25,8 @@ describe MethodChecker, "(Feature Envy)" do
   it 'should report simple parameter call' do
     @cchk.check_source('def simple(arga) arga[3] end')
     @rpt.length.should == 2
-    @rpt[1].should == UtilityFunction.new(@cchk)
-    @rpt[0].should == FeatureEnvy.new(@cchk, ':arga')
+    @rpt[0].should == UtilityFunction.new(@cchk)
+    @rpt[1].should == FeatureEnvy.new(@cchk, ':arga')
   end
 
   it 'should report highest affinity' do

data/spec/reek/options_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+ 
+require 'reek/options'
+
+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[:sort_order].should == default_order
+  end
+end
+
+describe Options, ' when --sort_order is specified' do
+  before :each do
+    @default_order = Options[:sort_order]
+  end
+
+  it 'should require an argument' do
+    lambda { Options.parse_args(['-s']) }.should raise_error(OptionParser::MissingArgument)
+    Options[:sort_order].should == @default_order
+  end
+
+  it "should allow sort by smell" do
+    Options.parse %w{-s smell}
+    Options[:sort_order].should == Report::SORT_ORDERS[:smell]
+  end
+
+  it "should allow sort by context" do
+    Options.parse %w{-s context}
+    Options[:sort_order].should == Report::SORT_ORDERS[:context]
+  end
+
+  it "should reject illegal sort order" do
+    lambda { Options.parse_args(%w{-s tarts}) }.should raise_error(OptionParser::InvalidArgument)
+    Options[:sort_order].should == @default_order
+  end
+end

data/spec/reek/report_spec.rb

@@ -47,3 +47,36 @@ describe Report, " as a SortedSet" do
     rpt.length.should == 1
   end
 end
+
+describe SortByContext do
+  before :each do
+    @sorter = SortByContext.new
+  end
+
+  it 'should return 0 for identical smells' do
+    smell = LongMethod.new('Class#method')
+    @sorter.compare(smell, smell).should == 0
+  end
+
+  it 'should return non-0 for different smells' do
+    @sorter.compare(LongMethod.new('x'), FeatureEnvy.new('y', 1)).should == -1
+  end
+end
+
+describe SortBySmell do
+  before :each do
+    @sorter = SortBySmell.new
+  end
+  
+  it 'should return 0 for identical smells' do
+    @sorter.compare(LongMethod.new('x'), LongMethod.new('x')).should == 0
+  end
+
+  it 'should differentiate identical smells with different contexts' do
+    @sorter.compare(LongMethod.new('x'), LongMethod.new('y')).should == -1
+  end
+
+  it 'should differentiate different smells with identical contexts' do
+    @sorter.compare(LongMethod.new('x'), FeatureEnvy.new('x', 2)).should == 1
+  end
+end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>Code smell detector</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.1.1</a>
+      <a href="http://rubyforge.org/projects/reek" class="numbers">0.2.0</a>
     </div>
     <h1>&#x2192; &#8216;reek&#8217;</h1>
 

data/website/index.txt

@@ -18,7 +18,7 @@ h2. The basics
   $ reek
 </pre>
 
-(More details coming soon...)
+(See reek --help for more.)
 
 h2. Code Smells
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reek
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-09 00:00:00 +01:00
+date: 2008-09-12 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,7 @@ files:
 - lib/reek/checker.rb
 - lib/reek/class_checker.rb
 - lib/reek/method_checker.rb
+- lib/reek/options.rb
 - lib/reek/printer.rb
 - lib/reek/report.rb
 - lib/reek/smells.rb
@@ -63,6 +64,7 @@ files:
 - spec/reek/long_method_spec.rb
 - spec/reek/method_checker_spec.rb
 - spec/reek/nested_iterators_spec.rb
+- spec/reek/options_spec.rb
 - spec/reek/report_spec.rb
 - spec/reek/smell_spec.rb
 - spec/reek/uncommunicative_name_spec.rb