recurring_date 0.1.4 → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. checksums.yaml +4 -4
  2. data/.yardoc/checksums +3 -0
  3. data/.yardoc/complete +0 -0
  4. data/.yardoc/object_types +0 -0
  5. data/.yardoc/objects/root.dat +0 -0
  6. data/.yardoc/proxy_types +0 -0
  7. data/Gemfile.lock +1 -1
  8. data/README.md +2 -0
  9. data/doc/Date.html +143 -0
  10. data/doc/RecurringDate.html +296 -0
  11. data/doc/RecurringDate/Enumerator.html +2546 -0
  12. data/doc/_index.html +135 -0
  13. data/doc/class_list.html +51 -0
  14. data/doc/css/common.css +1 -0
  15. data/doc/css/full_list.css +58 -0
  16. data/doc/css/style.css +496 -0
  17. data/doc/file.README.html +144 -0
  18. data/doc/file_list.html +56 -0
  19. data/doc/frames.html +17 -0
  20. data/doc/index.html +144 -0
  21. data/doc/js/app.js +314 -0
  22. data/doc/js/full_list.js +216 -0
  23. data/doc/js/jquery.js +4 -0
  24. data/doc/method_list.html +275 -0
  25. data/doc/top-level-namespace.html +112 -0
  26. data/lib/recurring_date.rb +3 -0
  27. data/lib/recurring_date/enumerator.rb +81 -2
  28. data/lib/recurring_date/version.rb +1 -1
  29. metadata +24 -2
data/doc/file.README.html ADDED
@@ -0,0 +1,144 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.24
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "README";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="file_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'>
61
+ <h1 id="label-recurring_date">recurring_date</h1>
62
+
63
+ <p><a href="https://badge.fury.io/rb/recurring_date"><img src="https://badge.fury.io/rb/recurring_date.svg"></a> <a href="https://travis-ci.org/placek/recurring_date"><img src="https://travis-ci.org/placek/recurring_date.svg?branch=master"></a> <a href="https://codeclimate.com/github/placek/recurring_date/maintainability"><img src="https://api.codeclimate.com/v1/badges/8b2339034c78677126e7/maintainability"></a></p>
64
+
65
+ <p>Iterate over a set of dates, giving an iteration conditions.</p>
66
+
67
+ <p>This gem provides an enumerator <code>RecurringDate::Enumerator</code>, selecting specific dates due to the recursion pattern.</p>
68
+
69
+ <p><code>RecurringDate::Enumerator</code> is lazy so pattern can be applied to an infinite set of dates.</p>
70
+
71
+ <p>The enumerator operates on objects that implements the <code>Enumerator#each</code> and yields <code>Date</code>.</p>
72
+
73
+ <h2 id="label-Installation">Installation</h2>
74
+
75
+ <p>Add this line to your application&#39;s Gemfile:</p>
76
+
77
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>recurring_date</span><span class='tstring_end'>&#39;</span></span>
78
+ </code></pre>
79
+
80
+ <p>And then execute:</p>
81
+
82
+ <pre class="code ruby"><code class="ruby">$ bundle
83
+ </code></pre>
84
+
85
+ <p>Or install it yourself as:</p>
86
+
87
+ <pre class="code ruby"><code class="ruby">$ gem install recurring_date
88
+ </code></pre>
89
+
90
+ <h2 id="label-Usage">Usage</h2>
91
+
92
+ <h3 id="label-RecurringDate"><code>RecurringDate</code></h3>
93
+
94
+ <p><code>RecurringDate</code> module adds two methods to class <code>Date</code>:</p>
95
+
96
+ <p>| Method | Description |————|————- | <code>#mweek</code> | Returns a number - n&#39;th occurence of the week day in the month. | <code>#to_enum</code> | Returns <code>RecurringDate::Enumerator</code> enumerator with given range from <code>self</code> iterating forever (infinite set).</p>
97
+
98
+ <h3 id="label-RecurringDate-3A-3AEnumerator"><code>RecurringDate::Enumerator</code></h3>
99
+
100
+ <p>The enumerator implements bunch of chainable methods to provide simple DSL for selecting wanted recursion pattern.</p>
101
+
102
+ <p>| Pattern | DSL |———————————————————-|—– | dates matching <code>condition</code> | <code>enumerator.select { ❘d❘ condition }</code> | dates not matching <code>condition</code> | <code>enumerator.reject { ❘d❘ condition }</code> | dates matching <code>condition</code> (with index <code>i</code>) | <code>enumerator.select_with_index { ❘d, i❘ condition }</code> | dates from beginning as long as <code>condition</code> is fulfilled | <code>enumerator.take_while { ❘d❘ condition }</code> | <code>n</code> dates from beginning | <code>enumerator.take(n)</code> | every 4th of October | <code>enumerator.month(10).mday(4)</code> | every 3rd and 23rd of August | <code>enumerator.month(8).mday(3, 23)</code> | every 17th June and July | <code>enumerator.month(6, 7).mday(17)</code> | every 10th and 12th of February and April | <code>enumerator.month(2, 4).mday(10, 12)</code> | every 13th of the month | <code>enumerator.mday(13)</code> | every 21st and 23rd of the month | <code>enumerator.mday(21, 23)</code> | every Friday | <code>enumerator.wday(5)</code> | every Saturday and Sunday | <code>enumerator.wday(6, 0)</code> | every Saturday and Sunday | <code>enumerator.matching(6, 0) { ❘d❘ d.wday }</code> | every Saturday and Sunday | <code>enumerator.matching(6, 0, &amp;:wday)</code> | every 4th day | <code>enumerator.pattern(4)</code> | every 7th or 10th day | <code>enumerator.pattern(7, 10)</code> | every second Friday | <code>enumerator.wday(5).pattern(2)</code> | every 2nd Monday of the month | <code>enumerator.wday(1).mweek(2)</code> | 2nd and 4th Sunday of the month | <code>enumerator.wday(0).mweek(2,4)</code> | 3rd Tuesday and Wednesday of the month | <code>enumerator.wday(2,3).mweek(3)</code> | until <code>date</code> | <code>enumerator.until(date)</code></p>
103
+
104
+ <h6 id="label-NOTE">NOTE</h6>
105
+ <ul><li>
106
+ <p>There is a method <code>RecurringDate::Enumerator.eternity</code> that returns <code>RecurringDate::Enumerator</code> instance that iterates perpetualy over every day after <em>1970-01-01</em>.</p>
107
+ </li><li>
108
+ <p>The <code>RecurringDate::Enumerator.from(date)</code> method does the same, but from <code>date</code>.</p>
109
+ </li><li>
110
+ <p>Every enumerator method (except <code>select</code>, <code>select_with_index</code>, <code>reject</code>, <code>take</code>, <code>take_while</code> and <code>until</code>) has a corresponding method with <code>not_</code> prefix.</p>
111
+ </li><li>
112
+ <p>For <code>rails</code> models the pattern can be used to select records, like: <code>Model.where(&#39;column::date IN (?)&#39;, dates)</code>.</p>
113
+ </li></ul>
114
+
115
+ <h3 id="label-Example">Example</h3>
116
+
117
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>recurring_date</span><span class='tstring_end'>&#39;</span></span>
118
+ <span class='id identifier rubyid_rule'>rule</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="RecurringDate.html" title="RecurringDate (module)">RecurringDate</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="RecurringDate/Enumerator.html" title="RecurringDate::Enumerator (class)">Enumerator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_eternity'><span class='object_link'><a href="RecurringDate/Enumerator.html#eternity-class_method" title="RecurringDate::Enumerator.eternity (method)">eternity</a></span></span>
119
+ <span class='id identifier rubyid_rule'>rule</span><span class='period'>.</span><span class='id identifier rubyid_wday'>wday</span><span class='lparen'>(</span><span class='int'>5</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_mweek'>mweek</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span> <span class='comment'># =&gt; enumerator of all first Fridays of a month
120
+ </span><span class='id identifier rubyid_rule'>rule</span><span class='period'>.</span><span class='id identifier rubyid_pattern'>pattern</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_until'>until</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Date.html" title="Date (class)">Date</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='int'>2020</span><span class='comma'>,</span> <span class='int'>8</span><span class='comma'>,</span> <span class='int'>1</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='comment'># =&gt; enumerator of every second day until 2020-08-01
121
+ </span><span class='id identifier rubyid_rule'>rule</span><span class='period'>.</span><span class='id identifier rubyid_wday'>wday</span><span class='lparen'>(</span><span class='int'>6</span><span class='comma'>,</span><span class='int'>0</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_mweek'>mweek</span><span class='lparen'>(</span><span class='int'>2</span><span class='comma'>,</span><span class='int'>4</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_take'>take</span><span class='lparen'>(</span><span class='int'>8</span><span class='rparen'>)</span> <span class='comment'># =&gt; enumerator of next four 2nd and 4th weekends of a month
122
+ </span><span class='id identifier rubyid_rule'>rule</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span> <span class='comment'># =&gt; array of `Date` instances (be careful - it can be infinite)
123
+ </span></code></pre>
124
+
125
+ <h2 id="label-Development">Development</h2>
126
+
127
+ <p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run <code>rake spec</code> to run the tests. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
128
+
129
+ <p>To install this gem onto your local machine, run <code>bundle exec rake install</code>. To release a new version, update the version number in <code>lib/recurring_date/version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
130
+
131
+ <h2 id="label-Contributing">Contributing</h2>
132
+
133
+ <p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/placek/recurring_date">github.com/placek/recurring_date</a>.</p>
134
+ </div></div>
135
+
136
+ <div id="footer">
137
+ Generated on Tue Mar 24 07:23:15 2020 by
138
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
139
+ 0.9.24 (ruby-2.6.5).
140
+ </div>
141
+
142
+ </div>
143
+ </body>
144
+ </html>
data/doc/file_list.html ADDED
@@ -0,0 +1,56 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
+ <meta charset="utf-8" />
6
+
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
8
+
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
10
+
11
+
12
+
13
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
+
17
+
18
+ <title>File List</title>
19
+ <base id="base_target" target="_parent" />
20
+ </head>
21
+ <body>
22
+ <div id="content">
23
+ <div class="fixed_header">
24
+ <h1 id="full_list_header">File List</h1>
25
+ <div id="full_list_nav">
26
+
27
+ <span><a target="_self" href="class_list.html">
28
+ Classes
29
+ </a></span>
30
+
31
+ <span><a target="_self" href="method_list.html">
32
+ Methods
33
+ </a></span>
34
+
35
+ <span><a target="_self" href="file_list.html">
36
+ Files
37
+ </a></span>
38
+
39
+ </div>
40
+
41
+ <div id="search">Search: <input type="text" /></div>
42
+ </div>
43
+
44
+ <ul id="full_list" class="file">
45
+
46
+
47
+ <li id="object_README" class="odd">
48
+ <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
49
+ </li>
50
+
51
+
52
+
53
+ </ul>
54
+ </div>
55
+ </body>
56
+ </html>
data/doc/frames.html ADDED
@@ -0,0 +1,17 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Documentation by YARD 0.9.24</title>
6
+ </head>
7
+ <script type="text/javascript">
8
+ var match = unescape(window.location.hash).match(/^#!(.+)/);
9
+ var name = match ? match[1] : 'index.html';
10
+ name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
11
+ window.top.location = name;
12
+ </script>
13
+ <noscript>
14
+ <h1>Oops!</h1>
15
+ <h2>YARD requires JavaScript!</h2>
16
+ </noscript>
17
+ </html>
data/doc/index.html ADDED
@@ -0,0 +1,144 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.24
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "README";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'>
61
+ <h1 id="label-recurring_date">recurring_date</h1>
62
+
63
+ <p><a href="https://badge.fury.io/rb/recurring_date"><img src="https://badge.fury.io/rb/recurring_date.svg"></a> <a href="https://travis-ci.org/placek/recurring_date"><img src="https://travis-ci.org/placek/recurring_date.svg?branch=master"></a> <a href="https://codeclimate.com/github/placek/recurring_date/maintainability"><img src="https://api.codeclimate.com/v1/badges/8b2339034c78677126e7/maintainability"></a></p>
64
+
65
+ <p>Iterate over a set of dates, giving an iteration conditions.</p>
66
+
67
+ <p>This gem provides an enumerator <code>RecurringDate::Enumerator</code>, selecting specific dates due to the recursion pattern.</p>
68
+
69
+ <p><code>RecurringDate::Enumerator</code> is lazy so pattern can be applied to an infinite set of dates.</p>
70
+
71
+ <p>The enumerator operates on objects that implements the <code>Enumerator#each</code> and yields <code>Date</code>.</p>
72
+
73
+ <h2 id="label-Installation">Installation</h2>
74
+
75
+ <p>Add this line to your application&#39;s Gemfile:</p>
76
+
77
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>recurring_date</span><span class='tstring_end'>&#39;</span></span>
78
+ </code></pre>
79
+
80
+ <p>And then execute:</p>
81
+
82
+ <pre class="code ruby"><code class="ruby">$ bundle
83
+ </code></pre>
84
+
85
+ <p>Or install it yourself as:</p>
86
+
87
+ <pre class="code ruby"><code class="ruby">$ gem install recurring_date
88
+ </code></pre>
89
+
90
+ <h2 id="label-Usage">Usage</h2>
91
+
92
+ <h3 id="label-RecurringDate"><code>RecurringDate</code></h3>
93
+
94
+ <p><code>RecurringDate</code> module adds two methods to class <code>Date</code>:</p>
95
+
96
+ <p>| Method | Description |————|————- | <code>#mweek</code> | Returns a number - n&#39;th occurence of the week day in the month. | <code>#to_enum</code> | Returns <code>RecurringDate::Enumerator</code> enumerator with given range from <code>self</code> iterating forever (infinite set).</p>
97
+
98
+ <h3 id="label-RecurringDate-3A-3AEnumerator"><code>RecurringDate::Enumerator</code></h3>
99
+
100
+ <p>The enumerator implements bunch of chainable methods to provide simple DSL for selecting wanted recursion pattern.</p>
101
+
102
+ <p>| Pattern | DSL |———————————————————-|—– | dates matching <code>condition</code> | <code>enumerator.select { ❘d❘ condition }</code> | dates not matching <code>condition</code> | <code>enumerator.reject { ❘d❘ condition }</code> | dates matching <code>condition</code> (with index <code>i</code>) | <code>enumerator.select_with_index { ❘d, i❘ condition }</code> | dates from beginning as long as <code>condition</code> is fulfilled | <code>enumerator.take_while { ❘d❘ condition }</code> | <code>n</code> dates from beginning | <code>enumerator.take(n)</code> | every 4th of October | <code>enumerator.month(10).mday(4)</code> | every 3rd and 23rd of August | <code>enumerator.month(8).mday(3, 23)</code> | every 17th June and July | <code>enumerator.month(6, 7).mday(17)</code> | every 10th and 12th of February and April | <code>enumerator.month(2, 4).mday(10, 12)</code> | every 13th of the month | <code>enumerator.mday(13)</code> | every 21st and 23rd of the month | <code>enumerator.mday(21, 23)</code> | every Friday | <code>enumerator.wday(5)</code> | every Saturday and Sunday | <code>enumerator.wday(6, 0)</code> | every Saturday and Sunday | <code>enumerator.matching(6, 0) { ❘d❘ d.wday }</code> | every Saturday and Sunday | <code>enumerator.matching(6, 0, &amp;:wday)</code> | every 4th day | <code>enumerator.pattern(4)</code> | every 7th or 10th day | <code>enumerator.pattern(7, 10)</code> | every second Friday | <code>enumerator.wday(5).pattern(2)</code> | every 2nd Monday of the month | <code>enumerator.wday(1).mweek(2)</code> | 2nd and 4th Sunday of the month | <code>enumerator.wday(0).mweek(2,4)</code> | 3rd Tuesday and Wednesday of the month | <code>enumerator.wday(2,3).mweek(3)</code> | until <code>date</code> | <code>enumerator.until(date)</code></p>
103
+
104
+ <h6 id="label-NOTE">NOTE</h6>
105
+ <ul><li>
106
+ <p>There is a method <code>RecurringDate::Enumerator.eternity</code> that returns <code>RecurringDate::Enumerator</code> instance that iterates perpetualy over every day after <em>1970-01-01</em>.</p>
107
+ </li><li>
108
+ <p>The <code>RecurringDate::Enumerator.from(date)</code> method does the same, but from <code>date</code>.</p>
109
+ </li><li>
110
+ <p>Every enumerator method (except <code>select</code>, <code>select_with_index</code>, <code>reject</code>, <code>take</code>, <code>take_while</code> and <code>until</code>) has a corresponding method with <code>not_</code> prefix.</p>
111
+ </li><li>
112
+ <p>For <code>rails</code> models the pattern can be used to select records, like: <code>Model.where(&#39;column::date IN (?)&#39;, dates)</code>.</p>
113
+ </li></ul>
114
+
115
+ <h3 id="label-Example">Example</h3>
116
+
117
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>recurring_date</span><span class='tstring_end'>&#39;</span></span>
118
+ <span class='id identifier rubyid_rule'>rule</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="RecurringDate.html" title="RecurringDate (module)">RecurringDate</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="RecurringDate/Enumerator.html" title="RecurringDate::Enumerator (class)">Enumerator</a></span></span><span class='period'>.</span><span class='id identifier rubyid_eternity'><span class='object_link'><a href="RecurringDate/Enumerator.html#eternity-class_method" title="RecurringDate::Enumerator.eternity (method)">eternity</a></span></span>
119
+ <span class='id identifier rubyid_rule'>rule</span><span class='period'>.</span><span class='id identifier rubyid_wday'>wday</span><span class='lparen'>(</span><span class='int'>5</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_mweek'>mweek</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span> <span class='comment'># =&gt; enumerator of all first Fridays of a month
120
+ </span><span class='id identifier rubyid_rule'>rule</span><span class='period'>.</span><span class='id identifier rubyid_pattern'>pattern</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_until'>until</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Date.html" title="Date (class)">Date</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='int'>2020</span><span class='comma'>,</span> <span class='int'>8</span><span class='comma'>,</span> <span class='int'>1</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='comment'># =&gt; enumerator of every second day until 2020-08-01
121
+ </span><span class='id identifier rubyid_rule'>rule</span><span class='period'>.</span><span class='id identifier rubyid_wday'>wday</span><span class='lparen'>(</span><span class='int'>6</span><span class='comma'>,</span><span class='int'>0</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_mweek'>mweek</span><span class='lparen'>(</span><span class='int'>2</span><span class='comma'>,</span><span class='int'>4</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_take'>take</span><span class='lparen'>(</span><span class='int'>8</span><span class='rparen'>)</span> <span class='comment'># =&gt; enumerator of next four 2nd and 4th weekends of a month
122
+ </span><span class='id identifier rubyid_rule'>rule</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span> <span class='comment'># =&gt; array of `Date` instances (be careful - it can be infinite)
123
+ </span></code></pre>
124
+
125
+ <h2 id="label-Development">Development</h2>
126
+
127
+ <p>After checking out the repo, run <code>bin/setup</code> to install dependencies. Then, run <code>rake spec</code> to run the tests. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
128
+
129
+ <p>To install this gem onto your local machine, run <code>bundle exec rake install</code>. To release a new version, update the version number in <code>lib/recurring_date/version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
130
+
131
+ <h2 id="label-Contributing">Contributing</h2>
132
+
133
+ <p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/placek/recurring_date">github.com/placek/recurring_date</a>.</p>
134
+ </div></div>
135
+
136
+ <div id="footer">
137
+ Generated on Tue Mar 24 07:23:15 2020 by
138
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
139
+ 0.9.24 (ruby-2.6.5).
140
+ </div>
141
+
142
+ </div>
143
+ </body>
144
+ </html>
data/doc/js/app.js ADDED
@@ -0,0 +1,314 @@
1
+ (function() {
2
+
3
+ var localStorage = {}, sessionStorage = {};
4
+ try { localStorage = window.localStorage; } catch (e) { }
5
+ try { sessionStorage = window.sessionStorage; } catch (e) { }
6
+
7
+ function createSourceLinks() {
8
+ $('.method_details_list .source_code').
9
+ before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
10
+ $('.toggleSource').toggle(function() {
11
+ $(this).parent().nextAll('.source_code').slideDown(100);
12
+ $(this).text("Hide source");
13
+ },
14
+ function() {
15
+ $(this).parent().nextAll('.source_code').slideUp(100);
16
+ $(this).text("View source");
17
+ });
18
+ }
19
+
20
+ function createDefineLinks() {
21
+ var tHeight = 0;
22
+ $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
23
+ $('.toggleDefines').toggle(function() {
24
+ tHeight = $(this).parent().prev().height();
25
+ $(this).prev().css('display', 'inline');
26
+ $(this).parent().prev().height($(this).parent().height());
27
+ $(this).text("(less)");
28
+ },
29
+ function() {
30
+ $(this).prev().hide();
31
+ $(this).parent().prev().height(tHeight);
32
+ $(this).text("more...");
33
+ });
34
+ }
35
+
36
+ function createFullTreeLinks() {
37
+ var tHeight = 0;
38
+ $('.inheritanceTree').toggle(function() {
39
+ tHeight = $(this).parent().prev().height();
40
+ $(this).parent().toggleClass('showAll');
41
+ $(this).text("(hide)");
42
+ $(this).parent().prev().height($(this).parent().height());
43
+ },
44
+ function() {
45
+ $(this).parent().toggleClass('showAll');
46
+ $(this).parent().prev().height(tHeight);
47
+ $(this).text("show all");
48
+ });
49
+ }
50
+
51
+ function searchFrameButtons() {
52
+ $('.full_list_link').click(function() {
53
+ toggleSearchFrame(this, $(this).attr('href'));
54
+ return false;
55
+ });
56
+ window.addEventListener('message', function(e) {
57
+ if (e.data === 'navEscape') {
58
+ $('#nav').slideUp(100);
59
+ $('#search a').removeClass('active inactive');
60
+ $(window).focus();
61
+ }
62
+ });
63
+
64
+ $(window).resize(function() {
65
+ if ($('#search:visible').length === 0) {
66
+ $('#nav').removeAttr('style');
67
+ $('#search a').removeClass('active inactive');
68
+ $(window).focus();
69
+ }
70
+ });
71
+ }
72
+
73
+ function toggleSearchFrame(id, link) {
74
+ var frame = $('#nav');
75
+ $('#search a').removeClass('active').addClass('inactive');
76
+ if (frame.attr('src') === link && frame.css('display') !== "none") {
77
+ frame.slideUp(100);
78
+ $('#search a').removeClass('active inactive');
79
+ }
80
+ else {
81
+ $(id).addClass('active').removeClass('inactive');
82
+ if (frame.attr('src') !== link) frame.attr('src', link);
83
+ frame.slideDown(100);
84
+ }
85
+ }
86
+
87
+ function linkSummaries() {
88
+ $('.summary_signature').click(function() {
89
+ document.location = $(this).find('a').attr('href');
90
+ });
91
+ }
92
+
93
+ function summaryToggle() {
94
+ $('.summary_toggle').click(function(e) {
95
+ e.preventDefault();
96
+ localStorage.summaryCollapsed = $(this).text();
97
+ $('.summary_toggle').each(function() {
98
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
99
+ var next = $(this).parent().parent().nextAll('ul.summary').first();
100
+ if (next.hasClass('compact')) {
101
+ next.toggle();
102
+ next.nextAll('ul.summary').first().toggle();
103
+ }
104
+ else if (next.hasClass('summary')) {
105
+ var list = $('<ul class="summary compact" />');
106
+ list.html(next.html());
107
+ list.find('.summary_desc, .note').remove();
108
+ list.find('a').each(function() {
109
+ $(this).html($(this).find('strong').html());
110
+ $(this).parent().html($(this)[0].outerHTML);
111
+ });
112
+ next.before(list);
113
+ next.toggle();
114
+ }
115
+ });
116
+ return false;
117
+ });
118
+ if (localStorage.summaryCollapsed == "collapse") {
119
+ $('.summary_toggle').first().click();
120
+ } else { localStorage.summaryCollapsed = "expand"; }
121
+ }
122
+
123
+ function constantSummaryToggle() {
124
+ $('.constants_summary_toggle').click(function(e) {
125
+ e.preventDefault();
126
+ localStorage.summaryCollapsed = $(this).text();
127
+ $('.constants_summary_toggle').each(function() {
128
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
129
+ var next = $(this).parent().parent().nextAll('dl.constants').first();
130
+ if (next.hasClass('compact')) {
131
+ next.toggle();
132
+ next.nextAll('dl.constants').first().toggle();
133
+ }
134
+ else if (next.hasClass('constants')) {
135
+ var list = $('<dl class="constants compact" />');
136
+ list.html(next.html());
137
+ list.find('dt').each(function() {
138
+ $(this).addClass('summary_signature');
139
+ $(this).text( $(this).text().split('=')[0]);
140
+ if ($(this).has(".deprecated").length) {
141
+ $(this).addClass('deprecated');
142
+ };
143
+ });
144
+ // Add the value of the constant as "Tooltip" to the summary object
145
+ list.find('pre.code').each(function() {
146
+ console.log($(this).parent());
147
+ var dt_element = $(this).parent().prev();
148
+ var tooltip = $(this).text();
149
+ if (dt_element.hasClass("deprecated")) {
150
+ tooltip = 'Deprecated. ' + tooltip;
151
+ };
152
+ dt_element.attr('title', tooltip);
153
+ });
154
+ list.find('.docstring, .tags, dd').remove();
155
+ next.before(list);
156
+ next.toggle();
157
+ }
158
+ });
159
+ return false;
160
+ });
161
+ if (localStorage.summaryCollapsed == "collapse") {
162
+ $('.constants_summary_toggle').first().click();
163
+ } else { localStorage.summaryCollapsed = "expand"; }
164
+ }
165
+
166
+ function generateTOC() {
167
+ if ($('#filecontents').length === 0) return;
168
+ var _toc = $('<ol class="top"></ol>');
169
+ var show = false;
170
+ var toc = _toc;
171
+ var counter = 0;
172
+ var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
173
+ var i;
174
+ var curli;
175
+ if ($('#filecontents h1').length > 1) tags.unshift('h1');
176
+ for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
177
+ var lastTag = parseInt(tags[0][1], 10);
178
+ $(tags.join(', ')).each(function() {
179
+ if ($(this).parents('.method_details .docstring').length != 0) return;
180
+ if (this.id == "filecontents") return;
181
+ show = true;
182
+ var thisTag = parseInt(this.tagName[1], 10);
183
+ if (this.id.length === 0) {
184
+ var proposedId = $(this).attr('toc-id');
185
+ if (typeof(proposedId) != "undefined") this.id = proposedId;
186
+ else {
187
+ var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
188
+ if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
189
+ this.id = proposedId;
190
+ }
191
+ }
192
+ if (thisTag > lastTag) {
193
+ for (i = 0; i < thisTag - lastTag; i++) {
194
+ if ( typeof(curli) == "undefined" ) {
195
+ curli = $('<li/>');
196
+ toc.append(curli);
197
+ }
198
+ toc = $('<ol/>');
199
+ curli.append(toc);
200
+ curli = undefined;
201
+ }
202
+ }
203
+ if (thisTag < lastTag) {
204
+ for (i = 0; i < lastTag - thisTag; i++) {
205
+ toc = toc.parent();
206
+ toc = toc.parent();
207
+ }
208
+ }
209
+ var title = $(this).attr('toc-title');
210
+ if (typeof(title) == "undefined") title = $(this).text();
211
+ curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
212
+ toc.append(curli);
213
+ lastTag = thisTag;
214
+ });
215
+ if (!show) return;
216
+ html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
217
+ $('#content').prepend(html);
218
+ $('#toc').append(_toc);
219
+ $('#toc .hide_toc').toggle(function() {
220
+ $('#toc .top').slideUp('fast');
221
+ $('#toc').toggleClass('hidden');
222
+ $('#toc .title small').toggle();
223
+ }, function() {
224
+ $('#toc .top').slideDown('fast');
225
+ $('#toc').toggleClass('hidden');
226
+ $('#toc .title small').toggle();
227
+ });
228
+ }
229
+
230
+ function navResizeFn(e) {
231
+ if (e.which !== 1) {
232
+ navResizeFnStop();
233
+ return;
234
+ }
235
+
236
+ sessionStorage.navWidth = e.pageX.toString();
237
+ $('.nav_wrap').css('width', e.pageX);
238
+ $('.nav_wrap').css('-ms-flex', 'inherit');
239
+ }
240
+
241
+ function navResizeFnStop() {
242
+ $(window).unbind('mousemove', navResizeFn);
243
+ window.removeEventListener('message', navMessageFn, false);
244
+ }
245
+
246
+ function navMessageFn(e) {
247
+ if (e.data.action === 'mousemove') navResizeFn(e.data.event);
248
+ if (e.data.action === 'mouseup') navResizeFnStop();
249
+ }
250
+
251
+ function navResizer() {
252
+ $('#resizer').mousedown(function(e) {
253
+ e.preventDefault();
254
+ $(window).mousemove(navResizeFn);
255
+ window.addEventListener('message', navMessageFn, false);
256
+ });
257
+ $(window).mouseup(navResizeFnStop);
258
+
259
+ if (sessionStorage.navWidth) {
260
+ navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
261
+ }
262
+ }
263
+
264
+ function navExpander() {
265
+ var done = false, timer = setTimeout(postMessage, 500);
266
+ function postMessage() {
267
+ if (done) return;
268
+ clearTimeout(timer);
269
+ var opts = { action: 'expand', path: pathId };
270
+ document.getElementById('nav').contentWindow.postMessage(opts, '*');
271
+ done = true;
272
+ }
273
+
274
+ window.addEventListener('message', function(event) {
275
+ if (event.data === 'navReady') postMessage();
276
+ return false;
277
+ }, false);
278
+ }
279
+
280
+ function mainFocus() {
281
+ var hash = window.location.hash;
282
+ if (hash !== '' && $(hash)[0]) {
283
+ $(hash)[0].scrollIntoView();
284
+ }
285
+
286
+ setTimeout(function() { $('#main').focus(); }, 10);
287
+ }
288
+
289
+ function navigationChange() {
290
+ // This works around the broken anchor navigation with the YARD template.
291
+ window.onpopstate = function() {
292
+ var hash = window.location.hash;
293
+ if (hash !== '' && $(hash)[0]) {
294
+ $(hash)[0].scrollIntoView();
295
+ }
296
+ };
297
+ }
298
+
299
+ $(document).ready(function() {
300
+ navResizer();
301
+ navExpander();
302
+ createSourceLinks();
303
+ createDefineLinks();
304
+ createFullTreeLinks();
305
+ searchFrameButtons();
306
+ linkSummaries();
307
+ summaryToggle();
308
+ constantSummaryToggle();
309
+ generateTOC();
310
+ mainFocus();
311
+ navigationChange();
312
+ });
313
+
314
+ })();