kevinrutherford-reek 1.1.3.4 → 1.1.3.5

data/History.txt

@@ -1,11 +1,20 @@
-== 1.1.4 (in git)
+== 1.2 (in git)
+
+=== Major Changes
+* Reek's output reports are now formatted differently:
+** Reek is no longer silent about smell-free source code
+** Output now reports on all files examined, even if they have no smells
+** Smell warnings are indented in the report; file summary headers are not
+** Reports for multiple sources are run together; no more blank lines
 
 === Minor Changes
-* LongMethod now counts statements deeper into each method (fixed #25)
-* LongMethod no longer counts control structures, only their contained stmts
+* Several changes to the LongMethod counting algorithm:
+** LongMethod now counts statements deeper into each method (fixed #25)
+** LongMethod no longer counts control structures, only their contained stmts
+** See http://wiki.github.com/kevinrutherford/reek/long-method for details
 * LargeClass is disabled when checking in-memory classes (fixed #28)
-* Output now reports on all files examined, even if they have no smells
-* Smell warnings are indented in the report to distinguish them from file headers
+* Now reports an error for corrupt config files
+* Empty config files are ignored
 
 == 1.1.3 2009-05-19
 

data/bin/reek

@@ -10,10 +10,17 @@ require 'reek'
 require 'reek/source'
 require 'reek/options'
 
-exitstatus = 0
-source = Reek::Options.parse(ARGV)
-if source.smelly?
-  puts source.report
-  exitstatus = 2
+def reek(args)
+  begin
+    source = Reek::Options.parse(args)
+    puts source.full_report
+    return source.smelly? ? 2 : 0
+  rescue SystemExit => ex
+    return ex.status
+  rescue Exception => error
+    $stderr.puts "Error: #{error}"
+    return 1
+  end
 end
-exit(exitstatus)
+
+exit reek(ARGV)

data/features/masking_smells.feature

@@ -0,0 +1,42 @@
+@masking
+Feature: Masking smells using config files
+  In order to keep my reports meaningful
+  As a developer
+  I want to mask some smells using config files
+
+  Scenario: empty config file is ignored
+    When I run reek spec/samples/empty_config_file/dirty.rb
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/empty_config_file/dirty.rb -- 6 warnings:
+        Dirty has the variable name '@s' (Uncommunicative Name)
+        Dirty#a calls @s.title multiple times (Duplication)
+        Dirty#a calls puts(@s.title) multiple times (Duplication)
+        Dirty#a has the name 'a' (Uncommunicative Name)
+        Dirty#a/block has the variable name 'x' (Uncommunicative Name)
+        Dirty#a/block/block is nested (Nested Iterators)
+
+      """
+
+  Scenario: corrupt config file prevents normal output
+    When I run reek spec/samples/corrupt_config_file/dirty.rb
+    Then it fails with exit status 1
+    And it reports the error 'Error: invalid configuration file "corrupt.reek"'
+
+  Scenario: missing source file is an error
+    When I run reek no_such_file.rb
+    Then it fails with exit status 1
+    And it reports the error "Error: No such file or directory - no_such_file.rb"
+
+  Scenario: switch off one smell
+    When I run reek spec/samples/masked/dirty.rb
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/masked/dirty.rb -- 3 warnings:
+        Dirty#a calls @s.title multiple times (Duplication)
+        Dirty#a calls puts(@s.title) multiple times (Duplication)
+        Dirty#a/block/block is nested (Nested Iterators)
+
+      """

data/features/options.feature

@@ -0,0 +1,20 @@
+@options
+Feature: Reek can be controlled using command-line options
+  In order to change reek's default behaviour
+  As a developer
+  I want to supply options on the command line
+
+  Scenario: return non-zero status on bad option
+    When I run reek --no-such-option
+    Then it fails with exit status 1
+    And it reports the error "Error: invalid option: --no-such-option"
+
+  Scenario: return non-zero status on missing argument
+    When I run reek -f
+    Then it fails with exit status 1
+    And it reports the error "Error: missing argument: -f"
+
+  Scenario: display the current version number
+    When I run reek --version
+    Then it succeeds
+    And it reports the current version

data/features/rake_task.feature

@@ -0,0 +1,9 @@
+@rake
+Feature: RakeTask
+  In order to run reek as part of my CI process
+  As a developer
+  I want to create rake tasks to run reek
+
+  Scenario: reports no smells in reek's own source code
+    When I run rake reek
+    Then it succeeds

data/features/reports.feature

@@ -0,0 +1,28 @@
+@reports
+Feature: Correclty formatted reports
+  In order to get the most out of reek
+  As a developer
+  I want to be able to parse reek's output simply and consistently
+
+  Scenario: two reports run together with indented smells
+    When I run reek spec/samples/two_smelly_files/*.rb
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/two_smelly_files/dirty_one.rb -- 6 warnings:
+        Dirty has the variable name '@s' (Uncommunicative Name)
+        Dirty#a calls @s.title multiple times (Duplication)
+        Dirty#a calls puts(@s.title) multiple times (Duplication)
+        Dirty#a has the name 'a' (Uncommunicative Name)
+        Dirty#a/block has the variable name 'x' (Uncommunicative Name)
+        Dirty#a/block/block is nested (Nested Iterators)
+      spec/samples/two_smelly_files/dirty_two.rb -- 6 warnings:
+        Dirty has the variable name '@s' (Uncommunicative Name)
+        Dirty#a calls @s.title multiple times (Duplication)
+        Dirty#a calls puts(@s.title) multiple times (Duplication)
+        Dirty#a has the name 'a' (Uncommunicative Name)
+        Dirty#a/block has the variable name 'x' (Uncommunicative Name)
+        Dirty#a/block/block is nested (Nested Iterators)
+
+      """
+

data/features/samples.feature

@@ -0,0 +1,274 @@
+@samples
+Feature: Basic smell detection
+  In order to write better software
+  As a developer
+  I want to detect the smels in my Ruby code
+
+  Scenario: Correct smells from inline.rb
+    When I run reek spec/samples/inline.rb
+    Then it fails with exit status 2
+    And it reports:
+    """
+    spec/samples/inline.rb -- 32 warnings:
+      Inline::C has at least 13 instance variables (Large Class)
+      Inline::C#build calls ($? == 0) multiple times (Duplication)
+      Inline::C#build calls Inline.directory multiple times (Duplication)
+      Inline::C#build calls io.puts multiple times (Duplication)
+      Inline::C#build calls io.puts("#endif") multiple times (Duplication)
+      Inline::C#build calls io.puts("#ifdef __cplusplus") multiple times (Duplication)
+      Inline::C#build calls module_name multiple times (Duplication)
+      Inline::C#build calls warn("Output:\n#{result}") multiple times (Duplication)
+      Inline::C#build has approx 60 statements (Long Method)
+      Inline::C#build has the variable name 't' (Uncommunicative Name)
+      Inline::C#build/block/block has the variable name 'n' (Uncommunicative Name)
+      Inline::C#build/block/block is nested (Nested Iterators)
+      Inline::C#c has the name 'c' (Uncommunicative Name)
+      Inline::C#crap_for_windoze calls Config::CONFIG["libdir"] multiple times (Duplication)
+      Inline::C#generate calls result.sub!(/\A\n/, "") multiple times (Duplication)
+      Inline::C#generate calls signature["args"] multiple times (Duplication)
+      Inline::C#generate calls signature["args"].map multiple times (Duplication)
+      Inline::C#generate has approx 32 statements (Long Method)
+      Inline::C#initialize calls stack.empty? multiple times (Duplication)
+      Inline::C#load calls so_name multiple times (Duplication)
+      Inline::C#module_name/block has the variable name 'm' (Uncommunicative Name)
+      Inline::C#module_name/block has the variable name 'x' (Uncommunicative Name)
+      Inline::C#parse_signature has approx 15 statements (Long Method)
+      Inline::C#parse_signature is controlled by argument raw (Control Couple)
+      Inline::C#parse_signature/block has the variable name 'x' (Uncommunicative Name)
+      Inline::C#strip_comments doesn't depend on instance state (Utility Function)
+      Inline::C#strip_comments refers to src more than self (Feature Envy)
+      Inline::self.rootdir calls env.nil? multiple times (Duplication)
+      Inline::self.rootdir has approx 8 statements (Long Method)
+      Module#inline calls Inline.const_get(lang) multiple times (Duplication)
+      Module#inline has approx 11 statements (Long Method)
+      Module#inline is controlled by argument options (Control Couple)
+
+    """
+
+  Scenario: Correct smells from optparse.rb
+    When I run reek spec/samples/optparse.rb
+    Then it fails with exit status 2
+    And it reports:
+    """
+    spec/samples/optparse.rb -- 117 warnings:
+      OptionParser has at least 59 methods (Large Class)
+      OptionParser#CompletingHash#match/block/block is nested (Nested Iterators)
+      OptionParser#Completion::complete calls candidates.size multiple times (Duplication)
+      OptionParser#Completion::complete calls k.id2name multiple times (Duplication)
+      OptionParser#Completion::complete has approx 22 statements (Long Method)
+      OptionParser#Completion::complete has the variable name 'k' (Uncommunicative Name)
+      OptionParser#Completion::complete has the variable name 'v' (Uncommunicative Name)
+      OptionParser#Completion::complete refers to candidates more than self (Feature Envy)
+      OptionParser#Completion::complete/block has the variable name 'k' (Uncommunicative Name)
+      OptionParser#Completion::complete/block has the variable name 'v' (Uncommunicative Name)
+      OptionParser#List#accept has the variable name 't' (Uncommunicative Name)
+      OptionParser#List#accept is controlled by argument pat (Control Couple)
+      OptionParser#List#accept refers to pat more than self (Feature Envy)
+      OptionParser#List#add_banner refers to opt more than self (Feature Envy)
+      OptionParser#List#complete has 4 parameters (Long Parameter List)
+      OptionParser#List#reject has the variable name 't' (Uncommunicative Name)
+      OptionParser#List#summarize refers to opt more than self (Feature Envy)
+      OptionParser#List#update has 5 parameters (Long Parameter List)
+      OptionParser#List#update has approx 6 statements (Long Method)
+      OptionParser#List#update has the variable name 'o' (Uncommunicative Name)
+      OptionParser#List#update is controlled by argument lopts (Control Couple)
+      OptionParser#List#update is controlled by argument sopts (Control Couple)
+      OptionParser#List#update/block has the variable name 'o' (Uncommunicative Name)
+      OptionParser#ParseError#set_option is controlled by argument eq (Control Couple)
+      OptionParser#Switch#NoArgument#parse is controlled by argument arg (Control Couple)
+      OptionParser#Switch#OptionalArgument#parse is controlled by argument arg (Control Couple)
+      OptionParser#Switch#PlacedArgument#parse has approx 6 statements (Long Method)
+      OptionParser#Switch#RequiredArgument#parse is controlled by argument arg (Control Couple)
+      OptionParser#Switch#add_banner has the variable name 's' (Uncommunicative Name)
+      OptionParser#Switch#conv_arg calls conv multiple times (Duplication)
+      OptionParser#Switch#initialize has 7 parameters (Long Parameter List)
+      OptionParser#Switch#parse_arg calls pattern multiple times (Duplication)
+      OptionParser#Switch#parse_arg calls s.length multiple times (Duplication)
+      OptionParser#Switch#parse_arg has approx 11 statements (Long Method)
+      OptionParser#Switch#parse_arg has the variable name 'm' (Uncommunicative Name)
+      OptionParser#Switch#parse_arg has the variable name 's' (Uncommunicative Name)
+      OptionParser#Switch#self.guess has the variable name 't' (Uncommunicative Name)
+      OptionParser#Switch#self.incompatible_argument_styles has the variable name 't' (Uncommunicative Name)
+      OptionParser#Switch#summarize calls (indent + l) multiple times (Duplication)
+      OptionParser#Switch#summarize calls arg multiple times (Duplication)
+      OptionParser#Switch#summarize calls left.collect multiple times (Duplication)
+      OptionParser#Switch#summarize calls left.collect { |s| s.length }.max multiple times (Duplication)
+      OptionParser#Switch#summarize calls left.collect { |s| s.length }.max.to_i multiple times (Duplication)
+      OptionParser#Switch#summarize calls left.shift multiple times (Duplication)
+      OptionParser#Switch#summarize calls left[-1] multiple times (Duplication)
+      OptionParser#Switch#summarize calls s.length multiple times (Duplication)
+      OptionParser#Switch#summarize has 5 parameters (Long Parameter List)
+      OptionParser#Switch#summarize has approx 25 statements (Long Method)
+      OptionParser#Switch#summarize has the variable name 'l' (Uncommunicative Name)
+      OptionParser#Switch#summarize has the variable name 'r' (Uncommunicative Name)
+      OptionParser#Switch#summarize has the variable name 's' (Uncommunicative Name)
+      OptionParser#Switch#summarize refers to left more than self (Feature Envy)
+      OptionParser#Switch#summarize/block has the variable name 's' (Uncommunicative Name)
+      OptionParser#Switch#summarize/block/block is nested (Nested Iterators)
+      OptionParser#block has the variable name 'f' (Uncommunicative Name)
+      OptionParser#block has the variable name 'k' (Uncommunicative Name)
+      OptionParser#block has the variable name 'o' (Uncommunicative Name)
+      OptionParser#block has the variable name 's' (Uncommunicative Name)
+      OptionParser#block is controlled by argument o (Control Couple)
+      OptionParser#block is controlled by argument s (Control Couple)
+      OptionParser#block/block has the variable name 's' (Uncommunicative Name)
+      OptionParser#block/block has the variable name 'v' (Uncommunicative Name)
+      OptionParser#block/block is controlled by argument pkg (Control Couple)
+      OptionParser#block/block is nested (Nested Iterators)
+      OptionParser#complete has 4 parameters (Long Parameter List)
+      OptionParser#complete/block/block is nested (Nested Iterators)
+      OptionParser#getopts calls result[opt] = false multiple times (Duplication)
+      OptionParser#getopts has approx 17 statements (Long Method)
+      OptionParser#getopts/block is controlled by argument val (Control Couple)
+      OptionParser#load/block has the variable name 's' (Uncommunicative Name)
+      OptionParser#make_switch calls (long << o = q.downcase) multiple times (Duplication)
+      OptionParser#make_switch calls (sdesc << "-#{q}") multiple times (Duplication)
+      OptionParser#make_switch calls default_style.guess(arg = a) multiple times (Duplication)
+      OptionParser#make_switch calls notwice(NilClass, klass, "type") multiple times (Duplication)
+      OptionParser#make_switch calls notwice(a ? (Object) : (TrueClass), klass, "type") multiple times (Duplication)
+      OptionParser#make_switch calls pattern.method(:convert) multiple times (Duplication)
+      OptionParser#make_switch calls pattern.method(:convert).to_proc multiple times (Duplication)
+      OptionParser#make_switch calls pattern.respond_to?(:convert) multiple times (Duplication)
+      OptionParser#make_switch calls q.downcase multiple times (Duplication)
+      OptionParser#make_switch calls search(:atype, FalseClass) multiple times (Duplication)
+      OptionParser#make_switch calls search(:atype, o) multiple times (Duplication)
+      OptionParser#make_switch has approx 68 statements (Long Method)
+      OptionParser#make_switch has the variable name 'a' (Uncommunicative Name)
+      OptionParser#make_switch has the variable name 'n' (Uncommunicative Name)
+      OptionParser#make_switch has the variable name 'o' (Uncommunicative Name)
+      OptionParser#make_switch has the variable name 'q' (Uncommunicative Name)
+      OptionParser#make_switch has the variable name 's' (Uncommunicative Name)
+      OptionParser#make_switch/block has the variable name 'a' (Uncommunicative Name)
+      OptionParser#make_switch/block has the variable name 'o' (Uncommunicative Name)
+      OptionParser#make_switch/block has the variable name 'q' (Uncommunicative Name)
+      OptionParser#make_switch/block/block has the variable name 'c' (Uncommunicative Name)
+      OptionParser#make_switch/block/block has the variable name 'o' (Uncommunicative Name)
+      OptionParser#make_switch/block/block has the variable name 'v' (Uncommunicative Name)
+      OptionParser#make_switch/block/block is nested (Nested Iterators)
+      OptionParser#make_switch/block/block/block is nested (Nested Iterators)
+      OptionParser#order calls argv[0] multiple times (Duplication)
+      OptionParser#order refers to argv more than self (Feature Envy)
+      OptionParser#parse calls argv[0] multiple times (Duplication)
+      OptionParser#parse refers to argv more than self (Feature Envy)
+      OptionParser#parse_in_order calls $!.set_option(arg, true) multiple times (Duplication)
+      OptionParser#parse_in_order calls cb.call(val) multiple times (Duplication)
+      OptionParser#parse_in_order calls raise($!.set_option(arg, true)) multiple times (Duplication)
+      OptionParser#parse_in_order calls raise(*exc) multiple times (Duplication)
+      OptionParser#parse_in_order calls setter.call(sw.switch_name, val) multiple times (Duplication)
+      OptionParser#parse_in_order calls sw.block multiple times (Duplication)
+      OptionParser#parse_in_order calls sw.switch_name multiple times (Duplication)
+      OptionParser#parse_in_order has approx 28 statements (Long Method)
+      OptionParser#parse_in_order/block is controlled by argument setter (Control Couple)
+      OptionParser#parse_in_order/block/block is nested (Nested Iterators)
+      OptionParser#parse_in_order/block/block/block is nested (Nested Iterators)
+      OptionParser#permute calls argv[0] multiple times (Duplication)
+      OptionParser#permute refers to argv more than self (Feature Envy)
+      OptionParser#search/block has the variable name 'k' (Uncommunicative Name)
+      OptionParser#summarize has 4 parameters (Long Parameter List)
+      OptionParser#summarize/block has the variable name 'l' (Uncommunicative Name)
+      OptionParser#ver has the variable name 'v' (Uncommunicative Name)
+      block has the variable name 'q' (Uncommunicative Name)
+
+    """
+
+  Scenario: Correct smells from redcloth.rb
+    When I run reek spec/samples/redcloth.rb
+    Then it fails with exit status 2
+    And it reports:
+    """
+    spec/samples/redcloth.rb -- 93 warnings:
+      RedCloth has at least 44 methods (Large Class)
+      RedCloth#block has the variable name 'a' (Uncommunicative Name)
+      RedCloth#block has the variable name 'b' (Uncommunicative Name)
+      RedCloth#block_markdown_atx refers to text more than self (Feature Envy)
+      RedCloth#block_markdown_bq has approx 6 statements (Long Method)
+      RedCloth#block_markdown_rule doesn't depend on instance state (Utility Function)
+      RedCloth#block_markdown_rule refers to text more than self (Feature Envy)
+      RedCloth#block_markdown_setext refers to text more than self (Feature Envy)
+      RedCloth#block_textile_lists calls (line_id - 1) multiple times (Duplication)
+      RedCloth#block_textile_lists calls depth.last multiple times (Duplication)
+      RedCloth#block_textile_lists calls depth.last.length multiple times (Duplication)
+      RedCloth#block_textile_lists calls depth[i] multiple times (Duplication)
+      RedCloth#block_textile_lists calls lines[(line_id - 1)] multiple times (Duplication)
+      RedCloth#block_textile_lists calls tl.length multiple times (Duplication)
+      RedCloth#block_textile_lists has approx 20 statements (Long Method)
+      RedCloth#block_textile_lists refers to depth more than self (Feature Envy)
+      RedCloth#block_textile_lists/block/block is nested (Nested Iterators)
+      RedCloth#block_textile_lists/block/block/block has the variable name 'i' (Uncommunicative Name)
+      RedCloth#block_textile_lists/block/block/block has the variable name 'v' (Uncommunicative Name)
+      RedCloth#block_textile_lists/block/block/block is nested (Nested Iterators)
+      RedCloth#block_textile_table has approx 18 statements (Long Method)
+      RedCloth#block_textile_table/block/block has the variable name 'x' (Uncommunicative Name)
+      RedCloth#block_textile_table/block/block is nested (Nested Iterators)
+      RedCloth#block_textile_table/block/block/block is nested (Nested Iterators)
+      RedCloth#blocks has approx 18 statements (Long Method)
+      RedCloth#blocks/block is controlled by argument deep_code (Control Couple)
+      RedCloth#blocks/block/block is nested (Nested Iterators)
+      RedCloth#check_refs is controlled by argument text (Control Couple)
+      RedCloth#clean_html calls tags[tag] multiple times (Duplication)
+      RedCloth#clean_html doesn't depend on instance state (Utility Function)
+      RedCloth#clean_html has approx 14 statements (Long Method)
+      RedCloth#clean_html refers to raw more than self (Feature Envy)
+      RedCloth#clean_html refers to tags more than self (Feature Envy)
+      RedCloth#clean_html/block/block is nested (Nested Iterators)
+      RedCloth#clean_html/block/block/block has the variable name 'q' (Uncommunicative Name)
+      RedCloth#clean_html/block/block/block has the variable name 'q2' (Uncommunicative Name)
+      RedCloth#clean_html/block/block/block is nested (Nested Iterators)
+      RedCloth#clean_white_space has approx 7 statements (Long Method)
+      RedCloth#clean_white_space refers to text more than self (Feature Envy)
+      RedCloth#flush_left doesn't depend on instance state (Utility Function)
+      RedCloth#flush_left refers to indt more than self (Feature Envy)
+      RedCloth#flush_left refers to text more than self (Feature Envy)
+      RedCloth#footnote_ref doesn't depend on instance state (Utility Function)
+      RedCloth#footnote_ref refers to text more than self (Feature Envy)
+      RedCloth#glyphs_textile has approx 10 statements (Long Method)
+      RedCloth#h_align doesn't depend on instance state (Utility Function)
+      RedCloth#htmlesc doesn't depend on instance state (Utility Function)
+      RedCloth#htmlesc refers to str more than self (Feature Envy)
+      RedCloth#incoming_entities doesn't depend on instance state (Utility Function)
+      RedCloth#incoming_entities refers to text more than self (Feature Envy)
+      RedCloth#initialize/block has the variable name 'r' (Uncommunicative Name)
+      RedCloth#inline/block/block is nested (Nested Iterators)
+      RedCloth#inline_markdown_link has approx 6 statements (Long Method)
+      RedCloth#inline_markdown_link/block has the variable name 'm' (Uncommunicative Name)
+      RedCloth#inline_markdown_reflink has approx 8 statements (Long Method)
+      RedCloth#inline_markdown_reflink/block has the variable name 'm' (Uncommunicative Name)
+      RedCloth#inline_textile_code/block has the variable name 'm' (Uncommunicative Name)
+      RedCloth#inline_textile_image has approx 17 statements (Long Method)
+      RedCloth#inline_textile_image/block has the variable name 'm' (Uncommunicative Name)
+      RedCloth#inline_textile_link has approx 9 statements (Long Method)
+      RedCloth#inline_textile_link/block has the variable name 'm' (Uncommunicative Name)
+      RedCloth#inline_textile_span has approx 8 statements (Long Method)
+      RedCloth#inline_textile_span/block/block has the variable name 'm' (Uncommunicative Name)
+      RedCloth#inline_textile_span/block/block is nested (Nested Iterators)
+      RedCloth#no_textile doesn't depend on instance state (Utility Function)
+      RedCloth#no_textile refers to text more than self (Feature Envy)
+      RedCloth#pba calls $1.length multiple times (Duplication)
+      RedCloth#pba has approx 21 statements (Long Method)
+      RedCloth#pba is controlled by argument text_in (Control Couple)
+      RedCloth#pba refers to style more than self (Feature Envy)
+      RedCloth#pba refers to text more than self (Feature Envy)
+      RedCloth#refs_markdown/block has the variable name 'm' (Uncommunicative Name)
+      RedCloth#refs_textile/block has the variable name 'm' (Uncommunicative Name)
+      RedCloth#retrieve/block has the variable name 'i' (Uncommunicative Name)
+      RedCloth#retrieve/block has the variable name 'r' (Uncommunicative Name)
+      RedCloth#rip_offtags calls ((codepre - used_offtags.length) > 0) multiple times (Duplication)
+      RedCloth#rip_offtags calls (@pre_list.last << line) multiple times (Duplication)
+      RedCloth#rip_offtags calls (codepre - used_offtags.length) multiple times (Duplication)
+      RedCloth#rip_offtags calls @pre_list.last multiple times (Duplication)
+      RedCloth#rip_offtags calls codepre.zero? multiple times (Duplication)
+      RedCloth#rip_offtags calls htmlesc(line, :NoQuotes) multiple times (Duplication)
+      RedCloth#rip_offtags calls used_offtags.length multiple times (Duplication)
+      RedCloth#rip_offtags calls used_offtags["notextile"] multiple times (Duplication)
+      RedCloth#rip_offtags has approx 18 statements (Long Method)
+      RedCloth#textile_bq has 4 parameters (Long Parameter List)
+      RedCloth#textile_bq is controlled by argument atts (Control Couple)
+      RedCloth#textile_bq is controlled by argument cite (Control Couple)
+      RedCloth#textile_fn_ has 5 parameters (Long Parameter List)
+      RedCloth#textile_fn_ is controlled by argument atts (Control Couple)
+      RedCloth#textile_p has 4 parameters (Long Parameter List)
+      RedCloth#textile_p is controlled by argument atts (Control Couple)
+      RedCloth#to_html has approx 24 statements (Long Method)
+      RedCloth#v_align doesn't depend on instance state (Utility Function)
+
+    """

data/features/stdin.feature

@@ -0,0 +1,34 @@
+@stdin
+Feature: Reek reads from $stdin when no files are given
+  In order to use reek with pipelines
+  As a developer
+  I want to pipe source code on stdin
+
+  Scenario: return zero status with no smells
+    When I pass "def simple() @fred = 3 end" to reek
+    Then it succeeds
+    And it reports:
+      """
+      $stdin -- 0 warnings
+
+      """
+
+  Scenario: outputs nothing on empty stdin
+    When I pass "" to reek
+    Then it succeeds
+    And it reports:
+      """
+      $stdin -- 0 warnings
+
+      """
+
+  Scenario: return non-zero status when there are smells
+    When I pass "class Turn; def y() @x = 3; end end" to reek
+    Then it fails with exit status 2
+    And it reports:
+      """
+      $stdin -- 2 warnings:
+        Turn has the variable name '@x' (Uncommunicative Name)
+        Turn#y has the name 'y' (Uncommunicative Name)
+
+      """

data/features/step_definitions/reek_steps.rb

@@ -0,0 +1,35 @@
+When /^I run reek (.*)$/ do |args|
+  run args
+end
+
+When /^I pass "([^\"]*)" to reek$/ do |stdin|
+  run_with_pipe stdin
+end
+
+When /^I run rake reek$/ do
+  rake
+end
+
+Then /^stdout equals "([^\"]*)"$/ do |report|
+  @last_stdout.should == report
+end
+
+Then /^it succeeds$/ do
+  @last_exit_status.should == 0
+end
+
+Then /^it fails with exit status (\d+)$/ do |status|
+  @last_exit_status.should == status.to_i
+end
+
+Then /^it reports:$/ do |report|
+  @last_stdout.should == report
+end
+
+Then /^it reports the error ['"](.*)['"]$/ do |string|
+  @last_stderr.chomp.should == string
+end
+
+Then /^it reports the current version$/ do
+  @last_stdout.chomp.should == "reek #{Reek::VERSION}"
+end

data/features/support/env.rb

@@ -0,0 +1,38 @@
+$:.unshift 'lib'
+
+require 'rubygems'
+require 'tempfile'
+require 'spec/expectations'
+require 'fileutils'
+require 'reek'
+
+class CucumberWorld
+
+  def run(args)
+    stderr_file = Tempfile.new('cucumber')
+    stderr_file.close
+    @last_stdout = `ruby -Ilib bin/reek #{args} 2> #{stderr_file.path}`
+    @last_exit_status = $?.exitstatus
+    @last_stderr = IO.read(stderr_file.path)
+  end
+
+  def run_with_pipe(stdin)
+    stderr_file = Tempfile.new('cucumber')
+    stderr_file.close
+    @last_stdout = `echo \"#{stdin}\" | ruby -Ilib bin/reek 2> #{stderr_file.path}`
+    @last_exit_status = $?.exitstatus
+    @last_stderr = IO.read(stderr_file.path)
+  end
+
+  def rake
+    stderr_file = Tempfile.new('cucumber')
+    stderr_file.close
+    @last_stdout = `rake reek 2> #{stderr_file.path}`
+    @last_exit_status = $?.exitstatus
+    @last_stderr = IO.read(stderr_file.path)
+  end
+end
+
+World do
+  CucumberWorld.new
+end

data/lib/reek/options.rb

@@ -42,15 +42,11 @@ EOB
     end
 
     def self.parse(args)
-      begin
-        @@opts = parse_args(args)
-        if args.length > 0
-          return Source.from_pathlist(args)
-        else
-          return Source.from_io($stdin, 'stdin')
-        end
-      rescue OptionParser::ParseError, SystemCallError => err
-        fatal_error(err)
+      @@opts = parse_args(args)
+      if args.length > 0
+        return Source.from_pathlist(args)
+      else
+        return Source.from_io($stdin, '$stdin')
       end
     end
 
@@ -81,12 +77,5 @@ EOB
         config[:format] = SMELL_SORT
       end
     end
-    
-    def self.fatal_error(err) # :nodoc:
-      puts "Error: #{err}"
-      puts "Use '-h' for help."
-      exit(1)
-    end
-    
   end
 end

data/lib/reek/report.rb

@@ -55,7 +55,7 @@ module Reek
     end
 
     def header(desc, num_smells)
-      result = "\"#{desc}\" -- #{num_smells} warning"
+      result = "#{desc} -- #{num_smells} warning"
       result += 's' unless num_smells == 1
       result += " (+#{@masked_smells.length} masked)" unless @masked_smells.empty?
       result
@@ -94,8 +94,8 @@ module Reek
       @sources.select {|src| src.smelly? }
     end
 
-    def to_s
-      @sources.map { |src| src.full_report }.join("\n")
+    def full_report
+      @sources.map { |src| src.full_report }.join
     end
   end
 end

data/lib/reek/sniffer.rb

@@ -76,7 +76,10 @@ module Reek
     # +config_file+.
     #
     def configure_with(config_file)
-      YAML.load_file(config_file).push_keys(@config)
+      hash = YAML.load_file(config_file)
+      return unless hash
+      raise "invalid configuration file \"#{File.basename(config_file)}\"" unless Hash === hash
+      hash.push_keys(@config)
     end
 
     def disable(smell)

data/lib/reek/source.rb

@@ -118,6 +118,10 @@ module Reek
       @sources.any? {|source| source.smelly? }
     end
 
+    def full_report
+      ReportList.new(@sources).full_report
+    end
+
     def report
       ReportList.new(@sources)
     end

data/lib/reek.rb

@@ -1,5 +1,5 @@
 $:.unshift File.dirname(__FILE__)
 
 module Reek # :doc:
-  VERSION = '1.1.3.4'
+  VERSION = '1.1.3.5'
 end

data/reek.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.1.3.4"
+  s.version = "1.1.3.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-06-19}
+  s.date = %q{2009-06-29}
   s.default_executable = %q{reek}
   s.description = %q{Code smell detector for Ruby}
   s.email = ["kevin@rutherford-software.com"]
   s.executables = ["reek"]
   s.extra_rdoc_files = ["History.txt", "README.txt"]
-  s.files = ["History.txt", "README.txt", "Rakefile", "bin/reek", "config/defaults.reek", "lib/reek.rb", "lib/reek/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/exceptions.reek", "lib/reek/if_context.rb", "lib/reek/method_context.rb", "lib/reek/module_context.rb", "lib/reek/name.rb", "lib/reek/object_refs.rb", "lib/reek/object_source.rb", "lib/reek/options.rb", "lib/reek/rake_task.rb", "lib/reek/report.rb", "lib/reek/sexp_formatter.rb", "lib/reek/singleton_method_context.rb", "lib/reek/smell_warning.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_detector.rb", "lib/reek/smells/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/sniffer.rb", "lib/reek/source.rb", "lib/reek/spec.rb", "lib/reek/stop_context.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "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/if_context_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/options_spec.rb", "spec/reek/report_spec.rb", "spec/reek/singleton_method_context_spec.rb", "spec/reek/smell_warning_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_detector_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/slow/inline_spec.rb", "spec/slow/optparse_spec.rb", "spec/slow/redcloth_spec.rb", "spec/slow/reek_source_spec.rb", "spec/slow/samples/inline.rb", "spec/slow/samples/optparse.rb", "spec/slow/samples/redcloth.rb", "spec/slow/script_spec.rb", "spec/slow/source_list_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/rspec.rake"]
+  s.files = ["History.txt", "README.txt", "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", "lib/reek.rb", "lib/reek/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/exceptions.reek", "lib/reek/if_context.rb", "lib/reek/method_context.rb", "lib/reek/module_context.rb", "lib/reek/name.rb", "lib/reek/object_refs.rb", "lib/reek/object_source.rb", "lib/reek/options.rb", "lib/reek/rake_task.rb", "lib/reek/report.rb", "lib/reek/sexp_formatter.rb", "lib/reek/singleton_method_context.rb", "lib/reek/smell_warning.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_detector.rb", "lib/reek/smells/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/sniffer.rb", "lib/reek/source.rb", "lib/reek/spec.rb", "lib/reek/stop_context.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "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/if_context_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/options_spec.rb", "spec/reek/report_spec.rb", "spec/reek/singleton_method_context_spec.rb", "spec/reek/smell_warning_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_detector_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "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/inline.rb", "spec/samples/masked/dirty.rb", "spec/samples/masked/masked.reek", "spec/samples/optparse.rb", "spec/samples/redcloth.rb", "spec/samples/two_smelly_files/dirty_one.rb", "spec/samples/two_smelly_files/dirty_two.rb", "spec/slow/inline_spec.rb", "spec/slow/optparse_spec.rb", "spec/slow/redcloth_spec.rb", "spec/slow/reek_source_spec.rb", "spec/slow/source_list_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/rspec.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

data/spec/samples/corrupt_config_file/corrupt.reek

@@ -0,0 +1 @@
+This is not a config file

data/spec/samples/corrupt_config_file/dirty.rb

@@ -0,0 +1,7 @@
+class Dirty
+  def a
+    puts @s.title
+    @s.map {|x| x.each {|key| key += 3}}
+    puts @s.title
+  end
+end

data/spec/samples/empty_config_file/dirty.rb

@@ -0,0 +1,7 @@
+class Dirty
+  def a
+    puts @s.title
+    @s.map {|x| x.each {|key| key += 3}}
+    puts @s.title
+  end
+end

data/spec/samples/masked/dirty.rb

@@ -0,0 +1,7 @@
+class Dirty
+  def a
+    puts @s.title
+    @s.map {|x| x.each {|key| key += 3}}
+    puts @s.title
+  end
+end

data/spec/samples/masked/masked.reek

@@ -0,0 +1,3 @@
+---
+UncommunicativeName:
+  enabled: false

data/spec/samples/two_smelly_files/dirty_one.rb

@@ -0,0 +1,7 @@
+class Dirty
+  def a
+    puts @s.title
+    @s.map {|x| x.each {|key| key += 3}}
+    puts @s.title
+  end
+end

data/spec/samples/two_smelly_files/dirty_two.rb

@@ -0,0 +1,7 @@
+class Dirty
+  def a
+    puts @s.title
+    @s.map {|x| x.each {|key| key += 3}}
+    puts @s.title
+  end
+end

data/spec/slow/reek_source_spec.rb

@@ -11,10 +11,3 @@ describe 'Reek source code:' do
     Dir['lib/**/*.rb'].should_not reek
   end
 end
-
-describe 'RakeTask' do
-  it 'should report no duplication' do
-    report = `rake reek`.split("\n")
-    report.length.should == 1
-  end
-end

data/spec/spec_helper.rb

@@ -10,4 +10,4 @@ end
 
 require 'reek/spec'
 
-SAMPLES_DIR = 'spec/slow/samples' unless Object.const_defined?('SAMPLES_DIR')
+SAMPLES_DIR = 'spec/samples' unless Object.const_defined?('SAMPLES_DIR')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevinrutherford-reek
 version: !ruby/object:Gem::Version 
-  version: 1.1.3.4
+  version: 1.1.3.5
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-19 00:00:00 -07:00
+date: 2009-06-29 00:00:00 -07:00
 default_executable: reek
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,6 +58,14 @@ files:
 - 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
 - lib/reek.rb
 - lib/reek/block_context.rb
 - lib/reek/class_context.rb
@@ -117,14 +125,21 @@ files:
 - spec/reek/smells/smell_detector_spec.rb
 - spec/reek/smells/uncommunicative_name_spec.rb
 - spec/reek/smells/utility_function_spec.rb
+- 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/inline.rb
+- spec/samples/masked/dirty.rb
+- spec/samples/masked/masked.reek
+- spec/samples/optparse.rb
+- spec/samples/redcloth.rb
+- spec/samples/two_smelly_files/dirty_one.rb
+- spec/samples/two_smelly_files/dirty_two.rb
 - spec/slow/inline_spec.rb
 - spec/slow/optparse_spec.rb
 - spec/slow/redcloth_spec.rb
 - spec/slow/reek_source_spec.rb
-- spec/slow/samples/inline.rb
-- spec/slow/samples/optparse.rb
-- spec/slow/samples/redcloth.rb
-- spec/slow/script_spec.rb
 - spec/slow/source_list_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb

data/spec/slow/script_spec.rb

@@ -1,55 +0,0 @@
-require 'reek'
-
-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
-  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 complain about missing file' do
-    `ruby -Ilib bin/reek nosuchfile.rb`
-    $?.exitstatus.should == 1
-  end
-
-  it 'should return non-zero status on missing argument' do
-    `ruby -Ilib bin/reek -f 2>/dev/null`
-    $?.exitstatus.should == 1
-  end
-end
-
-describe 'exit status', 'when reek is used correctly' do
-  it 'should return non-zero status when smells are reported' do
-    `echo "def x() 3; end" | ruby -Ilib bin/reek`
-    $?.exitstatus.should == 2
-  end
-
-  it 'should return zero status with no smells' do
-    `echo "def simple() @fred = 3 end" | ruby -Ilib bin/reek`
-    $?.exitstatus.should == 0
-  end
-end
-
-describe 'report format', 'with one source' do
-  it 'should output nothing with empty source' do
-    `echo "" | ruby -Ilib bin/reek`.should be_empty
-  end
-
-  it 'should output nothing when no smells' do
-    `echo "def simple() @fred = 3; end" | ruby -Ilib bin/reek`.should be_empty
-  end
-
-  it 'should not adorn the list of warnings' do
-    report = `echo  "class Turn; def y() @x = 3; end end" | ruby -Ilib bin/reek`
-    report.split(/\n/).length.should == 2
-    report.should_not match(/\n\n/)
-  end
-end