CapybaraSelect2 for select2 version 2/3/4
!!! CapybaraSelect2 detects select2 version automatically
Installation
Add this line to your application's Gemfile:
group :test do
gem 'capybara-select-2'
end
And then execute:
$ bundle
Or install it with gem install
command:
$ gem install capybara-select-2
Configuration
Minitest
# application_system_test_case.rb
class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
include CapybaraSelect2
include CapybaraSelect2::Helpers # if need specific helpers
end
Rspec
# spec_helper.rb
RSpec.configure do |config|
config.include CapybaraSelect2
config.include CapybaraSelect2::Helpers # if need specific helpers
end
[Note] In RSpec tests select2
helper is available out of the box
Cucumber
# env.rb
World CapybaraSelect2
World CapybaraSelect2::Helpers # if need specific helpers
Usage
Examples
select2 'Buy Milk', css: '#todo'
select2 'Buy Milk', xpath: '//div[@id="todo"]'
select2 'Buy Milk', from: 'Things to do'
select2 'Buy Milk', 'Go to gym', css: '#todo'
select2 'Buy Milk', from: 'Things to do', search: true
select2 'Buy Milk', from: 'Things to do', search: 'Buy'
select2 'Millennials', from: 'Generation', tag: true
[Note] CSS and XPath selectors must identify an HTML node that wraps select2 element or a select2 element itself (an HTML element with the .select2-container
class)
Options
Option | Purpose |
---|---|
css | Identify select2 element by a CSS selector |
xpath | Identify select2 element by an XPath selector |
from | Identify select2 element by a label |
search | Search for an option by the passed string. Search by an option text if true passed |
tag | Create an option |
match | Specifies Capybara's matching strategy when selecting an option |
exact_text | Whether an option text must match exactly |
Helpers
Specific select2 helpers that allow more refined access to select2 control
select2_open label: 'Todo'
select2_close
select2_search 'Milk', css: '#todo'
select2_select 'Buy Milk', from: 'Todo'
select2_clear xpath: "//div[@id='todo']"
Helper | Purpose |
---|---|
select2_open | Open select2 control |
select2_close | Close select2 control |
select2_search | Type into a select2 search field |
select2_select | Select an option from an opened select2 control |
select2_clear | Remove selected options (for multi select only) |
[!Note] Helpers above are not available in tests by default. To use them include CapybaraSelect2::Helpers
in your test invironment (see Configuration section)
RSpec matchers
# Check that a select2 option with specified text is present on the page
expect(page).to have_select2_option 'Buy Milk'
Testing
See test examples
To see test examples for a specific select2 version, start Sinatra app first:
$ rackup spec/support/select2_examples/config.ru
Visit http://localhost:9292/select2/v4.0.5/examples in your browser to see examples for select2 version 4.0.5
Running tests
# run spec cases for all select2 versions
$ bundle exec rspec
# run spec cases for a specific select2 version
$ SELECT2_VERSION=4.0.5 bundle exec rspec spec/shared
Contributing
- Add a test case which covers the bug
- Add code which makes the test green
- Open pull request
License
The gem is available as open source under the terms of the MIT License.