anniversary 0.0.2 → 1.0.0

data/doc/rdoc-style.css

@@ -0,0 +1,208 @@
+
+body {
+    font-family: Verdana,Arial,Helvetica,sans-serif;
+    font-size:   90%;
+    margin: 0;
+    margin-left: 40px;
+    padding: 0;
+    background: white;
+}
+
+h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
+h1 { font-size: 150%; }
+h2,h3,h4 { margin-top: 1em; }
+
+a { background: #eef; color: #039; text-decoration: none; }
+a:hover { background: #039; color: #eef; }
+
+/* Override the base stylesheet's Anchor inside a table cell */
+td > a {
+  background: transparent;
+  color: #039;
+  text-decoration: none;
+}
+
+/* and inside a section title */
+.section-title > a {
+  background: transparent;
+  color: #eee;
+  text-decoration: none;
+}
+
+/* === Structural elements =================================== */
+
+div#index {
+    margin: 0;
+    margin-left: -40px;
+    padding: 0;
+    font-size: 90%;
+}
+
+
+div#index a {
+    margin-left: 0.7em;
+}
+
+div#index .section-bar {
+   margin-left: 0px;
+   padding-left: 0.7em;
+   background: #ccc;
+   font-size: small;
+}
+
+
+div#classHeader, div#fileHeader {
+    width: auto;
+    color: white;
+    padding: 0.5em 1.5em 0.5em 1.5em;
+    margin: 0;
+    margin-left: -40px;
+    border-bottom: 3px solid #006;
+}
+
+div#classHeader a, div#fileHeader a {
+    background: inherit;
+    color: white;
+}
+
+div#classHeader td, div#fileHeader td {
+    background: inherit;
+    color: white;
+}
+
+
+div#fileHeader {
+    background: #057;
+}
+
+div#classHeader {
+    background: #048;
+}
+
+
+.class-name-in-header {
+  font-size:  180%;
+  font-weight: bold;
+}
+
+
+div#bodyContent {
+    padding: 0 1.5em 0 1.5em;
+}
+
+div#description {
+    padding: 0.5em 1.5em;
+    background: #efefef;
+    border: 1px dotted #999;
+}
+
+div#description h1,h2,h3,h4,h5,h6 {
+    color: #125;;
+    background: transparent;
+}
+
+div#validator-badges {
+    text-align: center;
+}
+div#validator-badges img { border: 0; }
+
+div#copyright {
+    color: #333;
+    background: #efefef;
+    font: 0.75em sans-serif;
+    margin-top: 5em;
+    margin-bottom: 0;
+    padding: 0.5em 2em;
+}
+
+
+/* === Classes =================================== */
+
+table.header-table {
+    color: white;
+    font-size: small;
+}
+
+.type-note {
+    font-size: small;
+    color: #DEDEDE;
+}
+
+.xxsection-bar {
+    background: #eee;
+    color: #333;
+    padding: 3px;
+}
+
+.section-bar {
+   color: #333;
+   border-bottom: 1px solid #999;
+    margin-left: -20px;
+}
+
+
+.section-title {
+    background: #79a;
+    color: #eee;
+    padding: 3px;
+    margin-top: 2em;
+    margin-left: -30px;
+    border: 1px solid #999;
+}
+
+.top-aligned-row {  vertical-align: top }
+.bottom-aligned-row { vertical-align: bottom }
+
+/* --- Context section classes ----------------------- */
+
+.context-row { }
+.context-item-name { font-family: monospace; font-weight: bold; color: black; }
+.context-item-value { font-size: small; color: #448; }
+.context-item-desc { color: #333; padding-left: 2em; }
+
+/* --- Method classes -------------------------- */
+.method-detail {
+    background: #efefef;
+    padding: 0;
+    margin-top: 0.5em;
+    margin-bottom: 1em;
+    border: 1px dotted #ccc;
+}
+.method-heading {
+  color: black;
+  background: #ccc;
+  border-bottom: 1px solid #666;
+  padding: 0.2em 0.5em 0 0.5em;
+}
+.method-signature { color: black; background: inherit; }
+.method-name { font-weight: bold; }
+.method-args { font-style: italic; }
+.method-description { padding: 0 0.5em 0 0.5em; }
+
+/* --- Source code sections -------------------- */
+
+a.source-toggle { font-size: 90%; }
+div.method-source-code {
+    background: #262626;
+    color: #ffdead;
+    margin: 1em;
+    padding: 0.5em;
+    border: 1px dashed #999;
+    overflow: hidden;
+}
+
+div.method-source-code pre { color: #ffdead; overflow: hidden; }
+
+/* --- Ruby keyword styles --------------------- */
+
+.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
+
+.ruby-constant  { color: #7fffd4; background: transparent; }
+.ruby-keyword { color: #00ffff; background: transparent; }
+.ruby-ivar    { color: #eedd82; background: transparent; }
+.ruby-operator  { color: #00ffee; background: transparent; }
+.ruby-identifier { color: #ffdead; background: transparent; }
+.ruby-node    { color: #ffa07a; background: transparent; }
+.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
+.ruby-regexp  { color: #ffa07a; background: transparent; }
+.ruby-value   { color: #7fffd4; background: transparent; }

data/lib/anniversary/date_additions.rb

@@ -1,11 +1,19 @@
 require 'date'
 
 class Date
+  # Return the equivalent date in a different year and optionally month.
+  # If the result of just changing the year and or month results in an invalid date
+  # e.g. September 31 in any year, or February 29 in a non-leap year, then return a valid
+  # date in the next month, see Date.civil_with_missing_day_correction
   def in_year_with_correction(yr,mth=month)
     Date.civil_with_missing_day_correction(yr, mth, day)
   end
   alias_method :in_year_and_month_with_correction, :in_year_with_correction
 
+  # Return a date with a given year, month and day.  If the date would be invalid because that day does 
+  # not exist in that month in that year, then return an equivalent date, 'reflected' around the end of the month.
+  # For example, Date.civil_with_missing_day_correction(2001, 2, 29) would return Date.civil(2001, 3, 1), and
+  # Date.civil_with_missing_day_correction(2011, 2, 31) would return Date.civil(2011, 3, 2)
   def self.civil_with_missing_day_correction(year, month, day)
     days_in_month = [
       #   J   F   M   A   M   J   J   A   S   O   N   D
@@ -19,37 +27,65 @@ class Date
       civil(year, month, day)
     end
 
-    def years_months_days_since(date, debug = false)
-      if date < self
-        puts "#{self}.years_months_days_since(#{date})" if debug
-        anniversary_this_year = date.in_year_with_correction(year)
+    # return a 3 element array comprising the number of years, months and days which have occurred between the argument
+    # initial_date and the receiver
+    #
+    # :call-seq:
+    # years_months_days_since(initial_date)
+    #
+    # The return values are
+    #    0. years - the number of anniversary dates which have occurred 
+    #    1. months - the number of 'monthiversary' dates which have occurred since the last anniversary date
+    #    2. days - the number of days since the last monthiversary
+    #
+    # If the receiver is before the argument then years, months and days will be 0 or negative values.
+    def years_months_days_since(initial_date, debug = false)
+      if initial_date < self
+        puts "#{self}.years_months_days_since(#{initial_date})" if debug
+        anniversary_this_year = initial_date.in_year_with_correction(year)
         puts "anniversary_this_year is #{anniversary_this_year}" if debug
         years = if anniversary_this_year <= self
-          year - date.year
+          year - initial_date.year
         else
-          year - date.year - 1
+          year - initial_date.year - 1
         end
-        last_monthiversary = monthiversary_this_month = date.in_year_and_month_with_correction(year, month)
+        last_monthiversary = monthiversary_this_month = initial_date.in_year_and_month_with_correction(year, month)
         puts "monthiversary_this_month is #{monthiversary_this_month}" if debug
         if (monthiversary_this_month > self)
           last_month = Date.civil(year, month, 1) << 1
-          last_monthiversary = date.in_year_and_month_with_correction(last_month.year, last_month.month)
+          last_monthiversary = initial_date.in_year_and_month_with_correction(last_month.year, last_month.month)
         end
         puts "last_monthiversary is #{last_monthiversary}" if debug
 
-        if last_monthiversary > date
+        if last_monthiversary > initial_date
           months = (last_monthiversary.month - anniversary_this_year.month)
           months += 12 if months < 0
         else
           months = 0
         end
         days = (self - last_monthiversary).to_i
-      elsif date > self
-        date.years_months_days_since(self, debug).map {|v| -v}
+      elsif initial_date > self
+        initial_date.years_months_days_since(self, debug).map {|v| -v}
       else
         years, months, days = 0, 0, 0
       end
 
       [years, months, days]
     end
+    
+    # return a 3 element array comprising the number of years, months and days which will occur between the argument
+    # end_date and the receiver
+    #
+    # :call-seq:
+    # years_months_days_until(end_date)
+    #
+    # The return values are
+    #    0. years - the number of anniversary dates which will occur 
+    #    1. months - the number of 'monthiversary' dates which will occur after the last anniversary date
+    #    2. days - the number of days after the last monthiversary
+    #
+    # If the receiver is after the argument then years, months and days will be 0 or negative values.
+    def years_months_days_until(end_date, debug = false)
+      end_date.years_months_days_since(self)
+    end
   end

data/lib/anniversary/version.rb

@@ -1,3 +1,3 @@
 module Anniversary
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/spec/lib/date_additions_spec.rb

@@ -2,6 +2,24 @@
 require 'spec_helper'
 require 'anniversary.rb'
 describe "::Date" do
+  
+  context "Date.civil_with_missing_day_correction" do
+    it "should handle a leap day jump" do
+      Date.civil_with_missing_day_correction(2011, 2, 29).should == Date.civil(2011, 3, 1)
+    end
+    
+    it "should handle a normal short month jump" do
+      Date.civil_with_missing_day_correction(2011, 9, 31).should == Date.civil(2011, 10, 1)
+    end
+    
+    it "should handle a multi-day jump in a leap year" do
+      Date.civil_with_missing_day_correction(2012, 2, 31).should == Date.civil(2012, 3, 2)
+    end
+    
+    it "should handle a multi-day jump in a non-leap year" do
+      Date.civil_with_missing_day_correction(2011, 2, 31).should == Date.civil(2011, 3, 3)
+    end
+  end
 
   context "years_months_days_since" do
     def self.build_example(anniversary, subject, expected)
@@ -67,6 +85,6 @@ describe "::Date" do
      
      test_range( ::Date.civil(2000,6,1), ::Date.civil(2010,8,31))
      test_range( ::Date.civil(2000, 6, 15), ::Date.civil(2010,8,31))
-
+  
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: anniversary
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
+  hash: 23
+  prerelease: false
   segments: 
+  - 1
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors: 
 - Rick Denatale
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-13 00:00:00 -05:00
+date: 2011-01-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,9 +44,25 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rvmrc
 - Gemfile
 - Rakefile
 - anniversary.gemspec
+- doc/classes/Anniversary.html
+- doc/classes/Date.html
+- doc/classes/Date.src/M000001.html
+- doc/classes/Date.src/M000003.html
+- doc/classes/Date.src/M000004.html
+- doc/classes/Date.src/M000005.html
+- doc/created.rid
+- doc/files/lib/anniversary/date_additions_rb.html
+- doc/files/lib/anniversary/version_rb.html
+- doc/files/lib/anniversary_rb.html
+- doc/fr_class_index.html
+- doc/fr_file_index.html
+- doc/fr_method_index.html
+- doc/index.html
+- doc/rdoc-style.css
 - lib/anniversary.rb
 - lib/anniversary/date_additions.rb
 - lib/anniversary/version.rb
@@ -82,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: anniversary
-rubygems_version: 1.4.1
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Add method to Ruby's Date to get [years, months, days] between two dates