Capybara

Capybara/CurrentPathExpectation

Enabled by default Supports autocorrection

Enabled

Yes

Checks that no expectations are set on Capybara’s current_path.

The have_current_path matcher (https://www.rubydoc.info/github/ teamcapybara/capybara/master/Capybara/RSpecMatchers#have_current_path- instance_method) should be used on page to set expectations on Capybara’s current path, since it uses Capybara’s waiting functionality (https://github.com/teamcapybara/capybara/blob/master/ README.md#asynchronous-javascript-ajax-and-friends) which ensures that preceding actions (like click_link) have completed.

Examples

# bad
expect(current_path).to eq('/callback')
expect(page.current_path).to match(/widgets/)

# good
expect(page).to have_current_path("/callback")
expect(page).to have_current_path(/widgets/)

Capybara/FeatureMethods

Enabled by default Supports autocorrection

Enabled

Yes

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.

Examples

# 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

Configurable attributes

Name Default value Configurable values

EnabledMethods

[]

Array

Capybara/VisibilityMatcher

Enabled by default Supports autocorrection

Enabled

No

Checks for boolean visibility in capybara finders.

Capybara lets you find elements that match a certain visibility using the :visible option. :visible accepts both boolean and symbols as values, however using booleans can have unwanted effects. visible: false does not find just invisible elements, but both visible and invisible elements. For expressiveness and clarity, use one of the symbol values, :all, :hidden or :visible. (https://www.rubydoc.info/gems/capybara/Capybara%2FNode%2FFinders:all)

Examples

# bad
expect(page).to have_selector('.foo', visible: false)
expect(page).to have_css('.foo', visible: true)
expect(page).to have_link('my link', visible: false)

# good
expect(page).to have_selector('.foo', visible: :visible)
expect(page).to have_css('.foo', visible: :all)
expect(page).to have_link('my link', visible: :hidden)

Configurable attributes

Name Default value Configurable values

VersionAdded

1.39

String