Deprecate `assert_template` and `assigns()`. #20138

tgxworld · 2015-05-13T10:33:08Z

Related: #18950.

tgxworld · 2015-05-13T10:34:44Z

actionpack/test/controller/action_pack_assertions_test.rb

-
-    process :hello_world
-    assert_template 'hello_world'
-  end


Duplicated in https://github.com/tgxworld/rails/blob/deprecated_assert_template/actionpack/test/controller/action_pack_assertions_test.rb#L492-L495 and https://github.com/tgxworld/rails/blob/deprecated_assert_template/actionpack/test/controller/action_pack_assertions_test.rb#L518-L522

tgxworld · 2015-05-23T07:00:45Z

@dhh @matthewd I've deprecated both assigns() and assert_template and extraced both methods into a plugin. I'll still have to publish the gem though.

tgxworld · 2015-05-23T16:57:55Z

Done! Gem published at https://rubygems.org/gems/rails-controller-testing.

rafaelfranca · 2015-05-28T18:35:08Z

actionpack/lib/action_controller/template_assertions.rb

@@ -102,6 +102,11 @@ def reset_template_assertion
    #   # assert that the "_customer" partial was rendered with a specific object
    #   assert_template partial: '_customer', locals: { customer: @customer }
    def assert_template(options = {}, message = nil)
+      ActiveSupport::Deprecation.warn(


We should raise a NoMethodError and point to the gem so we can remove all the implementation

I thought we had to deprecate it first?

If we are extracting a gem there is no need. The NoMethodError message should tell about the gem and people can get it work adding the gem to their Gemfile.

Do you want me to transfer the Gem to Rails? Although Rails isn't supporting these two methods, it seems weird that we're pointing to my personal repository.

👍 transfer to Rails so I can give you commit access.

Hmm I can't transfer without admin rights. Better to fork in this case?

transfer to me so I can transfer to Rails.

Thanks! I'll remove the method soon.

Don't remove the methods, just change their implementation to:

def assert_template(*) raise NoMethodError, "assert_template was extracted to a gem. To continue using it use the ..." end

Ok I'll remove the internal tests in this case.

tgxworld · 2015-05-30T03:08:11Z

Updated but there is some problem on Travis that isn't related.

rafaelfranca · 2015-05-30T03:11:35Z

Great work! Could you add a CHANGELOG entry?

tgxworld · 2015-05-30T03:27:47Z

Great work! Could you add a CHANGELOG entry?

O yeah forgot about it XD. Done 😄

rafaelfranca · 2015-05-30T03:30:33Z

actionpack/CHANGELOG.md

@@ -1,3 +1,9 @@
+*   Deprecate `assigns` and `assert_template`.


I think it is better to tell that these methods were extracted to the gem and point to it on the changelog.

tgxworld · 2015-05-30T06:16:18Z

actionpack/CHANGELOG.md

@@ -1,3 +1,10 @@
+*   Remove `assigns` and `assert_template`. Both methods have been extracted
+    into a gem at https://github.com/rails/rails-controller-testing.


@rafaelfranca Is this ok? 😄

Deprecate `assert_template` and `assigns()`.

kirs · 2015-06-06T09:09:59Z

👍 great job!

I first thought this was markdown so I updated the feature post spec (it's now improved but unrelated to the fix). Then I discovered that it's because InternalPostsController was using the default application layout instead of the blog layout. Easy fix, but what about the test? I first tried to use a controller test. However, asserting that a specific layout is used is deprecated: rails/rails#20138 Then I tried a feature spec. This works, but I'm still just testing things unrelated to what I care about. In particular, the main navigation (About Projects Music) exists in the application layout, but not in the blog layout. That works for now, but it still didn't feel like the right way to test if a post has the correct styles applied to it. I landed on actually asserting on the styles using Capybara's [matches_style] matcher. This requires that I use a non-headless browser to render the CSS styles of a page. [matches_style]: https://rubydoc.info/github/teamcapybara/capybara/master/Capybara%2FNode%2FMatchers:matches_style%3F

tgxworld reviewed May 13, 2015
View reviewed changes

tgxworld force-pushed the deprecated_assert_template branch 6 times, most recently from 7bcd3f9 to db2d0fe Compare May 23, 2015 06:39

tgxworld changed the title ~~Deprecate assert_template.~~ Deprecate assert_template and assigns(). May 23, 2015

tgxworld force-pushed the deprecated_assert_template branch 2 times, most recently from 47e55c9 to 8c6c96e Compare May 27, 2015 09:24

rafaelfranca reviewed May 28, 2015
View reviewed changes

tgxworld force-pushed the deprecated_assert_template branch 3 times, most recently from 86b91d7 to eda79db Compare May 30, 2015 02:59

rafaelfranca added the actionpack label May 30, 2015

rafaelfranca added this to the 5.0.0 milestone May 30, 2015

tgxworld force-pushed the deprecated_assert_template branch from eda79db to 28d34e2 Compare May 30, 2015 03:26

rafaelfranca reviewed May 30, 2015
View reviewed changes

Remove assigns and assert_template.

ca83436

tgxworld force-pushed the deprecated_assert_template branch from 28d34e2 to ca83436 Compare May 30, 2015 06:14

tgxworld reviewed May 30, 2015
View reviewed changes

rafaelfranca added a commit that referenced this pull request Jun 1, 2015

Merge pull request #20138 from tgxworld/deprecated_assert_template

bdfc662

Deprecate `assert_template` and `assigns()`.

rafaelfranca merged commit bdfc662 into rails:master Jun 1, 2015

tgxworld mentioned this pull request Jun 2, 2015

7-10% performance improvement for tests by removing assert_template. #19374

Closed

rafaelfranca modified the milestones: 5.0.0 [temp], 5.0.0 Dec 30, 2015

tgxworld deleted the deprecated_assert_template branch August 30, 2019 06:43

pirj mentioned this pull request Aug 20, 2020

Update and discourage use of controller specs rubocop/rspec-style-guide#113

Open

edwardloveall mentioned this pull request Mar 26, 2022

Fix individual post view edwardloveall/portfolio#507

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `assert_template` and `assigns()`. #20138

Deprecate `assert_template` and `assigns()`. #20138

tgxworld commented May 13, 2015

tgxworld May 13, 2015

tgxworld commented May 23, 2015

tgxworld commented May 23, 2015

rafaelfranca May 28, 2015

tgxworld May 29, 2015

rafaelfranca May 29, 2015

tgxworld May 29, 2015

rafaelfranca May 29, 2015

tgxworld May 29, 2015

rafaelfranca May 29, 2015

tgxworld May 29, 2015

rafaelfranca May 29, 2015

tgxworld May 29, 2015

tgxworld commented May 30, 2015

rafaelfranca commented May 30, 2015

tgxworld commented May 30, 2015

rafaelfranca May 30, 2015

tgxworld May 30, 2015

kirs commented Jun 6, 2015

		@@ -1,3 +1,10 @@
		* Remove `assigns` and `assert_template`. Both methods have been extracted
		into a gem at https://github.com/rails/rails-controller-testing.

Deprecate assert_template and assigns(). #20138

Deprecate assert_template and assigns(). #20138

Conversation

tgxworld commented May 13, 2015

Choose a reason for hiding this comment

tgxworld commented May 23, 2015

tgxworld commented May 23, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tgxworld commented May 30, 2015

rafaelfranca commented May 30, 2015

tgxworld commented May 30, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kirs commented Jun 6, 2015

Deprecate `assert_template` and `assigns()`. #20138

Deprecate `assert_template` and `assigns()`. #20138