reek 4.4.1 → 4.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f4239287ce5d453034915801d47bd07738e0a09
-  data.tar.gz: 717f8ac8b8a9e0093a4aaa2ee9c5f739fd27be57
+  metadata.gz: 9726cb15a47090a670c986a90860b2ba22826416
+  data.tar.gz: 61c5759684ec24d5d0e7bd1e4d2e035a5263d25f
 SHA512:
-  metadata.gz: ccbb4be4cf7bb2d47ce72f5fd7d709ca3b3b4e49b95253aa549a14d62a7468a176c9b10cb1d21da9667963791c3f8eca66137e0f2dd03bd5507e65c94deb6953
-  data.tar.gz: 90eb9358f3f66271fa0a568e4582f9d473911723730a30e1b9de7771e5f79381832be59c3d511ddae81c614d772d67a6e49a07ddece6de756f482663976ee5ea
+  metadata.gz: ee0920b75d4b8be3d47940587f97aea414a0eb9faa83b2871d1d8627021c155674e108746a74588357f576b0d2783c59fadb40eae2d1972493eeb873e268b5af
+  data.tar.gz: 235a55cefe8256fb4d20529f10e1db0c3f4719641cd34c1c8e8d7b20d6c4e86fe07ae541990c92c4f22f838c2fe2476c9ce48b1a7145af2d74c735867d4940b0

data/.rubocop.yml

@@ -1,3 +1,6 @@
+require:
+  - rubocop-rspec
+
 AllCops:
   Exclude:
     - 'samples/**/*'
@@ -23,6 +26,49 @@ Metrics/LineLength:
 Metrics/ParameterLists:
   CountKeywordArgs: false
 
+# FIXME: Update specs to avoid offenses
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/reek/cli/application_spec.rb'
+
+# This file does not test a class
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/quality/reek_source_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/report/location_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/cli/application_spec.rb'
+
+# FIXME: Update specs to avoid offenses
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/reek/context/code_context_spec.rb'
+    - 'spec/reek/context/method_context_spec.rb'
+    - 'spec/reek/context/module_context_spec.rb'
+
 Style/AccessorMethodName:
   Exclude:
     - 'lib/reek/context/visibility_tracker.rb'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 4.4.2 (2016-09-21)
+
+* (troessner) Fail properly on bad configuration comments
+
 ## 4.4.1 (2016-09-13)
 
 * (troessner) Quote names in smell detector messages

data/Gemfile

@@ -10,11 +10,15 @@ group :development do
   gem 'mutant-rspec',  '~> 0.8.8'
   gem 'rake',          '~> 11.1'
   gem 'rspec',         '~> 3.0'
-  gem 'rubocop',       '~> 0.42.0'
   gem 'simplecov',     '~> 0.12.0'
   gem 'yard',          '~> 0.9.5'
   gem 'activesupport', '~> 4.2'
 
+  if RUBY_VERSION >= '2.3'
+    gem 'rubocop',       '~> 0.42.0'
+    gem 'rubocop-rspec', '~> 1.7'
+  end
+
   platforms :mri do
     gem 'redcarpet', '~> 3.3.1'
   end

data/docs/Duplicate-Method-Call.md

@@ -51,3 +51,99 @@ Reek's Duplicate Method Call detector currently offers the [Basic Smell Options]
 Option | Value | Effect
 -------|-------|-------
 `max_calls` |  integer | The maximum number of duplicate calls allowed within a method. Defaults to 1.
+`allow_calls` | an array of strings or regular expressions | Ignores any context who matches it |
+
+## Example configuration
+
+### Adjusting `max_calls`
+
+Imagine code like this:
+
+```Ruby
+class Alfa
+  def bravo
+    charlie.delta
+    charlie.delta
+  end
+end
+```
+
+This would report:
+
+>>
+src.rb -- 1 warning:
+  [4, 5]:DuplicateMethodCall: Alfa#bravo calls 'charlie.delta' 2 times
+
+If you want to allow those double calls here you can disable it in 2 different ways:
+
+1.) Via source code comment:
+
+```Ruby
+class Alfa
+  # :reek:DuplicateMethodCall { max_calls: 2 }
+  def bravo
+    charlie.delta
+    charlie.delta
+  end
+end
+```
+
+2.) Via configuration file:
+
+```Yaml
+DuplicateMethodCall:
+  max_calls: 2
+```
+
+Note though that the latter way will set `max_calls` to 2 for all instances
+of the smell detector which might not be what you want - in this case
+you'll have to use source code comments.
+
+### Adjusting `allow_calls`
+
+Imagine code like this:
+
+```Ruby
+class Alfa
+  def bravo
+    charlie.delta
+    charlie.delta
+    echo.foxtrot
+    echo.foxtrot
+  end
+end
+```
+
+This would report:
+
+>>
+src.rb -- 2 warnings:
+  [4, 5]:DuplicateMethodCall: Alfa#bravo calls charlie.delta 2 times
+  [6, 7]:DuplicateMethodCall: Alfa#bravo calls echo.foxtrot 2 times
+
+So let's say you're ok with the `echo.foxtrot` calls you can stop reporting them like this:
+
+1.) Via source code comment:
+
+```Ruby
+class Alfa
+  # :reek:DuplicateMethodCall { allow_calls: ['echo.foxtrot'] }
+  def bravo
+    charlie.delta
+    charlie.delta
+    echo.foxtrot
+    echo.foxtrot
+  end
+end
+```
+
+2.) Via configuration file:
+
+```Yaml
+DuplicateMethodCall:
+  allow_calls:
+  - 'echo.foxtrot'
+```
+
+Note though that the latter way will allow those calls across your source code which might not be what you want.
+In this case you'll have to use source code comments.

data/docs/How-To-Write-New-Detectors.md

@@ -59,6 +59,20 @@ module Reek
 end
 ```
 
+For your detector to be properly loaded you need to require it in `lib/reek/smells.rb` as well.
+
+### defaults.reek
+
+After you ran
+
+```
+bundle exec rake
+```
+
+for the first time with your shiny new detector in place the `defaults.reek`
+file should have been updated automatically. Make sure you don't forget to check
+in those changes as well.
+
 ### Documentation
 
 * Above every `SmellDetector::sniff` method it should be documented what the expected AST is
@@ -66,6 +80,8 @@ end
   take any arbitrary existing smell detector documentation page as template (since
   they all have the same structure already)
 * The detector should be listed under [Code Smells](docs/Code-Smells.md)
+* Depending on what your detector does it might make sense to add it to other doc pages as
+  well e.g. [Simulated Polymorphism](docs/Simulated-Polymorphism.md)
 
 ### Rspec examples
 

data/docs/Large-Class.md

@@ -9,7 +9,8 @@ size of the corresponding instance of `Class`.)
 
 ## Current Support in Reek
 
-Reek offers two checks in this category.
+Reek offers three checks in this category.
 
+* [Too Many Constants](Too-Many-Constants.md)
 * [Too Many Instance Variables](Too-Many-Instance-Variables.md)
 * [Too Many Methods](Too-Many-Methods.md)

data/docs/Simulated-Polymorphism.md

@@ -13,4 +13,4 @@ Conditional code is hard to read and understand, because the reader must hold mo
 
 ## Current Support in Reek
 
-Reek checks for [Repeated Conditional](Repeated-Conditional.md)  and for [Nil Check](Nil-Check.md).
+Reek checks for [Manual Dispatch](Manual-Dispatch.md), [Repeated Conditional](Repeated-Conditional.md)  and for [Nil Check](Nil-Check.md).

data/features/configuration_via_source_comments/erroneous_source_comments.feature

@@ -0,0 +1,39 @@
+Feature: Erroneous source comments are handled properly
+  Erroneous source comments should be handled in a way that is intuitive and helpful
+  for the user. Reek should neither crash nor silently swallow it.
+  If there is something wrong - no matter how small it is - Reek should report it back
+  to the user right away so the user can actually do something about it.
+  If a user tries to deactivate an unknown smell detector (e.g. because he made a typo)
+  we should just skip this file and tell the user about it so he can fix it and then
+  re-run Reek.
+
+  Scenario: Unknown smell detector
+    Given a file named "bad_detector.rb" with:
+      """
+      # Test class
+      # :reek:UnknownDetectorName
+      def x
+      end
+      """
+    When I run reek bad_detector.rb
+    Then it reports the error "Error: You are trying to configure an unknown smell detector 'UnknownDetectorName'"
+
+  Scenario: One good file, one bad file
+    Given a file named "bad_detector.rb" with:
+      """
+      # Test class
+      # :reek:UnknownDetectorName
+      def x
+      end
+      """
+    Given the smelly file 'smelly.rb'
+    When I run reek bad_detector.rb smelly.rb
+    Then it reports the error "Error: You are trying to configure an unknown smell detector 'UnknownDetectorName'"
+    And the exit status indicates smells
+    And it reports:
+      """
+      smelly.rb -- 2 warnings:
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
+      2 total warnings
+      """

data/lib/reek/ast/node.rb

@@ -106,6 +106,10 @@ module Reek
         1
       end
 
+      def source
+        loc.expression.source_buffer.name
+      end
+
       protected
 
       # See ".each_node" for documentation.

data/lib/reek/code_comment.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 require 'yaml'
+require_relative 'smells/smell_detector'
+require_relative 'errors'
 
 module Reek
   #
@@ -25,14 +27,20 @@ module Reek
 
     #
     # @param comment [String] - the original comment as found in the source code
-    #   E.g.:
-    #   "\n        # :reek:Duplication: { enabled: false }\n      "
+    # @param line [Integer] - start of the expression the comment belongs to
+    # @param source [String] - Path to source file or "string"
     #
-    def initialize(comment)
+    def initialize(comment:, line: nil, source: nil)
       @original_comment  = comment
       @config            = Hash.new { |hash, key| hash[key] = {} }
 
       @original_comment.scan(CONFIGURATION_REGEX) do |detector, _option_string, options|
+        unless Smells::SmellDetector.valid_detector?(detector)
+          raise BadDetectorInCommentError, detector: detector,
+                                           source: source,
+                                           line: line,
+                                           original_comment: @original_comment
+        end
         @config.merge! detector => YAML.load(options || DISABLE_DETECTOR_CONFIGURATION)
       end
     end

data/lib/reek/context/code_context.rb

@@ -161,7 +161,9 @@ module Reek
       attr_reader :refs
 
       def configuration_via_code_commment
-        @configuration_via_code_commment ||= CodeComment.new(full_comment).config
+        @configuration_via_code_commment ||= CodeComment.new(comment: full_comment,
+                                                             line: exp.line,
+                                                             source: exp.source).config
       end
 
       def full_comment

data/lib/reek/context/module_context.rb

@@ -64,7 +64,7 @@ module Reek
       end
 
       def descriptively_commented?
-        CodeComment.new(exp.leading_comment).descriptive?
+        CodeComment.new(comment: exp.leading_comment).descriptive?
       end
 
       # A namespace module is a module (or class) that is only there for namespacing

data/lib/reek/errors.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module Reek
+  # Gets raised when trying to configure a detector which is unknown to us.
+  # This might happen for multiple reasons. The users might have a typo in
+  # his comment or he might use a detector that does not exist anymore.
+  class BadDetectorInCommentError < RuntimeError
+    UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-EOS.freeze
+
+      Error: You are trying to configure an unknown smell detector '%s' in one
+      of your source code comments.
+      The source is '%s' and the comment belongs to the expression starting in line %d.
+      Here's the original comment:
+
+      %s
+
+      Please see the Reek docs for:
+        * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
+        * what smell detectors are available: https://github.com/troessner/reek/blob/master/docs/Code-Smells.md
+      Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
+
+    EOS
+
+    def initialize(detector:, source:, line:, original_comment:)
+      message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,
+                       detector,
+                       source,
+                       line,
+                       original_comment)
+      super message
+    end
+  end
+end

data/lib/reek/examiner.rb

@@ -96,12 +96,17 @@ module Reek
     # and continue with the analysis.
     #
     # @return [Array<SmellWarning>] the smells found in the source
+    #
+    # :reek:TooManyStatements { max_statements: 8 }
     def run
       return [] unless syntax_tree
       begin
         examine_tree
+      rescue BadDetectorInCommentError => exception
+        warn exception
+        []
       rescue StandardError => exception
-        $stderr.puts format(INCOMPREHENSIBLE_SOURCE_TEMPLATE, origin, exception.inspect)
+        warn format(INCOMPREHENSIBLE_SOURCE_TEMPLATE, origin, exception.inspect)
         []
       end
     end

data/lib/reek/rake/task.rb

@@ -9,8 +9,6 @@ require 'English'
 module Reek
   #
   # Defines a task library for running Reek.
-  # (Classes here will be configured via the Rakefile, and therefore will
-  # possess a :reek:attribute or two.)
   #
   # @public
   module Rake

data/lib/reek/smells/boolean_parameter.rb

@@ -21,7 +21,7 @@ module Reek
       #
       # :reek:FeatureEnvy
       def sniff(ctx)
-        ctx.default_assignments.select do |_param, value|
+        ctx.default_assignments.select do |_parameter, value|
           [:true, :false].include?(value.type)
         end.map do |parameter, _value|
           smell_warning(

data/lib/reek/smells/class_variable.rb

@@ -40,13 +40,13 @@ module Reek
       #
       # :reek:TooManyStatements: { max_statements: 7 }
       # :reek:FeatureEnvy
-      def class_variables_in(ast)
+      def class_variables_in(exp)
         result = Hash.new { |hash, key| hash[key] = [] }
         collector = proc do |cvar_node|
           result[cvar_node.name].push(cvar_node.line)
         end
         [:cvar, :cvasgn, :cvdecl].each do |stmt_type|
-          ast.each_node(stmt_type, [:class, :module], &collector)
+          exp.each_node(stmt_type, [:class, :module], &collector)
         end
         result
       end

data/lib/reek/smells/instance_variable_assumption.rb

@@ -39,7 +39,7 @@ module Reek
           context: ctx,
           lines: [ctx.exp.line],
           message: message,
-          parameters: { assumption: assumption })
+          parameters: { assumption: assumption.to_s })
       end
 
       # :reek:UtilityFunction