From 417369e0cd6ec96950d2d48f2c94e7b1eb012076 Mon Sep 17 00:00:00 2001
From: zverok <zverok.offline@gmail.com>
Date: Sat, 26 Oct 2019 14:02:59 +0300
Subject: Improve Enumerator.produce docs

* Add to NEWS;
* Add examples of while-alike cycles with practical tasks.
---
 enumerator.c | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'enumerator.c')

diff --git a/enumerator.c b/enumerator.c
index eee3a34e6b..06e2a9e6a7 100644
--- a/enumerator.c
+++ b/enumerator.c
@@ -2923,6 +2923,21 @@ producer_size(VALUE obj, VALUE args, VALUE eobj)
  *
  *   ancestors = Enumerator.produce(node) { |prev| node = prev.parent or raise StopIteration }
  *   enclosing_section = ancestors.find { |n| n.type == :section }
+ *
+ * Using ::produce together with Enumerable methods like Enumerable#detect,
+ * Enumerable#slice, Enumerable#take_while can provide Enumerator-based alternative
+ * for +while+ and +until+ cycles:
+ *
+ *   # Find next Tuesday
+ *   require 'date'
+ *   Enumerator.produce(Date.today, &:succ).detect(&:tuesday?)
+ *
+ *   # Simple lexer:
+ *   require 'strscan'
+ *   scanner = StringScanner.new('7+38/6')
+ *   PATTERN = %r{\d+|[-/+*]}
+ *   p Enumerator.produce { scanner.scan(PATTERN) }.slice_after { scanner.eos? }.first
+ *   # => ["7", "+", "38", "/", "6"]
  */
 static VALUE
 enumerator_s_produce(int argc, VALUE *argv, VALUE klass)
-- 
cgit v1.2.1