rubocop-rspec 1.5.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a5f78eba0374bbe357f1de4227be9e3b6282116
-  data.tar.gz: 20fa1701861557f4c615613a9f3fe3300a758ac1
+  metadata.gz: 82d2c8c126eff832fb8c23b6a53a3e0d1a7e4f9c
+  data.tar.gz: c02b0c96893e673c18b0480f8e2755023ecb6987
 SHA512:
-  metadata.gz: 098e42022cd531df17726bc09d7d392b990d08b63c22e59a4b71e28f7a7cc23613688d93fc1f5edc97cb9e97cea1bab92d6a03ddaa0405f74e822e74e02c7744
-  data.tar.gz: 2461baf4ad9f1eadff4264a786bdeff878a50c164ac6576558ebabdd2b2e7870a5cc05996d419a499e9c97d7f7b32be67fd645e16f0a6c233fccb53adb0a1b15
+  metadata.gz: 1d6c8e1aeaa1e02427d474c2000c3cc50094746cf85e86a98965e1041aafb7b2be35e25616cce96b69f6a6803b2d1679e31647d112ea6e819267bfde52f24cb6
+  data.tar.gz: 643ac89c40e06801a88c7b19d49ee9109389f9a574717f9aee9ca527e48c38f0a95f8586979eecf5d9f26161a5ef3a0a502a1870c7a7fac62ed0ac96fd6b5140

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Master (unreleased)
 
+## 1.6.0 (2016-08-03)
+
+* Add `SkipBlocks` option for `DescribedClass` cop. ([@backus][])
+
 ## 1.5.3 (2016-08-02)
 
 * Add `RSpec/NamedSubject` cop. ([@backus][])

data/config/default.yml

@@ -8,6 +8,7 @@ RSpec/DescribeClass:
 
 RSpec/DescribedClass:
   Description: 'Use `described_class` for tested class / module'
+  SkipBlocks: false
   Enabled: true
 
 RSpec/DescribeMethod:

data/lib/rubocop/cop/rspec/described_class.rb

@@ -20,41 +20,94 @@ module RuboCop
       class DescribedClass < Cop
         include RuboCop::RSpec::TopLevelDescribe
 
-        MESSAGE = 'Use `described_class` instead of `%s`'.freeze
+        DESCRIBED_CLASS = 'described_class'.freeze
+        MSG             = "Use `#{DESCRIBED_CLASS}` instead of `%s`".freeze
 
-        def on_block(node)
-          method, _args, body = *node
-          return unless top_level_describe?(method)
+        RSPEC_BLOCK_METHODS = '
+          :after
+          :around
+          :before
+          :context
+          :describe
+          :example
+          :example_group
+          :fcontext
+          :fdescribe
+          :feature
+          :fexample
+          :ffeature
+          :fit
+          :focus
+          :fscenario
+          :fspecify
+          :it
+          :let
+          :let!
+          :scenario
+          :specify
+          :xcontext
+          :xdescribe
+          :xexample
+          :xfeature
+          :xit
+          :xscenario
+          :xspecify
+        '.freeze
+
+        def_node_matcher :described_constant, <<-PATTERN
+          (block $(send _ :describe $(const ...)) (args) $_)
+        PATTERN
+
+        def_node_matcher :common_instance_exec_closure?, <<-PATTERN
+          (block (send (const nil {:Class :Module}) :new ...) ...)
+        PATTERN
 
-          _receiver, _method_name, object = *method
-          return unless object && object.type.equal?(:const)
+        def_node_matcher :rspec_block?, <<-PATTERN
+          (block (send nil {#{RSPEC_BLOCK_METHODS}} ...) ...)
+        PATTERN
+
+        def_node_matcher :scope_changing_syntax?, '{def class module}'
+
+        def on_block(node)
+          describe, described_class, body = described_constant(node)
+          return unless top_level_describe?(describe)
 
-          inspect_children(body, object)
+          find_constant_usage(body, described_class) do |match|
+            add_offense(match, :expression, format(MSG, match.const_name))
+          end
         end
 
         def autocorrect(node)
           lambda do |corrector|
-            corrector.replace(node.loc.expression, 'described_class')
+            corrector.replace(node.loc.expression, DESCRIBED_CLASS)
           end
         end
 
         private
 
-        def inspect_children(node, object)
+        def find_constant_usage(node, described_class, &block)
+          yield(node) if node.eql?(described_class)
+
           return unless node.instance_of?(Node)
-          return if scope_change?(node) || node.type.equal?(:const)
+          return if scope_change?(node) || node.const_type?
 
           node.children.each do |child|
-            if child.eql?(object)
-              name = object.loc.expression.source
-              add_offense(child, :expression, format(MESSAGE, name))
-            end
-            inspect_children(child, object)
+            find_constant_usage(child, described_class, &block)
           end
         end
 
         def scope_change?(node)
-          [:def, :class, :module].include?(node.type)
+          scope_changing_syntax?(node)          ||
+            common_instance_exec_closure?(node) ||
+            skippable_block?(node)
+        end
+
+        def skippable_block?(node)
+          node.block_type? && !rspec_block?(node) && skip_blocks?
+        end
+
+        def skip_blocks?
+          cop_config['SkipBlocks'].equal?(true)
         end
       end
     end

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '1.5.3'.freeze
+      STRING = '1.6.0'.freeze
     end
   end
 end

data/spec/rubocop/cop/rspec/described_class_spec.rb

@@ -1,5 +1,73 @@
-describe RuboCop::Cop::RSpec::DescribedClass do
-  subject(:cop) { described_class.new }
+describe RuboCop::Cop::RSpec::DescribedClass, :config do
+  subject(:cop) { described_class.new(config) }
+
+  shared_examples 'SkipBlocks enabled' do
+    it 'does not flag violations within non-rspec blocks' do
+      expect_violation(<<-RUBY)
+        describe MyClass do
+          controller(ApplicationController) do
+            bar = MyClass
+          end
+
+          before do
+            MyClass
+            ^^^^^^^ Use `described_class` instead of `MyClass`
+
+            Foo.custom_block do
+              MyClass
+            end
+          end
+        end
+      RUBY
+    end
+  end
+
+  shared_examples 'SkipBlocks disabled' do
+    it 'flags violations within all blocks' do
+      expect_violation(<<-RUBY)
+        describe MyClass do
+          controller(ApplicationController) do
+            bar = MyClass
+                  ^^^^^^^ Use `described_class` instead of `MyClass`
+          end
+
+          before(:each) do
+            MyClass
+            ^^^^^^^ Use `described_class` instead of `MyClass`
+
+            Foo.custom_block do
+              MyClass
+              ^^^^^^^ Use `described_class` instead of `MyClass`
+            end
+          end
+        end
+      RUBY
+    end
+  end
+
+  context 'when SkipBlocks is `true`' do
+    let(:cop_config) { { 'SkipBlocks' => true } }
+
+    include_examples 'SkipBlocks enabled'
+  end
+
+  context 'when SkipBlocks anything besides `true`' do
+    let(:cop_config) { { 'SkipBlocks' => 'yes' } }
+
+    include_examples 'SkipBlocks disabled'
+  end
+
+  context 'when SkipBlocks is not set' do
+    let(:cop_config) { Hash.new }
+
+    include_examples 'SkipBlocks disabled'
+  end
+
+  context 'when SkipBlocks is `false`' do
+    let(:cop_config) { { 'SkipBlocks' => false } }
+
+    include_examples 'SkipBlocks disabled'
+  end
 
   it 'checks for the use of the described class' do
     expect_violation(<<-RUBY)
@@ -35,6 +103,9 @@ describe RuboCop::Cop::RSpec::DescribedClass do
   it 'ignores class if the scope is changing' do
     expect_no_violations(<<-RUBY)
       describe MyClass do
+        Class.new  { foo = MyClass }
+        Module.new { bar = MyClass }
+
         def method
           include MyClass
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.6.0
 platform: ruby
 authors:
 - Ian MacLeod
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-02 00:00:00.000000000 Z
+date: 2016-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop