reek 3.10.2 → 3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a251ceb10b65df518731985aac57a7f73b29961b
-  data.tar.gz: 9490529cdf278161c31bf009b99bbb39dd9d633f
+  metadata.gz: 67870a4dc44b9996f80e3daddb3614cbc9a1ee6d
+  data.tar.gz: 8eedb66acfa7d1b874a2806ffd7b6aab69769794
 SHA512:
-  metadata.gz: f1a8f22deef9a74aa7eb9938e637372e276b5af8ede419383364579950b4d59d3632bce86b8c023749282bd527fe7e27074f7a18154f8a7356157518c4b690c0
-  data.tar.gz: c2057985478a62c26b33b6e45db1c0dffc11ede4fa188ce6df4191369b8b5d0aba6d3f7b76f3d91004305f965e67e08b31339e6d9f89c3ca65dc2ad209a1ac76
+  metadata.gz: ad6862ed6352640db4ff88fbe718c6116579d257a6c83337dd1603e1a8580686da6895be5b478db0d5ebd4fd3e288c3e29a9e56ae25cc5115053eef8a18540f9
+  data.tar.gz: 8e1cc3bd8e0d9f6c00dfa21e2cd2ba6c9706b817c0a6c895d75be07f58f28f2ce9159f20edbceb1d1e9d676869f65b7771119ac339af04cc2ade6c01854ae8b9

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 3.11 (2016-02-18)
+
+* (troessner) Add a --todo cli flag that will generate a todo list.
+
 ## 3.10.2 (2016-02-15)
 
 * (troessner) Bump parser to 2.3.0.6 as minimum to fix problems with invalid syntax.

data/README.md

@@ -16,7 +16,7 @@ Reek is a tool that examines Ruby classes, modules and methods and reports any
 [Code Smells](docs/Code-Smells.md) it finds.
 
 For an excellent introduction to
-[Code Smells](docs/Code-Smells.md) and `Reek` check out [this blog post](https://blog.codeship.com/how-to-find-ruby-code-smells-with-reek/)
+[Code Smells](docs/Code-Smells.md) and Reek check out [this blog post](https://blog.codeship.com/how-to-find-ruby-code-smells-with-reek/)
 or [that one](https://troessner.wordpress.com/2016/01/01/the-latest-and-greatest-additions-to-reek/). There is also [this talk](https://www.youtube.com/watch?v=ZzqOuHI5MkA) from the RUBYCONF Porto.
 
 Install it via rubygems:
@@ -63,7 +63,7 @@ demo.rb -- 8 warnings:
 
 ## Supported rubies
 
-`Reek` is officially running on the following MRI rubies:
+Reek is officially running on the following MRI rubies:
 
   - 2.0
   - 2.1
@@ -95,7 +95,7 @@ class Item < ActiveRecord::Base
 end
 ```
 
-Running `reek` on this file like this:
+Running Reek on this file like this:
 
 ```
 reek app/models/shopping_cart.rb
@@ -133,13 +133,13 @@ those first when you have a warning that you don't know how to deal with.
 
 ## Sources
 
-There are multiple ways you can have `reek` work on sources, the most common one just being
+There are multiple ways you can have Reek work on sources, the most common one just being
 
 ```Bash
 reek lib/
 ```
 
-If you don't pass any source arguments to `reek` it just takes the current working directory as source.
+If you don't pass any source arguments to Reek it just takes the current working directory as source.
 
 So
 
@@ -153,7 +153,7 @@ is the exact same thing as being explicit:
 reek .
 ```
 
-Additionally you can pipe code to `reek` like this:
+Additionally you can pipe code to Reek like this:
 
 ```Bash
 echo "class C; def m; end; end" | reek
@@ -210,7 +210,7 @@ For a summary of those CLI options see [Command-Line Options](docs/Command-Line-
 
 Configuring Reek via a configuration file is by far the most powerful way.
 
-There are three ways of passing `reek` a configuration file:
+There are three ways of passing Reek a configuration file:
 
 1. Using the CLI `-c` switch (see [_Command-line interface_](#command-line-interface) above)
 2. Having a file ending with `.reek` either in your current working directory or in a parent directory (more on that later)
@@ -337,6 +337,42 @@ end
 
 This is an incredible powerful feature and further explained under [Smell Suppresion](docs/Smell-Suppression.md).
 
+### Generating a 'todo' list
+
+Integrating tools like Reek into an existing larger codebase can be daunting when you have to fix
+possibly hundreds or thousands of smell warnings first.
+Sure you could manually disable smell warnings like shown above but depending on the size of your
+codebase this might not be an option.
+Fortunately Reek provides a 'todo' flag which you can use to generate a configuration that will
+suppress all smell warnings for the current codebase:
+
+```Bash
+reek --todo lib/
+```
+
+This will create the file '.todo.reek' in your current working directory.
+
+You can then use this as your configuration - since your working directory
+probably is your project root in most cases you don't have to tell Reek
+explicitly to use '.todo.reek' because Reek will automatically pick it up
+and use it as configuration file. See [Configuration Loading](#configuration-loading) above.
+
+If for whatever reasons you decide to put '.todo.reek' somewhere else where
+Reek won't pick it up automatically you need to tell Reek explicitly to do so
+via:
+
+```Bash
+reek -c whatever/.todo.reek lib/
+```
+
+Note that if you re-run
+
+```Bash
+reek --todo lib/
+```
+
+'.todo.reek' will get overwritten with a possibly updated configuration.
+
 ## Usage
 
 Besides the obvious
@@ -386,7 +422,7 @@ If you don't feel like getting your hands dirty with code there are still other
 
 ## Output formats
 
-`reek` supports 5 output formats:
+Reek supports 5 output formats:
 
 * plain text (default)
 * HTML (`--format html`)
@@ -429,12 +465,12 @@ Be careful though, Reek does not merge your configuration entries, so if you alr
 
 * [overcommit](https://github.com/brigade/overcommit) - a Git commit hook manager with support for
   Reek
-* [ruby-critic](https://github.com/whitesmith/rubycritic) - gem that wraps around static analysis gems such as `reek`, [flay](https://github.com/seattlerb/flay) and [flog](https://github.com/seattlerb/flog)
+* [ruby-critic](https://github.com/whitesmith/rubycritic) - gem that wraps around static analysis gems such as Reek, [flay](https://github.com/seattlerb/flay) and [flog](https://github.com/seattlerb/flog)
 * [pronto-reek](https://github.com/mmozuras/pronto-reek) - Reek integration for [pronto](https://github.com/mmozuras/pronto)
 
 ### Misc
 
-* [Colorful output for `reek`](https://github.com/joenas/preek)
+* [Colorful output for Reek](https://github.com/joenas/preek)
   (also with [Guard::Preek](https://github.com/joenas/guard-preek))
 
 ## Brothers and sisters

data/docs/Command-Line-Options.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-`reek` follows standard Unix convention for passing arguments.
+Reek follows standard Unix convention for passing arguments.
 
 Check out
 

data/docs/Unused-Private-Method.md

@@ -18,7 +18,7 @@ class Car
 end
 ```
 
-`Reek` would emit the following warning:
+Reek would emit the following warning:
 
 ```
 2 warnings:
@@ -32,7 +32,7 @@ end
 
 Private methods that are called via dynamic dispatch
 will trigger a false alarm since detecting something like this is far out of
-scope for `Reek`. In this case you can disable this detector via the `exclude`
+scope for Reek. In this case you can disable this detector via the `exclude`
 configuration option (which is part of the [Basic Smell Options](Basic-Smell-Options.md))
 for instance like this (an example from `Reek's` own codebase):
 
@@ -50,7 +50,7 @@ a method scope (like you can see above).
 
 ## Known limitations
 
-* Method calls via dynamic dispatch (e.g. via `send`) is something `Reek` (or any other
+* Method calls via dynamic dispatch (e.g. via `send`) is something Reek (or any other
   static tool for that matter) can not detect.
 * Method calls via callback like [Rails filters](http://guides.rubyonrails.org/action_controller_overview.html#filters)
   will trigger this as well, e.g.:
@@ -65,7 +65,7 @@ a method scope (like you can see above).
     end
   end
 ```
-* `Reek` works on a per-file base. This means that using something like the [template pattern](https://en.wikipedia.org/wiki/Template_method_pattern)
+* Reek works on a per-file base. This means that using something like the [template pattern](https://en.wikipedia.org/wiki/Template_method_pattern)
   with private methods will trigger this detector.
   We do believe though that using private methods to fill out a template in a
   superclass is not a good idea in general so this probably isn't really a problem

data/docs/YAML-Reports.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-`Reek`'s `--yaml` option writes on $stdout a YAML dump of the smells found. Each reported smell has a number of standard fields and a number of fields that are specific to the smell's type. The common fields are as follows:
+Reek's `--yaml` option writes on $stdout a YAML dump of the smells found. Each reported smell has a number of standard fields and a number of fields that are specific to the smell's type. The common fields are as follows:
 
 | Field         | Type       | Value  |
 | ---------------|-------------|---------|

data/features/command_line_interface/options.feature

@@ -43,6 +43,9 @@ Feature: Reek can be controlled using command-line options
           -c, --config FILE                Read configuration options from FILE
               --smell SMELL                Detect smell SMELL (default: all enabled smells)
 
+      Generate a todo list:
+          -t, --todo                       Generate a todo list
+
       Report format:
           -f, --format FORMAT              Report smells in the given format:
                                              html

data/features/step_definitions/todo_list_steps.rb

@@ -0,0 +1,40 @@
+Given(/^a directory 'lib' with one clean file 'clean\.rb' and one dirty file 'dirty\.rb'$/) do
+  write_file('lib/clean.rb', <<-EOS.strip_heredoc)
+    # clean class for testing purposes
+    class Clean
+      def super_clean
+        puts @janitor.name
+      end
+    end
+  EOS
+
+  write_file('lib/dirty.rb', <<-EOS.strip_heredoc)
+    class Dirty
+      def a; end
+      def b; end
+    end
+  EOS
+end
+
+Given(/^a configuration file 'config\.reek' that partially masks 'dirty\.rb'$/) do
+  write_file('config.reek', <<-EOS.strip_heredoc)
+    ---
+    IrresponsibleModule:
+      exclude:
+      - Dirty
+    UncommunicativeMethodName:
+      exclude:
+      - Dirty#b
+  EOS
+end
+
+Given(/^a directory 'superclean' with one clean file 'clean\.rb'$/) do
+  write_file('superclean/clean.rb', <<-EOS.strip_heredoc)
+    # clean class for testing purposes
+    class Clean
+      def super_clean
+        puts @janitor.name
+      end
+    end
+  EOS
+end

data/features/todo_list.feature

@@ -0,0 +1,72 @@
+Feature:
+
+  Write a Reek configuration as a kind of todo list that will prevent Reek
+  from reporting smells on the current code.
+  This can then be worked on later on.
+  The main goal here would be to ease the Reek adoption by allowing developers to:
+    - introduce Reek right away (e.g. for CI)
+    - exclude the "old" smells from getting reported
+    - fix them step by step
+    - get rid of the todo file
+
+  Background:
+    Given a directory 'lib' with one clean file 'clean.rb' and one dirty file 'dirty.rb'
+    And a directory 'superclean' with one clean file 'clean.rb'
+
+  Scenario: Generate a proper todo file that disables all found smells
+    When I run reek lib
+    Then the exit status indicates smells
+    And it reports:
+      """
+      lib/dirty.rb -- 3 warnings:
+        [1]:IrresponsibleModule: Dirty has no descriptive comment [https://github.com/troessner/reek/blob/master/docs/Irresponsible-Module.md]
+        [2]:UncommunicativeMethodName: Dirty#a has the name 'a' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
+        [3]:UncommunicativeMethodName: Dirty#b has the name 'b' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
+      3 total warnings
+      """
+    When I run reek --todo lib
+    Then it succeeds
+    And a file named ".todo.reek" should exist
+    And the file ".todo.reek" should contain:
+      """
+      ---
+      IrresponsibleModule:
+        exclude:
+        - Dirty
+      UncommunicativeMethodName:
+        exclude:
+        - Dirty#a
+        - Dirty#b
+        """
+    When I run reek -c .todo.reek lib
+    Then it succeeds
+
+  Scenario: Respects an configuration file
+    Given a configuration file 'config.reek' that partially masks 'dirty.rb'
+    When I run reek -c config.reek --todo lib
+    Then it succeeds
+    And a file named ".todo.reek" should exist
+    And the file ".todo.reek" should contain:
+      """
+      ---
+      UncommunicativeMethodName:
+        exclude:
+        - Dirty#a
+      """
+
+  Scenario: Print out a helpful message that explains to the user what to do next
+    When I run reek --todo lib
+    Then it reports:
+      """
+
+      '.todo.reek' generated! You can now use this as a starting point for your configuration.
+      """
+
+  Scenario: Reacts appropiately when there are no smells
+    When I run reek --todo superclean/
+    Then a file named ".todo.reek" should not exist
+    And it reports:
+      """
+
+      '.todo.reek' not generated because there were no smells found!
+      """

data/lib/reek/cli/application.rb

@@ -1,7 +1,8 @@
 require_relative 'options'
-require_relative 'reek_command'
 require_relative 'option_interpreter'
 require_relative '../configuration/app_configuration'
+require_relative 'command/report_command'
+require_relative 'command/todo_list_command'
 
 module Reek
   module CLI
@@ -17,7 +18,7 @@ module Reek
         @options = configure_options(argv)
         @status = options.success_exit_code
         @configuration = configure_app_configuration(options.config_file)
-        @command = ReekCommand.new(OptionInterpreter.new(options))
+        @command = command_class.new(OptionInterpreter.new(options))
       end
 
       def execute
@@ -42,6 +43,10 @@ module Reek
         $stderr.puts "Error: #{error}"
         exit Options::DEFAULT_ERROR_EXIT_CODE
       end
+
+      def command_class
+        options.generate_todo_list ? Command::TodoListCommand : Command::ReportCommand
+      end
     end
   end
 end

data/lib/reek/cli/command/base_command.rb

@@ -0,0 +1,26 @@
+module Reek
+  module CLI
+    module Command
+      #
+      # Base class for all commands
+      #
+      class BaseCommand
+        def initialize(options)
+          @options = options
+        end
+
+        private
+
+        attr_reader :options
+
+        def smell_names
+          @smell_names ||= options.smells_to_detect
+        end
+
+        def sources
+          @sources ||= options.sources
+        end
+      end
+    end
+  end
+end

data/lib/reek/cli/command/report_command.rb

@@ -0,0 +1,38 @@
+require_relative 'base_command'
+require_relative '../../examiner'
+
+module Reek
+  module CLI
+    module Command
+      #
+      # A command to collect smells from a set of sources and write them out in
+      # text report format.
+      #
+      class ReportCommand < BaseCommand
+        def execute(app)
+          populate_reporter_with_smells app
+          reporter.show
+          result_code
+        end
+
+        private
+
+        def populate_reporter_with_smells(app)
+          sources.each do |source|
+            reporter.add_examiner Examiner.new(source,
+                                               smell_names,
+                                               configuration: app.configuration)
+          end
+        end
+
+        def result_code
+          reporter.smells? ? options.failure_exit_code : options.success_exit_code
+        end
+
+        def reporter
+          @reporter ||= options.reporter
+        end
+      end
+    end
+  end
+end

data/lib/reek/cli/command/todo_list_command.rb

@@ -0,0 +1,49 @@
+require_relative 'base_command'
+require_relative '../../examiner'
+
+module Reek
+  module CLI
+    module Command
+      #
+      # A command to collect smells from a set of sources and writes a configuration
+      # file that can serve as a todo list.
+      #
+      class TodoListCommand < BaseCommand
+        FILE_NAME = '.todo.reek'.freeze
+
+        def execute(app)
+          smells = scan_for_smells(app)
+          if smells.empty?
+            puts "\n'.todo.reek' not generated because "\
+                    'there were no smells found!'
+          else
+            File.write FILE_NAME, groups_for(smells).to_yaml
+            puts "\n'.todo.reek' generated! You can now use "\
+                    'this as a starting point for your configuration.'
+          end
+          options.success_exit_code
+        end
+
+        private
+
+        def scan_for_smells(app)
+          sources.map do |source|
+            Examiner.new(source,
+                         smell_names,
+                         configuration: app.configuration)
+          end.map(&:smells).flatten
+        end
+
+        def groups_for(smells)
+          @groups ||= begin
+            Hash[
+              smells.group_by(&:smell_type).map do |smell_type, smells_for_type|
+                [smell_type, { 'exclude' => smells_for_type.map(&:context) }]
+              end
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/reek/cli/options.rb

@@ -9,7 +9,7 @@ module Reek
     #
     # See {file:docs/Command-Line-Options.md} for details.
     #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 9 }
+    # :reek:TooManyInstanceVariables: { max_instance_variables: 10 }
     # :reek:Attribute: { enabled: false }
     #
     class Options
@@ -26,18 +26,20 @@ module Reek
                     :show_links,
                     :sorting,
                     :success_exit_code,
-                    :failure_exit_code
+                    :failure_exit_code,
+                    :generate_todo_list
 
       def initialize(argv = [])
-        @argv              = argv
-        @parser            = OptionParser.new
-        @report_format     = :text
-        @location_format   = :numbers
-        @show_links        = true
-        @smells_to_detect  = []
-        @colored           = color_support?
-        @success_exit_code = DEFAULT_SUCCESS_EXIT_CODE
-        @failure_exit_code = DEFAULT_FAILURE_EXIT_CODE
+        @argv               = argv
+        @parser             = OptionParser.new
+        @report_format      = :text
+        @location_format    = :numbers
+        @show_links         = true
+        @smells_to_detect   = []
+        @colored            = color_support?
+        @success_exit_code  = DEFAULT_SUCCESS_EXIT_CODE
+        @failure_exit_code  = DEFAULT_FAILURE_EXIT_CODE
+        @generate_todo_list = false
 
         set_up_parser
       end
@@ -55,10 +57,11 @@ module Reek
         $stdout.tty?
       end
 
-      # :reek:TooManyStatements: { max_statements: 6 }
+      # :reek:TooManyStatements: { max_statements: 7 }
       def set_up_parser
         set_banner
         set_configuration_options
+        set_generate_todo_list_options
         set_alternative_formatter_options
         set_report_formatting_options
         set_exit_codes
@@ -81,17 +84,6 @@ module Reek
         EOB
       end
 
-      def set_alternative_formatter_options
-        parser.separator "\nReport format:"
-        parser.on(
-          '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml, :code_climate],
-          'Report smells in the given format:',
-          '  html', '  text (default)', '  yaml', '  json', '  xml', '  code_climate'
-        ) do |opt|
-          self.report_format = opt
-        end
-      end
-
       # :reek:TooManyStatements: { max_statements: 6 }
       def set_configuration_options
         parser.separator 'Configuration:'
@@ -104,6 +96,24 @@ module Reek
         end
       end
 
+      def set_generate_todo_list_options
+        parser.separator '\nGenerate a todo list:'
+        parser.on('-t', '--todo', 'Generate a todo list') do
+          self.generate_todo_list = true
+        end
+      end
+
+      def set_alternative_formatter_options
+        parser.separator "\nReport format:"
+        parser.on(
+          '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml, :code_climate],
+          'Report smells in the given format:',
+          '  html', '  text (default)', '  yaml', '  json', '  xml', '  code_climate'
+        ) do |opt|
+          self.report_format = opt
+        end
+      end
+
       def set_report_formatting_options
         parser.separator "\nText format options:"
         set_up_color_option

data/lib/reek/version.rb

@@ -6,6 +6,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '3.10.2'.freeze
+    STRING = '3.11'.freeze
   end
 end

data/spec/factories/factories.rb

@@ -1,6 +1,8 @@
 require_relative '../../lib/reek/smells'
 require_relative '../../lib/reek/smells/smell_detector'
 require_relative '../../lib/reek/smells/smell_warning'
+require_relative '../../lib/reek/cli/option_interpreter'
+require_relative '../../lib/reek/cli/options'
 
 FactoryGirl.define do
   factory :context, class: Reek::Context::CodeContext do
@@ -51,4 +53,14 @@ FactoryGirl.define do
           parameters: parameters)
     end
   end
+
+  factory :options_interpreter_with_empty_sources, class: Reek::CLI::OptionInterpreter do
+    transient do
+      options { Reek::CLI::Options.new [] }
+    end
+
+    initialize_with do
+      Reek::CLI::OptionInterpreter.new(options)
+    end
+  end
 end

data/spec/reek/cli/application_spec.rb

@@ -15,17 +15,19 @@ RSpec.describe Reek::CLI::Application do
     end
   end
 
-  describe '#execute' do
-    let(:command) { double 'reek_command' }
-    let(:app) { Reek::CLI::Application.new [] }
+  context 'report_command' do
+    describe '#execute' do
+      let(:command) { double 'reek_command' }
+      let(:app) { Reek::CLI::Application.new [] }
 
-    before do
-      allow(Reek::CLI::ReekCommand).to receive(:new).and_return command
-    end
+      before do
+        allow(Reek::CLI::Command::ReportCommand).to receive(:new).and_return command
+      end
 
-    it "returns the command's result code" do
-      allow(command).to receive(:execute).and_return 'foo'
-      expect(app.execute).to eq 'foo'
+      it "returns the command's result code" do
+        allow(command).to receive(:execute).and_return 'foo'
+        expect(app.execute).to eq 'foo'
+      end
     end
   end
 end

data/spec/reek/cli/{reek_command_spec.rb → command/report_command_spec.rb}

@@ -1,9 +1,9 @@
-require_relative '../../spec_helper'
-require_lib 'reek/cli/reek_command'
+require_relative '../../../spec_helper'
+require_lib 'reek/cli/command/report_command'
 require_lib 'reek/cli/options'
 require_lib 'reek/cli/option_interpreter'
 
-RSpec.describe Reek::CLI::ReekCommand do
+RSpec.describe Reek::CLI::Command::ReportCommand do
   describe '#execute' do
     let(:options) { Reek::CLI::Options.new [] }
     let(:option_interpreter) { Reek::CLI::OptionInterpreter.new(options) }

data/spec/reek/cli/command/todo_list_command_spec.rb

@@ -0,0 +1,64 @@
+require_relative '../../../spec_helper'
+require_lib 'reek/cli/command/todo_list_command'
+require_lib 'reek/cli/options'
+require_lib 'reek/cli/option_interpreter'
+
+RSpec.describe Reek::CLI::Command::TodoListCommand do
+  describe '#execute' do
+    let(:option_interpreter) { FactoryGirl.build(:options_interpreter_with_empty_sources) }
+    let(:app) { double 'app' }
+    let(:command) { described_class.new option_interpreter }
+
+    before do
+      $stdout = StringIO.new
+      allow(File).to receive(:write)
+    end
+
+    after(:all) do
+      $stdout = STDOUT
+    end
+
+    context 'smells found' do
+      before do
+        smells = [FactoryGirl.build(:smell_warning)]
+        allow(command).to receive(:scan_for_smells).and_return(smells)
+      end
+
+      it 'shows a proper message' do
+        expected = "\n'.todo.reek' generated! You can now use this as a starting point for your configuration.\n"
+        expect { command.execute app }.to output(expected).to_stdout
+      end
+
+      it 'returns a success code' do
+        result = command.execute app
+        expect(result).to eq(Reek::CLI::Options::DEFAULT_SUCCESS_EXIT_CODE)
+      end
+    end
+
+    context 'no smells found' do
+      before do
+        allow(command).to receive(:scan_for_smells).and_return []
+      end
+
+      it 'shows a proper message' do
+        expected = "\n'.todo.reek' not generated because there were no smells found!\n"
+        expect { command.execute app }.to output(expected).to_stdout
+      end
+
+      it 'returns a success code' do
+        result = command.execute app
+        expect(result).to eq Reek::CLI::Options::DEFAULT_SUCCESS_EXIT_CODE
+      end
+    end
+
+    describe 'groups_for' do
+      let(:command) { described_class.new({}) }
+
+      it 'returns a proper hash representation of the smells found' do
+        smells = [FactoryGirl.build(:smell_warning)]
+        expected = { 'FeatureEnvy' => { 'exclude' => ['self'] } }
+        expect(command.send(:groups_for, smells)).to eq(expected)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 3.10.2
+  version: '3.11'
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -155,7 +155,9 @@ files:
 - features/step_definitions/.rubocop.yml
 - features/step_definitions/reek_steps.rb
 - features/step_definitions/sample_file_steps.rb
+- features/step_definitions/todo_list_steps.rb
 - features/support/env.rb
+- features/todo_list.feature
 - lib/reek.rb
 - lib/reek/ast/ast_node_class_map.rb
 - lib/reek/ast/node.rb
@@ -181,11 +183,12 @@ files:
 - lib/reek/ast/sexp_extensions/when.rb
 - lib/reek/ast/sexp_extensions/yield.rb
 - lib/reek/cli/application.rb
-- lib/reek/cli/command.rb
+- lib/reek/cli/command/base_command.rb
+- lib/reek/cli/command/report_command.rb
+- lib/reek/cli/command/todo_list_command.rb
 - lib/reek/cli/input.rb
 - lib/reek/cli/option_interpreter.rb
 - lib/reek/cli/options.rb
-- lib/reek/cli/reek_command.rb
 - lib/reek/cli/silencer.rb
 - lib/reek/cli/warning_collector.rb
 - lib/reek/code_comment.rb
@@ -271,10 +274,11 @@ files:
 - spec/reek/ast/reference_collector_spec.rb
 - spec/reek/ast/sexp_extensions_spec.rb
 - spec/reek/cli/application_spec.rb
+- spec/reek/cli/command/report_command_spec.rb
+- spec/reek/cli/command/todo_list_command_spec.rb
 - spec/reek/cli/input_spec.rb
 - spec/reek/cli/option_interpreter_spec.rb
 - spec/reek/cli/options_spec.rb
-- spec/reek/cli/reek_command_spec.rb
 - spec/reek/cli/warning_collector_spec.rb
 - spec/reek/code_comment_spec.rb
 - spec/reek/configuration/app_configuration_spec.rb

data/lib/reek/cli/command.rb

@@ -1,16 +0,0 @@
-module Reek
-  module CLI
-    #
-    # Base class for all commands
-    #
-    class Command
-      def initialize(options)
-        @options = options
-      end
-
-      private
-
-      attr_reader :options
-    end
-  end
-end

data/lib/reek/cli/reek_command.rb

@@ -1,34 +0,0 @@
-require_relative 'command'
-require_relative '../examiner'
-
-module Reek
-  module CLI
-    #
-    # A command to collect smells from a set of sources and write them out in
-    # text report format.
-    #
-    class ReekCommand < Command
-      def execute(app)
-        options.sources.each do |source|
-          reporter.add_examiner Examiner.new(source, smell_names, configuration: app.configuration)
-        end
-        reporter.show
-        result_code
-      end
-
-      private
-
-      def result_code
-        reporter.smells? ? options.failure_exit_code : options.success_exit_code
-      end
-
-      def reporter
-        @reporter ||= options.reporter
-      end
-
-      def smell_names
-        @smell_names ||= options.smells_to_detect
-      end
-    end
-  end
-end