-
Notifications
You must be signed in to change notification settings - Fork 55
/
Copy pathMontrose.html
460 lines (245 loc) · 19 KB
/
Montrose.html
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Montrose
— Documentation by YARD 0.9.36
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Montrose";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (M)</a> »
<span class="title">Montrose</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Montrose
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd><span class='object_link'><a href="Montrose/Chainable.html" title="Montrose::Chainable (module)">Chainable</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/montrose.rb<span class="defines">,<br />
lib/montrose/day.rb,<br /> lib/montrose/hour.rb,<br /> lib/montrose/ical.rb,<br /> lib/montrose/rule.rb,<br /> lib/montrose/week.rb,<br /> lib/montrose/clock.rb,<br /> lib/montrose/month.rb,<br /> lib/montrose/stack.rb,<br /> lib/montrose/utils.rb,<br /> lib/montrose/errors.rb,<br /> lib/montrose/minute.rb,<br /> lib/montrose/options.rb,<br /> lib/montrose/version.rb,<br /> lib/montrose/schedule.rb,<br /> lib/montrose/year_day.rb,<br /> lib/montrose/chainable.rb,<br /> lib/montrose/frequency.rb,<br /> lib/montrose/month_day.rb,<br /> lib/montrose/recurrence.rb,<br /> lib/montrose/rule/after.rb,<br /> lib/montrose/rule/total.rb,<br /> lib/montrose/rule/until.rb,<br /> lib/montrose/rule/during.rb,<br /> lib/montrose/rule/except.rb,<br /> lib/montrose/time_of_day.rb,<br /> lib/montrose/rule/between.rb,<br /> lib/montrose/rule/covering.rb,<br /> lib/montrose/frequency/daily.rb,<br /> lib/montrose/frequency/hourly.rb,<br /> lib/montrose/frequency/weekly.rb,<br /> lib/montrose/frequency/yearly.rb,<br /> lib/montrose/rule/day_of_week.rb,<br /> lib/montrose/rule/day_of_year.rb,<br /> lib/montrose/rule/hour_of_day.rb,<br /> lib/montrose/rule/time_of_day.rb,<br /> lib/montrose/frequency/monthly.rb,<br /> lib/montrose/rule/day_of_month.rb,<br /> lib/montrose/rule/week_of_year.rb,<br /> lib/montrose/frequency/minutely.rb,<br /> lib/montrose/frequency/secondly.rb,<br /> lib/montrose/rule/month_of_year.rb,<br /> lib/montrose/rule/minute_of_hour.rb,<br /> lib/montrose/rule/nth_day_matcher.rb,<br /> lib/montrose/rule/nth_day_of_year.rb,<br /> lib/montrose/rule/nth_day_of_month.rb,<br /> lib/montrose/refinements/array_concat.rb</span>
</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Montrose/Chainable.html" title="Montrose::Chainable (module)">Chainable</a></span>, <span class='object_link'><a href="Montrose/Refinements.html" title="Montrose::Refinements (module)">Refinements</a></span>, <span class='object_link'><a href="Montrose/Rule.html" title="Montrose::Rule (module)">Rule</a></span>, <span class='object_link'><a href="Montrose/Utils.html" title="Montrose::Utils (module)">Utils</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Montrose/Clock.html" title="Montrose::Clock (class)">Clock</a></span>, <span class='object_link'><a href="Montrose/Day.html" title="Montrose::Day (class)">Day</a></span>, <span class='object_link'><a href="Montrose/Frequency.html" title="Montrose::Frequency (class)">Frequency</a></span>, <span class='object_link'><a href="Montrose/Hour.html" title="Montrose::Hour (class)">Hour</a></span>, <span class='object_link'><a href="Montrose/ICal.html" title="Montrose::ICal (class)">ICal</a></span>, <span class='object_link'><a href="Montrose/Minute.html" title="Montrose::Minute (class)">Minute</a></span>, <span class='object_link'><a href="Montrose/Month.html" title="Montrose::Month (class)">Month</a></span>, <span class='object_link'><a href="Montrose/MonthDay.html" title="Montrose::MonthDay (class)">MonthDay</a></span>, <span class='object_link'><a href="Montrose/Options.html" title="Montrose::Options (class)">Options</a></span>, <span class='object_link'><a href="Montrose/Recurrence.html" title="Montrose::Recurrence (class)">Recurrence</a></span>, <span class='object_link'><a href="Montrose/Schedule.html" title="Montrose::Schedule (class)">Schedule</a></span>, <span class='object_link'><a href="Montrose/Stack.html" title="Montrose::Stack (class)">Stack</a></span>, <span class='object_link'><a href="Montrose/TimeOfDay.html" title="Montrose::TimeOfDay (class)">TimeOfDay</a></span>, <span class='object_link'><a href="Montrose/Week.html" title="Montrose::Week (class)">Week</a></span>, <span class='object_link'><a href="Montrose/YearDay.html" title="Montrose::YearDay (class)">YearDay</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="Error-constant" class="">Error =
</dt>
<dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>StandardError</span><span class='rparen'>)</span></pre></dd>
<dt id="ConfigurationError-constant" class="">ConfigurationError =
</dt>
<dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#Error-constant" title="Montrose::Error (constant)">Error</a></span></span><span class='rparen'>)</span></pre></dd>
<dt id="SerializationError-constant" class="">SerializationError =
</dt>
<dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#Error-constant" title="Montrose::Error (constant)">Error</a></span></span><span class='rparen'>)</span></pre></dd>
<dt id="VERSION-constant" class="">VERSION =
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.17.0</span><span class='tstring_end'>"</span></span></pre></dd>
</dl>
<h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#enable_deprecated_between_masking-class_method" title="enable_deprecated_between_masking (class method)">.<strong>enable_deprecated_between_masking</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Create a new recurrence from given options An alias to <span class='object_link'><a href="Montrose/Recurrence.html#new-class_method" title="Montrose::Recurrence.new (method)">Recurrence.new</a></span>.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#enable_deprecated_between_masking%3F-class_method" title="enable_deprecated_between_masking? (class method)">.<strong>enable_deprecated_between_masking?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#recurrence-class_method" title="recurrence (class method)">.<strong>recurrence</strong>(options = {}) ⇒ Montrose::Recurrence </a>
(also: r)
</span>
<span class="summary_desc"><div class='inline'>
<p>Create a new recurrence from given options An alias to <span class='object_link'><a href="Montrose/Recurrence.html#new-class_method" title="Montrose::Recurrence.new (method)">Recurrence.new</a></span>.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Montrose/Chainable.html" title="Montrose::Chainable (module)">Chainable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Montrose/Chainable.html#at-instance_method" title="Montrose::Chainable#at (method)">at</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#between-instance_method" title="Montrose::Chainable#between (method)">between</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#branch-instance_method" title="Montrose::Chainable#branch (method)">branch</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#covering-instance_method" title="Montrose::Chainable#covering (method)">covering</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#daily-instance_method" title="Montrose::Chainable#daily (method)">daily</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#day_of_month-instance_method" title="Montrose::Chainable#day_of_month (method)">day_of_month</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#day_of_week-instance_method" title="Montrose::Chainable#day_of_week (method)">day_of_week</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#day_of_year-instance_method" title="Montrose::Chainable#day_of_year (method)">day_of_year</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#default_options-instance_method" title="Montrose::Chainable#default_options (method)">default_options</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#during-instance_method" title="Montrose::Chainable#during (method)">during</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#every-instance_method" title="Montrose::Chainable#every (method)">every</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#except-instance_method" title="Montrose::Chainable#except (method)">except</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#hour_of_day-instance_method" title="Montrose::Chainable#hour_of_day (method)">hour_of_day</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#hourly-instance_method" title="Montrose::Chainable#hourly (method)">hourly</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#merge-instance_method" title="Montrose::Chainable#merge (method)">merge</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#minutely-instance_method" title="Montrose::Chainable#minutely (method)">minutely</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#month_of_year-instance_method" title="Montrose::Chainable#month_of_year (method)">month_of_year</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#monthly-instance_method" title="Montrose::Chainable#monthly (method)">monthly</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#on-instance_method" title="Montrose::Chainable#on (method)">on</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#starts-instance_method" title="Montrose::Chainable#starts (method)">starts</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#total-instance_method" title="Montrose::Chainable#total (method)">total</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#until-instance_method" title="Montrose::Chainable#until (method)">until</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#week_of_year-instance_method" title="Montrose::Chainable#week_of_year (method)">week_of_year</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#weekly-instance_method" title="Montrose::Chainable#weekly (method)">weekly</a></span>, <span class='object_link'><a href="Montrose/Chainable.html#yearly-instance_method" title="Montrose::Chainable#yearly (method)">yearly</a></span></p>
<div id="class_attr_details" class="attr_details">
<h2>Class Attribute Details</h2>
<span id="enable_deprecated_between_masking=-class_method"></span>
<div class="method_details first">
<h3 class="signature first" id="enable_deprecated_between_masking-class_method">
.<strong>enable_deprecated_between_masking</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new recurrence from given options An alias to <span class='object_link'><a href="Montrose/Recurrence.html#new-class_method" title="Montrose::Recurrence.new (method)">Montrose::Recurrence.new</a></span></p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/montrose.rb', line 57</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enable_deprecated_between_masking'>enable_deprecated_between_masking</span>
<span class='ivar'>@enable_deprecated_between_masking</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="enable_deprecated_between_masking?-class_method">
.<strong>enable_deprecated_between_masking?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
64
65
66
67
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/montrose.rb', line 64</span>
<span class='kw'>def</span> <span class='id identifier rubyid_enable_deprecated_between_masking?'>enable_deprecated_between_masking?</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='op'>!</span><span class='op'>!</span><span class='id identifier rubyid_enable_deprecated_between_masking'>enable_deprecated_between_masking</span>
<span class='kw'>if</span> <span class='id identifier rubyid_result'>result</span>
<span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[DEPRECATION] Legacy Montrose.between masking behavior is deprecated. Please use Montrose.covering instead to retain this behavior.</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_result'>result</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="recurrence-class_method">
.<strong>recurrence</strong>(options = {}) ⇒ <tt><span class='object_link'><a href="Montrose/Recurrence.html" title="Montrose::Recurrence (class)">Montrose::Recurrence</a></span></tt>
<span class="aliases">Also known as:
<span class="names"><span id='r-class_method'>r</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new recurrence from given options An alias to <span class='object_link'><a href="Montrose/Recurrence.html#new-class_method" title="Montrose::Recurrence.new (method)">Montrose::Recurrence.new</a></span></p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="Montrose (module)">Montrose</a></span></span><span class='period'>.</span><span class='id identifier rubyid_recurrence'>recurrence</span><span class='lparen'>(</span><span class='label'>every:</span> <span class='symbol'>:day</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="" title="Montrose (module)">Montrose</a></span></span><span class='period'>.</span><span class='id identifier rubyid_r'>r</span><span class='lparen'>(</span><span class='label'>every:</span> <span class='symbol'>:day</span><span class='rparen'>)</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>recurrence options</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Montrose/Recurrence.html" title="Montrose::Recurrence (class)">Montrose::Recurrence</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/montrose.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_recurrence'>recurrence</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_branch'>branch</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Dec 13 15:23:53 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-2.7.8).
</div>
</div>
</body>
</html>