reek 0.3.0 → 0.3.1

data/spec/reek/{utility_function_spec.rb → smells/utility_function_spec.rb}

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

data/spec/samples/inline.reek

@@ -1,19 +1,27 @@
+[Duplication] C#build calls $?.==(0) more than once
+[Duplication] C#build calls Inline.directory more than once
+[Duplication] C#build calls io.puts more than once
+[Duplication] C#build calls io.puts(#endif) more than once
+[Duplication] C#build calls io.puts(#ifdef __cplusplus) more than once
 [Long Method] C#build has approx 61 statements
 [Nested Iterators] C#build has nested iterators
-[Feature Envy] C#build uses io more than self
 [Uncommunicative Name] C#build uses the local variable name 't'
 [Uncommunicative Name] C#c uses the method name 'c'
-[Feature Envy] C#crap_for_windoze uses Config::CONFIG more than self
+[Duplication] C#crap_for_windoze calls Config::CONFIG[libdir] more than once
+[Duplication] C#generate calls result.sub!((?-mix:\A\n), ) more than once
+[Duplication] C#generate calls signature[args] more than once
+[Duplication] C#generate calls signature[args].map more than once
 [Long Method] C#generate has approx 33 statements
-[Feature Envy] C#initialize uses stack more than self
+[Duplication] C#initialize calls stack.empty? more than once
 [Long Method] C#load_cache has approx 7 statements
 [Long Method] C#module_name has approx 6 statements
-[Nested Iterators] C#module_name has nested iterators
-[Feature Envy] C#module_name uses md5 more than self
+[Feature Envy] C#module_name refers to 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
+[Feature Envy] C#strip_comments refers to src more than self
 [Large Class] Dir has 31 methods
 [Large Class] Module has 34 methods
+[Duplication] Module#inline calls Inline.const_get(lang) more than once
 [Long Method] Module#inline has approx 12 statements
 [Control Couple] Module#inline is controlled by argument options

data/spec/samples/optparse.reek

@@ -2,6 +2,13 @@
 [Long Parameter List] CompletingHash#complete has 4 parameters
 [Nested Iterators] CompletingHash#complete has nested iterators
 [Long Method] CompletingHash#getopts has approx 17 statements
+[Duplication] CompletingHash#make_switch calls default_style.guess(arg=a) more than once
+[Duplication] CompletingHash#make_switch calls long.<<(o=q.downcase) more than once
+[Duplication] CompletingHash#make_switch calls pattern.method(convert) more than once
+[Duplication] CompletingHash#make_switch calls pattern.method(convert).to_proc more than once
+[Duplication] CompletingHash#make_switch calls pattern.respond_to?(convert) more than once
+[Duplication] CompletingHash#make_switch calls q.downcase more than once
+[Duplication] CompletingHash#make_switch calls sdesc.<<("-#{q}") more than once
 [Long Method] CompletingHash#make_switch has approx 69 statements
 [Nested Iterators] CompletingHash#make_switch has nested iterators
 [Uncommunicative Name] CompletingHash#make_switch uses the local variable name 'a'
@@ -10,30 +17,37 @@
 [Uncommunicative Name] CompletingHash#make_switch uses the local variable name 'q'
 [Uncommunicative Name] CompletingHash#make_switch uses the local variable name 's'
 [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
+[Duplication] CompletingHash#order calls argv[0] more than once
+[Feature Envy] CompletingHash#order refers to argv more than self
+[Duplication] CompletingHash#parse calls argv[0] more than once
+[Feature Envy] CompletingHash#parse refers to argv more than self
+[Duplication] CompletingHash#parse_in_order calls $!.set_option(arg, true) more than once
+[Duplication] CompletingHash#parse_in_order calls cb.call(val) more than once
+[Duplication] CompletingHash#parse_in_order calls setter.call(sw.switch_name, val) more than once
+[Duplication] CompletingHash#parse_in_order calls sw.block more than once
+[Duplication] CompletingHash#parse_in_order calls sw.switch_name more than once
 [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
+[Duplication] CompletingHash#permute calls argv[0] more than once
+[Feature Envy] CompletingHash#permute refers to 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
+[Feature Envy] List#accept refers to pat more than self
 [Uncommunicative Name] List#accept uses the parameter name 't'
-[Feature Envy] List#add_banner uses opt more than self
 [Long Parameter List] List#complete has 4 parameters
-[Feature Envy] List#initialize uses OptionMap more than self
 [Uncommunicative Name] List#reject uses the parameter name 't'
-[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
+[Duplication] OptionParser#complete calls candidates.size more than once
+[Duplication] OptionParser#complete calls k.id2name more than once
 [Long Method] OptionParser#complete has approx 23 statements
-[Feature Envy] OptionParser#complete uses candidates more than self
+[Feature Envy] OptionParser#complete refers to 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
@@ -43,14 +57,22 @@
 [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
+[Duplication] Switch#parse_arg calls s.length more than once
 [Long Method] Switch#parse_arg has approx 12 statements
-[Feature Envy] Switch#parse_arg uses arg more than self
+[Feature Envy] Switch#parse_arg refers to arg more than self
 [Uncommunicative Name] Switch#parse_arg uses the local variable name 'm'
 [Uncommunicative Name] Switch#parse_arg uses the local variable name 's'
+[Duplication] Switch#summarize calls block.max more than once
+[Duplication] Switch#summarize calls block.max.to_i more than once
+[Duplication] Switch#summarize calls indent.+(l) more than once
+[Duplication] Switch#summarize calls left.collect more than once
+[Duplication] Switch#summarize calls left.shift more than once
+[Duplication] Switch#summarize calls left[-1] more than once
+[Duplication] Switch#summarize calls s.length more than once
 [Long Parameter List] Switch#summarize has 5 parameters
 [Long Method] Switch#summarize has approx 27 statements
 [Nested Iterators] Switch#summarize has nested iterators
-[Feature Envy] Switch#summarize uses left more than self
+[Feature Envy] Switch#summarize refers to left more than self
 [Uncommunicative Name] Switch#summarize uses the local variable name 'l'
 [Uncommunicative Name] Switch#summarize uses the local variable name 'r'
 [Uncommunicative Name] Switch#summarize uses the local variable name 's'

data/spec/samples/redcloth.reek

@@ -1,24 +1,34 @@
 [Long Method] RedCloth#block_markdown_bq has approx 6 statements
 [Utility Function] RedCloth#block_markdown_rule doesn't depend on instance state
+[Duplication] RedCloth#block_textile_lists calls depth.last more than once
+[Duplication] RedCloth#block_textile_lists calls depth.last.length more than once
+[Duplication] RedCloth#block_textile_lists calls depth[i] more than once
+[Duplication] RedCloth#block_textile_lists calls line_id.-(1) more than once
+[Duplication] RedCloth#block_textile_lists calls lines[line_id.-(1)] more than once
+[Duplication] RedCloth#block_textile_lists calls tl.length more than once
 [Long Method] RedCloth#block_textile_lists has approx 21 statements
 [Nested Iterators] RedCloth#block_textile_lists has nested iterators
-[Feature Envy] RedCloth#block_textile_lists uses depth more than self
 [Long Method] RedCloth#block_textile_table has approx 19 statements
 [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
+[Duplication] RedCloth#clean_html calls tags[tag] more than once
 [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
+[Feature Envy] RedCloth#clean_html refers to tags more than self
 [Long Method] RedCloth#clean_white_space has approx 7 statements
-[Feature Envy] RedCloth#clean_white_space uses text more than self
+[Feature Envy] RedCloth#clean_white_space refers to text more than self
 [Utility Function] RedCloth#flush_left doesn't depend on instance state
+[Feature Envy] RedCloth#flush_left refers to indt more than self
+[Feature Envy] RedCloth#flush_left refers to text more than self
 [Utility Function] RedCloth#footnote_ref doesn't depend on instance state
 [Long Method] RedCloth#glyphs_textile has approx 9 statements
 [Utility Function] RedCloth#h_align doesn't depend on instance state
 [Utility Function] RedCloth#htmlesc doesn't depend on instance state
+[Feature Envy] RedCloth#htmlesc refers to str more than self
 [Utility Function] RedCloth#incoming_entities doesn't depend on instance state
 [Nested Iterators] RedCloth#inline has nested iterators
 [Long Method] RedCloth#inline_markdown_link has approx 6 statements
@@ -29,13 +39,21 @@
 [Nested Iterators] RedCloth#inline_textile_span has nested iterators
 [Utility Function] RedCloth#lT doesn't depend on instance state
 [Utility Function] RedCloth#no_textile doesn't depend on instance state
+[Feature Envy] RedCloth#no_textile refers to text more than self
+[Duplication] RedCloth#pba calls $1.length more than once
 [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
+[Feature Envy] RedCloth#pba refers to style more than self
+[Feature Envy] RedCloth#pba refers to text more than self
+[Duplication] RedCloth#rip_offtags calls @pre_list.last more than once
+[Duplication] RedCloth#rip_offtags calls @pre_list.last.<<(line) more than once
+[Duplication] RedCloth#rip_offtags calls codepre.-(used_offtags.length) more than once
+[Duplication] RedCloth#rip_offtags calls codepre.-(used_offtags.length).>(0) more than once
+[Duplication] RedCloth#rip_offtags calls codepre.zero? more than once
+[Duplication] RedCloth#rip_offtags calls used_offtags.length more than once
+[Duplication] RedCloth#rip_offtags calls used_offtags[notextile] more than once
 [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
+[Feature Envy] RedCloth#rip_offtags refers to codepre 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

data/spec/script_spec.rb

@@ -62,7 +62,7 @@ describe 'report format', 'with one source' do
 
   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.split(/\n/).length.should == 2
     report.should_not match(/\n\n/)
   end
 end

data/tasks/reek.rake

@@ -1,7 +1,16 @@
 require 'reek/rake_task'
+require 'flay'
 
 Reek::RakeTask.new do |t|
   t.fail_on_error = true
   t.verbose = false
 #  t.sort = 'smell'
 end
+
+desc 'Check for code duplication'
+task 'flay' do
+  files = FileList['lib/**/*.rb']
+  flayer = Flay.new(16)
+  flayer.process(*files)
+  flayer.report
+end

data/website/index.html

@@ -39,7 +39,7 @@
 <h2>Installing</h2>
 <code>$ gem install reek</code>
 <h2>The basics</h2>
-<code>$ reek [options] [source_files]</code>
+<code>$ reek [options] sources</code>
 <p>(See <code>reek --help</code> for details.)</p>
 <h2>Code Smells</h2>
 <p>reek currently includes very naive checks for the following code smells:</p>
@@ -51,6 +51,7 @@
 	<li>Long Parameter List</li>
 	<li>Utility Function</li>
 	<li>Nested Iterators</li>
+	<li>Control Couple</li>
 </ul>
 <h2>How to access the source code</h2>
 <p>The source is hosted on both <a href="http://github.com/kevinrutherford/reek/tree/master">github</a> and <a href="http://rubyforge.org/projects/reek/">rubyforge</a></p>
@@ -59,7 +60,7 @@
 <h2>Contact</h2>
 <p>Comments are welcome. Send an email to <a href="mailto:kevin@rutherford-software.com">Kevin Rutherford</a></p>
     <p class="coda">
-      <a href="http://www.kevinrutherford.co.uk">Kevin Rutherford</a>, 15th September 2008<br>
+      <a href="http://www.kevinrutherford.co.uk">Kevin Rutherford</a>, 2nd November 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -8,7 +8,7 @@ h2. Installing
 
 h2. The basics
 
-    @$ reek [options] [source_files]@
+    @$ reek [options] sources@
 
 (See @reek --help@ for details.)
 
@@ -23,6 +23,8 @@ reek currently includes very naive checks for the following code smells:
 * Long Parameter List
 * Utility Function
 * Nested Iterators
+* Control Couple
+* Duplication
 
 h2. How to access the source code
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reek
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-02 00:00:00 +00:00
+date: 2008-11-17 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,25 +68,37 @@ files:
 - lib/reek/printer.rb
 - lib/reek/rake_task.rb
 - lib/reek/report.rb
-- lib/reek/smells.rb
+- lib/reek/smells/control_couple.rb
+- lib/reek/smells/duplication.rb
+- lib/reek/smells/feature_envy.rb
+- lib/reek/smells/large_class.rb
+- lib/reek/smells/long_method.rb
+- lib/reek/smells/long_parameter_list.rb
+- lib/reek/smells/long_yield_list.rb
+- lib/reek/smells/nested_iterators.rb
+- lib/reek/smells/smell.rb
+- lib/reek/smells/smells.rb
+- lib/reek/smells/uncommunicative_name.rb
+- lib/reek/smells/utility_function.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
-- spec/reek/long_parameter_list_spec.rb
 - spec/reek/method_checker_spec.rb
-- spec/reek/nested_iterators_spec.rb
 - spec/reek/object_refs_spec.rb
 - spec/reek/options_spec.rb
 - spec/reek/printer_spec.rb
 - spec/reek/report_spec.rb
-- spec/reek/smell_spec.rb
-- spec/reek/uncommunicative_name_spec.rb
-- spec/reek/utility_function_spec.rb
+- spec/reek/smells/control_couple_spec.rb
+- spec/reek/smells/duplication_spec.rb
+- spec/reek/smells/feature_envy_spec.rb
+- spec/reek/smells/large_class_spec.rb
+- spec/reek/smells/long_method_spec.rb
+- spec/reek/smells/long_parameter_list_spec.rb
+- spec/reek/smells/nested_iterators_spec.rb
+- spec/reek/smells/smell_spec.rb
+- spec/reek/smells/uncommunicative_name_spec.rb
+- spec/reek/smells/utility_function_spec.rb
 - spec/reek_source_spec.rb
 - spec/samples/inline.rb
 - spec/samples/inline.reek

data/lib/reek/smells.rb

@@ -1,192 +0,0 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'reek/printer'
-require 'reek/options'
-
-module Reek
-
-  class Smell
-    include Comparable
-  
-    def self.convert_camel_case(class_name)
-      class_name.gsub(/([a-z])([A-Z])/) { |s| "#{$1} #{$2}"}
-    end
-
-    def initialize(context, arg=nil)
-      @context = context
-    end
-
-    def self.check(exp, context, arg=nil)
-      smell = new(context, arg)
-      return false unless smell.recognise?(exp)
-      context.report(smell)
-      true
-    end
-    
-    def recognise?(stuff)
-      @context != nil
-    end
-
-    def hash  # :nodoc:
-      report.hash
-    end
-
-    def <=>(other)  # :nodoc:
-      Options[:sort_order].compare(self, other)
-    end
-
-    alias eql? <=>
-    
-    def name
-      self.class.convert_camel_case(self.class.name.split(/::/)[1])
-    end
-
-    def report
-      "[#{name}] #{detailed_report}"
-    end
-
-    alias inspect report
-
-    def to_s
-      report
-    end
-  end
-
-  class LongParameterList < Smell
-    MAX_ALLOWED = 3
-
-    def self.count_parameters(exp)
-      result = exp.length - 1
-      result -= 1 if Array === exp[-1] and exp[-1][0] == :block
-      result
-    end
-
-    def recognise?(args)
-      @num_params = LongParameterList.count_parameters(args)
-      @num_params > MAX_ALLOWED
-    end
-
-    def detailed_report
-      "#{@context.to_s} has #{@num_params} parameters"
-    end
-  end
-
-  class LongYieldList < LongParameterList
-    def recognise?(args)
-      @num_params = args.length
-      Array === args and @num_params > MAX_ALLOWED
-    end
-
-    def detailed_report
-      "#{@context} yields #{@num_params} parameters"
-    end
-  end
-
-  class LongMethod < Smell
-    MAX_ALLOWED = 5
-
-    def recognise?(num_stmts)
-      @num_stmts = num_stmts
-      num_stmts > MAX_ALLOWED
-    end
-
-    def detailed_report
-      "#{@context} has approx #{@num_stmts} statements"
-    end
-  end
-
-  class FeatureEnvy < Smell
-
-    def recognise?(refs)
-      @refs = refs
-      !refs.self_is_max?
-    end
-
-    def detailed_report
-      receiver = @refs.max_keys.map {|r| Printer.print(r)}.sort.join(' and ')
-      "#{@context} uses #{receiver} more than self"
-    end
-  end
-
-  class UtilityFunction < Smell
-    def initialize(context, num_stmts)
-      super
-      @num_stmts = num_stmts
-    end
-
-    def recognise?(depends_on_self)
-      @num_stmts > 0 and !depends_on_self
-    end
-
-    def detailed_report
-      "#{@context} doesn't depend on instance state"
-    end
-  end
-
-  class LargeClass < Smell
-    MAX_ALLOWED = 25
-
-    def self.non_inherited_methods(klass)
-      return klass.instance_methods if klass.superclass.nil?
-      klass.instance_methods - klass.superclass.instance_methods
-    end
-
-    def recognise?(name)
-      klass = Object.const_get(name) rescue return
-      @num_methods = LargeClass.non_inherited_methods(klass).length
-      @num_methods > MAX_ALLOWED
-    end
-
-    def detailed_report
-      "#{@context} has #{@num_methods} methods"
-    end
-  end
-
-  class UncommunicativeName < Smell
-    def initialize(context, symbol_type)
-      super
-      @symbol_type = symbol_type
-    end
-
-    def self.effective_length(name)
-      return 500 if name == '*'
-      name = name[1..-1] while /^@/ === name
-      name.length
-    end
-
-    def recognise?(symbol)
-      @symbol = symbol.to_s
-      UncommunicativeName.effective_length(@symbol) < 2
-    end
-
-    def detailed_report
-      "#{@context} uses the #{@symbol_type} name '#{@symbol}'"
-    end
-  end
-
-  class NestedIterators < Smell
-    def recognise?(already_in_iter)
-      already_in_iter
-    end
-
-    def detailed_report
-      "#{@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