rubocop-rspec 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d76ad6b5a03029a44d0df0b733fd13816be3ffd
-  data.tar.gz: 430a2169a27502c780f3ab10d9e0bae261a31f94
+  metadata.gz: 05c5a02b8f251474055785a8e599fa2bbd66a5da
+  data.tar.gz: 4d34abb87f561cbe99dcd4df35d4d2e4b8eb1499
 SHA512:
-  metadata.gz: 54815c238a360be303b16144d9dcb3338770948de917b0a5a6f292dd25721b9d48c042edab0361f203b050be82cb18bcd2dcd1250b4ee111f9e3f3d15dd1ed1d
-  data.tar.gz: 1d39b6af29a27b1cda1ae5f223e74dfba11f494381920ae821941546322d3688cd30e3666a245535c6bc8998c2b7bb13c4aafc378ebc7b3469ee434b60741db3
+  metadata.gz: 55de6981f33d7f310a4290a1fc4578bb6d0ba905a2ce4ea86f966d025165cfd6d08d05f5198b56dcd207178724f574e6e046cb4af01be02a7e36662cfe792647
+  data.tar.gz: 73f5cdbc39ed5bc4aaa0d2fa8aa0769855b09f2d960ccf5078638582be79556109a491819a4253414a567a50baef1e66b6b737203998a57fad0cf2997c4446ca

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Master (Unreleased)
 
+## 1.15.0 (2017-05-24)
+
+* Add `RSpec/DescribeSymbol` cop. ([@tsigo][])
+* Fix error when `RSpec/OverwritingSetup` and `RSpec/ScatteredLet` analyzed empty example groups. ([@backus][])
+
 ## 1.14.0 (2017-03-24)
 
 * Add `RSpec/OverwritingSetup` cop. ([@Darhazer][])
@@ -206,3 +211,4 @@
 [@redross]: https://github.com/redross
 [@cfabianski]: https://github.com/cfabianski
 [@dgollahon]: https://github.com/dgollahon
+[@tsigo]: https://github.com/tsigo

data/config/default.yml

@@ -42,6 +42,10 @@ RSpec/DescribeMethod:
   Description: Checks that the second argument to `describe` specifies a method.
   Enabled: true
 
+RSpec/DescribeSymbol:
+  Description: Avoid describing symbols.
+  Enabled: true
+
 RSpec/IteratedExpectation:
   Description: Check that `all` matcher is used instead of iterating over an array.
   Enabled: true

data/lib/rubocop-rspec.rb

@@ -26,6 +26,7 @@ require 'rubocop/cop/rspec/be_eql'
 require 'rubocop/cop/rspec/before_after_all'
 require 'rubocop/cop/rspec/describe_class'
 require 'rubocop/cop/rspec/describe_method'
+require 'rubocop/cop/rspec/describe_symbol'
 require 'rubocop/cop/rspec/described_class'
 require 'rubocop/cop/rspec/empty_example_group'
 require 'rubocop/cop/rspec/empty_line_after_final_let'

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Avoid describing symbols.
+      #
+      # @example
+      #   # bad
+      #   describe :my_method do
+      #     ...
+      #   end
+      #
+      #   # good
+      #   describe '#my_method' do
+      #     ...
+      #   end
+      #
+      # See https://github.com/rspec/rspec-core/issues/1610
+      class DescribeSymbol < Cop
+        MSG = 'Avoid describing symbols.'.freeze
+
+        def_node_matcher :describe_symbol?, <<-PATTERN
+          (send {(const nil :RSpec) nil} :describe $sym ...)
+        PATTERN
+
+        def on_send(node)
+          describe_symbol?(node) { |match| add_offense(match, :expression) }
+        end
+      end
+    end
+  end
+end

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

@@ -29,7 +29,7 @@ module RuboCop
         PATTERN
 
         def on_block(node)
-          return unless example_group?(node)
+          return unless example_group_with_body?(node)
 
           _describe, _args, body = *node
 

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

@@ -32,7 +32,7 @@ module RuboCop
         def_node_matcher :let?, '(block (send nil {:let :let!} ...) ...)'
 
         def on_block(node)
-          return unless example_group?(node)
+          return unless example_group_with_body?(node)
 
           _describe, _args, body = *node
 

data/lib/rubocop/rspec/language/node_pattern.rb

@@ -8,6 +8,11 @@ module RuboCop
         extend RuboCop::NodePattern::Macros
 
         def_node_matcher :example_group?, ExampleGroups::ALL.block_pattern
+
+        def_node_matcher :example_group_with_body?, <<-PATTERN
+          (block #{ExampleGroups::ALL.send_pattern} args [!nil])
+        PATTERN
+
         def_node_matcher :example?, Examples::ALL.block_pattern
       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.14.0'.freeze
+      STRING = '1.15.0'.freeze
     end
   end
 end

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

@@ -0,0 +1,42 @@
+RSpec.describe RuboCop::Cop::RSpec::DescribeSymbol do
+  subject(:cop) { described_class.new }
+
+  it 'flags violations for `describe :symbol`' do
+    expect_violation(<<-RUBY)
+      describe(:some_method) { }
+               ^^^^^^^^^^^^ Avoid describing symbols.
+    RUBY
+  end
+
+  it 'flags violations for `describe :symbol` with multiple arguments' do
+    expect_violation(<<-RUBY)
+      describe(:some_method, "description") { }
+               ^^^^^^^^^^^^ Avoid describing symbols.
+    RUBY
+  end
+
+  it 'flags violations for `RSpec.describe :symbol`' do
+    expect_violation(<<-RUBY)
+      RSpec.describe(:some_method, "description") { }
+                     ^^^^^^^^^^^^ Avoid describing symbols.
+    RUBY
+  end
+
+  it 'flags violations for a nested `describe`' do
+    expect_violation(<<-RUBY)
+      RSpec.describe Foo do
+        describe :to_s do
+                 ^^^^^ Avoid describing symbols.
+        end
+      end
+    RUBY
+  end
+
+  it 'does not flag non-Symbol arguments' do
+    expect_no_violations('describe("#some_method") { }')
+  end
+
+  it 'does not flag `context :symbol`' do
+    expect_no_violations('context(:some_method) { }')
+  end
+end

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

@@ -43,4 +43,9 @@ RSpec.describe RuboCop::Cop::RSpec::OverwritingSetup do
       end
     RUBY
   end
+
+  it 'does not encounter an error when handling an empty describe' do
+    expect { inspect_source(cop, 'RSpec.describe(User) do end', 'a_spec.rb') }
+      .not_to raise_error
+  end
 end

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

@@ -23,4 +23,9 @@ RSpec.describe RuboCop::Cop::RSpec::ScatteredLet do
       end
     RUBY
   end
+
+  it 'does not encounter an error when handling an empty describe' do
+    expect { inspect_source(cop, 'RSpec.describe(User) do end', 'a_spec.rb') }
+      .not_to raise_error
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -151,6 +151,7 @@ files:
 - lib/rubocop/cop/rspec/cop.rb
 - lib/rubocop/cop/rspec/describe_class.rb
 - lib/rubocop/cop/rspec/describe_method.rb
+- lib/rubocop/cop/rspec/describe_symbol.rb
 - lib/rubocop/cop/rspec/described_class.rb
 - lib/rubocop/cop/rspec/empty_example_group.rb
 - lib/rubocop/cop/rspec/empty_line_after_final_let.rb
@@ -212,6 +213,7 @@ files:
 - spec/rubocop/cop/rspec/cop_spec.rb
 - spec/rubocop/cop/rspec/describe_class_spec.rb
 - spec/rubocop/cop/rspec/describe_method_spec.rb
+- spec/rubocop/cop/rspec/describe_symbol_spec.rb
 - spec/rubocop/cop/rspec/described_class_spec.rb
 - spec/rubocop/cop/rspec/empty_example_group_spec.rb
 - spec/rubocop/cop/rspec/empty_line_after_final_let_spec.rb
@@ -279,7 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Code style checking for RSpec files
@@ -295,6 +297,7 @@ test_files:
 - spec/rubocop/cop/rspec/cop_spec.rb
 - spec/rubocop/cop/rspec/describe_class_spec.rb
 - spec/rubocop/cop/rspec/describe_method_spec.rb
+- spec/rubocop/cop/rspec/describe_symbol_spec.rb
 - spec/rubocop/cop/rspec/described_class_spec.rb
 - spec/rubocop/cop/rspec/empty_example_group_spec.rb
 - spec/rubocop/cop/rspec/empty_line_after_final_let_spec.rb