activemodel 4.0.13 → 4.1.0.beta1

data/lib/active_model/conversion.rb

@@ -41,7 +41,7 @@ module ActiveModel
     end
 
     # 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+.
+    # the object is persisted or not. Returns +nil+ if there are no key attributes.
     #
     #   class Person < ActiveRecord::Base
     #   end
@@ -62,7 +62,7 @@ module ActiveModel
     #   person = Person.create
     #   person.to_param # => "1"
     def to_param
-      (persisted? && key = to_key) ? key.join('-') : nil
+      persisted? ? to_key.join('-') : nil
     end
 
     # Returns a +string+ identifying the path associated with the object.

data/lib/active_model/dirty.rb

@@ -14,13 +14,9 @@ module ActiveModel
   #   track.
   # * Call <tt>attr_name_will_change!</tt> before each change to the tracked
   #   attribute.
-  #
-  # If you wish to also track previous changes on save or update, you need to
-  # add:
-  #
-  #   @previously_changed = changes
-  #
-  # inside of your save or update method.
+  # * Call <tt>changes_applied</tt> after the changes are persisted.
+  # * Call <tt>reset_changes</tt> when you want to reset the changes
+  #   information.
   #
   # A minimal implementation could be:
   #
@@ -39,8 +35,12 @@ module ActiveModel
   #     end
   #
   #     def save
-  #       @previously_changed = changes
-  #       @changed_attributes.clear
+  #       # do persistence work
+  #       changes_applied
+  #     end
+  #
+  #     def reload!
+  #       reset_changes
   #     end
   #   end
   #
@@ -65,6 +65,12 @@ module ActiveModel
   #   person.changed?       # => false
   #   person.name_changed?  # => false
   #
+  # Reset the changes:
+  #
+  #   person.previous_changes # => {"name" => ["Uncle Bob", "Bill"]}
+  #   person.reload!
+  #   person.previous_changes # => {}
+  #
   # Assigning the same value leaves the attribute unchanged:
   #
   #   person.name = 'Bill'
@@ -91,7 +97,7 @@ module ActiveModel
 
     included do
       attribute_method_suffix '_changed?', '_change', '_will_change!', '_was'
-      attribute_method_affix :prefix => 'reset_', :suffix => '!'
+      attribute_method_affix prefix: 'reset_', suffix: '!'
     end
 
     # Returns +true+ if any attribute have unsaved changes, +false+ otherwise.
@@ -129,7 +135,7 @@ module ActiveModel
     #   person.save
     #   person.previous_changes # => {"name" => ["bob", "robert"]}
     def previous_changes
-      @previously_changed
+      @previously_changed ||= {}
     end
 
     # Returns a hash of the attributes with unsaved changes indicating their original
@@ -139,14 +145,31 @@ module ActiveModel
     #   person.name = 'robert'
     #   person.changed_attributes # => {"name" => "bob"}
     def changed_attributes
-      @changed_attributes ||= {}
+      @changed_attributes ||= ActiveSupport::HashWithIndifferentAccess.new
+    end
+
+    # Handle <tt>*_changed?</tt> for +method_missing+.
+    def attribute_changed?(attr) # :nodoc:
+      changed_attributes.include?(attr)
+    end
+
+    # Handle <tt>*_was</tt> for +method_missing+.
+    def attribute_was(attr) # :nodoc:
+      attribute_changed?(attr) ? changed_attributes[attr] : __send__(attr)
     end
 
     private
 
-      # Handle <tt>*_changed?</tt> for +method_missing+.
-      def attribute_changed?(attr)
-        changed_attributes.include?(attr)
+      # Removes current changes and makes them accessible through +previous_changes+.
+      def changes_applied
+        @previously_changed = changes
+        @changed_attributes = {}
+      end
+
+      # Removes all dirty data: current changes and previous changes
+      def reset_changes
+        @previously_changed = {}
+        @changed_attributes = {}
       end
 
       # Handle <tt>*_change</tt> for +method_missing+.
@@ -154,11 +177,6 @@ module ActiveModel
         [changed_attributes[attr], __send__(attr)] if attribute_changed?(attr)
       end
 
-      # Handle <tt>*_was</tt> for +method_missing+.
-      def attribute_was(attr)
-        attribute_changed?(attr) ? changed_attributes[attr] : __send__(attr)
-      end
-
       # Handle <tt>*_will_change!</tt> for +method_missing+.
       def attribute_will_change!(attr)
         return if attribute_changed?(attr)

data/lib/active_model/errors.rb

@@ -231,7 +231,7 @@ module ActiveModel
     #   #    <error>name must be specified</error>
     #   #  </errors>
     def to_xml(options={})
-      to_a.to_xml({ :root => "errors", :skip_types => true }.merge!(options))
+      to_a.to_xml({ root: "errors", skip_types: true }.merge!(options))
     end
 
     # Returns a Hash that can be used as the JSON representation for this
@@ -289,7 +289,7 @@ module ActiveModel
     #   # => NameIsInvalid: name is invalid
     #
     #   person.errors.messages # => {}
-    def add(attribute, message = nil, options = {})
+    def add(attribute, message = :invalid, options = {})
       message = normalize_message(attribute, message, options)
       if exception = options[:strict]
         exception = ActiveModel::StrictValidationFailed if exception == true
@@ -331,7 +331,7 @@ module ActiveModel
     #
     #   person.errors.add :name, :blank
     #   person.errors.added? :name, :blank # => true
-    def added?(attribute, message = nil, options = {})
+    def added?(attribute, message = :invalid, options = {})
       message = normalize_message(attribute, message, options)
       self[attribute].include? message
     end
@@ -370,11 +370,11 @@ module ActiveModel
     def full_message(attribute, message)
       return message if attribute == :base
       attr_name = attribute.to_s.tr('.', '_').humanize
-      attr_name = @base.class.human_attribute_name(attribute, :default => attr_name)
+      attr_name = @base.class.human_attribute_name(attribute, default: attr_name)
       I18n.t(:"errors.format", {
-        :default   => "%{attribute} %{message}",
-        :attribute => attr_name,
-        :message   => message
+        default:  "%{attribute} %{message}",
+        attribute: attr_name,
+        message:   message
       })
     end
 
@@ -426,10 +426,10 @@ module ActiveModel
       value = (attribute != :base ? @base.send(:read_attribute_for_validation, attribute) : nil)
 
       options = {
-        :default => defaults,
-        :model => @base.class.model_name.human,
-        :attribute => @base.class.human_attribute_name(attribute),
-        :value => value
+        default: defaults,
+        model: @base.class.model_name.human,
+        attribute: @base.class.human_attribute_name(attribute),
+        value: value
       }.merge!(options)
 
       I18n.translate(key, options)
@@ -437,8 +437,6 @@ module ActiveModel
 
   private
     def normalize_message(attribute, message, options)
-      message ||= :invalid
-
       case message
       when Symbol
         generate_message(attribute, message, options.except(*CALLBACKS_OPTIONS))

data/lib/active_model/forbidden_attributes_protection.rb

@@ -23,6 +23,5 @@ module ActiveModel
           attributes
         end
       end
-      alias :sanitize_forbidden_attributes :sanitize_for_mass_assignment
   end
 end

data/lib/active_model/naming.rb

@@ -129,7 +129,7 @@ module ActiveModel
     #
     # Equivalent to +to_s+.
     delegate :==, :===, :<=>, :=~, :"!~", :eql?, :to_s,
-             :to_str, :to => :name
+             :to_str, to: :name
 
     # Returns a new ActiveModel::Name instance. By default, the +namespace+
     # and +name+ option will take the namespace and name of the given class
@@ -183,7 +183,7 @@ module ActiveModel
       defaults << options[:default] if options[:default]
       defaults << @human
 
-      options = { :scope => [@klass.i18n_scope, :models], :count => 1, :default => defaults }.merge!(options.except(:default))
+      options = { scope: [@klass.i18n_scope, :models], count: 1, default: defaults }.merge!(options.except(:default))
       I18n.translate(defaults.shift, options)
     end
 
@@ -262,10 +262,10 @@ module ActiveModel
     # namespaced models regarding whether it's inside isolated engine.
     #
     #   # For isolated engine:
-    #   ActiveModel::Naming.singular_route_key(Blog::Post) #=> "post"
+    #   ActiveModel::Naming.singular_route_key(Blog::Post) # => "post"
     #
     #   # For shared engine:
-    #   ActiveModel::Naming.singular_route_key(Blog::Post) #=> "blog_post"
+    #   ActiveModel::Naming.singular_route_key(Blog::Post) # => "blog_post"
     def self.singular_route_key(record_or_class)
       model_name_from_record_or_class(record_or_class).singular_route_key
     end
@@ -274,10 +274,10 @@ module ActiveModel
     # namespaced models regarding whether it's inside isolated engine.
     #
     #   # For isolated engine:
-    #   ActiveModel::Naming.route_key(Blog::Post) #=> "posts"
+    #   ActiveModel::Naming.route_key(Blog::Post) # => "posts"
     #
     #   # For shared engine:
-    #   ActiveModel::Naming.route_key(Blog::Post) #=> "blog_posts"
+    #   ActiveModel::Naming.route_key(Blog::Post) # => "blog_posts"
     #
     # The route key also considers if the noun is uncountable and, in
     # such cases, automatically appends _index.
@@ -289,10 +289,10 @@ module ActiveModel
     # namespaced models regarding whether it's inside isolated engine.
     #
     #   # For isolated engine:
-    #   ActiveModel::Naming.param_key(Blog::Post) #=> "post"
+    #   ActiveModel::Naming.param_key(Blog::Post) # => "post"
     #
     #   # For shared engine:
-    #   ActiveModel::Naming.param_key(Blog::Post) #=> "blog_post"
+    #   ActiveModel::Naming.param_key(Blog::Post) # => "blog_post"
     def self.param_key(record_or_class)
       model_name_from_record_or_class(record_or_class).param_key
     end

data/lib/active_model/secure_password.rb

@@ -2,7 +2,9 @@ module ActiveModel
   module SecurePassword
     extend ActiveSupport::Concern
 
-    class << self; attr_accessor :min_cost; end
+    class << self
+      attr_accessor :min_cost # :nodoc:
+    end
     self.min_cost = false
 
     module ClassMethods
@@ -15,12 +17,12 @@ module ActiveModel
       # argument. You can add more validations by hand if need be.
       #
       # If you don't need the confirmation validation, just don't set any
-      # value to the password_confirmation attribute and the the validation
+      # value to the password_confirmation attribute and the validation
       # will not be triggered.
       #
-      # You need to add bcrypt (~> 3.1.7) to Gemfile to use #has_secure_password:
+      # You need to add bcrypt-ruby (~> 3.1.2) to Gemfile to use #has_secure_password:
       #
-      #   gem 'bcrypt', '~> 3.1.7'
+      #   gem 'bcrypt-ruby', '~> 3.1.2'
       #
       # Example using Active Record (which automatically includes ActiveModel::SecurePassword):
       #
@@ -40,13 +42,13 @@ module ActiveModel
       #   User.find_by(name: 'david').try(:authenticate, 'notright')      # => false
       #   User.find_by(name: 'david').try(:authenticate, 'mUc3m00RsqyRe') # => user
       def has_secure_password(options = {})
-        # Load bcrypt gem only when has_secure_password is used.
+        # Load bcrypt-ruby only when has_secure_password is used.
         # This is to avoid ActiveModel (and by extension the entire framework)
         # being dependent on a binary library.
         begin
           require 'bcrypt'
         rescue LoadError
-          $stderr.puts "You don't have bcrypt installed in your application. Please add it to your Gemfile and run bundle install"
+          $stderr.puts "You don't have bcrypt-ruby installed in your application. Please add it to your Gemfile and run bundle install"
           raise
         end
 
@@ -55,9 +57,9 @@ module ActiveModel
         include InstanceMethodsOnActivation
 
         if options.fetch(:validations, true)
-          validates_confirmation_of :password, if: lambda { |m| m.password.present? }
-          validates_presence_of     :password, :on => :create
-          validates_presence_of     :password_confirmation, if: lambda { |m| m.password.present? }
+          validates_confirmation_of :password, if: :should_confirm_password?
+          validates_presence_of     :password, on: :create
+          validates_presence_of     :password_confirmation, if: :should_confirm_password?
 
           before_create { raise "Password digest missing on new record" if password_digest.blank? }
         end
@@ -108,6 +110,12 @@ module ActiveModel
       def password_confirmation=(unencrypted_password)
         @password_confirmation = unencrypted_password
       end
+
+      private
+
+      def should_confirm_password?
+        password_confirmation && password.present?
+      end
     end
   end
 end

data/lib/active_model/serializers/json.rb

@@ -109,7 +109,7 @@ module ActiveModel
       #
       #     def attributes=(hash)
       #       hash.each do |key, value|
-      #         instance_variable_set("@#{key}", value)
+      #         send("#{key}=", value)
       #       end
       #     end
       #

data/lib/active_model/serializers/xml.rb

@@ -1,4 +1,4 @@
-require 'active_support/core_ext/class/attribute_accessors'
+require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/array/conversions'
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/core_ext/hash/slice'
@@ -79,7 +79,7 @@ module ActiveModel
           require 'builder' unless defined? ::Builder
 
           options[:indent]  ||= 2
-          options[:builder] ||= ::Builder::XmlMarkup.new(:indent => options[:indent])
+          options[:builder] ||= ::Builder::XmlMarkup.new(indent: options[:indent])
 
           @builder = options[:builder]
           @builder.instruct! unless options[:skip_instruct]
@@ -88,8 +88,8 @@ module ActiveModel
           root = ActiveSupport::XmlMini.rename_key(root, options)
 
           args = [root]
-          args << {:xmlns => options[:namespace]} if options[:namespace]
-          args << {:type => options[:type]} if options[:type] && !options[:skip_types]
+          args << { xmlns: options[:namespace] } if options[:namespace]
+          args << { type: options[:type] } if options[:type] && !options[:skip_types]
 
           @builder.tag!(*args) do
             add_attributes_and_methods
@@ -132,7 +132,7 @@ module ActiveModel
             records = records.to_ary
 
             tag  = ActiveSupport::XmlMini.rename_key(association.to_s, options)
-            type = options[:skip_types] ? { } : {:type => "array"}
+            type = options[:skip_types] ? { } : { type: "array" }
             association_name = association.to_s.singularize
             merged_options[:root] = association_name
 
@@ -145,7 +145,7 @@ module ActiveModel
                     record_type = {}
                   else
                     record_class = (record.class.to_s.underscore == association_name) ? nil : record.class.name
-                    record_type = {:type => record_class}
+                    record_type = { type: record_class }
                   end
 
                   record.to_xml merged_options.merge(record_type)
@@ -205,7 +205,7 @@ module ActiveModel
         Serializer.new(self, options).serialize(&block)
       end
 
-      # Sets the model +attributes+ from a JSON string. Returns +self+.
+      # Sets the model +attributes+ from an XML string. Returns +self+.
       #
       #   class Person
       #     include ActiveModel::Serializers::Xml

data/lib/active_model/translation.rb

@@ -41,7 +41,7 @@ module ActiveModel
     #
     # Specify +options+ with additional translating options.
     def human_attribute_name(attribute, options = {})
-      options   = { :count => 1 }.merge!(options)
+      options   = { count: 1 }.merge!(options)
       parts     = attribute.to_s.split(".")
       attribute = parts.pop
       namespace = parts.join("/") unless parts.empty?

data/lib/active_model/validations.rb

@@ -46,7 +46,7 @@ module ActiveModel
       include HelperMethods
 
       attr_accessor :validation_context
-      define_callbacks :validate, :scope => :name
+      define_callbacks :validate, scope: :name
 
       class_attribute :_validators
       self._validators = Hash.new { |h,k| h[k] = [] }
@@ -142,7 +142,9 @@ module ActiveModel
         if options.key?(:on)
           options = options.dup
           options[:if] = Array(options[:if])
-          options[:if].unshift("validation_context == :#{options[:on]}")
+          options[:if].unshift lambda { |o|
+            o.validation_context == options[:on]
+          }
         end
         args << options
         set_callback(:validate, *args, &block)
@@ -226,7 +228,6 @@ module ActiveModel
       #   Person.validators_on(:name)
       #   # => [
       #   #       #<ActiveModel::Validations::PresenceValidator:0x007fe604914e60 @attributes=[:name], @options={}>,
-      #   #       #<ActiveModel::Validations::InclusionValidator:0x007fe603bb8780 @attributes=[:age], @options={in:0..99}>
       #   #    ]
       def validators_on(*attributes)
         attributes.flat_map do |attribute|

data/lib/active_model/validations/acceptance.rb

@@ -3,7 +3,8 @@ module ActiveModel
   module Validations
     class AcceptanceValidator < EachValidator # :nodoc:
       def initialize(options)
-        super({ :allow_nil => true, :accept => "1" }.merge!(options))
+        super({ allow_nil: true, accept: "1" }.merge!(options))
+        setup!(options[:class])
       end
 
       def validate_each(record, attribute, value)
@@ -12,7 +13,8 @@ module ActiveModel
         end
       end
 
-      def setup(klass)
+      private
+      def setup!(klass)
         attr_readers = attributes.reject { |name| klass.attribute_method?(name) }
         attr_writers = attributes.reject { |name| klass.attribute_method?("#{name}=") }
         klass.send(:attr_reader, *attr_readers)

data/lib/active_model/validations/callbacks.rb

@@ -22,7 +22,10 @@ module ActiveModel
 
       included do
         include ActiveSupport::Callbacks
-        define_callbacks :validation, :terminator => "result == false", :skip_after_callbacks_if_terminated => true, :scope => [:kind, :name]
+        define_callbacks :validation,
+                         terminator: ->(_,result) { result == false },
+                         skip_after_callbacks_if_terminated: true,
+                         scope: [:kind, :name]
       end
 
       module ClassMethods
@@ -55,7 +58,9 @@ module ActiveModel
           if options.is_a?(Hash) && options[:on]
             options[:if] = Array(options[:if])
             options[:on] = Array(options[:on])
-            options[:if].unshift("#{options[:on]}.include? self.validation_context")
+            options[:if].unshift lambda { |o|
+              options[:on].include? o.validation_context
+            }
           end
           set_callback(:validation, :before, *args, &block)
         end