timeboss 0.0.6 → 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 (80) hide show
  1. checksums.yaml +4 -4
  2. data/.github/ISSUE_TEMPLATE/bug_report.md +23 -0
  3. data/.github/ISSUE_TEMPLATE/feature_request.md +20 -0
  4. data/.gitignore +2 -0
  5. data/.travis.yml +4 -1
  6. data/.yardopts +1 -0
  7. data/CODE_OF_CONDUCT.md +76 -0
  8. data/README.md +30 -18
  9. data/bin/tbsh +15 -0
  10. data/doc/TimeBoss.html +146 -0
  11. data/doc/TimeBoss/Calendar.html +137 -0
  12. data/doc/TimeBoss/Calendar/Day.html +594 -0
  13. data/doc/TimeBoss/Calendar/Half.html +396 -0
  14. data/doc/TimeBoss/Calendar/Month.html +396 -0
  15. data/doc/TimeBoss/Calendar/Parser.html +386 -0
  16. data/doc/TimeBoss/Calendar/Period.html +841 -0
  17. data/doc/TimeBoss/Calendar/Quarter.html +396 -0
  18. data/doc/TimeBoss/Calendar/Support.html +131 -0
  19. data/doc/TimeBoss/Calendar/Support/Formatter.html +459 -0
  20. data/doc/TimeBoss/Calendar/Support/MonthBased.html +591 -0
  21. data/doc/TimeBoss/Calendar/Support/MonthBasis.html +437 -0
  22. data/doc/TimeBoss/Calendar/Support/MonthlyUnit.html +591 -0
  23. data/doc/TimeBoss/Calendar/Support/Navigable.html +723 -0
  24. data/doc/TimeBoss/Calendar/Support/Shiftable.html +138 -0
  25. data/doc/TimeBoss/Calendar/Support/Unit.html +1299 -0
  26. data/doc/TimeBoss/Calendar/Waypoints.html +155 -0
  27. data/doc/TimeBoss/Calendar/Waypoints/Absolute.html +1378 -0
  28. data/doc/TimeBoss/Calendar/Waypoints/Relative.html +4308 -0
  29. data/doc/TimeBoss/Calendar/Week.html +671 -0
  30. data/doc/TimeBoss/Calendar/Year.html +319 -0
  31. data/doc/TimeBoss/Calendars.html +336 -0
  32. data/doc/TimeBoss/Calendars/Broadcast.html +221 -0
  33. data/doc/TimeBoss/Calendars/Broadcast/Basis.html +278 -0
  34. data/doc/TimeBoss/Calendars/Entry.html +399 -0
  35. data/doc/TimeBoss/Support.html +115 -0
  36. data/doc/TimeBoss/Support/Shellable.html +249 -0
  37. data/doc/_index.html +416 -0
  38. data/doc/class_list.html +51 -0
  39. data/doc/css/common.css +1 -0
  40. data/doc/css/full_list.css +58 -0
  41. data/doc/css/style.css +496 -0
  42. data/doc/file.README.html +299 -0
  43. data/doc/file_list.html +56 -0
  44. data/doc/frames.html +17 -0
  45. data/doc/index.html +299 -0
  46. data/doc/js/app.js +314 -0
  47. data/doc/js/full_list.js +216 -0
  48. data/doc/js/jquery.js +4 -0
  49. data/doc/method_list.html +1139 -0
  50. data/doc/top-level-namespace.html +110 -0
  51. data/lib/tasks/calendars.rake +5 -0
  52. data/lib/timeboss.rb +4 -0
  53. data/lib/timeboss/calendar.rb +22 -0
  54. data/lib/timeboss/calendar/day.rb +19 -6
  55. data/lib/timeboss/calendar/half.rb +7 -2
  56. data/lib/timeboss/calendar/month.rb +7 -2
  57. data/lib/timeboss/calendar/parser.rb +1 -0
  58. data/lib/timeboss/calendar/period.rb +26 -11
  59. data/lib/timeboss/calendar/quarter.rb +7 -2
  60. data/lib/timeboss/calendar/support.rb +8 -0
  61. data/lib/timeboss/calendar/support/formatter.rb +1 -0
  62. data/lib/timeboss/calendar/support/month_basis.rb +3 -0
  63. data/lib/timeboss/calendar/support/{month_based.rb → monthly_unit.rb} +24 -18
  64. data/lib/timeboss/calendar/support/navigable.rb +73 -0
  65. data/lib/timeboss/calendar/support/shiftable.rb +3 -2
  66. data/lib/timeboss/calendar/support/unit.rb +26 -0
  67. data/lib/timeboss/calendar/waypoints.rb +6 -80
  68. data/lib/timeboss/calendar/waypoints/absolute.rb +114 -0
  69. data/lib/timeboss/calendar/waypoints/relative.rb +268 -0
  70. data/lib/timeboss/calendar/week.rb +26 -18
  71. data/lib/timeboss/calendar/year.rb +6 -5
  72. data/lib/timeboss/calendars.rb +20 -3
  73. data/lib/timeboss/version.rb +1 -1
  74. data/spec/calendar/day_spec.rb +1 -1
  75. data/spec/calendar/support/{month_based_spec.rb → monthly_unit_spec.rb} +18 -8
  76. data/spec/calendar/week_spec.rb +5 -13
  77. data/spec/calendars/broadcast_spec.rb +27 -7
  78. data/spec/calendars_spec.rb +7 -1
  79. data/timeboss.gemspec +1 -0
  80. metadata +77 -8
data/doc/TimeBoss/Calendar/Waypoints.html ADDED
@@ -0,0 +1,155 @@
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
+ Module: TimeBoss::Calendar::Waypoints
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::Waypoints";
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 (W)</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">Waypoints</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>Module: TimeBoss::Calendar::Waypoints
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+ <dl>
75
+ <dt>Includes:</dt>
76
+ <dd><span class='object_link'><a href="Waypoints/Absolute.html" title="TimeBoss::Calendar::Waypoints::Absolute (module)">Absolute</a></span>, <span class='object_link'><a href="Waypoints/Relative.html" title="TimeBoss::Calendar::Waypoints::Relative (module)">Relative</a></span></dd>
77
+ </dl>
78
+
79
+
80
+
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/timeboss/calendar/waypoints.rb<span class="defines">,<br />
87
+ lib/timeboss/calendar/waypoints/absolute.rb,<br /> lib/timeboss/calendar/waypoints/relative.rb</span>
88
+ </dd>
89
+ </dl>
90
+
91
+ </div>
92
+
93
+ <h2>Overview</h2><div class="docstring">
94
+ <div class="discussion">
95
+
96
+ <p>Provides implementations for known periods within a calendar.</p>
97
+
98
+
99
+ </div>
100
+ </div>
101
+ <div class="tags">
102
+
103
+
104
+ </div><h2>Defined Under Namespace</h2>
105
+ <p class="children">
106
+
107
+
108
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Waypoints/Absolute.html" title="TimeBoss::Calendar::Waypoints::Absolute (module)">Absolute</a></span>, <span class='object_link'><a href="Waypoints/Relative.html" title="TimeBoss::Calendar::Waypoints::Relative (module)">Relative</a></span>
109
+
110
+
111
+
112
+
113
+ </p>
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+ <h2>Method Summary</h2>
129
+
130
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Waypoints/Relative.html" title="TimeBoss::Calendar::Waypoints::Relative (module)">Relative</a></span></h3>
131
+ <p class="inherited"><span class='object_link'><a href="Waypoints/Relative.html#days_ago-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#days_ago (method)">#days_ago</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#days_ahead-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#days_ahead (method)">#days_ahead</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#days_back-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#days_back (method)">#days_back</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#days_for-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#days_for (method)">#days_for</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#days_forward-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#days_forward (method)">#days_forward</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#halves_ago-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#halves_ago (method)">#halves_ago</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#halves_ahead-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#halves_ahead (method)">#halves_ahead</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#halves_back-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#halves_back (method)">#halves_back</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#halves_for-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#halves_for (method)">#halves_for</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#halves_forward-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#halves_forward (method)">#halves_forward</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#last_day-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#last_day (method)">#last_day</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#last_half-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#last_half (method)">#last_half</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#last_month-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#last_month (method)">#last_month</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#last_quarter-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#last_quarter (method)">#last_quarter</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#last_week-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#last_week (method)">#last_week</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#last_year-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#last_year (method)">#last_year</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#months_ago-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#months_ago (method)">#months_ago</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#months_ahead-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#months_ahead (method)">#months_ahead</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#months_back-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#months_back (method)">#months_back</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#months_for-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#months_for (method)">#months_for</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#months_forward-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#months_forward (method)">#months_forward</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#next_day-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#next_day (method)">#next_day</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#next_half-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#next_half (method)">#next_half</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#next_month-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#next_month (method)">#next_month</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#next_quarter-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#next_quarter (method)">#next_quarter</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#next_week-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#next_week (method)">#next_week</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#next_year-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#next_year (method)">#next_year</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#quarters_ago-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#quarters_ago (method)">#quarters_ago</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#quarters_ahead-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#quarters_ahead (method)">#quarters_ahead</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#quarters_back-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#quarters_back (method)">#quarters_back</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#quarters_for-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#quarters_for (method)">#quarters_for</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#quarters_forward-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#quarters_forward (method)">#quarters_forward</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#this_day-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#this_day (method)">#this_day</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#this_half-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#this_half (method)">#this_half</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#this_month-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#this_month (method)">#this_month</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#this_quarter-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#this_quarter (method)">#this_quarter</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#this_week-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#this_week (method)">#this_week</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#this_year-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#this_year (method)">#this_year</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#weeks_ago-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#weeks_ago (method)">#weeks_ago</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#weeks_ahead-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#weeks_ahead (method)">#weeks_ahead</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#weeks_back-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#weeks_back (method)">#weeks_back</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#weeks_for-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#weeks_for (method)">#weeks_for</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#weeks_forward-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#weeks_forward (method)">#weeks_forward</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#years_ago-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#years_ago (method)">#years_ago</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#years_ahead-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#years_ahead (method)">#years_ahead</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#years_back-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#years_back (method)">#years_back</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#years_for-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#years_for (method)">#years_for</a></span>, <span class='object_link'><a href="Waypoints/Relative.html#years_forward-instance_method" title="TimeBoss::Calendar::Waypoints::Relative#years_forward (method)">#years_forward</a></span></p>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Waypoints/Absolute.html" title="TimeBoss::Calendar::Waypoints::Absolute (module)">Absolute</a></span></h3>
142
+ <p class="inherited"><span class='object_link'><a href="Waypoints/Absolute.html#day-instance_method" title="TimeBoss::Calendar::Waypoints::Absolute#day (method)">#day</a></span>, <span class='object_link'><a href="Waypoints/Absolute.html#day_for-instance_method" title="TimeBoss::Calendar::Waypoints::Absolute#day_for (method)">#day_for</a></span>, <span class='object_link'><a href="Waypoints/Absolute.html#half-instance_method" title="TimeBoss::Calendar::Waypoints::Absolute#half (method)">#half</a></span>, <span class='object_link'><a href="Waypoints/Absolute.html#half_for-instance_method" title="TimeBoss::Calendar::Waypoints::Absolute#half_for (method)">#half_for</a></span>, <span class='object_link'><a href="Waypoints/Absolute.html#month-instance_method" title="TimeBoss::Calendar::Waypoints::Absolute#month (method)">#month</a></span>, <span class='object_link'><a href="Waypoints/Absolute.html#month_for-instance_method" title="TimeBoss::Calendar::Waypoints::Absolute#month_for (method)">#month_for</a></span>, <span class='object_link'><a href="Waypoints/Absolute.html#quarter-instance_method" title="TimeBoss::Calendar::Waypoints::Absolute#quarter (method)">#quarter</a></span>, <span class='object_link'><a href="Waypoints/Absolute.html#quarter_for-instance_method" title="TimeBoss::Calendar::Waypoints::Absolute#quarter_for (method)">#quarter_for</a></span>, <span class='object_link'><a href="Waypoints/Absolute.html#week-instance_method" title="TimeBoss::Calendar::Waypoints::Absolute#week (method)">#week</a></span>, <span class='object_link'><a href="Waypoints/Absolute.html#week_for-instance_method" title="TimeBoss::Calendar::Waypoints::Absolute#week_for (method)">#week_for</a></span>, <span class='object_link'><a href="Waypoints/Absolute.html#year-instance_method" title="TimeBoss::Calendar::Waypoints::Absolute#year (method)">#year</a></span>, <span class='object_link'><a href="Waypoints/Absolute.html#year_for-instance_method" title="TimeBoss::Calendar::Waypoints::Absolute#year_for (method)">#year_for</a></span></p>
143
+
144
+
145
+ </div>
146
+
147
+ <div id="footer">
148
+ Generated on Sun Jul 19 10:12:10 2020 by
149
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
150
+ 0.9.25 (ruby-2.4.1).
151
+ </div>
152
+
153
+ </div>
154
+ </body>
155
+ </html>
data/doc/TimeBoss/Calendar/Waypoints/Absolute.html ADDED
@@ -0,0 +1,1378 @@
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
+ Module: TimeBoss::Calendar::Waypoints::Absolute
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::Waypoints::Absolute";
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)</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> &raquo; <span class='title'><span class='object_link'><a href="../Waypoints.html" title="TimeBoss::Calendar::Waypoints (module)">Waypoints</a></span></span>
41
+ &raquo;
42
+ <span class="title">Absolute</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>Module: TimeBoss::Calendar::Waypoints::Absolute
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+ <dl>
78
+ <dt>Included in:</dt>
79
+ <dd><span class='object_link'><a href="../Waypoints.html" title="TimeBoss::Calendar::Waypoints (module)">TimeBoss::Calendar::Waypoints</a></span></dd>
80
+ </dl>
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/timeboss/calendar/waypoints/absolute.rb</dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+ <h2>Overview</h2><div class="docstring">
92
+ <div class="discussion">
93
+
94
+ <p>Provides implementation for absolute periods within a calendar.</p>
95
+
96
+
97
+ </div>
98
+ </div>
99
+ <div class="tags">
100
+
101
+
102
+ </div>
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>
111
+ Instance Method Summary
112
+ <small><a href="#" class="summary_toggle">collapse</a></small>
113
+ </h2>
114
+
115
+ <ul class="summary">
116
+
117
+ <li class="public ">
118
+ <span class="summary_signature">
119
+
120
+ <a href="#day-instance_method" title="#day (instance method)">#<strong>day</strong>(year_index, index) &#x21d2; Calendar::Day </a>
121
+
122
+
123
+
124
+ </span>
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ <span class="summary_desc"><div class='inline'>
135
+ <p>Get the specified day by index within the specified year.</p>
136
+ </div></span>
137
+
138
+ </li>
139
+
140
+
141
+ <li class="public ">
142
+ <span class="summary_signature">
143
+
144
+ <a href="#day_for-instance_method" title="#day_for (instance method)">#<strong>day_for</strong>(date) &#x21d2; Calendar::Day </a>
145
+
146
+
147
+
148
+ </span>
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>Get the day that contains the specified date.</p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#half-instance_method" title="#half (instance method)">#<strong>half</strong> &#x21d2; Calendar::Half </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+ <span class="summary_desc"><div class='inline'>
183
+ <p>Get the specified half by index within the specified year.</p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ <li class="public ">
190
+ <span class="summary_signature">
191
+
192
+ <a href="#half_for-instance_method" title="#half_for (instance method)">#<strong>half_for</strong> &#x21d2; Calendar::Half </a>
193
+
194
+
195
+
196
+ </span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <span class="summary_desc"><div class='inline'>
207
+ <p>Get the half that contains the specified date.</p>
208
+ </div></span>
209
+
210
+ </li>
211
+
212
+
213
+ <li class="public ">
214
+ <span class="summary_signature">
215
+
216
+ <a href="#month-instance_method" title="#month (instance method)">#<strong>month</strong> &#x21d2; Calendar::Month </a>
217
+
218
+
219
+
220
+ </span>
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+ <span class="summary_desc"><div class='inline'>
231
+ <p>Get the specified month by index within the specified year.</p>
232
+ </div></span>
233
+
234
+ </li>
235
+
236
+
237
+ <li class="public ">
238
+ <span class="summary_signature">
239
+
240
+ <a href="#month_for-instance_method" title="#month_for (instance method)">#<strong>month_for</strong> &#x21d2; Calendar::Month </a>
241
+
242
+
243
+
244
+ </span>
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+ <span class="summary_desc"><div class='inline'>
255
+ <p>Get the month that contains the specified date.</p>
256
+ </div></span>
257
+
258
+ </li>
259
+
260
+
261
+ <li class="public ">
262
+ <span class="summary_signature">
263
+
264
+ <a href="#quarter-instance_method" title="#quarter (instance method)">#<strong>quarter</strong> &#x21d2; Calendar::Quarter </a>
265
+
266
+
267
+
268
+ </span>
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+ <span class="summary_desc"><div class='inline'>
279
+ <p>Get the specified quarter by index within the specified year.</p>
280
+ </div></span>
281
+
282
+ </li>
283
+
284
+
285
+ <li class="public ">
286
+ <span class="summary_signature">
287
+
288
+ <a href="#quarter_for-instance_method" title="#quarter_for (instance method)">#<strong>quarter_for</strong> &#x21d2; Calendar::Quarter </a>
289
+
290
+
291
+
292
+ </span>
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+ <span class="summary_desc"><div class='inline'>
303
+ <p>Get the quarter that contains the specified date.</p>
304
+ </div></span>
305
+
306
+ </li>
307
+
308
+
309
+ <li class="public ">
310
+ <span class="summary_signature">
311
+
312
+ <a href="#week-instance_method" title="#week (instance method)">#<strong>week</strong>(year_index, index) &#x21d2; Calendar::Week </a>
313
+
314
+
315
+
316
+ </span>
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+ <span class="summary_desc"><div class='inline'>
327
+ <p>Get the specified week by index within the specified year.</p>
328
+ </div></span>
329
+
330
+ </li>
331
+
332
+
333
+ <li class="public ">
334
+ <span class="summary_signature">
335
+
336
+ <a href="#week_for-instance_method" title="#week_for (instance method)">#<strong>week_for</strong>(date) &#x21d2; Calendar::Week </a>
337
+
338
+
339
+
340
+ </span>
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+
349
+
350
+ <span class="summary_desc"><div class='inline'>
351
+ <p>Get the week that contains the specified date.</p>
352
+ </div></span>
353
+
354
+ </li>
355
+
356
+
357
+ <li class="public ">
358
+ <span class="summary_signature">
359
+
360
+ <a href="#year-instance_method" title="#year (instance method)">#<strong>year</strong> &#x21d2; Calendar::Year </a>
361
+
362
+
363
+
364
+ </span>
365
+
366
+
367
+
368
+
369
+
370
+
371
+
372
+
373
+
374
+ <span class="summary_desc"><div class='inline'>
375
+ <p>Get the specified year by index within the specified year.</p>
376
+ </div></span>
377
+
378
+ </li>
379
+
380
+
381
+ <li class="public ">
382
+ <span class="summary_signature">
383
+
384
+ <a href="#year_for-instance_method" title="#year_for (instance method)">#<strong>year_for</strong> &#x21d2; Calendar::Year </a>
385
+
386
+
387
+
388
+ </span>
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+ <span class="summary_desc"><div class='inline'>
399
+ <p>Get the year that contains the specified date.</p>
400
+ </div></span>
401
+
402
+ </li>
403
+
404
+
405
+ </ul>
406
+
407
+
408
+
409
+
410
+ <div id="instance_method_details" class="method_details_list">
411
+ <h2>Instance Method Details</h2>
412
+
413
+
414
+ <div class="method_details first">
415
+ <h3 class="signature first" id="day-instance_method">
416
+
417
+ #<strong>day</strong>(year_index, index) &#x21d2; <tt><span class='object_link'><a href="../Day.html" title="TimeBoss::Calendar::Day (class)">Calendar::Day</a></span></tt>
418
+
419
+
420
+
421
+
422
+
423
+ </h3><div class="docstring">
424
+ <div class="discussion">
425
+
426
+ <p>Get the specified day by index within the specified year.</p>
427
+
428
+
429
+ </div>
430
+ </div>
431
+ <div class="tags">
432
+ <p class="tag_title">Parameters:</p>
433
+ <ul class="param">
434
+
435
+ <li>
436
+
437
+ <span class='name'>year_index</span>
438
+
439
+
440
+ <span class='type'>(<tt>Integer</tt>)</span>
441
+
442
+
443
+
444
+ &mdash;
445
+ <div class='inline'>
446
+ <p>the year to examine</p>
447
+ </div>
448
+
449
+ </li>
450
+
451
+ <li>
452
+
453
+ <span class='name'>index</span>
454
+
455
+
456
+ <span class='type'>(<tt>Integer</tt>)</span>
457
+
458
+
459
+
460
+ &mdash;
461
+ <div class='inline'>
462
+ <p>the index of the day within the year</p>
463
+ </div>
464
+
465
+ </li>
466
+
467
+ </ul>
468
+
469
+ <p class="tag_title">Returns:</p>
470
+ <ul class="return">
471
+
472
+ <li>
473
+
474
+
475
+ <span class='type'>(<tt><span class='object_link'><a href="../Day.html" title="TimeBoss::Calendar::Day (class)">Calendar::Day</a></span></tt>)</span>
476
+
477
+
478
+
479
+ </li>
480
+
481
+ </ul>
482
+
483
+ </div><table class="source_code">
484
+ <tr>
485
+ <td>
486
+ <pre class="lines">
487
+
488
+
489
+ 45
490
+ 46
491
+ 47</pre>
492
+ </td>
493
+ <td>
494
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/waypoints/absolute.rb', line 45</span>
495
+
496
+ <span class='kw'>def</span> <span class='id identifier rubyid_day'>day</span><span class='lparen'>(</span><span class='id identifier rubyid_year_index'>year_index</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span>
497
+ <span class='id identifier rubyid_year'>year</span><span class='lparen'>(</span><span class='id identifier rubyid_year_index'>year_index</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_days'>days</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span> <span class='op'>-</span> <span class='int'>1</span><span class='rbracket'>]</span>
498
+ <span class='kw'>end</span></pre>
499
+ </td>
500
+ </tr>
501
+ </table>
502
+ </div>
503
+
504
+ <div class="method_details ">
505
+ <h3 class="signature " id="day_for-instance_method">
506
+
507
+ #<strong>day_for</strong>(date) &#x21d2; <tt><span class='object_link'><a href="../Day.html" title="TimeBoss::Calendar::Day (class)">Calendar::Day</a></span></tt>
508
+
509
+
510
+
511
+
512
+
513
+ </h3><div class="docstring">
514
+ <div class="discussion">
515
+
516
+ <p>Get the day that contains the specified date.</p>
517
+
518
+
519
+ </div>
520
+ </div>
521
+ <div class="tags">
522
+ <p class="tag_title">Parameters:</p>
523
+ <ul class="param">
524
+
525
+ <li>
526
+
527
+ <span class='name'>date</span>
528
+
529
+
530
+ <span class='type'>(<tt>Date</tt>)</span>
531
+
532
+
533
+
534
+ &mdash;
535
+ <div class='inline'>
536
+ <p>the date for which to locate the calendar day</p>
537
+ </div>
538
+
539
+ </li>
540
+
541
+ </ul>
542
+
543
+ <p class="tag_title">Returns:</p>
544
+ <ul class="return">
545
+
546
+ <li>
547
+
548
+
549
+ <span class='type'>(<tt><span class='object_link'><a href="../Day.html" title="TimeBoss::Calendar::Day (class)">Calendar::Day</a></span></tt>)</span>
550
+
551
+
552
+
553
+ </li>
554
+
555
+ </ul>
556
+
557
+ </div><table class="source_code">
558
+ <tr>
559
+ <td>
560
+ <pre class="lines">
561
+
562
+
563
+ 52
564
+ 53
565
+ 54</pre>
566
+ </td>
567
+ <td>
568
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/waypoints/absolute.rb', line 52</span>
569
+
570
+ <span class='kw'>def</span> <span class='id identifier rubyid_day_for'>day_for</span><span class='lparen'>(</span><span class='id identifier rubyid_date'>date</span><span class='rparen'>)</span>
571
+ <span class='const'><span class='object_link'><a href="../Day.html" title="TimeBoss::Calendar::Day (class)">Day</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Day.html#initialize-instance_method" title="TimeBoss::Calendar::Day#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_date'>date</span><span class='rparen'>)</span>
572
+ <span class='kw'>end</span></pre>
573
+ </td>
574
+ </tr>
575
+ </table>
576
+ </div>
577
+
578
+ <div class="method_details ">
579
+ <h3 class="signature " id="half-instance_method">
580
+
581
+ #<strong>half</strong> &#x21d2; <tt><span class='object_link'><a href="../Half.html" title="TimeBoss::Calendar::Half (class)">Calendar::Half</a></span></tt>
582
+
583
+
584
+
585
+
586
+
587
+ </h3><div class="docstring">
588
+ <div class="discussion">
589
+
590
+ <p>Get the specified half by index within the specified year</p>
591
+
592
+
593
+ </div>
594
+ </div>
595
+ <div class="tags">
596
+ <p class="tag_title">Parameters:</p>
597
+ <ul class="param">
598
+
599
+ <li>
600
+
601
+ <span class='name'>year_index</span>
602
+
603
+
604
+ <span class='type'>(<tt>Integer</tt>)</span>
605
+
606
+
607
+
608
+ &mdash;
609
+ <div class='inline'>
610
+ <p>the year to examine</p>
611
+ </div>
612
+
613
+ </li>
614
+
615
+ <li>
616
+
617
+ <span class='name'>index</span>
618
+
619
+
620
+ <span class='type'>(<tt>Integer</tt>)</span>
621
+
622
+
623
+
624
+ &mdash;
625
+ <div class='inline'>
626
+ <p>the index of the half within the year</p>
627
+ </div>
628
+
629
+ </li>
630
+
631
+ </ul>
632
+
633
+ <p class="tag_title">Returns:</p>
634
+ <ul class="return">
635
+
636
+ <li>
637
+
638
+
639
+ <span class='type'>(<tt><span class='object_link'><a href="../Half.html" title="TimeBoss::Calendar::Half (class)">Calendar::Half</a></span></tt>)</span>
640
+
641
+
642
+
643
+ </li>
644
+
645
+ </ul>
646
+
647
+ </div><table class="source_code">
648
+ <tr>
649
+ <td>
650
+ <pre class="lines">
651
+
652
+
653
+ </pre>
654
+ </td>
655
+ <td>
656
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/waypoints/absolute.rb', line 88</span>
657
+
658
+ </pre>
659
+ </td>
660
+ </tr>
661
+ </table>
662
+ </div>
663
+
664
+ <div class="method_details ">
665
+ <h3 class="signature " id="half_for-instance_method">
666
+
667
+ #<strong>half_for</strong> &#x21d2; <tt><span class='object_link'><a href="../Half.html" title="TimeBoss::Calendar::Half (class)">Calendar::Half</a></span></tt>
668
+
669
+
670
+
671
+
672
+
673
+ </h3><div class="docstring">
674
+ <div class="discussion">
675
+
676
+ <p>Get the half that contains the specified date.</p>
677
+
678
+
679
+ </div>
680
+ </div>
681
+ <div class="tags">
682
+ <p class="tag_title">Parameters:</p>
683
+ <ul class="param">
684
+
685
+ <li>
686
+
687
+ <span class='name'>date</span>
688
+
689
+
690
+ <span class='type'>(<tt>Date</tt>)</span>
691
+
692
+
693
+
694
+ &mdash;
695
+ <div class='inline'>
696
+ <p>the date for which to locate the calendar half</p>
697
+ </div>
698
+
699
+ </li>
700
+
701
+ </ul>
702
+
703
+ <p class="tag_title">Returns:</p>
704
+ <ul class="return">
705
+
706
+ <li>
707
+
708
+
709
+ <span class='type'>(<tt><span class='object_link'><a href="../Half.html" title="TimeBoss::Calendar::Half (class)">Calendar::Half</a></span></tt>)</span>
710
+
711
+
712
+
713
+ </li>
714
+
715
+ </ul>
716
+
717
+ </div><table class="source_code">
718
+ <tr>
719
+ <td>
720
+ <pre class="lines">
721
+
722
+
723
+ </pre>
724
+ </td>
725
+ <td>
726
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/waypoints/absolute.rb', line 94</span>
727
+
728
+ </pre>
729
+ </td>
730
+ </tr>
731
+ </table>
732
+ </div>
733
+
734
+ <div class="method_details ">
735
+ <h3 class="signature " id="month-instance_method">
736
+
737
+ #<strong>month</strong> &#x21d2; <tt><span class='object_link'><a href="../Month.html" title="TimeBoss::Calendar::Month (class)">Calendar::Month</a></span></tt>
738
+
739
+
740
+
741
+
742
+
743
+ </h3><div class="docstring">
744
+ <div class="discussion">
745
+
746
+ <p>Get the specified month by index within the specified year</p>
747
+
748
+
749
+ </div>
750
+ </div>
751
+ <div class="tags">
752
+ <p class="tag_title">Parameters:</p>
753
+ <ul class="param">
754
+
755
+ <li>
756
+
757
+ <span class='name'>year_index</span>
758
+
759
+
760
+ <span class='type'>(<tt>Integer</tt>)</span>
761
+
762
+
763
+
764
+ &mdash;
765
+ <div class='inline'>
766
+ <p>the year to examine</p>
767
+ </div>
768
+
769
+ </li>
770
+
771
+ <li>
772
+
773
+ <span class='name'>index</span>
774
+
775
+
776
+ <span class='type'>(<tt>Integer</tt>)</span>
777
+
778
+
779
+
780
+ &mdash;
781
+ <div class='inline'>
782
+ <p>the index of the month within the year</p>
783
+ </div>
784
+
785
+ </li>
786
+
787
+ </ul>
788
+
789
+ <p class="tag_title">Returns:</p>
790
+ <ul class="return">
791
+
792
+ <li>
793
+
794
+
795
+ <span class='type'>(<tt><span class='object_link'><a href="../Month.html" title="TimeBoss::Calendar::Month (class)">Calendar::Month</a></span></tt>)</span>
796
+
797
+
798
+
799
+ </li>
800
+
801
+ </ul>
802
+
803
+ </div><table class="source_code">
804
+ <tr>
805
+ <td>
806
+ <pre class="lines">
807
+
808
+
809
+ </pre>
810
+ </td>
811
+ <td>
812
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/waypoints/absolute.rb', line 62</span>
813
+
814
+ </pre>
815
+ </td>
816
+ </tr>
817
+ </table>
818
+ </div>
819
+
820
+ <div class="method_details ">
821
+ <h3 class="signature " id="month_for-instance_method">
822
+
823
+ #<strong>month_for</strong> &#x21d2; <tt><span class='object_link'><a href="../Month.html" title="TimeBoss::Calendar::Month (class)">Calendar::Month</a></span></tt>
824
+
825
+
826
+
827
+
828
+
829
+ </h3><div class="docstring">
830
+ <div class="discussion">
831
+
832
+ <p>Get the month that contains the specified date.</p>
833
+
834
+
835
+ </div>
836
+ </div>
837
+ <div class="tags">
838
+ <p class="tag_title">Parameters:</p>
839
+ <ul class="param">
840
+
841
+ <li>
842
+
843
+ <span class='name'>date</span>
844
+
845
+
846
+ <span class='type'>(<tt>Date</tt>)</span>
847
+
848
+
849
+
850
+ &mdash;
851
+ <div class='inline'>
852
+ <p>the date for which to locate the calendar month</p>
853
+ </div>
854
+
855
+ </li>
856
+
857
+ </ul>
858
+
859
+ <p class="tag_title">Returns:</p>
860
+ <ul class="return">
861
+
862
+ <li>
863
+
864
+
865
+ <span class='type'>(<tt><span class='object_link'><a href="../Month.html" title="TimeBoss::Calendar::Month (class)">Calendar::Month</a></span></tt>)</span>
866
+
867
+
868
+
869
+ </li>
870
+
871
+ </ul>
872
+
873
+ </div><table class="source_code">
874
+ <tr>
875
+ <td>
876
+ <pre class="lines">
877
+
878
+
879
+ </pre>
880
+ </td>
881
+ <td>
882
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/waypoints/absolute.rb', line 68</span>
883
+
884
+ </pre>
885
+ </td>
886
+ </tr>
887
+ </table>
888
+ </div>
889
+
890
+ <div class="method_details ">
891
+ <h3 class="signature " id="quarter-instance_method">
892
+
893
+ #<strong>quarter</strong> &#x21d2; <tt><span class='object_link'><a href="../Quarter.html" title="TimeBoss::Calendar::Quarter (class)">Calendar::Quarter</a></span></tt>
894
+
895
+
896
+
897
+
898
+
899
+ </h3><div class="docstring">
900
+ <div class="discussion">
901
+
902
+ <p>Get the specified quarter by index within the specified year</p>
903
+
904
+
905
+ </div>
906
+ </div>
907
+ <div class="tags">
908
+ <p class="tag_title">Parameters:</p>
909
+ <ul class="param">
910
+
911
+ <li>
912
+
913
+ <span class='name'>year_index</span>
914
+
915
+
916
+ <span class='type'>(<tt>Integer</tt>)</span>
917
+
918
+
919
+
920
+ &mdash;
921
+ <div class='inline'>
922
+ <p>the year to examine</p>
923
+ </div>
924
+
925
+ </li>
926
+
927
+ <li>
928
+
929
+ <span class='name'>index</span>
930
+
931
+
932
+ <span class='type'>(<tt>Integer</tt>)</span>
933
+
934
+
935
+
936
+ &mdash;
937
+ <div class='inline'>
938
+ <p>the index of the quarter within the year</p>
939
+ </div>
940
+
941
+ </li>
942
+
943
+ </ul>
944
+
945
+ <p class="tag_title">Returns:</p>
946
+ <ul class="return">
947
+
948
+ <li>
949
+
950
+
951
+ <span class='type'>(<tt><span class='object_link'><a href="../Quarter.html" title="TimeBoss::Calendar::Quarter (class)">Calendar::Quarter</a></span></tt>)</span>
952
+
953
+
954
+
955
+ </li>
956
+
957
+ </ul>
958
+
959
+ </div><table class="source_code">
960
+ <tr>
961
+ <td>
962
+ <pre class="lines">
963
+
964
+
965
+ </pre>
966
+ </td>
967
+ <td>
968
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/waypoints/absolute.rb', line 75</span>
969
+
970
+ </pre>
971
+ </td>
972
+ </tr>
973
+ </table>
974
+ </div>
975
+
976
+ <div class="method_details ">
977
+ <h3 class="signature " id="quarter_for-instance_method">
978
+
979
+ #<strong>quarter_for</strong> &#x21d2; <tt><span class='object_link'><a href="../Quarter.html" title="TimeBoss::Calendar::Quarter (class)">Calendar::Quarter</a></span></tt>
980
+
981
+
982
+
983
+
984
+
985
+ </h3><div class="docstring">
986
+ <div class="discussion">
987
+
988
+ <p>Get the quarter that contains the specified date.</p>
989
+
990
+
991
+ </div>
992
+ </div>
993
+ <div class="tags">
994
+ <p class="tag_title">Parameters:</p>
995
+ <ul class="param">
996
+
997
+ <li>
998
+
999
+ <span class='name'>date</span>
1000
+
1001
+
1002
+ <span class='type'>(<tt>Date</tt>)</span>
1003
+
1004
+
1005
+
1006
+ &mdash;
1007
+ <div class='inline'>
1008
+ <p>the date for which to locate the calendar quarter</p>
1009
+ </div>
1010
+
1011
+ </li>
1012
+
1013
+ </ul>
1014
+
1015
+ <p class="tag_title">Returns:</p>
1016
+ <ul class="return">
1017
+
1018
+ <li>
1019
+
1020
+
1021
+ <span class='type'>(<tt><span class='object_link'><a href="../Quarter.html" title="TimeBoss::Calendar::Quarter (class)">Calendar::Quarter</a></span></tt>)</span>
1022
+
1023
+
1024
+
1025
+ </li>
1026
+
1027
+ </ul>
1028
+
1029
+ </div><table class="source_code">
1030
+ <tr>
1031
+ <td>
1032
+ <pre class="lines">
1033
+
1034
+
1035
+ </pre>
1036
+ </td>
1037
+ <td>
1038
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/waypoints/absolute.rb', line 81</span>
1039
+
1040
+ </pre>
1041
+ </td>
1042
+ </tr>
1043
+ </table>
1044
+ </div>
1045
+
1046
+ <div class="method_details ">
1047
+ <h3 class="signature " id="week-instance_method">
1048
+
1049
+ #<strong>week</strong>(year_index, index) &#x21d2; <tt><span class='object_link'><a href="../Week.html" title="TimeBoss::Calendar::Week (class)">Calendar::Week</a></span></tt>
1050
+
1051
+
1052
+
1053
+
1054
+
1055
+ </h3><div class="docstring">
1056
+ <div class="discussion">
1057
+
1058
+ <p>Get the specified week by index within the specified year.</p>
1059
+
1060
+
1061
+ </div>
1062
+ </div>
1063
+ <div class="tags">
1064
+ <p class="tag_title">Parameters:</p>
1065
+ <ul class="param">
1066
+
1067
+ <li>
1068
+
1069
+ <span class='name'>year_index</span>
1070
+
1071
+
1072
+ <span class='type'>(<tt>Integer</tt>)</span>
1073
+
1074
+
1075
+
1076
+ &mdash;
1077
+ <div class='inline'>
1078
+ <p>the year to examine</p>
1079
+ </div>
1080
+
1081
+ </li>
1082
+
1083
+ <li>
1084
+
1085
+ <span class='name'>index</span>
1086
+
1087
+
1088
+ <span class='type'>(<tt>Integer</tt>)</span>
1089
+
1090
+
1091
+
1092
+ &mdash;
1093
+ <div class='inline'>
1094
+ <p>the index of the week within the year</p>
1095
+ </div>
1096
+
1097
+ </li>
1098
+
1099
+ </ul>
1100
+
1101
+ <p class="tag_title">Returns:</p>
1102
+ <ul class="return">
1103
+
1104
+ <li>
1105
+
1106
+
1107
+ <span class='type'>(<tt><span class='object_link'><a href="../Week.html" title="TimeBoss::Calendar::Week (class)">Calendar::Week</a></span></tt>)</span>
1108
+
1109
+
1110
+
1111
+ </li>
1112
+
1113
+ </ul>
1114
+
1115
+ </div><table class="source_code">
1116
+ <tr>
1117
+ <td>
1118
+ <pre class="lines">
1119
+
1120
+
1121
+ 30
1122
+ 31
1123
+ 32</pre>
1124
+ </td>
1125
+ <td>
1126
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/waypoints/absolute.rb', line 30</span>
1127
+
1128
+ <span class='kw'>def</span> <span class='id identifier rubyid_week'>week</span><span class='lparen'>(</span><span class='id identifier rubyid_year_index'>year_index</span><span class='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='rparen'>)</span>
1129
+ <span class='id identifier rubyid_year'>year</span><span class='lparen'>(</span><span class='id identifier rubyid_year_index'>year_index</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_weeks'>weeks</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span> <span class='op'>-</span> <span class='int'>1</span><span class='rbracket'>]</span>
1130
+ <span class='kw'>end</span></pre>
1131
+ </td>
1132
+ </tr>
1133
+ </table>
1134
+ </div>
1135
+
1136
+ <div class="method_details ">
1137
+ <h3 class="signature " id="week_for-instance_method">
1138
+
1139
+ #<strong>week_for</strong>(date) &#x21d2; <tt><span class='object_link'><a href="../Week.html" title="TimeBoss::Calendar::Week (class)">Calendar::Week</a></span></tt>
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+ </h3><div class="docstring">
1146
+ <div class="discussion">
1147
+
1148
+ <p>Get the week that contains the specified date.</p>
1149
+
1150
+
1151
+ </div>
1152
+ </div>
1153
+ <div class="tags">
1154
+ <p class="tag_title">Parameters:</p>
1155
+ <ul class="param">
1156
+
1157
+ <li>
1158
+
1159
+ <span class='name'>date</span>
1160
+
1161
+
1162
+ <span class='type'>(<tt>Date</tt>)</span>
1163
+
1164
+
1165
+
1166
+ &mdash;
1167
+ <div class='inline'>
1168
+ <p>the date for which to locate the calendar week</p>
1169
+ </div>
1170
+
1171
+ </li>
1172
+
1173
+ </ul>
1174
+
1175
+ <p class="tag_title">Returns:</p>
1176
+ <ul class="return">
1177
+
1178
+ <li>
1179
+
1180
+
1181
+ <span class='type'>(<tt><span class='object_link'><a href="../Week.html" title="TimeBoss::Calendar::Week (class)">Calendar::Week</a></span></tt>)</span>
1182
+
1183
+
1184
+
1185
+ </li>
1186
+
1187
+ </ul>
1188
+
1189
+ </div><table class="source_code">
1190
+ <tr>
1191
+ <td>
1192
+ <pre class="lines">
1193
+
1194
+
1195
+ 37
1196
+ 38
1197
+ 39</pre>
1198
+ </td>
1199
+ <td>
1200
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/waypoints/absolute.rb', line 37</span>
1201
+
1202
+ <span class='kw'>def</span> <span class='id identifier rubyid_week_for'>week_for</span><span class='lparen'>(</span><span class='id identifier rubyid_date'>date</span><span class='rparen'>)</span>
1203
+ <span class='id identifier rubyid_year_for'>year_for</span><span class='lparen'>(</span><span class='id identifier rubyid_date'>date</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_weeks'>weeks</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_w'>w</span><span class='op'>|</span> <span class='id identifier rubyid_w'>w</span><span class='period'>.</span><span class='id identifier rubyid_to_range'>to_range</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_date'>date</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
1204
+ <span class='kw'>end</span></pre>
1205
+ </td>
1206
+ </tr>
1207
+ </table>
1208
+ </div>
1209
+
1210
+ <div class="method_details ">
1211
+ <h3 class="signature " id="year-instance_method">
1212
+
1213
+ #<strong>year</strong> &#x21d2; <tt><span class='object_link'><a href="../Year.html" title="TimeBoss::Calendar::Year (class)">Calendar::Year</a></span></tt>
1214
+
1215
+
1216
+
1217
+
1218
+
1219
+ </h3><div class="docstring">
1220
+ <div class="discussion">
1221
+
1222
+ <p>Get the specified year by index within the specified year</p>
1223
+
1224
+
1225
+ </div>
1226
+ </div>
1227
+ <div class="tags">
1228
+ <p class="tag_title">Parameters:</p>
1229
+ <ul class="param">
1230
+
1231
+ <li>
1232
+
1233
+ <span class='name'>year_index</span>
1234
+
1235
+
1236
+ <span class='type'>(<tt>Integer</tt>)</span>
1237
+
1238
+
1239
+
1240
+ &mdash;
1241
+ <div class='inline'>
1242
+ <p>the year to examine</p>
1243
+ </div>
1244
+
1245
+ </li>
1246
+
1247
+ <li>
1248
+
1249
+ <span class='name'>index</span>
1250
+
1251
+
1252
+ <span class='type'>(<tt>Integer</tt>)</span>
1253
+
1254
+
1255
+
1256
+ &mdash;
1257
+ <div class='inline'>
1258
+ <p>the index of the year within the year</p>
1259
+ </div>
1260
+
1261
+ </li>
1262
+
1263
+ </ul>
1264
+
1265
+ <p class="tag_title">Returns:</p>
1266
+ <ul class="return">
1267
+
1268
+ <li>
1269
+
1270
+
1271
+ <span class='type'>(<tt><span class='object_link'><a href="../Year.html" title="TimeBoss::Calendar::Year (class)">Calendar::Year</a></span></tt>)</span>
1272
+
1273
+
1274
+
1275
+ </li>
1276
+
1277
+ </ul>
1278
+
1279
+ </div><table class="source_code">
1280
+ <tr>
1281
+ <td>
1282
+ <pre class="lines">
1283
+
1284
+
1285
+ </pre>
1286
+ </td>
1287
+ <td>
1288
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/waypoints/absolute.rb', line 101</span>
1289
+
1290
+ </pre>
1291
+ </td>
1292
+ </tr>
1293
+ </table>
1294
+ </div>
1295
+
1296
+ <div class="method_details ">
1297
+ <h3 class="signature " id="year_for-instance_method">
1298
+
1299
+ #<strong>year_for</strong> &#x21d2; <tt><span class='object_link'><a href="../Year.html" title="TimeBoss::Calendar::Year (class)">Calendar::Year</a></span></tt>
1300
+
1301
+
1302
+
1303
+
1304
+
1305
+ </h3><div class="docstring">
1306
+ <div class="discussion">
1307
+
1308
+ <p>Get the year that contains the specified date.</p>
1309
+
1310
+
1311
+ </div>
1312
+ </div>
1313
+ <div class="tags">
1314
+ <p class="tag_title">Parameters:</p>
1315
+ <ul class="param">
1316
+
1317
+ <li>
1318
+
1319
+ <span class='name'>date</span>
1320
+
1321
+
1322
+ <span class='type'>(<tt>Date</tt>)</span>
1323
+
1324
+
1325
+
1326
+ &mdash;
1327
+ <div class='inline'>
1328
+ <p>the date for which to locate the calendar year</p>
1329
+ </div>
1330
+
1331
+ </li>
1332
+
1333
+ </ul>
1334
+
1335
+ <p class="tag_title">Returns:</p>
1336
+ <ul class="return">
1337
+
1338
+ <li>
1339
+
1340
+
1341
+ <span class='type'>(<tt><span class='object_link'><a href="../Year.html" title="TimeBoss::Calendar::Year (class)">Calendar::Year</a></span></tt>)</span>
1342
+
1343
+
1344
+
1345
+ </li>
1346
+
1347
+ </ul>
1348
+
1349
+ </div><table class="source_code">
1350
+ <tr>
1351
+ <td>
1352
+ <pre class="lines">
1353
+
1354
+
1355
+ </pre>
1356
+ </td>
1357
+ <td>
1358
+ <pre class="code"><span class="info file"># File 'lib/timeboss/calendar/waypoints/absolute.rb', line 107</span>
1359
+
1360
+ </pre>
1361
+ </td>
1362
+ </tr>
1363
+ </table>
1364
+ </div>
1365
+
1366
+ </div>
1367
+
1368
+ </div>
1369
+
1370
+ <div id="footer">
1371
+ Generated on Sun Jul 19 10:12:11 2020 by
1372
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1373
+ 0.9.25 (ruby-2.4.1).
1374
+ </div>
1375
+
1376
+ </div>
1377
+ </body>
1378
+ </html>