Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryancyq/rspec-activesupport
RSpec matcher for ActiveSupport test assertions
https://github.com/ryancyq/rspec-activesupport
activesupport rspec testing
Last synced: 2 months ago
JSON representation
RSpec matcher for ActiveSupport test assertions
- Host: GitHub
- URL: https://github.com/ryancyq/rspec-activesupport
- Owner: ryancyq
- License: mit
- Created: 2024-07-27T08:39:50.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-03T07:53:18.000Z (3 months ago)
- Last Synced: 2024-10-03T07:55:50.894Z (3 months ago)
- Topics: activesupport, rspec, testing
- Language: Ruby
- Homepage:
- Size: 41 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# rspec-activesupport
[![Version][rubygems_badge]][rubygems]
[![CI][ci_badge]][ci_workflows]
[![Maintainability][maintainability_badge]][maintainability]
`rspec-activesupport` provides ActiveSupport test assertions through [RSpec][rspec] matchers.
### Assertions Supported
- `ActiveSupport::Deprecation.warn`: RSpec expectation on deprecations being warned.
## Requirements
- Ruby: MRI 2.5+
- ActiveSupport: 6.1+
- RSpec-Expectations: 3.0+
## Installation
Add `rspec-activesupport` to both the `:development` and `:test` groups of your Gemfile:
```rb
group :development, :test do
gem "rspec-activesupport", "~> 0.1"
end
```
Or execute the following command in bash:
```sh
bundle add rspec-activesupport --group development,test
```
If Bundler is not being used to manage dependencies, install the gem by executing:
```sh
gem install rspec-activesupport
```
### Setup (Optional)
If you want to configure the entire RSpec suite with the same deprecator, add the following to `spec_helper.rb`, which is usually used to load RSpec configuration:
```rb
# /spec/spec_helper.rb
require "rspec/active_support"
RSpec.configure do |config|
config.deprecator = MyGem.deprecator
end
```
### Usage
With that, you can start using the matchers provided by the gem.
```rb
describe "#deprecator" do
let(:deprecate) { MyGem.deprecator.warn "my deprecation" }
it "warn deprecation" do
expect { deprecate }.to warn_deprecation(%r{my deprecation})
end
end
```
Or you can pass the deprecator explicitly to the matcher:
```rb
describe "#deprecator" do
let(:deprecate) { MyGem.deprecator.warn "my deprecation" }
it "warn deprecation" do
expect { deprecate }.to warn_deprecation(%r{my deprecation}, MyGem.deprecator)
end
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## License
Please see [LICENSE](https://github.com/ryancyq/rspec-activesupport/blob/main/LICENSE) for licensing details.
## Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/ryancyq/rspec-activesupport](https://github.com/ryancyq/rspec-activesupport).
[rubygems_badge]: https://img.shields.io/gem/v/rspec-activesupport.svg
[rubygems]: https://rubygems.org/gems/rspec-activesupport
[ci_badge]: https://github.com/ryancyq/rspec-activesupport/actions/workflows/ci.yml/badge.svg
[ci_workflows]: https://github.com/ryancyq/rspec-activesupport/actions/workflows/ci.yml
[maintainability_badge]: https://api.codeclimate.com/v1/badges/f956ddf9381ba82cd473/maintainability
[maintainability]: https://codeclimate.com/github/ryancyq/rspec-activesupport/maintainability
[rspec]: https://rspec.info/