class method
self.wrap
Ruby on Rails 3.2.22.5
Since v3.0.20Signature
self.wrap(object)
Wraps its argument in an array unless it is already an array (or array-like).
Specifically:
-
If the argument is
nilan empty list is returned. -
Otherwise, if the argument responds to
to_aryit is invoked, and its result returned. -
Otherwise, returns an array with the argument as its single element.
Array.wrap(nil) # => [] Array.wrap([1, 2, 3]) # => [1, 2, 3] Array.wrap(0) # => [0]
This method is similar in purpose to Kernel#Array, but there are some differences:
-
If the argument responds to
to_arythe method is invoked.Kernel#Array
moves on to try to_a if the returned value is nil, but Array.wrap returns such a nil right away.
-
If the returned value from
to_aryis neithernilnor anArrayobject,Kernel#Array
raises an exception, while Array.wrap does not, it just returns the value.
-
It does not call
to_aon the argument, though special-casesnilto return an empty array.
The last point is particularly worth comparing for some enumerables:
Array(:foo => :bar) # => [[:foo, :bar]] Array.wrap(:foo => :bar) # => [{:foo => :bar}] Array("foo\nbar") # => ["foo\n", "bar"], in Ruby 1.8 Array.wrap("foo\nbar") # => ["foo\nbar"]
There’s also a related idiom that uses the splat operator:
[*object]
which returns [nil] for nil, and calls to Array(object) otherwise.
Thus, in this case the behavior is different for nil, and the differences with Kernel#Array explained above apply to the rest of +object+s.
Parameters
-
objectreq
Source
# File activesupport/lib/active_support/core_ext/array/wrap.rb, line 39
def self.wrap(object)
if object.nil?
[]
elsif object.respond_to?(:to_ary)
object.to_ary || [object]
else
[object]
end
end
Defined in activesupport/lib/active_support/core_ext/array/wrap.rb line 39
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in Array