This defines four ruby text objects – block, class, function and name. A block is delimited by the regex in the variable g:ruby_block_openers and end. A function is a special case of block, starting with def, class works the same way. The inner variant doesn't include the delimiter lines.

A name is a module-scoped identifier like Module::Klass.

By default, the omaps ir and ar are used for a block; if and af for a function, ic, ac for a class and an for a name.

Specifying a count selects outer blocks recursively.

The variable g:textobj_ruby_inclusive controls whether leading comments and a single blank line are included in the a object if present, defaulting to 1.

Consult the documentation of textobj-user for custom mappings.

If g:textobj_ruby_inner_branch is 1, the inner block object will select the lines between else, elsif, rescue and ensure (configurable via g:ruby_block_middles) and the boundaries instead of including all conditional branches.

If g:textobj_ruby_no_mappings is 1, no actual mappings are created.

The plugin uses a consistent line based approach, with the lines containing the delimiters being part of the block. This means that invoking the text object on the word before a do will select the block opened by it, which is especially useful on empty blocks. When the ir object is used on the opener line, the selection will begin on the next line.

The reason for inclusive mode is that when deleting or copying a function, you most likely want to paste it somewhere else and not leave an additional empty line around (given that you separate all functions by a single blank line). Comments directly above a block are most likely connected to it, so leaving them would be impractical.

When invoked multiple times in visual mode, the selection grows to the next larger block, just like when invoking the operator with a count. To decide whether to grow, the visual selection is checked – if start and end do not match, it is assumed that the selection is already a block. This can result in faulty behaviour when invoked from visual mode with o nonzero selection and the cursor on the end delimiter line – the next outer block will be selected.

textobj-user

Copyright (c) Torsten Schmits. Distributed under the terms of the MIT License.