File: README.md

package info (click to toggle)
ruby-rails-controller-testing 1.0.5-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid, trixie
  • size: 1,016 kB
  • sloc: ruby: 646; makefile: 4
file content (97 lines) | stat: -rw-r--r-- 2,277 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# Rails::Controller::Testing

This gem brings back `assigns` to your controller tests as well as `assert_template`
to both controller and integration tests.

Note: This gem is only useful once `assigns` and `assert_template` have been
removed from Rails.

## Installation

Add this line to your application's Gemfile:

    gem 'rails-controller-testing'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install rails-controller-testing

### RSpec

See https://github.com/rspec/rspec-rails/issues/1393.

rspec-rails automatically integrates with this gem since version `3.5.0`.
Adding the gem to your `Gemfile` is sufficient.

If you use an older version of rspec-rails, you can manually include the
modules in your `rails_helper`.

```ruby
RSpec.configure do |config|
  [:controller, :view, :request].each do |type|
    config.include ::Rails::Controller::Testing::TestProcess, :type => type
    config.include ::Rails::Controller::Testing::TemplateAssertions, :type => type
    config.include ::Rails::Controller::Testing::Integration, :type => type
  end
end
```

## Outside Rails

For projects and gems using controller tests outside of a Rails application,
invoke the `Rails::Controller::Testing.install` method inside your test suite
setup to include the required modules on controller test cases.

```ruby
# test/test_helper.rb

require 'rails-controller-testing'
Rails::Controller::Testing.install
```

## Usage

### assigns

`assigns` allows you to access the instance variables that have been passed to
your views.

```ruby
class PostsController < ActionController::Base
  def index
    @posts = Post.all
  end
end

class PostControllerTest < ActionController::TestCase
  def test_index
    get :index
    assert_equal Post.all, assigns(:posts)
  end
end
```

### assert_template

`assert_template` allows to you assert that certain templates have been rendered.

```ruby
class PostControllerTest < ActionController::TestCase
  def test_index
    get :index
    assert_template 'posts/index'
  end
end
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request