File: yield.md

package info (click to toggle)
ruby-ruby-lsp 0.26.7-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 27,676 kB
  • sloc: ruby: 35,294; javascript: 29; sh: 7; makefile: 4
file content (81 lines) | stat: -rw-r--r-- 2,173 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# Yield

In Ruby, every method implicitly accepts a block, even when not included in the parameters list.

```ruby
def foo
end

foo { 123 } # works!
```

The `yield` keyword is used to invoke the block that was passed with arguments.

```ruby
# Consider this method call. The block being passed to the method `foo` accepts an argument called `a`.
# It then takes whatever argument was passed and multiplies it by 2
foo do |a|
  a * 2
end

# In the `foo` method declaration, we can use `yield` to invoke the block that was passed and provide the block
# with the value for the `a` argument
def foo
  # Invoke the block passed to `foo` with the number 10 as the argument `a`
  result = yield(10)
  puts result # Will print 20
end
```

If `yield` is used to invoke the block, but no block was passed, that will result in a local jump error.

```ruby
# If we invoke `foo` without a block, trying to `yield` will fail
foo

# `foo': no block given (yield) (LocalJumpError)
```

We can decide to use `yield` conditionally by using Ruby's `block_given?` method, which will return `true` if a block
was passed to the method.

```ruby
def foo
  # If a block is passed when invoking `foo`, call the block with argument 10 and print the result.
  # Otherwise, just print that no block was passed
  if block_given?
    result = yield(10)
    puts result
  else
    puts "No block passed!"
  end
end

foo do |a|
  a * 2
end
# => 20

foo
# => No block passed!
```

## Block parameter

In addition to implicit blocks, Ruby also allows developers to use explicit block parameters as part of the method's
signature. In this scenario, we can use the reference to the block directly instead of relying on the `yield` keyword.

```ruby
# Block parameters are prefixed with & and a name
def foo(&my_block_param)
  # If a block was passed to `foo`, `my_block_param` will be a `Proc` object. Otherwise, it will be `nil`. We can use
  # that to check for its presence
  if my_block_param
    # Explicit block parameters are invoked using the method `call`, which is present in all `Proc` objects
    result = my_block_param.call(10)
    puts result
  else
    puts "No block passed!"
  end
end
```