Ruby and Rails have several methods that can be used to check for the existence of a value or the state of an object. Ruby provides #nil?
and #empty?
, and Rails' ActiveSupport adds #blank?
and #present?
. All these work in their own way and it's important to know how each evaluates data as using the wrong method in your code might cause unexpected results.
In this article, we'll refresh your knowledge on these methods. We'll (re)learn what conditions pass or fail when each is used as well as the type of objects each method can be used on. We'll even throw in a handy cheat sheet at the end!
#nil?
#nil?
is a Ruby method on the Object
class. Since all classes inherit from this class, #nil?
can be used on any object. It returns true
for nil
(an instance of the class NilClass
) and false for everything else.
1nil.nil?
2=> true
3
4true.nil?
5=> false
6
75.nil?
8=> false
9
10"".nil?
11=> false
12
13[].nil?
14=> false
#empty?
#empty?
is a method that can be used on strings, arrays, hashes and sets. It returns true
if the instance of the object has a length of zero.
When used on strings, it returns true
for empty strings.
1"".empty?
2=> true
Note that whitespace characters are characters and so using #empty?
on a string containing only whitespace will return false
. Because of this, it might not be the best method to use when validating text. If you are only using this method to validate user input, for instance, you might end up processing input that only contains whitespace.
1" ".empty?
2=> false
3
4"\t\n".empty?
5=> false
For arrays, hashes and sets, it returns true
if they have no elements.
1[].empty?
2=> true
3
4{}.empty?
5=> true
6
7require 'set'
8Set.new.empty?
9=> true
When #empty?
is used on nil
or any other class that doesn't have the method, a NoMethodError
exception will be raised. So to use it in checking your data, you have to put in place more checks to ensure your program never crashes.
1if !my_var.nil? && !my_var.empty?
2 # make use of my_var
3end
A better method to use would be the Rails #blank?
method, which we'll now look at.
#blank?
#blank?
is a Rails method (in ActiveSupport). It operates on any object.
For strings, it will return true
for empty strings as well as strings containing only whitespace characters.
1"".blank?
2=> true
3
4" ".blank?
5=> true
6
7"\n\t".blank?
8=> true
For arrays, hashes and sets, it works just like #empty?
, in that it returns true
if they have no elements.
1[].blank?
2=> true
3
4{}.blank?
5=> true
6
7Set.new.blank?
8=> true
9
10[nil].blank?
11=> false
12
13["", ""].blank?
14=> false
15
16person = {:firstName => "John", :lastName => "Doe"}
17person.blank?
18=> false
It returns false
for true
and true
for any falsey conditions (i.e. nil
and false
).
1true.blank?
2=> false
3
4false.blank?
5=> true
6
7nil.blank?
8=> true
As you can see, it is better to use #blank?
rather than #empty?
in validating data as it won't cause NoMethodErrors
when used on some objects since it is available for all objects. It also won't pass for strings that only contain whitespace.
#present?
#present?
is also a Rails method. It does the opposite of what #blank?
does.
1!my_var.blank? == my_var.present?
2=> true
Here are some examples:
1"".present?
2=> false
3
4" ".present?
5=> false
6
7[].present?
8=> false
9
10nil.present?
11=> false
12
13true.present?
14=> true
15
16false.present?
17=> false
18
19{}.present?
20=> false
21
22person = {:firstName => "John", :lastName => "Doe"}
23person.present?
24=> true
25
265.present?
27=> true
This is also a better method for validation than #empty?
for the same reasons we covered for #blank?
.
In Conclusion
Since the naming of these methods tends to confuse, here's a handy cheat sheet for you to bookmark.
#nil? | #empty? | #blank? | #present? | |
---|---|---|---|---|
5 | false | NoMethodError | false | true |
"" | false | true | true | false |
" " | false | false | true | false |
"\t\n" | false | false | true | false |
[] | false | true | true | false |
["a"] | false | false | false | true |
{} | false | true | true | false |
{a: "b"} | false | false | false | true |
Set.new | false | true | true | false |
nil | true | NoMethodError | true | false |
true | false | NoMethodError | false | true |
false | false | NoMethodError | true | false |
As with everything, the choice between #nil?
, #empty?
, #blank?
and #present?
depends on the situation. For checking if a user has a name to address them with, #present?
could be a good fit, for example. However #blank?
and #present
return a boolean for all objects, which might hide bugs in the code by not raising an error when a value is of the wrong type.
We hope we refreshed your memory on checking values in Ruby. If you have any questions or comments, don’t hesitate to drop us a line @AppSignal.