From 1491f87b8d348ac4735fc3fa6f27aa82dcea5686 Mon Sep 17 00:00:00 2001 From: perezd Date: Wed, 18 Feb 2009 13:02:16 -0800 Subject: [PATCH] updating documentation --- rdoc/classes/Date.html | 124 +++++++++++ rdoc/classes/Month.html | 8 +- rdoc/classes/SmartMonth.html | 12 ++ rdoc/classes/SmartMonth/Calculations.html | 122 +++++------ rdoc/classes/SmartMonth/Collection.html | 165 +++++++-------- rdoc/classes/SmartMonth/Extensions.html | 111 ++++++++++ rdoc/classes/SmartMonth/Extensions/Date.html | 197 ++++++++++++++++++ rdoc/classes/SmartMonth/Magic.html | 37 +++- rdoc/classes/SmartMonth/Math.html | 140 ++++++------- rdoc/classes/SmartMonth/Rulesets.html | 79 ++----- rdoc/classes/SmartMonth/Util.html | 128 +++++++----- rdoc/created.rid | 2 +- rdoc/files/README.html | 5 +- rdoc/files/lib/month_rb.html | 3 +- .../lib/smart_month/calculations_rb.html | 2 +- rdoc/files/lib/smart_month/collection_rb.html | 2 +- .../lib/smart_month/extensions/date_rb.html | 109 ++++++++++ rdoc/files/lib/smart_month/magic_rb.html | 2 +- rdoc/files/lib/smart_month/math_rb.html | 2 +- rdoc/files/lib/smart_month/rulesets_rb.html | 2 +- rdoc/files/lib/smart_month/util_rb.html | 2 +- rdoc/fr_class_index.html | 4 +- rdoc/fr_file_index.html | 1 + rdoc/fr_method_index.html | 71 ++++--- 24 files changed, 939 insertions(+), 391 deletions(-) create mode 100644 rdoc/classes/Date.html create mode 100644 rdoc/classes/SmartMonth/Extensions.html create mode 100644 rdoc/classes/SmartMonth/Extensions/Date.html create mode 100644 rdoc/files/lib/smart_month/extensions/date_rb.html diff --git a/rdoc/classes/Date.html b/rdoc/classes/Date.html new file mode 100644 index 0000000..e2c2fb5 --- /dev/null +++ b/rdoc/classes/Date.html @@ -0,0 +1,124 @@ + + + + + + Class: Date + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassDate
In: + + lib/smart_month/extensions/date.rb + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+inject the extension mixin to the base class +

+ +
+ + +
+ + +
+ + + +
+

Included Modules

+ + +
+ +
+ + + + + + + + + + + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file diff --git a/rdoc/classes/Month.html b/rdoc/classes/Month.html index 38a9e38..926bad0 100644 --- a/rdoc/classes/Month.html +++ b/rdoc/classes/Month.html @@ -165,10 +165,10 @@

Public Class methods

onclick="toggleCode('M000001-source');return false;">[Source]

-    # File lib/month.rb, line 25
-25:   def initialize(month = Time.now.mon, year = Time.now.year)
-26:     @date = Date.new(year,( month.is_a?(Integer) ? month : Month::NAMES.index(month.to_s.capitalize) ) ,1) 
-27:   end
+    # File lib/month.rb, line 23
+23:   def initialize(month = Time.now.mon, year = Time.now.year)
+24:     @date = Date.new(year,( month.is_a?(Integer) ? month : Month::NAMES.index(month.to_s.capitalize) ) ,1) 
+25:   end
diff --git a/rdoc/classes/SmartMonth.html b/rdoc/classes/SmartMonth.html index 861730f..875baba 100644 --- a/rdoc/classes/SmartMonth.html +++ b/rdoc/classes/SmartMonth.html @@ -62,6 +62,10 @@ lib/smart_month/collection.rb +
+ + lib/smart_month/extensions/date.rb +
lib/smart_month/magic.rb @@ -92,6 +96,13 @@
+
+

+This module extends the core Date class +functionality for use throughout smart_month. +

+ +
@@ -109,6 +120,7 @@

Classes and Modules

Module SmartMonth::Calculations
Module SmartMonth::Collection
+Module SmartMonth::Extensions
Module SmartMonth::Magic
Module SmartMonth::Math
Module SmartMonth::Util
diff --git a/rdoc/classes/SmartMonth/Calculations.html b/rdoc/classes/SmartMonth/Calculations.html index e23b435..1691404 100644 --- a/rdoc/classes/SmartMonth/Calculations.html +++ b/rdoc/classes/SmartMonth/Calculations.html @@ -86,15 +86,15 @@

Methods

- every   - every!   - first   - fourth   - last   - length   - second   - size   - third   + every   + every!   + first   + fourth   + last   + length   + second   + size   + third  
@@ -116,11 +116,11 @@

Methods

Public Instance methods

-
- +
+
- + every(*days)
@@ -132,8 +132,8 @@

Public Instance methods

returned.

[Source]

-
+ onclick="toggleCode('M000035-source');return false;">[Source]

+ 
     # File lib/smart_month/calculations.rb, line 34
 34:     def every(*days)
@@ -162,23 +162,23 @@ 
Public Instance methods
-
- +
+
- + every!(*days)

-this returns the same data as every +this returns the same data as every but removes the hash organization of the data.

[Source]

-
+ onclick="toggleCode('M000036-source');return false;">[Source]

+ 
     # File lib/smart_month/calculations.rb, line 58
 58:     def every!(*days)
@@ -190,24 +190,24 @@ 
Public Instance methods
-
- +
+
- + first(day = nil)

-returns the first date of the day +returns the first date of the day requested. if no day is defined, it returns the very first day of the month. +href="Calculations.html#M000030">first day of the month.

[Source]

-
+ onclick="toggleCode('M000030-source');return false;">[Source]

+ 
    # File lib/smart_month/calculations.rb, line 6
 6:     def first(day = nil)
@@ -218,23 +218,23 @@ 
Public Instance methods
-
- +
+
- + fourth(day)

-returns the fourth (or potentially -last), date of the day requested. +returns the fourth (or potentially +last), date of the day requested.

[Source]

-
+ onclick="toggleCode('M000033-source');return false;">[Source]

+ 
     # File lib/smart_month/calculations.rb, line 21
 21:     def fourth(day)
@@ -245,24 +245,24 @@ 
Public Instance methods
-
- +
+
- + last(day = nil)

-returns last date of the day +returns last date of the day requested. if no day is defined, it returns the very last day of the month. +href="Calculations.html#M000034">last day of the month.

[Source]

-
+ onclick="toggleCode('M000034-source');return false;">[Source]

+ 
     # File lib/smart_month/calculations.rb, line 27
 27:     def last(day = nil)
@@ -273,8 +273,8 @@ 
Public Instance methods
-
- +
+
length() @@ -282,28 +282,28 @@

Public Instance methods

-Alias for size +Alias for size

-
- +
+
- + second(day)

-returns the second date of the day +returns the second date of the day requested.

[Source]

-
+ onclick="toggleCode('M000031-source');return false;">[Source]

+ 
     # File lib/smart_month/calculations.rb, line 11
 11:     def second(day)
@@ -314,11 +314,11 @@ 
Public Instance methods
-
- +
+
- + size()
@@ -328,8 +328,8 @@

Public Instance methods

returns the total number of days in month.

[Source]

-
+ onclick="toggleCode('M000037-source');return false;">[Source]

+ 
     # File lib/smart_month/calculations.rb, line 64
 64:     def size
@@ -340,23 +340,23 @@ 
Public Instance methods
-
- +
+
- + third(day)

-returns the third date of the day +returns the third date of the day requested.

[Source]

-
+ onclick="toggleCode('M000032-source');return false;">[Source]

+ 
     # File lib/smart_month/calculations.rb, line 16
 16:     def third(day)
diff --git a/rdoc/classes/SmartMonth/Collection.html b/rdoc/classes/SmartMonth/Collection.html
index a638daa..f8e8333 100644
--- a/rdoc/classes/SmartMonth/Collection.html
+++ b/rdoc/classes/SmartMonth/Collection.html
@@ -86,13 +86,13 @@
       
Methods

 
       

-      each  
-      next  
-      next!  
-      prev  
-      prev!  
-      previous  
-      previous!  
+      each  
+      next  
+      next!  
+      prev  
+      prev!  
+      previous  
+      previous!  
@@ -103,12 +103,6 @@

Methods

-
-

Classes and Modules

- - Class SmartMonth::Collection::Day
- -
@@ -120,43 +114,40 @@

Classes and Modules

Public Instance methods

-
- +
+
- + each(first = 1, last = self.last.day, &block)

-allows us to iterate internally on the days of a given month. It also uses -the helpful Day class that provides some -fun methods. (see SmartMonth::Collection::Day) +allows us to iterate internally on the days of a given month.

[Source]

-
+ onclick="toggleCode('M000026-source');return false;">[Source]

+ 
-    # File lib/smart_month/collection.rb, line 60
-60:     def each(first = 1, last = self.last.day, &block)
-61:      (1..self.last.day).each do |e|
-62:        block.call(Day.new(Date.new(@date.year,@date.month,e)))
-63:      end
-64:      return self
-65:     end
+    # File lib/smart_month/collection.rb, line 44
+44:     def each(first = 1, last = self.last.day, &block)
+45:      (1..self.last.day).each do |e|
+46:        block.call(Date.new(@date.year,@date.month,e))
+47:      end
+48:      return self
+49:     end
-
- +
+
- + next()
@@ -166,27 +157,27 @@

Public Instance methods

allows for increment by copy

[Source]

-
+ onclick="toggleCode('M000020-source');return false;">[Source]

+ 
-    # File lib/smart_month/collection.rb, line 21
-21:     def next
-22:       if @date.month + 1 > 12
-23:         Month.new(1,@date.year+1)
-24:       else
-25:         Month.new(@date.month+1,@date.year)
-26:       end
-27:     end
+    # File lib/smart_month/collection.rb, line 6
+ 6:     def next
+ 7:       if @date.month + 1 > 12
+ 8:         Month.new(1,@date.year+1)
+ 9:       else
+10:         Month.new(@date.month+1,@date.year)
+11:       end
+12:     end
-
- +
+
- + next!()
@@ -196,24 +187,24 @@

Public Instance methods

allows for in place incrementing by 1

[Source]

-
+ onclick="toggleCode('M000021-source');return false;">[Source]

+ 
-    # File lib/smart_month/collection.rb, line 30
-30:     def next!
-31:       if @date.month + 1 > 12
-32:         @date = Date.new(@date.year+1,@date.month,1)
-33:       else
-34:         @date = Date.new(@date.year,@date.month+1,1)
-35:       end
-36:     end
+    # File lib/smart_month/collection.rb, line 15
+15:     def next!
+16:       if @date.month + 1 > 12
+17:         @date = Date.new(@date.year+1,@date.month,1)
+18:       else
+19:         @date = Date.new(@date.year,@date.month+1,1)
+20:       end
+21:     end
-
- +
+
prev() @@ -221,13 +212,13 @@

Public Instance methods

-Alias for previous +Alias for previous

-
- +
+
prev!() @@ -235,16 +226,16 @@

Public Instance methods

-Alias for previous! +Alias for previous!

-
- +
+
- + previous()
@@ -254,27 +245,27 @@

Public Instance methods

allows for deincrement by copy

[Source]

-
+ onclick="toggleCode('M000022-source');return false;">[Source]

+ 
-    # File lib/smart_month/collection.rb, line 39
-39:     def previous
-40:       if @date.month - 1 == 0
-41:         Month.new(12,@date.year-1)
-42:       else
-43:         Month.new(@date.month-1,@date.year)
-44:       end
-45:     end
+    # File lib/smart_month/collection.rb, line 24
+24:     def previous
+25:       if @date.month - 1 == 0
+26:         Month.new(12,@date.year-1)
+27:       else
+28:         Month.new(@date.month-1,@date.year)
+29:       end
+30:     end
-
- +
+
- + previous!()
@@ -284,17 +275,17 @@

Public Instance methods

allows for in place deincrementing by 1

[Source]

-
+ onclick="toggleCode('M000024-source');return false;">[Source]

+ 
-    # File lib/smart_month/collection.rb, line 49
-49:     def previous!
-50:       if @date.month - 1 == 0
-51:         @date = Date.new(@date.year-1,12,1)
-52:       else
-53:         @date = Date.new(@date.year,@date.month-1,1)
-54:       end
-55:     end
+    # File lib/smart_month/collection.rb, line 34
+34:     def previous!
+35:       if @date.month - 1 == 0
+36:         @date = Date.new(@date.year-1,12,1)
+37:       else
+38:         @date = Date.new(@date.year,@date.month-1,1)
+39:       end
+40:     end
diff --git a/rdoc/classes/SmartMonth/Extensions.html b/rdoc/classes/SmartMonth/Extensions.html new file mode 100644 index 0000000..24d0e8d --- /dev/null +++ b/rdoc/classes/SmartMonth/Extensions.html @@ -0,0 +1,111 @@ + + + + + + Module: SmartMonth::Extensions + + + + + + + + + + +
+ + + + + + + + + + +
ModuleSmartMonth::Extensions
In: + + lib/smart_month/extensions/date.rb + +
+
+
+ + +
+ + + +
+ + + +
+ + +
+ + + + +
+ +
+

Classes and Modules

+ + Module SmartMonth::Extensions::Date
+ +
+ + + + + + + + + + +
+ + + + + + \ No newline at end of file diff --git a/rdoc/classes/SmartMonth/Extensions/Date.html b/rdoc/classes/SmartMonth/Extensions/Date.html new file mode 100644 index 0000000..232f693 --- /dev/null +++ b/rdoc/classes/SmartMonth/Extensions/Date.html @@ -0,0 +1,197 @@ + + + + + + Module: SmartMonth::Extensions::Date + + + + + + + + + + +
+ + + + + + + + + + +
ModuleSmartMonth::Extensions::Date
In: + + lib/smart_month/extensions/date.rb + +
+
+
+ + +
+ + + +
+ + + +
+ +
+

Methods

+ +
+ inspect   + to_day   + to_i   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Instance methods

+ +
+ + +
+ + inspect() + +
+ +
+

+this is to make date objects more console-friendly +

+

[Source]

+
+
+    # File lib/smart_month/extensions/date.rb, line 8
+ 8:       def inspect
+ 9:         strftime("%a, %d %b %Y")
+10:       end
+
+
+
+
+ +
+ + +
+ + to_day() + +
+ +
+

+allows a date to return the day of the week it currently is as a string +

+

[Source]

+
+
+    # File lib/smart_month/extensions/date.rb, line 18
+18:       def to_day
+19:         Month::DAYS[self.wday]
+20:       end
+
+
+
+
+ +
+ + +
+ + to_i() + +
+ +
+

+allows a date to retrun the current day its set to as an integer +

+

[Source]

+
+
+    # File lib/smart_month/extensions/date.rb, line 13
+13:       def to_i
+14:         self.day.to_i
+15:       end
+
+
+
+
+ + +
+ + +
+ + + + + + \ No newline at end of file diff --git a/rdoc/classes/SmartMonth/Magic.html b/rdoc/classes/SmartMonth/Magic.html index 0bd5ab6..df85556 100644 --- a/rdoc/classes/SmartMonth/Magic.html +++ b/rdoc/classes/SmartMonth/Magic.html @@ -165,14 +165,35 @@

Public Instance methods

# File lib/smart_month/magic.rb, line 24 24: def method_missing(meth) 25: raw = meth.to_s.split("_") -26: func = raw.slice!(0) -27: if func == "every" -28: args = raw.select { |a| a != "and" } -29: self.send(func,args) -30: else -31: self.send(func,raw) if %w(first second third fourth last).include? func -32: end -33: end +26: +27: # execute lookup using week as positioning control +28: if week_position?(raw[0]) && raw[1] == "and" +29: results = [] +30: # parse the request +31: arg = raw.slice!(raw.index(raw.last)) +32: funcs = parse_arguments(raw) +33: # execute +34: funcs.each do |func| +35: results << self.send(func,arg) if week_position?(func) +36: end +37: return results +38: +39: # execute an every pattern on n-days +40: elsif raw[0] == "every" +41: # parse the request +42: func = raw.slice!(0) +43: args = parse_arguments(raw) +44: # execute +45: return self.every(args) +46: +47: # revert to basic singular lookup or raise an exception +48: elsif self.respond_to?(raw[0]) +49: func = raw.slice!(0) +50: return self.send(func,raw) if week_position?(func) +51: else +52: raise NoMethodError +53: end +54: end
diff --git a/rdoc/classes/SmartMonth/Math.html b/rdoc/classes/SmartMonth/Math.html index 9f3b0c2..0658d5f 100644 --- a/rdoc/classes/SmartMonth/Math.html +++ b/rdoc/classes/SmartMonth/Math.html @@ -86,13 +86,13 @@

Methods

- %   - *   - **   - +   - -   - /   - ==   + %   + *   + **   + +   + -   + /   + ==  
@@ -114,11 +114,11 @@

Methods

Public Instance methods

-
- +
+
- + %(int)
@@ -128,23 +128,23 @@

Public Instance methods

modulos a number to the month value and returns a Fixnum.

[Source]

-
+ onclick="toggleCode('M000018-source');return false;">[Source]

+ 
-    # File lib/smart_month/math.rb, line 30
-30:     def %(int)
-31:       self.to_i % int
-32:     end
+    # File lib/smart_month/math.rb, line 31
+31:     def %(int)
+32:       self.to_i % int
+33:     end
-
- +
+
- + *(int)
@@ -154,23 +154,23 @@

Public Instance methods

multiplies a number to the month value and returns a Fixnum.

[Source]

-
+ onclick="toggleCode('M000015-source');return false;">[Source]

+ 
-    # File lib/smart_month/math.rb, line 15
-15:     def *(int)
-16:       self.to_i * int
-17:     end
+    # File lib/smart_month/math.rb, line 16
+16:     def *(int)
+17:       self.to_i * int
+18:     end
-
- +
+
- + **(int)
@@ -180,23 +180,23 @@

Public Instance methods

exponents a number to the month value and returns a Fixnum.

[Source]

-
+ onclick="toggleCode('M000017-source');return false;">[Source]

+ 
-    # File lib/smart_month/math.rb, line 25
-25:     def **(int)
-26:       self.to_i ** int
-27:     end
+    # File lib/smart_month/math.rb, line 26
+26:     def **(int)
+27:       self.to_i ** int
+28:     end
-
- +
+
- + +(int)
@@ -206,23 +206,23 @@

Public Instance methods

adds a number to the month value and returns a Fixnum.

[Source]

-
+ onclick="toggleCode('M000013-source');return false;">[Source]

+ 
-   # File lib/smart_month/math.rb, line 5
-5:     def +(int)
-6:       self.to_i + int
-7:     end
+   # File lib/smart_month/math.rb, line 6
+6:     def +(int)
+7:       self.to_i + int
+8:     end
-
- +
+
- + -(int)
@@ -232,23 +232,23 @@

Public Instance methods

subtracts a number to the month value and returns a Fixnum.

[Source]

-
+ onclick="toggleCode('M000014-source');return false;">[Source]

+ 
-    # File lib/smart_month/math.rb, line 10
-10:     def -(int)
-11:       self.to_i - int
-12:     end
+    # File lib/smart_month/math.rb, line 11
+11:     def -(int)
+12:       self.to_i - int
+13:     end
-
- +
+
- + /(int)
@@ -258,23 +258,23 @@

Public Instance methods

divides a number to the month value and returns a Fixnum.

[Source]

-
+ onclick="toggleCode('M000016-source');return false;">[Source]

+ 
-    # File lib/smart_month/math.rb, line 20
-20:     def /(int)
-21:       self.to_i / int
-22:     end
+    # File lib/smart_month/math.rb, line 21
+21:     def /(int)
+22:       self.to_i / int
+23:     end
-
- +
+
- + ==(month)
@@ -284,13 +284,13 @@

Public Instance methods

compares the current month to another month.

[Source]

-
+ onclick="toggleCode('M000019-source');return false;">[Source]

+ 
-    # File lib/smart_month/math.rb, line 35
-35:     def ==(month)
-36:       self.inspect! == month.inspect! 
-37:     end
+    # File lib/smart_month/math.rb, line 36
+36:     def ==(month)
+37:       self.inspect! == month.inspect! 
+38:     end
diff --git a/rdoc/classes/SmartMonth/Rulesets.html b/rdoc/classes/SmartMonth/Rulesets.html index f54d961..125938c 100644 --- a/rdoc/classes/SmartMonth/Rulesets.html +++ b/rdoc/classes/SmartMonth/Rulesets.html @@ -86,10 +86,8 @@

Methods

- create_condition_with_date   - create_condition_with_frequency   - load   - parse_date   + load   + parse_string_as_date  
@@ -111,63 +109,12 @@

Methods

Public Class methods

-
- - -
- - load(path) - -
- -
-

[Source]

-
-
-   # File lib/smart_month/rulesets.rb, line 5
-5:     def self.load(path)
-6:       @@ruleset_yml = YAML::load(File.open(path))
-7:     end
-
-
-
-
- -
- - -
- - parse_date(rule) - -
- -
-

[Source]

-
-
-    # File lib/smart_month/rulesets.rb, line 16
-16:     def self.parse_date(rule)
-17:       month,day,year = rule.split
-18:       day.gsub!(',','')
-19:       day.gsub!(/st|rd|th|nd/,'')
-20:       {:year => year, :month => month, :day => day}
-21:     end
-
-
-
-
- -

Public Instance methods

-
- create_condition_with_date() + load(path)
@@ -176,9 +123,10 @@

Public Instance methods

onclick="toggleCode('M000039-source');return false;">[Source]

-    # File lib/smart_month/rulesets.rb, line 9
- 9:     def create_condition_with_date
-10:     end
+   # File lib/smart_month/rulesets.rb, line 6
+6:     def self.load(path)
+7:       @@ruleset_yml = YAML::load(File.open(path))
+8:     end
@@ -189,7 +137,7 @@

Public Instance methods

- create_condition_with_frequency() + parse_string_as_date(rule)
@@ -198,10 +146,13 @@

Public Instance methods

onclick="toggleCode('M000040-source');return false;">[Source]

-    # File lib/smart_month/rulesets.rb, line 12
-12:     def create_condition_with_frequency
-13:       "([Month.new(#{month}).#{freq}!(#{days})].flatten.include? Date.new(self.year,self.month,self.day)) ? true : false"
-14:     end
+    # File lib/smart_month/rulesets.rb, line 10
+10:     def self.parse_string_as_date(rule)
+11:       month,day,year = rule.split
+12:       day.gsub!(',','')
+13:       day.gsub!(/st|rd|th|nd/,'')
+14:       {:year => year, :month => month, :day => day}
+15:     end
diff --git a/rdoc/classes/SmartMonth/Util.html b/rdoc/classes/SmartMonth/Util.html index 50c1712..d8d5afc 100644 --- a/rdoc/classes/SmartMonth/Util.html +++ b/rdoc/classes/SmartMonth/Util.html @@ -87,11 +87,12 @@

Methods

inspect   - inspect!   - to_i   - to_int   - to_s   - year   + inspect!   + month   + to_i   + to_int   + to_s   + year  
@@ -124,7 +125,7 @@

Public Instance methods

-returns the month as a string. +returns the month as a string.

[Source]

@@ -139,60 +140,88 @@

Public Instance methods

-
- +
+
- + inspect!()

-returns the month and the year as a string. +returns the month and the year as a string.

[Source]

-
+ onclick="toggleCode('M000007-source');return false;">[Source]

+ 
-    # File lib/smart_month/util.rb, line 15
-15:     def inspect!
-16:       "#{self.to_s} #{@date.year}"
-17:     end
+    # File lib/smart_month/util.rb, line 10
+10:     def inspect!
+11:       "#{self.to_s} #{self.year}"
+12:     end
-
- +
+ + +
+ + month() + +
+ +
+

+returns the month of the current month. +

+

[Source]

+
+
+    # File lib/smart_month/util.rb, line 32
+32:     def month
+33:       @date.month
+34:     end
+
+
+
+
+ +
+
- + to_i()

-returns the month as a fixnum. +returns the month as a fixnum.

[Source]

-
+ onclick="toggleCode('M000009-source');return false;">[Source]

+ 
-    # File lib/smart_month/util.rb, line 25
-25:     def to_i
-26:       Month::NAMES.index(self.to_s)
-27:     end
+    # File lib/smart_month/util.rb, line 20
+20:     def to_i
+21:       Month::NAMES.index(self.to_s)
+22:     end
-
- +
+
to_int() @@ -200,58 +229,59 @@

Public Instance methods

-Alias for to_i +Alias for to_i

-
- +
+
- + to_s()

-returns the month as a string. +returns the month as a string.

[Source]

-
+ onclick="toggleCode('M000008-source');return false;">[Source]

+ 
-    # File lib/smart_month/util.rb, line 20
-20:     def to_s
-21:        Month::NAMES[@date.month]
-22:     end
+    # File lib/smart_month/util.rb, line 15
+15:     def to_s
+16:        Month::NAMES[self.month]
+17:     end
-
- +
+
- + year()

-returns the year of the current month. +returns the year of the current month.

[Source]

-
+ onclick="toggleCode('M000011-source');return false;">[Source]

+ 
-    # File lib/smart_month/util.rb, line 10
-10:     def year
-11:       @date.year
-12:     end
+    # File lib/smart_month/util.rb, line 27
+27:     def year
+28:       @date.year
+29:     end
diff --git a/rdoc/created.rid b/rdoc/created.rid index 06c51aa..7d1fb1f 100644 --- a/rdoc/created.rid +++ b/rdoc/created.rid @@ -1 +1 @@ -Wed, 18 Feb 2009 00:56:19 -0800 +Wed, 18 Feb 2009 13:02:05 -0800 diff --git a/rdoc/files/README.html b/rdoc/files/README.html index c48a198..0174c18 100644 --- a/rdoc/files/README.html +++ b/rdoc/files/README.html @@ -81,8 +81,9 @@

README

SmartMonth is a -"bodysnatcher" plugin that takes boring Date month fixnums and -replaces them with a rich toolkit of functionality. You can use Date month fixnums and replaces them with a +rich toolkit of functionality. You can use SmartMonth to:

    diff --git a/rdoc/files/lib/month_rb.html b/rdoc/files/lib/month_rb.html index ec73a4e..eb69b3d 100644 --- a/rdoc/files/lib/month_rb.html +++ b/rdoc/files/lib/month_rb.html @@ -56,7 +56,7 @@

    month.rb

    Last Update: - Wed Feb 18 00:32:29 -0800 2009 + Wed Feb 18 12:30:15 -0800 2009
@@ -73,7 +73,6 @@

month.rb

Required files

- date   calculations   collection   math   diff --git a/rdoc/files/lib/smart_month/calculations_rb.html b/rdoc/files/lib/smart_month/calculations_rb.html index e4bb583..370b7c0 100644 --- a/rdoc/files/lib/smart_month/calculations_rb.html +++ b/rdoc/files/lib/smart_month/calculations_rb.html @@ -56,7 +56,7 @@

calculations.rb

Last Update: - Wed Feb 18 00:49:10 -0800 2009 + Wed Feb 18 12:24:44 -0800 2009
diff --git a/rdoc/files/lib/smart_month/collection_rb.html b/rdoc/files/lib/smart_month/collection_rb.html index bdadb72..8361d7d 100644 --- a/rdoc/files/lib/smart_month/collection_rb.html +++ b/rdoc/files/lib/smart_month/collection_rb.html @@ -56,7 +56,7 @@

collection.rb

Last Update: - Sun Aug 24 15:58:50 -0700 2008 + Wed Feb 18 12:25:45 -0800 2009
diff --git a/rdoc/files/lib/smart_month/extensions/date_rb.html b/rdoc/files/lib/smart_month/extensions/date_rb.html new file mode 100644 index 0000000..42d2253 --- /dev/null +++ b/rdoc/files/lib/smart_month/extensions/date_rb.html @@ -0,0 +1,109 @@ + + + + + + File: date.rb + + + + + + + + + + +
+

date.rb

+ + + + + + + + + +
Path:lib/smart_month/extensions/date.rb +
Last Update:Wed Feb 18 12:57:19 -0800 2009
+
+ + +
+ + + +
+ +
+

+This module extends the core Date class functionality for use +throughout smart_month. +

+ +
+ + +
+ + +
+ + + + +
+ + + + + + + + + + + +
+ + + + + + \ No newline at end of file diff --git a/rdoc/files/lib/smart_month/magic_rb.html b/rdoc/files/lib/smart_month/magic_rb.html index 8d9bc66..bc02beb 100644 --- a/rdoc/files/lib/smart_month/magic_rb.html +++ b/rdoc/files/lib/smart_month/magic_rb.html @@ -56,7 +56,7 @@

magic.rb

Last Update: - Fri Aug 15 10:05:33 -0700 2008 + Wed Feb 18 12:33:29 -0800 2009
diff --git a/rdoc/files/lib/smart_month/math_rb.html b/rdoc/files/lib/smart_month/math_rb.html index 3c660e6..d208dde 100644 --- a/rdoc/files/lib/smart_month/math_rb.html +++ b/rdoc/files/lib/smart_month/math_rb.html @@ -56,7 +56,7 @@

math.rb

Last Update: - Wed Aug 13 15:20:31 -0700 2008 + Wed Feb 18 12:32:48 -0800 2009
diff --git a/rdoc/files/lib/smart_month/rulesets_rb.html b/rdoc/files/lib/smart_month/rulesets_rb.html index eb951bf..69a3b1c 100644 --- a/rdoc/files/lib/smart_month/rulesets_rb.html +++ b/rdoc/files/lib/smart_month/rulesets_rb.html @@ -56,7 +56,7 @@

rulesets.rb

Last Update: - Wed Feb 18 00:32:18 -0800 2009 + Wed Feb 18 12:31:49 -0800 2009
diff --git a/rdoc/files/lib/smart_month/util_rb.html b/rdoc/files/lib/smart_month/util_rb.html index 41fa956..aa8a8ba 100644 --- a/rdoc/files/lib/smart_month/util_rb.html +++ b/rdoc/files/lib/smart_month/util_rb.html @@ -56,7 +56,7 @@

util.rb

Last Update: - Wed Oct 01 13:06:31 -0700 2008 + Wed Feb 18 12:30:54 -0800 2009
diff --git a/rdoc/fr_class_index.html b/rdoc/fr_class_index.html index b4ea54f..113be0e 100644 --- a/rdoc/fr_class_index.html +++ b/rdoc/fr_class_index.html @@ -20,11 +20,13 @@

Classes

+ Date
Month
SmartMonth
SmartMonth::Calculations
SmartMonth::Collection
- SmartMonth::Collection::Day
+ SmartMonth::Extensions
+ SmartMonth::Extensions::Date
SmartMonth::Magic
SmartMonth::Magic::MonthFactory
SmartMonth::Math
diff --git a/rdoc/fr_file_index.html b/rdoc/fr_file_index.html index 5843387..f2e43fd 100644 --- a/rdoc/fr_file_index.html +++ b/rdoc/fr_file_index.html @@ -24,6 +24,7 @@

Files

lib/month.rb
lib/smart_month/calculations.rb
lib/smart_month/collection.rb
+ lib/smart_month/extensions/date.rb
lib/smart_month/magic.rb
lib/smart_month/math.rb
lib/smart_month/rulesets.rb
diff --git a/rdoc/fr_method_index.html b/rdoc/fr_method_index.html index 08ddcdd..7e5b487 100644 --- a/rdoc/fr_method_index.html +++ b/rdoc/fr_method_index.html @@ -20,47 +20,46 @@

Methods

- % (SmartMonth::Math)
- * (SmartMonth::Math)
- ** (SmartMonth::Math)
- + (SmartMonth::Math)
- - (SmartMonth::Math)
- / (SmartMonth::Math)
- == (SmartMonth::Math)
+ % (SmartMonth::Math)
+ * (SmartMonth::Math)
+ ** (SmartMonth::Math)
+ + (SmartMonth::Math)
+ - (SmartMonth::Math)
+ / (SmartMonth::Math)
+ == (SmartMonth::Math)
[] (SmartMonth::Magic::MonthFactory)
- create_condition_with_date (SmartMonth::Rulesets)
- create_condition_with_frequency (SmartMonth::Rulesets)
- each (SmartMonth::Collection)
- every (SmartMonth::Calculations)
- every! (SmartMonth::Calculations)
- first (SmartMonth::Calculations)
- fourth (SmartMonth::Calculations)
+ each (SmartMonth::Collection)
+ every (SmartMonth::Calculations)
+ every! (SmartMonth::Calculations)
+ first (SmartMonth::Calculations)
+ fourth (SmartMonth::Calculations)
included (SmartMonth::Magic)
inspect (SmartMonth::Util)
- inspect! (SmartMonth::Util)
- last (SmartMonth::Calculations)
- length (SmartMonth::Calculations)
- load (SmartMonth::Rulesets)
- method_missing (SmartMonth::Magic)
+ inspect (SmartMonth::Extensions::Date)
+ inspect! (SmartMonth::Util)
+ last (SmartMonth::Calculations)
+ length (SmartMonth::Calculations)
+ load (SmartMonth::Rulesets)
method_missing (SmartMonth::Magic::MonthFactory)
+ method_missing (SmartMonth::Magic)
+ month (SmartMonth::Util)
new (Month)
- new (SmartMonth::Collection::Day)
- next (SmartMonth::Collection)
- next! (SmartMonth::Collection)
- parse_date (SmartMonth::Rulesets)
- prev (SmartMonth::Collection)
- prev! (SmartMonth::Collection)
- previous (SmartMonth::Collection)
- previous! (SmartMonth::Collection)
- second (SmartMonth::Calculations)
- size (SmartMonth::Calculations)
- third (SmartMonth::Calculations)
- to_i (SmartMonth::Collection::Day)
- to_i (SmartMonth::Util)
- to_int (SmartMonth::Util)
- to_s (SmartMonth::Util)
- to_s (SmartMonth::Collection::Day)
- year (SmartMonth::Util)
+ next (SmartMonth::Collection)
+ next! (SmartMonth::Collection)
+ parse_string_as_date (SmartMonth::Rulesets)
+ prev (SmartMonth::Collection)
+ prev! (SmartMonth::Collection)
+ previous (SmartMonth::Collection)
+ previous! (SmartMonth::Collection)
+ second (SmartMonth::Calculations)
+ size (SmartMonth::Calculations)
+ third (SmartMonth::Calculations)
+ to_day (SmartMonth::Extensions::Date)
+ to_i (SmartMonth::Util)
+ to_i (SmartMonth::Extensions::Date)
+ to_int (SmartMonth::Util)
+ to_s (SmartMonth::Util)
+ year (SmartMonth::Util)