reek 5.0.2 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bcb2aafdd323d869bc486bfde721dfa290d8faa
-  data.tar.gz: 1a63a1bbaadcd3ae873a85f8560024124aeddf5b
+  metadata.gz: 3e1bd0b5a333788b75250144a86c3a1a47a915bb
+  data.tar.gz: b9077da5e1add357ca2411a983cccaef9f754ab5
 SHA512:
-  metadata.gz: b812c771f685ac34d1c6c240ca259b467cb9a19db49264aef1340118e74f62053113313ebcf644177d37600a70d205f2215378b9f7bb3a8f51d137b20e5d534c
-  data.tar.gz: 80769603222b66562779e6690d35931eae51504eadd3fda1fce2764dcd9f9d54f2b6b26cce9a5503ba07e13239df75b4a5cecae936768fafad294d1699bbadf7
+  metadata.gz: b7c6ea853eabe8c9d2b090bd12c679bf5a95723b9009d48b35e641c106126697e3ad53ed4121b7540ee5d9bf8fe6e95c269bb90f7b16cfb25ea049953f9b2e26
+  data.tar.gz: 2b2cc32734fa88f97792cae488fae2e210981920b53626b3041f3e88846e856cf54e8ad26e8d430992cbb4f3b0fdc6be0f4653cc51dc2528655efda4b2cd7db2

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 require:
   - rubocop-rspec
 
@@ -45,37 +47,11 @@ Lint/InterpolationCheck:
 Lint/BooleanSymbol:
   Enabled: false
 
-Lint/HandleExceptions:
-  Exclude:
-    - 'spec/reek/configuration/configuration_file_finder_spec.rb'
-
 # Spec blocks can be any size
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
-# FIXME: Make the class shorter
-Metrics/ClassLength:
-  Exclude:
-    - lib/reek/context_builder.rb
-    - lib/reek/cli/options.rb
-
-Style/SafeNavigation:
-  Exclude:
-    - lib/reek/ast/node.rb
-    - lib/reek/ast/sexp_extensions/module.rb
-
-# FIXME: Lower the method length by fixing the biggest offenders
-Metrics/MethodLength:
-  Max: 15
-  Exclude:
-    - 'lib/reek/cli/options.rb'
-
-Metrics/AbcSize:
-  Exclude:
-    - 'lib/reek/cli/options.rb'
-    - 'lib/reek/configuration/configuration_converter.rb'
-
 # Be rather lenient with line length
 Metrics/LineLength:
   Max: 120
@@ -84,56 +60,21 @@ Metrics/LineLength:
 Metrics/ParameterLists:
   CountKeywordArgs: false
 
-Naming/AccessorMethodName:
-  Exclude:
-    - 'lib/reek/context/visibility_tracker.rb'
-
 # EOS is a fine name to use in our specs
 Naming/HeredocDelimiterNaming:
   Exclude:
     - 'spec/**/*'
 
-# FIXME: Update specs to avoid offenses
-RSpec/AnyInstance:
-  Exclude:
-    - 'spec/reek/cli/application_spec.rb'
-
-# This file does not test a class
+# These files do not test classes or modules
 RSpec/DescribeClass:
   Exclude:
-    - 'spec/quality/reek_source_spec.rb'
+    - 'spec/quality/*_spec.rb'
+    - 'spec/performance/reek/smell_detectors/runtime_speed_spec.rb'
 
 # Our examples are large because we have source literals in them
 RSpec/ExampleLength:
   Enabled: false
 
-# FIXME: Split up files to avoid offenses
-RSpec/MultipleDescribes:
-  Exclude:
-    - 'spec/reek/ast/sexp_extensions_spec.rb'
-    - 'spec/reek/code_comment_spec.rb'
-    - 'spec/reek/report/location_formatter_spec.rb'
-    - 'spec/reek/report/progress_formatter_spec.rb'
-
-# FIXME: Update specs to avoid offenses
-RSpec/MultipleExpectations:
-  Exclude:
-    - 'spec/reek/cli/application_spec.rb'
-    - 'spec/reek/code_comment_spec.rb'
-    - 'spec/reek/configuration/app_configuration_spec.rb'
-    - 'spec/reek/context/module_context_spec.rb'
-    - 'spec/reek/context_builder_spec.rb'
-    - 'spec/reek/examiner_spec.rb'
-    - 'spec/reek/spec/should_reek_of_spec.rb'
-
-# FIXME: Update specs to avoid offenses
-RSpec/NestedGroups:
-  Exclude:
-    - 'spec/reek/report/code_climate/code_climate_fingerprint_spec.rb'
-    - 'spec/reek/cli/application_spec.rb'
-    - 'spec/reek/configuration/schema_validator_spec.rb'
-    - 'spec/reek/configuration/configuration_file_finder_spec.rb'
-
 # rubocop-rspec expects a CodeClimate namespace to go with the code_climate directory.
 RSpec/FilePath:
   Exclude:
@@ -146,12 +87,6 @@ RSpec/FilePath:
 Style/AndOr:
   EnforcedStyle: conditionals
 
-Style/Documentation:
-  Exclude:
-    - 'lib/reek/ast/sexp_extensions/send.rb'
-    - 'lib/reek/ast/sexp_extensions/super.rb'
-    - 'lib/reek/ast/sexp_extensions/variables.rb'
-
 # Require comment for files in lib and bin
 Style/FrozenStringLiteralComment:
   Include:
@@ -190,3 +125,7 @@ Style/SymbolArray:
 # Allow small arrays of words with quotes
 Style/WordArray:
   MinSize: 4
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/reek/cli/options.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,63 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-08-17 12:44:20 +0200 using RuboCop version 0.58.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 21
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 178
+
+# Offense count: 12
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 16
+
+# Offense count: 2
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/reek/cli/application_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: CustomIncludeMethods.
+RSpec/EmptyExampleGroup:
+  Exclude:
+    - 'spec/factories/factories.rb'
+
+# Offense count: 1
+RSpec/MissingExampleGroupArgument:
+  Exclude:
+    - 'spec/factories/factories.rb'
+
+# Offense count: 4
+RSpec/MultipleDescribes:
+  Exclude:
+    - 'spec/reek/ast/sexp_extensions_spec.rb'
+    - 'spec/reek/code_comment_spec.rb'
+    - 'spec/reek/report/location_formatter_spec.rb'
+    - 'spec/reek/report/progress_formatter_spec.rb'
+
+# Offense count: 32
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 5
+
+# Offense count: 23
+RSpec/NestedGroups:
+  Max: 5
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, Whitelist.
+# Whitelist: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/reek/ast/node.rb'
+    - 'lib/reek/ast/sexp_extensions/module.rb'

data/.simplecov

@@ -2,10 +2,13 @@ SimpleCov.start do
   track_files 'lib/**/*.rb'
   add_filter 'lib/reek/version.rb' # version.rb is loaded too early to test
   add_filter 'lib/reek/cli/options.rb' # tested mostly via integration tests
+  add_filter 'spec/'
+  add_filter 'samples/'
+  coverage_dir 'tmp/coverage'
 end
 
 SimpleCov.at_exit do
   SimpleCov.result.format!
-  SimpleCov.minimum_coverage 98.9
+  SimpleCov.minimum_coverage 98.88
   SimpleCov.minimum_coverage_by_file 81.4
 end

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 5.1.0 (2018-09-22)
+
+* (troessner) Simplify todo list feature.
+* (troessner) Show configuration path.
+
 ## 5.0.2 (2018-07-10)
 
 * (mvz) Parser 2.5.1.1 seems broken. Disallow it.

data/Gemfile

@@ -5,20 +5,18 @@ gemspec
 ruby RUBY_VERSION
 
 group :development do
-  gem 'activesupport', '>= 4.2'
-  gem 'aruba',         '~> 0.14.0'
-  gem 'ataru',         '~> 0.2.0'
-  gem 'cucumber',      '~> 3.0'
-  gem 'factory_bot',   '~> 4.0'
-  gem 'rake',          '~> 12.0'
-  gem 'rspec',         '~> 3.0'
-  gem 'simplecov',     '~> 0.16.1'
-  gem 'yard',          '~> 0.9.5'
-
-  if RUBY_VERSION >= '2.3'
-    gem 'rubocop',       '~> 0.57.1'
-    gem 'rubocop-rspec', '~> 1.20'
-  end
+  gem 'activesupport',   '>= 4.2'
+  gem 'aruba',           '~> 0.14.0'
+  gem 'cucumber',        '~> 3.0'
+  gem 'factory_bot',     '~> 4.0'
+  gem 'kramdown',        '~> 1.17'
+  gem 'rake',            '~> 12.0'
+  gem 'rspec',           '~> 3.0'
+  gem 'rspec-benchmark', '~> 0.3.0'
+  gem 'rubocop',         '~> 0.59.1'
+  gem 'rubocop-rspec',   '~> 1.29.0'
+  gem 'simplecov',       '~> 0.16.1'
+  gem 'yard',            '~> 0.9.5'
 
   platforms :mri do
     gem 'redcarpet', '~> 3.4.0'
@@ -26,11 +24,8 @@ group :development do
 end
 
 group :debugging do
-  # Fixing https://github.com/guard/guard/wiki/Add-Readline-support-to-Ruby-on-Mac-OS-X#option-4-using-a-pure-ruby-readline-implementation
   gem 'pry'
-  gem 'rb-readline', '~> 0.5.3'
   platforms :mri do
     gem 'pry-byebug'
-    gem 'pry-stack_explorer'
   end
 end

data/README.md

@@ -407,6 +407,16 @@ end
 
 This is an incredibly powerful feature and further explained under [Smell Suppresion](docs/Smell-Suppression.md).
 
+#### Debugging trouble with the configuration
+
+With Reeks dynamic mechanism of finding a configuration file you might run into a situation where you are not
+100% sure what configuration file Reek is using. E.g. you have a project specific configuration file in your
+project root and also another Reek configuration in your HOME directory that you use for all your other projects
+and for whatever reasons Reek seems to be using another configuration file than the one you assumed it would.
+
+In this case you can pass the flag `--show-configuration-path` to Reek which will cause Reek to output the path
+to the configuration file it is using.
+
 ### Generating a 'todo' list
 
 Integrating tools like Reek into an existing larger codebase can be daunting when you have to fix
@@ -420,29 +430,28 @@ suppress all smell warnings for the current codebase:
 reek --todo lib/
 ```
 
-This will create the file '.todo.reek' in your current working directory.
+This will create the file '.reek.yml' 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
+explicitly to use '.reek.yml' 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
+If for whatever reasons you decide to put '.reek.yml' 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/
+reek -c whatever/.reek.yml lib/
 ```
 
 It's important to understand that the number one use case of the `--todo` flag
 is to be run once at the beginning of the introduction of Reek to ease the transition.
-If you find yourself re-running Reek with the `--todo` flag in order to silence new warnings
+If you find yourself wanting to re-run Reek with the `--todo` flag in order to silence a lot of new warnings
 you're defeating the purpose of both the `--todo` flag and of Reek itself.
 
-As a consequence, running Reek with the `--todo` flag again will overwrite '.todo.reek' without
-asking (should not be a problem since this file is supposed to be versioned) and
-without taking **any** other configuration file you might have into account.
+As a consequence, running Reek with the `--todo` flag again will not overwrite an existing '.reek.yml'
+and instead abort execution. It also will not take **any** other configuration file you might have into account.
 
 This means that when you run
 
@@ -450,8 +459,10 @@ This means that when you run
 reek -c other_configuration.reek --todo lib/
 ```
 
-`other_configuration.reek` will simply be ignored (as outlined before, Reek
-is supposed to have one configuration file and one file only).
+`other_configuration.reek` will simply be ignored.
+
+Of course you can always just delete the existing .reek.yml file and then run Reek with the `--todo` flag
+but keep in mind that this is not the intended use case of this feature.
 
 ## Usage
 
@@ -492,16 +503,6 @@ bundle exec rake
 
 This will run the tests (RSpec and Cucumber), RuboCop and Reek itself.
 
-You can also run:
-
-```
-bundle exec rake ci
-```
-
-This will run everything the default task runs and also
-[Ataru](https://github.com/CodePadawans/ataru). This is the task that we run on
-Travis as well and that determines if your pull request is green or red.
-
 Another useful Rake task is the `console` task. This will throw you right into an environment where you can play around with Reeks modules and classes:
 
 ```
@@ -521,15 +522,6 @@ require 'pry'
 binding.pry
 ```
 
-If you do this, you need to also run the specs with `DEBUG=1` set, e.g.:
-
-```
-DEBUG=1 bundle exec rspec spec/your/file_spec.rb:23
-```
-
-This is necessary because normally all specs run with a timeout of 5 seconds,
-which isn't much if you're busy using Pry.
-
 Have a look at our [Developer API](docs/API.md) for more inspiration.
 
 From then on you should check out:

data/Rakefile

@@ -6,11 +6,11 @@ Dir['tasks/**/*.rake'].each { |t| load t }
 task :ci do
   [
     'test:spec',
+    'test:performance',
     'configuration:update_default_configuration',
     'test:features',
     :rubocop,
-    'test:quality',
-    :ataru
+    'test:quality'
   ].each do |name|
     puts "\n=== Running #{name}...\n"
     Rake::Task[name].invoke

data/docs/templates/default/docstring/setup.rb

@@ -1,6 +1,7 @@
 def init
   super
   return unless show_api_marker_section?
+
   if sections.first
     sections.first.place(:api_marker).before(:private)
   else
@@ -10,6 +11,7 @@ end
 
 def api_marker
   return if object.type == :root
+
   erb(:private) unless ['public', 'private'].include? api_text
 end
 
@@ -23,6 +25,7 @@ end
 
 def show_api_marker_section?
   return false if object.type == :root
+
   case api_text
   when 'public'
     false

data/features/command_line_interface/options.feature

@@ -20,7 +20,7 @@ Feature: Reek can be controlled using command-line options
     Then the exit status is 23
 
   Scenario: return given status code when using --success-exit-code
-    Given the clean file 'clean.rb'
+    Given the clean file "clean.rb"
     When I run reek clean.rb --success-exit-code 42
     Then the exit status is 42
 
@@ -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.0.2/docs/Code-Smells.md for a list of smells
+                                           Check out https://github.com/troessner/reek/blob/v5.1.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:
@@ -62,6 +62,8 @@ Feature: Reek can be controlled using command-line options
               --[no-]color                 Use colors for the output (default: true)
           -V, --[no-]empty-headings        Show headings for smell-free source files (default: false)
           -U, --[no-]documentation         Show link to related documentation page for each smell (default: true)
+              --[no-]show-configuration-path
+                                           Show which configuration file Reek is using (default: false)
           -n, --[no-]line-numbers          Show line numbers in the output (default: true)
           -s, --single-line                Show location in editor-compatible single-line-per-smell format
           -P, --[no-]progress              Show progress of each source as it is examined (default: true)
@@ -118,5 +120,5 @@ Feature: Reek can be controlled using command-line options
       UnusedPrivateMethod
       UtilityFunction
 
-      Check out https://github.com/troessner/reek/blob/v5.0.2/docs/Code-Smells.md for a details on each detector
+      Check out https://github.com/troessner/reek/blob/v5.1.0/docs/Code-Smells.md for a details on each detector
       """

data/features/configuration_files/schema_validation.feature

@@ -5,7 +5,7 @@ Feature: Validate schema
 
   Scenario: Our generated default configuration
     Given our default configuration file
-    And the clean file 'clean.rb'
+    And the clean file "clean.rb"
     When I run reek -c defaults.reek clean.rb
     Then it succeeds
     And it reports nothing
@@ -37,7 +37,7 @@ Feature: Validate schema
       - lib/legacy
       - lib/rake/legacy_tasks
     """
-    And the clean file 'clean.rb'
+    And the clean file "clean.rb"
     When I run reek -c config.reek clean.rb
     Then it succeeds
     And it reports nothing
@@ -50,7 +50,7 @@ Feature: Validate schema
       DoesNotExist:
         enabled: true
     """
-    And the clean file 'clean.rb'
+    And the clean file "clean.rb"
     When I run reek -c config.reek clean.rb
     Then the exit status indicates an error
     And stderr reports: