reek 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6002373fce680e5b27b465fef2e8809c9cc0301a
-  data.tar.gz: abf6a5e6e1ab36e4d940bcea6f83893df1c230a5
+  metadata.gz: 2bd3b362caed94f8eec563376a0542677d215b9c
+  data.tar.gz: 85af0be0c7132c4718b145b114d2013a836a8880
 SHA512:
-  metadata.gz: 3b6d532b9a3e596ce386b1edd8e389dffb31a4b9276cbc584d3c216d9a21d67b5cf84dc69f9cf99ec7f27abc4ea0e2fb1fd63153bd9772ba2d8a47a86e7444d5
-  data.tar.gz: 9db171e0f2a6096d8d5f0093feb9d7a42a119d300d19403e689caaef6444287ca1401a4e0df0338e38caf8b7ddcdd0d72908baeb1446ec499bb15b382ca2fb6a
+  metadata.gz: e933370d907c7d45079a56e513c88363b3b6faeb8244651e6ac4a6f3e08242087e705490c8a5d86eee80fb585f5f74a3af7f5d2d49e42e672081b0e9d861f32c
+  data.tar.gz: c0bcc02e84cd9475db5f2c59c1d74c9fc42e983ff79e373f951092224df4df8784fd00b2ce8d43a306d4ebe42e742dba2507e42893aa88a4798a47dc7874d726

data/CHANGELOG

@@ -1,3 +1,8 @@
+== 1.5.0
+
+* (mvz) Parse with the parse gem
+* (mvz) Add ModuleInitialize smell
+
 == 1.4.0
 
 * (Gilles Leblanc) Corrects UnusedParameter with keyword arguments with splat

data/README.md

@@ -1,7 +1,6 @@
 # Reek -- code smell detection for Ruby
 
-
-### Overview
+## Overview
 
 
 [![Build Status](https://secure.travis-ci.org/troessner/reek.png?branch=master)](http://travis-ci.org/troessner/reek?branch=master)
@@ -9,59 +8,25 @@
 [![Dependency Status](https://gemnasium.com/troessner/reek.png)](https://gemnasium.com/troessner/reek)
 [![Inline docs](http://inch-ci.org/github/troessner/reek.png)](http://inch-ci.org/github/troessner/reek)
 
+## Quickstart
 
-### Synopsis
-
+`reek` is a tool that examines Ruby classes, modules and methods and reports any [Code Smells](https://github.com/troessner/reek/wiki/Code-Smells) it finds. Install it like this:
 
-Reek is a tool that examines Ruby classes, modules and methods and
-reports any code smells it finds. Install it like this:
-
-```bash
-$ gem install reek
+```Bash
+gem install reek
 ```
 
 and run it like this:
 
-```bash
-$ reek [options] [dir_or_source_file]*
+```Bash
+reek [options] [dir_or_source_file]*
 ```
 
-For a full list of command-line options see the
-[Reek wiki](https://github.com/troessner/reek/wiki/command-line-options)
-or run
-
-```bash
-$ reek --help
-```
-
-## Usage
-
-For scanning the current directory you're in do a
-
-```bash
-$ reek .
-```
+## Example
 
-(Mind the "." at the end to indicate the current directory)
+Imagine a source file <tt>demo.rb</tt> containing:
 
-
-Likewise you can scan specific directories like this
-
-```bash
-$ reek lib/your/files
-```
-
-Note that if you just call
-
-```bash
-$ reek
-```
-
-without any arguments reek will wait for input from STDIN.
-
-Given a source file <tt>demo.rb</tt> containing:
-
-```ruby
+```Ruby
 class Dirty
   # This method smells of :reek:NestedIterators but ignores them
   def awful(x, y, offset = 0, log = false)
@@ -74,7 +39,7 @@ end
 
 Reek will report the following code smells in this file:
 
-```bash
+```
 $ reek demo.rb
 spec/samples/demo/demo.rb -- 6 warnings:
   Dirty has no descriptive comment (IrresponsibleModule)
@@ -83,48 +48,55 @@ spec/samples/demo/demo.rb -- 6 warnings:
   Dirty#awful has the parameter name 'x' (UncommunicativeName)
   Dirty#awful has the parameter name 'y' (UncommunicativeName)
   Dirty#awful has the variable name 'w' (UncommunicativeName)
+  Dirty#awful has unused parameter 'log' (UnusedParameters)
+  Dirty#awful has unused parameter 'offset' (UnusedParameters)
+  Dirty#awful has unused parameter 'x' (UnusedParameters)
+  Dirty#awful has unused parameter 'y' (UnusedParameters)
 ```
 
-## Features
+## Code smells
 
-Reek currently includes checks for some aspects of Control Couple,
-Data Clump, Feature Envy, Large Class, Long Method, Long Parameter List,
-Simulated Polymorphism, Uncommunicative Name and more.
-See the [Reek wiki](https://github.com/troessner/reek/wiki/code-smells)
-for up to date details of exactly what Reek will check in your code.
+`reek` currently includes checks for some aspects of [Control Couple](https://github.com/troessner/reek/wiki/Control-Couple), [Data Clump](https://github.com/troessner/reek/wiki/Data-Clump), [Feature Envy](https://github.com/troessner/reek/wiki/Feature-Envy), [Large Class](https://github.com/troessner/reek/wiki/Large-Class), [Long Parameter List](https://github.com/troessner/reek/wiki/Long-Parameter-List), [Simulated Polymorphism](https://github.com/troessner/reek/wiki/Simulated-Polymorphism), [Too Many Statements](https://github.com/troessner/reek/wiki/Too-Many-Statements), [Uncommunicative Name](https://github.com/troessner/reek/wiki/Uncommunicative-Name), [Unused Parameters](https://github.com/troessner/reek/wiki/Unused-Parameters) and more. See the [Code Smells](https://github.com/troessner/reek/wiki/Code-Smells) for up to date details of exactly what `reek` will check in your code.
 
-### Integration
+## Configuration
 
-Basically there are two ways to use reek in your project except for the obvious
-static code analysis:
+For a basic overview, run
 
-1. Use Reek's [Rake Task](https://github.com/troessner/reek/wiki/Rake-Task) to
-  easily add Reek to your Rakefile
+```Ruby
+reek --help
+```
 
-2. Add Reek's custom matcher to your Rspec examples like this:
+For a summary of those CLI options see [Command-Line Options](https://github.com/troessner/reek/wiki/Command-Line-Options).
 
-```Ruby
-require 'rubygems'
-require 'spec'
-require 'reek'
-require 'reek/spec'
+Apart from that, `reek` offers quite a few ways for configuring it:
+
+* The first thing you probably want to check out are the [Basic Smell Options](https://github.com/troessner/reek/wiki/Basic-Smell-Options)
+* `reek` is not the police. In case you need to suppress a smell warning for whatever reasons have a look at [Smell Suppression](https://github.com/troessner/reek/wiki/Smell-Suppression)
+* Lastly there are a couple of ways to configure `reek` via [Configuration Files](https://github.com/troessner/reek/wiki/Configuration-Files)
+
+## Integration
 
-include Reek::Spec
+Besides the obvious
 
-my_precious_code = 'class C; def m; end; end'
-my_precious_code.should_not reek # Well, it does.
+```Bash
+reek [options] [dir_or_source_file]*
 ```
 
-## Contributing
+there are quite a few other ways how to use reek in your projects:
 
-* Fork the repo
-* Create a feature branch
-* Make sure the tests pass (see below)
-* Submit a pull request
+* Use `reek`'s [Rake Task](https://github.com/troessner/reek/wiki/Rake-Task) to automate detecting code smells
+* Add `reek`'s custom matcher to your [RSpec examples](https://github.com/troessner/reek/wiki/RSpec-Integration)
+* Include `reek` using the [Developer API](https://github.com/troessner/reek/wiki/Developer-Api)
 
-### Running the tests
+## Developing reek / Contributing
 
-Either just `bundle exec rake` to run all or, if you want to be specific:
+The first thing you want to do after checking out the source code is to run bundler
+
+```
+bundle install
+```
+
+and then to run the tests:
 
 ```bash
 bundle exec rspec spec/your/file_spec.rb            # Runs all tests in spec/your/file_spec.rb
@@ -133,7 +105,28 @@ bundle exec cucumber features/your_file.feature     # Runs all scenarios in your
 bundle exec cucumber features/your_file.feature:23  # Runs scenario at line 23
 ```
 
-## Miscellaneous
+Or just run the whole test suite by running
+
+```
+bundle exec rake
+```
+
+From then on continue by following the establish [pull request workflow](https://help.github.com/articles/using-pull-requests/).
+
+If you don't feel like getting your hands dirty with code there a still other ways you can help us:
+
+* Work on the [wiki](https://github.com/troessner/reek/wiki)
+* Open up an [issue](https://github.com/troessner/reek/issues) and report bugs or suggest other improvements
+
+## Output formats
+
+`reek` supports 3 output formats:
+
+* plain text (default)
+* html (-H, --html)
+* yaml (-y, --yaml)
+
+## Additional resources
 
 ### Tools
 
@@ -146,22 +139,7 @@ TextMate Bundle for `reek`:
 Colorful output for `reek`: [Preek](https://github.com/joenas/preek) (also with
 [Guard::Preek](https://github.com/joenas/guard-preek))
 
-### Dependencies
-
-Reek makes use of the following other gems:
-
-* ruby_parser
-* sexp_processor
-* ruby2ruby
-* rainbow
-
-### Learn More
-
-Find out more about Reek from any of the following sources:
+### Find out more:
 
-* Browse the Reek documentation at
-  [https://github.com/troessner/reek/wiki](https://github.com/troessner/reek/wiki)
-* Browse the code or install the latest development version from
-  [https://github.com/troessner/reek/tree](https://github.com/troessner/reek/tree)
-* Read the code API at
-  [http://rdoc.info/projects/troessner/reek](http://rdoc.info/projects/troessner/reek)
+* [Stack Overflow](http://stackoverflow.com/questions/tagged/reek)
+* [RDoc](http://rdoc.info/projects/troessner/reek)

data/config/defaults.reek

@@ -38,6 +38,9 @@ LongYieldList:
   enabled: true
   exclude: []
   max_params: 3
+ModuleInitialize:
+  enabled: true
+  exclude: []
 NestedIterators:
   enabled: true
   exclude: []

data/features/samples.feature

@@ -10,7 +10,8 @@ Feature: Basic smell detection
     Then the exit status indicates smells
     And it reports:
     """
-    spec/samples/inline.rb -- 41 warnings:
+    spec/samples/inline.rb -- 43 warnings:
+      CompilationError has no descriptive comment (IrresponsibleModule)
       File has no descriptive comment (IrresponsibleModule)
       File#self.write_with_backup has approx 6 statements (TooManyStatements)
       Inline declares the class variable @@directory (ClassVariable)
@@ -24,7 +25,7 @@ Feature: Basic smell detection
       Inline::C tests $DEBUG at least 7 times (RepeatedConditional)
       Inline::C tests $TESTING at least 4 times (RepeatedConditional)
       Inline::C tests @@type_map.has_key?(type) at least 3 times (RepeatedConditional)
-      Inline::C#build calls ($? != 0) twice (DuplicateMethodCall)
+      Inline::C#build calls $? != 0 twice (DuplicateMethodCall)
       Inline::C#build calls Inline.directory 5 times (DuplicateMethodCall)
       Inline::C#build calls io.puts 6 times (DuplicateMethodCall)
       Inline::C#build calls io.puts("#endif") twice (DuplicateMethodCall)
@@ -51,6 +52,7 @@ Feature: Basic smell detection
       Inline::C#strip_comments doesn't depend on instance state (UtilityFunction)
       Inline::C#strip_comments refers to src more than self (FeatureEnvy)
       Module#inline calls Inline.const_get(lang) twice (DuplicateMethodCall)
+      Module#inline calls options[:testing] twice (DuplicateMethodCall)
       Module#inline has approx 12 statements (TooManyStatements)
     """
 
@@ -59,14 +61,14 @@ Feature: Basic smell detection
     Then the exit status indicates smells
     And it reports:
     """
-    spec/samples/optparse.rb -- 109 warnings:
+    spec/samples/optparse.rb -- 111 warnings:
       OptionParser has at least 42 methods (TooManyMethods)
       OptionParser has the variable name 'f' (UncommunicativeVariableName)
       OptionParser has the variable name 'k' (UncommunicativeVariableName)
       OptionParser has the variable name 'o' (UncommunicativeVariableName)
       OptionParser has the variable name 's' (UncommunicativeVariableName)
       OptionParser has the variable name 'v' (UncommunicativeVariableName)
-      OptionParser tests (argv.size == 1) and Array.===(argv[0]) at least 3 times (RepeatedConditional)
+      OptionParser tests (argv.size == 1) && (Array === argv[0]) at least 3 times (RepeatedConditional)
       OptionParser tests a at least 7 times (RepeatedConditional)
       OptionParser tests default_pattern at least 7 times (RepeatedConditional)
       OptionParser tests not_style at least 3 times (RepeatedConditional)
@@ -79,15 +81,15 @@ Feature: Basic smell detection
       OptionParser#getopts has approx 18 statements (TooManyStatements)
       OptionParser#load has approx 6 statements (TooManyStatements)
       OptionParser#load has the variable name 's' (UncommunicativeVariableName)
-      OptionParser#make_switch calls (long << (o = q.downcase)) twice (DuplicateMethodCall)
-      OptionParser#make_switch calls (sdesc << "-#{q}") twice (DuplicateMethodCall)
-      OptionParser#make_switch calls default_style.guess((arg = a)) 4 times (DuplicateMethodCall)
-      OptionParser#make_switch calls notwice((a ? (Object) : (TrueClass)), klass, "type") twice (DuplicateMethodCall)
+      OptionParser#make_switch calls default_style.guess(arg = a) 4 times (DuplicateMethodCall)
+      OptionParser#make_switch calls long << (o = q.downcase) twice (DuplicateMethodCall)
       OptionParser#make_switch calls notwice(NilClass, klass, "type") twice (DuplicateMethodCall)
+      OptionParser#make_switch calls notwice(if a ... end, klass, "type") twice (DuplicateMethodCall)
       OptionParser#make_switch calls pattern.method(:convert) twice (DuplicateMethodCall)
       OptionParser#make_switch calls pattern.method(:convert).to_proc twice (DuplicateMethodCall)
       OptionParser#make_switch calls pattern.respond_to?(:convert) twice (DuplicateMethodCall)
       OptionParser#make_switch calls q.downcase 3 times (DuplicateMethodCall)
+      OptionParser#make_switch calls sdesc << "-#{q}" twice (DuplicateMethodCall)
       OptionParser#make_switch calls search(:atype, FalseClass) twice (DuplicateMethodCall)
       OptionParser#make_switch calls search(:atype, o) 6 times (DuplicateMethodCall)
       OptionParser#make_switch contains iterators nested 3 deep (NestedIterators)
@@ -120,7 +122,9 @@ Feature: Basic smell detection
       OptionParser#self.inc performs a nil-check. (NilCheck)
       OptionParser#summarize has 4 parameters (LongParameterList)
       OptionParser#summarize has the variable name 'l' (UncommunicativeVariableName)
+      OptionParser#summarize is controlled by argument blk (ControlParameter)
       OptionParser#ver has the variable name 'v' (UncommunicativeVariableName)
+      OptionParser::Arguable has initialize method (ModuleInitialize)
       OptionParser::Arguable#options has approx 6 statements (TooManyStatements)
       OptionParser::Arguable#options= is controlled by argument opt (ControlParameter)
       OptionParser::CompletingHash#match contains iterators nested 2 deep (NestedIterators)
@@ -152,13 +156,13 @@ Feature: Basic smell detection
       OptionParser::Switch#self.guess has approx 6 statements (TooManyStatements)
       OptionParser::Switch#self.guess has the variable name 't' (UncommunicativeVariableName)
       OptionParser::Switch#self.incompatible_argument_styles has the parameter name 't' (UncommunicativeParameterName)
-      OptionParser::Switch#summarize calls (indent + l) twice (DuplicateMethodCall)
+      OptionParser::Switch#summarize calls indent + l twice (DuplicateMethodCall)
+      OptionParser::Switch#summarize calls left.collect do |s| ... end twice (DuplicateMethodCall)
+      OptionParser::Switch#summarize calls left.collect do |s| ... end.max twice (DuplicateMethodCall)
+      OptionParser::Switch#summarize calls left.collect do |s| ... end.max.to_i twice (DuplicateMethodCall)
       OptionParser::Switch#summarize calls left.collect twice (DuplicateMethodCall)
-      OptionParser::Switch#summarize calls left.collect { |s| s.length } twice (DuplicateMethodCall)
-      OptionParser::Switch#summarize calls left.collect { |s| s.length }.max twice (DuplicateMethodCall)
-      OptionParser::Switch#summarize calls left.collect { |s| s.length }.max.to_i twice (DuplicateMethodCall)
       OptionParser::Switch#summarize calls left.shift twice (DuplicateMethodCall)
-      OptionParser::Switch#summarize calls left[-1] 3 times (DuplicateMethodCall)
+      OptionParser::Switch#summarize calls left[(-1)] 3 times (DuplicateMethodCall)
       OptionParser::Switch#summarize calls s.length 3 times (DuplicateMethodCall)
       OptionParser::Switch#summarize contains iterators nested 2 deep (NestedIterators)
       OptionParser::Switch#summarize has 5 parameters (LongParameterList)
@@ -190,11 +194,11 @@ Feature: Basic smell detection
       RedCloth#block_markdown_lists has unused parameter 'text' (UnusedParameters)
       RedCloth#block_markdown_rule refers to text more than self (FeatureEnvy)
       RedCloth#block_markdown_setext refers to text more than self (FeatureEnvy)
-      RedCloth#block_textile_lists calls (line_id - 1) twice (DuplicateMethodCall)
       RedCloth#block_textile_lists calls depth.last 5 times (DuplicateMethodCall)
       RedCloth#block_textile_lists calls depth.last.length twice (DuplicateMethodCall)
       RedCloth#block_textile_lists calls depth[i] twice (DuplicateMethodCall)
-      RedCloth#block_textile_lists calls lines[(line_id - 1)] twice (DuplicateMethodCall)
+      RedCloth#block_textile_lists calls line_id - 1 twice (DuplicateMethodCall)
+      RedCloth#block_textile_lists calls lines[line_id - 1] twice (DuplicateMethodCall)
       RedCloth#block_textile_lists calls tl.length 3 times (DuplicateMethodCall)
       RedCloth#block_textile_lists contains iterators nested 3 deep (NestedIterators)
       RedCloth#block_textile_lists has approx 21 statements (TooManyStatements)
@@ -208,6 +212,7 @@ Feature: Basic smell detection
       RedCloth#blocks has approx 19 statements (TooManyStatements)
       RedCloth#blocks has boolean parameter 'deep_code' (BooleanParameter)
       RedCloth#blocks is controlled by argument deep_code (ControlParameter)
+      RedCloth#blocks refers to blk more than self (FeatureEnvy)
       RedCloth#clean_html calls tags[tag] twice (DuplicateMethodCall)
       RedCloth#clean_html contains iterators nested 3 deep (NestedIterators)
       RedCloth#clean_html doesn't depend on instance state (UtilityFunction)
@@ -219,7 +224,6 @@ Feature: Basic smell detection
       RedCloth#clean_white_space has approx 7 statements (TooManyStatements)
       RedCloth#clean_white_space refers to text more than self (FeatureEnvy)
       RedCloth#flush_left doesn't depend on instance state (UtilityFunction)
-      RedCloth#flush_left refers to indt more than self (FeatureEnvy)
       RedCloth#flush_left refers to text more than self (FeatureEnvy)
       RedCloth#footnote_ref refers to text more than self (FeatureEnvy)
       RedCloth#glyphs_textile has approx 10 statements (TooManyStatements)
@@ -245,21 +249,21 @@ Feature: Basic smell detection
       RedCloth#inline_textile_span has the variable name 'm' (UncommunicativeVariableName)
       RedCloth#lT has the name 'lT' (UncommunicativeMethodName)
       RedCloth#lT is controlled by argument text (ControlParameter)
+      RedCloth#lT refers to text more than self (FeatureEnvy)
       RedCloth#no_textile doesn't depend on instance state (UtilityFunction)
       RedCloth#no_textile refers to text more than self (FeatureEnvy)
       RedCloth#pba calls $1.length twice (DuplicateMethodCall)
       RedCloth#pba has approx 21 statements (TooManyStatements)
       RedCloth#pba is controlled by argument element (ControlParameter)
-      RedCloth#pba refers to style more than self (FeatureEnvy)
       RedCloth#pba refers to text more than self (FeatureEnvy)
       RedCloth#refs_markdown has the variable name 'm' (UncommunicativeVariableName)
       RedCloth#refs_textile has the variable name 'm' (UncommunicativeVariableName)
       RedCloth#retrieve has the variable name 'i' (UncommunicativeVariableName)
       RedCloth#retrieve has the variable name 'r' (UncommunicativeVariableName)
-      RedCloth#rip_offtags calls ((codepre - used_offtags.length) > 0) twice (DuplicateMethodCall)
-      RedCloth#rip_offtags calls (@pre_list.last << line) twice (DuplicateMethodCall)
-      RedCloth#rip_offtags calls (codepre - used_offtags.length) twice (DuplicateMethodCall)
+      RedCloth#rip_offtags calls (codepre - used_offtags.length) > 0 twice (DuplicateMethodCall)
+      RedCloth#rip_offtags calls @pre_list.last << line twice (DuplicateMethodCall)
       RedCloth#rip_offtags calls @pre_list.last twice (DuplicateMethodCall)
+      RedCloth#rip_offtags calls codepre - used_offtags.length twice (DuplicateMethodCall)
       RedCloth#rip_offtags calls codepre.zero? twice (DuplicateMethodCall)
       RedCloth#rip_offtags calls htmlesc(line, :NoQuotes) twice (DuplicateMethodCall)
       RedCloth#rip_offtags calls used_offtags.length twice (DuplicateMethodCall)

data/features/step_definitions/reek_steps.rb

@@ -57,7 +57,7 @@ Then /^it reports the error ['"](.*)['"]$/ do |string|
 end
 
 Then /^it reports a parsing error$/ do
-  expect(@last_stderr.chomp).to match(/Racc::ParseError/)
+  expect(@last_stderr.chomp).to match(/Parser::SyntaxError/)
 end
 
 Then /^it should indicate the line numbers of those smells$/ do

data/features/support/env.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'tempfile'
 require 'fileutils'
 require 'open3'
@@ -6,18 +5,19 @@ require 'reek/cli/application'
 
 class ReekWorld
   def run(cmd)
-    out, err, status = Open3.capture3(cmd)
-    @last_stdout = out
-    @last_stderr = err
-    @last_exit_status = status.exitstatus
+    stderr_file = Tempfile.new('reek-world')
+    stderr_file.close
+    @last_stdout = `#{cmd} 2> #{stderr_file.path}`
+    @last_exit_status = $?.exitstatus
+    @last_stderr = IO.read(stderr_file.path)
   end
 
   def reek(args)
-    run("ruby -Ilib -rubygems bin/reek --no-color #{args}")
+    run("ruby -Ilib bin/reek --no-color #{args}")
   end
 
   def reek_with_pipe(stdin, args)
-    run("echo \"#{stdin}\" | ruby -Ilib -rubygems bin/reek --no-color #{args}")
+    run("echo \"#{stdin}\" | ruby -Ilib bin/reek --no-color #{args}")
   end
 
   def rake(name, task_def)

data/lib/reek/core/code_context.rb

@@ -20,7 +20,7 @@ module Reek
       end
 
       def node_instance_methods
-        local_nodes(:defn)
+        local_nodes(:def)
       end
 
       def local_nodes(type, &blk)