activesupport 3.1.0 → 5.0.0

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

@@ -1,13 +1,10 @@
+require 'date'
 require 'active_support/inflector/methods'
 require 'active_support/core_ext/time/conversions'
 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>.
@@ -22,6 +19,7 @@ class DateTime
   #   datetime.to_formatted_s(:long)          # => "December 04, 2007 00:00"
   #   datetime.to_formatted_s(:long_ordinal)  # => "December 4th, 2007 00:00"
   #   datetime.to_formatted_s(:rfc822)        # => "Tue, 04 Dec 2007 00:00:00 +0000"
+  #   datetime.to_formatted_s(:iso8601)       # => "2007-12-04T00:00:00+00:00"
   #
   # == Adding your own datetime formats to to_formatted_s
   # DateTime formats are shared with Time. You can add your own to the
@@ -30,7 +28,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 +37,11 @@ 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:
+  # Returns a formatted string of the offset from UTC, or an alternative
+  # string if the time zone is already UTC.
   #
   #   datetime = DateTime.civil(2000, 1, 1, 0, 0, 0, Rational(-6, 24))
   #   datetime.formatted_offset         # => "-06:00"
@@ -58,46 +57,49 @@ 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, including fractional microseconds, since the Unix epoch.
   def to_f
-    seconds_since_unix_epoch.to_f
+    seconds_since_unix_epoch.to_f + sec_fraction
   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
 
+  # Returns the fraction of a second as microseconds
+  def usec
+    (sec_fraction * 1_000_000).to_i
+  end
+
+  # Returns the fraction of a second as nanoseconds
+  def nsec
+    (sec_fraction * 1_000_000_000).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.rb

@@ -0,0 +1,5 @@
+require 'active_support/core_ext/date_time/acts_like'
+require 'active_support/core_ext/date_time/blank'
+require 'active_support/core_ext/date_time/calculations'
+require 'active_support/core_ext/date_time/compatibility'
+require 'active_support/core_ext/date_time/conversions'

data/lib/active_support/core_ext/digest/uuid.rb

@@ -0,0 +1,51 @@
+require 'securerandom'
+
+module Digest
+  module UUID
+    DNS_NAMESPACE  = "k\xA7\xB8\x10\x9D\xAD\x11\xD1\x80\xB4\x00\xC0O\xD40\xC8" #:nodoc:
+    URL_NAMESPACE  = "k\xA7\xB8\x11\x9D\xAD\x11\xD1\x80\xB4\x00\xC0O\xD40\xC8" #:nodoc:
+    OID_NAMESPACE  = "k\xA7\xB8\x12\x9D\xAD\x11\xD1\x80\xB4\x00\xC0O\xD40\xC8" #:nodoc:
+    X500_NAMESPACE = "k\xA7\xB8\x14\x9D\xAD\x11\xD1\x80\xB4\x00\xC0O\xD40\xC8" #:nodoc:
+
+    # Generates a v5 non-random UUID (Universally Unique IDentifier).
+    #
+    # Using Digest::MD5 generates version 3 UUIDs; Digest::SHA1 generates version 5 UUIDs.
+    # uuid_from_hash always generates the same UUID for a given name and namespace combination.
+    #
+    # See RFC 4122 for details of UUID at: http://www.ietf.org/rfc/rfc4122.txt
+    def self.uuid_from_hash(hash_class, uuid_namespace, name)
+      if hash_class == Digest::MD5
+        version = 3
+      elsif hash_class == Digest::SHA1
+        version = 5
+      else
+        raise ArgumentError, "Expected Digest::SHA1 or Digest::MD5, got #{hash_class.name}."
+      end
+
+      hash = hash_class.new
+      hash.update(uuid_namespace)
+      hash.update(name)
+
+      ary = hash.digest.unpack('NnnnnN')
+      ary[2] = (ary[2] & 0x0FFF) | (version << 12)
+      ary[3] = (ary[3] & 0x3FFF) | 0x8000
+
+      "%08x-%04x-%04x-%04x-%04x%08x" % ary
+    end
+
+    # Convenience method for uuid_from_hash using Digest::MD5.
+    def self.uuid_v3(uuid_namespace, name)
+      self.uuid_from_hash(Digest::MD5, uuid_namespace, name)
+    end
+
+    # Convenience method for uuid_from_hash using Digest::SHA1.
+    def self.uuid_v5(uuid_namespace, name)
+      self.uuid_from_hash(Digest::SHA1, uuid_namespace, name)
+    end
+
+    # Convenience method for SecureRandom.uuid.
+    def self.uuid_v4
+      SecureRandom.uuid
+    end
+  end
+end

data/lib/active_support/core_ext/enumerable.rb

@@ -1,41 +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
-    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)
@@ -47,71 +11,114 @@ 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)
+  def sum(identity = nil, &block)
     if block_given?
       map(&block).sum(identity)
     else
-      inject { |sum, element| sum + element } || identity
+      sum = identity ? inject(identity, :+) : inject(:+)
+      sum || identity || 0
     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, &block)
-    each do |element|
-      block.call(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
-    Hash[map { |elem| [yield(elem), elem] }]
+    if block_given?
+      Hash[map { |elem| [yield(elem), elem] }]
+    else
+      to_enum(:index_by) { size if respond_to?(:size) }
+    end
   end
 
-  # Returns true if the collection has more than 1 element. Functionally equivalent to collection.size > 1.
-  # Can be called with a block too, much like any?, so people.many? { |p| p.age > 26 } returns true if more than 1 person is over 26.
-  def many?(&block)
-    size = block_given? ? count(&block) : self.size
-    size > 1
+  # 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?
+      any? do |element|
+        cnt += 1 if yield element
+        cnt > 1
+      end
+    else
+      any? { (cnt += 1) > 1 }
+    end
   end
 
-  # The negative of the Enumerable#include?. 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
+
+  # Returns a copy of the enumerable without the specified elements.
+  #
+  #   ["David", "Rafael", "Aaron", "Todd"].without "Aaron", "Todd"
+  #     => ["David", "Rafael"]
+  #
+  #   {foo: 1, bar: 2, baz: 3}.without :bar
+  #     => {foo: 1, baz: 3}
+  def without(*elements)
+    reject { |element| elements.include?(element) }
+  end
+
+  # Convert an enumerable to an array based on the given key.
+  #
+  #   [{ name: "David" }, { name: "Rafael" }, { name: "Aaron" }].pluck(:name)
+  #     => ["David", "Rafael", "Aaron"]
+  #
+  #   [{ id: 1, name: "David" }, { id: 2, name: "Rafael" }].pluck(:id, :name)
+  #     => [[1, "David"], [2, "Rafael"]]
+  def pluck(*keys)
+    if keys.many?
+      map { |element| keys.map { |key| element[key] } }
+    else
+      map { |element| element[keys.first] }
+    end
+  end
 end
 
 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
+  def sum(identity = nil)
+    if block_given? || !(first.is_a?(Integer) && last.is_a?(Integer))
+      super
+    else
+      actual_last = exclude_end? ? (last - 1) : last
+      if actual_last >= first
+        sum = identity || 0
+        sum + (actual_last - first + 1) * (actual_last + first) / 2
+      else
+        identity || 0
+      end
+    end
+  end
+end
+
+# Array#sum was added in Ruby 2.4 but it only works with Numeric elements.
+#
+# We tried shimming it to attempt the fast native method, rescue TypeError,
+# and fall back to the compatible implementation, but that's much slower than
+# just calling the compat method in the first place.
+if Array.instance_methods(false).include?(:sum) && !(%w[a].sum rescue false)
+  class Array
+    remove_method :sum
+
+    def sum(*args) #:nodoc:
+      # Use Enumerable#sum instead.
+      super
+    end
   end
 end

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

@@ -1,41 +1,68 @@
+require 'fileutils'
+
 class File
-  # Write to a file atomically.  Useful for situations where you don't
+  # 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.
+  # This method needs to create a temporary file. By default it will create it
+  # in the same directory as the destination file. If you don't like this
+  # behavior you can provide a different directory but it must be on the
+  # same physical filesystem as the file you're trying to write.
   #
-  #   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)
+  def self.atomic_write(file_name, temp_dir = dirname(file_name))
     require 'tempfile' unless defined?(Tempfile)
-    require 'fileutils' unless defined?(FileUtils)
 
-    temp_file = Tempfile.new(basename(file_name), temp_dir)
-    yield temp_file
-    temp_file.close
+    Tempfile.open(".#{basename(file_name)}", temp_dir) do |temp_file|
+      temp_file.binmode
+      return_val = yield temp_file
+      temp_file.close
+
+      old_stat = if exist?(file_name)
+        # Get original file permissions
+        stat(file_name)
+      elsif temp_dir != dirname(file_name)
+        # If not possible, probe which are the default permissions in the
+        # destination directory.
+        probe_stat_in(dirname(file_name))
+      end
 
-    begin
-      # 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)
+      if old_stat
+        # Set correct permissions on new file
+        begin
+          chown(old_stat.uid, old_stat.gid, temp_file.path)
+          # This operation will affect filesystem ACL's
+          chmod(old_stat.mode, temp_file.path)
+        rescue Errno::EPERM, Errno::EACCES
+          # Changing file ownership failed, moving on.
+        end
+      end
+
+      # Overwrite original file with temp file
+      rename(temp_file.path, file_name)
+      return_val
     end
+  end
 
-    # Overwrite original file with temp file
-    FileUtils.mv(temp_file.path, file_name)
+  # Private utility method.
+  def self.probe_stat_in(dir) #:nodoc:
+    basename = [
+      '.permissions_check',
+      Thread.current.object_id,
+      Process.pid,
+      rand(1000000)
+    ].join('.')
 
-    # Set correct permissions on new file
-    chown(old_stat.uid, old_stat.gid, file_name)
-    chmod(old_stat.mode, file_name)
+    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'

data/lib/active_support/core_ext/hash/compact.rb

@@ -0,0 +1,20 @@
+class Hash
+  # Returns a hash with non +nil+ values.
+  #
+  #   hash = { a: true, b: false, c: nil}
+  #   hash.compact # => { a: true, b: false}
+  #   hash # => { a: true, b: false, c: nil}
+  #   { c: nil }.compact # => {}
+  def compact
+    self.select { |_, value| !value.nil? }
+  end
+
+  # Replaces current hash with non +nil+ values.
+  #
+  #   hash = { a: true, b: false, c: nil}
+  #   hash.compact! # => { a: true, b: false}
+  #   hash # => { a: true, b: false}
+  def compact!
+    self.reject! { |_, value| value.nil? }
+  end
+end