From 37e687b72f875ff1693797da28d2c2b24109b3f3 Mon Sep 17 00:00:00 2001 From: Nick Anderson Date: Mon, 11 Jun 2018 16:36:14 -0500 Subject: [PATCH 1/2] Add assertion tip --- style/ruby/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/style/ruby/README.md b/style/ruby/README.md index 791bc86..64021b2 100644 --- a/style/ruby/README.md +++ b/style/ruby/README.md @@ -222,6 +222,24 @@ https://github.com/hanmoi-choi/reek-emacs end ``` +- Use [specific assertion functions](http://guides.rubyonrails.org/testing.html#available-assertions) + over `assert`. Using these functions gives much more meaningful results when tests fail. + + ```ruby + + # good + + assert_predicate @user, :valid? # on error: expected @user to not be valid? + + assert_includes response['message'], 'must be a valid email' # on error: expected response['message'] to include 'must be a valid email` + + # bad + + assert @user.valid? # on error: expected false to be truthy + + assert response['message'].include?('must be a valid email') # on error: expect false to be truthy + ``` + ### System Tests ##### Organization From d78495b4e59584059b36750350400aceac37fd8c Mon Sep 17 00:00:00 2001 From: Nick Anderson Date: Mon, 11 Jun 2018 16:41:46 -0500 Subject: [PATCH 2/2] Fix typo --- style/ruby/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/style/ruby/README.md b/style/ruby/README.md index 64021b2..51f1b11 100644 --- a/style/ruby/README.md +++ b/style/ruby/README.md @@ -229,7 +229,7 @@ https://github.com/hanmoi-choi/reek-emacs # good - assert_predicate @user, :valid? # on error: expected @user to not be valid? + assert_predicate @user, :valid? # on error: expected @user to be valid? assert_includes response['message'], 'must be a valid email' # on error: expected response['message'] to include 'must be a valid email`