diff --git a/doc/Time.html b/doc/Time.html new file mode 100644 index 0000000..ee465f5 --- /dev/null +++ b/doc/Time.html @@ -0,0 +1,2277 @@ + + + + +Class: Time + + + + + + + + + + + + + + + +

Class: Time + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
  • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
lib/time_ext/time.rb
+ +
+
+ + + + + +

+ Instance Method Summary + (collapse) +

+ + + + + + +
+

Instance Method Details

+ + +
+

+ + - (Object) beginning_of_hour + + + + Also known as: + at_beginning_of_hour + + +

+
+

+Returns a new Time representing the start of the hour (XX:00:00). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+181
+182
+183
+
+
# File 'lib/time_ext/time.rb', line 181
+
+def beginning_of_hour
+  change(:min => 0, :sec => 0, :usec => 0)
+end
+
+
+
+ +
+

+ + - (Object) beginning_of_minute + + + + Also known as: + at_beginning_of_min, beginning_of_min, at_beginning_of_minute + + +

+
+

+Returns a new Time representing the start of the minute (XX:XX:00). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+167
+168
+169
+
+
# File 'lib/time_ext/time.rb', line 167
+
+def beginning_of_minute
+  change(:sec => 0, :usec => 0)
+end
+
+
+
+ +
+

+ + - (Object) beginning_of_second + + + + Also known as: + at_beginning_of_sec, beginning_of_sec, at_beginning_of_second + + +

+
+

+Returns a new Time representing the start of the second, XX:XX:XX.000000 +(.000000000 in ruby1.9). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+153
+154
+155
+
+
# File 'lib/time_ext/time.rb', line 153
+
+def beginning_of_second
+  change(:usec => 0)
+end
+
+
+
+ +
+

+ + - (Object) ceil(unit = :sec) + + + + Also known as: + beginning_of_next, at_beginning_of_next + + +

+
+

+Returns a new Time representing the start of the next unit specified +(second by default). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+21
+22
+23
+
+
# File 'lib/time_ext/time.rb', line 21
+
+def ceil(unit = :sec)
+  self.send("next_#{unit}").send("beginning_of_#{unit}")
+end
+
+
+
+ +
+

+ + - (Object) common_year_days_in_month + + + +

+
+

+Helper method for backwards compatibility with ActiveSupport. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+9
+10
+11
+
+
# File 'lib/time_ext/time.rb', line 9
+
+def common_year_days_in_month
+  defined?(COMMON_YEAR_DAYS_IN_MONTH) ? COMMON_YEAR_DAYS_IN_MONTH : [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+end
+
+
+
+ +
+

+ + - (Object) days_ago(days) + + + +

+
+

+Returns a new Time representing the time a number of specified days ago. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+123
+124
+125
+
+
# File 'lib/time_ext/time.rb', line 123
+
+def days_ago(days)
+  ago(days.days)
+end
+
+
+
+ +
+

+ + - (Object) days_into_week + + + +

+
+

+Helper method for backwards compatibility with ActiveSupport. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+4
+5
+6
+
+
# File 'lib/time_ext/time.rb', line 4
+
+def days_into_week
+  defined?(DAYS_INTO_WEEK) ? DAYS_INTO_WEEK : { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6 }
+end
+
+
+
+ +
+

+ + - (Object) days_since(days) + + + +

+
+

+Returns a new Time representing the time a number of specified days in the +future. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+128
+129
+130
+
+
# File 'lib/time_ext/time.rb', line 128
+
+def days_since(days)
+  since(days.days)
+end
+
+
+
+ +
+

+ + - (Object) end_of_hour + + + +

+
+

+Returns a new Time representing the end of the hour, XX:59:59.999999 +(.999999999 in ruby1.9). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+187
+188
+189
+
+
# File 'lib/time_ext/time.rb', line 187
+
+def end_of_hour
+  change(:min => 59, :sec => 59, :usec => 999999.999)
+end
+
+
+
+ +
+

+ + - (Object) end_of_minute + + + + Also known as: + end_of_min + + +

+
+

+Returns a new Time representing the end of the hour, XX:XX:59.999999 +(.999999999 in ruby1.9). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+175
+176
+177
+
+
# File 'lib/time_ext/time.rb', line 175
+
+def end_of_minute
+  change(:sec => 59, :usec => 999999.999)
+end
+
+
+
+ +
+

+ + - (Object) end_of_second + + + + Also known as: + end_of_sec + + +

+
+

+Returns a new Time representing the end of the hour, XX:XX:XX.999999 +(.999999999 in ruby1.9). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+161
+162
+163
+
+
# File 'lib/time_ext/time.rb', line 161
+
+def end_of_second
+  change(:usec => 999999.999)
+end
+
+
+
+ +
+

+ + - (Object) floor(unit = :sec) + + + + Also known as: + at_beginning_of, beginning_of + + +

+
+

+Returns a new Time representing the start of the unit specified (second by +default). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+14
+15
+16
+
+
# File 'lib/time_ext/time.rb', line 14
+
+def floor(unit = :sec)
+  self.send("beginning_of_#{unit}")
+end
+
+
+
+ +
+

+ + - (Object) hours_ago(hours) + + + +

+
+

+Returns a new Time representing the time a number of specified hours ago. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+113
+114
+115
+
+
# File 'lib/time_ext/time.rb', line 113
+
+def hours_ago(hours)
+  ago(hours.hours)
+end
+
+
+
+ +
+

+ + - (Object) hours_since(hours) + + + +

+
+

+Returns a new Time representing the time a number of specified hours in the +future. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+118
+119
+120
+
+
# File 'lib/time_ext/time.rb', line 118
+
+def hours_since(hours)
+  since(hours.hours)
+end
+
+
+
+ +
+

+ + - (Object) minutes_ago(minutes) + + + + Also known as: + mins_ago + + +

+
+

+Returns a new Time representing the time a number of specified minutes ago. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+101
+102
+103
+
+
# File 'lib/time_ext/time.rb', line 101
+
+def minutes_ago(minutes)
+  ago(minutes.minutes)
+end
+
+
+
+ +
+

+ + - (Object) minutes_since(minutes) + + + + Also known as: + mins_since + + +

+
+

+Returns a new Time representing the time a number of specified minutes in +the future. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+107
+108
+109
+
+
# File 'lib/time_ext/time.rb', line 107
+
+def minutes_since(minutes)
+  since(minutes.minutes)
+end
+
+
+
+ +
+

+ + - (Object) next_day + + + +

+
+

+Short-hand for days_since(1). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+75
+76
+77
+
+
# File 'lib/time_ext/time.rb', line 75
+
+def next_day
+  days_since(1)
+end
+
+
+
+ +
+

+ + - (Object) next_hour + + + +

+
+

+Short-hand for hours_since(1). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+65
+66
+67
+
+
# File 'lib/time_ext/time.rb', line 65
+
+def next_hour
+  hours_since(1)
+end
+
+
+
+ +
+

+ + - (Object) next_minute + + + + Also known as: + next_min + + +

+
+

+Short-hand for minutes_since(1). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+54
+55
+56
+
+
# File 'lib/time_ext/time.rb', line 54
+
+def next_minute
+  minutes_since(1)
+end
+
+
+
+ +
+

+ + - (Object) next_quarter + + + +

+
+

+Short-hand for quarters_since(1).beginning_of_quarter. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+85
+86
+87
+
+
# File 'lib/time_ext/time.rb', line 85
+
+def next_quarter
+  quarters_since(1).beginning_of_quarter
+end
+
+
+
+ +
+

+ + - (Object) next_second + + + + Also known as: + next_sec + + +

+
+

+Short-hand for seconds_since(1). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+42
+43
+44
+
+
# File 'lib/time_ext/time.rb', line 42
+
+def next_second
+  since(1)
+end
+
+
+
+ +
+

+ + - (Object) prev_day + + + +

+
+

+Short-hand for days_ago(1). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+70
+71
+72
+
+
# File 'lib/time_ext/time.rb', line 70
+
+def prev_day
+  days_ago(1)
+end
+
+
+
+ +
+

+ + - (Object) prev_hour + + + +

+
+

+Short-hand for hours_ago(1). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+60
+61
+62
+
+
# File 'lib/time_ext/time.rb', line 60
+
+def prev_hour
+  hours_ago(1)
+end
+
+
+
+ +
+

+ + - (Object) prev_minute + + + + Also known as: + prev_min + + +

+
+

+Short-hand for minutes_ago(1). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+48
+49
+50
+
+
# File 'lib/time_ext/time.rb', line 48
+
+def prev_minute
+  minutes_ago(1)
+end
+
+
+
+ +
+

+ + - (Object) prev_quarter + + + +

+
+

+Short-hand for quarters_ago(1).beginning_of_quarter. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+90
+91
+92
+
+
# File 'lib/time_ext/time.rb', line 90
+
+def prev_quarter
+  quarters_ago(1).beginning_of_quarter
+end
+
+
+
+ +
+

+ + - (Object) prev_second + + + + Also known as: + prev_sec + + +

+
+

+Short-hand for seconds_ago(1). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+36
+37
+38
+
+
# File 'lib/time_ext/time.rb', line 36
+
+def prev_second
+  ago(1)
+end
+
+
+
+ +
+

+ + - (Object) prev_week(day = :monday) + + + +

+
+

+Returns a new Time representing the start of the given day in the previous +week (default is Monday). +

+ + +
+
+
+ +
+ + + + +
+
+
+
+80
+81
+82
+
+
# File 'lib/time_ext/time.rb', line 80
+
+def prev_week(day = :monday)
+  weeks_ago(1).beginning_of_week.since(days_into_week[day].day).change(:hour => 0)
+end
+
+
+
+ +
+

+ + - (Object) quarters_ago(quarters) + + + +

+
+

+Returns a new Time representing the time a number of specified quarters (3 +months) ago. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+143
+144
+145
+
+
# File 'lib/time_ext/time.rb', line 143
+
+def quarters_ago(quarters)
+  ago((quarters * 3).months)
+end
+
+
+
+ +
+

+ + - (Object) quarters_since(quarters) + + + +

+
+

+Returns a new Time representing the time a number of specified quarters (3 +months) in the future. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+148
+149
+150
+
+
# File 'lib/time_ext/time.rb', line 148
+
+def quarters_since(quarters)
+  since((quarters * 3).months)
+end
+
+
+
+ +
+

+ + - (Object) round(unit = :sec) + + + + Also known as: + beginning_of_closest + + +

+
+

+Returns a new Time representing the start of the current or next unit +specified (second by default) depending which is closest +

+ + +
+
+
+ +
+ + + + +
+
+
+
+28
+29
+30
+31
+32
+
+
# File 'lib/time_ext/time.rb', line 28
+
+def round(unit = :sec)
+  next_unit = self.ceil(unit)
+  this_unit = self.floor(unit)
+  (self - this_unit) < (next_unit - self) ? this_unit : next_unit
+end
+
+
+
+ +
+

+ + - (Object) weeks_ago(weeks) + + + +

+
+

+Returns a new Time representing the time a number of specified weeks ago. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+133
+134
+135
+
+
# File 'lib/time_ext/time.rb', line 133
+
+def weeks_ago(weeks)
+  ago(weeks.weeks)
+end
+
+
+
+ +
+

+ + - (Object) weeks_since(weeks) + + + +

+
+

+Returns a new Time representing the time a number of specified weeks in the +future. +

+ + +
+
+
+ +
+ + + + +
+
+
+
+138
+139
+140
+
+
# File 'lib/time_ext/time.rb', line 138
+
+def weeks_since(weeks)
+  since(weeks.weeks)
+end
+
+
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/doc/_index.html b/doc/_index.html new file mode 100644 index 0000000..7ebb9ec --- /dev/null +++ b/doc/_index.html @@ -0,0 +1,94 @@ + + + + +Documentation by YARD 0.5.8 + + + + + + + + + + + + + + + +
+

Documentation by YARD 0.5.8

+

Alphabetic Index

+ + +

File Listing

+ + +
+ +

Namespace Listing A-Z

+ + + + + + + + +
+ + +
    +
  • T
  • +
      + +
    • + Time + +
    • + +
    +
+ +
+
+ + + + + \ No newline at end of file diff --git a/doc/class_list.html b/doc/class_list.html new file mode 100644 index 0000000..26ba488 --- /dev/null +++ b/doc/class_list.html @@ -0,0 +1,36 @@ + + + + + + + + + + + + +
+

Class List

+ + + + +
+ + + diff --git a/doc/css/common.css b/doc/css/common.css new file mode 100644 index 0000000..cf25c45 --- /dev/null +++ b/doc/css/common.css @@ -0,0 +1 @@ +/* Override this file with custom rules */ \ No newline at end of file diff --git a/doc/css/full_list.css b/doc/css/full_list.css new file mode 100644 index 0000000..78592b3 --- /dev/null +++ b/doc/css/full_list.css @@ -0,0 +1,50 @@ +body { + margin: 0; + font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; + font-size: 13px; + height: 101%; + overflow-x: hidden; +} + +h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; } +.clear { clear: both; } +#search { position: absolute; right: 5px; top: 9px; } +#full_list { padding: 0; list-style: none; margin-left: 0; } +#full_list ul { padding: 0; } +#full_list li { padding: 5px; padding-left: 12px; margin: 0; font-size: 1.1em; list-style: none; } +#noresults { display: none; padding: 7px 12px; } +ul.collapsed ul, ul.collapsed li { display: none; } +li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; } +li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; } +li { color: #888; cursor: pointer; } +li.deprecated { text-decoration: line-through; font-style: italic; } +li.r1 { background: #f0f0f0; } +li.r2 { background: #fafafa; } +li:hover { background: #ddd; } +li small:before { content: "("; } +li small:after { content: ")"; } +li small.search_info { display: none; } +a:link, a:visited { text-decoration: none; color: #05a; } +li.clicked { background: #05a; color: #ccc; } +li.clicked a:link, li.clicked a:visited { color: #eee; } +li.clicked a.toggle { opacity: 0.5; background-position: bottom right; } +li.collapsed.clicked a.toggle { background-position: top right; } +#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; } +#nav { margin-left: 10px; font-size: 0.9em; display: none; color: #aaa; } +#nav a:link, #nav a:visited { color: #358; } +#nav a:hover { background: transparent; color: #5af; } + +.frames #content h1 { margin-top: 0; } +.frames li { white-space: nowrap; cursor: normal; } +.frames li small { display: block; font-size: 0.8em; } +.frames li small:before { content: ""; } +.frames li small:after { content: ""; } +.frames li small.search_info { display: none; } +.frames #search { position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; } +.frames #search input { width: 110px; } +.frames #nav { display: block; } + +#full_list.insearch li { display: none; } +#full_list.insearch li.found { display: list-item; padding-left: 10px; } +#full_list.insearch li a.toggle { display: none; } +#full_list.insearch li small.search_info { display: block; } diff --git a/doc/css/style.css b/doc/css/style.css new file mode 100644 index 0000000..ace9dd8 --- /dev/null +++ b/doc/css/style.css @@ -0,0 +1,277 @@ +body { + padding: 0 20px; + font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; + font-size: 13px; +} +body.frames { padding: 0 5px; } +h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; } +h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; } +h1.title { margin-bottom: 10px; } +h1.alphaindex { margin-top: 0; font-size: 22px; } +h2 { + padding: 0; + padding-bottom: 3px; + border-bottom: 1px #aaa solid; + font-size: 1.4em; + margin: 1.8em 0 0.5em; +} +h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right; } +.clear { clear: both; } +.inline { display: inline; } +.inline p:first-child { display: inline; } +.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; } +.docstring h1 { font-size: 1.2em; } +.docstring h2 { font-size: 1.1em; } +.docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; } + +.note { + color: #222; + -moz-border-radius: 3px; -webkit-border-radius: 3px; + background: #e3e4e3; border: 1px solid #d5d5d5; padding: 7px 10px; +} +.note.todo { background: #ffffc5; border-color: #ececaa; } +.note.returns_void { background: #efefef; } +.note.deprecated { background: #ffe5e5; border-color: #e9dada; } +.note.private { background: #ffffc5; border-color: #ececaa; } +.note.title { text-transform: lowercase; padding: 1px 5px; margin-left: 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; } +h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; } +.note.title.constructor { color: #fff; background: #6a98d6; border-color: #6689d6; } +.note.title.writeonly { color: #fff; background: #45a638; border-color: #2da31d; } +.note.title.readonly { color: #fff; background: #6a98d6; border-color: #6689d6; } +.note.title.private { background: #d5d5d5; border-color: #c5c5c5; } + +h3.inherited { + font-style: italic; + font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; + font-weight: normal; + padding: 0; + margin: 0; + margin-top: 12px; + margin-bottom: 3px; + font-size: 13px; +} +p.inherited { + padding: 0; + margin: 0; + margin-left: 25px; +} + +dl.box { + width: 520px; + font-size: 1em; +} +dl.box dt { + float: left; + display: block; + width: 100px; + margin: 0; + text-align: right; + font-weight: bold; + border: 1px solid #aaa; + border-width: 1px 0px 0px 1px; + padding: 6px 0; + padding-right: 10px; +} +dl.box dd { + float: left; + display: block; + width: 380px; + margin: 0; + padding: 6px 0; + padding-right: 20px; + border: 1px solid #aaa; + border-width: 1px 1px 0 0; +} +dl.box .last { + border-bottom: 1px solid #aaa; +} +dl.box .r1 { background: #eee; } + +ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; } +#files { padding-left: 15px; font-size: 1.1em; } + +#files { padding: 0; } +#files li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; } + +dl.constants { margin-left: 40px; } +dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; } +dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; } + +.summary_desc { margin-left: 32px; display: block; font-family: sans-serif; } +.summary_desc tt { font-size: 0.9em; } +dl.constants .docstring { margin-left: 32px; font-size: 0.9em; font-weight: normal; } +dl.constants .discussion *:first-child { margin-top: 0; } +dl.constants .discussion *:last-child { margin-bottom: 0; } + +.method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; } +.method_details.first { border: 0; } +p.signature { + font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace; + padding: 6px 10px; margin-top: 18px; + background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px; +} +p.signature tt { font-family: Monaco, Consolas, Courier, monospace; } +p.signature .overload { display: block; } +p.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; } +p.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; } +p.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; } + +.tags h3 { font-size: 1em; margin-bottom: 0; } +.tags ul { margin-top: 5px; padding-left: 30px; list-style: square; } +.tags ul li { margin-bottom: 3px; } +.tags ul .name { font-family: monospace; font-weight: bold; } +.tags ul .note { padding: 3px 6px; } +.tags { margin-bottom: 12px; } + +.tags .examples h3 { margin-bottom: 10px; } +.tags .examples h4 { padding: 0; margin: 0; margin-left: 15px; font-weight: bold; font-size: 0.9em; } + +.tags .overload .overload_item { list-style: none; margin-bottom: 25px; } +.tags .overload .overload_item .signature { + padding: 2px 8px; + background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px; +} +.tags .overload .signature { margin-left: -15px; font-family: monospace; display: block; font-size: 1.1em; } +.tags .overload .docstring { margin-top: 15px; } + +.defines { display: none; } + +#method_missing_details .notice.this { position: relative; top: -8px; color: #888; padding: 0; margin: 0; } + +.showSource { font-size: 0.9em; } +.showSource a:link, .showSource a:visited { text-decoration: none; color: #666; } + +#content a:link, #content a:visited { text-decoration: none; color: #05a; } +#content a:hover { background: #ffffa5; } +.docstring { margin-right: 6em; } + +ul.summary { + list-style: none; + font-family: monospace; + font-size: 1em; + line-height: 1.5em; +} +ul.summary a:link, ul.summary a:visited { + text-decoration: none; font-size: 1.1em; +} +ul.summary li { margin-bottom: 5px; } +.summary .summary_signature { + padding: 1px 10px; + background: #eaeaff; border: 1px solid #dfdfe5; + -moz-border-radius: 3px; -webkit-border-radius: 3px; +} +.summary_signature:hover { background: #eeeeff; cursor: pointer; } +ul.summary.compact li { display: inline; margin-right: 5px; line-height: 2.6em;} +ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; } +#content .summary_signature:hover a:link, +#content .summary_signature:hover a:visited { + background: transparent; + color: #48f; +} + +p.inherited a { font-family: monospace; font-size: 0.9em; } +p.inherited { word-spacing: 5px; font-size: 1.2em; } + +p.children { font-size: 1.2em; } +p.children a { font-size: 0.9em; } +p.children strong { font-size: 0.8em; } +p.children strong.modules { padding-left: 5px; } + +ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; } +ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; } +ul.fullTree li { text-align: center; } +ul.fullTree li.next:before { font-size: 1.2em; content: '\2B06'; color: #bbb; display: block; margin-top: 3px; } + +#search { position: absolute; right: 14px; top: 0px; } +#search a:link, #search a:visited { + display: block; float: left; margin-right: 4px; + padding: 8px 10px; text-decoration: none; color: #05a; background: #eaeaff; + border: 1px solid #d8d8e5; + -moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px; + -webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px; +} +#search a:hover { background: #eef; color: #06b; } +#search a.active { + background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457; + -moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px; + -webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px; +} +#search a.inactive { color: #999; } +.frames #search { display: none; } +.inheritanceTree, .toggleDefines { float: right; } + +#menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; } +#menu .title, #menu a { font-size: 0.7em; } +#menu .title a { font-size: 1em; } +#menu .title { color: #555; } +#menu a:link, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; } +#menu a:hover { color: #05a; } +#menu .noframes { display: none; } +.frames #menu .noframes { display: inline; float: right; } + +#footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; } +#footer a:link, #footer a:visited { color: #444; text-decoration: none; border-bottom: 1px dotted #bbd; } +#footer a:hover { color: #05a; } + +#listing ul.alpha { font-size: 1.1em; } +#listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; } +#listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; } +#listing ul.alpha ul { margin: 0; padding-left: 15px; } +#listing ul small { color: #666; font-size: 0.7em; } + +li.r1 { background: #f0f0f0; } +li.r2 { background: #fafafa; } + +#search_frame { + background: #fff; + display: none; + position: absolute; + top: 36px; + right: 18px; + width: 500px; + height: 80%; + overflow-y: scroll; + border: 1px solid #999; + border-collapse: collapse; + -webkit-box-shadow: -7px 5px 25px #aaa; + -moz-box-shadow: -7px 5px 25px #aaa; + -moz-border-radius: 2px; + -webkit-border-radius: 2px; +} + +#content ul.summary li.deprecated a:link, +#content ul.summary li.deprecated a:visited { text-decoration: line-through; font-style: italic; } + +/* syntax highlighting */ +.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; } +#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; } +#filecontents pre.code, .docstring pre.code { display: block; } +.source_code .lines { padding-right: 12px; color: #555; text-align: right; } +#filecontents pre.code, .docstring pre.code, +.tags .example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; } +pre.code { color: #000; } +pre.code .info.file { color: #555; } +pre.code .val { color: #036A07; } +pre.code .tstring_content, +pre.code .heredoc_beg, pre.code .heredoc_end, +pre.code .qwords_beg, pre.code .qwords_end, +pre.code .tstring, pre.code .dstring { color: #036A07; } +pre.code .fid, pre.code .id.new, pre.code .id.to_s, +pre.code .id.to_sym, pre.code .id.to_f, +pre.code .dot + pre.code .id, +pre.code .id.to_i pre.code .id.each { color: #0085FF; } +pre.code .comment { color: #0066FF; } +pre.code .const, pre.code .constant { color: #585CF6; } +pre.code .symbol { color: #C5060B; } +pre.code .kw, +pre.code .label, +pre.code .id.require, +pre.code .id.extend, +pre.code .id.include { color: #0000FF; } +pre.code .ivar { color: #318495; } +pre.code .gvar, +pre.code .id.backref, +pre.code .id.nth_ref { color: #6D79DE; } +pre.code .regexp, .dregexp { color: #036A07; } +pre.code a { border-bottom: 1px dotted #bbf; } + diff --git a/doc/file.README.html b/doc/file.README.html new file mode 100644 index 0000000..881a86a --- /dev/null +++ b/doc/file.README.html @@ -0,0 +1,105 @@ + + + + +Documentation by YARD 0.5.8 + + + + + + + + + + + + + + + +

Ruby Time Extensions

+ +

This gem extends the abilities of Ruby’s built-in Time class by building on top of what ActiveSupport already adds. Hence I must also warn that using this gem will load all of ActiveSupport at this time.

+ +

Installation

+ +
gem install time_ext
+
+ +

Basic Usage

+ +
require "time/ext"
+Time.now.round(:week)
+#=> Beginning of this week, or next week depending on which date is closest
+
+ +

Notable Methods

+ +

The round, floor, and ceil methods were the main reason I created this gem. Each of them takes a unit argument, which can be one of the following: :sec, :min, :hour, :day, :week, :month, :quarter, and :year.

+ +

For more, please refer to the source code or the spec tests for now.

+ +

To-Do

+ + + +

Note on Patches/Pull Requests

+ + + + + +

Copyright (c) 2010 Jim Myhrberg.

+ +

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

+ +

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+ +

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ + + + + \ No newline at end of file diff --git a/doc/file_list.html b/doc/file_list.html new file mode 100644 index 0000000..7115ba1 --- /dev/null +++ b/doc/file_list.html @@ -0,0 +1,38 @@ + + + + + + + + + + + + +
+

File List

+ + + + +
+ + + diff --git a/doc/frames.html b/doc/frames.html new file mode 100644 index 0000000..e5f4744 --- /dev/null +++ b/doc/frames.html @@ -0,0 +1,13 @@ + + + + + + Documentation by YARD 0.5.8 + + + + + + diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..881a86a --- /dev/null +++ b/doc/index.html @@ -0,0 +1,105 @@ + + + + +Documentation by YARD 0.5.8 + + + + + + + + + + + + + + + +

Ruby Time Extensions

+ +

This gem extends the abilities of Ruby’s built-in Time class by building on top of what ActiveSupport already adds. Hence I must also warn that using this gem will load all of ActiveSupport at this time.

+ +

Installation

+ +
gem install time_ext
+
+ +

Basic Usage

+ +
require "time/ext"
+Time.now.round(:week)
+#=> Beginning of this week, or next week depending on which date is closest
+
+ +

Notable Methods

+ +

The round, floor, and ceil methods were the main reason I created this gem. Each of them takes a unit argument, which can be one of the following: :sec, :min, :hour, :day, :week, :month, :quarter, and :year.

+ +

For more, please refer to the source code or the spec tests for now.

+ +

To-Do

+ + + +

Note on Patches/Pull Requests

+ + + + + +

Copyright (c) 2010 Jim Myhrberg.

+ +

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

+ +

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+ +

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ + + + + \ No newline at end of file diff --git a/doc/js/app.js b/doc/js/app.js new file mode 100644 index 0000000..ca73848 --- /dev/null +++ b/doc/js/app.js @@ -0,0 +1,138 @@ +function createSourceLinks() { + $('.method_details_list .source_code'). + before("[View source]"); + $('.toggleSource').toggle(function() { + $(this).parent().next().slideDown(100); + $(this).text("Hide source"); + }, + function() { + $(this).parent().next().slideUp(100); + $(this).text("View source"); + }); +} + +function createDefineLinks() { + var tHeight = 0; + $('.defines').after(" more..."); + $('.toggleDefines').toggle(function() { + tHeight = $(this).parent().prev().height(); + $(this).prev().show(); + $(this).parent().prev().height($(this).parent().height()); + $(this).text("(less)"); + }, + function() { + $(this).prev().hide(); + $(this).parent().prev().height(tHeight); + $(this).text("more...") + }); +} + +function createFullTreeLinks() { + var tHeight = 0; + $('.inheritanceTree').toggle(function() { + tHeight = $(this).parent().prev().height(); + $(this).prev().prev().hide(); + $(this).prev().show(); + $(this).text("(hide)"); + $(this).parent().prev().height($(this).parent().height()); + }, + function() { + $(this).prev().prev().show(); + $(this).prev().hide(); + $(this).parent().prev().height(tHeight); + $(this).text("show all") + }); +} + +function fixBoxInfoHeights() { + $('dl.box dd.r1, dl.box dd.r2').each(function() { + $(this).prev().height($(this).height()); + }); +} + +function searchFrameLinks() { + $('#method_list_link').click(function() { + toggleSearchFrame(this, relpath + 'method_list.html'); + }); + + $('#class_list_link').click(function() { + toggleSearchFrame(this, relpath + 'class_list.html'); + }); + + $('#file_list_link').click(function() { + toggleSearchFrame(this, relpath + 'file_list.html'); + }); +} + +function toggleSearchFrame(id, link) { + var frame = $('#search_frame'); + $('#search a').removeClass('active').addClass('inactive'); + if (frame.attr('src') == link && frame.css('display') != "none") { + frame.slideUp(100); + $('#search a').removeClass('active inactive'); + } + else { + $(id).addClass('active').removeClass('inactive'); + frame.attr('src', link).slideDown(100); + } +} + +function linkSummaries() { + $('.summary_signature').click(function() { + document.location = $(this).find('a').attr('href'); + }); +} + +function framesInit() { + if (window.top.frames.main) { + document.body.className = 'frames'; + $('#menu .noframes a').attr('href', document.location); + } +} + +function keyboardShortcuts() { + if (window.top.frames.main) return; + $(document).keypress(function(evt) { + if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return; + if (evt.originalTarget.nodeName == "INPUT" || + evt.originalTarget.nodeName == "TEXTAREA") return; + switch (evt.charCode) { + case 67: case 99: $('#class_list_link').click(); break; // 'c' + case 77: case 109: $('#method_list_link').click(); break; // 'm' + case 70: case 102: $('#file_list_link').click(); break; // 'f' + } + }); +} + +function summaryToggle() { + $('.summary_toggle').click(function() { + $(this).text($(this).text() == "collapse" ? "expand" : "collapse"); + var next = $(this).parent().parent().next(); + if (next.hasClass('compact')) { + next.toggle(); + next.next().toggle(); + } + else if (next.hasClass('summary')) { + var list = $('