reek 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e1bd0b5a333788b75250144a86c3a1a47a915bb
-  data.tar.gz: b9077da5e1add357ca2411a983cccaef9f754ab5
+  metadata.gz: 6edbc24f9dc5d13f418d60c9fbcadd30e8ac433c
+  data.tar.gz: f0fdcaa7d1a6dc702f24763f62a44367a7004365
 SHA512:
-  metadata.gz: b7c6ea853eabe8c9d2b090bd12c679bf5a95723b9009d48b35e641c106126697e3ad53ed4121b7540ee5d9bf8fe6e95c269bb90f7b16cfb25ea049953f9b2e26
-  data.tar.gz: 2b2cc32734fa88f97792cae488fae2e210981920b53626b3041f3e88846e856cf54e8ad26e8d430992cbb4f3b0fdc6be0f4653cc51dc2528655efda4b2cd7db2
+  metadata.gz: aa7cad97b7d6108cf2c8f813adf0dc72258f64aab8645eacbb5854146614a6afa6d35951e950187d967007abeefe38eebd5af468f005d551929a73115e7cbe00
+  data.tar.gz: 4a04b1a57046145c006322cb6d34db5bcd970cceef1834a539209dfe2c2469c1b4d05359e5e3393dd8084f3f605af25dd2aaafaecb6212cf680587a267326e2d

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 5.2.0 (2018-10-13)
+
+* (troessner) Enable exclusion of single files.
+
 ## 5.1.0 (2018-09-22)
 
 * (troessner) Simplify todo list feature.

data/CONTRIBUTING.md

@@ -89,6 +89,14 @@ class Alfa
 end
 ```
 
+We also aim to make our specs as self-reliant as possible. They should not rely on external sample
+or configuration files since that makes it very hard to reason about them and introduces a tight coupling
+which makes refactoring more difficult.
+Unfortunately our current specs are a bit misleading in this regard since they are often doing the
+opposite, relying on external sample and configuration files (indicated by using
+some of the constants defined in `samples/paths.rb`).
+Our goal is to reverse this development.
+
 ### Cucumber Features
 
 Reek uses [Cucumber](https://cucumber.io/) with

data/Gemfile

@@ -12,7 +12,7 @@ group :development do
   gem 'kramdown',        '~> 1.17'
   gem 'rake',            '~> 12.0'
   gem 'rspec',           '~> 3.0'
-  gem 'rspec-benchmark', '~> 0.3.0'
+  gem 'rspec-benchmark', '~> 0.4.0'
   gem 'rubocop',         '~> 0.59.1'
   gem 'rubocop-rspec',   '~> 1.29.0'
   gem 'simplecov',       '~> 0.16.1'

data/README.md

@@ -324,10 +324,11 @@ directories:
 
 ### Excluding directories
 
-# Directories below will not be scanned at all
+# Directories and files below will not be scanned at all
 exclude_paths:
   - lib/legacy
   - lib/rake/legacy_tasks
+  - lib/smelly.rb  
 ```
 
 As you see above, Reek's configuration consists of 3 different sections denoted by 3 different keys:
@@ -582,6 +583,9 @@ directories:
   "app/mailers":
     InstanceVariableAssumption:
       enabled: false
+  "app/models":
+    InstanceVariableAssumption:
+      enabled: false
 ```
 
 Be careful though, Reek does not merge your configuration entries, so if you already have a directory directive for "app/controllers" or "app/helpers" you need to update those directives instead of copying the above YAML sample into your configuration file.

data/docs/Instance-Variable-Assumption.md

@@ -129,6 +129,35 @@ An instance variable must:
 
 If not, _Instance Variable Assumption_ will be reported.
 
+## Using Instance Variable Assumption in a Rails context
+
+In ActiveRecord it seems common to use callbacks like `after_initialize` to initialize instance variables as
+outlined [here](https://stackoverflow.com/questions/41165520/overriding-applicationrecord-initialize-bad-idea)
+or [here](http://blog.dalethatcher.com/2008/03/rails-dont-override-initialize-on.html)
+instead of overriding the `initialize` method.
+If an instance variable is initialized in such a callback Reek will report it correspondingly.
+
+This would smell for instance:
+
+```Ruby
+class Sample < ApplicationRecord
+  after_initialize do
+    @my_var = false
+  end
+end
+```
+
+Since Reek cannot reliably detect that is used in a Rails context we recommend to disable this detector
+for "app/models" like this:
+
+```Yaml
+directories:
+  # Your other configuration....
+  "app/models":
+    InstanceVariableAssumption:
+      enabled: false
+```
+
 ## Configuration
 
 _Instance Variable Assumption_ supports the [Basic Smell Options](Basic-Smell-Options.md).

data/features/command_line_interface/options.feature

@@ -43,7 +43,7 @@ Feature: Reek can be controlled using command-line options
           -c, --config FILE                Read configuration options from FILE
               --smell SMELL                Only look for a specific smell.
                                            Call it like this: reek --smell MissingSafeMethod source.rb
-                                           Check out https://github.com/troessner/reek/blob/v5.1.0/docs/Code-Smells.md for a list of smells
+                                           Check out https://github.com/troessner/reek/blob/v5.2.0/docs/Code-Smells.md for a list of smells
               --stdin-filename FILE        When passing code in via pipe, assume this filename when checking file or directory rules in the config.
 
       Generate a todo list:
@@ -120,5 +120,5 @@ Feature: Reek can be controlled using command-line options
       UnusedPrivateMethod
       UtilityFunction
 
-      Check out https://github.com/troessner/reek/blob/v5.1.0/docs/Code-Smells.md for a details on each detector
+      Check out https://github.com/troessner/reek/blob/v5.2.0/docs/Code-Smells.md for a details on each detector
       """

data/features/configuration_files/exclude_paths_directives.feature

@@ -3,25 +3,24 @@ Feature: Exclude paths directives
   As a user
   I want to be able to exclude specific paths from being checked
 
-  Scenario: Exclude some paths
-    Given a file named "bad_files_live_here/smelly.rb" with:
-      """
-      # A smelly example class
-      class Smelly
-        def alfa(bravo); end
-      end
-      """
+  Scenario: Exclude paths
+    Given the smelly file "smelly.rb" in the directory "smelly_sources"
+    And the smelly file "smelly.rb" in the directory "smelly_as_well"
+    And the smelly file "smelly.rb" in the directory "smelly_as_well_2"
     When I run reek .
     Then the exit status indicates smells
     Given a file named "config.reek" with:
       """
       ---
       exclude_paths:
-        - bad_files_live_here
+        - smelly_sources/smelly.rb
+        - smelly_as_well/
+        - smelly_as_well_2
       """
     When I run reek -c config.reek .
     Then it succeeds
     And it reports nothing
+
   Scenario: Using a file name within an excluded directory
     Given a file named "bad_files_live_here/smelly.rb" with:
       """

data/features/configuration_files/schema_validation.feature

@@ -35,8 +35,8 @@ Feature: Validate schema
 
     exclude_paths:
       - lib/legacy
-      - lib/rake/legacy_tasks
     """
+    And a directory named "lib/legacy"
     And the clean file "clean.rb"
     When I run reek -c config.reek clean.rb
     Then it succeeds

data/features/reports/json.feature

@@ -24,7 +24,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 4 ],
               "message": "has the name 'x'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Method-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Method-Name.md",
               "name": "x"
           },
           {
@@ -33,7 +33,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 5 ],
               "message": "has the variable name 'y'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Variable-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Variable-Name.md",
               "name": "y"
           }
       ]
@@ -53,7 +53,7 @@ Feature: Report smells using simple JSON layout
                   1
               ],
               "message": "has no descriptive comment",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.1.0/docs/Irresponsible-Module.md"
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.2.0/docs/Irresponsible-Module.md"
           }
       ]
       """

data/features/reports/reports.feature

@@ -182,8 +182,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Method-Name.md]
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Variable-Name.md]
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:
@@ -209,8 +209,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Method-Name.md]
-        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Variable-Name.md]
+        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Method-Name.md]
+        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:

data/features/reports/yaml.feature

@@ -25,7 +25,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeMethodName
         source: smelly.rb
         name: x
-        documentation_link: https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Method-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Method-Name.md
       - context: Smelly#x
         lines:
         - 5
@@ -33,7 +33,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeVariableName
         source: smelly.rb
         name: y
-        documentation_link: https://github.com/troessner/reek/blob/v5.1.0/docs/Uncommunicative-Variable-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.2.0/docs/Uncommunicative-Variable-Name.md
       """
 
   Scenario: Indicate smells and print them as yaml when using STDIN
@@ -48,5 +48,5 @@ Feature: Report smells using simple YAML layout
         lines:
         - 1
         message: has no descriptive comment
-        documentation_link: https://github.com/troessner/reek/blob/v5.1.0/docs/Irresponsible-Module.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.2.0/docs/Irresponsible-Module.md
       """

data/features/step_definitions/sample_file_steps.rb

@@ -4,6 +4,12 @@ Given(/^the smelly file '(.+)'$/) do |filename|
   write_file(filename, SAMPLES_DIR.join('smelly_source').join(filename).read)
 end
 
+Given(/^the smelly file "(.+)" in the directory "(.+)"$/) do |filename, directory|
+  FileUtils.mkdir_p directory
+  write_file Pathname(directory).join(filename).to_s,
+             SAMPLES_DIR.join('smelly_source').join(filename).read
+end
+
 Given(/^the clean file "(.*)"$/) do |filename|
   write_file(filename, CLEAN_FILE.read)
 end

data/lib/reek/configuration/excluded_paths.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative './configuration_validator'
+require_relative '../errors/config_file_error'
 
 module Reek
   module Configuration
@@ -10,11 +11,10 @@ module Reek
     module ExcludedPaths
       include ConfigurationValidator
 
-      # @quality :reek:NestedIterators { max_allowed_nesting: 2 }
+      # @param paths [String]
+      # @return [undefined]
       def add(paths)
-        paths.each do |path|
-          with_valid_directory(path) { |directory| self << directory }
-        end
+        paths.each { |path| self << Pathname(path) }
       end
     end
   end

data/lib/reek/source/source_locator.rb

@@ -59,6 +59,8 @@ module Reek
 
             false
           end
+        elsif path_excluded?(path)
+          true
         else
           false
         end

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '5.1.0'
+    STRING = '5.2.0'
   end
 end

data/samples/configuration/with_excluded_paths.reek

@@ -2,3 +2,4 @@
 exclude_paths:
   - samples/source_with_exclude_paths/ignore_me/
   - samples/source_with_exclude_paths/nested/ignore_me_as_well
+  - samples/source_with_exclude_paths/nested/uncommunicative_parameter_name.rb

data/samples/source_with_exclude_paths/nested/uncommunicative_variable_name.rb

@@ -0,0 +1,6 @@
+# Klass comment.
+class Klass
+  def meth
+    x = 5
+  end
+end

data/spec/reek/configuration/app_configuration_spec.rb

@@ -7,48 +7,65 @@ require_lib 'reek/configuration/excluded_paths'
 
 RSpec.describe Reek::Configuration::AppConfiguration do
   describe 'factory methods' do
-    let(:expected_excluded_paths) do
-      [SAMPLES_DIR.join('two_smelly_files'),
-       SAMPLES_DIR.join('source_with_non_ruby_files')]
-    end
-
-    let(:expected_default_directive) do
-      { Reek::SmellDetectors::IrresponsibleModule => { 'enabled' => false } }
+    around do |example|
+      Dir.mktmpdir('/tmp') do |tmp|
+        Dir.chdir(tmp) do
+          example.run
+        end
+      end
     end
 
-    let(:expected_directory_directives) do
-      { SAMPLES_DIR.join('three_clean_files') =>
-        { Reek::SmellDetectors::UtilityFunction => { 'enabled' => false } } }
+    let(:expected_exclude_file_names) do
+      %w(exclude_me.rb exclude_me_too.rb)
     end
 
-    let(:default_directive_value) do
-      { Reek::DETECTORS_KEY =>
-        { 'IrresponsibleModule' => { 'enabled' => false } } }
+    let(:expected_exclude_directories) do
+      %w(directory_with_trailing_slash/ directory_without_trailing_slash)
     end
 
-    let(:directory_directives_value) do
-      { Reek::DIRECTORIES_KEY =>
-        { 'samples/three_clean_files' =>
-          { 'UtilityFunction' => { 'enabled' => false } } } }
+    let(:expected_excluded_paths) do
+      (expected_exclude_file_names + expected_exclude_directories).map { |path| Pathname(path) }
     end
 
-    let(:exclude_paths_value) do
-      { Reek::EXCLUDE_PATHS_KEY =>
-        ['samples/two_smelly_files',
-         'samples/source_with_non_ruby_files'] }
+    let(:expected_default_directive) do
+      { Reek::SmellDetectors::IrresponsibleModule => { 'enabled' => false } }
     end
 
-    let(:combined_value) do
-      directory_directives_value.
-        merge(default_directive_value).
-        merge(exclude_paths_value)
+    let(:expected_directory_directives) do
+      { Pathname('directory_with_some_ruby_files') =>
+        { Reek::SmellDetectors::UtilityFunction => { 'enabled' => false } } }
     end
 
     describe '#from_path' do
-      let(:full_configuration_path) { CONFIGURATION_DIR.join('full_configuration.reek') }
+      let(:configuration_path) { 'config.reek' }
+      let(:configuration) do
+        <<-EOF.strip_heredoc
+        ---
+        detectors:
+          IrresponsibleModule:
+            enabled: false
+
+        directories:
+          "directory_with_some_ruby_files":
+            UtilityFunction:
+              enabled: false
+
+        exclude_paths:
+          - "exclude_me.rb"
+          - "exclude_me_too.rb"
+          - "directory_with_trailing_slash/"
+          - "directory_without_trailing_slash"
+        EOF
+      end
+
+      before do
+        File.write configuration_path, configuration
+        FileUtils.touch expected_exclude_file_names
+        FileUtils.mkdir expected_exclude_directories
+      end
 
       it 'properly loads configuration and processes it' do
-        config = described_class.from_path full_configuration_path
+        config = described_class.from_path configuration_path
 
         expect(config.send(:excluded_paths)).to eq(expected_excluded_paths)
         expect(config.send(:default_directive)).to eq(expected_default_directive)
@@ -57,6 +74,32 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
 
     describe '#from_hash' do
+      before do
+        FileUtils.touch expected_exclude_file_names
+        FileUtils.mkdir expected_exclude_directories
+      end
+
+      let(:default_directive_value) do
+        { Reek::DETECTORS_KEY =>
+            { 'IrresponsibleModule' => { 'enabled' => false } } }
+      end
+
+      let(:directory_directives_value) do
+        { Reek::DIRECTORIES_KEY =>
+            { 'directory_with_some_ruby_files' =>
+                { 'UtilityFunction' => { 'enabled' => false } } } }
+      end
+
+      let(:exclude_paths_value) do
+        { Reek::EXCLUDE_PATHS_KEY => (expected_exclude_file_names + expected_exclude_directories) }
+      end
+
+      let(:combined_value) do
+        directory_directives_value.
+          merge(default_directive_value).
+          merge(exclude_paths_value)
+      end
+
       it 'sets the configuration a unified simple data structure' do
         config = described_class.from_hash(combined_value)
 
@@ -79,7 +122,7 @@ RSpec.describe Reek::Configuration::AppConfiguration do
 
   describe '#directive_for' do
     context 'with multiple directory directives and no default directive present' do
-      let(:source_via) { 'samples/three_clean_files/dummy.rb' }
+      let(:source_via) { 'samples/some_files/dummy1.rb' }
       let(:baz_config)  { { IrresponsibleModule: { enabled: false } } }
       let(:bang_config) { { Attribute: { enabled: true } } }
       let(:expected_result) { { Reek::SmellDetectors::Attribute => { enabled: true } } }
@@ -87,8 +130,8 @@ RSpec.describe Reek::Configuration::AppConfiguration do
       let(:directory_directives) do
         { Reek::DIRECTORIES_KEY =>
           {
-            'samples/two_smelly_files' => baz_config,
-            'samples/three_clean_files' => bang_config
+            'samples/some_files' => bang_config,
+            'samples/other_files' => baz_config
           } }
       end
 
@@ -124,7 +167,7 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
 
     context 'with a path not covered by a directory directive but a default directive present' do
-      let(:source_via) { 'spec/samples/three_clean_files/dummy.rb' }
+      let(:source_via) { 'samples/some_files/dummy.rb' }
 
       let(:configuration_as_hash) do
         {
@@ -132,7 +175,7 @@ RSpec.describe Reek::Configuration::AppConfiguration do
             IrresponsibleModule: { enabled: false }
           },
           Reek::DIRECTORIES_KEY =>
-            { 'spec/samples/two_smelly_files' => { Attribute: { enabled: false } } }
+            { 'samples/other_files' => { Attribute: { enabled: false } } }
         }
       end
 

data/spec/reek/configuration/excluded_paths_spec.rb

@@ -5,15 +5,12 @@ require_lib 'reek/configuration/excluded_paths'
 RSpec.describe Reek::Configuration::ExcludedPaths do
   describe '#add' do
     let(:exclusions) { [].extend(described_class) }
+    let(:paths) { ['smelly/sources'] }
+    let(:expected_exclude_paths) { [Pathname('smelly/sources')] }
 
-    context 'when one of given paths is a file' do
-      let(:smelly_source_dir) { SAMPLES_DIR.join('smelly_source') }
-      let(:file_as_path) { smelly_source_dir.join('inline.rb') }
-      let(:paths) { [smelly_source_dir, file_as_path] }
-
-      it 'raises an error if one of the given paths is a file' do
-        expect { exclusions.add(paths) }.to raise_error(Reek::Errors::ConfigFileError)
-      end
+    it 'adds the given paths as Pathname' do
+      exclusions.add(paths)
+      expect(exclusions).to eq expected_exclude_paths
     end
   end
 end

data/spec/reek/source/source_locator_spec.rb

@@ -92,17 +92,18 @@ RSpec.describe Reek::Source::SourceLocator do
         end
       end
 
-      context 'when path is a directory' do
+      context 'when path is a directory or a file' do
         let(:path) { SAMPLES_DIR.join('source_with_exclude_paths') }
 
         let(:expected_paths) do
-          [path.join('nested/uncommunicative_parameter_name.rb')]
+          [path.join('nested/uncommunicative_variable_name.rb')]
         end
 
         let(:paths_that_are_expected_to_be_ignored) do
           [
             path.join('ignore_me/uncommunicative_method_name.rb'),
-            path.join('nested/ignore_me_as_well/irresponsible_module.rb')
+            path.join('nested/ignore_me_as_well/irresponsible_module.rb'),
+            path.join('nested/uncommunicative_parameter_name.rb')
           ]
         end
 
@@ -111,7 +112,7 @@ RSpec.describe Reek::Source::SourceLocator do
           expect(sources).not_to include(*paths_that_are_expected_to_be_ignored)
         end
 
-        it 'scans directories that are not excluded' do
+        it 'scans directories and files that are not excluded' do
           sources = described_class.new([path], configuration: configuration).sources
           expect(sources).to eq expected_paths
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-22 00:00:00.000000000 Z
+date: 2018-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -367,6 +367,7 @@ files:
 - samples/source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb
 - samples/source_with_exclude_paths/nested/ignore_me_as_well/irresponsible_module.rb
 - samples/source_with_exclude_paths/nested/uncommunicative_parameter_name.rb
+- samples/source_with_exclude_paths/nested/uncommunicative_variable_name.rb
 - samples/source_with_hidden_directories/.hidden/hidden.rb
 - samples/source_with_hidden_directories/not_hidden.rb
 - samples/source_with_non_ruby_files/gibberish