reek 1.3.8 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e5b741864981fffaab8d15e77e27ade44e67355
-  data.tar.gz: 0196170433478c772cd616523401c3c58dd4c40f
+  metadata.gz: 6002373fce680e5b27b465fef2e8809c9cc0301a
+  data.tar.gz: abf6a5e6e1ab36e4d940bcea6f83893df1c230a5
 SHA512:
-  metadata.gz: 224dfa2013aad084aaff389f7aca99883f0d7153f7086fa6c860dde323753da85aec0809c9b5a47f410cd84c69754aba47d5887a9cb782b9128619ebca198663
-  data.tar.gz: 32a0e0f15be5a1deecdd60a61d06f894917d979f24a7e8942c3bd22cba336ced0103fa1f3090b442388d54c2be5c947ac97beb12f4f28ca0a5b106c6f1c9b3ad
+  metadata.gz: 3b6d532b9a3e596ce386b1edd8e389dffb31a4b9276cbc584d3c216d9a21d67b5cf84dc69f9cf99ec7f27abc4ea0e2fb1fd63153bd9772ba2d8a47a86e7444d5
+  data.tar.gz: 9db171e0f2a6096d8d5f0093feb9d7a42a119d300d19403e689caaef6444287ca1401a4e0df0338e38caf8b7ddcdd0d72908baeb1446ec499bb15b382ca2fb6a

data/CHANGELOG

@@ -1,3 +1,14 @@
+== 1.4.0
+
+* (Gilles Leblanc) Corrects UnusedParameter with keyword arguments with splat
+* (mvz) Consider block parameter for DuplicateMethodCall
+* (mvz) Add support for detecting specific smells
+* (troessner) Add ultra verbose warning formatter.
+
+== 1.3.8
+
+* Internal improvements
+
 == 1.3.7
 
 * (gilles-leblanc) Add color to reek's output

data/README.md

@@ -95,11 +95,13 @@ for up to date details of exactly what Reek will check in your code.
 
 ### Integration
 
-Basically there are two ways to use reek in your project except for the obvious static code analysis:
+Basically there are two ways to use reek in your project except for the obvious
+static code analysis:
 
-(1) Use Reek's [Rake Task](https://github.com/troessner/reek/wiki/Rake-Task) to easily add Reek to your Rakefile
+1. Use Reek's [Rake Task](https://github.com/troessner/reek/wiki/Rake-Task) to
+  easily add Reek to your Rakefile
 
-(2) Add Reek's custom matcher to your Rspec examples like this:
+2. Add Reek's custom matcher to your Rspec examples like this:
 
 ```Ruby
 require 'rubygems'
@@ -122,23 +124,27 @@ my_precious_code.should_not reek # Well, it does.
 
 ### Running the tests
 
-Either just `rake` to run all or, if you want to be specific:
+Either just `bundle exec rake` to run all or, if you want to be specific:
 
 ```bash
-spec spec/your/file        # Runs all tests
-spec spec/your/file -l 23  # Runs test in line 23
-spec spec/your/file -u     # Runs all tests stopping at the breakpoints you have set before with `debugger`
+bundle exec rspec spec/your/file_spec.rb            # Runs all tests in spec/your/file_spec.rb
+bundle exec rspec spec/your/file_spec.rb:23         # Runs test in line 23
+bundle exec cucumber features/your_file.feature     # Runs all scenarios in your_file.feature
+bundle exec cucumber features/your_file.feature:23  # Runs scenario at line 23
 ```
 
 ## Miscellaneous
 
 ### Tools
 
-There's a vim plugin for `reek`: [https://github.com/rainerborene/vim-reek](https://github.com/rainerborene/vim-reek)
+There's a vim plugin for `reek`:
+[https://github.com/rainerborene/vim-reek](https://github.com/rainerborene/vim-reek)
 
-TextMate Bundle for `reek`: [https://github.com/peeyush1234/reek.tmbundle](https://github.com/peeyush1234/reek.tmbundle)
+TextMate Bundle for `reek`:
+[https://github.com/peeyush1234/reek.tmbundle](https://github.com/peeyush1234/reek.tmbundle)
 
-Colorful output for `reek`: [Preek](https://github.com/joenas/preek) (also with [Guard::Preek](https://github.com/joenas/guard-preek))
+Colorful output for `reek`: [Preek](https://github.com/joenas/preek) (also with
+[Guard::Preek](https://github.com/joenas/guard-preek))
 
 ### Dependencies
 
@@ -153,7 +159,9 @@ Reek makes use of the following other gems:
 
 Find out more about Reek from any of the following sources:
 
-* 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)
-
+* 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)

data/Rakefile

@@ -1,19 +1,6 @@
 require 'rake/clean'
-require "bundler/gem_tasks"
-
-$:.unshift File.dirname(__FILE__) + '/lib'
-
-PROJECT_NAME = 'reek'
-
-BUILD_DIR = 'build'; directory BUILD_DIR
-PKG_DIR = "#{BUILD_DIR}/pkg"; directory PKG_DIR
-
-GEM_MANIFEST = "Manifest.txt"
-VERSION_FILE = 'lib/reek.rb'
-
-CLOBBER.include("#{BUILD_DIR}/*")
+require 'bundler/gem_tasks'
 
 Dir['tasks/**/*.rake'].each { |t| load t }
 
-task :default => [:test]
-
+task default: [:test]

data/assets/html_output.html.erb

@@ -0,0 +1,103 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset='UTF-8' />
+    <title>Reek Output</title>
+    <style>
+    * {
+      -webkit-box-sizing: border-box;
+      -moz-box-sizing: border-box;
+      box-sizing: border-box;
+    }
+    body {
+      background-color: #e8eef2;
+      font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
+      margin: 0;
+    }
+    #header {
+      background-color: #fafbfc;
+      border-bottom: 1px solid #cfdbe2;
+      margin-bottom: 20px;
+      padding: 20px;
+      color: #444444;
+    }
+    h1 {
+      margin: 0;
+    }
+    .total-warnings {
+      color: #f47f7f;
+    }
+    #reek-smells {
+      padding: 20px;
+      width: 100%;
+    }
+    .box {
+      margin-bottom: 20px;
+      background-color: #ffffff;
+      border: 1px solid transparent;
+      border-radius: 4px;
+      border-color: #cfdbe2;
+      -webkit-box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05);
+      box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05);
+      border-top-width: 3px;
+    }
+    .smell-list {
+      margin-bottom: 0px;
+      padding-left: 0px;
+    }
+    .list-item:first-child {
+      border-top-width: 0;
+    }
+    .list-item {
+      border-width: 1px 0;
+      border-radius: 0;
+      position: relative;
+      display: block;
+      padding: 10px 15px;
+      margin-bottom: -1px;
+      background-color: #ffffff;
+      border: 1px solid #f1f2f3;
+    }
+    .list-item > .content:first-child {
+      margin-top: 0px;
+    }
+    .list-item > .content {
+      overflow: hidden;
+    }
+    .list-item > .content > .heading {
+      margin: 0 0 5px 0;
+    }
+    .list-item > .content > small {
+      float: right;
+      color: #909fa7;
+      font-size: 0.8rem;
+    }
+    .list-item > .content > p {
+      margin: 0;
+      color: #656565;
+    }
+    </style>
+  </head>
+  <body>
+    <div id="header">
+      <h1>Reek Output - <span class="total-warnings"><%= smells.size %> total warnings</span></h1>
+    </div>
+    <div id="reek-smells">
+      <div class="box">
+        <div class="smell-list">
+          <% smells.each do |smell| %>
+          <div class="list-item">
+            <div class="content">
+              <div class="heading"><strong><%= smell.context%></strong> <%= smell.message%> (<%= smell.subclass%>)</div>
+              <small class="text-muted pull-right">Line <%= smell.lines %></small>
+              <p>
+              <small><%= smell.source %></small>
+              </p>
+            </div>
+          </div>
+          <% end %>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

data/features/command_line_interface/options.feature

@@ -36,15 +36,18 @@ Feature: Reek can be controlled using command-line options
 
       Configuration:
           -c, --config FILE                Read configuration options from FILE
+              --smell SMELL                Detect smell SMELL (default is all enabled smells)
 
       Report formatting:
           -o, --[no-]color                 Use colors for the output (this is the default)
           -q, --quiet                      Suppress headings for smell-free source files (this is the default)
           -V, --no-quiet, --verbose        Show headings for smell-free source files
+          -U, --ultra-verbose              Be as explanatory as possible
           -n, --no-line-numbers            Suppress line numbers from the output
               --line-numbers               Show line numbers in the output (this is the default)
           -s, --single-line                Show IDE-compatible single-line-per-warning
           -S, --sort-by-issue-count        Sort by "issue-count", listing the "smelliest" files first
           -y, --yaml                       Report smells in YAML format
+          -H, --html                       Report smells in HTML format
 
       """

data/features/command_line_interface/smell_selection.feature

@@ -0,0 +1,19 @@
+Feature: Smell selection
+  In order to focus on particular code smells
+  As a developer
+  I want to be able to selectively activate smell detectors
+
+  Scenario: --smell selects a smell to detect
+    When I run reek --no-line-numbers --smell DuplicateMethodCall spec/samples/two_smelly_files
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/two_smelly_files/dirty_one.rb -- 2 warnings:
+        Dirty#a calls @s.title twice (DuplicateMethodCall)
+        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+      spec/samples/two_smelly_files/dirty_two.rb -- 2 warnings:
+        Dirty#a calls @s.title twice (DuplicateMethodCall)
+        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+      4 total warnings
+
+      """

data/features/rake_task/rake_task.feature

@@ -46,7 +46,7 @@ Feature: Reek can be driven through its Task
       end
       """
     Then the exit status indicates an error
-    And stdout includes /spec\/samples\/masked\/dirty\.rb/
+    And stdout includes "spec/samples/masked/dirty.rb"
 
   Scenario: fail_on_error can hide the error status
     When I run rake reek with:

data/features/reports/reports.feature

@@ -187,3 +187,19 @@ Feature: Correctly formatted reports
       | args |
       | spec/samples/two_smelly_files/ |
       | spec/samples/two_smelly_files  |
+
+  Scenario Outline: -U or --ultra-verbose adds helpful links to smell warnings
+    When I run reek <option> spec/samples/one_smelly_file/dirty.rb
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/one_smelly_file/dirty.rb -- 3 warnings:
+        [1]:D has no descriptive comment (IrresponsibleModule) [https://github.com/troessner/reek/wiki/Irresponsible-Module]
+        [1]:D has the name 'D' (UncommunicativeModuleName) [https://github.com/troessner/reek/wiki/Uncommunicative-Module-Name]
+        [2]:D#a has the name 'a' (UncommunicativeMethodName) [https://github.com/troessner/reek/wiki/Uncommunicative-Method-Name]
+      """
+
+    Examples:
+      | option           |
+      | -U               |
+      | --ultra-verbose  |

data/features/reports/yaml.feature

@@ -6,7 +6,10 @@ Feature: Report smells using simple YAML layout
   Scenario: output is empty when there are no smells
     When I run reek --yaml spec/samples/three_clean_files
     Then it succeeds
-    And stdout equals ""
+    And it reports this yaml:
+    """
+    --- []
+    """
 
   @masking
   Scenario: masked smells always appear
@@ -14,49 +17,49 @@ Feature: Report smells using simple YAML layout
     Then the exit status indicates smells
     And it reports this yaml:
       """
-      --- 
-      - !ruby/object:Reek::SmellWarning 
-        location: 
-          lines: 
+      ---
+      - !ruby/object:Reek::SmellWarning
+        location:
+          lines:
           - 4
           - 6
           context: Dirty#a
           source: spec/samples/masked/dirty.rb
-        smell: 
+        smell:
           class: Duplication
           occurrences: 2
           subclass: DuplicateMethodCall
           call: "@s.title"
           message: calls @s.title twice
-        status: 
+        status:
           is_active: true
-      - !ruby/object:Reek::SmellWarning 
-        location: 
-          lines: 
+      - !ruby/object:Reek::SmellWarning
+        location:
+          lines:
           - 5
           - 7
           context: Dirty#a
           source: spec/samples/masked/dirty.rb
-        smell: 
+        smell:
           class: Duplication
           occurrences: 2
           subclass: DuplicateMethodCall
           call: puts(@s.title)
           message: calls puts(@s.title) twice
-        status: 
+        status:
           is_active: true
-      - !ruby/object:Reek::SmellWarning 
-        location: 
-          lines: 
+      - !ruby/object:Reek::SmellWarning
+        location:
+          lines:
           - 5
           context: Dirty#a
           source: spec/samples/masked/dirty.rb
-        smell: 
+        smell:
           class: NestedIterators
           depth: 2
           subclass: NestedIterators
           message: contains iterators nested 2 deep
-        status: 
+        status:
           is_active: true
 
       """
@@ -67,19 +70,19 @@ Feature: Report smells using simple YAML layout
     Then the exit status indicates smells
     And it reports this yaml:
       """
-      --- 
-      - !ruby/object:Reek::SmellWarning 
-        location: 
-          lines: 
+      ---
+      - !ruby/object:Reek::SmellWarning
+        location:
+          lines:
           - 1
           context: Turn
           source: $stdin
-        smell: 
+        smell:
           class: IrresponsibleModule
           subclass: IrresponsibleModule
           module_name: Turn
           message: has no descriptive comment
-        status: 
+        status:
           is_active: true
 
       """

data/features/samples.feature

@@ -59,7 +59,7 @@ Feature: Basic smell detection
     Then the exit status indicates smells
     And it reports:
     """
-    spec/samples/optparse.rb -- 108 warnings:
+    spec/samples/optparse.rb -- 109 warnings:
       OptionParser has at least 42 methods (TooManyMethods)
       OptionParser has the variable name 'f' (UncommunicativeVariableName)
       OptionParser has the variable name 'k' (UncommunicativeVariableName)
@@ -154,6 +154,7 @@ Feature: Basic smell detection
       OptionParser::Switch#self.incompatible_argument_styles has the parameter name 't' (UncommunicativeParameterName)
       OptionParser::Switch#summarize calls (indent + l) 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)

data/features/step_definitions/reek_steps.rb

@@ -11,59 +11,59 @@ When /^I run rake (\w*) with:$/ do |name, task_def|
 end
 
 Then /^stdout equals "([^\"]*)"$/ do |report|
-  @last_stdout.should == report
+  expect(@last_stdout).to eq report
 end
 
-Then /^stdout includes \/([^\"]*)\/$/ do |report|
-  @last_stdout.should match(report)
+Then /^stdout includes "(.*)"$/ do |text|
+  expect(@last_stdout).to include text
 end
 
 Then /^it succeeds$/ do
-  @last_exit_status.should == Reek::Cli::Application::STATUS_SUCCESS
+  expect(@last_exit_status).to eq Reek::Cli::Application::STATUS_SUCCESS
 end
 
 Then /^the exit status indicates an error$/ do
-  @last_exit_status.should == Reek::Cli::Application::STATUS_ERROR
+  expect(@last_exit_status).to eq Reek::Cli::Application::STATUS_ERROR
 end
 
 Then /^the exit status indicates smells$/ do
-  @last_exit_status.should == Reek::Cli::Application::STATUS_SMELLS
+  expect(@last_exit_status).to eq Reek::Cli::Application::STATUS_SMELLS
 end
 
 Then /^it reports:$/ do |report|
-  @last_stdout.chomp.should == report.chomp
+  expect(@last_stdout.chomp).to eq report.chomp
 end
 
 Then /^it reports this yaml:$/ do |expected_yaml|
   expected_warnings = YAML.load(expected_yaml.chomp)
   actual_warnings = YAML.load(@last_stdout)
-  actual_warnings.should == expected_warnings
+  expect(actual_warnings).to eq expected_warnings
 end
 
 Then /^stderr reports:$/ do |report|
-  @last_stderr.should == report
+  expect(@last_stderr).to eq report
 end
 
 Then /^it reports no errors$/ do
-  @last_stderr.chomp.should eq ""
+  expect(@last_stderr.chomp).to eq ''
 end
 
 Then /^it reports an error$/ do
-  @last_stderr.chomp.should_not be_empty
+  expect(@last_stderr.chomp).to_not be_empty
 end
 
 Then /^it reports the error ['"](.*)['"]$/ do |string|
-  @last_stderr.chomp.should == string
+  expect(@last_stderr.chomp).to eq string
 end
 
 Then /^it reports a parsing error$/ do
-  @last_stderr.chomp.should match(/Racc::ParseError/)
+  expect(@last_stderr.chomp).to match(/Racc::ParseError/)
 end
 
 Then /^it should indicate the line numbers of those smells$/ do
-  @last_stdout.chomp.should match(/\[.*\]:/)
+  expect(@last_stdout.chomp).to match(/\[.*\]:/)
 end
 
 Then /^it reports the current version$/ do
-  @last_stdout.should == "reek #{Reek::VERSION}\n"
+  expect(@last_stdout).to eq "reek #{Reek::VERSION}\n"
 end