activesupport 3.2.22.5 → 4.0.0

data/lib/active_support/core_ext/date_time/calculations.rb

@@ -1,46 +1,67 @@
-require 'rational' unless RUBY_VERSION >= '1.9.2'
+require 'active_support/deprecation'
 
 class DateTime
   class << self
-    # DateTimes aren't aware of DST rules, so use a consistent non-DST offset when creating a DateTime with an offset in the local zone
+    # *DEPRECATED*: Use +DateTime.civil_from_format+ directly.
     def local_offset
+      ActiveSupport::Deprecation.warn 'DateTime.local_offset is deprecated. Use DateTime.civil_from_format directly.'
+
       ::Time.local(2012).utc_offset.to_r / 86400
     end
 
-    # Returns <tt>Time.zone.now.to_datetime</tt> when <tt>Time.zone</tt> or <tt>config.time_zone</tt> are set, otherwise returns <tt>Time.now.to_datetime</tt>.
+    # Returns <tt>Time.zone.now.to_datetime</tt> when <tt>Time.zone</tt> or
+    # <tt>config.time_zone</tt> are set, otherwise returns
+    # <tt>Time.now.to_datetime</tt>.
     def current
       ::Time.zone ? ::Time.zone.now.to_datetime : ::Time.now.to_datetime
     end
   end
 
-  # Tells whether the DateTime object's datetime lies in the past
+  # Tells whether the DateTime object's datetime lies in the past.
   def past?
     self < ::DateTime.current
   end
 
-  # Tells whether the DateTime object's datetime lies in the future
+  # Tells whether the DateTime object's datetime lies in the future.
   def future?
     self > ::DateTime.current
   end
 
-  # Seconds since midnight: DateTime.now.seconds_since_midnight
+  # Seconds since midnight: DateTime.now.seconds_since_midnight.
   def seconds_since_midnight
     sec + (min * 60) + (hour * 3600)
   end
 
-  # Returns a new DateTime where one or more of the elements have been changed according to the +options+ parameter. The time options
-  # (hour, minute, sec) reset cascadingly, so if only the hour is passed, then minute and sec is set to 0. If the hour and
-  # minute is passed, then sec is set to 0.
+  # Returns the number of seconds until 23:59:59.
+  #
+  #   DateTime.new(2012, 8, 29,  0,  0,  0).seconds_until_end_of_day # => 86399
+  #   DateTime.new(2012, 8, 29, 12, 34, 56).seconds_until_end_of_day # => 41103
+  #   DateTime.new(2012, 8, 29, 23, 59, 59).seconds_until_end_of_day # => 0
+  def seconds_until_end_of_day
+    end_of_day.to_i - to_i
+  end
+
+  # Returns a new DateTime where one or more of the elements have been changed
+  # according to the +options+ parameter. The time options (<tt>:hour</tt>,
+  # <tt>:min</tt>, <tt>:sec</tt>) reset cascadingly, so if only the hour is
+  # passed, then minute and sec is set to 0. If the hour and minute is passed,
+  # then sec is set to 0. The +options+ parameter takes a hash with any of these
+  # keys: <tt>:year</tt>, <tt>:month</tt>, <tt>:day</tt>, <tt>:hour</tt>,
+  # <tt>:min</tt>, <tt>:sec</tt>, <tt>:offset</tt>, <tt>:start</tt>.
+  #
+  #   DateTime.new(2012, 8, 29, 22, 35, 0).change(day: 1)              # => DateTime.new(2012, 8, 1, 22, 35, 0)
+  #   DateTime.new(2012, 8, 29, 22, 35, 0).change(year: 1981, day: 1)  # => DateTime.new(1981, 8, 1, 22, 35, 0)
+  #   DateTime.new(2012, 8, 29, 22, 35, 0).change(year: 1981, hour: 0) # => DateTime.new(1981, 8, 29, 0, 0, 0)
   def change(options)
     ::DateTime.civil(
-      options[:year]  || year,
-      options[:month] || month,
-      options[:day]   || day,
-      options[:hour]  || hour,
-      options[:min]   || (options[:hour] ? 0 : min),
-      options[:sec]   || ((options[:hour] || options[:min]) ? 0 : sec),
-      options[:offset]  || offset,
-      options[:start]  || start
+      options.fetch(:year, year),
+      options.fetch(:month, month),
+      options.fetch(:day, day),
+      options.fetch(:hour, hour),
+      options.fetch(:min, options[:hour] ? 0 : min),
+      options.fetch(:sec, (options[:hour] || options[:min]) ? 0 : sec + sec_fraction),
+      options.fetch(:offset, offset),
+      options.fetch(:start, start)
     )
   end
 
@@ -51,24 +72,33 @@ class DateTime
   def advance(options)
     d = to_date.advance(options)
     datetime_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day)
-    seconds_to_advance = (options[:seconds] || 0) + (options[:minutes] || 0) * 60 + (options[:hours] || 0) * 3600
-    seconds_to_advance == 0 ? datetime_advanced_by_date : datetime_advanced_by_date.since(seconds_to_advance)
+    seconds_to_advance = \
+      options.fetch(:seconds, 0) +
+      options.fetch(:minutes, 0) * 60 +
+      options.fetch(:hours, 0) * 3600
+
+    if seconds_to_advance.zero?
+      datetime_advanced_by_date
+    else
+      datetime_advanced_by_date.since seconds_to_advance
+    end
   end
 
-  # Returns a new DateTime representing the time a number of seconds ago
+  # Returns a new DateTime representing the time a number of seconds ago.
   # Do not use this method in combination with x.months, use months_ago instead!
   def ago(seconds)
     since(-seconds)
   end
 
-  # Returns a new DateTime representing the time a number of seconds since the instance time
-  # Do not use this method in combination with x.months, use months_since instead!
+  # Returns a new DateTime representing the time a number of seconds since the
+  # instance time. Do not use this method in combination with x.months, use
+  # months_since instead!
   def since(seconds)
     self + Rational(seconds.round, 86400)
   end
   alias :in :since
 
-  # Returns a new DateTime representing the start of the day (0:00)
+  # Returns a new DateTime representing the start of the day (0:00).
   def beginning_of_day
     change(:hour => 0)
   end
@@ -76,74 +106,59 @@ class DateTime
   alias :at_midnight :beginning_of_day
   alias :at_beginning_of_day :beginning_of_day
 
-  # Returns a new DateTime representing the end of the day (23:59:59)
+  # Returns a new DateTime representing the end of the day (23:59:59).
   def end_of_day
     change(:hour => 23, :min => 59, :sec => 59)
   end
+  alias :at_end_of_day :end_of_day
 
-  # Returns a new DateTime representing the start of the hour (hh:00:00)
+  # Returns a new DateTime representing the start of the hour (hh:00:00).
   def beginning_of_hour
     change(:min => 0)
   end
   alias :at_beginning_of_hour :beginning_of_hour
 
-  # Returns a new DateTime representing the end of the hour (hh:59:59)
+  # Returns a new DateTime representing the end of the hour (hh:59:59).
   def end_of_hour
     change(:min => 59, :sec => 59)
   end
+  alias :at_end_of_hour :end_of_hour
 
-  # 1.9.3 defines + and - on DateTime, < 1.9.3 do not.
-  if DateTime.public_instance_methods(false).include?(:+)
-    def plus_with_duration(other) #:nodoc:
-      if ActiveSupport::Duration === other
-        other.since(self)
-      else
-        plus_without_duration(other)
-      end
-    end
-    alias_method :plus_without_duration, :+
-    alias_method :+, :plus_with_duration
-
-    def minus_with_duration(other) #:nodoc:
-      if ActiveSupport::Duration === other
-        plus_with_duration(-other)
-      else
-        minus_without_duration(other)
-      end
-    end
-    alias_method :minus_without_duration, :-
-    alias_method :-, :minus_with_duration
+  # Returns a new DateTime representing the start of the minute (hh:mm:00).
+  def beginning_of_minute
+    change(:sec => 0)
   end
+  alias :at_beginning_of_minute :beginning_of_minute
 
-  # Adjusts DateTime to UTC by adding its offset value; offset is set to 0
-  #
-  # Example:
+  # Returns a new DateTime representing the end of the minute (hh:mm:59).
+  def end_of_minute
+    change(:sec => 59)
+  end
+  alias :at_end_of_minute :end_of_minute
+
+  # Adjusts DateTime to UTC by adding its offset value; offset is set to 0.
   #
-  #   DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24))       # => Mon, 21 Feb 2005 10:11:12 -0600
-  #   DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24)).utc   # => Mon, 21 Feb 2005 16:11:12 +0000
+  #   DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24))     # => Mon, 21 Feb 2005 10:11:12 -0600
+  #   DateTime.civil(2005, 2, 21, 10, 11, 12, Rational(-6, 24)).utc # => Mon, 21 Feb 2005 16:11:12 +0000
   def utc
     new_offset(0)
   end
   alias_method :getutc, :utc
 
-  # Returns true if offset == 0
+  # Returns +true+ if <tt>offset == 0</tt>.
   def utc?
     offset == 0
   end
 
-  # Returns the offset value in seconds
+  # Returns the offset value in seconds.
   def utc_offset
     (offset * 86400).to_i
   end
 
-  # Layers additional behavior on DateTime#<=> so that Time and ActiveSupport::TimeWithZone instances can be compared with a DateTime
+  # Layers additional behavior on DateTime#<=> so that Time and
+  # ActiveSupport::TimeWithZone instances can be compared with a DateTime.
   def <=>(other)
-    if other.kind_of?(Infinity)
-      super
-    elsif other.respond_to? :to_datetime
-      super other.to_datetime
-    else
-      nil
-    end
+    super other.to_datetime
   end
+
 end

data/lib/active_support/core_ext/date_time/conversions.rb

@@ -4,10 +4,6 @@ require 'active_support/core_ext/date_time/calculations'
 require 'active_support/values/time_zone'
 
 class DateTime
-  # Ruby 1.9 has DateTime#to_time which internally relies on Time. We define our own #to_time which allows
-  # DateTimes outside the range of what can be created with Time.
-  remove_method :to_time if instance_methods.include?(:to_time)
-
   # Convert to a formatted string. See Time::DATE_FORMATS for predefined formats.
   #
   # This method is aliased to <tt>to_s</tt>.
@@ -30,7 +26,7 @@ class DateTime
   # datetime argument as the value.
   #
   #   # config/initializers/time_formats.rb
-  #   Time::DATE_FORMATS[:month_and_year] = "%B %Y"
+  #   Time::DATE_FORMATS[:month_and_year] = '%B %Y'
   #   Time::DATE_FORMATS[:short_ordinal] = lambda { |time| time.strftime("%B #{time.day.ordinalize}") }
   def to_formatted_s(format = :default)
     if formatter = ::Time::DATE_FORMATS[format]
@@ -39,10 +35,9 @@ class DateTime
       to_default_s
     end
   end
-  alias_method :to_default_s, :to_s unless (instance_methods(false) & [:to_s, 'to_s']).empty?
+  alias_method :to_default_s, :to_s if instance_methods(false).include?(:to_s)
   alias_method :to_s, :to_formatted_s
 
-  # Returns the +utc_offset+ as an +HH:MM formatted string. Examples:
   #
   #   datetime = DateTime.civil(2000, 1, 1, 0, 0, 0, Rational(-6, 24))
   #   datetime.formatted_offset         # => "-06:00"
@@ -58,46 +53,39 @@ class DateTime
   alias_method :default_inspect, :inspect
   alias_method :inspect, :readable_inspect
 
-  # Converts self to a Ruby Date object; time portion is discarded.
-  def to_date
-    ::Date.new(year, month, day)
-  end unless instance_methods(false).include?(:to_date)
-
-  # Attempts to convert self to a Ruby Time object; returns self if out of range of Ruby Time class.
-  # If self has an offset other than 0, self will just be returned unaltered, since there's no clean way to map it to a Time.
-  def to_time
-    self.offset == 0 ? ::Time.utc_time(year, month, day, hour, min, sec, sec_fraction * (RUBY_VERSION < '1.9' ? 86400000000 : 1000000)) : self
-  end
-
-  # To be able to keep Times, Dates and DateTimes interchangeable on conversions.
-  def to_datetime
-    self
-  end unless instance_methods(false).include?(:to_datetime)
-
+  # Returns DateTime with local offset for given year if format is local else
+  # offset is zero.
+  #
+  #   DateTime.civil_from_format :local, 2012
+  #   # => Sun, 01 Jan 2012 00:00:00 +0300
+  #   DateTime.civil_from_format :local, 2012, 12, 17
+  #   # => Mon, 17 Dec 2012 00:00:00 +0000
   def self.civil_from_format(utc_or_local, year, month=1, day=1, hour=0, min=0, sec=0)
-    offset = utc_or_local.to_sym == :local ? local_offset : 0
+    if utc_or_local.to_sym == :local
+      offset = ::Time.local(year, month, day).utc_offset.to_r / 86400
+    else
+      offset = 0
+    end
     civil(year, month, day, hour, min, sec, offset)
   end
 
-  # Converts datetime to an appropriate format for use in XML.
-  def xmlschema
-    strftime("%Y-%m-%dT%H:%M:%S%Z")
-  end unless instance_methods(false).include?(:xmlschema)
-
-  # Converts self to a floating-point number of seconds since the Unix epoch.
+  # Converts +self+ to a floating-point number of seconds since the Unix epoch.
   def to_f
     seconds_since_unix_epoch.to_f
   end
 
-  # Converts self to an integer number of seconds since the Unix epoch.
+  # Converts +self+ to an integer number of seconds since the Unix epoch.
   def to_i
     seconds_since_unix_epoch.to_i
   end
 
   private
 
+  def offset_in_seconds
+    (offset * 86400).to_i
+  end
+
   def seconds_since_unix_epoch
-    seconds_per_day = 86_400
-    (self - ::DateTime.civil(1970)) * seconds_per_day
+    (jd - 2440588) * 86400 - offset_in_seconds + seconds_since_midnight
   end
 end

data/lib/active_support/core_ext/date_time/zones.rb

@@ -6,16 +6,19 @@ class DateTime
   #   Time.zone = 'Hawaii'             # => 'Hawaii'
   #   DateTime.new(2000).in_time_zone  # => Fri, 31 Dec 1999 14:00:00 HST -10:00
   #
-  # This method is similar to Time#localtime, except that it uses <tt>Time.zone</tt> as the local zone
-  # instead of the operating system's time zone.
+  # This method is similar to Time#localtime, except that it uses <tt>Time.zone</tt>
+  # as the local zone instead of the operating system's time zone.
   #
-  # You can also pass in a TimeZone instance or string that identifies a TimeZone as an argument,
-  # and the conversion will be based on that zone instead of <tt>Time.zone</tt>.
+  # You can also pass in a TimeZone instance or string that identifies a TimeZone
+  # as an argument, and the conversion will be based on that zone instead of
+  # <tt>Time.zone</tt>.
   #
-  #   DateTime.new(2000).in_time_zone('Alaska')  # => Fri, 31 Dec 1999 15:00:00 AKST -09:00
+  #   DateTime.new(2000).in_time_zone('Alaska') # => Fri, 31 Dec 1999 15:00:00 AKST -09:00
   def in_time_zone(zone = ::Time.zone)
-    return self unless zone
-
-    ActiveSupport::TimeWithZone.new(utc? ? self : getutc, ::Time.find_zone!(zone))
+    if zone
+      ActiveSupport::TimeWithZone.new(utc? ? self : getutc, ::Time.find_zone!(zone))
+    else
+      self
+    end
   end
 end

data/lib/active_support/core_ext/date_time.rb

@@ -0,0 +1,4 @@
+require 'active_support/core_ext/date_time/acts_like'
+require 'active_support/core_ext/date_time/calculations'
+require 'active_support/core_ext/date_time/conversions'
+require 'active_support/core_ext/date_time/zones'

data/lib/active_support/core_ext/enumerable.rb

@@ -1,42 +1,5 @@
-require 'active_support/ordered_hash'
-
 module Enumerable
-  # Ruby 1.8.7 introduces group_by, but the result isn't ordered. Override it.
-  remove_method(:group_by) if [].respond_to?(:group_by) && RUBY_VERSION < '1.9'
-
-  # Collect an enumerable into sets, grouped by the result of a block. Useful,
-  # for example, for grouping records by date.
-  #
-  # Example:
-  #
-  #   latest_transcripts.group_by(&:day).each do |day, transcripts|
-  #     p "#{day} -> #{transcripts.map(&:class).join(', ')}"
-  #   end
-  #   "2006-03-01 -> Transcript"
-  #   "2006-02-28 -> Transcript"
-  #   "2006-02-27 -> Transcript, Transcript"
-  #   "2006-02-26 -> Transcript, Transcript"
-  #   "2006-02-25 -> Transcript"
-  #   "2006-02-24 -> Transcript, Transcript"
-  #   "2006-02-23 -> Transcript"
-  def group_by
-    return to_enum :group_by unless block_given?
-    assoc = ActiveSupport::OrderedHash.new
-
-    each do |element|
-      key = yield(element)
-
-      if assoc.has_key?(key)
-        assoc[key] << element
-      else
-        assoc[key] = [element]
-      end
-    end
-
-    assoc
-  end unless [].respond_to?(:group_by)
-
-  # Calculates a sum from the elements. Examples:
+  # Calculates a sum from the elements.
   #
   #  payments.sum { |p| p.price * p.tax_rate }
   #  payments.sum(&:price)
@@ -48,56 +11,38 @@ module Enumerable
   # It can also calculate the sum without the use of a block.
   #
   #  [5, 15, 10].sum # => 30
-  #  ["foo", "bar"].sum # => "foobar"
+  #  ['foo', 'bar'].sum # => "foobar"
   #  [[1, 2], [3, 1, 5]].sum => [1, 2, 3, 1, 5]
   #
   # The default sum of an empty list is zero. You can override this default:
   #
   #  [].sum(Payment.new(0)) { |i| i.amount } # => Payment.new(0)
-  #
   def sum(identity = 0, &block)
     if block_given?
       map(&block).sum(identity)
     else
-      inject(:+) || identity
+      inject { |sum, element| sum + element } || identity
     end
   end
 
-  # Iterates over a collection, passing the current element *and* the
-  # +memo+ to the block. Handy for building up hashes or
-  # reducing collections down to one object. Examples:
-  #
-  #   %w(foo bar).each_with_object({}) { |str, hsh| hsh[str] = str.upcase }
-  #   # => {'foo' => 'FOO', 'bar' => 'BAR'}
-  #
-  # *Note* that you can't use immutable objects like numbers, true or false as
-  # the memo. You would think the following returns 120, but since the memo is
-  # never changed, it does not.
-  #
-  #   (1..5).each_with_object(1) { |value, memo| memo *= value } # => 1
-  #
-  def each_with_object(memo)
-    return to_enum :each_with_object, memo unless block_given?
-    each do |element|
-      yield element, memo
-    end
-    memo
-  end unless [].respond_to?(:each_with_object)
-
-  # Convert an enumerable to a hash. Examples:
+  # Convert an enumerable to a hash.
   #
   #   people.index_by(&:login)
   #     => { "nextangle" => <Person ...>, "chade-" => <Person ...>, ...}
   #   people.index_by { |person| "#{person.first_name} #{person.last_name}" }
   #     => { "Chade- Fowlersburg-e" => <Person ...>, "David Heinemeier Hansson" => <Person ...>, ...}
-  #
   def index_by
-    return to_enum :index_by unless block_given?
-    Hash[map { |elem| [yield(elem), elem] }]
+    if block_given?
+      Hash[map { |elem| [yield(elem), elem] }]
+    else
+      to_enum :index_by
+    end
   end
 
-  # Returns true if the enumerable has more than 1 element. Functionally equivalent to enum.to_a.size > 1.
-  # Can be called with a block too, much like any?, so <tt>people.many? { |p| p.age > 26 }</tt> returns true if more than one person is over 26.
+  # Returns +true+ if the enumerable has more than 1 element. Functionally
+  # equivalent to <tt>enum.to_a.size > 1</tt>. Can be called with a block too,
+  # much like any?, so <tt>people.many? { |p| p.age > 26 }</tt> returns +true+
+  # if more than one person is over 26.
   def many?
     cnt = 0
     if block_given?
@@ -106,11 +51,12 @@ module Enumerable
         cnt > 1
       end
     else
-      any?{ (cnt += 1) > 1 }
+      any? { (cnt += 1) > 1 }
     end
   end
 
-  # The negative of the <tt>Enumerable#include?</tt>. Returns true if the collection does not include the object.
+  # The negative of the <tt>Enumerable#include?</tt>. Returns +true+ if the
+  # collection does not include the object.
   def exclude?(object)
     !include?(object)
   end
@@ -120,8 +66,15 @@ class Range #:nodoc:
   # Optimize range sum to use arithmetic progression if a block is not given and
   # we have a range of numeric values.
   def sum(identity = 0)
-    return super if block_given? || !(first.instance_of?(Integer) && last.instance_of?(Integer))
-    actual_last = exclude_end? ? (last - 1) : last
-    (actual_last - first + 1) * (actual_last + first) / 2
+    if block_given? || !(first.is_a?(Integer) && last.is_a?(Integer))
+      super
+    else
+      actual_last = exclude_end? ? (last - 1) : last
+      if actual_last >= first
+        (actual_last - first + 1) * (actual_last + first) / 2
+      else
+        identity
+      end
+    end
   end
 end

data/lib/active_support/core_ext/file/atomic.rb

@@ -1,16 +1,18 @@
+require 'fileutils'
+
 class File
   # Write to a file atomically. Useful for situations where you don't
   # want other processes or threads to see half-written files.
   #
-  #   File.atomic_write("important.file") do |file|
-  #     file.write("hello")
+  #   File.atomic_write('important.file') do |file|
+  #     file.write('hello')
   #   end
   #
   # If your temp directory is not on the same filesystem as the file you're
   # trying to write, you can provide a different temporary directory.
   #
-  #   File.atomic_write("/data/something.important", "/data/tmp") do |file|
-  #     file.write("hello")
+  #   File.atomic_write('/data/something.important', '/data/tmp') do |file|
+  #     file.write('hello')
   #   end
   def self.atomic_write(file_name, temp_dir = Dir.tmpdir)
     require 'tempfile' unless defined?(Tempfile)
@@ -21,15 +23,13 @@ class File
     yield temp_file
     temp_file.close
 
-    begin
+    if File.exists?(file_name)
       # Get original file permissions
       old_stat = stat(file_name)
-    rescue Errno::ENOENT
-      # No old permissions, write a temp file to determine the defaults
-      check_name = join(dirname(file_name), ".permissions_check.#{Thread.current.object_id}.#{Process.pid}.#{rand(1000000)}")
-      open(check_name, "w") { }
-      old_stat = stat(check_name)
-      unlink(check_name)
+    else
+      # If not possible, probe which are the default permissions in the
+      # destination directory.
+      old_stat = probe_stat_in(dirname(file_name))
     end
 
     # Overwrite original file with temp file
@@ -44,4 +44,20 @@ class File
       # Changing file ownership failed, moving on.
     end
   end
+
+  # Private utility method.
+  def self.probe_stat_in(dir) #:nodoc:
+    basename = [
+      '.permissions_check',
+      Thread.current.object_id,
+      Process.pid,
+      rand(1000000)
+    ].join('.')
+
+    file_name = join(dir, basename)
+    FileUtils.touch(file_name)
+    stat(file_name)
+  ensure
+    FileUtils.rm_f(file_name) if file_name
+  end
 end

data/lib/active_support/core_ext/file.rb

@@ -1,2 +1 @@
 require 'active_support/core_ext/file/atomic'
-require 'active_support/core_ext/file/path'