rubocop-rspec 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da531fd6da6c4bc5ffa7012451f5d496e876621d
-  data.tar.gz: 68cf66d909464963445c3d5edff27f434bea6d5c
+  metadata.gz: 920ff6aef932dcc189cf4a9b36a4da113414e514
+  data.tar.gz: 924b473a982bea7b74862f9d38c7adebd54b0d15
 SHA512:
-  metadata.gz: 4b97442d8f7fa551ffd4c85f76ca2bdfea664bc09a5ca5f3580f70c5c4f498da522017ef6a02b48caa0b8c8b9c6925f1edbfaf3f524265a6808b1cc01746732e
-  data.tar.gz: 4f228565a1e5842f9332b4af0dbd02084dc4203ab58c0f3f888560ac385af243ed66b4789596e621d669bdf1da1bdb3dd664f0d094981f54b525668b2fcc07a8
+  metadata.gz: 95f9ed3893655f17e5d78fbe03decd86deb93fab86db2599f2848795c035eeea9e4347df6b3700f3cc6e31599bd76e37ab4ab57477a9c17b9cf462c479bafb9a
+  data.tar.gz: ad2e034857001d8fd654008c96446fb48641dde3787a2ace21709005c2c185f8fa2a370a11e7dca03d42ccb428f1d110de574eaf286bf17447f92b8bc08dd2c5

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Master (Unreleased)
 
+## 1.17.0 (2017-09-14)
+
+* Add `RSpec/Capybara` namespace including the first cop for feature specs: `Capybara/FeatureMethods`. ([@rspeicher][])
+* Update to RuboCop 0.50.0. ([@bquorning][])
+
 ## 1.16.0 (2017-09-06)
 
 * Add `RSpec/FactoryGirl` namespace including the first cop for factories: `FactoryGirl/DynamicAttributeDefinedStatically`. ([@jonatas][])
@@ -26,7 +31,7 @@
 
 ## 1.15.0 (2017-03-24)
 
-* Add `RSpec/DescribeSymbol` cop. ([@tsigo][])
+* Add `RSpec/DescribeSymbol` cop. ([@rspeicher][])
 * Fix error when `RSpec/OverwritingSetup` and `RSpec/ScatteredLet` analyzed empty example groups. ([@backus][])
 
 ## 1.14.0 (2017-03-24)
@@ -233,7 +238,7 @@
 [@redross]: https://github.com/redross
 [@cfabianski]: https://github.com/cfabianski
 [@dgollahon]: https://github.com/dgollahon
-[@tsigo]: https://github.com/tsigo
+[@rspeicher]: https://github.com/rspeicher
 [@jonatas]: https://github.com/jonatas
 [@pocke]: https://github.com/pocke
 [@bmorrall]: https:/github.com/bmorrall

data/config/default.yml

@@ -325,7 +325,12 @@ RSpec/VoidExpect:
   Enabled: true
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/VoidExpect
 
+Capybara/FeatureMethods:
+  Description: Checks for consistent method usage in feature specs.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Capybara/FeatureMethods
+
 FactoryGirl/DynamicAttributeDefinedStatically:
   Description: Prefer declaring dynamic attribute values in a block.
   Enabled: true
-  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/FactoryGirl/DynamicAttributeDefinedStatically
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FactoryGirl/DynamicAttributeDefinedStatically

data/lib/rubocop-rspec.rb

@@ -17,6 +17,7 @@ require 'rubocop/rspec/example'
 require 'rubocop/rspec/hook'
 require 'rubocop/cop/rspec/cop'
 require 'rubocop/rspec/align_let_brace'
+require 'rubocop/rspec/capybara'
 require 'rubocop/rspec/factory_girl'
 
 RuboCop::RSpec::Inject.defaults!
@@ -28,6 +29,7 @@ require 'rubocop/cop/rspec/any_instance'
 require 'rubocop/cop/rspec/around_block'
 require 'rubocop/cop/rspec/be_eql'
 require 'rubocop/cop/rspec/before_after_all'
+require 'rubocop/cop/rspec/capybara/feature_methods'
 require 'rubocop/cop/rspec/describe_class'
 require 'rubocop/cop/rspec/describe_method'
 require 'rubocop/cop/rspec/describe_symbol'

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      module Capybara
+        # Checks for consistent method usage in feature specs.
+        #
+        # @example
+        #   # bad
+        #   feature 'User logs in' do
+        #     given(:user) { User.new }
+        #
+        #     background do
+        #       visit new_session_path
+        #     end
+        #
+        #     scenario 'with OAuth' do
+        #       # ...
+        #     end
+        #   end
+        #
+        #   # good
+        #   describe 'User logs in' do
+        #     let(:user) { User.new }
+        #
+        #     before do
+        #       visit new_session_path
+        #     end
+        #
+        #     it 'with OAuth' do
+        #       # ...
+        #     end
+        #   end
+        class FeatureMethods < Cop
+          MSG = 'Use `%s` instead of `%s`.'.freeze
+
+          # https://git.io/v7Kwr
+          MAP = {
+            background: :before,
+            scenario:   :it,
+            xscenario:  :xit,
+            given:      :let,
+            given!:     :let!,
+            feature:    :describe
+          }.freeze
+
+          def_node_matcher :feature_method?, <<-PATTERN
+            (send {(const nil :RSpec) nil} ${:#{MAP.keys.join(' :')}} ...)
+          PATTERN
+
+          def on_send(node)
+            feature_method?(node) do |match|
+              add_offense(node, :selector, format(MSG, MAP[match], match))
+            end
+          end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.selector, MAP[node.method_name].to_s)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -40,7 +40,7 @@ module RuboCop
           key_parts = [example.metadata, example.implementation]
 
           if example.definition.method_name == :its
-            key_parts << example.definition.method_args
+            key_parts << example.definition.arguments
           end
 
           key_parts

data/lib/rubocop/rspec/capybara.rb

@@ -0,0 +1,7 @@
+module RuboCop
+  module RSpec
+    # RuboCop Capybara project namespace
+    module Capybara
+    end
+  end
+end

data/lib/rubocop/rspec/config_formatter.rb

@@ -4,8 +4,8 @@ module RuboCop
   module RSpec
     # Builds a YAML config file from two config hashes
     class ConfigFormatter
-      NAMESPACES = /^(#{Regexp.union('RSpec', 'FactoryGirl')})/
-      STYLE_GUIDE_BASE_URL = 'http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'.freeze
+      NAMESPACES = /^(#{Regexp.union('RSpec', 'Capybara', 'FactoryGirl')})/
+      STYLE_GUIDE_BASE_URL = 'http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/'.freeze
 
       def initialize(config, descriptions)
         @config       = config
@@ -22,7 +22,7 @@ module RuboCop
         cops.each_with_object(config.dup) do |cop, unified|
           unified[cop] = config.fetch(cop)
             .merge(descriptions.fetch(cop))
-            .merge('StyleGuide' => STYLE_GUIDE_BASE_URL + cop)
+            .merge('StyleGuide' => STYLE_GUIDE_BASE_URL + cop.sub('RSpec/', ''))
         end
       end
 

data/lib/rubocop/rspec/hook.rb

@@ -42,7 +42,7 @@ module RuboCop
       end
 
       def scope_argument
-        node.method_args.first
+        node.send_node.first_argument
       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.16.0'.freeze
+      STRING = '1.17.0'.freeze
     end
   end
 end

data/rubocop-rspec.gemspec

@@ -1,15 +1,13 @@
-# encoding: utf-8
-
 $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 require 'rubocop/rspec/version'
 
 Gem::Specification.new do |spec|
   spec.name = 'rubocop-rspec'
   spec.summary = 'Code style checking for RSpec files'
-  spec.description = <<-end_description
+  spec.description = <<-DESCRIPTION
     Code style checking for RSpec files.
     A plugin for the RuboCop code style enforcing & linting tool.
-  end_description
+  DESCRIPTION
   spec.homepage = 'http://github.com/backus/rubocop-rspec'
   spec.authors = ['John Backus', 'Ian MacLeod', 'Nils Gemeinhardt']
   spec.email = [
@@ -34,7 +32,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.49.0'
+  spec.add_runtime_dependency 'rubocop', '>= 0.50.0'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.4'

data/spec/project/default_config_spec.rb

@@ -6,10 +6,11 @@ RSpec.describe 'config/default.yml' do
   let(:cop_names) do
     namespaces = {
       'rspec' => 'RSpec',
+      'capybara' => 'Capybara',
       'factory_girl' => 'FactoryGirl'
     }
     glob = SpecHelper::ROOT.join('lib', 'rubocop', 'cop',
-                                 'rspec', '{,factory_girl/}*.rb')
+                                 'rspec', '{capybara/,,factory_girl/}*.rb')
     cop_names =
       Pathname.glob(glob).map do |file|
         file_name = file.basename('.rb').to_s

data/spec/rubocop/cop/rspec/capybara/feature_methods_spec.rb

@@ -0,0 +1,52 @@
+RSpec.describe RuboCop::Cop::RSpec::Capybara::FeatureMethods do
+  subject(:cop) { described_class.new }
+
+  it 'flags violations for `background`' do
+    expect_offense(<<-RUBY)
+      background do; end
+      ^^^^^^^^^^ Use `before` instead of `background`.
+    RUBY
+  end
+
+  it 'flags violations for `scenario`' do
+    expect_offense(<<-RUBY)
+      scenario 'Foo' do; end
+      ^^^^^^^^ Use `it` instead of `scenario`.
+    RUBY
+  end
+
+  it 'flags violations for `xscenario`' do
+    expect_offense(<<-RUBY)
+      RSpec.xscenario 'Foo' do; end
+            ^^^^^^^^^ Use `xit` instead of `xscenario`.
+    RUBY
+  end
+
+  it 'flags violations for `given`' do
+    expect_offense(<<-RUBY)
+      given(:foo) { :foo }
+      ^^^^^ Use `let` instead of `given`.
+    RUBY
+  end
+
+  it 'flags violations for `given!`' do
+    expect_offense(<<-RUBY)
+      given!(:foo) { :foo }
+      ^^^^^^ Use `let!` instead of `given!`.
+    RUBY
+  end
+
+  it 'flags violations for `feature`' do
+    expect_offense(<<-RUBY)
+      RSpec.feature 'Foo' do; end
+            ^^^^^^^ Use `describe` instead of `feature`.
+    RUBY
+  end
+
+  include_examples 'autocorrect', 'background { }',    'before { }'
+  include_examples 'autocorrect', 'scenario { }',      'it { }'
+  include_examples 'autocorrect', 'xscenario { }',     'xit { }'
+  include_examples 'autocorrect', 'given(:foo) { }',   'let(:foo) { }'
+  include_examples 'autocorrect', 'given!(:foo) { }',  'let!(:foo) { }'
+  include_examples 'autocorrect', 'RSpec.feature { }', 'RSpec.describe { }'
+end

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

@@ -140,7 +140,6 @@ RSpec.describe RuboCop::Cop::RSpec::ExpectActual, :config do
 
     it 'ignores rspec-rails routing specs' do
       inspect_source(
-        cop,
         'expect(get: "/foo").to be_routeable',
         'spec/routing/foo_spec.rb'
       )

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 RSpec.describe RuboCop::Cop::RSpec::HookArgument, :config do
   subject(:cop) { described_class.new(config) }
 

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 RSpec.describe RuboCop::Cop::RSpec::ItBehavesLike, :config do
   subject(:cop) { described_class.new(config) }
 

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

@@ -77,7 +77,7 @@ RSpec.describe RuboCop::Cop::RSpec::LetBeforeExamples do
   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') }
+    expect { inspect_source('RSpec.describe(User) do end', 'a_spec.rb') }
       .not_to raise_error
   end
 end

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

@@ -163,7 +163,7 @@ RSpec.describe RuboCop::Cop::RSpec::MultipleExpectations, :config do
   end
 
   it 'generates a todo based on the worst violation' do
-    inspect_source(cop, <<-RUBY, 'spec/foo_spec.rb')
+    inspect_source(<<-RUBY, 'spec/foo_spec.rb')
       describe Foo do
         it 'uses expect twice' do
           expect(foo).to eq(bar)

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

@@ -29,7 +29,7 @@ RSpec.describe RuboCop::Cop::RSpec::MultipleSubjects do
       end
     RUBY
 
-    expect(autocorrect_source(cop, source, 'example_spec.rb')).to eql(source)
+    expect(autocorrect_source(source, 'example_spec.rb')).to eql(source)
   end
 
   it 'does not flag shared example groups' do

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

@@ -56,7 +56,7 @@ RSpec.describe RuboCop::Cop::RSpec::NestedGroups, :config do
     let(:cop_config) { { 'MaxNesting' => '1' } }
 
     it 'emits a deprecation warning' do
-      expect { inspect_source(cop, 'describe(Foo) { }', 'foo_spec.rb') }
+      expect { inspect_source('describe(Foo) { }', 'foo_spec.rb') }
         .to output(
           'Configuration key `MaxNesting` for RSpec/NestedGroups is ' \
           "deprecated in favor of `Max`. Please use that instead.\n"

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

@@ -45,7 +45,7 @@ RSpec.describe RuboCop::Cop::RSpec::OverwritingSetup do
   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') }
+    expect { inspect_source('RSpec.describe(User) do end', 'a_spec.rb') }
       .not_to raise_error
   end
 end

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

@@ -25,7 +25,7 @@ RSpec.describe RuboCop::Cop::RSpec::ScatteredLet do
   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') }
+    expect { inspect_source('RSpec.describe(User) do end', 'a_spec.rb') }
       .not_to raise_error
   end
 end

data/spec/shared/autocorrect_behavior.rb

@@ -1,6 +1,6 @@
 RSpec.shared_examples 'autocorrect' do |original, corrected|
   it "autocorrects `#{original}` to `#{corrected}`" do
-    autocorrected = autocorrect_source(cop, original, 'spec/foo_spec.rb')
+    autocorrected = autocorrect_source(original, 'spec/foo_spec.rb')
 
     expect(autocorrected).to eql(corrected)
   end

data/spec/shared/detects_style_behavior.rb

@@ -1,6 +1,6 @@
 RSpec.shared_examples 'detects style' do |source, style, filename: 'x_spec.rb'|
   it 'generates a todo based on the detected style' do
-    inspect_source(cop, source, filename)
+    inspect_source(source, filename)
 
     expect(cop.config_to_allow_offenses).to eq('EnforcedStyle' => style)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-06 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.50.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,7 @@ files:
 - lib/rubocop/cop/rspec/around_block.rb
 - lib/rubocop/cop/rspec/be_eql.rb
 - lib/rubocop/cop/rspec/before_after_all.rb
+- lib/rubocop/cop/rspec/capybara/feature_methods.rb
 - lib/rubocop/cop/rspec/cop.rb
 - lib/rubocop/cop/rspec/describe_class.rb
 - lib/rubocop/cop/rspec/describe_method.rb
@@ -157,6 +158,7 @@ files:
 - lib/rubocop/cop/rspec/void_expect.rb
 - lib/rubocop/rspec.rb
 - lib/rubocop/rspec/align_let_brace.rb
+- lib/rubocop/rspec/capybara.rb
 - lib/rubocop/rspec/concept.rb
 - lib/rubocop/rspec/config_formatter.rb
 - lib/rubocop/rspec/description_extractor.rb
@@ -181,6 +183,7 @@ files:
 - spec/rubocop/cop/rspec/around_block_spec.rb
 - spec/rubocop/cop/rspec/be_eql_spec.rb
 - spec/rubocop/cop/rspec/before_after_all_spec.rb
+- spec/rubocop/cop/rspec/capybara/feature_methods_spec.rb
 - spec/rubocop/cop/rspec/cop_spec.rb
 - spec/rubocop/cop/rspec/describe_class_spec.rb
 - spec/rubocop/cop/rspec/describe_method_spec.rb
@@ -274,6 +277,7 @@ test_files:
 - spec/rubocop/cop/rspec/around_block_spec.rb
 - spec/rubocop/cop/rspec/be_eql_spec.rb
 - spec/rubocop/cop/rspec/before_after_all_spec.rb
+- spec/rubocop/cop/rspec/capybara/feature_methods_spec.rb
 - spec/rubocop/cop/rspec/cop_spec.rb
 - spec/rubocop/cop/rspec/describe_class_spec.rb
 - spec/rubocop/cop/rspec/describe_method_spec.rb