https://github.com/dkarter/capybara_error_intel
🐛 Ruby gem for heuristic error messages in Capybara based Page Objects
https://github.com/dkarter/capybara_error_intel
capybara integration-testing page-object pageobject rails rspec ruby testing
Last synced: 2 months ago
JSON representation
🐛 Ruby gem for heuristic error messages in Capybara based Page Objects
- Host: GitHub
- URL: https://github.com/dkarter/capybara_error_intel
- Owner: dkarter
- License: mit
- Created: 2016-09-14T00:53:25.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T04:13:14.000Z (over 1 year ago)
- Last Synced: 2025-02-06T14:50:06.830Z (3 months ago)
- Topics: capybara, integration-testing, page-object, pageobject, rails, rspec, ruby, testing
- Language: Ruby
- Homepage: https://doriankarter.com
- Size: 908 KB
- Stars: 16
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/dkarter/capybara_error_intel) [](https://codeclimate.com/github/dkarter/capybara_error_intel) [](https://codeclimate.com/github/dkarter/capybara_error_intel/coverage) [](https://codeclimate.com/github/dkarter/capybara_error_intel) [](https://badge.fury.io/rb/capybara_error_intel) 
Capybara provides excellent error messages for its built in predicate methods: `has_selector?`, `has_text?`, `has_title?` etc., but when those are used from Page Objects while exposing predicate methods from the PageObjects themselves the error messages are lost and all we get is `expected true, got false`. Including this module into your PageObject by adding `include CapybaraErrorIntel::DSL` after `include Capybara::DSL` will return the heuristic error messages.
## Example
Turn this:
Into this:
## Installation
Add this line to your application's Gemfile:
```ruby
group :test do
gem 'capybara_error_intel'
end
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install capybara_error_intel
## Usage
Simply include at the top of your PageObject, **after** `include Capybara::DSL`.
Then use the built in Capybara::DSL as you are used to.
```ruby
module Pages
class PostIndex
include Capybara::DSL
include CapybaraErrorIntel::DSL
def on_page?
has_selector?('h1', text: 'Posts')
end
end
end
```
Now this page object can be used in an expressive assertion like so:
```ruby
feature "User signs in" do
scenario "redirected to posts index after sign in" do
#... do the sign in dance
post_index = Pages::PostIndex.new
expect(post_index).to be_on_page
end
end
```
Note: currently this gem only supports the following Capybara built-in predicate
methods:
- `has_selector?(*args)`
- `has_text?(*args)` (and `has_content?` alias)
- `has_title?(title, options={})`
- `has_css?(css, options={})`
- `has_button?(locator, options={})`
- `has_field?(locator, options={})`
- `has_xpath?(xpath, options={})`
- `has_checked_field?(locator, options={})`
- `has_unchecked_field?(locator, options={})`
- `has_select?(locator, options={})`
- `has_table?(locator, options={})`
It should be rather trivial to add more of them. Please open an issue or submit a pull request if something you need is missing.
### Accessing original predicate methods from your Page Object
If you ever need to access the overwritten Capybara predicate methods you can do
so by using Capybara's `page` for example:
```ruby
module Pages
class PostIndex
include Capybara::DSL
include CapybaraErrorIntel::DSL
def has_header?(header_text)
page.has_selector?('h1', text: header_text)
end
end
end
```
This will allow you to have negative assertions. That being said I strongly
discourage the use of negative assertions, especially with waiting Capybara
methods such as `has_selector?` since they can make your test suite really slow.
```ruby
expect(post_index_page).to_not have_header('POSTS')
```
> Note: I'm considering changing CapybaraErrorIntel for v2 to expose the
> predicate methods as bang methods, both positive and negative e.g.
> `has_selector!` and `has_no_selector!`. Please share your thoughts in the
> issues section.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Releasing a New Version
0. Add a version header to the top of CHANGELOG.md and list all changes as
bullets below the new version number
1. Change the version number in `lib/capybara_error_intel/version.rb`
2. In the project's directory run `gem build capybara_error_intel.gemspec`
3. Push the gem to RubyGems `gem push capybara_error_intel-##VERSION##.gem`
## Contributing
Bug reports and pull requests are welcome on GitHub at
https://github.com/dkarter/capybara_error_intel
Please make sure the test suite passes and that you added tests for any new
method implemented.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).