reek 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72d27c8901d22ffc65492d565e6c037d71f9f1e0
-  data.tar.gz: e358a34395daae66652468724f1794f4a8719d0a
+  metadata.gz: 71c1d52a08d1ce16364812f297d6a072109b406b
+  data.tar.gz: f0ea4129036dde1687ad6656c603d63e8a6ddaf2
 SHA512:
-  metadata.gz: d6ef752ab64fb5db0d0038e4a41405c261c1f9e6b9174e3b9b2b50062892fe78bcd5d1467ca0d392590e00a63ca33b25e1c6376cb59a2d37f989e12284e79951
-  data.tar.gz: 7daf1e81235a889917a06a737bab16996f0e2c51fbd3ab278869c7405c985821088e8d6071a0c79f573f725dd84bebd49b358327ea825314eee5769aca618a1d
+  metadata.gz: 1228e4b9dc1f5673e7f474af1c6f5eb16d30eac8df72d4aecb4684b2ff2aa7796e62defe53a903ff9853444fe112187e3d7de7f40bd8c619c75d459d11273d7d
+  data.tar.gz: fb720491aa22c267bdccdfdb7296f9f89a216ab7da89d8e66f903c63bf401ee8beff14256a0b052bf284df93f81d27f9c050f1db1af3b15714f6b7a23565c425

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## 4.0.3 (2016-05-23)
+
+* (mvz) Include default exclusions in generated TODO file
+* (mvz) Avoid generating duplicate context entries in exclusions
+
 ## 4.0.2 (2016-04-23)
 
 * (mvz) Stop UnusedPrivateMethod getting confused by nested classes

data/README.md

@@ -2,8 +2,37 @@
 
 # Code smell detector for Ruby
 
-## Overview
+**Table of Contents**
+
+- [Overview](#overview)
+- [Quickstart](#quickstart)
+- [Example](#example)
+- [Supported rubies](#supported-rubies)
+- [Fixing Smell Warnings](#fixing-smell-warnings)
+- [Sources](#sources)
+- [Code smells](#code-smells)
+- [Configuration](#configuration)
+  - [Command-line interface](#command-line-interface)
+  - [Configuration file](#configuration-file)
+    - [Configuration loading](#configuration-loading)
+    - [Configuration options](#configuration-options)
+  - [Source code comments](#source-code-comments)
+  - [Generating a 'todo' list](#generating-a-todo-list)
+- [Usage](#usage)
+- [Developing Reek / Contributing](#developing-reek--contributing)
+- [Output formats](#output-formats)
+- [Working with Rails](#working-with-rails)
+- [Integrations](#integrations)
+  - [Editor integrations](#editor-integrations)
+  - [Projects that use or support us](#projects-that-use-or-support-us)
+  - [Misc](#misc)
+- [Brothers and sisters](#brothers-and-sisters)
+- [Contributors](#contributors)
+- [Additional resources](#additional-resources)
+  - [Miscellaneous](#miscellaneous)
+  - [More information](#more-information)
 
+## Overview
 
 [![Build Status](https://secure.travis-ci.org/troessner/reek.svg?branch=master)](https://travis-ci.org/troessner/reek?branch=master)
 [![Gem Version](https://badge.fury.io/rb/reek.svg)](https://badge.fury.io/rb/reek)
@@ -19,7 +48,7 @@ Reek is a tool that examines Ruby classes, modules and methods and reports any
 
 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/)
-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 Portugal](http://rubyconf.pt/).
+or [that one](https://troessner.svbtle.com/the-latest-and-greatest-additions-to-reek). There is also [this talk](https://www.youtube.com/watch?v=ZzqOuHI5MkA) from the [RubyConf Portugal](http://rubyconf.pt/).
 
 Install it via rubygems:
 
@@ -461,6 +490,7 @@ Be careful though, Reek does not merge your configuration entries, so if you alr
 * [TextMate Bundle](https://github.com/peeyush1234/reek.tmbundle)
 * [Atom plugin](https://atom.io/packages/linter-reek)
 * [SublimeLinter plugin](https://packagecontrol.io/packages/SublimeLinter-contrib-reek)
+* [Emacs plugin](https://github.com/hanmoi-choi/reek-emacs)
 
 ### Projects that use or support us
 

data/features/step_definitions/sample_file_steps.rb

@@ -118,6 +118,14 @@ Given(/^a configuration file masking some duplication smells called 'config.reek
   EOS
 end
 
+Given(/^a configuration file disabling DuplicateMethodCall called 'config.reek'$/) do
+  write_file('config.reek', <<-EOS.strip_heredoc)
+    ---
+    DuplicateMethodCall:
+      enabled: false
+  EOS
+end
+
 When(/^I run "reek (.*?)" in the subdirectory$/) do |args|
   cd 'subdir'
   reek(args)

data/features/todo_list.feature

@@ -9,41 +9,42 @@ Feature:
     - 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
+    Given a smelly file called 'smelly.rb'
+    When I run reek smelly.rb
     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
+      smelly.rb -- 3 warnings:
+        [4, 5]:DuplicateMethodCall: Smelly#m calls @foo.bar 2 times [https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md]
+        [4, 5]:DuplicateMethodCall: Smelly#m calls puts @foo.bar 2 times [https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md]
+        [3]:UncommunicativeMethodName: Smelly#m has the name 'm' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
       """
-    When I run reek --todo lib
+    When I run reek --todo smelly.rb
     Then it succeeds
+    And it reports:
+      """
+
+      '.todo.reek' generated! You can now use this as a starting point for your configuration.
+      """
     And a file named ".todo.reek" should exist
     And the file ".todo.reek" should contain:
       """
       ---
-      IrresponsibleModule:
+      DuplicateMethodCall:
         exclude:
-        - Dirty
+        - Smelly#m
       UncommunicativeMethodName:
         exclude:
-        - Dirty#a
-        - Dirty#b
+        - Smelly#m
         """
-    When I run reek -c .todo.reek lib
+    When I run reek -c .todo.reek smelly.rb
     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
+  Scenario: Respects a configuration file
+    Given a smelly file called 'smelly.rb'
+    And a configuration file disabling DuplicateMethodCall called 'config.reek'
+    When I run reek -c config.reek --todo smelly.rb
     Then it succeeds
     And a file named ".todo.reek" should exist
     And the file ".todo.reek" should contain:
@@ -51,19 +52,12 @@ Feature:
       ---
       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.
+        - Smelly#m
       """
 
   Scenario: Reacts appropiately when there are no smells
-    When I run reek --todo superclean/
+    Given the clean file 'clean.rb'
+    When I run reek --todo clean.rb
     Then a file named ".todo.reek" should not exist
     And it reports:
       """

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

@@ -36,13 +36,13 @@ module Reek
         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) }]
+          @groups ||=
+            begin
+              todos = smells.group_by(&:smell_class).map do |smell_class, smells_for_class|
+                smell_class.todo_configuration_for(smells_for_class)
               end
-            ]
-          end
+              todos.inject(&:merge)
+            end
         end
       end
     end

data/lib/reek/smells/smell_detector.rb

@@ -55,6 +55,12 @@ module Reek
         context.matches?(value(EXCLUDE_KEY, context, DEFAULT_EXCLUDE_SET))
       end
 
+      def self.todo_configuration_for(smells)
+        default_exclusions = default_config.fetch 'exclude'
+        exclusions = default_exclusions + smells.map(&:context)
+        { smell_type => { 'exclude' => exclusions.uniq } }
+      end
+
       private
 
       attr_accessor :smells_found

data/lib/reek/smells/smell_warning.rb

@@ -63,6 +63,10 @@ module Reek
         "#{smell_type}: #{context} #{message}"
       end
 
+      def smell_class
+        smell_detector.class
+      end
+
       protected
 
       def sort_key

data/lib/reek/version.rb

@@ -7,6 +7,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.0.2'.freeze
+    STRING = '4.0.3'.freeze
   end
 end

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

@@ -3,6 +3,11 @@ require_lib 'reek/cli/command/todo_list_command'
 require_lib 'reek/cli/options'
 
 RSpec.describe Reek::CLI::Command::TodoListCommand do
+  let(:nil_check) { build :smell_detector, smell_type: :NilCheck }
+  let(:feature_envy) { build :smell_detector, smell_type: :FeatureEnvy }
+  let(:nested_iterators) { build :smell_detector, smell_type: :NestedIterators }
+  let(:too_many_statements) { build :smell_detector, smell_type: :TooManyStatements }
+
   describe '#execute' do
     let(:options) { Reek::CLI::Options.new [] }
     let(:configuration) { double 'configuration' }
@@ -24,7 +29,7 @@ RSpec.describe Reek::CLI::Command::TodoListCommand do
 
     context 'smells found' do
       before do
-        smells = [FactoryGirl.build(:smell_warning)]
+        smells = [build(:smell_warning, context: 'Foo#bar')]
         allow(command).to receive(:scan_for_smells).and_return(smells)
       end
 
@@ -37,6 +42,61 @@ RSpec.describe Reek::CLI::Command::TodoListCommand do
         result = command.execute
         expect(result).to eq(Reek::CLI::Options::DEFAULT_SUCCESS_EXIT_CODE)
       end
+
+      it 'writes a todo file' do
+        command.execute
+        expected_yaml = { 'FeatureEnvy' => { 'exclude' => ['Foo#bar'] } }.to_yaml
+        expect(File).to have_received(:write).with(described_class::FILE_NAME, expected_yaml)
+      end
+    end
+
+    context 'smells with duplicate context found' do
+      before do
+        smells = [
+          build(:smell_warning, context: 'Foo#bar', smell_detector: feature_envy),
+          build(:smell_warning, context: 'Foo#bar', smell_detector: feature_envy)
+        ]
+        allow(command).to receive(:scan_for_smells).and_return(smells)
+      end
+
+      it 'writes the context into the todo file once' do
+        command.execute
+        expected_yaml = { 'FeatureEnvy' => { 'exclude' => ['Foo#bar'] } }.to_yaml
+        expect(File).to have_received(:write).with(described_class::FILE_NAME, expected_yaml)
+      end
+    end
+
+    context 'smells with default exclusions found' do
+      let(:smell) { build :smell_warning, smell_detector: too_many_statements, context: 'Foo#bar' }
+
+      before do
+        allow(command).to receive(:scan_for_smells).and_return [smell]
+      end
+
+      it 'includes the default exclusions in the generated yaml' do
+        command.execute
+        expected_yaml = { 'TooManyStatements' => { 'exclude' => ['initialize', 'Foo#bar'] } }.to_yaml
+        expect(File).to have_received(:write).with(described_class::FILE_NAME, expected_yaml)
+      end
+    end
+
+    context 'smells of different types found' do
+      before do
+        smells = [
+          build(:smell_warning, context: 'Foo#bar', smell_detector: nil_check),
+          build(:smell_warning, context: 'Bar#baz', smell_detector: nested_iterators)
+        ]
+        allow(command).to receive(:scan_for_smells).and_return(smells)
+      end
+
+      it 'writes the context into the todo file once' do
+        command.execute
+        expected_yaml = {
+          'NilCheck' => { 'exclude' => ['Foo#bar'] },
+          'NestedIterators' => { 'exclude' => ['Bar#baz'] }
+        }.to_yaml
+        expect(File).to have_received(:write).with(described_class::FILE_NAME, expected_yaml)
+      end
     end
 
     context 'no smells found' do
@@ -53,13 +113,10 @@ RSpec.describe Reek::CLI::Command::TodoListCommand do
         result = command.execute
         expect(result).to eq Reek::CLI::Options::DEFAULT_SUCCESS_EXIT_CODE
       end
-    end
 
-    describe 'groups_for' do
-      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)
+      it 'does not write a todo file' do
+        command.execute
+        expect(File).not_to have_received(:write)
       end
     end
   end

data/spec/reek/smells/smell_detector_spec.rb

@@ -0,0 +1,36 @@
+require_relative '../../spec_helper'
+require_lib 'reek/smells/smell_detector'
+
+RSpec.describe Reek::Smells::SmellDetector do
+  describe '.todo_configuration_for' do
+    it 'returns exclusion configuration for the given smells' do
+      detector = described_class.new
+      smell = create(:smell_warning, smell_detector: detector, context: 'Foo#bar')
+      result = described_class.todo_configuration_for([smell])
+      expect(result).to eq('SmellDetector' => { 'exclude' => ['Foo#bar'] })
+    end
+
+    it 'merges identical contexts' do
+      detector = described_class.new
+      smell = create(:smell_warning, smell_detector: detector, context: 'Foo#bar')
+      result = described_class.todo_configuration_for([smell, smell])
+      expect(result).to eq('SmellDetector' => { 'exclude' => ['Foo#bar'] })
+    end
+
+    context 'with default exclusions present' do
+      let(:subclass) { Reek::Smells::TooManyStatements }
+
+      before do
+        expect(subclass.default_config['exclude']).to eq ['initialize']
+      end
+
+      it 'includes default exclusions' do
+        detector = subclass.new
+        smell = create(:smell_warning, smell_detector: detector, context: 'Foo#bar')
+        result = subclass.todo_configuration_for([smell])
+
+        expect(result).to eq('TooManyStatements' => { 'exclude' => ['initialize', 'Foo#bar'] })
+      end
+    end
+  end
+end

data/spec/reek/smells/smell_warning_spec.rb

@@ -5,6 +5,7 @@ RSpec.describe Reek::Smells::SmellWarning do
   let(:duplication_detector)  { build(:smell_detector, smell_type: 'DuplicateMethodCall') }
   let(:feature_envy_detector) { build(:smell_detector, smell_type: 'FeatureEnvy') }
   let(:utility_function_detector) { build(:smell_detector, smell_type: 'UtilityFunction') }
+  let(:uncommunicative_name_detector) { build(:smell_detector, smell_type: 'UncommunicativeVariableName') }
 
   context 'sort order' do
     shared_examples_for 'first sorts ahead of second' do
@@ -65,16 +66,12 @@ RSpec.describe Reek::Smells::SmellWarning do
 
     context 'smells differing everywhere' do
       let(:first) do
-        duplication_detector = build(:smell_detector,
-                                     smell_type: 'DuplicateMethodCall')
         build(:smell_warning, smell_detector: duplication_detector,
                               context: 'Dirty#a',
                               message: 'calls @s.title twice')
       end
 
       let(:second) do
-        uncommunicative_name_detector = build(:smell_detector,
-                                              smell_type: 'UncommunicativeVariableName')
         build(:smell_warning, smell_detector: uncommunicative_name_detector,
                               context: 'Dirty',
                               message: "has the variable name '@s'")
@@ -84,6 +81,13 @@ RSpec.describe Reek::Smells::SmellWarning do
     end
   end
 
+  describe '#smell_class' do
+    it "returns the dectector's class" do
+      warning = build(:smell_warning, smell_detector: duplication_detector)
+      expect(warning.smell_class).to eq duplication_detector.class
+    end
+  end
+
   context '#yaml_hash' do
     let(:class) { 'FeatureEnvy' }
     let(:context_name) { 'Module::Class#method/block' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-23 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -159,7 +159,6 @@ 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
@@ -319,6 +318,7 @@ files:
 - spec/reek/smells/repeated_conditional_spec.rb
 - spec/reek/smells/smell_configuration_spec.rb
 - spec/reek/smells/smell_detector_shared.rb
+- spec/reek/smells/smell_detector_spec.rb
 - spec/reek/smells/smell_repository_spec.rb
 - spec/reek/smells/smell_warning_spec.rb
 - spec/reek/smells/too_many_instance_variables_spec.rb

data/features/step_definitions/todo_list_steps.rb

@@ -1,40 +0,0 @@
-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