Class: Insertion

Inherits:

Object

show all

Defined in:

lib/yard/core_ext/array.rb

Overview

The Insertion class inserts a value before or after another value in a list.

  Insertion.new([1, 2, 3], 4).before(3) # => [1, 2, 4, 3]

- (Object) after(val, ignore_subsections = true) Inserts the value after val.
- (Object) before(val) Inserts the value before val.
- (Insertion) initialize(list, value) constructor Creates an insertion object on a list with a value to be inserted.

- (Insertion) initialize(list, value)

Creates an insertion object on a list with a value to be inserted. To finalize the insertion, call #before or #after on the object.

29	# File 'lib/yard/core_ext/array.rb', line 29 def initialize(list, value) @list, @value = list, value end

- (Object) after(val, ignore_subsections = true)

Inserts the value after val.

  Insertion.new([1, [2], 3], :X).after(1) # => [1, [2], :X, 3]

(Object) val — the object the value will be inserted after
(Boolean) ignore_subsections (defaults to: true) — treat any Array objects that follow val as associated and do not split them up.

42	# File 'lib/yard/core_ext/array.rb', line 42 def after(val, ignore_subsections = true) insertion(val, 1, ignore_subsections) end

- (Object) before(val)

Inserts the value before val

33	# File 'lib/yard/core_ext/array.rb', line 33 def before(val) insertion(val, 0) end