rubocop-rspec 1.24.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa8c9ef29194d2c818e26ab7304672b410755e182a6ff7476f58f933be307102
-  data.tar.gz: 6bd4ae51e5e90ea1dcb4217a4f741fa67b4a503dfd350205a6950b0cd2305397
+  metadata.gz: c195bc91134a73125f33d0675230a01fd467747690f3113ff3a924559d7c748c
+  data.tar.gz: 3f9fcaedd22ab9f67542b083ef72a6ab466df04a758c84f3e244176b781a6109
 SHA512:
-  metadata.gz: 70867c1789297dc3408df72fd6a0e831afec0238de3250c5446ce3385100f52ee3cc5962b2d3d4263ce4057bda07eddfc3f365921ce1049926030d0c3b21490c
-  data.tar.gz: 9d91b68565b10ba04221e4a516359e1bbc942e6e955bc4076937ae0c45fb317780b90c9d502e4e5eff5898b47d3e3fd9324cc00beb7613a33ffcb3f5f64c733e
+  metadata.gz: be3574c7d021a099bdd2869d47a908f4ac5c3ea9e12823030db025a92d24fd3d8008373b422b72e7e666cfefda0a983b3ae6d5f57e62c2dd14f99dc416d48ac3
+  data.tar.gz: 8bcad630c6244f19a896c061c15c94dbe9611f651d72306642bb980c2aa082b0d78d54f54e3b32544b475c4cbbb8a18dbe8631105cdbec4f6d12e0b81851b8b2

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## Master (Unreleased)
 
+## 1.25.0 (2018-04-07)
+
+* Add `RSpec/SharedExamples` cop to enforce consistent usage of string to titleize shared examples. ([@anthony-robin][])
+* Add `RSpec/Be` cop to enforce passing argument to the generic `be` matcher. ([@Darhazer][])
+* Fix false positives in `StaticAttributeDefinedDynamically` and `ReturnFromStub` when a const is used in an array or hash. ([@Darhazer][])
+* Add `RSpec/Pending` cop to enforce no existing pending or skipped examples.  This is disabled by default. ([@patrickomatic][])
+* Fix `RSpec/NestedGroups` cop support --auto-gen-config. ([@walf443][])
+* Fix false positives in `Capybara/FeatureMethods` when feature methods are used as property names in a factory. ([@Darhazer][])
+* Allow configuring enabled methods in `Capybara/FeatureMethods`. ([@Darhazer][])
+* Add `FactoryBot/CreateList` cop. ([@Darhazer][])
+
 ## 1.24.0 (2018-03-06)
 
 * Compatibility with RuboCop v0.53.0. ([@bquorning][])
@@ -316,3 +327,4 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@anthony-robin]: https://github.com/anthony-robin
 [@jojos003]: https://github.com/jojos003
 [@abrom]: https://github.com/abrom
+[@patrickomatic]: https://github.com/patrickomatic

data/Gemfile

@@ -3,8 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'codeclimate-test-reporter', '~> 1.0.0'
-  gem 'simplecov',                 '~> 0.12.0', require: false
+  gem 'simplecov', require: false
 end
 
 local_gemfile = 'Gemfile.local'

data/README.md

@@ -2,10 +2,9 @@
 
 [![Join the chat at https://gitter.im/rubocop-rspec/Lobby](https://badges.gitter.im/rubocop-rspec/Lobby.svg)](https://gitter.im/rubocop-rspec/Lobby)
 [![Gem Version](https://badge.fury.io/rb/rubocop-rspec.svg)](https://rubygems.org/gems/rubocop-rspec)
-[![Dependency Status](https://gemnasium.com/backus/rubocop-rspec.svg)](https://gemnasium.com/backus/rubocop-rspec)
-[![Build Status](https://secure.travis-ci.org/backus/rubocop-rspec.svg?branch=master)](http://travis-ci.org/backus/rubocop-rspec)
-[![Coverage Status](https://codeclimate.com/github/backus/rubocop-rspec/badges/coverage.svg)](https://codeclimate.com/github/backus/rubocop-rspec/coverage)
-[![Code Climate](https://codeclimate.com/github/backus/rubocop-rspec/badges/gpa.svg)](https://codeclimate.com/github/backus/rubocop-rspec)
+[![CircleCI](https://circleci.com/gh/rubocop-rspec/rubocop-rspec.svg?style=svg)](https://circleci.com/gh/rubocop-rspec/rubocop-rspec)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/f6254deb61671e357f30/test_coverage)](https://codeclimate.com/github/rubocop-rspec/rubocop-rspec/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f6254deb61671e357f30/maintainability)](https://codeclimate.com/github/rubocop-rspec/rubocop-rspec/maintainability)
 
 RSpec-specific analysis for your projects, as an extension to
 [RuboCop](https://github.com/bbatsov/rubocop).
@@ -60,6 +59,10 @@ end
 
 rubocop-rspec is available on Code Climate as part of the rubocop engine. [Learn More](https://codeclimate.com/changelog/55a433bbe30ba00852000fac).
 
+## Documentation
+
+You can read more about RuboCop-RSpec in its [official manual](http://rubocop-rspec.readthedocs.io).
+
 ## Inspecting files that don't end with `_spec.rb`
 
 By default, `rubocop-rspec` only inspects code within paths ending in `_spec.rb` or including `spec/`. You can override this setting in your config file by specifying one or more patterns:

data/Rakefile

@@ -12,6 +12,9 @@ rescue Bundler::BundlerError => e
 end
 
 require 'rspec/core/rake_task'
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
@@ -20,8 +23,6 @@ desc 'Run RSpec with code coverage'
 task :coverage do
   ENV['COVERAGE'] = 'true'
   Rake::Task['spec'].execute
-
-  sh('codeclimate-test-reporter') if ENV['CI']
 end
 
 desc 'Run RuboCop over this gem'
@@ -44,7 +45,21 @@ task confirm_config: :build_config do
   end
 end
 
-task default: %i[build_config coverage internal_investigation confirm_config]
+desc 'Confirm documentation is up to date'
+task confirm_documentation: :generate_cops_documentation do
+  _, _, _, process =
+    Open3.popen3('git diff --exit-code manual/')
+
+  unless process.value.success?
+    raise 'manual is out of sync, please add manual/ to the commit'
+  end
+end
+
+task default: %i[build_config coverage
+                 internal_investigation
+                 confirm_config
+                 documentation_syntax_check
+                 confirm_documentation]
 
 desc 'Generate a new cop template'
 task :new_cop, [:cop] do |_task, args|

data/config/default.yml

@@ -29,6 +29,11 @@ RSpec/AlignRightLetBrace:
   Enabled: false
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/AlignRightLetBrace
 
+RSpec/Be:
+  Description: Check for expectations where `be` is used without argument.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Be
+
 RSpec/BeEql:
   Description: Check for expectations where `be(...)` can replace `eql(...)`.
   Enabled: true
@@ -289,6 +294,11 @@ RSpec/OverwritingSetup:
   Description: Checks if there is a let/subject that overwrites an existing one.
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/OverwritingSetup
 
+RSpec/Pending:
+  Enabled: false
+  Description: Checks for any pending or skipped examples.
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Pending
+
 RSpec/RepeatedDescription:
   Enabled: true
   Description: Check for repeated description strings in example groups.
@@ -313,6 +323,11 @@ RSpec/SharedContext:
   Enabled: true
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/SharedContext
 
+RSpec/SharedExamples:
+  Description: Enforces use of string to titleize shared examples.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/SharedExamples
+
 RSpec/SingleArgumentMessageChain:
   Description: Checks that chains of messages contain more than one element.
   Enabled: true
@@ -362,8 +377,18 @@ Capybara/CurrentPathExpectation:
 Capybara/FeatureMethods:
   Description: Checks for consistent method usage in feature specs.
   Enabled: true
+  EnabledMethods: []
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Capybara/FeatureMethods
 
+FactoryBot/CreateList:
+  Description: Checks for create_list usage.
+  Enabled: true
+  EnforcedStyle: create_list
+  SupportedStyles:
+  - create_list
+  - n_times
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryBot/CreateList
+
 FactoryBot/DynamicAttributeDefinedStatically:
   Description: Prefer declaring dynamic attribute values in a block.
   Enabled: true

data/lib/rubocop-rspec.rb

@@ -6,6 +6,7 @@ require 'rubocop'
 require_relative 'rubocop/rspec'
 require_relative 'rubocop/rspec/version'
 require_relative 'rubocop/rspec/inject'
+require_relative 'rubocop/rspec/node'
 require_relative 'rubocop/rspec/top_level_describe'
 require_relative 'rubocop/rspec/wording'
 require_relative 'rubocop/rspec/util'
@@ -38,3 +39,5 @@ module RuboCop
     end
   end
 end
+
+RuboCop::AST::Node.include(RuboCop::RSpec::Node)

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

@@ -0,0 +1,35 @@
+module RuboCop
+  module Cop
+    module RSpec
+      # Check for expectations where `be` is used without argument.
+      #
+      # The `be` matcher is too generic, as it pass on everything that is not
+      # nil or false. If that is the exact intend, use `be_truthy`. In all other
+      # cases it's better to specify what exactly is the expected value.
+      #
+      # @example
+      #
+      #   # bad
+      #   expect(foo).to be
+      #
+      #   # good
+      #   expect(foo).to be_truthy
+      #   expect(foo).to be 1.0
+      #   expect(foo).to be(true)
+      #
+      class Be < Cop
+        MSG = 'Don\'t use `be` without an argument.'.freeze
+
+        def_node_matcher :be_without_args, <<-PATTERN
+          (send _ {:to :not_to :to_not} $(send nil? :be))
+        PATTERN
+
+        def on_send(node)
+          be_without_args(node) do |matcher|
+            add_offense(matcher, location: :selector)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec/capybara/feature_methods.rb

@@ -6,6 +6,14 @@ module RuboCop
       module Capybara
         # Checks for consistent method usage in feature specs.
         #
+        # By default, the cop disables all Capybara-specific methods that have
+        # the same native RSpec method (e.g. are just aliases). Some teams
+        # however may prefer using some of the Capybara methods (like `feature`)
+        # to make it obvious that the test uses Capybara, while still disable
+        # the rest of the methods, like `given` (alias for `let`), `background`
+        # (alias for `before`), etc. You can configure which of the methods to
+        # be enabled by using the EnabledMethods configuration option.
+        #
         # @example
         #   # bad
         #   feature 'User logs in' do
@@ -45,6 +53,12 @@ module RuboCop
             feature:    :describe
           }.freeze
 
+          def_node_matcher :spec?, <<-PATTERN
+            (block
+              (send {(const nil? :RSpec) nil?} {:describe :feature} ...)
+            ...)
+          PATTERN
+
           def_node_matcher :feature_method, <<-PATTERN
             (block
               $(send {(const nil? :RSpec) nil?} ${#{MAP.keys.map(&:inspect).join(' ')}} ...)
@@ -52,7 +66,11 @@ module RuboCop
           PATTERN
 
           def on_block(node)
+            return unless spec?(root_node)
+
             feature_method(node) do |send_node, match|
+              next if enabled?(match)
+
               add_offense(
                 send_node,
                 location: :selector,
@@ -66,6 +84,22 @@ module RuboCop
               corrector.replace(node.loc.selector, MAP[node.method_name].to_s)
             end
           end
+
+          private
+
+          def root_node
+            processed_source.ast
+          end
+
+          def enabled?(method_name)
+            enabled_methods.include?(method_name)
+          end
+
+          def enabled_methods
+            cop_config
+              .fetch('EnabledMethods', [])
+              .map(&:to_sym)
+          end
         end
       end
     end

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

@@ -8,12 +8,12 @@ module RuboCop
       # @example
       #   # bad
       #   describe :my_method do
-      #     ...
+      #     # ...
       #   end
       #
       #   # good
       #   describe '#my_method' do
-      #     ...
+      #     # ...
       #   end
       #
       # @see https://github.com/rspec/rspec-core/issues/1610

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

@@ -36,9 +36,9 @@ module RuboCop
       # @example configuration
       #
       #   # .rubocop.yml
-      #   RSpec/EmptyExampleGroup:
-      #     CustomIncludeMethods:
-      #     - include_tests
+      #   # RSpec/EmptyExampleGroup:
+      #   #   CustomIncludeMethods:
+      #   #   - include_tests
       #
       #   # spec_helper.rb
       #   RSpec.configure do |config|

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

@@ -72,8 +72,7 @@ module RuboCop
         private
 
         def check_example_without_description(node)
-          _send, _method, arg = *node
-          return unless arg.nil?
+          return if node.arguments?
           return unless disallow_empty_description?(node)
 
           add_offense(node, message: MSG_ADD_DESCRIPTION)

data/lib/rubocop/cop/rspec/factory_bot/create_list.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module FactoryBot
+        # Checks for create_list usage.
+        #
+        # This cop can be configured using the `EnforcedStyle` option
+        #
+        # @example `EnforcedStyle: create_list`
+        #   # bad
+        #   3.times { create :user }
+        #
+        #   # good
+        #   create_list :user, 3
+        #
+        #   # good
+        #   3.times { |n| create :user, created_at: n.months.ago }
+        #
+        # @example `EnforcedStyle: n_times`
+        #   # bad
+        #   create_list :user, 3
+        #
+        #   # good
+        #   3.times { create :user }
+        class CreateList < Cop
+          include ConfigurableEnforcedStyle
+
+          MSG_CREATE_LIST = 'Prefer create_list.'.freeze
+          MSG_N_TIMES = 'Prefer %<number>s.times.'.freeze
+
+          def_node_matcher :n_times_block?, <<-PATTERN
+            (block
+              (send (int _) :times)
+              ...
+            )
+          PATTERN
+
+          def_node_matcher :factory_call, <<-PATTERN
+            (send ${(const nil? {:FactoryGirl :FactoryBot}) nil?} :create (sym $_) $...)
+          PATTERN
+
+          def_node_matcher :factory_list_call, <<-PATTERN
+            (send ${(const nil? {:FactoryGirl :FactoryBot}) nil?} :create_list (sym $_) (int $_) $...)
+          PATTERN
+
+          def on_block(node)
+            return unless style == :create_list
+            return unless n_times_block?(node)
+            return unless contains_only_factory?(node.body)
+
+            add_offense(node.send_node,
+                        location: :expression, message: MSG_CREATE_LIST)
+          end
+
+          def on_send(node)
+            return unless style == :n_times
+
+            factory_list_call(node) do |_receiver, _factory, count, _|
+              add_offense(
+                node,
+                location: :selector,
+                message: format(MSG_N_TIMES, number: count)
+              )
+            end
+          end
+
+          def autocorrect(node)
+            if style == :create_list
+              autocorrect_n_times_to_create_list(node)
+            else
+              autocorrect_create_list_to_n_times(node)
+            end
+          end
+
+          private
+
+          def contains_only_factory?(node)
+            if node.block_type?
+              factory_call(node.send_node)
+            else
+              factory_call(node)
+            end
+          end
+
+          def autocorrect_n_times_to_create_list(node)
+            block = node.parent
+            count = block.receiver.source
+            replacement = factory_call_replacement(block.body, count)
+
+            lambda do |corrector|
+              corrector.replace(block.loc.expression, replacement)
+            end
+          end
+
+          def autocorrect_create_list_to_n_times(node)
+            replacement = generate_n_times_block(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, replacement)
+            end
+          end
+
+          def generate_n_times_block(node)
+            receiver, factory, count, options = *factory_list_call(node)
+
+            arguments = ":#{factory}"
+            options = build_options_string(options)
+            arguments += ", #{options}" unless options.empty?
+
+            replacement = format_receiver(receiver)
+            replacement += format_method_call(node, 'create', arguments)
+            "#{count}.times { #{replacement} }"
+          end
+
+          def factory_call_replacement(body, count)
+            receiver, factory, options = *factory_call(body)
+
+            arguments = ":#{factory}, #{count}"
+            options = build_options_string(options)
+            arguments += ", #{options}" unless options.empty?
+
+            replacement = format_receiver(receiver)
+            replacement += format_method_call(body, 'create_list', arguments)
+            replacement
+          end
+
+          def build_options_string(options)
+            options.map(&:source).join(', ')
+          end
+
+          def format_method_call(node, method, arguments)
+            if node.parenthesized?
+              "#{method}(#{arguments})"
+            else
+              "#{method} #{arguments}"
+            end
+          end
+
+          def format_receiver(receiver)
+            return '' unless receiver
+            "#{receiver.source}."
+          end
+        end
+      end
+    end
+  end
+end