activemodel 3.2.22.5 → 4.0.0.beta1

data/lib/active_model/callbacks.rb

@@ -1,13 +1,12 @@
-require 'active_support/core_ext/array/wrap'
-require 'active_support/callbacks'
+require 'active_support/core_ext/array/extract_options'
 
 module ActiveModel
-  # == Active Model Callbacks
+  # == Active \Model \Callbacks
   #
   # Provides an interface for any class to have Active Record like callbacks.
   #
   # Like the Active Record methods, the callback chain is aborted as soon as
-  # one of the methods in the chain returns false.
+  # one of the methods in the chain returns +false+.
   #
   # First, extend ActiveModel::Callbacks from the class you are creating:
   #
@@ -19,9 +18,10 @@ module ActiveModel
   #
   #   define_model_callbacks :create, :update
   #
-  # This will provide all three standard callbacks (before, around and after) for
-  # both the :create and :update methods. To implement, you need to wrap the methods
-  # you want callbacks on in a block so that the callbacks get a chance to fire:
+  # This will provide all three standard callbacks (before, around and after)
+  # for both the <tt>:create</tt> and <tt>:update</tt> methods. To implement,
+  # you need to wrap the methods you want callbacks on in a block so that the
+  # callbacks get a chance to fire:
   #
   #   def create
   #     run_callbacks :create do
@@ -29,8 +29,8 @@ module ActiveModel
   #     end
   #   end
   #
-  # Then in your class, you can use the +before_create+, +after_create+ and +around_create+
-  # methods, just as you would in an Active Record module.
+  # Then in your class, you can use the +before_create+, +after_create+ and
+  # +around_create+ methods, just as you would in an Active Record module.
   #
   #   before_create :action_before_create
   #
@@ -38,39 +38,52 @@ module ActiveModel
   #     # Your code here
   #   end
   #
+  # When defining an around callback remember to yield to the block, otherwise
+  # it won't be executed:
+  #
+  #  around_create :log_status
+  #
+  #  def log_status
+  #    puts 'going to call the block...'
+  #    yield
+  #    puts 'block successfully called.'
+  #  end
+  #
   # You can choose not to have all three callbacks by passing a hash to the
-  # define_model_callbacks method.
+  # +define_model_callbacks+ method.
   #
-  #   define_model_callbacks :create, :only => [:after, :before]
+  #   define_model_callbacks :create, only: [:after, :before]
   #
-  # Would only create the after_create and before_create callback methods in your
-  # class.
+  # Would only create the +after_create+ and +before_create+ callback methods in
+  # your class.
   module Callbacks
-    def self.extended(base)
+    def self.extended(base) #:nodoc:
       base.class_eval do
         include ActiveSupport::Callbacks
       end
     end
 
-    # define_model_callbacks accepts the same options define_callbacks does, in case
-    # you want to overwrite a default. Besides that, it also accepts an :only option,
-    # where you can choose if you want all types (before, around or after) or just some.
+    # define_model_callbacks accepts the same options +define_callbacks+ does,
+    # in case you want to overwrite a default. Besides that, it also accepts an
+    # <tt>:only</tt> option, where you can choose if you want all types (before,
+    # around or after) or just some.
     #
-    #   define_model_callbacks :initializer, :only => :after
+    #   define_model_callbacks :initializer, only: :after
     #
-    # Note, the <tt>:only => <type></tt> hash will apply to all callbacks defined on
-    # that method call. To get around this you can call the define_model_callbacks
+    # Note, the <tt>only: <type></tt> hash will apply to all callbacks defined
+    # on that method call. To get around this you can call the define_model_callbacks
     # method as many times as you need.
     #
-    #   define_model_callbacks :create, :only => :after
-    #   define_model_callbacks :update, :only => :before
-    #   define_model_callbacks :destroy, :only => :around
+    #   define_model_callbacks :create,  only: :after
+    #   define_model_callbacks :update,  only: :before
+    #   define_model_callbacks :destroy, only: :around
     #
-    # Would create +after_create+, +before_update+ and +around_destroy+ methods only.
+    # Would create +after_create+, +before_update+ and +around_destroy+ methods
+    # only.
     #
-    # You can pass in a class to before_<type>, after_<type> and around_<type>, in which
-    # case the callback will call that class's <action>_<type> method passing the object
-    # that the callback is being called on.
+    # You can pass in a class to before_<type>, after_<type> and around_<type>,
+    # in which case the callback will call that class's <action>_<type> method
+    # passing the object that the callback is being called on.
     #
     #   class MyModel
     #     extend ActiveModel::Callbacks
@@ -84,16 +97,16 @@ module ActiveModel
     #       # obj is the MyModel instance that the callback is being called on
     #     end
     #   end
-    #
     def define_model_callbacks(*callbacks)
       options = callbacks.extract_options!
       options = {
-         :terminator => "result == false",
-         :scope => [:kind, :name],
-         :only => [:before, :around, :after]
-      }.merge(options)
+        :terminator => "result == false",
+        :skip_after_callbacks_if_terminated => true,
+        :scope => [:kind, :name],
+        :only => [:before, :around, :after]
+      }.merge!(options)
 
-      types = Array.wrap(options.delete(:only))
+      types = Array(options.delete(:only))
 
       callbacks.each do |callback|
         define_callbacks(callback, options)
@@ -104,6 +117,8 @@ module ActiveModel
       end
     end
 
+    private
+
     def _define_before_model_callback(klass, callback) #:nodoc:
       klass.class_eval <<-CALLBACK, __FILE__, __LINE__ + 1
         def self.before_#{callback}(*args, &block)
@@ -125,7 +140,7 @@ module ActiveModel
         def self.after_#{callback}(*args, &block)
           options = args.extract_options!
           options[:prepend] = true
-          options[:if] = Array.wrap(options[:if]) << "!halted && value != false"
+          options[:if] = Array(options[:if]) << "value != false"
           set_callback(:#{callback}, :after, *(args << options), &block)
         end
       CALLBACK

data/lib/active_model/conversion.rb

@@ -1,8 +1,5 @@
-require 'active_support/concern'
-require 'active_support/inflector'
-
 module ActiveModel
-  # == Active Model Conversions
+  # == Active \Model Conversions
   #
   # Handles default conversions: to_model, to_key, to_param, and to_partial_path.
   #
@@ -18,17 +15,23 @@ module ActiveModel
   #   end
   #
   #   cm = ContactMessage.new
-  #   cm.to_model == self # => true
-  #   cm.to_key           # => nil
-  #   cm.to_param         # => nil
-  #   cm.to_path          # => "contact_messages/contact_message"
-  #
+  #   cm.to_model == cm  # => true
+  #   cm.to_key          # => nil
+  #   cm.to_param        # => nil
+  #   cm.to_partial_path # => "contact_messages/contact_message"
   module Conversion
     extend ActiveSupport::Concern
 
     # If your object is already designed to implement all of the Active Model
     # you can use the default <tt>:to_model</tt> implementation, which simply
-    # returns self.
+    # returns +self+.
+    #
+    #   class Person
+    #     include ActiveModel::Conversion
+    #   end
+    #
+    #   person = Person.new
+    #   person.to_model == person # => true
     #
     # If your model does not act like an Active Model object, then you should
     # define <tt>:to_model</tt> yourself returning a proxy object that wraps
@@ -37,29 +40,46 @@ module ActiveModel
       self
     end
 
-    # Returns an Enumerable of all key attributes if any is set, regardless
-    # if the object is persisted or not.
+    # Returns an Enumerable of all key attributes if any is set, regardless if
+    # the object is persisted or not. If there no key attributes, returns +nil+.
+    #
+    #   class Person < ActiveRecord::Base
+    #   end
     #
-    # Note the default implementation uses persisted? just because all objects
-    # in Ruby 1.8.x responds to <tt>:id</tt>.
+    #   person = Person.create
+    #   person.to_key # => [1]
     def to_key
-      persisted? ? [id] : nil
+      key = respond_to?(:id) && id
+      key ? [key] : nil
     end
 
-    # Returns a string representing the object's key suitable for use in URLs,
-    # or nil if <tt>persisted?</tt> is false.
+    # Returns a +string+ representing the object's key suitable for use in URLs,
+    # or +nil+ if <tt>persisted?</tt> is +false+.
+    #
+    #   class Person < ActiveRecord::Base
+    #   end
+    #
+    #   person = Person.create
+    #   person.to_param # => "1"
     def to_param
       persisted? ? to_key.join('-') : nil
     end
 
-    # Returns a string identifying the path associated with the object.
+    # Returns a +string+ identifying the path associated with the object.
     # ActionPack uses this to find a suitable partial to represent the object.
+    #
+    #   class Person
+    #     include ActiveModel::Conversion
+    #   end
+    #
+    #   person = Person.new
+    #   person.to_partial_path # => "people/person"
     def to_partial_path
       self.class._to_partial_path
     end
 
     module ClassMethods #:nodoc:
-      # Provide a class level cache for the to_path. This is an
+      # Provide a class level cache for #to_partial_path. This is an
       # internal method and should not be accessed directly.
       def _to_partial_path #:nodoc:
         @_to_partial_path ||= begin

data/lib/active_model/deprecated_mass_assignment_security.rb

@@ -0,0 +1,21 @@
+module ActiveModel
+  module DeprecatedMassAssignmentSecurity # :nodoc:
+    extend ActiveSupport::Concern
+
+     module ClassMethods # :nodoc:
+       def attr_protected(*args)
+         raise "`attr_protected` is extracted out of Rails into a gem. " \
+           "Please use new recommended protection model for params" \
+           "(strong_parameters) or add `protected_attributes` to your " \
+           "Gemfile to use old one."
+       end
+
+       def attr_accessible(*args)
+         raise "`attr_accessible` is extracted out of Rails into a gem. " \
+           "Please use new recommended protection model for params" \
+           "(strong_parameters) or add `protected_attributes` to your " \
+           "Gemfile to use old one."
+       end
+     end
+  end
+end

data/lib/active_model/dirty.rb

@@ -1,23 +1,22 @@
-require 'active_model/attribute_methods'
 require 'active_support/hash_with_indifferent_access'
 require 'active_support/core_ext/object/duplicable'
 
 module ActiveModel
-  # == Active Model Dirty
+  # == Active \Model \Dirty
   #
   # Provides a way to track changes in your object in the same way as
   # Active Record does.
   #
   # The requirements for implementing ActiveModel::Dirty are:
   #
-  # * <tt>include ActiveModel::Dirty</tt> in your object
+  # * <tt>include ActiveModel::Dirty</tt> in your object.
   # * Call <tt>define_attribute_methods</tt> passing each method you want to
-  #   track
+  #   track.
   # * Call <tt>attr_name_will_change!</tt> before each change to the tracked
-  #   attribute
+  #   attribute.
   #
   # If you wish to also track previous changes on save or update, you need to
-  # add
+  # add:
   #
   #   @previously_changed = changes
   #
@@ -26,10 +25,9 @@ module ActiveModel
   # A minimal implementation could be:
   #
   #   class Person
-  #
   #     include ActiveModel::Dirty
   #
-  #     define_attribute_methods [:name]
+  #     define_attribute_methods :name
   #
   #     def name
   #       @name
@@ -44,46 +42,49 @@ module ActiveModel
   #       @previously_changed = changes
   #       @changed_attributes.clear
   #     end
-  #
   #   end
   #
-  # == Examples:
-  #
   # A newly instantiated object is unchanged:
+  #
   #   person = Person.find_by_name('Uncle Bob')
   #   person.changed?       # => false
   #
   # Change the name:
+  #
   #   person.name = 'Bob'
   #   person.changed?       # => true
   #   person.name_changed?  # => true
-  #   person.name_was       # => 'Uncle Bob'
-  #   person.name_change    # => ['Uncle Bob', 'Bob']
+  #   person.name_was       # => "Uncle Bob"
+  #   person.name_change    # => ["Uncle Bob", "Bob"]
   #   person.name = 'Bill'
-  #   person.name_change    # => ['Uncle Bob', 'Bill']
+  #   person.name_change    # => ["Uncle Bob", "Bill"]
   #
   # Save the changes:
+  #
   #   person.save
   #   person.changed?       # => false
   #   person.name_changed?  # => false
   #
   # Assigning the same value leaves the attribute unchanged:
+  #
   #   person.name = 'Bill'
   #   person.name_changed?  # => false
   #   person.name_change    # => nil
   #
   # Which attributes have changed?
+  #
   #   person.name = 'Bob'
-  #   person.changed        # => ['name']
-  #   person.changes        # => { 'name' => ['Bill', 'Bob'] }
+  #   person.changed        # => ["name"]
+  #   person.changes        # => {"name" => ["Bill", "Bob"]}
   #
   # If an attribute is modified in-place then make use of <tt>[attribute_name]_will_change!</tt>
-  # to mark that the attribute is changing. Otherwise ActiveModel can't track changes to
-  # in-place attributes.
+  # to mark that the attribute is changing. Otherwise ActiveModel can't track
+  # changes to in-place attributes.
   #
   #   person.name_will_change!
+  #   person.name_change    # => ["Bill", "Bill"]
   #   person.name << 'y'
-  #   person.name_change    # => ['Bill', 'Billy']
+  #   person.name_change    # => ["Bill", "Billy"]
   module Dirty
     extend ActiveSupport::Concern
     include ActiveModel::AttributeMethods
@@ -93,40 +94,50 @@ module ActiveModel
       attribute_method_affix :prefix => 'reset_', :suffix => '!'
     end
 
-    # Returns true if any attribute have unsaved changes, false otherwise.
+    # Returns +true+ if any attribute have unsaved changes, +false+ otherwise.
+    #
     #   person.changed? # => false
     #   person.name = 'bob'
     #   person.changed? # => true
     def changed?
-      changed_attributes.any?
+      changed_attributes.present?
     end
 
-    # List of attributes with unsaved changes.
+    # Returns an array with the name of the attributes with unsaved changes.
+    #
     #   person.changed # => []
     #   person.name = 'bob'
-    #   person.changed # => ['name']
+    #   person.changed # => ["name"]
     def changed
       changed_attributes.keys
     end
 
-    # Map of changed attrs => [original value, new value].
+    # Returns a hash of changed attributes indicating their original
+    # and new values like <tt>attr => [original value, new value]</tt>.
+    #
     #   person.changes # => {}
     #   person.name = 'bob'
-    #   person.changes # => { 'name' => ['bill', 'bob'] }
+    #   person.changes # => { "name" => ["bill", "bob"] }
     def changes
-      HashWithIndifferentAccess[changed.map { |attr| [attr, attribute_change(attr)] }]
+      ActiveSupport::HashWithIndifferentAccess[changed.map { |attr| [attr, attribute_change(attr)] }]
     end
 
-    # Map of attributes that were changed when the model was saved.
-    #   person.name # => 'bob'
+    # Returns a hash of attributes that were changed before the model was saved.
+    #
+    #   person.name # => "bob"
     #   person.name = 'robert'
     #   person.save
-    #   person.previous_changes # => {'name' => ['bob, 'robert']}
+    #   person.previous_changes # => {"name" => ["bob", "robert"]}
     def previous_changes
       @previously_changed
     end
 
-    # Map of change <tt>attr => original value</tt>.
+    # Returns a hash of the attributes with unsaved changes indicating their original
+    # values like <tt>attr => original value</tt>.
+    #
+    #   person.name # => "bob"
+    #   person.name = 'robert'
+    #   person.changed_attributes # => {"name" => "bob"}
     def changed_attributes
       @changed_attributes ||= {}
     end
@@ -150,18 +161,23 @@ module ActiveModel
 
       # Handle <tt>*_will_change!</tt> for +method_missing+.
       def attribute_will_change!(attr)
+        return if attribute_changed?(attr)
+
         begin
           value = __send__(attr)
           value = value.duplicable? ? value.clone : value
         rescue TypeError, NoMethodError
         end
 
-        changed_attributes[attr] = value unless changed_attributes.include?(attr)
+        changed_attributes[attr] = value
       end
 
       # Handle <tt>reset_*!</tt> for +method_missing+.
       def reset_attribute!(attr)
-        __send__("#{attr}=", changed_attributes[attr]) if attribute_changed?(attr)
+        if attribute_changed?(attr)
+          __send__("#{attr}=", changed_attributes[attr])
+          changed_attributes.delete(attr)
+        end
       end
   end
 end