cucumber / cucumber/aruba

Clean up output matchers

Open
#545 2 comments 0 reactions 0 assignees View on GitHub
internal
Dominant language
Ruby
Stars
966
Forks
162
Avg merge
18h 51m
Merged PRs (30d)
8

Description

## Summary

There are several matchers defined by Aruba that are very similar to matchers provided by RSpec. For example:

* `include_output_string` and its aliases `an_output_string_including` and `file_content_including`. These seem similar to the `include` or perhaps `match` matchers.
* `include_an_object`. This seems similar to `include`.

## Expected Behavior

Aruba should use default RSpec matchers where possible to make its internal code comprehensible and to provide good examples for its users. Also, Aruba should not define generic matchers that may have to be supported beyond their internal use.

## Current Behavior

There's a proliferation of matchers that increase the maintenance burden.

## Possible Solution

Remove matchers that don't pull their weight.

## Context & Motivation

Improving the output of failing steps is hard because there are many custom matchers that all need to be checked.

Contributor guide

Open the contributing guide

Research direction

No files or tests are named; start by locating the definitions and usages of include_output_string, an_output_string_including, file_content_including, and include_an_object. Compare those usages with RSpec's default matchers, and consider the work done when redundant custom matchers are removed without losing relevant matcher behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
testing
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.