activesupport 3.0.20 → 3.1.0

data/CHANGELOG

@@ -1,48 +1,44 @@
-## Rails 3.0.20 (unreleased)
+*Rails 3.1.0 (unreleased)*
 
-## Rails 3.0.19 (Jan 8, 2013)
+* ActiveSupport::Dependencies#load and ActiveSupport::Dependencies#require now
+return the value from `super` [Aaron Patterson]
 
-* Hash.from_xml raises when it encounters type="symbol" or type="yaml".
-  Use Hash.from_trusted_xml to parse this XML.
+* Fixed ActiveSupport::Gzip to work properly in Ruby 1.8 [Guillermo Iguaran]
 
-  CVE-2013-0156
+* Kernel.require_library_or_gem was deprecated and will be removed in Rails 3.2.0 [Josh Kalderimis]
 
-  *Jeremy Kemper*
+* ActiveSupport::Duration#duplicable? was fixed for Ruby 1.8 [thedarkone]
 
-## Rails 3.0.18 (Jan 2, 2013)
+* ActiveSupport::BufferedLogger set log encoding to BINARY, but still use text
+mode to output portable newlines. [fxn]
 
-* No changes.
-
-## Rails 3.0.17 (Aug 9, 2012)
-
-* ERB::Util.html_escape now escapes single quotes. [Santiago Pastorino]
-
-## Rails 3.0.16 (Jul 26, 2012)
-
-* No changes.
+* ActiveSupport::Dependencies now raises NameError if it finds an existing constant in load_missing_constant. This better reflects the nature of the error which is usually caused by calling constantize on a nested constant. [Andrew White]
 
-## Rails 3.0.14 (Jun 12, 2012)
+* Deprecated ActiveSupport::SecureRandom in favour of SecureRandom from the standard library [Jon Leighton]
 
-* No changes.
+* New reporting method Kernel#quietly. [fxn]
 
-* Rails 3.0.13 (May 31, 2012)
+* Add String#inquiry as a convenience method for turning a string into a StringInquirer object [DHH]
 
-* Stop SafeBuffer#clone_empty from issuing warnings
+* Add Object#in? to test if an object is included in another object [Prem Sichanugrist, Brian Morearty, John Reitano]
 
-* Rails 3.0.10 (August 16, 2011)
+* LocalCache strategy is now a real middleware class, not an anonymous class
+posing for pictures.
 
-* Delayed backtrace scrubbing in `load_missing_constant` until we actually
-  raise the exception
+* ActiveSupport::Dependencies::ClassCache class has been introduced for
+holding references to reloadable classes.
 
+* ActiveSupport::Dependencies::Reference has been refactored to take direct
+advantage of the new ClassCache.
 
-*Rails 3.0.9 (June 16, 2011)*
+* Backports Range#cover? as an alias for Range#include? in Ruby 1.8 [Diego Carrion, fxn]
 
-*No changes.
+* Added weeks_ago and prev_week to Date/DateTime/Time. [Rob Zolkos, fxn]
 
+* Added before_remove_const callback to ActiveSupport::Dependencies.remove_unloadable_constants! [Andrew White]
 
-*Rails 3.0.8 (June 7, 2011)*
+* JSON decoding now uses the multi_json gem which also vendors a json engine called OkJson. The yaml backend has been removed in favor of OkJson as a default engine for 1.8.x, while the built in 1.9.x json implementation will be used by default. [Josh Kalderimis]
 
-* No changes.
 
 *Rails 3.0.7 (April 18, 2011)*
 
@@ -76,7 +72,7 @@
 
 *Rails 3.0.1 (October 15, 2010)*
 
-* No changes.
+* No Changes, just a version bump.
 
 
 *Rails 3.0.0 (August 29, 2010)*

data/README.rdoc

@@ -14,7 +14,7 @@ The latest version of Active Support can be installed with Rubygems:
 
 Source code can be downloaded as part of the Rails project on GitHub
 
-* http://github.com/rails/rails/tree/master/activesupport/
+* https://github.com/rails/rails/tree/master/activesupport
 
 
 == License
@@ -30,4 +30,4 @@ API documentation is at
 
 Bug reports and feature requests can be filed with the rest for the Ruby on Rails project here:
 
-* https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets
+* https://github.com/rails/rails/issues

data/lib/active_support/backtrace_cleaner.rb

@@ -1,27 +1,32 @@
 module ActiveSupport
-  # Many backtraces include too much information that's not relevant for the context. This makes it hard to find the signal
-  # in the backtrace and adds debugging time. With a BacktraceCleaner, you can setup filters and silencers for your particular
-  # context, so only the relevant lines are included.
+  # Backtraces often include many lines that are not relevant for the context under review. This makes it hard to find the 
+  # signal amongst the backtrace noise, and adds debugging time. With a BacktraceCleaner, filters and silencers are used to
+  # remove the noisy lines, so that only the most relevant lines remain.
   #
-  # If you need to reconfigure an existing BacktraceCleaner, like the one in Rails, to show as much as possible, you can always
-  # call BacktraceCleaner#remove_silencers! Also, if you need to reconfigure an existing BacktraceCleaner so that it does not
-  # filter or modify the paths of any lines of the backtrace, you can call BacktraceCleaner#remove_filters! These two methods
-  # will give you a completely untouched backtrace.
+  # Filters are used to modify lines of data, while silencers are used to remove lines entirely.  The typical filter use case
+  # is to remove lengthy path information from the start of each line, and view file paths relevant to the app directory 
+  # instead of the file system root.  The typical silencer use case is to exclude the output of a noisy library from the 
+  # backtrace, so that you can focus on the rest.
   #
-  # Example:
+  # ==== Example:
   #
   #   bc = BacktraceCleaner.new
   #   bc.add_filter   { |line| line.gsub(Rails.root, '') }
   #   bc.add_silencer { |line| line =~ /mongrel|rubygems/ }
   #   bc.clean(exception.backtrace) # will strip the Rails.root prefix and skip any lines from mongrel or rubygems
   #
+  # To reconfigure an existing BacktraceCleaner (like the default one in Rails) and show as much data as possible, you can 
+  # always call <tt>BacktraceCleaner#remove_silencers!</tt>, which will restore the backtrace to a pristine state.  If you 
+  # need to reconfigure an existing BacktraceCleaner so that it does not filter or modify the paths of any lines of the 
+  # backtrace, you can call BacktraceCleaner#remove_filters! These two methods will give you a completely untouched backtrace.
+  #
   # Inspired by the Quiet Backtrace gem by Thoughtbot.
   class BacktraceCleaner
     def initialize
       @filters, @silencers = [], []
     end
 
-    # Returns the backtrace after all filters and silencers has been run against it. Filters run first, then silencers.
+    # Returns the backtrace after all filters and silencers have been run against it. Filters run first, then silencers.
     def clean(backtrace, kind = :silent)
       filtered = filter(backtrace)
 
@@ -45,8 +50,8 @@ module ActiveSupport
       @filters << block
     end
 
-    # Adds a silencer from the block provided. If the silencer returns true for a given line, it'll be excluded from the
-    # clean backtrace.
+    # Adds a silencer from the block provided. If the silencer returns true for a given line, it will be excluded from 
+    # the clean backtrace.
     #
     # Example:
     #
@@ -57,7 +62,7 @@ module ActiveSupport
     end
 
     # Will remove all silencers, but leave in the filters. This is useful if your context of debugging suddenly expands as
-    # you suspect a bug in the libraries you use.
+    # you suspect a bug in one of the libraries you use.
     def remove_silencers!
       @silencers = []
     end

data/lib/active_support/buffered_logger.rb

@@ -55,6 +55,13 @@ module ActiveSupport
       end
     end
 
+    def open_log(log, mode)
+      open(log, mode).tap do |open_log|
+        open_log.set_encoding(Encoding::BINARY) if open_log.respond_to?(:set_encoding)
+        open_log.sync = true
+      end
+    end
+
     def add(severity, message = nil, progname = nil, &block)
       return if @level > severity
       message = (message || (block && block.call) || progname).to_s
@@ -126,14 +133,5 @@ module ActiveSupport
       def clear_buffer
         @buffer.delete(Thread.current)
       end
-
-    private
-
-    def open_log(log, mode)
-      open(log, mode).tap do |log|
-        log.set_encoding(Encoding::BINARY) if log.respond_to?(:set_encoding)
-        log.sync = true
-      end
-    end
   end
 end

data/lib/active_support/cache/file_store.rb

@@ -1,5 +1,6 @@
 require 'active_support/core_ext/file/atomic'
 require 'active_support/core_ext/string/conversions'
+require 'active_support/core_ext/object/inclusion'
 require 'rack/utils'
 
 module ActiveSupport
@@ -15,12 +16,12 @@ module ActiveSupport
 
       def initialize(cache_path, options = nil)
         super(options)
-        @cache_path = cache_path
+        @cache_path = cache_path.to_s
         extend Strategy::LocalCache
       end
 
       def clear(options = nil)
-        root_dirs = Dir.entries(cache_path).reject{|f| ['.', '..'].include?(f)}
+        root_dirs = Dir.entries(cache_path).reject{|f| f.in?(['.', '..'])}
         FileUtils.rm_r(root_dirs.collect{|f| File.join(cache_path, f)})
       end
 
@@ -161,7 +162,7 @@ module ActiveSupport
         # Delete empty directories in the cache.
         def delete_empty_directories(dir)
           return if dir == cache_path
-          if Dir.entries(dir).reject{|f| ['.', '..'].include?(f)}.empty?
+          if Dir.entries(dir).reject{|f| f.in?(['.', '..'])}.empty?
             File.delete(dir) rescue nil
             delete_empty_directories(File.dirname(dir))
           end

data/lib/active_support/cache/mem_cache_store.rb

@@ -4,7 +4,9 @@ rescue LoadError => e
   $stderr.puts "You don't have memcache-client installed in your application. Please add it to your Gemfile and run bundle install"
   raise e
 end
+
 require 'digest/md5'
+require 'active_support/core_ext/string/encoding'
 
 module ActiveSupport
   module Cache
@@ -73,7 +75,7 @@ module ActiveSupport
       def read_multi(*names)
         options = names.extract_options!
         options = merged_options(options)
-        keys_to_names = names.inject({}){|map, name| map[escape_key(namespaced_key(name, options))] = name; map}
+        keys_to_names = Hash[names.map{|name| [escape_key(namespaced_key(name, options)), name]}]
         raw_values = @data.get_multi(keys_to_names.keys, :raw => true)
         values = {}
         raw_values.each do |key, value|
@@ -157,8 +159,14 @@ module ActiveSupport
         end
 
       private
+
+        # Memcache keys are binaries. So we need to force their encoding to binary
+        # before applying the regular expression to ensure we are escaping all
+        # characters properly.
         def escape_key(key)
-          key = key.to_s.gsub(ESCAPE_KEY_CHARS){|match| "%#{match.getbyte(0).to_s(16).upcase}"}
+          key = key.to_s.dup
+          key = key.force_encoding("BINARY") if key.encoding_aware?
+          key = key.gsub(ESCAPE_KEY_CHARS){ |match| "%#{match.getbyte(0).to_s(16).upcase}" }
           key = "#{key[0, 213]}:md5:#{Digest::MD5.hexdigest(key)}" if key.size > 250
           key
         end

data/lib/active_support/cache/strategy/local_cache.rb

@@ -50,34 +50,39 @@ module ActiveSupport
           end
         end
 
-        # Middleware class can be inserted as a Rack handler to be local cache for the
-        # duration of request.
-        def middleware
-          @middleware ||= begin
-            klass = Class.new
-            klass.class_eval(<<-EOS, __FILE__, __LINE__ + 1)
-              class << self
-                def name
-                  "ActiveSupport::Cache::Strategy::LocalCache"
-                end
-                alias :to_s :name
-              end
+        #--
+        # This class wraps up local storage for middlewares. Only the middleware method should
+        # construct them.
+        class Middleware # :nodoc:
+          attr_reader :name, :thread_local_key
 
-              def initialize(app)
-                @app = app
-              end
+          def initialize(name, thread_local_key)
+            @name             = name
+            @thread_local_key = thread_local_key
+            @app              = nil
+          end
 
-              def call(env)
-                Thread.current[:#{thread_local_key}] = LocalStore.new
-                @app.call(env)
-              ensure
-                Thread.current[:#{thread_local_key}] = nil
-              end
-            EOS
-            klass
+          def new(app)
+            @app = app
+            self
+          end
+
+          def call(env)
+            Thread.current[thread_local_key] = LocalStore.new
+            @app.call(env)
+          ensure
+            Thread.current[thread_local_key] = nil
           end
         end
 
+        # Middleware class can be inserted as a Rack handler to be local cache for the
+        # duration of request.
+        def middleware
+          @middleware ||= Middleware.new(
+            "ActiveSupport::Cache::Strategy::LocalCache",
+            thread_local_key)
+        end
+
         def clear(options = nil) # :nodoc:
           local_cache.clear(options) if local_cache
           super

data/lib/active_support/cache.rb

@@ -484,19 +484,20 @@ module ActiveSupport
         # object responds to +cache_key+. Otherwise, to_param method will be
         # called. If the key is a Hash, then keys will be sorted alphabetically.
         def expanded_key(key) # :nodoc:
-          if key.respond_to?(:cache_key)
-            key = key.cache_key.to_s
-          elsif key.is_a?(Array)
+          return key.cache_key.to_s if key.respond_to?(:cache_key)
+
+          case key
+          when Array
             if key.size > 1
-              key.collect{|element| expanded_key(element)}.to_param
+              key = key.collect{|element| expanded_key(element)}
             else
-              key.first.to_param
+              key = key.first
             end
-          elsif key.is_a?(Hash)
-            key = key.to_a.sort{|a,b| a.first.to_s <=> b.first.to_s}.collect{|k,v| "#{k}=#{v}"}.to_param
-          else
-            key = key.to_param
+          when Hash
+            key = key.sort_by { |k,_| k.to_s }.collect{|k,v| "#{k}=#{v}"}
           end
+
+          key.to_param
         end
 
         # Prefix a key with the namespace. Namespace and key will be delimited with a colon.
@@ -589,11 +590,7 @@ module ActiveSupport
       # Check if the entry is expired. The +expires_in+ parameter can override the
       # value set when the entry was created.
       def expired?
-        if @expires_in && @created_at + @expires_in <= Time.now.to_f
-          true
-        else
-          false
-        end
+        @expires_in && @created_at + @expires_in <= Time.now.to_f
       end
 
       # Set a new time when the entry will expire.