activesupport 3.0.0.rc → 3.0.0.rc2

data/lib/active_support/log_subscriber/test_helper.rb

@@ -12,7 +12,7 @@ module ActiveSupport
     #     def setup
     #       ActiveRecord::LogSubscriber.attach_to(:active_record)
     #     end
-    # 
+    #
     #     def test_basic_query_logging
     #       Developer.all
     #       wait

data/lib/active_support/message_encryptor.rb

@@ -2,9 +2,9 @@ require 'openssl'
 require 'active_support/base64'
 
 module ActiveSupport
-  # MessageEncryptor is a simple way to encrypt values which get stored somewhere 
+  # MessageEncryptor is a simple way to encrypt values which get stored somewhere
   # you don't trust.
-  # 
+  #
   # The cipher text and initialization vector are base64 encoded and returned to you.
   #
   # This can be used in situations similar to the MessageVerifier, but where you don't
@@ -17,53 +17,53 @@ module ActiveSupport
       @secret = secret
       @cipher = cipher
     end
-    
+
     def encrypt(value)
       cipher = new_cipher
       # Rely on OpenSSL for the initialization vector
       iv = cipher.random_iv
-      
-      cipher.encrypt 
+
+      cipher.encrypt
       cipher.key = @secret
       cipher.iv  = iv
-      
-      encrypted_data = cipher.update(Marshal.dump(value)) 
+
+      encrypted_data = cipher.update(Marshal.dump(value))
       encrypted_data << cipher.final
 
       [encrypted_data, iv].map {|v| ActiveSupport::Base64.encode64s(v)}.join("--")
     end
-    
+
     def decrypt(encrypted_message)
       cipher = new_cipher
       encrypted_data, iv = encrypted_message.split("--").map {|v| ActiveSupport::Base64.decode64(v)}
-      
+
       cipher.decrypt
       cipher.key = @secret
       cipher.iv  = iv
 
       decrypted_data = cipher.update(encrypted_data)
       decrypted_data << cipher.final
-      
+
       Marshal.load(decrypted_data)
     rescue OpenSSLCipherError, TypeError
       raise InvalidMessage
     end
-    
+
     def encrypt_and_sign(value)
       verifier.generate(encrypt(value))
     end
-    
+
     def decrypt_and_verify(value)
       decrypt(verifier.verify(value))
     end
-    
-    
-    
-    private 
+
+
+
+    private
       def new_cipher
         OpenSSL::Cipher::Cipher.new(@cipher)
       end
-      
+
       def verifier
         MessageVerifier.new(@secret)
       end

data/lib/active_support/message_verifier.rb

@@ -4,28 +4,28 @@ require 'active_support/core_ext/object/blank'
 module ActiveSupport
   # MessageVerifier makes it easy to generate and verify messages which are signed
   # to prevent tampering.
-  # 
+  #
   # This is useful for cases like remember-me tokens and auto-unsubscribe links where the
   # session store isn't suitable or available.
   #
   # Remember Me:
   #   cookies[:remember_me] = @verifier.generate([@user.id, 2.weeks.from_now])
-  # 
+  #
   # In the authentication filter:
   #
   #   id, time = @verifier.verify(cookies[:remember_me])
   #   if time < Time.now
   #     self.current_user = User.find(id)
   #   end
-  # 
+  #
   class MessageVerifier
     class InvalidSignature < StandardError; end
-    
+
     def initialize(secret, digest = 'SHA1')
       @secret = secret
       @digest = digest
     end
-    
+
     def verify(signed_message)
       raise InvalidSignature if signed_message.blank?
 
@@ -36,12 +36,12 @@ module ActiveSupport
         raise InvalidSignature
       end
     end
-    
+
     def generate(value)
       data = ActiveSupport::Base64.encode64s(Marshal.dump(value))
       "#{data}--#{generate_digest(data)}"
     end
-    
+
     private
       # constant-time comparison algorithm to prevent timing attacks
       def secure_compare(a, b)

data/lib/active_support/multibyte.rb

@@ -6,7 +6,7 @@ module ActiveSupport #:nodoc:
     autoload :EncodingError, 'active_support/multibyte/exceptions'
     autoload :Chars, 'active_support/multibyte/chars'
     autoload :Unicode, 'active_support/multibyte/unicode'
-    
+
     # The proxy class returned when calling mb_chars. You can use this accessor to configure your own proxy
     # class so you can support other encodings. See the ActiveSupport::Multibyte::Chars implementation for
     # an example how to do this.

data/lib/active_support/multibyte/chars.rb

@@ -11,7 +11,7 @@ module ActiveSupport #:nodoc:
     # String methods are proxied through the Chars object, and can be accessed through the +mb_chars+ method. Methods
     # which would normally return a String object now return a Chars object so methods can be chained.
     #
-    #   "The Perfect String  ".mb_chars.downcase.strip.normalize #=> "the perfect string"
+    #   "The Perfect String  ".mb_chars.downcase.strip.normalize # => "the perfect string"
     #
     # Chars objects are perfectly interchangeable with String objects as long as no explicit class checks are made.
     # If certain methods do explicitly check the class, call +to_s+ before you pass chars objects to them.
@@ -83,12 +83,13 @@ module ActiveSupport #:nodoc:
 
       include Comparable
 
-      # Returns <tt>-1</tt>, <tt>0</tt> or <tt>+1</tt> depending on whether the Chars object is to be sorted before,
-      # equal or after the object on the right side of the operation. It accepts any object that implements +to_s+.
-      # See <tt>String#<=></tt> for more details.
+      # Returns -1, 0, or 1, depending on whether the Chars object is to be sorted before,
+      # equal or after the object on the right side of the operation. It accepts any object
+      # that implements +to_s+:
       #
-      # Example:
-      #   'é'.mb_chars <=> 'ü'.mb_chars #=> -1
+      #   'é'.mb_chars <=> 'ü'.mb_chars # => -1
+      #
+      # See <tt>String#<=></tt> for more details.
       def <=>(other)
         @wrapped_string <=> other.to_s
       end
@@ -103,7 +104,7 @@ module ActiveSupport #:nodoc:
         # Returns a new Chars object containing the _other_ object concatenated to the string.
         #
         # Example:
-        #   ('Café'.mb_chars + ' périferôl').to_s #=> "Café périferôl"
+        #   ('Café'.mb_chars + ' périferôl').to_s # => "Café périferôl"
         def +(other)
           chars(@wrapped_string + other)
         end
@@ -111,7 +112,7 @@ module ActiveSupport #:nodoc:
         # Like <tt>String#=~</tt> only it returns the character offset (in codepoints) instead of the byte offset.
         #
         # Example:
-        #   'Café périferôl'.mb_chars =~ /ô/ #=> 12
+        #   'Café périferôl'.mb_chars =~ /ô/ # => 12
         def =~(other)
           translate_offset(@wrapped_string =~ other)
         end
@@ -119,7 +120,7 @@ module ActiveSupport #:nodoc:
         # Inserts the passed string at specified codepoint offsets.
         #
         # Example:
-        #   'Café'.mb_chars.insert(4, ' périferôl').to_s #=> "Café périferôl"
+        #   'Café'.mb_chars.insert(4, ' périferôl').to_s # => "Café périferôl"
         def insert(offset, fragment)
           unpacked = Unicode.u_unpack(@wrapped_string)
           unless offset > unpacked.length
@@ -135,7 +136,7 @@ module ActiveSupport #:nodoc:
         # Returns +true+ if contained string contains _other_. Returns +false+ otherwise.
         #
         # Example:
-        #   'Café'.mb_chars.include?('é') #=> true
+        #   'Café'.mb_chars.include?('é') # => true
         def include?(other)
           # We have to redefine this method because Enumerable defines it.
           @wrapped_string.include?(other)
@@ -144,8 +145,8 @@ module ActiveSupport #:nodoc:
         # Returns the position _needle_ in the string, counting in codepoints. Returns +nil+ if _needle_ isn't found.
         #
         # Example:
-        #   'Café périferôl'.mb_chars.index('ô') #=> 12
-        #   'Café périferôl'.mb_chars.index(/\w/u) #=> 0
+        #   'Café périferôl'.mb_chars.index('ô')   # => 12
+        #   'Café périferôl'.mb_chars.index(/\w/u) # => 0
         def index(needle, offset=0)
           wrapped_offset = first(offset).wrapped_string.length
           index = @wrapped_string.index(needle, wrapped_offset)
@@ -157,8 +158,8 @@ module ActiveSupport #:nodoc:
         # string. Returns +nil+ if _needle_ isn't found.
         #
         # Example:
-        #   'Café périferôl'.mb_chars.rindex('é') #=> 6
-        #   'Café périferôl'.mb_chars.rindex(/\w/u) #=> 13
+        #   'Café périferôl'.mb_chars.rindex('é')   # => 6
+        #   'Café périferôl'.mb_chars.rindex(/\w/u) # => 13
         def rindex(needle, offset=nil)
           offset ||= length
           wrapped_offset = first(offset).wrapped_string.length
@@ -190,7 +191,7 @@ module ActiveSupport #:nodoc:
         # Returns the codepoint of the first character in the string.
         #
         # Example:
-        #   'こんにちは'.mb_chars.ord #=> 12371
+        #   'こんにちは'.mb_chars.ord # => 12371
         def ord
           Unicode.u_unpack(@wrapped_string)[0]
         end
@@ -200,10 +201,10 @@ module ActiveSupport #:nodoc:
         # Example:
         #
         #   "¾ cup".mb_chars.rjust(8).to_s
-        #   #=> "   ¾ cup"
+        #   # => "   ¾ cup"
         #
         #   "¾ cup".mb_chars.rjust(8, " ").to_s # Use non-breaking whitespace
-        #   #=> "   ¾ cup"
+        #   # => "   ¾ cup"
         def rjust(integer, padstr=' ')
           justify(integer, :right, padstr)
         end
@@ -213,10 +214,10 @@ module ActiveSupport #:nodoc:
         # Example:
         #
         #   "¾ cup".mb_chars.rjust(8).to_s
-        #   #=> "¾ cup   "
+        #   # => "¾ cup   "
         #
         #   "¾ cup".mb_chars.rjust(8, " ").to_s # Use non-breaking whitespace
-        #   #=> "¾ cup   "
+        #   # => "¾ cup   "
         def ljust(integer, padstr=' ')
           justify(integer, :left, padstr)
         end
@@ -226,10 +227,10 @@ module ActiveSupport #:nodoc:
         # Example:
         #
         #   "¾ cup".mb_chars.center(8).to_s
-        #   #=> " ¾ cup  "
+        #   # => " ¾ cup  "
         #
         #   "¾ cup".mb_chars.center(8, " ").to_s # Use non-breaking whitespace
-        #   #=> " ¾ cup  "
+        #   # => " ¾ cup  "
         def center(integer, padstr=' ')
           justify(integer, :center, padstr)
         end
@@ -244,7 +245,7 @@ module ActiveSupport #:nodoc:
       # instances instead of String. This makes chaining methods easier.
       #
       # Example:
-      #   'Café périferôl'.mb_chars.split(/é/).map { |part| part.upcase.to_s } #=> ["CAF", " P", "RIFERÔL"]
+      #   'Café périferôl'.mb_chars.split(/é/).map { |part| part.upcase.to_s } # => ["CAF", " P", "RIFERÔL"]
       def split(*args)
         @wrapped_string.split(*args).map { |i| i.mb_chars }
       end
@@ -256,12 +257,12 @@ module ActiveSupport #:nodoc:
       #   s = "Müller"
       #   s.mb_chars[2] = "e" # Replace character with offset 2
       #   s
-      #   #=> "Müeler"
+      #   # => "Müeler"
       #
       #   s = "Müller"
       #   s.mb_chars[1, 2] = "ö" # Replace 2 characters at character offset 1
       #   s
-      #   #=> "Möler"
+      #   # => "Möler"
       def []=(*args)
         replace_by = args.pop
         # Indexed replace with regular expressions already works
@@ -292,7 +293,7 @@ module ActiveSupport #:nodoc:
       # Reverses all characters in the string.
       #
       # Example:
-      #   'Café'.mb_chars.reverse.to_s #=> 'éfaC'
+      #   'Café'.mb_chars.reverse.to_s # => 'éfaC'
       def reverse
         chars(Unicode.g_unpack(@wrapped_string).reverse.flatten.pack('U*'))
       end
@@ -301,7 +302,7 @@ module ActiveSupport #:nodoc:
       # character.
       #
       # Example:
-      #   'こんにちは'.mb_chars.slice(2..3).to_s #=> "にち"
+      #   'こんにちは'.mb_chars.slice(2..3).to_s # => "にち"
       def slice(*args)
         if args.size > 2
           raise ArgumentError, "wrong number of arguments (#{args.size} for 1)" # Do as if we were native
@@ -330,7 +331,7 @@ module ActiveSupport #:nodoc:
       #
       # Example:
       #   s = 'こんにちは'
-      #   s.mb_chars.limit(7) #=> "こに"
+      #   s.mb_chars.limit(7) # => "こに"
       def limit(limit)
         slice(0...translate_offset(limit))
       end
@@ -338,7 +339,7 @@ module ActiveSupport #:nodoc:
       # Convert characters in the string to uppercase.
       #
       # Example:
-      #   'Laurent, où sont les tests ?'.mb_chars.upcase.to_s #=> "LAURENT, OÙ SONT LES TESTS ?"
+      #   'Laurent, où sont les tests ?'.mb_chars.upcase.to_s # => "LAURENT, OÙ SONT LES TESTS ?"
       def upcase
         chars(Unicode.apply_mapping @wrapped_string, :uppercase_mapping)
       end
@@ -346,7 +347,7 @@ module ActiveSupport #:nodoc:
       # Convert characters in the string to lowercase.
       #
       # Example:
-      #   'VĚDA A VÝZKUM'.mb_chars.downcase.to_s #=> "věda a výzkum"
+      #   'VĚDA A VÝZKUM'.mb_chars.downcase.to_s # => "věda a výzkum"
       def downcase
         chars(Unicode.apply_mapping @wrapped_string, :lowercase_mapping)
       end
@@ -354,7 +355,7 @@ module ActiveSupport #:nodoc:
       # Converts the first character to uppercase and the remainder to lowercase.
       #
       # Example:
-      #  'über'.mb_chars.capitalize.to_s #=> "Über"
+      #  'über'.mb_chars.capitalize.to_s # => "Über"
       def capitalize
         (slice(0) || chars('')).upcase + (slice(1..-1) || chars('')).downcase
       end
@@ -382,8 +383,8 @@ module ActiveSupport #:nodoc:
       # Performs canonical decomposition on all the characters.
       #
       # Example:
-      #   'é'.length #=> 2
-      #   'é'.mb_chars.decompose.to_s.length #=> 3
+      #   'é'.length                         # => 2
+      #   'é'.mb_chars.decompose.to_s.length # => 3
       def decompose
         chars(Unicode.decompose_codepoints(:canonical, Unicode.u_unpack(@wrapped_string)).pack('U*'))
       end
@@ -391,8 +392,8 @@ module ActiveSupport #:nodoc:
       # Performs composition on all the characters.
       #
       # Example:
-      #   'é'.length #=> 3
-      #   'é'.mb_chars.compose.to_s.length #=> 2
+      #   'é'.length                       # => 3
+      #   'é'.mb_chars.compose.to_s.length # => 2
       def compose
         chars(Unicode.compose_codepoints(Unicode.u_unpack(@wrapped_string)).pack('U*'))
       end
@@ -400,8 +401,8 @@ module ActiveSupport #:nodoc:
       # Returns the number of grapheme clusters in the string.
       #
       # Example:
-      #   'क्षि'.mb_chars.length #=> 4
-      #   'क्षि'.mb_chars.g_length #=> 3
+      #   'क्षि'.mb_chars.length   # => 4
+      #   'क्षि'.mb_chars.g_length # => 3
       def g_length
         Unicode.g_unpack(@wrapped_string).length
       end

data/lib/active_support/multibyte/unicode.rb

@@ -64,7 +64,7 @@ module ActiveSupport
       # valid UTF-8.
       #
       # Example:
-      #   Unicode.u_unpack('Café') #=> [67, 97, 102, 233]
+      #   Unicode.u_unpack('Café') # => [67, 97, 102, 233]
       def u_unpack(string)
         begin
           string.unpack 'U*'
@@ -85,8 +85,8 @@ module ActiveSupport
       # Unpack the string at grapheme boundaries. Returns a list of character lists.
       #
       # Example:
-      #   Unicode.g_unpack('क्षि') #=> [[2325, 2381], [2359], [2367]]
-      #   Unicode.g_unpack('Café') #=> [[67], [97], [102], [233]]
+      #   Unicode.g_unpack('क्षि') # => [[2325, 2381], [2359], [2367]]
+      #   Unicode.g_unpack('Café') # => [[67], [97], [102], [233]]
       def g_unpack(string)
         codepoints = u_unpack(string)
         unpacked = []
@@ -120,7 +120,7 @@ module ActiveSupport
       # Reverse operation of g_unpack.
       #
       # Example:
-      #   Unicode.g_pack(Unicode.g_unpack('क्षि')) #=> 'क्षि'
+      #   Unicode.g_pack(Unicode.g_unpack('क्षि')) # => 'क्षि'
       def g_pack(unpacked)
         (unpacked.flatten).pack('U*')
       end

data/lib/active_support/notifications.rb

@@ -22,9 +22,9 @@ module ActiveSupport
   #   end
   #
   #   event = @events.first
-  #   event.name      #=> :render
-  #   event.duration  #=> 10 (in milliseconds)
-  #   event.payload   #=> { :extra => :information }
+  #   event.name      # => :render
+  #   event.duration  # => 10 (in milliseconds)
+  #   event.payload   # => { :extra => :information }
   #
   # When subscribing to Notifications, you can pass a pattern, to only consume
   # events that match the pattern:

data/lib/active_support/secure_random.rb

@@ -26,25 +26,25 @@ module ActiveSupport
     # == Example
     #
     #  # random hexadecimal string.
-    #  p SecureRandom.hex(10) #=> "52750b30ffbc7de3b362"
-    #  p SecureRandom.hex(10) #=> "92b15d6c8dc4beb5f559"
-    #  p SecureRandom.hex(11) #=> "6aca1b5c58e4863e6b81b8"
-    #  p SecureRandom.hex(12) #=> "94b2fff3e7fd9b9c391a2306"
-    #  p SecureRandom.hex(13) #=> "39b290146bea6ce975c37cfc23"
+    #  p SecureRandom.hex(10) # => "52750b30ffbc7de3b362"
+    #  p SecureRandom.hex(10) # => "92b15d6c8dc4beb5f559"
+    #  p SecureRandom.hex(11) # => "6aca1b5c58e4863e6b81b8"
+    #  p SecureRandom.hex(12) # => "94b2fff3e7fd9b9c391a2306"
+    #  p SecureRandom.hex(13) # => "39b290146bea6ce975c37cfc23"
     #  ...
     #
     #  # random base64 string.
-    #  p SecureRandom.base64(10) #=> "EcmTPZwWRAozdA=="
-    #  p SecureRandom.base64(10) #=> "9b0nsevdwNuM/w=="
-    #  p SecureRandom.base64(10) #=> "KO1nIU+p9DKxGg=="
-    #  p SecureRandom.base64(11) #=> "l7XEiFja+8EKEtY="
-    #  p SecureRandom.base64(12) #=> "7kJSM/MzBJI+75j8"
-    #  p SecureRandom.base64(13) #=> "vKLJ0tXBHqQOuIcSIg=="
+    #  p SecureRandom.base64(10) # => "EcmTPZwWRAozdA=="
+    #  p SecureRandom.base64(10) # => "9b0nsevdwNuM/w=="
+    #  p SecureRandom.base64(10) # => "KO1nIU+p9DKxGg=="
+    #  p SecureRandom.base64(11) # => "l7XEiFja+8EKEtY="
+    #  p SecureRandom.base64(12) # => "7kJSM/MzBJI+75j8"
+    #  p SecureRandom.base64(13) # => "vKLJ0tXBHqQOuIcSIg=="
     #  ...
     #
     #  # random binary string.
-    #  p SecureRandom.random_bytes(10) #=> "\016\t{\370g\310pbr\301"
-    #  p SecureRandom.random_bytes(10) #=> "\323U\030TO\234\357\020\a\337"
+    #  p SecureRandom.random_bytes(10) # => "\016\t{\370g\310pbr\301"
+    #  p SecureRandom.random_bytes(10) # => "\323U\030TO\234\357\020\a\337"
     #  ...
     module SecureRandom
       # SecureRandom.random_bytes generates a random binary string.