rubocop-rspec 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4af4076d3a91d5fdb416fa1fec36c74e07998744
-  data.tar.gz: e9bd1905617f520629969606be3a7d7228415b3b
+  metadata.gz: 7f7a58ee16af46402f371a3a3be9ae83752a7555
+  data.tar.gz: 15ecddf6c683fe294fb914faeadd45eabbbabba6
 SHA512:
-  metadata.gz: 98850f3ef7a136727655aaf9eaaab8e889e8944f71762760def61d32c89e2690f6c6e3d519d1c82e9d7cd364796119105b82dfb7d2c17e58a9d4449fc9e6889d
-  data.tar.gz: dff8cba69accc6a345a681a47a8529a3830821d5a1d09b12f81250c3bc1c513c6409c9267dc658c59a11af04421bf9f42ce029239097cb14ee1915a9b170ab4e
+  metadata.gz: ca7b87e0e9210d37795f29ebba6b5398c5e5583b9b68e3a1519c4f9208d18228d99378fba6114a6381c8bf579bf21cf755a3b9ef438765065965b381d9a1e3ca
+  data.tar.gz: f515ccc02aace366c6ec987aaf258450d8d7f0d2e740382d303a4480633b031de8150ca198369b2059c5856cb94d121afe7161bb10dfe1e70f7bdc1a60ed6f5d

data/CHANGELOG.md

@@ -2,13 +2,26 @@
 
 ## master (unreleased)
 
-## 1.4.1 (03/04/2016)
+## 1.5.0 (2016-05-17)
+
+* Expand `VerifiedDoubles` cop to check for `spy` as well as `double`. ([@andyw8][])
+* Enable `VerifiedDoubles` cop by default. ([@andyw8][])
+* Add `IgnoreSymbolicNames` option for `VerifiedDoubles` cop. ([@andyw8][])
+* Add `RSpec::ExampleLength` cop. ([@andyw8][])
+* Handle alphanumeric class names in `FilePath` cop. ([@andyw8][])
+* Skip `DescribeClass` cop for view specs. ([@andyw8][])
+* Skip `FilePath` cop for Rails routing specs. ([@andyw8][])
+* Add cop to check for focused specs. ([@renanborgescampos][], [@jaredmoody][])
+* Clean-up `RSpec::NotToNot` to use same configuration semantics as other Rubocop cops, add autocorrect support for `RSpec::NotToNot`. ([@baberthal][])
+* Update to rubocop 0.40.0. ([@nijikon][])
+
+## 1.4.1 (2016-04-03)
 
 * Ignore routing specs for DescribeClass cop. ([@nijikon][])
 * Move rubocop dependency to runtime. ([@nijikon][])
 * Update to rubocop 0.39.0. ([@nijikon][])
 
-## 1.4.0 (15/02/2016)
+## 1.4.0 (2016-02-15)
 
 * Update to rubocop 0.37.2. ([@nijikon][])
 * Update ruby versions we test against. ([@nijikon][])
@@ -73,7 +86,7 @@
 
 <!-- Contributors -->
 
-[@andyw8]: https://github.com/andyw8i
+[@andyw8]: https://github.com/andyw8
 [@bquorning]: https://github.com/bquorning
 [@deivid-rodriguez]: https://github.com/deivid-rodriguez
 [@geniou]: https://github.com/geniou
@@ -83,3 +96,6 @@
 [@pstengel]: https://github.com/pstengel
 [@miguelfteixeira]: https://github.com/miguelfteixeira
 [@mlarraz]: https://github.com/mlarraz
+[@renanborgescampos]: https://github.com/renanborgescampos
+[@jaredmoody]: https://github.com/jaredmoody
+[@baberthal]: https://github.com/baberthal

data/README.md

@@ -85,7 +85,7 @@ This means that in order to run the specs locally, you need a (shallow) clone
 of the RuboCop repository:
 
 ```bash
-git submodule update --init --depth 1 vendor/rubocop
+git submodule update --init vendor/rubocop
 ```
 
 ## License

data/config/default.yml

@@ -41,9 +41,21 @@ RSpec/FilePath:
 
 RSpec/VerifiedDoubles:
   Description: 'Prefer using verifying doubles over normal doubles.'
-  Enabled: false
+  Enabled: true
 
 RSpec/NotToNot:
   Description: 'Enforces the usage of the same method on all negative message expectations.'
+  EnforcedStyle: not_to
+  SupportedStyles:
+    - not_to
+    - to_not
+  Enabled: true
+
+RSpec/Focus:
+  Description: 'Checks if there are focused specs.'
+  Enabled: true
+
+RSpec/ExampleLength:
+  Description: 'Checks for long example'
   Enabled: true
-  AcceptedMethod: 'not_to'
+  Max: 5

data/lib/rubocop-rspec.rb

@@ -15,7 +15,9 @@ require 'rubocop/cop/rspec/describe_method'
 require 'rubocop/cop/rspec/described_class'
 require 'rubocop/cop/rspec/example_wording'
 require 'rubocop/cop/rspec/file_path'
+require 'rubocop/cop/rspec/focus'
 require 'rubocop/cop/rspec/instance_variable'
+require 'rubocop/cop/rspec/example_length'
 require 'rubocop/cop/rspec/multiple_describes'
 require 'rubocop/cop/rspec/not_to_not'
 require 'rubocop/cop/rspec/verified_doubles'

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

@@ -33,11 +33,14 @@ module RuboCop
           _receiver, method_name, *_args = *node
           return unless ANY_INSTANCE_METHODS.include?(method_name)
 
-          add_offense(node, :expression,
-                      format(MESSAGE % { method: method_name },
-                             node.loc.expression.source
-                            )
-                     )
+          add_offense(
+            node,
+            :expression,
+            format(
+              MESSAGE % { method: method_name },
+              node.loc.expression.source
+            )
+          )
         end
       end
     end

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

@@ -24,6 +24,7 @@ module RuboCop
         REQUEST_PAIR = s(:pair, s(:sym, :type), s(:sym, :request))
         FEATURE_PAIR = s(:pair, s(:sym, :type), s(:sym, :feature))
         ROUTING_PAIR = s(:pair, s(:sym, :type), s(:sym, :routing))
+        VIEW_PAIR = s(:pair, s(:sym, :type), s(:sym, :view))
 
         MESSAGE = 'The first argument to describe should be the class or ' \
                   'module being tested.'.freeze
@@ -34,7 +35,7 @@ module RuboCop
           return if args[1..-1].any? do |arg|
             next unless arg.hash_type?
             arg.children.any? do |n|
-              [REQUEST_PAIR, FEATURE_PAIR, ROUTING_PAIR].include?(n)
+              [REQUEST_PAIR, FEATURE_PAIR, ROUTING_PAIR, VIEW_PAIR].include?(n)
             end
           end
 

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

@@ -0,0 +1,60 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # A long example is usually more difficult to understand. Consider
+      # extracting out some behaviour, e.g. with a `let` block, or a helper
+      # method.
+      #
+      # @example
+      #   # bad
+      #   it do
+      #     service = described_class.new
+      #     more_setup
+      #     more_setup
+      #     result = service.call
+      #     expect(result).to be(true)
+      #   end
+      #
+      #   # good
+      #   it do
+      #     service = described_class.new
+      #     result = service.call
+      #     expect(result).to be(true)
+      #   end
+      class ExampleLength < Cop
+        include CodeLength
+        EXAMPLE_BLOCKS = [:it, :specify].freeze
+
+        def on_block(node)
+          method, _args, _body = *node
+          _receiver, method_name, _object = *method
+          return unless EXAMPLE_BLOCKS.include?(method_name)
+
+          length = code_length(node)
+
+          return unless length > max
+          add_offense(node, :expression, message(length, max))
+        end
+
+        private
+
+        def max
+          cop_config['Max']
+        end
+
+        def code_length(node)
+          lines = node.source.lines.to_a[1..-2] || []
+
+          lines.count { |line| !irrelevant_line(line) }
+        end
+
+        def message(length, max_length)
+          format('Example has too many lines. [%d/%d]', length, max_length)
+        end
+      end
+    end
+  end
+end

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

@@ -7,8 +7,8 @@ module RuboCop
       # Checks the path of the spec file and enforces that it reflects the
       # described class/module and its optionally called out method.
       #
-      # With the configuration option `CustomTransform` modules or clases can be
-      # specified that should not as usual be transformed from CamelCase to
+      # With the configuration option `CustomTransform` modules or classes can
+      # be specified that should not as usual be transformed from CamelCase to
       # snake_case (e.g. 'RuboCop' => 'rubocop' ).
       #
       # @example
@@ -20,8 +20,11 @@ module RuboCop
 
         MESSAGE = 'Spec path should end with `%s`'.freeze
         METHOD_STRING_MATCHER = /^[\#\.].+/
+        ROUTING_PAIR = s(:pair, s(:sym, :type), s(:sym, :routing))
 
         def on_top_level_describe(node, args)
+          return if routing_spec?(args)
+
           return unless single_top_level_describe?
           object = args.first.const_name
           return unless object
@@ -34,6 +37,13 @@ module RuboCop
 
         private
 
+        def routing_spec?(args)
+          args[1..-1].any? do |arg|
+            next unless arg.hash_type?
+            arg.children.include?(ROUTING_PAIR)
+          end
+        end
+
         def matcher(object, method)
           path = File.join(parts(object))
           if method && method.type == :str
@@ -56,7 +66,7 @@ module RuboCop
         def camel_to_underscore(string)
           string.dup.tap do |result|
             result.gsub!(/([^A-Z])([A-Z]+)/, '\\1_\\2')
-            result.gsub!(/([A-Z])([A-Z][^A-Z]+)/, '\\1_\\2')
+            result.gsub!(/([A-Z])([A-Z\d][^A-Z\d]+)/, '\\1_\\2')
             result.downcase!
           end
         end

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

@@ -0,0 +1,67 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks if test is focused.
+      #
+      # @example
+      #   # bad
+      #   describe MyClass, focus: true do
+      #   end
+      #
+      #   describe MyClass, :focus do
+      #   end
+      #
+      #   fdescribe MyClass do
+      #   end
+      #
+      #   # good
+      #   describe MyClass do
+      #   end
+      class Focus < Cop
+        MESSAGE = 'Focused spec found.'.freeze
+
+        FOCUSABLE_BLOCKS = [
+          :example_group, :describe, :context, :xdescribe, :xcontext,
+          :it, :example, :specify, :xit, :xexample, :xspecify,
+          :feature, :scenario, :xfeature, :xscenario
+        ].freeze
+
+        FOCUSED_BLOCKS = [
+          :fdescribe, :fcontext,
+          :focus, :fexample, :fit, :fspecify,
+          :ffeature, :fscenario
+        ].freeze
+
+        FOCUS_KEY = s(:sym, :focus)
+
+        FOCUS_TRUE_PAIR = s(:pair, FOCUS_KEY, s(:true))
+
+        def on_send(node)
+          _receiver, method_name, *_args = *node
+          @focusable_block = FOCUSABLE_BLOCKS.include?(method_name)
+          if FOCUSED_BLOCKS.include?(method_name)
+            add_offense(node, :expression, MESSAGE)
+          end
+
+          # check for :focus
+          return unless @focusable_block
+          node.children.any? do |n|
+            add_offense(n, :expression, MESSAGE) if n == FOCUS_KEY
+          end
+        end
+
+        def on_hash(node)
+          return unless @focusable_block
+          return if node.children.any? do |n|
+            if [FOCUS_TRUE_PAIR].include?(n)
+              add_offense(n, :expression, MESSAGE)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -17,36 +17,37 @@ module RuboCop
       #     expect(false).not_to be_true
       #   end
       class NotToNot < Cop
-        ACCEPTED_METHODS = [:not_to, :to_not].freeze
+        include RuboCop::Cop::ConfigurableEnforcedStyle
+
+        MSG = 'Prefer `%s` over `%s`'.freeze
+
+        METHOD_NAMES = [:not_to, :to_not].freeze
 
         def on_send(node)
           _receiver, method_name, *_args = *node
 
-          if method_name == rejected_method
-            add_offense(node, :expression, offense_message)
-          end
-        end
-
-        private
+          return unless METHOD_NAMES.include?(method_name)
 
-        def accepted_method
-          @accepted_method ||= begin
-            method = cop_config['AcceptedMethod'].to_sym
+          return if style == method_name
+          add_offense(node, :expression)
+        end
 
-            unless ACCEPTED_METHODS.include?(method)
-              raise "Invalid AcceptedMethod value: #{method}"
-            end
+        def message(node)
+          _receiver, method_name, *_args = *node
 
-            method
+          if method_name == :not_to
+            format(MSG, 'to_not', 'not_to')
+          else
+            format(MSG, 'not_to', 'to_not')
           end
         end
 
-        def rejected_method
-          @rejected_method ||= (ACCEPTED_METHODS - [accepted_method]).first
-        end
-
-        def offense_message
-          "Use `#{accepted_method}` instead of `#{rejected_method}`"
+        def autocorrect(node)
+          _receiver, method_name, *_args = *node
+          lambda do |corrector|
+            corrector.replace(node.loc.selector,
+                              method_name == :not_to ? 'to_not' : 'not_to')
+          end
         end
       end
     end

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

@@ -19,14 +19,24 @@ module RuboCop
       #   end
       class VerifiedDoubles < Cop
         MSG = 'Prefer using verifying doubles over normal doubles.'.freeze
+        DOUBLE_TYPES = [:double, :spy].freeze
 
         def on_send(node)
-          _receiver, method_name, *_args = *node
-          return unless method_name == :double
+          _receiver, method_name, *args = *node
+          name, *_stubs = *args
+          return unless DOUBLE_TYPES.include?(method_name)
+          return if name.nil?
+          return if name_is_symbol?(name) && cop_config['IgnoreSymbolicNames']
           add_offense(node,
                       :expression,
                       format(MSG, node.loc.expression.source))
         end
+
+        private
+
+        def name_is_symbol?(name)
+          name.children.first.is_a? Symbol
+        end
       end
     end
   end

data/lib/rubocop/rspec/version.rb

@@ -5,7 +5,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '1.4.1'.freeze
+      STRING = '1.5.0'.freeze
     end
   end
 end

data/rubocop-rspec.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^spec/})
   spec.extra_rdoc_files = ['MIT-LICENSE.md', 'README.md']
 
-  spec.add_runtime_dependency 'rubocop', '0.39.0'
+  spec.add_runtime_dependency 'rubocop', '>= 0.40.0'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.4'

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

@@ -4,9 +4,14 @@ describe RuboCop::Cop::RSpec::AnyInstance do
   subject(:cop) { described_class.new }
 
   it 'finds `allow_any_instance_of` instead of an instance double' do
-    inspect_source(cop, ['before do',
-                         '  allow_any_instance_of(Object).to receive(:foo)',
-                         'end'])
+    inspect_source(
+      cop,
+      [
+        'before do',
+        '  allow_any_instance_of(Object).to receive(:foo)',
+        'end'
+      ]
+    )
     expect(cop.messages)
       .to eq(['Avoid stubbing using `allow_any_instance_of`'])
     expect(cop.highlights).to eq(['allow_any_instance_of(Object)'])
@@ -14,9 +19,14 @@ describe RuboCop::Cop::RSpec::AnyInstance do
   end
 
   it 'finds `expect_any_instance_of` instead of an instance double' do
-    inspect_source(cop, ['before do',
-                         '  expect_any_instance_of(Object).to receive(:foo)',
-                         'end'])
+    inspect_source(
+      cop,
+      [
+        'before do',
+        '  expect_any_instance_of(Object).to receive(:foo)',
+        'end'
+      ]
+    )
     expect(cop.messages)
       .to eq(['Avoid stubbing using `expect_any_instance_of`'])
     expect(cop.highlights).to eq(['expect_any_instance_of(Object)'])
@@ -24,9 +34,14 @@ describe RuboCop::Cop::RSpec::AnyInstance do
   end
 
   it 'finds old `any_instance` syntax instead of an instance double' do
-    inspect_source(cop, ['before do',
-                         '  Object.any_instance.should_receive(:foo)',
-                         'end'])
+    inspect_source(
+      cop,
+      [
+        'before do',
+        '  Object.any_instance.should_receive(:foo)',
+        'end'
+      ]
+    )
     expect(cop.messages)
       .to eq(['Avoid stubbing using `any_instance`'])
     expect(cop.highlights).to eq(['Object.any_instance'])