reek 4.2.5 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c782c9f7772d236e5608adea55c1dbef8ab620b8
-  data.tar.gz: 7851ccc5dd286f7488b4460a021179e35698429d
+  metadata.gz: 5e3c2e9cc70f29c322ad9284d8412aafc7d1dba9
+  data.tar.gz: b2bbee88bc846020a28cb27214d0ea09a1fbb1c7
 SHA512:
-  metadata.gz: 6147cba71db38cd92ca1c99ad7cfb9e002c7287bc114d8d318f99650d6ca4f3f06765f07d2f291dfedddfb394a3d84433a3f37b8bbea25c701e0d0bcaae7304b
-  data.tar.gz: 3f26e46e871f05bebe920624c33d12154fc7b773b426d263c2a6f2d14f247bc93d4d35683a150e8878636b5f729cc1fc0a96cecd7de2adaa99787652434f7946
+  metadata.gz: cc8a77b31dcbc0be82506493b24654f299cd21c5f8ecf2484d962a73363072c372d09d8d9e58223197c6fb9934a0de0f42481bf131146297d3f653194219110c
+  data.tar.gz: 5fca779e7aa91f5a7e6b943fd3923f4cada5a50364e3952ed30def4a16dd112b3267bcca1fde743e627008cc534c9c82ba223dd4a4f8502bfb346a7b2da5154f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 4.3.0 (2016-08-23)
+
+* (backus) Add ManualDispatch smell.
+
 ## 4.2.5 (2016-08-23)
 
 * (mvz) Detect safe navigation operator and report on it.

data/defaults.reek

@@ -38,6 +38,9 @@ LongYieldList:
   enabled: true
   exclude: []
   max_params: 3
+ManualDispatch:
+  enabled: true
+  exclude: []
 ModuleInitialize:
   enabled: true
   exclude: []

data/docs/Manual-Dispatch.md

@@ -0,0 +1,30 @@
+## Introduction
+
+Reek reports a _Manual Dispatch_ smell if it finds source code that manually checks whether an object responds to a method before that method is called. Manual dispatch is a type of [Simulated Polymorphism](Simulated-Polymorphism.md) which leads to code that is harder to reason about, debug, and refactor.
+
+## Example
+
+```Ruby
+class MyManualDispatcher
+  attr_reader :foo
+
+  def initialize(foo)
+    @foo = foo
+  end
+
+  def call
+    foo.bar if foo.respond_to?(:bar)
+  end
+end
+```
+
+Reek would emit the following warning:
+
+```
+test.rb -- 1 warning:
+  [9]: MyManualDispatcher manually dispatches method call (ManualDispatch)
+```
+
+## Configuration
+
+_Manual Dispatch_ offers the [Basic Smell Options](Basic-Smell-Options.md).

data/features/samples.feature

@@ -60,7 +60,7 @@ Feature: Basic smell detection
       UncommunicativeVariableName: Inline::C#module_name has the variable name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
       UncommunicativeVariableName: Inline::C#parse_signature has the variable name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
       UtilityFunction: Inline::C#strip_comments doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
-    optparse.rb -- 120 warnings:
+    optparse.rb -- 124 warnings:
       Attribute: OptionParser#banner is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: OptionParser#default_argv is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: OptionParser#program_name is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
@@ -121,6 +121,10 @@ Feature: Basic smell detection
       LongParameterList: OptionParser::List#update has 5 parameters [https://github.com/troessner/reek/blob/master/docs/Long-Parameter-List.md]
       LongParameterList: OptionParser::Switch#initialize has 7 parameters [https://github.com/troessner/reek/blob/master/docs/Long-Parameter-List.md]
       LongParameterList: OptionParser::Switch#summarize has 5 parameters [https://github.com/troessner/reek/blob/master/docs/Long-Parameter-List.md]
+      ManualDispatch: OptionParser#make_switch manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
+      ManualDispatch: OptionParser::List#accept manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
+      ManualDispatch: OptionParser::List#add_banner manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
+      ManualDispatch: OptionParser::List#summarize manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
       ModuleInitialize: OptionParser::Arguable has initialize method [https://github.com/troessner/reek/blob/master/docs/Module-Initialize.md]
       NestedIterators: OptionParser#make_switch contains iterators nested 2 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
       NilCheck: OptionParser#make_switch performs a nil-check [https://github.com/troessner/reek/blob/master/docs/Nil-Check.md]
@@ -181,7 +185,7 @@ Feature: Basic smell detection
       UnusedParameters: OptionParser::Completion#convert has unused parameter 'opt' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
       UnusedParameters: OptionParser::Switch::NoArgument#parse has unused parameter 'argv' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
       UnusedParameters: OptionParser::Switch::OptionalArgument#parse has unused parameter 'argv' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
-    redcloth.rb -- 104 warnings:
+    redcloth.rb -- 105 warnings:
       Attribute: RedCloth#filter_html is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: RedCloth#filter_styles is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: RedCloth#hard_breaks is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
@@ -219,6 +223,7 @@ Feature: Basic smell detection
       LongParameterList: RedCloth#textile_bq has 4 parameters [https://github.com/troessner/reek/blob/master/docs/Long-Parameter-List.md]
       LongParameterList: RedCloth#textile_fn_ has 5 parameters [https://github.com/troessner/reek/blob/master/docs/Long-Parameter-List.md]
       LongParameterList: RedCloth#textile_p has 4 parameters [https://github.com/troessner/reek/blob/master/docs/Long-Parameter-List.md]
+      ManualDispatch: RedCloth#block_textile_prefix manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
       NestedIterators: RedCloth#block_textile_lists contains iterators nested 3 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
       NestedIterators: RedCloth#block_textile_table contains iterators nested 2 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
       NestedIterators: RedCloth#block_textile_table contains iterators nested 3 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
@@ -286,5 +291,5 @@ Feature: Basic smell detection
       UtilityFunction: RedCloth#lT doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
       UtilityFunction: RedCloth#no_textile doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
       UtilityFunction: RedCloth#v_align doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
-    272 total warnings
+    277 total warnings
     """

data/lib/reek/smells.rb

@@ -9,6 +9,7 @@ require_relative 'smells/feature_envy'
 require_relative 'smells/irresponsible_module'
 require_relative 'smells/long_parameter_list'
 require_relative 'smells/long_yield_list'
+require_relative 'smells/manual_dispatch'
 require_relative 'smells/module_initialize'
 require_relative 'smells/nested_iterators'
 require_relative 'smells/nil_check'

data/lib/reek/smells/manual_dispatch.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require_relative 'smell_detector'
+require_relative 'smell_warning'
+
+module Reek
+  module Smells
+    #
+    # A Manual Dispatch occurs when a method is only called after a
+    # manual check that the method receiver is of the correct type.
+    #
+    # The +ManualDispatch+ checker reports any invocation of +respond_to?+
+    #
+    # See {file:docs/Manual-Dispatch.md} for details.
+    class ManualDispatch < SmellDetector
+      MESSAGE = 'manually dispatches method call'.freeze
+
+      #
+      # Checks for +respond_to?+ usage within the given method
+      #
+      # @return [Array<SmellWarning>]
+      #
+      # :reek:FeatureEnvy
+      def sniff(ctx)
+        ctx.each_node(:send).flat_map do |node|
+          next unless node.name.equal?(:respond_to?)
+
+          smell_warning(context: ctx, lines: [node.line], message: MESSAGE)
+        end.compact
+      end
+    end
+  end
+end

data/lib/reek/version.rb

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

data/spec/reek/smells/manual_dispatch_spec.rb

@@ -0,0 +1,47 @@
+require_relative '../../spec_helper'
+require_lib 'reek/smells/too_many_constants'
+require_relative 'smell_detector_shared'
+
+RSpec.describe Reek::Smells::ManualDispatch do
+  it 'reports manual dispatch smell when using #respond_to?' do
+    src = <<-EOS
+      class Dummy
+        def call
+          fail if unrelated_guard_clause?
+
+          if foo.respond_to?(:bar, true)
+            hello
+            foo.baz
+            foo.bar
+          end
+        end
+      end
+    EOS
+
+    expect(src).to reek_of(:ManualDispatch, message: 'manually dispatches method call', lines: [5])
+  end
+
+  it 'reports manual dispatch smell when using #respond_to? on implicit self' do
+    src = <<-EOS
+      class Dummy
+        def call
+          bar if respond_to?(:bar)
+        end
+      end
+    EOS
+
+    expect(src).to reek_of(:ManualDispatch)
+  end
+
+  it 'reports manual dispatch within a conditional' do
+    src = <<-EOS
+      class Dummy
+        def call
+          foo.respond_to?(:bar) && foo.bar
+        end
+      end
+    EOS
+
+    expect(src).to reek_of(:ManualDispatch)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.2.5
+  version: 4.3.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -108,6 +108,7 @@ files:
 - docs/Large-Class.md
 - docs/Long-Parameter-List.md
 - docs/Long-Yield-List.md
+- docs/Manual-Dispatch.md
 - docs/Module-Initialize.md
 - docs/Nested-Iterators.md
 - docs/Nil-Check.md
@@ -238,6 +239,7 @@ files:
 - lib/reek/smells/irresponsible_module.rb
 - lib/reek/smells/long_parameter_list.rb
 - lib/reek/smells/long_yield_list.rb
+- lib/reek/smells/manual_dispatch.rb
 - lib/reek/smells/module_initialize.rb
 - lib/reek/smells/nested_iterators.rb
 - lib/reek/smells/nil_check.rb
@@ -346,6 +348,7 @@ files:
 - spec/reek/smells/irresponsible_module_spec.rb
 - spec/reek/smells/long_parameter_list_spec.rb
 - spec/reek/smells/long_yield_list_spec.rb
+- spec/reek/smells/manual_dispatch_spec.rb
 - spec/reek/smells/module_initialize_spec.rb
 - spec/reek/smells/nested_iterators_spec.rb
 - spec/reek/smells/nil_check_spec.rb
@@ -412,4 +415,3 @@ signing_key:
 specification_version: 4
 summary: Code smell detector for Ruby
 test_files: []
-has_rdoc: