timeboss 0.0.10 → 0.1.0

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 (71) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/.yardopts +1 -0
  4. data/README.md +1 -1
  5. data/doc/TimeBoss.html +146 -0
  6. data/doc/TimeBoss/Calendar.html +137 -0
  7. data/doc/TimeBoss/Calendar/Day.html +594 -0
  8. data/doc/TimeBoss/Calendar/Half.html +396 -0
  9. data/doc/TimeBoss/Calendar/Month.html +396 -0
  10. data/doc/TimeBoss/Calendar/Parser.html +386 -0
  11. data/doc/TimeBoss/Calendar/Period.html +841 -0
  12. data/doc/TimeBoss/Calendar/Quarter.html +396 -0
  13. data/doc/TimeBoss/Calendar/Support.html +131 -0
  14. data/doc/TimeBoss/Calendar/Support/Formatter.html +459 -0
  15. data/doc/TimeBoss/Calendar/Support/MonthBased.html +591 -0
  16. data/doc/TimeBoss/Calendar/Support/MonthBasis.html +437 -0
  17. data/doc/TimeBoss/Calendar/Support/MonthlyUnit.html +591 -0
  18. data/doc/TimeBoss/Calendar/Support/Navigable.html +723 -0
  19. data/doc/TimeBoss/Calendar/Support/Shiftable.html +138 -0
  20. data/doc/TimeBoss/Calendar/Support/Unit.html +1299 -0
  21. data/doc/TimeBoss/Calendar/Waypoints.html +155 -0
  22. data/doc/TimeBoss/Calendar/Waypoints/Absolute.html +1378 -0
  23. data/doc/TimeBoss/Calendar/Waypoints/Relative.html +4308 -0
  24. data/doc/TimeBoss/Calendar/Week.html +671 -0
  25. data/doc/TimeBoss/Calendar/Year.html +319 -0
  26. data/doc/TimeBoss/Calendars.html +336 -0
  27. data/doc/TimeBoss/Calendars/Broadcast.html +221 -0
  28. data/doc/TimeBoss/Calendars/Broadcast/Basis.html +278 -0
  29. data/doc/TimeBoss/Calendars/Entry.html +399 -0
  30. data/doc/TimeBoss/Support.html +115 -0
  31. data/doc/TimeBoss/Support/Shellable.html +249 -0
  32. data/doc/_index.html +416 -0
  33. data/doc/class_list.html +51 -0
  34. data/doc/css/common.css +1 -0
  35. data/doc/css/full_list.css +58 -0
  36. data/doc/css/style.css +496 -0
  37. data/doc/file.README.html +299 -0
  38. data/doc/file_list.html +56 -0
  39. data/doc/frames.html +17 -0
  40. data/doc/index.html +299 -0
  41. data/doc/js/app.js +314 -0
  42. data/doc/js/full_list.js +216 -0
  43. data/doc/js/jquery.js +4 -0
  44. data/doc/method_list.html +1139 -0
  45. data/doc/top-level-namespace.html +110 -0
  46. data/lib/timeboss.rb +4 -0
  47. data/lib/timeboss/calendar.rb +14 -0
  48. data/lib/timeboss/calendar/day.rb +10 -3
  49. data/lib/timeboss/calendar/half.rb +7 -2
  50. data/lib/timeboss/calendar/month.rb +7 -2
  51. data/lib/timeboss/calendar/parser.rb +1 -0
  52. data/lib/timeboss/calendar/period.rb +26 -11
  53. data/lib/timeboss/calendar/quarter.rb +7 -2
  54. data/lib/timeboss/calendar/support.rb +8 -0
  55. data/lib/timeboss/calendar/support/formatter.rb +1 -0
  56. data/lib/timeboss/calendar/support/month_basis.rb +3 -0
  57. data/lib/timeboss/calendar/support/{month_based.rb → monthly_unit.rb} +7 -1
  58. data/lib/timeboss/calendar/support/navigable.rb +25 -1
  59. data/lib/timeboss/calendar/support/shiftable.rb +3 -2
  60. data/lib/timeboss/calendar/support/unit.rb +24 -0
  61. data/lib/timeboss/calendar/waypoints.rb +6 -55
  62. data/lib/timeboss/calendar/waypoints/absolute.rb +114 -0
  63. data/lib/timeboss/calendar/waypoints/relative.rb +268 -0
  64. data/lib/timeboss/calendar/week.rb +11 -0
  65. data/lib/timeboss/calendar/year.rb +6 -5
  66. data/lib/timeboss/calendars.rb +16 -0
  67. data/lib/timeboss/version.rb +1 -1
  68. data/spec/calendar/support/{month_based_spec.rb → monthly_unit_spec.rb} +7 -7
  69. data/spec/calendars/broadcast_spec.rb +7 -7
  70. data/timeboss.gemspec +1 -0
  71. metadata +70 -7
data/doc/TimeBoss/Calendar/Half.html ADDED
@@ -0,0 +1,396 @@
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
+ Class: TimeBoss::Calendar::Half
8
+
9
+ &mdash; Documentation by YARD 0.9.25
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 = "TimeBoss::Calendar::Half";
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 (H)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../TimeBoss.html" title="TimeBoss (module)">TimeBoss</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Calendar.html" title="TimeBoss::Calendar (class)">Calendar</a></span></span>
41
+ &raquo;
42
+ <span class="title">Half</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: TimeBoss::Calendar::Half
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="Support/MonthlyUnit.html" title="TimeBoss::Calendar::Support::MonthlyUnit (class)">Support::MonthlyUnit</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="Support/Unit.html" title="TimeBoss::Calendar::Support::Unit (class)">Support::Unit</a></span></li>
78
+
79
+ <li class="next"><span class='object_link'><a href="Support/MonthlyUnit.html" title="TimeBoss::Calendar::Support::MonthlyUnit (class)">Support::MonthlyUnit</a></span></li>
80
+
81
+ <li class="next">TimeBoss::Calendar::Half</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dl>
100
+ <dt>Defined in:</dt>
101
+ <dd>lib/timeboss/calendar/half.rb</dd>
102
+ </dl>
103
+
104
+ </div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+
109
+ <p>Representation of a 6-month period within a calendar.</p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+
119
+ <h2>
120
+ Constant Summary
121
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
122
+ </h2>
123
+
124
+ <dl class="constants">
125
+
126
+ <dt id="NUM_MONTHS-constant" class="">NUM_MONTHS =
127
+
128
+ </dt>
129
+ <dd><pre class="code"><span class='int'>6</span></pre></dd>
130
+
131
+ </dl>
132
+
133
+
134
+
135
+
136
+
137
+
138
+ <h3 class="inherited">Constants included
139
+ from <span class='object_link'><a href="Support/Shiftable.html" title="TimeBoss::Calendar::Support::Shiftable (module)">Support::Shiftable</a></span></h3>
140
+ <p class="inherited"><span class='object_link'><a href="Support/Shiftable.html#PERIODS-constant" title="TimeBoss::Calendar::Support::Shiftable::PERIODS (constant)">Support::Shiftable::PERIODS</a></span></p>
141
+
142
+
143
+
144
+
145
+ <h2>Instance Attribute Summary</h2>
146
+
147
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Support/MonthlyUnit.html" title="TimeBoss::Calendar::Support::MonthlyUnit (class)">Support::MonthlyUnit</a></span></h3>
148
+ <p class="inherited"><span class='object_link'><a href="Support/MonthlyUnit.html#index-instance_method" title="TimeBoss::Calendar::Support::MonthlyUnit#index (method)">#index</a></span>, <span class='object_link'><a href="Support/MonthlyUnit.html#year_index-instance_method" title="TimeBoss::Calendar::Support::MonthlyUnit#year_index (method)">#year_index</a></span></p>
149
+
150
+
151
+
152
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Support/Unit.html" title="TimeBoss::Calendar::Support::Unit (class)">Support::Unit</a></span></h3>
153
+ <p class="inherited"><span class='object_link'><a href="Support/Unit.html#calendar-instance_method" title="TimeBoss::Calendar::Support::Unit#calendar (method)">#calendar</a></span>, <span class='object_link'><a href="Support/Unit.html#end_date-instance_method" title="TimeBoss::Calendar::Support::Unit#end_date (method)">#end_date</a></span>, <span class='object_link'><a href="Support/Unit.html#start_date-instance_method" title="TimeBoss::Calendar::Support::Unit#start_date (method)">#start_date</a></span></p>
154
+
155
+
156
+
157
+ <h2>
158
+ Instance Method Summary
159
+ <small><a href="#" class="summary_toggle">collapse</a></small>
160
+ </h2>
161
+
162
+ <ul class="summary">
163
+
164
+ <li class="public ">
165
+ <span class="summary_signature">
166
+
167
+ <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; String </a>
168
+
169
+
170
+
171
+ </span>
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+ <span class="summary_desc"><div class='inline'>
182
+ <p>Get a simple representation of this half.</p>
183
+ </div></span>
184
+
185
+ </li>
186
+
187
+
188
+ <li class="public ">
189
+ <span class="summary_signature">
190
+
191
+ <a href="#title-instance_method" title="#title (instance method)">#<strong>title</strong> &#x21d2; String </a>
192
+
193
+
194
+
195
+ </span>
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <span class="summary_desc"><div class='inline'>
206
+ <p>Get a “pretty” representation of this half.</p>
207
+ </div></span>
208
+
209
+ </li>
210
+
211
+
212
+ </ul>
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Support/MonthlyUnit.html" title="TimeBoss::Calendar::Support::MonthlyUnit (class)">Support::MonthlyUnit</a></span></h3>
225
+ <p class="inherited"><span class='object_link'><a href="Support/MonthlyUnit.html#initialize-instance_method" title="TimeBoss::Calendar::Support::MonthlyUnit#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Support/MonthlyUnit.html#to_s-instance_method" title="TimeBoss::Calendar::Support::MonthlyUnit#to_s (method)">#to_s</a></span>, <span class='object_link'><a href="Support/MonthlyUnit.html#weeks-instance_method" title="TimeBoss::Calendar::Support::MonthlyUnit#weeks (method)">#weeks</a></span></p>
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Support/Unit.html" title="TimeBoss::Calendar::Support::Unit (class)">Support::Unit</a></span></h3>
236
+ <p class="inherited"><span class='object_link'><a href="Support/Unit.html#%2B-instance_method" title="TimeBoss::Calendar::Support::Unit#+ (method)">#+</a></span>, <span class='object_link'><a href="Support/Unit.html#--instance_method" title="TimeBoss::Calendar::Support::Unit#- (method)">#-</a></span>, <span class='object_link'><a href="Support/Unit.html#==-instance_method" title="TimeBoss::Calendar::Support::Unit#== (method)">#==</a></span>, <span class='object_link'><a href="Support/Unit.html#current%3F-instance_method" title="TimeBoss::Calendar::Support::Unit#current? (method)">#current?</a></span>, <span class='object_link'><a href="Support/Unit.html#format-instance_method" title="TimeBoss::Calendar::Support::Unit#format (method)">#format</a></span>, <span class='object_link'><a href="Support/Unit.html#initialize-instance_method" title="TimeBoss::Calendar::Support::Unit#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Support/Unit.html#offset-instance_method" title="TimeBoss::Calendar::Support::Unit#offset (method)">#offset</a></span>, <span class='object_link'><a href="Support/Unit.html#thru-instance_method" title="TimeBoss::Calendar::Support::Unit#thru (method)">#thru</a></span>, <span class='object_link'><a href="Support/Unit.html#to_range-instance_method" title="TimeBoss::Calendar::Support::Unit#to_range (method)">#to_range</a></span>, <span class='object_link'><a href="Support/Unit.html#type-class_method" title="TimeBoss::Calendar::Support::Unit.type (method)">type</a></span></p>
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Support/Navigable.html" title="TimeBoss::Calendar::Support::Navigable (module)">Support::Navigable</a></span></h3>
253
+ <p class="inherited"><span class='object_link'><a href="Support/Navigable.html#ago-instance_method" title="TimeBoss::Calendar::Support::Navigable#ago (method)">#ago</a></span>, <span class='object_link'><a href="Support/Navigable.html#ahead-instance_method" title="TimeBoss::Calendar::Support::Navigable#ahead (method)">#ahead</a></span>, <span class='object_link'><a href="Support/Navigable.html#next-instance_method" title="TimeBoss::Calendar::Support::Navigable#next (method)">#next</a></span>, <span class='object_link'><a href="Support/Navigable.html#previous-instance_method" title="TimeBoss::Calendar::Support::Navigable#previous (method)">#previous</a></span>, <span class='object_link'><a href="Support/Navigable.html#until-instance_method" title="TimeBoss::Calendar::Support::Navigable#until (method)">#until</a></span></p>
254
+ <div id="constructor_details" class="method_details_list">
255
+ <h2>Constructor Details</h2>
256
+
257
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Support/MonthlyUnit.html#initialize-instance_method" title="TimeBoss::Calendar::Support::MonthlyUnit#initialize (method)">TimeBoss::Calendar::Support::MonthlyUnit</a></span></p>
258
+
259
+ </div>
260
+
261
+
262
+ <div id="instance_method_details" class="method_details_list">
263
+ <h2>Instance Method Details</h2>
264
+
265
+
266
+ <div class="method_details first">
267
+ <h3 class="signature first" id="name-instance_method">
268
+
269
+ #<strong>name</strong> &#x21d2; <tt>String</tt>
270
+
271
+
272
+
273
+
274
+
275
+ </h3><div class="docstring">
276
+ <div class="discussion">
277
+
278
+ <p>Get a simple representation of this half.</p>
279
+
280
+
281
+ </div>
282
+ </div>
283
+ <div class="tags">
284
+
285
+ <p class="tag_title">Returns:</p>
286
+ <ul class="return">
287
+
288
+ <li>
289
+
290
+
291
+ <span class='type'>(<tt>String</tt>)</span>
292
+
293
+
294
+
295
+ &mdash;
296
+ <div class='inline'>
297
+ <p>(e.g. “2020H2”)</p>
298
+ </div>
299
+
300
+ </li>
301
+
302
+ </ul>
303
+
304
+ </div><table class="source_code">
305
+ <tr>
306
+ <td>
307
+ <pre class="lines">
308
+
309
+
310
+ 12
311
+ 13
312
+ 14</pre>
313
+ </td>
314
+ <td>
315
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/half.rb', line 12</span>
316
+
317
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
318
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_year_index'>year_index</span><span class='embexpr_end'>}</span><span class='tstring_content'>H</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_index'>index</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
319
+ <span class='kw'>end</span></pre>
320
+ </td>
321
+ </tr>
322
+ </table>
323
+ </div>
324
+
325
+ <div class="method_details ">
326
+ <h3 class="signature " id="title-instance_method">
327
+
328
+ #<strong>title</strong> &#x21d2; <tt>String</tt>
329
+
330
+
331
+
332
+
333
+
334
+ </h3><div class="docstring">
335
+ <div class="discussion">
336
+
337
+ <p>Get a “pretty” representation of this half.</p>
338
+
339
+
340
+ </div>
341
+ </div>
342
+ <div class="tags">
343
+
344
+ <p class="tag_title">Returns:</p>
345
+ <ul class="return">
346
+
347
+ <li>
348
+
349
+
350
+ <span class='type'>(<tt>String</tt>)</span>
351
+
352
+
353
+
354
+ &mdash;
355
+ <div class='inline'>
356
+ <p>(e.g. “H2 2020”)</p>
357
+ </div>
358
+
359
+ </li>
360
+
361
+ </ul>
362
+
363
+ </div><table class="source_code">
364
+ <tr>
365
+ <td>
366
+ <pre class="lines">
367
+
368
+
369
+ 18
370
+ 19
371
+ 20</pre>
372
+ </td>
373
+ <td>
374
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/half.rb', line 18</span>
375
+
376
+ <span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
377
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>H</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_index'>index</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_year_index'>year_index</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
378
+ <span class='kw'>end</span></pre>
379
+ </td>
380
+ </tr>
381
+ </table>
382
+ </div>
383
+
384
+ </div>
385
+
386
+ </div>
387
+
388
+ <div id="footer">
389
+ Generated on Sun Jul 19 10:12:11 2020 by
390
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
391
+ 0.9.25 (ruby-2.4.1).
392
+ </div>
393
+
394
+ </div>
395
+ </body>
396
+ </html>
data/doc/TimeBoss/Calendar/Month.html ADDED
@@ -0,0 +1,396 @@
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
+ Class: TimeBoss::Calendar::Month
8
+
9
+ &mdash; Documentation by YARD 0.9.25
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 = "TimeBoss::Calendar::Month";
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 (M)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../TimeBoss.html" title="TimeBoss (module)">TimeBoss</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Calendar.html" title="TimeBoss::Calendar (class)">Calendar</a></span></span>
41
+ &raquo;
42
+ <span class="title">Month</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: TimeBoss::Calendar::Month
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="Support/MonthlyUnit.html" title="TimeBoss::Calendar::Support::MonthlyUnit (class)">Support::MonthlyUnit</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="Support/Unit.html" title="TimeBoss::Calendar::Support::Unit (class)">Support::Unit</a></span></li>
78
+
79
+ <li class="next"><span class='object_link'><a href="Support/MonthlyUnit.html" title="TimeBoss::Calendar::Support::MonthlyUnit (class)">Support::MonthlyUnit</a></span></li>
80
+
81
+ <li class="next">TimeBoss::Calendar::Month</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dl>
100
+ <dt>Defined in:</dt>
101
+ <dd>lib/timeboss/calendar/month.rb</dd>
102
+ </dl>
103
+
104
+ </div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+
109
+ <p>Representation of a single month within a calendar.</p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+
119
+ <h2>
120
+ Constant Summary
121
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
122
+ </h2>
123
+
124
+ <dl class="constants">
125
+
126
+ <dt id="NUM_MONTHS-constant" class="">NUM_MONTHS =
127
+
128
+ </dt>
129
+ <dd><pre class="code"><span class='int'>1</span></pre></dd>
130
+
131
+ </dl>
132
+
133
+
134
+
135
+
136
+
137
+
138
+ <h3 class="inherited">Constants included
139
+ from <span class='object_link'><a href="Support/Shiftable.html" title="TimeBoss::Calendar::Support::Shiftable (module)">Support::Shiftable</a></span></h3>
140
+ <p class="inherited"><span class='object_link'><a href="Support/Shiftable.html#PERIODS-constant" title="TimeBoss::Calendar::Support::Shiftable::PERIODS (constant)">Support::Shiftable::PERIODS</a></span></p>
141
+
142
+
143
+
144
+
145
+ <h2>Instance Attribute Summary</h2>
146
+
147
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Support/MonthlyUnit.html" title="TimeBoss::Calendar::Support::MonthlyUnit (class)">Support::MonthlyUnit</a></span></h3>
148
+ <p class="inherited"><span class='object_link'><a href="Support/MonthlyUnit.html#index-instance_method" title="TimeBoss::Calendar::Support::MonthlyUnit#index (method)">#index</a></span>, <span class='object_link'><a href="Support/MonthlyUnit.html#year_index-instance_method" title="TimeBoss::Calendar::Support::MonthlyUnit#year_index (method)">#year_index</a></span></p>
149
+
150
+
151
+
152
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Support/Unit.html" title="TimeBoss::Calendar::Support::Unit (class)">Support::Unit</a></span></h3>
153
+ <p class="inherited"><span class='object_link'><a href="Support/Unit.html#calendar-instance_method" title="TimeBoss::Calendar::Support::Unit#calendar (method)">#calendar</a></span>, <span class='object_link'><a href="Support/Unit.html#end_date-instance_method" title="TimeBoss::Calendar::Support::Unit#end_date (method)">#end_date</a></span>, <span class='object_link'><a href="Support/Unit.html#start_date-instance_method" title="TimeBoss::Calendar::Support::Unit#start_date (method)">#start_date</a></span></p>
154
+
155
+
156
+
157
+ <h2>
158
+ Instance Method Summary
159
+ <small><a href="#" class="summary_toggle">collapse</a></small>
160
+ </h2>
161
+
162
+ <ul class="summary">
163
+
164
+ <li class="public ">
165
+ <span class="summary_signature">
166
+
167
+ <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; String </a>
168
+
169
+
170
+
171
+ </span>
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+ <span class="summary_desc"><div class='inline'>
182
+ <p>Get a simple representation of this month.</p>
183
+ </div></span>
184
+
185
+ </li>
186
+
187
+
188
+ <li class="public ">
189
+ <span class="summary_signature">
190
+
191
+ <a href="#title-instance_method" title="#title (instance method)">#<strong>title</strong> &#x21d2; String </a>
192
+
193
+
194
+
195
+ </span>
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <span class="summary_desc"><div class='inline'>
206
+ <p>Get a “pretty” representation of this month.</p>
207
+ </div></span>
208
+
209
+ </li>
210
+
211
+
212
+ </ul>
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Support/MonthlyUnit.html" title="TimeBoss::Calendar::Support::MonthlyUnit (class)">Support::MonthlyUnit</a></span></h3>
225
+ <p class="inherited"><span class='object_link'><a href="Support/MonthlyUnit.html#initialize-instance_method" title="TimeBoss::Calendar::Support::MonthlyUnit#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Support/MonthlyUnit.html#to_s-instance_method" title="TimeBoss::Calendar::Support::MonthlyUnit#to_s (method)">#to_s</a></span>, <span class='object_link'><a href="Support/MonthlyUnit.html#weeks-instance_method" title="TimeBoss::Calendar::Support::MonthlyUnit#weeks (method)">#weeks</a></span></p>
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Support/Unit.html" title="TimeBoss::Calendar::Support::Unit (class)">Support::Unit</a></span></h3>
236
+ <p class="inherited"><span class='object_link'><a href="Support/Unit.html#%2B-instance_method" title="TimeBoss::Calendar::Support::Unit#+ (method)">#+</a></span>, <span class='object_link'><a href="Support/Unit.html#--instance_method" title="TimeBoss::Calendar::Support::Unit#- (method)">#-</a></span>, <span class='object_link'><a href="Support/Unit.html#==-instance_method" title="TimeBoss::Calendar::Support::Unit#== (method)">#==</a></span>, <span class='object_link'><a href="Support/Unit.html#current%3F-instance_method" title="TimeBoss::Calendar::Support::Unit#current? (method)">#current?</a></span>, <span class='object_link'><a href="Support/Unit.html#format-instance_method" title="TimeBoss::Calendar::Support::Unit#format (method)">#format</a></span>, <span class='object_link'><a href="Support/Unit.html#initialize-instance_method" title="TimeBoss::Calendar::Support::Unit#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Support/Unit.html#offset-instance_method" title="TimeBoss::Calendar::Support::Unit#offset (method)">#offset</a></span>, <span class='object_link'><a href="Support/Unit.html#thru-instance_method" title="TimeBoss::Calendar::Support::Unit#thru (method)">#thru</a></span>, <span class='object_link'><a href="Support/Unit.html#to_range-instance_method" title="TimeBoss::Calendar::Support::Unit#to_range (method)">#to_range</a></span>, <span class='object_link'><a href="Support/Unit.html#type-class_method" title="TimeBoss::Calendar::Support::Unit.type (method)">type</a></span></p>
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Support/Navigable.html" title="TimeBoss::Calendar::Support::Navigable (module)">Support::Navigable</a></span></h3>
253
+ <p class="inherited"><span class='object_link'><a href="Support/Navigable.html#ago-instance_method" title="TimeBoss::Calendar::Support::Navigable#ago (method)">#ago</a></span>, <span class='object_link'><a href="Support/Navigable.html#ahead-instance_method" title="TimeBoss::Calendar::Support::Navigable#ahead (method)">#ahead</a></span>, <span class='object_link'><a href="Support/Navigable.html#next-instance_method" title="TimeBoss::Calendar::Support::Navigable#next (method)">#next</a></span>, <span class='object_link'><a href="Support/Navigable.html#previous-instance_method" title="TimeBoss::Calendar::Support::Navigable#previous (method)">#previous</a></span>, <span class='object_link'><a href="Support/Navigable.html#until-instance_method" title="TimeBoss::Calendar::Support::Navigable#until (method)">#until</a></span></p>
254
+ <div id="constructor_details" class="method_details_list">
255
+ <h2>Constructor Details</h2>
256
+
257
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Support/MonthlyUnit.html#initialize-instance_method" title="TimeBoss::Calendar::Support::MonthlyUnit#initialize (method)">TimeBoss::Calendar::Support::MonthlyUnit</a></span></p>
258
+
259
+ </div>
260
+
261
+
262
+ <div id="instance_method_details" class="method_details_list">
263
+ <h2>Instance Method Details</h2>
264
+
265
+
266
+ <div class="method_details first">
267
+ <h3 class="signature first" id="name-instance_method">
268
+
269
+ #<strong>name</strong> &#x21d2; <tt>String</tt>
270
+
271
+
272
+
273
+
274
+
275
+ </h3><div class="docstring">
276
+ <div class="discussion">
277
+
278
+ <p>Get a simple representation of this month.</p>
279
+
280
+
281
+ </div>
282
+ </div>
283
+ <div class="tags">
284
+
285
+ <p class="tag_title">Returns:</p>
286
+ <ul class="return">
287
+
288
+ <li>
289
+
290
+
291
+ <span class='type'>(<tt>String</tt>)</span>
292
+
293
+
294
+
295
+ &mdash;
296
+ <div class='inline'>
297
+ <p>(e.g. “2020M8”)</p>
298
+ </div>
299
+
300
+ </li>
301
+
302
+ </ul>
303
+
304
+ </div><table class="source_code">
305
+ <tr>
306
+ <td>
307
+ <pre class="lines">
308
+
309
+
310
+ 12
311
+ 13
312
+ 14</pre>
313
+ </td>
314
+ <td>
315
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/month.rb', line 12</span>
316
+
317
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
318
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_year_index'>year_index</span><span class='embexpr_end'>}</span><span class='tstring_content'>M</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_index'>index</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
319
+ <span class='kw'>end</span></pre>
320
+ </td>
321
+ </tr>
322
+ </table>
323
+ </div>
324
+
325
+ <div class="method_details ">
326
+ <h3 class="signature " id="title-instance_method">
327
+
328
+ #<strong>title</strong> &#x21d2; <tt>String</tt>
329
+
330
+
331
+
332
+
333
+
334
+ </h3><div class="docstring">
335
+ <div class="discussion">
336
+
337
+ <p>Get a “pretty” representation of this month.</p>
338
+
339
+
340
+ </div>
341
+ </div>
342
+ <div class="tags">
343
+
344
+ <p class="tag_title">Returns:</p>
345
+ <ul class="return">
346
+
347
+ <li>
348
+
349
+
350
+ <span class='type'>(<tt>String</tt>)</span>
351
+
352
+
353
+
354
+ &mdash;
355
+ <div class='inline'>
356
+ <p>(e.g. “August 2020”)</p>
357
+ </div>
358
+
359
+ </li>
360
+
361
+ </ul>
362
+
363
+ </div><table class="source_code">
364
+ <tr>
365
+ <td>
366
+ <pre class="lines">
367
+
368
+
369
+ 18
370
+ 19
371
+ 20</pre>
372
+ </td>
373
+ <td>
374
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/month.rb', line 18</span>
375
+
376
+ <span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
377
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>Date</span><span class='op'>::</span><span class='const'>MONTHNAMES</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_year_index'>year_index</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
378
+ <span class='kw'>end</span></pre>
379
+ </td>
380
+ </tr>
381
+ </table>
382
+ </div>
383
+
384
+ </div>
385
+
386
+ </div>
387
+
388
+ <div id="footer">
389
+ Generated on Sun Jul 19 10:12:11 2020 by
390
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
391
+ 0.9.25 (ruby-2.4.1).
392
+ </div>
393
+
394
+ </div>
395
+ </body>
396
+ </html>