Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaredbeck/minitest_to_rspec
Converts minitest files to rspec
https://github.com/jaredbeck/minitest_to_rspec
Last synced: 13 days ago
JSON representation
Converts minitest files to rspec
- Host: GitHub
- URL: https://github.com/jaredbeck/minitest_to_rspec
- Owner: jaredbeck
- License: mit
- Created: 2015-03-25T03:23:52.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-02-04T16:25:44.000Z (almost 5 years ago)
- Last Synced: 2024-10-23T11:38:40.317Z (21 days ago)
- Language: Ruby
- Size: 271 KB
- Stars: 81
- Watchers: 2
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MinitestToRspec
Converts [minitest][8] files to [rspec][9].
[![Build Status][1]][2]
- Selected assertions from [Test::Unit][26], [minitest][8],
and [ActiveSupport][27] are converted to [rspec-expectations][25].
- Selected methods from [mocha][28] are converted to [rspec-mocks][24].
(Experimental)
- Selected methods from [shoulda-context][36]
## Example
Input:
```ruby
require 'test_helper'
class ArrayTest < ActiveSupport::TestCase
test "changes length" do
ary = []
assert_difference "ary.length" do
ary.push(:x)
end
end
end
```
Output:
```ruby
require("spec_helper")
RSpec.describe(Array) do
it("changes length") do
ary = []
expect { ary.push(:x) }.to(change { ary.length })
end
end
```
You might not like the code style of the output. More on that below.
## Install
```bash
gem install minitest_to_rspec
```
## Usage
### CLI
```bash
mt2rspec [--rails] [--mocha] source_file [target_file]
mt2rspec --help
```
### Ruby
```ruby
require 'minitest_to_rspec'
converter = MinitestToRspec::Converter.new(rails: false, mocha: false)
converter.convert("assert('banana')")
#=> "expect(\"banana\").to(be_truthy)"
```
## Output
The only goal is correctness. [Code style][34] is not a consideration.
Providing the level of configuration necessary to make everyone happy would
be a huge distraction from the main purpose.
After conversion, I recommend using [rubocop][35]'s awesome `--auto-correct`
feature to apply your preferred code style.
Comments are discarded by [ruby_parser][14], so we have no way of
preserving them.
## Supported Assertions
Selected assertions from [minitest][8], [Test::Unit][26], and
[ActiveSupport][27]. See [doc/supported_assertions.md][5] for rationale.
Contributions are welcome.
Assertion | Arity | Source
--------------------------- | ----- | ------
assert | |
assert_difference | 1,2 |
[assert_equal][23] | 2,3 | Test::Unit
[assert_not_equal][22] | 2,3 | Test::Unit
assert_match | |
assert_nil | |
assert_not_nil | |
[assert_no_difference][12] | | ActiveSupport
[assert_nothing_raised][10] | | Test::Unit
[assert_raise][11] | 0..2 | Test::Unit
[assert_raises][13] | 0..2 | Minitest
refute | |
refute_equal | |
[refute_raise][39] | |
[refute_raises][39] | |
## Supported Mocha
Mocha | Arity | Block | Notes
--------------------- | ----- | ----- | -------
[any_instance][29] | 0 | n/a |
[expects][21] | 1 | n/a |
[once][31] | 0 | n/a |
[stub][19] | 0,1,2 | no |
[stub_everything][18] | 0,1,2 | no | Uses `as_null_object`, not the same.
[stubs][20] | 1 | n/a |
[twice][32] | 0 | n/a |
To do: [at_least, never, raises, etc.][30]
## Supported shoulda-context methods
Mocha | Arity | Block | Notes
--------------------- | ----- | ----- | -------
[context][36] | 1 | yes |
[setup][37] | 1,2 | no |
[should][38] | 1,2 | yes |
## Acknowledgements
This project would not be possible without [ruby_parser][14],
[sexp_processor][15], and [ruby2ruby][16] by [Ryan Davis][17].
[1]: https://travis-ci.org/jaredbeck/minitest_to_rspec.svg?branch=master
[2]: https://travis-ci.org/jaredbeck/minitest_to_rspec
[5]: https://github.com/jaredbeck/minitest_to_rspec/blob/master/doc/supported_assertions.md
[6]: https://github.com/seattlerb/ruby2ruby
[8]: https://github.com/jaredbeck/minitest_to_rspec/blob/master/doc/minitest.md
[9]: https://github.com/jaredbeck/minitest_to_rspec/blob/master/doc/rspec.md
[10]: http://www.rubydoc.info/gems/test-unit/3.0.9/Test/Unit/Assertions#assert_nothing_raised-instance_method
[11]: http://ruby-doc.org/stdlib-2.1.0/libdoc/test/unit/rdoc/Test/Unit/Assertions.html#method-i-assert_raise
[12]: http://api.rubyonrails.org/classes/ActiveSupport/Testing/Assertions.html#method-i-assert_no_difference
[13]: http://www.rubydoc.info/gems/minitest/5.5.1/Minitest/Assertions#assert_raises-instance_method
[14]: https://github.com/seattlerb/ruby_parser
[15]: https://github.com/seattlerb/sexp_processor
[16]: https://github.com/seattlerb/ruby2ruby
[17]: https://github.com/zenspider
[18]: http://www.rubydoc.info/github/floehopper/mocha/Mocha/API:stub_everything
[19]: http://www.rubydoc.info/github/floehopper/mocha/Mocha/API#stub-instance_method
[20]: http://www.rubydoc.info/github/floehopper/mocha/Mocha/ObjectMethods#stubs-instance_method
[21]: http://www.rubydoc.info/github/floehopper/mocha/Mocha/ObjectMethods:expects
[22]: http://www.rubydoc.info/gems/test-unit/3.0.9/Test/Unit/Assertions#assert_not_equal-instance_method
[23]: http://www.rubydoc.info/gems/test-unit/3.0.9/Test/Unit/Assertions#assert_equal-instance_method
[24]: https://github.com/rspec/rspec-mocks
[25]: https://github.com/rspec/rspec-expectations
[26]: http://test-unit.github.io/
[27]: https://rubygems.org/gems/activesupport
[28]: http://gofreerange.com/mocha/docs/
[29]: http://www.rubydoc.info/github/floehopper/mocha/Mocha/ClassMethods#any_instance-instance_method
[30]: http://www.rubydoc.info/github/floehopper/mocha/Mocha/Expectation
[31]: http://www.rubydoc.info/github/floehopper/mocha/Mocha/Expectation#once-instance_method
[32]: http://www.rubydoc.info/github/floehopper/mocha/Mocha/Expectation#twice-instance_method
[34]: https://github.com/bbatsov/ruby-style-guide
[35]: https://github.com/bbatsov/rubocop
[35]: https://github.com/thoughtbot/shoulda-context
[36]: http://www.rubydoc.info/github/thoughtbot/shoulda-context/master/Shoulda/Context/ClassMethods#context-instance_method
[37]: http://www.rubydoc.info/github/thoughtbot/shoulda-context/master/Shoulda/Context/Context#setup-instance_method
[38]: http://www.rubydoc.info/github/thoughtbot/shoulda-context/master/Shoulda/Context/ClassMethods#should-instance_method
[39]: https://github.com/jaredbeck/minitest_to_rspec/pull/20