Skip to main content

Ruby

Below are visualizations of all our scope tests for this language. These were created primarily for testing purposes rather than as documentation. There are quite a few, and they may feel a bit overwhelming from a documentation standpoint.

Scopes​

Anonymous function​

1. Anonymous function​

An anonymous function, eg a lambda function, an arrow function, etc.

Argument list​

1. Argument list: Actual empty​

An empty list of arguments in a function call. Insertion delimiter should be empty.

2. Argument list: Actual method empty​

An empty list of arguments in a method call. Insertion delimiter should be empty.

3. Argument list: Actual method multi line​

A multi line list of arguments in a method call. Insertion delimiter should include new line.

4. Argument list: Actual method single line​

A single line list of arguments in a method call

5. Argument list: Actual multi line​

A multi line list of arguments in a function call. Insertion delimiter should include new line.

6. Argument list: Actual single line​

A single line list of arguments in a function call

7. Argument list: Formal empty​

An empty list of parameters in a function declaration. Insertion delimiter should be empty.

8. Argument list: Formal lambda empty​

An empty list of parameters in a lambda declaration. Insertion delimiter should be empty.

9. Argument list: Formal lambda multi line​

A multi line list of parameters in a lambda declaration. Insertion delimiter should include new line.

10. Argument list: Formal lambda single line​

A single line list of parameters in a lambda declaration

11. Argument list: Formal method empty​

An empty list of parameters in a class method declaration. Insertion delimiter should be empty.

12. Argument list: Formal method multi line​

A multi line list of parameters in a class method declaration. Insertion delimiter should include new line.

13. Argument list: Formal method single line​

A single line list of parameters in a class method declaration

14. Argument list: Formal multi line​

A multi line list of parameters in a function declaration. Insertion delimiter should include new line.

15. Argument list: Formal single line​

A single line list of parameters in a function declaration

Argument or parameter​

1. Argument: Actual method multi line​

A multi line argument in a method call. Insertion delimiter should include new line.

2. Argument: Actual method single line​

A single line argument in a method call

3. Argument: Actual multi line​

A multiline argument in a function call. Insertion delimiter should include new line.

4. Argument: Actual single line​

A single line argument in a function call

5. Argument: Formal lambda multi line​

A multi line parameter in a lambda declaration. Insertion delimiter should include new line.

6. Argument: Formal lambda single line​

A single line parameter in a lambda declaration

7. Argument: Formal method multi line​

A multi line parameter in a class method declaration. Insertion delimiter should include new line.

8. Argument: Formal method single line​

A single line parameter in a class method declaration

9. Argument: Formal multi line​

A multi line parameter in a function declaration. Insertion delimiter should include new line.

10. Argument: Formal single line​

A single line parameter in a function declaration

11. Argument: Actual (iteration)​

Iteration scope for arguments in a function call: the argument list. The domain should be the entire function call.

12. Argument: Actual method (iteration)​

Iteration scope for arguments in a method call: the argument list. The domain should be the entire method call.

13. Argument: Formal (iteration)​

Iteration scope for formal parameters in a function declaration: the parameters list. The domain should be the entire function.

14. Argument: Formal lambda (iteration)​

Iteration scope for formal parameters in a lambda declaration: the parameter list. The domain should be the entire lambda.

15. Argument: Formal method (iteration)​

Iteration scope for formal parameters in a method declaration: the parameter list. The domain should be the entire method.

Branch​

1. Branch: If​

An if branch

2. Branch: If elif else​

An if-elif-else branch. The removal range for the if branch should include the trailing else keyword.

3. Branch: If else​

An if-else branch

4. Branch: Switch case​

A case/default branch in a switch statement

5. Branch: Ternary​

A branch in a ternary expression

6. Branch: Try​

A try/catch/finally branch

7. Branch: If (iteration)​

Iteration scope for if/elif/else branches: the if-else statement.

8. Branch: Switch case (iteration)​

Iteration scope for switch branches: the switch statement body.

9. Branch: Ternary (iteration)​

Iteration scope for ternary expression branches: the ternary expression.

10. Branch: Try (iteration)​

Iteration scope for try/catch/finally branches: the try-catch statement.

Class​

1. Class​

A class/struct in an object-oriented language

2. Class (iteration class)​

Iteration scope for classes: class bodies.

3. Class (iteration document)​

Iteration scope for classes: the entire document including leading and trailing empty lines.

Collection key​

1. Key: Map pair​

Key (LHS) of a key-value pair of a map

2. Key: Map pair (iteration)​

Iteration scope for keys of key-value pairs in a map: should be between the braces.

Comment​

1. Comment: Block​

A block comment

2. Comment: Line​

A line comment

Condition​

1. Condition: If​

A condition in an if statement

2. Condition: Switch case​

A condition in a switch statement

3. Condition: Ternary​

A condition in a ternary expression

4. Condition: While​

A condition in a while loop

5. Condition: Switch case (iteration)​

Iteration scope for conditions in a switch statement: the switch statement body.

Function call​

1. Function call​

A function call

2. Function call: Chain​

A chain of function calls, eg foo().bar()

3. Function call: Method​

A method call

Function callee​

1. Function callee​

The function being called in a function call

2. Function callee: Chain​

The function being called in a chain of function calls, including parent objects.

3. Function callee: Method​

The function being called in a method call, including parent objects.

If statement​

1. If statement​

An if statement

List​

1. List​

A list/array

Map​

1. Map​

A map/dictionary

Name​

1. Name: Argument actual​

Name of a (keyword) argument in a function call

2. Name: Argument formal​

Name of a parameter in a function declaration

3. Name: Argument formal lambda​

Name of a parameter in a lambda declaration

4. Name: Argument formal method​

Name of a parameter in a class method declaration

5. Name: Assignment​

Name (LHS) of an assignment

6. Name: Class​

Name of a class

7. Name: Foreach​

Iteration variable name in a for each loop

8. Name: Function​

Name of a function

9. Name: Method​

Name of a class method

10. Name (iteration block)​

Iteration scope for names: statement blocks (body of functions/if-statements/for-loops/etc).

11. Name (iteration class)​

Iteration scope for names: class bodies.

12. Name (iteration document)​

Iteration scope for names: the entire document including leading and trailing empty lines.

13. Name: Argument actual (iteration)​

Iteration scope for names of (keyword) arguments in a function call: the argument list.

14. Name: Argument formal (iteration)​

Iteration scope for names of formal parameters in a function declaration: the parameters list.

15. Name: Argument formal lambda (iteration)​

Iteration scope for names of formal parameters in a lambda declaration: the parameters list.

16. Name: Argument formal method (iteration)​

Iteration scope for names of formal parameters in a method declaration: the parameters list.

Named function​

1. Named function​

A named function declaration

2. Named function: Method​

A named method declaration in a class

3. Named function (iteration class)​

Iteration scope for named functions: class bodies.

4. Named function (iteration document)​

Iteration scope for named functions: the entire document including leading and trailing empty lines.

Regular expression​

1. Regular expression​

A regular expression

Statement​

1. Statement: Assignment​

An assignment statement

2. Statement: Break​

A break statement

3. Statement: Class​

A class/struct declaration

4. Statement: Continue​

A continue statement

5. Statement: Foreach​

A for-each loop statement

6. Statement: Function​

A named function declaration

7. Statement: Function call​

A function call statement

8. Statement: If​

A if/elif/else statement

9. Statement: Method​

A method declaration

10. Statement: Misc​

A miscellaneous statement

11. Statement: Return​

A return statement

12. Statement: Switch​

A switch statement

13. Statement: Throw​

A throw statement

14. Statement: Try​

A try/catch/finally statement

15. Statement: Variable initialized​

An initialized variable declaration

16. Statement: While​

A while loop statement

17. Statement: Yield​

A yield statement

18. Statement (iteration block)​

Iteration scope for statements: statement blocks (body of functions/if-statements/for-loops/etc).

19. Statement (iteration class)​

Iteration scope for statements: class bodies.

20. Statement (iteration document)​

Iteration scope for statements: the entire document including leading and trailing empty lines.

Value​

1. Value: Argument actual​

The value of a (keyword) argument in a function call

2. Value: Argument formal​

The (default) value of a argument in a function declaration

3. Value: Argument formal lambda​

The (default) value of a parameter in a lambda declaration

4. Value: Argument formal method​

The (default) value of a parameter in a method declaration

5. Value: Assignment​

Value (RHS) of an assignment

6. Value: Foreach​

Iterable in a for each loop

7. Value: Map pair​

Value (RHS) of a key-value pair in a map

8. Value: Return​

Return value of a function

9. Value: Return lambda​

Implicit return value from a lambda

10. Value: Switch​

The value / subject of a switch statement

11. Value: Throw​

Value of a throw statement

12. Value: Variable​

Value (RHS) of a variable declaration

13. Value: Yield​

Value of a yield statement

14. Value (iteration block)​

Iteration scope for values: statement blocks (body of functions/if-statements/for-loops/etc).

15. Value (iteration class)​

Iteration scope for values: class bodies.

16. Value (iteration document)​

Iteration scope for values: the entire document including leading and trailing empty lines.

17. Value: Argument actual (iteration)​

Iteration scope for values of (keyword) arguments in a function call: the arguments list.

18. Value: Argument formal (iteration)​

Iteration scope for values of formal parameters in a function declaration: the parameters list.

19. Value: Argument formal lambda (iteration)​

Iteration scope for values of formal parameters in a lambda declaration: the parameters list.

20. Value: Argument formal method (iteration)​

Iteration scope for values of formal parameters in a method declaration: the parameters list.

21. Value: Map pair (iteration)​

Iteration scope for values of key-value pairs in a map: should be between the braces.

Internal scopes​

The following are internal scopes. They are not intended for user interaction or spoken use. These scopes exist solely for internal Cursorless functionality.

Disqualify delimiter​

1. Disqualify delimiter​

Internally used to disqualify a token from being treated as a surrounding pair delimiter. This will usually be operators containing > or <, eg <, <=, ->, etc.

Interior​

1. Interior: Class​

The body of a class

2. Interior: Foreach​

The body of a for-each loop

3. Interior: Function​

The body of a function declaration

4. Interior: If​

The body of an if/elif/else branch

5. Interior: Lambda​

The block body of a lambda/anonymous function

6. Interior: Method​

The body of a method declaration

7. Interior: Switch​

The body of a switch statement

8. Interior: Switch case​

The body of a switch case branch

9. Interior: Try​

The body of a try/catch/finally branch

10. Interior: While​

The body of a while loop

String​

1. String: Multi line​

A multi-line string

2. String: Single line​

A single-line string

Text fragment​

1. Text fragment: Comment block​

Internally used text fragment consisting of a block comment

2. Text fragment: Comment line​

Internally used text fragment consisting of a line comment

3. Text fragment: String multi line​

Internally used text fragment consisting of a multi-line string

4. Text fragment: String single line​

Internally used text fragment consisting of a single-line string