reek 4.2.4 → 4.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7756b10a94b5df5b45c50b6cdaa6577146dbbf15
-  data.tar.gz: d1e67defd358f1ce5f60affaa2c33e45aa09d744
+  metadata.gz: c782c9f7772d236e5608adea55c1dbef8ab620b8
+  data.tar.gz: 7851ccc5dd286f7488b4460a021179e35698429d
 SHA512:
-  metadata.gz: f2cbb1aacb409e57504ab7206b917648ad9e5db97a98302179a5902ab8a8b83335fcc674580f380f2314ec055f9c8be35156c1bab5d7b5ba6384429a8b42fdf9
-  data.tar.gz: 7476f5a7ce8dc2a0ab1f4791c1d5d0a4688b2462761f50775dd8404928faced642dfeedbbacbb2d3525e673003889fe3e7c643305bb92658ea397ad5fcdc4368
+  metadata.gz: 6147cba71db38cd92ca1c99ad7cfb9e002c7287bc114d8d318f99650d6ca4f3f06765f07d2f291dfedddfb394a3d84433a3f37b8bbea25c701e0d0bcaae7304b
+  data.tar.gz: 3f26e46e871f05bebe920624c33d12154fc7b773b426d263c2a6f2d14f247bc93d4d35683a150e8878636b5f729cc1fc0a96cecd7de2adaa99787652434f7946

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 4.2.5 (2016-08-23)
+
+* (mvz) Detect safe navigation operator and report on it.
+
 ## 4.2.4 (2016-08-15)
 
 * (troessner) Make Reek more resilient on incomprehensible source.

data/docs/Nil-Check.md

@@ -37,6 +37,7 @@ _Nil Check_ reports use of
 * <code>.nil?</code> method
 * <code>==</code> and <code>===</code> operators when checking vs. <code>nil</code>
 * case statements that use syntax like <code>when nil</code>
+* use of the safe navigation operator like `foo&.bar`
 
 ## Configuration
 

data/lib/reek/smells/nil_check.rb

@@ -10,15 +10,29 @@ module Reek
     # See {file:docs/Nil-Check.md} for details.
     class NilCheck < SmellDetector
       def sniff(ctx)
-        call_node_finder = NodeFinder.new(ctx, :send, NilCallNodeDetector)
-        case_node_finder = NodeFinder.new(ctx, :when, NilWhenNodeDetector)
-        smelly_nodes = call_node_finder.smelly_nodes + case_node_finder.smelly_nodes
-
-        smelly_nodes.map do |node|
-          smell_warning(
+        lines = NodeDetector.new(ctx).detect.map(&:line)
+        if lines.any?
+          [smell_warning(
             context: ctx,
-            lines: [node.line],
-            message: 'performs a nil-check')
+            lines: lines,
+            message: 'performs a nil-check')]
+        else
+          []
+        end
+      end
+
+      # Detect all nodes that smell of NilCheck
+      class NodeDetector
+        attr_reader :ctx
+        def initialize(ctx)
+          @ctx = ctx
+        end
+
+        def detect
+          finders = [NodeFinder.new(ctx, :send, NilCallNodeDetector),
+                     NodeFinder.new(ctx, :when, NilWhenNodeDetector),
+                     NodeFinder.new(ctx, :csend, SafeNavigationNodeDetector)]
+          finders.flat_map(&:smelly_nodes)
         end
       end
 
@@ -81,6 +95,16 @@ module Reek
           node.condition_list.any? { |it| it.type == :nil }
         end
       end
+
+      # Detect safe navigation. Returns true for all nodes, since all :csend
+      # nodes are considered smelly.
+      module SafeNavigationNodeDetector
+        module_function
+
+        def detect(_node)
+          true
+        end
+      end
     end
   end
 end

data/lib/reek/version.rb

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

data/spec/reek/smells/nil_check_spec.rb

@@ -6,8 +6,8 @@ require_relative 'smell_detector_shared'
 RSpec.describe Reek::Smells::NilCheck do
   it 'reports correctly the basic use case' do
     src = <<-EOS
-      def nilcheck foo
-        foo.nil?
+      def foo(bar)
+        bar.nil?
       end
     EOS
     expect(src).to reek_of :NilCheck,
@@ -19,55 +19,70 @@ RSpec.describe Reek::Smells::NilCheck do
     expect('def no_nils; end').not_to reek_of(:NilCheck)
   end
 
-  it 'reports when scope uses multiple nil? methods' do
+  it 'reports when scope uses #nil?' do
     src = <<-EOS
-    def chk_multi_nil(para)
-      para.nil?
-      puts "Hello"
-      \"\".nil?
+    def foo(bar)
+      bar.nil?
     end
     EOS
     expect(src).to reek_of(:NilCheck)
   end
 
-  it 'reports twice when scope uses == nil and === nil' do
+  it 'reports when scope uses == nil' do
     src = <<-EOS
-    def chk_eq_nil(para)
-      para == nil
-      para === nil
+    def foo(bar)
+      bar == nil
+    end
+    EOS
+    expect(src).to reek_of(:NilCheck)
+  end
+
+  it 'reports when scope uses === nil' do
+    src = <<-EOS
+    def foo(bar)
+      bar === nil
     end
     EOS
     expect(src).to reek_of(:NilCheck)
   end
 
   it 'reports when scope uses nil ==' do
-    expect('def chk_eq_nil_rev(para); nil == para; end').to reek_of(:NilCheck)
+    src = <<-EOS
+    def foo(bar)
+      nil == bar
+    end
+    EOS
+    expect(src).to reek_of(:NilCheck)
   end
 
-  it 'reports when scope uses multiple case-clauses checking nil' do
+  it 'reports when scope uses a case-clause checking nil' do
     src = <<-EOS
     def case_nil
-      case @inst_var
+      case @foo
       when nil then puts "Nil"
       end
-      puts "Hello"
-      case @inst_var2
-      when 1 then puts 1
-      when nil then puts nil.inspect
-      end
     end
     EOS
     expect(src).to reek_of(:NilCheck)
   end
 
-  it 'reports a when clause that checks nil and other values' do
+  it 'reports when scope uses &.' do
     src = <<-EOS
-    def case_nil
-      case @inst_var
-      when nil, false then puts "Hello"
-      end
+    def foo(bar)
+      bar&.baz
     end
     EOS
     expect(src).to reek_of(:NilCheck)
   end
+
+  it 'reports all lines when scope uses multiple nilchecks' do
+    src = <<-EOS
+    def foo(bar)
+      bar.nil?
+      bar === nil
+      bar&.baz
+    end
+    EOS
+    expect(src).to reek_of(:NilCheck, lines: [2, 3, 4])
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.2.4
+  version: 4.2.5
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -412,3 +412,4 @@ signing_key:
 specification_version: 4
 summary: Code smell detector for Ruby
 test_files: []
+has_rdoc: