Sha256: cb52f67e72c476dc26f3afbf972bbe53589d95089654fe2f57571e1112cd1a8b

Contents?: true

Size: 1.83 KB

Versions: 46

Compression:

Stored size: 1.83 KB

Contents

class Array
  # Wraps its argument in an array unless it is already an array (or array-like).
  #
  # Specifically:
  #
  # * If the argument is +nil+ an empty list is returned.
  # * Otherwise, if the argument responds to +to_ary+ it 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 <tt>Kernel#Array</tt>, but there are some differences:
  #
  # * If the argument responds to +to_ary+ the method is invoked. <tt>Kernel#Array</tt>
  # moves on to try +to_a+ if the returned value is +nil+, but <tt>Arraw.wrap</tt> returns
  # such a +nil+ right away.
  # * If the returned value from +to_ary+ is neither +nil+ nor an +Array+ object, <tt>Kernel#Array</tt>
  # raises an exception, while <tt>Array.wrap</tt> does not, it just returns the value.
  # * It does not call +to_a+ on the argument, though special-cases +nil+ to 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 <tt>[nil]</tt> for +nil+, and calls to <tt>Array(object)</tt> otherwise.
  #
  # Thus, in this case the behavior is different for +nil+, and the differences with
  # <tt>Kernel#Array</tt> explained above apply to the rest of +object+s.
  def self.wrap(object)
    if object.nil?
      []
    elsif object.respond_to?(:to_ary)
      object.to_ary
    else
      [object]
    end
  end
end

Version data entries

46 entries across 46 versions & 3 rubygems

Version Path
social_url_stats-0.0.1 vendor/ruby/1.9.1/gems/activesupport-3.0.0/lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.20 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.19 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.18 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.17 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.16 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.15 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.14 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.13 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.13.rc1 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.12 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.12.rc1 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.11 lib/active_support/core_ext/array/wrap.rb
messagebus_ruby_api-0.4.7 spec/ruby/1.9.1/gems/activesupport-3.0.9/lib/active_support/core_ext/array/wrap.rb
messagebus_ruby_api-0.4.4 spec/ruby/1.9.1/gems/activesupport-3.0.9/lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.10 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.10.rc1 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.9 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.9.rc5 lib/active_support/core_ext/array/wrap.rb
activesupport-3.0.9.rc4 lib/active_support/core_ext/array/wrap.rb