Class: Insertion

Inherits:
Object
  • Object
show all
Defined in:
lib/yard/core_ext/insertion.rb

Overview

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

Examples:

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

Instance Method Summary (collapse)

Constructor Details

- (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.

Parameters:

  • list (Array)

    the list to perform the insertion on

  • value (Object)

    the value to insert



13
# File 'lib/yard/core_ext/insertion.rb', line 13

def initialize(list, value) @list, @values = list, (Array === value ? value : [value]) end

Instance Method Details

- (Object) after(val, recursive = false)

Inserts the value after val.

Examples:

If subsections are ignored

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

Parameters:

  • val (Object)

    the object the value will be inserted after

  • recursive (Boolean) (defaults to: false)

    look inside sublists



26
# File 'lib/yard/core_ext/insertion.rb', line 26

def after(val, recursive = false) insertion(val, 1, recursive) end

- (Object) after_any(val)

Alias for #after with recursive set to true

Since:

  • 0.6.0



34
# File 'lib/yard/core_ext/insertion.rb', line 34

def after_any(val) insertion(val, 1, true) end

- (Object) before(val, recursive = false)

Inserts the value before val

Parameters:

  • val (Object)

    the object the value will be inserted before

  • recursive (Boolean) (defaults to: false)

    look inside sublists



18
# File 'lib/yard/core_ext/insertion.rb', line 18

def before(val, recursive = false) insertion(val, 0, recursive) end

- (Object) before_any(val)

Alias for #before with recursive set to true

Since:

  • 0.6.0



30
# File 'lib/yard/core_ext/insertion.rb', line 30

def before_any(val) insertion(val, 0, true) end