README.md.erb
[](http://badge.fury.io/rb/transpec)
[](https://travis-ci.org/yujinakayama/transpec)
[](https://coveralls.io/github/yujinakayama/transpec?branch=master)
[](https://codeclimate.com/github/yujinakayama/transpec)
# Transpec
**Transpec** is a tool for converting your specs to the latest [RSpec](https://relishapp.com/rspec/) syntax with static and dynamic code analysis.
With Transpec you can upgrade your RSpec 2 specs to RSpec 3 in no time.
It supports [conversions](#supported-conversions) for almost all of the RSpec 3 changes – not only the `expect` syntax.
Also, you can use it on your RSpec 2 project even if you're not going to upgrade it to RSpec 3 for now.
Check out the following posts for the new RSpec syntax and the changes in RSpec 3:
* [RSpec's New Expectation Syntax](http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/)
* [RSpec's new message expectation syntax](http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/)
* [Notable Changes in RSpec 3](http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/)
If you are going to use Transpec in the upgrade process to RSpec 3,
read the RSpec official guide:
* https://relishapp.com/rspec/docs/upgrade
## Examples
Here's an example spec:
```ruby
<%=
example = <<END
describe Account do
subject(:account) { Account.new(logger) }
let(:logger) { mock('logger') }
describe '#balance' do
context 'initially' do
it 'is zero' do
account.balance.should == 0
end
end
end
describe '#close' do
it 'logs an account closed message' do
logger.should_receive(:account_closed).with(account)
account.close
end
end
describe '#renew' do
context 'when the account is not closed' do
before do
account.stub(:closed?).and_return(false)
end
it 'does not raise error' do
lambda { account.renew }.should_not raise_error(Account::RenewalError)
end
end
end
end
END
-%>
```
Transpec would convert it to the following form:
```ruby
<%= convert(example) -%>
```
### Actual examples
You can see actual conversion examples below:
* https://github.com/yujinakayama/guard/commit/transpec-demo
* https://github.com/yujinakayama/mail/commit/transpec-demo
* https://github.com/yujinakayama/twitter/commit/transpec-demo
## Installation
Simply install `transpec` with `gem` command:
```bash
$ gem install transpec
```
Normally you don't need to add `transpec` to your `Gemfile` or `*.gemspec` since this isn't a tool to be used daily.
## Basic Usage
Before converting your specs:
* Make sure your project has `rspec` gem dependency **<%= Transpec.required_rspec_version %>** or later. If not, change your `Gemfile` or `*.gemspec` to do so.
* Run `rspec` and check if all the specs pass.
* Ensure the Git repository is clean. (You don't want to mix up your changes and Transpec's changes, do you?)
Then, run `transpec` in the project root directory:
```bash
$ cd some-project
$ transpec
```
This will run the specs, convert them, and overwrite all spec files in the `spec` directory.
After the conversion, run `rspec` again and check whether everything is still green:
```bash
$ bundle exec rspec
```
If it's green, commit the changes with an auto-generated message
that describes the conversion summary and helps your team members to understand the new syntax:
```bash
$ git commit -aeF .git/COMMIT_EDITMSG
```
And you are done!
## Advanced Usage
### Convert only specific files
You can pass `transpec` arbitrary paths to convert:
```bash
# You always need to be in the project root directory
$ cd some-project
# Convert only files in `features` directory
$ transpec features
# Convert only files in `spec/foo` and `spec/bar` directory
$ transpec spec/foo spec/bar
# Convert only `spec/baz_spec.rb`
$ transpec spec/baz_spec.rb
```
Note that the current working directory always needs to be the project root directory,
so that Transpec can know where the root is.
### Enable/disable specific conversions
You can disable specific conversions that are enabled by default with `-k/--keep` option,
and enable conversions that are disabled by default with the `-v/--convert` option.
If you are willing to try the latest and modern syntax, run the following on RSpec 3:
```
$ transpec --convert example_group,hook_scope
```
See [`-k/--keep`](#-k--keep) and [`-v/--convert`](#-v--convert) for more details.
## Options
Though Transpec ships with sensible defaults that essentially conform to the RSpec 3 defaults,
you can customize the conversion behavior.
### `-f/--force`
Force processing even if the current Git repository is not clean.
```bash
$ git status --short
M spec/spec_helper.rb
$ transpec
The current Git repository is not clean. Aborting. If you want to proceed forcibly, use -f/--force option.
$ transpec --force
Copying project for dynamic analysis...
Running dynamic analysis with command "bundle exec rspec"...
```
### `-c/--rspec-command`
Specify a command to run your specs which is used for dynamic analysis.
Transpec needs to run your specs in a copied project directory for dynamic analysis.
If your project requires some special setup or commands to run specs, use this option.
`bundle exec rspec` is used by default.
Note that the command to run dynamic analysis does _not_ affect to the files or specs to be converted.
This means that even if you specify a command that only runs a subset of the files in your spec suite or a subset of the specs in a file, every spec will be converted.
For this reason, it's recommended to provide a command that runs full spec suite to `-c/--rspec-command`.
If you want to convert only a subset of the files in a spec suite, pass the paths to `transpec`.
See [Advanced Usage](#advanced-usage) for more details.
You can change the temporary directory that the your project will be copied
by specifying the `TMPDIR` environment variable.
```bash
$ transpec --rspec-command "./special_setup.sh && bundle exec rspec"
```
### `-k/--keep`
Keep specific syntaxes by disabling conversions.
```bash
$ transpec --keep should_receive,stub
```
#### Conversions enabled by default
Note that some syntaxes are available only if your project's RSpec is specific version or later.
If they are unavailable, conversions for such syntaxes will be disabled automatically.
Type | Target Syntax | Converted Syntax
-----------------|--------------------------------|-------------------------------------------
<%=
conversion_type_table = <<END
`should` | `obj.should matcher` | `expect(obj).to matcher`
`oneliner` | `it { should ... }` | `it { is_expected.to ... }`
`should_receive` | `obj.should_receive(:message)` | `expect(obj).to receive(:message)`
`stub` | `obj.stub(:message)` | `allow(obj).to receive(:message)`
`have_items` | `expect(obj).to have(n).items` | `expect(obj.size).to eq(n)`
`its` | `its(:attr) { }` | `describe '#attr' { subject { }; it { } }`
`pending` | `pending 'is an example' { }` | `skip 'is an example' { }`
`deprecated` | All other deprecated syntaxes | Latest syntaxes
END
validate_syntax_type_table(conversion_type_table, true)
conversion_type_table
-%>
See [Supported Conversions](#supported-conversions) for more details.
### `-v/--convert`
Enable specific conversions that are disabled by default.
```bash
$ transpec --convert example_group
```
#### Conversions disabled by default
Most of these target syntaxes are _not_ deprecated in both RSpec 2 and 3,
but the new syntaxes provide more modern and clear ways.
Type | Target Syntax | Converted Syntax
-----------------|--------------------------------|----------------------------------------------------
<%=
conversion_type_table = <<END
`example_group` | `describe 'something' { }` | `RSpec.describe 'something' { }`
`hook_scope` | `before(:all) { }` | `before(:context) { }`
`stub_with_hash` | `obj.stub(:message => value)` | `allow(obj).to receive(:message).and_return(value)`
END
validate_syntax_type_table(conversion_type_table, false)
conversion_type_table
-%>
Note: Specifying `stub_with_hash` enables conversion of `obj.stub(:message => value)`
to `allow(obj).to receive(:message).and_return(value)`
when `allow(obj).to receive_messages(:message => value)` is unavailable (prior to RSpec 3.0),
and it will be converted to multiple statements if the hash includes multiple pairs.
If your project's RSpec is 3.0 or later, it will be converted to `receive_messages(:message => value)`
regardless of this option.
See [Supported Conversions - Method stubs with a hash argument](#method-stubs-with-a-hash-argument) for more details.
### `-o/--convert-only`
Convert specific syntaxes while keeping all other syntaxes.
This option would be useful when you want to convert a non-deprecated syntax
while keeping another syntax that would be converted by default.
(e.g. converting the hook scope aliases while keeping the one-liner `should`).
```bash
$ transpec --convert-only example_group,hook_scope
```
### `-s/--skip-dynamic-analysis`
Skip dynamic analysis and convert with only static analysis.
The use of this option is basically **discouraged**
since it significantly decreases the overall conversion accuracy.
This would be useful only if your spec suite takes really long (like an hour) to run
and you prefer a combination of the rough but fast conversion by Transpec and manual fixes after that.
### `-n/--negative-form`
Specify a negative form of `to` which is used in the `expect` syntax.
Either `not_to` or `to_not`.
`not_to` is used by default.
```bash
$ transpec --negative-form to_not
```
### `-b/--boolean-matcher`
Specify a boolean matcher type which `be_true` and `be_false` will be converted to.
Any of `truthy,falsey`, `truthy,falsy` or `true,false` can be specified.
`truthy,falsey` is used by default.
```bash
$ transpec --boolean-matcher true,false
```
See [Supported Conversions - Boolean matchers](#boolean-matchers) for more details.
### `-e/--explicit-spec-type`
Add explicit spec `:type` metadata to example groups in a project using rspec-rails.
See [Supported Conversions - Implicit spec types in rspec-rails](#implicit-spec-types-in-rspec-rails) for more details.
### `-a/--no-yield-any-instance`
Suppress yielding receiver instances to `any_instance` implementation blocks as the first block argument.
By default in RSpec 3, `any_instance` implementation blocks will be yielded the receiving
instance as the first block argument, and by default Transpec converts specs by adding instance arguments to the blocks so that they conform to the behavior of RSpec 3.
Specifying this option suppresses the conversion and keeps them compatible with RSpec 2.
Note that this is not same as `--keep deprecated` since this configures `yield_receiver_to_any_instance_implementation_blocks` with `RSpec.configure`.
See [Supported Conversions - `any_instance` implementation blocks](#any_instance-implementation-blocks) for more details.
### `-p/--no-parens-matcher-arg`
Suppress parenthesizing arguments of matchers when converting
`should` with operator matcher to `expect` with non-operator matcher
(the `expect` syntax does not directly support the operator matchers).
Note that it will be parenthesized even if this option is specified
when parentheses are necessary to keep the meaning of the expression.
```ruby
<%=
example = <<END
describe 'original spec' do
it 'is an example' do
1.should == 1
2.should > 1
'string'.should =~ /^str/
[1, 2, 3].should =~ [2, 1, 3]
{ key: value }.should == { key: value }
end
end
END
-%>
<%= convert(example).gsub('original spec', 'converted spec') -%>
<%=
converted = convert(example, cli: ['-p'])
converted.gsub!(
'original spec',
'converted spec with -p/--no-parens-matcher-arg option'
)
insert_comment_above(converted, '{ key: value }', [
'With non-operator method, the parentheses are always required',
'to prevent the hash from being interpreted as a block.'
])
-%>
```
## Inconvertible Specs
You might see the following warning while conversion:
```
Cannot convert #should into #expect since #expect is not available in the context.
spec/awesome_spec.rb:4: 1.should == 1
```
This message would be shown with specs like:
```ruby
describe '#should that cannot be converted to #expect' do
class MyAwesomeTestRunner
def run
1.should == 1
end
end
it 'is 1' do
test_runner = MyAwesomeTestRunner.new
test_runner.run
end
end
```
### Reason
* `should` is defined on `BasicObject` class, so you can use `should` everywhere.
* `expect` is defined on `RSpec::Matchers` module which is included by `RSpec::Core::ExampleGroup` class, so you can use `expect` only where `self` is an instance of `RSpec::Core::ExampleGroup` (i.e. in `it` blocks, `:each` hook blocks or included module methods) or other classes that explicitly include `RSpec::Matchers`.
With the above example, in the context of `1.should == 1`, the `self` is an instance of `MyAwesomeTestRunner`.
Transpec tracks contexts and skips conversion if the syntax cannot be converted in a case like this.
### Solution
Include or extend any of the following module to make RSpec syntax available in the context:
* `RSpec::Matchers` for `expect(obj).to some_matcher`
* `RSpec::Mocks::ExampleMethods` for `expect/allow(obj).to receive(:message)`
```ruby
class MyAwesomeTestRunner
include RSpec::Matchers
def run
1.should == 1
end
end
```
Then run `transpec` again.
## Two Types of `should`
There are two types of `should`:
```ruby
describe 'the monkey-patched should' do
subject { [] }
it 'is empty' do
subject.should be_empty
# ^^^^^^ BasicObject#should in RSpec 2.11 or later,
# or Kernel#should prior to RSpec 2.11.
end
end
describe 'the one-liner should' do
subject { [] }
it { should be_empty }
# ^^^^^^ RSpec::Core::ExampleGroup#should
end
```
The monkey-patched `obj.should`:
* Is defined on `BasicObject` (or `Kernel`) and provided by `rspec-expectations` gem.
* Is deprecated in RSpec 3.
* Has [the issue](http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/#delegation-issues) with delegate/proxy objects.
* There's the alternative syntax [`expect(obj).to`](#standard-expectations) since RSpec 2.11.
The one-liner (implicit receiver) `should`:
* Is defined on `RSpec::Core::ExampleGroup` and provided by `rspec-core` gem.
* Is _not_ deprecated in RSpec 3.
* Does _not_ have the issue with delegate/proxy objects.
* There's the alternative syntax [`is_expected.to`](#one-liner-expectations) since RSpec 2.99.beta2.
## Supported Conversions
<%=
supported_conversions_section = find_section('Supported Conversions', level: 2)
table_of_contents(supported_conversions_section, level: 3)
%>
### Standard expectations
Targets:
```ruby
<%=
positive_example = <<END
obj.should matcher
END
-%>
<%=
negative_example = <<END
obj.should_not matcher
END
-%>
```
Will be converted to:
```ruby
<%= convert(positive_example, wrap_with: :example) -%>
<%= convert(negative_example, wrap_with: :example) -%>
<%= convert(negative_example, wrap_with: :example, cli: ['--negative-form', 'to_not']).chomp -%> # with `--negative-form to_not`
```
* This conversion can be disabled by: `--keep should`
* Deprecation: deprecated since RSpec 3.0
* See also: [RSpec's New Expectation Syntax](http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/)
### One-liner expectations
This conversion is available only if your project's RSpec is **<%= rspec_version = RSpecVersion.oneliner_is_expected_available_version %> or later**.
Targets:
```ruby
<%=
positive_example = <<END
it { should matcher }
END
-%>
<%=
negative_example = <<END
it { should_not matcher }
END
-%>
```
Will be converted to:
```ruby
<%= convert(positive_example, wrap_with: :example, rspec_version: rspec_version) -%>
<%= convert(negative_example, wrap_with: :example, rspec_version: rspec_version) -%>
<%= convert(negative_example, wrap_with: :example, rspec_version: rspec_version, cli: ['--negative-form', 'to_not']).chomp -%> # with `--negative-form to_not`
```
`is_expected.to` is designed for the consistency with the `expect` syntax.
However the one-liner `should` is still _not_ deprecated in RSpec 3.0
and available even if the `should` syntax is
[disabled with `RSpec.configure`](https://www.relishapp.com/rspec/rspec-expectations/v/3-0/docs/syntax-configuration#disable-should-syntax).
So if you think `is_expected.to` is verbose,
feel free to disable this conversion and continue using the one-liner `should`.
See [Two Types of `should`](#two-types-of-should) also.
* This conversion can be disabled by: `--keep oneliner`
* Deprecation: not deprecated
* See also: [Add `is_expected` for expect-based one-liner syntax. by myronmarston · rspec/rspec-core](https://github.com/rspec/rspec-core/pull/1180)
### Operator matchers
Targets:
```ruby
<%=
example = <<END
1.should == 1
1.should < 2
Integer.should === 1
'string'.should =~ /^str/
[1, 2, 3].should =~ [2, 1, 3]
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, wrap_with: :example) -%>
```
This conversion is combined with the conversion of [standard expectations](#standard-expecatations) and cannot be disabled separately because the `expect` syntax does not directly support the operator matchers.
* See also: [(Almost) All Matchers Are Supported - RSpec's New Expectation Syntax](http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/#almost-all-matchers-are-supported)
### Boolean matchers
This conversion is available only if your project's RSpec is **<%= rspec_version = RSpecVersion.be_truthy_available_version %> or later**.
Targets:
```ruby
<%=
example = <<END
expect(obj).to be_true
expect(obj).to be_false
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, rspec_version: rspec_version, wrap_with: :example) -%>
# With `--boolean-matcher truthy,falsy`
# be_falsy is just an alias of be_falsey.
<%= convert(example, cli: ['--boolean-matcher', 'truthy,falsy'], rspec_version: rspec_version, wrap_with: :example) -%>
# With `--boolean-matcher true,false`
<%= convert(example, cli: ['--boolean-matcher', 'true,false'], rspec_version: rspec_version, wrap_with: :example) -%>
```
* `be_true` matcher passes if expectation subject is _truthy_ in conditional semantics. (i.e. all objects except `false` and `nil`)
* `be_false` matcher passes if expectation subject is _falsey_ in conditional semantics. (i.e. `false` or `nil`)
* `be_truthy` and `be_falsey` matchers are renamed version of `be_true` and `be_false` and their behaviors are same.
* `be true` and `be false` are not new things. These are combinations of `be` matcher and boolean literals. These pass if expectation subject is exactly equal to boolean value.
So, converting `be_true`/`be_false` to `be_truthy`/`be_falsey` never breaks your specs and this is Transpec's default. If you are willing to test boolean values strictly, you can convert them to `be true`/`be false` with `--boolean-matcher true,false` option. Note that this may break your specs if your application code don't return exact boolean values.
* This conversion can be disabled by: `--keep deprecated`
* Deprecation: deprecated since RSpec 2.99, removed in RSpec 3.0
* See also: [Consider renaming `be_true` and `be_false` to `be_truthy` and `be_falsey` · rspec/rspec-expectations](https://github.com/rspec/rspec-expectations/issues/283)
### `be_close` matcher
Targets:
```ruby
<%=
example = <<END
expect(1.0 / 3.0).to be_close(0.333, 0.001)
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, wrap_with: :example) -%>
```
* This conversion can be disabled by: `--keep deprecated`
* Deprecation: deprecated since RSpec 2.1, removed in RSpec 3.0
* See also: [New be within matcher and RSpec.deprecate fix · rspec/rspec-expectations](https://github.com/rspec/rspec-expectations/pull/32)
### `have(n).items` matcher
This conversion will be **disabled automatically if `rspec-collection_matchers` is loaded** in your spec.
Targets:
```ruby
<%=
example = <<END
expect(collection).to have(3).items
expect(collection).to have_exactly(3).items
expect(collection).to have_at_least(3).items
expect(collection).to have_at_most(3).items
END
-%>
<%=
should_example = <<END
collection.should have(3).items
END
-%>
# Assume `team` responds to #players.
<%=
collection_owner_example = <<END
expect(team).to have(3).players
END
-%>
# Assume #players is a private method.
<%=
private_method_example = <<END
expect(team).to have(3).players
END
-%>
# Validation expectations in rspec-rails.
<%=
errors_on_example = <<END
expect(model).to have(2).errors_on(:name)
END
-%>
```
Will be converted to:
```ruby
<%=
convert(example, dynamic: true, wrap_with: :example, hidden: 'collection = [1, 2, 3]')
-%>
<%=
" # With `--keep should`\n" +
convert(should_example, cli: ['--keep', 'should'], dynamic: true, wrap_with: :example, hidden: 'collection = [1, 2, 3]')
-%>
<%=
convert(collection_owner_example, dynamic: true, wrap_with: :example, hidden: <<END)
class Team
def players
[1, 2, 3]
end
end
team = Team.new
END
-%>
# have(n).items matcher invokes #players even if it's a private method.
<%=
convert(private_method_example, dynamic: true, wrap_with: :example, hidden: <<END)
class Team
private
def players
[1, 2, 3]
end
end
team = Team.new
END
-%>
# Conversion of `have(n).errors_on(:attr)` is not supported.
<%=
convert(errors_on_example, dynamic: true, wrap_with: :example, hidden: <<END)
module ActiveModel
module Validations
def errors_on(attribute, options = {})
valid_args = [options[:context]].compact
self.valid?(*valid_args)
[self.errors[attribute]].flatten.compact
end
end
end
class Model
include ActiveModel::Validations
def valid?(*)
false
end
def errors
{ name: [:foo, :bar] }
end
end
model = Model.new
END
-%>
```
There's an option to continue using `have(n).items` matcher with [rspec-collection_matchers](https://github.com/rspec/rspec-collection_matchers) which is a gem extracted from `rspec-expectations`.
If you choose to do so, disable this conversion by either:
* Specify `--keep have_items` option manually.
* Require `rspec-collection_matchers` in your spec so that Transpec automatically disables this conversion.
#### Note about `expect(model).to have(n).errors_on(:attr)`
The idiom `expect(model).to have(n).errors_on(:attr)` in rspec-rails 2 consists of
`have(n).items` matcher and a monkey-patch [`ActiveModel::Validations#errors_on`](https://github.com/rspec/rspec-rails/blob/v2.14.2/lib/rspec/rails/extensions/active_record/base.rb#L34-L57).
In RSpec 2 the monkey-patch was provided by rspec-rails,
but in RSpec 3 it's extracted to rspec-collection_matchers along with `have(n).items` matcher.
So if you convert it to `expect(model.errors_on(:attr).size).to eq(2)` without rspec-collection_matchers,
it fails with error `undefined method 'error_on' for #<Model ...>`.
Technically it can be converted to:
```ruby
model.valid?
expect(model.errors[:attr].size).to eq(n)
```
However currently Transpec doesn't support this conversion
since this is probably not what most people want.
So using rspec-collection_matchers gem is recommended for now.
* This conversion can be disabled by: `--keep have_items`
* Deprecation: deprecated since RSpec 2.99, removed in RSpec 3.0
* See also: [Expectations: `have(x).items` matchers will be moved into an external gem - The Plan for RSpec 3](http://rspec.info/blog/2013/07/the-plan-for-rspec-3/#expectations-havexitems-matchers-will-be-moved-into-an-external-gem)
### One-liner expectations with `have(n).items` matcher
This conversion will be **disabled automatically if `rspec-collection_matchers` is loaded** in your spec.
Targets:
```ruby
<%=
example = <<END
it { should have(3).items }
END
-%>
<%=
collection_owner_example = <<END
it { should have_at_least(3).players }
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, dynamic: true, wrap_with: :group, hidden: 'subject { [1, 2, 3] }') -%>
# With `--keep should`
<%= convert(example, dynamic: true, wrap_with: :group, hidden: 'subject { [1, 2, 3] }', cli: ['--keep', 'should']) -%>
<%=
convert(collection_owner_example, dynamic: true, wrap_with: :group, hidden: <<END)
subject do
class Team
def players
[1, 2, 3]
end
end
Team.new
end
END
-%>
```
* This conversion can be disabled by: `--keep have_items`
### Expectations on block
Targets:
```ruby
<%=
example = <<END
lambda { do_something }.should raise_error
proc { do_something }.should raise_error
-> { do_something }.should raise_error
expect { do_something }.should raise_error
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, wrap_with: :example).lines.to_a.uniq.join("\n") -%>
```
* This conversion can be disabled by: `--keep should`
* Deprecation: deprecated since RSpec 3.0
* See also: [Unification of Block vs. Value Syntaxes - RSpec's New Expectation Syntax](http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/#unification-of-block-vs-value-syntaxes)
### Expectations on attribute of subject with `its`
This conversion will be **disabled automatically if `rspec-its` is loaded** in your spec.
Targets:
```ruby
<%=
example = <<END
describe 'example' do
subject { { foo: 1, bar: 2 } }
its(:size) { should == 2 }
its([:foo]) { should == 1 }
its('keys.first') { should == :foo }
end
END
-%>
```
Will be converted to:
```ruby
<%= convert(example) -%>
```
There's an option to continue using `its` with [rspec-its](https://github.com/rspec/rspec-its) which is a gem extracted from `rspec-core`.
If you choose to do so, disable this conversion by either:
* Specify `--keep its` option manually.
* Require `rspec-its` in your spec so that Transpec automatically disables this conversion.
Note that this conversion is a sort of first-aid
and ideally the expectations should be rewritten to be more expressive by yourself.
Read [this post](https://gist.github.com/myronmarston/4503509) for the rationale.
* This conversion can be disabled by: `--keep its`
* Deprecation: deprecated since RSpec 2.99, removed in RSpec 3.0
* See also: [Core: `its` will be moved into an external gem - The Plan for RSpec 3](http://rspec.info/blog/2013/07/the-plan-for-rspec-3/#core-its-will-be-moved-into-an-external-gem)
### Negative error expectations with specific error
Targets:
```ruby
<%=
example = <<END
expect { do_something }.not_to raise_error(SomeErrorClass)
expect { do_something }.not_to raise_error('message')
expect { do_something }.not_to raise_error(SomeErrorClass, 'message')
END
-%>
<%=
should_example = <<END
lambda { do_something }.should_not raise_error(SomeErrorClass)
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, wrap_with: :example).lines.to_a.uniq.join("\n") -%>
<%= convert(should_example, wrap_with: :example, cli: ['--keep', 'should']).chomp -%> # with `--keep should`
```
* This conversion can be disabled by: `--keep deprecated`
* Deprecation: deprecated since RSpec 2.14, removed in RSpec 3.0
* See also: [Consider deprecating `expect { }.not_to raise_error(SpecificErrorClass)` · rspec/rspec-expectations](https://github.com/rspec/rspec-expectations/issues/231)
### Message expectations
Targets:
```ruby
<%=
example = <<END
obj.should_receive(:message)
Klass.any_instance.should_receive(:message)
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, wrap_with: :example) -%>
```
* This conversion can be disabled by: `--keep should_receive`
* Deprecation: deprecated since RSpec 3.0
* See also: [RSpec's new message expectation syntax](http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/)
### Message expectations that are actually method stubs
Targets:
```ruby
<%=
example = <<END
obj.should_receive(:message).any_number_of_times
obj.should_receive(:message).at_least(0)
END
-%>
<%=
any_instance_example = <<END
Klass.any_instance.should_receive(:message).any_number_of_times
Klass.any_instance.should_receive(:message).at_least(0)
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, wrap_with: :example).lines.to_a.uniq.join("\n") -%>
<%= convert(example, wrap_with: :example, cli: ['--keep', 'stub']).lines.to_a.uniq.join("\n").chomp -%> # with `--keep stub`
<%= convert(any_instance_example, wrap_with: :example).lines.to_a.uniq.join("\n") -%>
<%= convert(any_instance_example, wrap_with: :example, cli: ['--keep', 'stub']).lines.to_a.uniq.join("\n").chomp -%> # with `--keep stub`
```
* This conversion can be disabled by: `--keep deprecated`
* Deprecation: deprecated since RSpec 2.14, removed in RSpec 3.0
* See also: [Don't allow at_least(0) · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/133)
### Method stubs
Targets:
```ruby
<%=
example = <<END
obj.stub(:message)
obj.stub!(:message)
END
-%>
<%=
stub_chain_example = <<END
obj.stub_chain(:foo, :bar, :baz)
END
-%>
<%=
any_instance_example = <<END
Klass.any_instance.stub(:message)
END
-%>
<%=
unstub_example = <<END
obj.unstub(:message)
obj.unstub!(:message)
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, wrap_with: :example).lines.to_a.uniq.join("\n") -%>
# Conversion from `stub_chain` to `receive_message_chain` is available
# only if the target project's RSpec is <%= rspec_version = RSpecVersion.receive_message_chain_available_version %> or later
<%= convert(stub_chain_example, wrap_with: :example, rspec_version: rspec_version) -%>
<%= convert(any_instance_example, wrap_with: :example) -%>
<%= convert(unstub_example, wrap_with: :example).lines.to_a.uniq.join("\n") -%>
```
* This conversion can be disabled by: `--keep stub`
* Deprecation: deprecated since RSpec 3.0
* See also:
* [RSpec's new message expectation syntax](http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/)
* [Bring back stub_chain (receive_message_chain) · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/464)
### Method stubs with a hash argument
Targets:
```ruby
<%=
example = <<END
obj.stub(:foo => 1, :bar => 2)
END
-%>
```
Will be converted to:
```ruby
# If the target project's RSpec is <%= rspec_version = RSpecVersion.receive_messages_available_version %> or later
<%= convert(example, wrap_with: :example, rspec_version: rspec_version) -%>
# If the target project's RSpec is prior to <%= RSpecVersion.receive_messages_available_version %>
<%= convert(example, wrap_with: :example, rspec_version: Transpec.required_rspec_version).chomp -%> # No conversion
# If the target project's RSpec is prior to <%= RSpecVersion.receive_messages_available_version %>
# and `--convert stub-with-hash` is specified
<%= convert(example, wrap_with: :example, rspec_version: Transpec.required_rspec_version, cli: ['--convert', 'stub_with_hash']) -%>
```
`allow(obj).to receive_messages(:foo => 1, :bar => 2)` which is designed to be the replacement for `obj.stub(:foo => 1, :bar => 2)` is available from RSpec 3.0.
So, if you're going to use Transpec in [the upgrade path to RSpec 3](http://rspec.info/blog/2013/07/the-plan-for-rspec-3/#the-upgrade-path), you may need to follow these steps:
1. Upgrade to RSpec 2.99
2. Run `transpec` (at this time `obj.stub(:message => value)` won't be converted)
3. Upgrade to RSpec 3.0
4. Run `transpec` again to convert `obj.stub(:message => value)`
Or if you're going to stay RSpec 2.14 for now but want to convert all `stub` to `allow` statements, run `transpec` with `--convert stub_with_hash` option. Note that once the conversion is done, multiple statements cannot be merged into a `receive_messages`.
* This conversion can be disabled by: `--keep stub`
* Deprecation: deprecated since RSpec 3.0
* See also: [allow receive with multiple methods · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/368)
### Method stub aliases
Targets:
```ruby
<%=
example = <<END
obj.stub!(:message)
obj.unstub!(:message)
END
-%>
```
Will be converted to:
```ruby
# With `--keep stub`
<%= convert(example, wrap_with: :example, cli: ['--keep', 'stub']) -%>
```
* This conversion can be disabled by: `--keep deprecated`
* Deprecation: deprecated since RSpec 2.14, removed in RSpec 3.0
* See also: [Consider deprecating and/or removing #stub! and #unstub! at some point · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/122)
### Method stubs with deprecated specification of number of times
Targets:
```ruby
<%=
example = <<END
obj.stub(:message).any_number_of_times
obj.stub(:message).at_least(0)
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, wrap_with: :example).lines.to_a.uniq.join("\n") -%>
<%= convert(example, wrap_with: :example, cli: ['--keep', 'stub']).lines.to_a.uniq.join("\n").chomp -%> # with `--keep stub`
```
* This conversion can be disabled by: `--keep deprecated`
* Deprecation: deprecated since RSpec 2.14, removed in RSpec 3.0
* See also: [Don't allow at_least(0) · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/133)
### Useless `and_return`
Targets:
```ruby
<%=
example = <<END
expect(obj).to receive(:message).and_return { 1 }
allow(obj).to receive(:message).and_return { 1 }
expect(obj).to receive(:message).and_return
allow(obj).to receive(:message).and_return
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, wrap_with: :example) -%>
```
* This conversion can be disabled by: `--keep deprecated`
* Deprecation: deprecated since RSpec 2.99, removed in RSpec 3.0
* See also: [Consider deprecating `and_return { value }` · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/558)
### `any_instance` implementation blocks
This conversion is available only if your project's RSpec is **`>= <%= RSpecVersion::RSPEC_2_99 %>` and `< <%= RSpecVersion::RSPEC_3_0 %>`**.
Targets:
```ruby
<%=
example = <<END
RSpec.configure do |rspec|
end
describe 'example' do
it 'is any_instance implementation block' do
expect_any_instance_of(Klass).to receive(:message) { |arg| puts arg }
allow_any_instance_of(Klass).to receive(:message) { |arg| puts arg }
end
end
END
-%>
```
Will be converted to:
```ruby
<% rspec_version = RSpecVersion.yielding_receiver_to_any_instance_implementation_block_available_version -%>
<%= convert(example, rspec_version: rspec_version) -%>
```
Or with `--no-yield-any-instance` option they will be converted to:
```ruby
<%= convert(example, cli: ['--no-yield-any-instance'], rspec_version: rspec_version) -%>
```
* This conversion can be disabled by: `--keep deprecated`
* Deprecation: deprecated since RSpec 2.99
* See also: [Mocks: `any_instance` block implementations will yield the receiver](http://rspec.info/blog/2013/07/the-plan-for-rspec-3/#mocks-anyinstance-block-implementations-will-yield-the-receiver)
### Test double aliases
Targets:
```ruby
<%=
example = <<END
stub('something')
mock('something')
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, wrap_with: :example).lines.to_a.uniq.join("\n") -%>
```
* This conversion can be disabled by: `--keep deprecated`
* Deprecation: deprecated since RSpec 2.14, removed in RSpec 3.0
* See also: [myronmarston / why_double.md - Gist](https://gist.github.com/myronmarston/6576665)
### Pending examples
This conversion is available only if your project's RSpec is **`>= <%= RSpecVersion::RSPEC_2_99 %>` and `< <%= RSpecVersion::RSPEC_3_0 %>`**.
Targets:
```ruby
<%=
example = <<END
describe 'example' do
it 'is skipped', :pending => true do
do_something_possibly_fail # This won't be run
end
pending 'is skipped' do
do_something_possibly_fail # This won't be run
end
it 'is skipped' do
pending
do_something_possibly_fail # This won't be run
end
it 'is run and expected to fail' do
pending do
do_something_surely_fail # This will be run and expected to fail
end
end
end
END
-%>
```
Will be converted to:
```ruby
<%=
convert(example, rspec_version: RSpecVersion.skip_available_version)
.gsub('pending', 'pending # #pending with block is no longer supported')
-%>
```
Here's an excerpt from [the warning](https://github.com/rspec/rspec-core/blob/v2.99.0.beta2/lib/rspec/core/example_group.rb#L67-L75) for pending examples in RSpec 2.99:
> The semantics of `RSpec::Core::ExampleGroup#pending` are changing in RSpec 3.
> In RSpec 2.x, it caused the example to be skipped. In RSpec 3, the example will
> still be run but is expected to fail, and will be marked as a failure (rather
> than as pending) if the example passes, just like how `pending` with a block
> from within an example already works.
>
> To keep the same skip semantics, change `pending` to `skip`. Otherwise, if you
> want the new RSpec 3 behavior, you can safely ignore this warning and continue
> to upgrade to RSpec 3 without addressing it.
* This conversion can be disabled by: `--keep pending`
* Deprecation: not deprecated but the behavior changes in RSpec 3.0
* See also: [Feature request: shortcut for pending-block within it · rspec/rspec-core](https://github.com/rspec/rspec-core/issues/1208)
### Current example object
This conversion is available only if your project's RSpec is **<%= rspec_version = RSpecVersion.yielded_example_available_version %> or later**.
Targets:
```ruby
<%=
example = <<END
module ScreenshotHelper
def save_failure_screenshot
return unless example.exception
# ...
end
end
describe 'example page' do
include ScreenshotHelper
after { save_failure_screenshot }
let(:user) { User.find(example.metadata[:user_id]) }
# ...
end
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, rspec_version: rspec_version) -%>
```
Here's an excerpt from [the warning](https://github.com/rspec/rspec-core/blob/7d6d2ca/lib/rspec/core/example_group.rb#L513-L527) for `RSpec::Core::ExampleGroup#example` and `#running_example` in RSpec 2.99:
> `RSpec::Core::ExampleGroup#example` is deprecated and will be removed in RSpec 3. There are a few options for what you can use instead:
>
> - `rspec-core`'s DSL methods (`it`, `before`, `after`, `let`, `subject`, etc) now yield the example as a block argument, and that is the recommended way to access the current example from those contexts.
> - The current example is now exposed via `RSpec.current_example`, which is accessible from any context.
> - If you can't update the code at this call site (e.g. because it is in an extension gem), you can use this snippet to continue making this method available in RSpec 2.99 and RSpec 3:
>
> ```ruby
> RSpec.configure do |c|
> c.expose_current_running_example_as :example
> end
> ```
* This conversion can be disabled by: `--keep deprecated`
* Deprecation: deprecated since RSpec 2.99, removed in RSpec 3.0
* See also: [Core: DSL methods will yield the example - The Plan for RSpec 3](http://rspec.info/blog/2013/07/the-plan-for-rspec-3/#core-dsl-methods-will-yield-the-example)
### Custom matcher DSL
This conversion is available only if your project's RSpec is **<%= rspec_version = RSpecVersion.non_should_matcher_protocol_available_version %> or later**.
Targets:
```ruby
<%=
example = <<END
RSpec::Matchers.define :be_awesome do
match_for_should { }
match_for_should_not { }
failure_message_for_should { }
failure_message_for_should_not { }
end
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, rspec_version: rspec_version) -%>
```
* This conversion can be disabled by: `--keep deprecated`
* Deprecation: deprecated since RSpec 3.0
* See also: [Expectations: Matcher protocol and custom matcher API changes - The Plan for RSpec 3](http://rspec.info/blog/2013/07/the-plan-for-rspec-3/#expectations-matcher-protocol-and-custom-matcher-api-changes)
### Implicit spec types in rspec-rails
This conversion is **available only if `rspec-rails` is loaded** in your spec and your project's RSpec is **<%= rspec_version = RSpecVersion.implicit_spec_type_disablement_available_version %> or later**.
Targets:
```ruby
# In spec/models/some_model_spec.rb
<%=
example = <<END
RSpec.configure do |rspec|
end
describe SomeModel do
end
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, rspec_version: rspec_version, rails: true, path: 'spec/models/some_model_spec.rb') -%>
```
Or with `--explicit-spec-type` option they will be converted to:
```ruby
<%= convert(example, rspec_version: rspec_version, rails: true, path: 'spec/models/some_model_spec.rb', cli: ['--explicit-spec-type']) -%>
```
* This conversion can be disabled by: `--keep deprecated`
* Deprecation: deprecated since RSpec 2.99, removed in RSpec 3.0
* See also: [Consider making example group mixins more explicit · rspec/rspec-rails](https://github.com/rspec/rspec-rails/issues/662)
### Deprecated configuration options
Targets:
```ruby
<%=
example = <<END
RSpec.configure do |c|
c.backtrace_clean_patterns
c.backtrace_clean_patterns = [/lib\\/something/]
c.color_enabled = true
c.out
c.out = File.open('output.txt', 'w')
c.output
c.output = File.open('output.txt', 'w')
c.backtrace_cleaner
c.color?(output)
c.filename_pattern
c.filename_pattern = '**/*_test.rb'
c.warnings
end
END
-%>
```
Will be converted to:
```ruby
<%=
converted = convert(example, rspec_version: RSpecVersion.new('3.0.0'))
[
['c.output_stream', :config_output_stream],
['c.backtrace_formatter', :config_backtrace_formatter],
].each do |pattern, feature|
rspec_version = RSpecVersion.send("#{feature}_available_version")
converted = insert_comment_above(converted, pattern, "RSpec #{rspec_version} or later")
end
converted
-%>
```
* This conversion can be disabled by: `--keep deprecated`
### Monkey-patched example groups
This conversion is **disabled by default** and available only if your project's RSpec is **<%= rspec_version = RSpecVersion.non_monkey_patch_example_group_available_version %> or later**.
Targets:
```ruby
<%=
example = <<END
RSpec.configure do |rspec|
end
describe 'top-level example group' do
describe 'nested example group' do
end
end
shared_examples 'shared examples' do
end
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, cli: ['--convert', 'example_group'], rspec_version: rspec_version) -%>
```
* This conversion can be enabled by: `--convert example_group`
* Deprecation: not deprecated
* See also: [Zero Monkey Patching Mode! - The Plan for RSpec 3](http://rspec.info/blog/2013/07/the-plan-for-rspec-3/#zero-monkey-patching-mode)
### Hook scope aliases
This conversion is **disabled by default** and available only if your project's RSpec is **<%= rspec_version = RSpecVersion.hook_scope_alias_available_version %> or later**.
Targets:
```ruby
<%=
example = <<END
describe 'example' do
before { do_something }
before(:each) { do_something }
before(:all) { do_something }
end
RSpec.configure do |rspec|
rspec.before(:suite) { do_something }
end
END
-%>
```
Will be converted to:
```ruby
<%= convert(example, cli: ['--convert', 'hook_scope'], rspec_version: rspec_version) -%>
```
* This conversion can be enabled by: `--convert hook_scope`
* Deprecation: not deprecated
* See also: [Adds hook scope aliases `example` and `context` · rspec/rspec-core](https://github.com/rspec/rspec-core/pull/1174)
## Compatibility
Transpec is tested on the following Ruby implementations:
<%= supported_ruby_names.map { |name| "* #{name}" }.join("\n") %>
## License
Copyright (c) 2013–<%= Time.now.year %> Yuji Nakayama
See the [LICENSE.txt](LICENSE.txt) for details.