activesupport 3.0.pre → 3.0.0.rc

data/lib/active_support/json/backends/jsongem.rb

@@ -23,15 +23,18 @@ module ActiveSupport
       private
         def convert_dates_from(data)
           case data
-            when DATE_REGEX
-              DateTime.parse(data)
-            when Array
-              data.map! { |d| convert_dates_from(d) }
-            when Hash
-              data.each do |key, value|
-                data[key] = convert_dates_from(value)
-              end
-            else data
+          when nil
+            nil
+          when DATE_REGEX
+            DateTime.parse(data)
+          when Array
+            data.map! { |d| convert_dates_from(d) }
+          when Hash
+            data.each do |key, value|
+              data[key] = convert_dates_from(value)
+            end
+          else
+            data
           end
         end
       end

data/lib/active_support/json/backends/yajl.rb

@@ -0,0 +1,40 @@
+require 'yajl' unless defined?(Yajl)
+
+module ActiveSupport
+  module JSON
+    module Backends
+      module Yajl
+        ParseError = ::Yajl::ParseError
+        extend self
+
+        # Parses a JSON string or IO and convert it into an object
+        def decode(json)
+          data = ::Yajl::Parser.new.parse(json)
+          if ActiveSupport.parse_json_times
+            convert_dates_from(data)
+          else
+            data
+          end
+        end
+
+      private
+        def convert_dates_from(data)
+          case data
+          when nil
+            nil
+          when DATE_REGEX
+            DateTime.parse(data)
+          when Array
+            data.map! { |d| convert_dates_from(d) }
+          when Hash
+            data.each do |key, value|
+              data[key] = convert_dates_from(value)
+            end
+          else
+            data
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_support/json/backends/yaml.rb

@@ -13,7 +13,7 @@ module ActiveSupport
             json = json.read
           end
           YAML.load(convert_json_to_yaml(json))
-        rescue ArgumentError => e
+        rescue ArgumentError
           raise ParseError, "Invalid JSON string"
         end
 

data/lib/active_support/json/decoding.rb

@@ -6,12 +6,15 @@ module ActiveSupport
   mattr_accessor :parse_json_times
 
   module JSON
+    # Listed in order of preference.
+    DECODERS = %w(Yajl Yaml)
+
     class << self
       attr_reader :parse_error
       delegate :decode, :to => :backend
 
       def backend
-        self.backend = "Yaml" unless defined?(@backend)
+        set_default_backend unless defined?(@backend)
         @backend
       end
 
@@ -19,7 +22,7 @@ module ActiveSupport
         if name.is_a?(Module)
           @backend = name
         else
-          require "active_support/json/backends/#{name.to_s.downcase}.rb"
+          require "active_support/json/backends/#{name.to_s.downcase}"
           @backend = ActiveSupport::JSON::Backends::const_get(name)
         end
         @parse_error = @backend::ParseError
@@ -31,6 +34,18 @@ module ActiveSupport
       ensure
         self.backend = old_backend
       end
+
+      def set_default_backend
+        DECODERS.find do |name|
+          begin
+            self.backend = name
+            true
+          rescue LoadError
+            # Try next decoder.
+            false
+          end
+        end
+      end
     end
   end
 end

data/lib/active_support/json/encoding.rb

@@ -1,21 +1,18 @@
-# encoding: utf-8
+require 'active_support/core_ext/object/to_json'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/deprecation'
+require 'active_support/json/variable'
+
+require 'bigdecimal'
+require 'active_support/core_ext/big_decimal/conversions' # for #to_s
 require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/hash/slice'
-require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/object/instance_variables'
-require 'active_support/deprecation'
-
-require 'active_support/core_ext/date_time/conversions'
+require 'time'
 require 'active_support/core_ext/time/conversions'
-require 'active_support/time_with_zone'
-require 'active_support/values/time_zone'
-
-# Hack to load json gem first so we can overwrite its to_json.
-begin
-  require 'json'
-rescue LoadError
-end
+require 'active_support/core_ext/date_time/conversions'
+require 'active_support/core_ext/date/conversions'
 
 module ActiveSupport
   class << self
@@ -68,6 +65,15 @@ module ActiveSupport
 
 
       ESCAPED_CHARS = {
+        "\x00" => '\u0000', "\x01" => '\u0001', "\x02" => '\u0002',
+        "\x03" => '\u0003', "\x04" => '\u0004', "\x05" => '\u0005',
+        "\x06" => '\u0006', "\x07" => '\u0007', "\x0B" => '\u000B',
+        "\x0E" => '\u000E', "\x0F" => '\u000F', "\x10" => '\u0010',
+        "\x11" => '\u0011', "\x12" => '\u0012', "\x13" => '\u0013',
+        "\x14" => '\u0014', "\x15" => '\u0015', "\x16" => '\u0016',
+        "\x17" => '\u0017', "\x18" => '\u0018', "\x19" => '\u0019',
+        "\x1A" => '\u001A', "\x1B" => '\u001B', "\x1C" => '\u001C',
+        "\x1D" => '\u001D', "\x1E" => '\u001E', "\x1F" => '\u001F',
         "\010" =>  '\b',
         "\f"   =>  '\f',
         "\n"   =>  '\n',
@@ -89,14 +95,16 @@ module ActiveSupport
         def escape_html_entities_in_json=(value)
           self.escape_regex = \
             if @escape_html_entities_in_json = value
-              /[\010\f\n\r\t"\\><&]/
+              /[\x00-\x1F"\\><&]/
             else
-              /[\010\f\n\r\t"\\]/
+              /[\x00-\x1F"\\]/
             end
         end
 
         def escape(string)
-          string = string.dup.force_encoding(::Encoding::BINARY) if string.respond_to?(:force_encoding)
+          if string.respond_to?(:force_encoding)
+            string = string.encode(::Encoding::UTF_8, :undef => :replace).force_encoding(::Encoding::BINARY)
+          end
           json = string.
             gsub(escape_regex) { |s| ESCAPED_CHARS[s] }.
             gsub(/([\xC0-\xDF][\x80-\xBF]|
@@ -104,11 +112,14 @@ module ActiveSupport
                    [\xF0-\xF7][\x80-\xBF]{3})+/nx) { |s|
             s.unpack("U*").pack("n*").unpack("H*")[0].gsub(/.{4}/n, '\\\\u\&')
           }
-          %("#{json}")
+          json = %("#{json}")
+          json.force_encoding(::Encoding::UTF_8) if json.respond_to?(:force_encoding)
+          json
         end
       end
 
-      self.escape_html_entities_in_json = true
+      self.use_standard_json_time_format = true
+      self.escape_html_entities_in_json  = false
     end
 
     CircularReferenceError = Deprecation::DeprecatedConstantProxy.new('ActiveSupport::JSON::CircularReferenceError', Encoding::CircularReferenceError)
@@ -116,18 +127,13 @@ module ActiveSupport
 end
 
 class Object
-  # Dumps object in JSON (JavaScript Object Notation). See www.json.org for more info.
-  def to_json(options = nil)
-    ActiveSupport::JSON.encode(self, options)
+  def as_json(options = nil) #:nodoc:
+    if respond_to?(:to_hash)
+      to_hash
+    else
+      instance_values
+    end
   end
-
-  def as_json(options = nil) instance_values end #:nodoc:
-end
-
-# A string that returns itself as its JSON-encoded form.
-class ActiveSupport::JSON::Variable < String
-  def as_json(options = nil) self end #:nodoc:
-  def encode_json(encoder) self end #:nodoc:
 end
 
 class TrueClass
@@ -159,9 +165,20 @@ class Numeric
   def encode_json(encoder) to_s end #:nodoc:
 end
 
+class BigDecimal
+  # A BigDecimal would be naturally represented as a JSON number. Most libraries,
+  # however, parse non-integer JSON numbers directly as floats. Clients using
+  # those libraries would get in general a wrong number and no way to recover
+  # other than manually inspecting the string with the JSON code itself.
+  #
+  # That's why a JSON string is returned. The JSON literal is not numeric, but if
+  # the other end knows by contract that the data is supposed to be a BigDecimal,
+  # it still has the chance to post-process the string and get the real value.
+  def as_json(options = nil) to_s end #:nodoc:
+end
+
 class Regexp
-  def as_json(options = nil) self end #:nodoc:
-  def encode_json(encoder) inspect end #:nodoc:
+  def as_json(options = nil) to_s end #:nodoc:
 end
 
 module Enumerable

data/lib/active_support/json/variable.rb

@@ -2,10 +2,8 @@ module ActiveSupport
   module JSON
     # A string that returns itself as its JSON-encoded form.
     class Variable < String
-      private
-        def rails_to_json(*)
-          self
-        end
+      def as_json(options = nil) self end #:nodoc:
+      def encode_json(encoder) self end #:nodoc:
     end
   end
 end

data/lib/active_support/lazy_load_hooks.rb

@@ -0,0 +1,27 @@
+module ActiveSupport
+  @load_hooks = Hash.new {|h,k| h[k] = [] }
+  @loaded = {}
+
+  def self.on_load(name, options = {}, &block)
+    if base = @loaded[name]
+      execute_hook(base, options, block)
+    else
+      @load_hooks[name] << [block, options]
+    end
+  end
+
+  def self.execute_hook(base, options, block)
+    if options[:yield]
+      block.call(base)
+    else
+      base.instance_eval(&block)
+    end
+  end
+
+  def self.run_load_hooks(name, base = Object)
+    @loaded[name] = base
+    @load_hooks[name].each do |hook, options|
+      execute_hook(base, options, hook)
+    end
+  end
+end

data/lib/active_support/locale/en.yml

@@ -14,8 +14,11 @@ en:
     # Don't forget the nil at the beginning; there's no such thing as a 0th month
     month_names: [~, January, February, March, April, May, June, July, August, September, October, November, December]
     abbr_month_names: [~, Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec]
-    # Used in date_select and datime_select.
-    order: [ :year, :month, :day ]
+    # Used in date_select and datetime_select.
+    order:
+      - :year
+      - :month
+      - :day
 
   time:
     formats:

data/lib/active_support/log_subscriber.rb

@@ -0,0 +1,123 @@
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/class/attribute'
+
+module ActiveSupport
+  # ActiveSupport::LogSubscriber is an object set to consume ActiveSupport::Notifications
+  # with solely purpose of logging. The log subscriber dispatches notifications to a
+  # regirested object based on its given namespace.
+  #
+  # An example would be Active Record log subscriber responsible for logging queries:
+  #
+  #   module ActiveRecord
+  #     class LogSubscriber < ActiveSupport::LogSubscriber
+  #       def sql(event)
+  #         "#{event.payload[:name]} (#{event.duration}) #{event.payload[:sql]}"
+  #       end
+  #     end
+  #   end
+  #
+  # And it's finally registed as:
+  #
+  #   ActiveRecord::LogSubscriber.attach_to :active_record
+  #
+  # Since we need to know all instance methods before attaching the log subscriber,
+  # the line above should be called after your ActiveRecord::LogSubscriber definition.
+  #
+  # After configured, whenever a "sql.active_record" notification is published,
+  # it will properly dispatch the event (ActiveSupport::Notifications::Event) to
+  # the sql method.
+  #
+  # Log subscriber also has some helpers to deal with logging and automatically flushes
+  # all logs when the request finishes (via action_dispatch.callback notification) in
+  # a Rails environment.
+  class LogSubscriber
+    mattr_accessor :colorize_logging
+    self.colorize_logging = true
+
+    class_attribute :logger
+
+    class << self
+      remove_method :logger
+    end
+
+    def self.logger
+      @logger ||= Rails.logger if defined?(Rails)
+    end
+
+    # Embed in a String to clear all previous ANSI sequences.
+    CLEAR   = "\e[0m"
+    BOLD    = "\e[1m"
+            
+    # Colors
+    BLACK   = "\e[30m"
+    RED     = "\e[31m"
+    GREEN   = "\e[32m"
+    YELLOW  = "\e[33m"
+    BLUE    = "\e[34m"
+    MAGENTA = "\e[35m"
+    CYAN    = "\e[36m"
+    WHITE   = "\e[37m"
+
+    def self.attach_to(namespace, log_subscriber=new, notifier=ActiveSupport::Notifications)
+      log_subscribers << log_subscriber
+      @@flushable_loggers = nil
+
+      log_subscriber.public_methods(false).each do |event|
+        next if 'call' == event.to_s
+
+        notifier.subscribe("#{event}.#{namespace}", log_subscriber)
+      end
+    end
+
+    def self.log_subscribers
+      @@log_subscribers ||= []
+    end
+
+    def self.flushable_loggers
+      @@flushable_loggers ||= begin
+        loggers = log_subscribers.map(&:logger)
+        loggers.uniq!
+        loggers.select { |l| l.respond_to?(:flush) }
+      end
+    end
+
+    # Flush all log_subscribers' logger.
+    def self.flush_all!
+      flushable_loggers.each(&:flush)
+    end
+
+    def call(message, *args)
+      return unless logger
+
+      method = message.split('.').first
+      begin
+        send(method, ActiveSupport::Notifications::Event.new(message, *args))
+      rescue Exception => e
+        logger.error "Could not log #{message.inspect} event. #{e.class}: #{e.message}"
+      end
+    end
+
+  protected
+
+    %w(info debug warn error fatal unknown).each do |level|
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
+        def #{level}(*args, &block)
+          return unless logger
+          logger.#{level}(*args, &block)
+        end
+      METHOD
+    end
+
+    # Set color by using a string or one of the defined constants. If a third
+    # option is set to true, it also adds bold to the string. This is based
+    # on Highline implementation and it automatically appends CLEAR to the end
+    # of the returned String.
+    #
+    def color(text, color, bold=false)
+      return text unless colorize_logging
+      color = self.class.const_get(color.to_s.upcase) if color.is_a?(Symbol)
+      bold  = bold ? BOLD : ""
+      "#{bold}#{color}#{text}#{CLEAR}"
+    end
+  end
+end

data/lib/active_support/log_subscriber/test_helper.rb

@@ -0,0 +1,99 @@
+require 'active_support/log_subscriber'
+require 'active_support/buffered_logger'
+
+module ActiveSupport
+  class LogSubscriber
+    # Provides some helpers to deal with testing log subscribers by setting up
+    # notifications. Take for instance Active Record subscriber tests:
+    #
+    #   class SyncLogSubscriberTest < ActiveSupport::TestCase
+    #     include ActiveSupport::LogSubscriber::TestHelper
+    #
+    #     def setup
+    #       ActiveRecord::LogSubscriber.attach_to(:active_record)
+    #     end
+    # 
+    #     def test_basic_query_logging
+    #       Developer.all
+    #       wait
+    #       assert_equal 1, @logger.logged(:debug).size
+    #       assert_match /Developer Load/, @logger.logged(:debug).last
+    #       assert_match /SELECT \* FROM "developers"/, @logger.logged(:debug).last
+    #     end
+    #   end
+    #
+    # All you need to do is to ensure that your log subscriber is added to Rails::Subscriber,
+    # as in the second line of the code above. The test helpers is reponsible for setting
+    # up the queue, subscriptions and turning colors in logs off.
+    #
+    # The messages are available in the @logger instance, which is a logger with limited
+    # powers (it actually do not send anything to your output), and you can collect them
+    # doing @logger.logged(level), where level is the level used in logging, like info,
+    # debug, warn and so on.
+    #
+    module TestHelper
+      def setup
+        @logger   = MockLogger.new
+        @notifier = ActiveSupport::Notifications::Fanout.new
+
+        ActiveSupport::LogSubscriber.colorize_logging = false
+
+        set_logger(@logger)
+        ActiveSupport::Notifications.notifier = @notifier
+      end
+
+      def teardown
+        set_logger(nil)
+        ActiveSupport::Notifications.notifier = nil
+      end
+
+      class MockLogger
+        include ActiveSupport::BufferedLogger::Severity
+
+        attr_reader :flush_count
+        attr_accessor :level
+
+        def initialize(level = DEBUG)
+          @flush_count = 0
+          @level = level
+          @logged = Hash.new { |h,k| h[k] = [] }
+        end
+
+        def method_missing(level, message)
+          @logged[level] << message
+        end
+
+        def logged(level)
+          @logged[level].compact.map { |l| l.to_s.strip }
+        end
+
+        def flush
+          @flush_count += 1
+        end
+
+        ActiveSupport::BufferedLogger::Severity.constants.each do |severity|
+          class_eval <<-EOT, __FILE__, __LINE__ + 1
+            def #{severity.downcase}?
+              #{severity} >= @level
+            end
+          EOT
+        end
+      end
+
+      # Wait notifications to be published.
+      def wait
+        @notifier.wait
+      end
+
+      # Overwrite if you use another logger in your log subscriber:
+      #
+      #   def logger
+      #     ActiveRecord::Base.logger = @logger
+      #   end
+      #
+      def set_logger(logger)
+        ActiveSupport::LogSubscriber.logger = logger
+      end
+    end
+  end
+end