aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Lea <commit@tomlea.co.uk>2008-09-11 16:41:19 +0100
committergbuesing <gbuesing@gmail.com>2008-10-13 20:00:09 -0500
commitd599b8000968047b4095dd8ff6c8ef10bb4ed462 (patch)
tree97ff0ef8ef8aa110748ec24da71d3c56568b6b53
parent27c70ff386e76ed0af41b53f2ba8cdb09bc94ace (diff)
downloadrails-d599b8000968047b4095dd8ff6c8ef10bb4ed462.tar.gz
rails-d599b8000968047b4095dd8ff6c8ef10bb4ed462.tar.bz2
rails-d599b8000968047b4095dd8ff6c8ef10bb4ed462.zip
Deprecated Float#years and Float#months, moved Numeric#years and Numeric#months into Integer.
-rw-r--r--activesupport/lib/active_support/core_ext/float.rb2
-rw-r--r--activesupport/lib/active_support/core_ext/float/time.rb27
-rw-r--r--activesupport/lib/active_support/core_ext/integer.rb2
-rw-r--r--activesupport/lib/active_support/core_ext/integer/time.rb45
-rw-r--r--activesupport/lib/active_support/core_ext/numeric/time.rb10
-rw-r--r--activesupport/test/core_ext/duration_test.rb18
6 files changed, 94 insertions, 10 deletions
diff --git a/activesupport/lib/active_support/core_ext/float.rb b/activesupport/lib/active_support/core_ext/float.rb
index 86862b7150..af166aa610 100644
--- a/activesupport/lib/active_support/core_ext/float.rb
+++ b/activesupport/lib/active_support/core_ext/float.rb
@@ -1,5 +1,7 @@
require 'active_support/core_ext/float/rounding'
+require 'active_support/core_ext/float/time'
class Float #:nodoc:
include ActiveSupport::CoreExtensions::Float::Rounding
+ include ActiveSupport::CoreExtensions::Float::Time
end
diff --git a/activesupport/lib/active_support/core_ext/float/time.rb b/activesupport/lib/active_support/core_ext/float/time.rb
new file mode 100644
index 0000000000..6229cfe76b
--- /dev/null
+++ b/activesupport/lib/active_support/core_ext/float/time.rb
@@ -0,0 +1,27 @@
+module ActiveSupport #:nodoc:
+ module CoreExtensions #:nodoc:
+ module Float #:nodoc:
+ module Time
+ # Deprication helper methods not available as core_ext is loaded first.
+ def years
+ ::ActiveSupport::Deprecation.warn(self.class.deprecated_method_warning(:years), caller)
+ years_without_deprecation
+ end
+ def months
+ ::ActiveSupport::Deprecation.warn(self.class.deprecated_method_warning(:months), "Fractional months are not respected. Use .to_i before ", caller)
+ months_without_deprecation
+ end
+
+ def months_without_deprecation
+ ActiveSupport::Duration.new(self * 30.days, [[:months, self]])
+ end
+ alias :month :months
+
+ def years_without_deprecation
+ ActiveSupport::Duration.new(self * 365.25.days, [[:years, self]])
+ end
+ alias :year :years
+ end
+ end
+ end
+end \ No newline at end of file
diff --git a/activesupport/lib/active_support/core_ext/integer.rb b/activesupport/lib/active_support/core_ext/integer.rb
index d1e6d76acb..18a7a402db 100644
--- a/activesupport/lib/active_support/core_ext/integer.rb
+++ b/activesupport/lib/active_support/core_ext/integer.rb
@@ -1,7 +1,9 @@
require 'active_support/core_ext/integer/even_odd'
require 'active_support/core_ext/integer/inflections'
+require 'active_support/core_ext/integer/time'
class Integer #:nodoc:
include ActiveSupport::CoreExtensions::Integer::EvenOdd
include ActiveSupport::CoreExtensions::Integer::Inflections
+ include ActiveSupport::CoreExtensions::Integer::Time
end
diff --git a/activesupport/lib/active_support/core_ext/integer/time.rb b/activesupport/lib/active_support/core_ext/integer/time.rb
new file mode 100644
index 0000000000..356e145b90
--- /dev/null
+++ b/activesupport/lib/active_support/core_ext/integer/time.rb
@@ -0,0 +1,45 @@
+module ActiveSupport #:nodoc:
+ module CoreExtensions #:nodoc:
+ module Integer #:nodoc:
+ # Enables the use of time calculations and declarations, like 45.minutes + 2.hours + 4.years.
+ #
+ # These methods use Time#advance for precise date calculations when using from_now, ago, etc.
+ # as well as adding or subtracting their results from a Time object. For example:
+ #
+ # # equivalent to Time.now.advance(:months => 1)
+ # 1.month.from_now
+ #
+ # # equivalent to Time.now.advance(:years => 2)
+ # 2.years.from_now
+ #
+ # # equivalent to Time.now.advance(:months => 4, :years => 5)
+ # (4.months + 5.years).from_now
+ #
+ # While these methods provide precise calculation when used as in the examples above, care
+ # should be taken to note that this is not true if the result of `months', `years', etc is
+ # converted before use:
+ #
+ # # equivalent to 30.days.to_i.from_now
+ # 1.month.to_i.from_now
+ #
+ # # equivalent to 365.25.days.to_f.from_now
+ # 1.year.to_f.from_now
+ #
+ # In such cases, Ruby's core
+ # Date[http://stdlib.rubyonrails.org/libdoc/date/rdoc/index.html] and
+ # Time[http://stdlib.rubyonrails.org/libdoc/time/rdoc/index.html] should be used for precision
+ # date and time arithmetic
+ module Time
+ def months
+ ActiveSupport::Duration.new(self * 30.days, [[:months, self]])
+ end
+ alias :month :months
+
+ def years
+ ActiveSupport::Duration.new(self * 365.25.days, [[:years, self]])
+ end
+ alias :year :years
+ end
+ end
+ end
+end
diff --git a/activesupport/lib/active_support/core_ext/numeric/time.rb b/activesupport/lib/active_support/core_ext/numeric/time.rb
index aac698f7a8..bc7f180cd1 100644
--- a/activesupport/lib/active_support/core_ext/numeric/time.rb
+++ b/activesupport/lib/active_support/core_ext/numeric/time.rb
@@ -60,16 +60,6 @@ module ActiveSupport #:nodoc:
end
alias :fortnight :fortnights
- def months
- ActiveSupport::Duration.new(self * 30.days, [[:months, self]])
- end
- alias :month :months
-
- def years
- ActiveSupport::Duration.new(self * 365.25.days, [[:years, self]])
- end
- alias :year :years
-
# Reads best without arguments: 10.minutes.ago
def ago(time = ::Time.now)
time - self
diff --git a/activesupport/test/core_ext/duration_test.rb b/activesupport/test/core_ext/duration_test.rb
index b01fbf2efb..7b767c819e 100644
--- a/activesupport/test/core_ext/duration_test.rb
+++ b/activesupport/test/core_ext/duration_test.rb
@@ -64,6 +64,24 @@ class DurationTest < Test::Unit::TestCase
assert_equal((7 * 36).hours.ago, 1.5.weeks.ago)
assert_equal((7 * 24 * 1.7).hours.ago, 1.7.weeks.ago)
end
+
+ def test_deprecated_fractional_years
+ assert_deprecated{1.0.years}
+ assert_deprecated{1.5.years}
+ assert_not_deprecated{1.years}
+ assert_deprecated{1.0.year}
+ assert_deprecated{1.5.year}
+ assert_not_deprecated{1.year}
+ end
+
+ def test_deprecated_fractional_months
+ assert_deprecated{1.5.months}
+ assert_deprecated{1.0.months}
+ assert_not_deprecated{1.months}
+ assert_deprecated{1.5.month}
+ assert_deprecated{1.0.month}
+ assert_not_deprecated{1.month}
+ end
def test_since_and_ago_anchored_to_time_now_when_time_zone_default_not_set
Time.zone_default = nil