activemodel 3.2.22.5 → 4.0.0.beta1

data/lib/active_model/serializers/xml.rb

@@ -1,8 +1,8 @@
-require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/class/attribute_accessors'
 require 'active_support/core_ext/array/conversions'
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/time/acts_like'
 
 module ActiveModel
   module Serializers
@@ -21,7 +21,11 @@ module ActiveModel
 
           def initialize(name, serializable, value)
             @name, @serializable = name, serializable
-            value  = value.in_time_zone if value.respond_to?(:in_time_zone)
+
+            if value.acts_like?(:time) && value.respond_to?(:in_time_zone)
+              value  = value.in_time_zone
+            end
+
             @value = value
             @type  = compute_type
           end
@@ -60,7 +64,7 @@ module ActiveModel
         end
 
         def serializable_collection
-          methods = Array.wrap(options[:methods]).map(&:to_s)
+          methods = Array(options[:methods]).map(&:to_s)
           serializable_hash.map do |name, value|
             name = name.to_s
             if methods.include?(name)
@@ -115,12 +119,18 @@ module ActiveModel
           end
         end
 
-        # TODO This can likely be cleaned up to simple use ActiveSupport::XmlMini.to_tag as well.
+        # TODO: This can likely be cleaned up to simple use ActiveSupport::XmlMini.to_tag as well.
         def add_associations(association, records, opts)
           merged_options = opts.merge(options.slice(:builder, :indent))
           merged_options[:skip_instruct] = true
 
-          if records.is_a?(Enumerable)
+          [:skip_types, :dasherize, :camelize].each do |key|
+            merged_options[key] = options[key] if merged_options[key].nil? && !options[key].nil?
+          end
+
+          if records.respond_to?(:to_ary)
+            records = records.to_ary
+
             tag  = ActiveSupport::XmlMini.rename_key(association.to_s, options)
             type = options[:skip_types] ? { } : {:type => "array"}
             association_name = association.to_s.singularize
@@ -155,7 +165,7 @@ module ActiveModel
 
         def add_procs
           if procs = options.delete(:procs)
-            Array.wrap(procs).each do |proc|
+            Array(procs).each do |proc|
               if proc.arity == 1
                 proc.call(options)
               else
@@ -169,8 +179,8 @@ module ActiveModel
       # Returns XML representing the model. Configuration can be
       # passed through +options+.
       #
-      # Without any +options+, the returned XML string will include all the model's
-      # attributes. For example:
+      # Without any +options+, the returned XML string will include all the
+      # model's attributes.
       #
       #   user = User.find(1)
       #   user.to_xml
@@ -180,21 +190,45 @@ module ActiveModel
       #     <id type="integer">1</id>
       #     <name>David</name>
       #     <age type="integer">16</age>
-      #     <created-at type="datetime">2011-01-30T22:29:23Z</created-at>
+      #     <created-at type="dateTime">2011-01-30T22:29:23Z</created-at>
       #   </user>
       #
-      # The <tt>:only</tt> and <tt>:except</tt> options can be used to limit the attributes
-      # included, and work similar to the +attributes+ method.
+      # The <tt>:only</tt> and <tt>:except</tt> options can be used to limit the
+      # attributes included, and work similar to the +attributes+ method.
       #
       # To include the result of some method calls on the model use <tt>:methods</tt>.
       #
       # To include associations use <tt>:include</tt>.
       #
-      # For further documentation see activerecord/lib/active_record/serializers/xml_serializer.xml.
+      # For further documentation, see <tt>ActiveRecord::Serialization#to_xml</tt>
       def to_xml(options = {}, &block)
         Serializer.new(self, options).serialize(&block)
       end
 
+      # Sets the model +attributes+ from a JSON string. Returns +self+.
+      #
+      #   class Person
+      #     include ActiveModel::Serializers::Xml
+      #
+      #     attr_accessor :name, :age, :awesome
+      #
+      #     def attributes=(hash)
+      #       hash.each do |key, value|
+      #         instance_variable_set("@#{key}", value)
+      #       end
+      #     end
+      #
+      #     def attributes
+      #       instance_values
+      #     end
+      #   end
+      #
+      #   xml = { name: 'bob', age: 22, awesome:true }.to_xml
+      #   person = Person.new
+      #   person.from_xml(xml) # => #<Person:0x007fec5e3b3c40 @age=22, @awesome=true, @name="bob">
+      #   person.name          # => "bob"
+      #   person.age           # => 22
+      #   person.awesome       # => true
       def from_xml(xml)
         self.attributes = Hash.from_xml(xml).values.first
         self

data/lib/active_model/test_case.rb

@@ -1,16 +1,4 @@
 module ActiveModel #:nodoc:
   class TestCase < ActiveSupport::TestCase #:nodoc:
-    def with_kcode(kcode)
-      if RUBY_VERSION < '1.9'
-        orig_kcode, $KCODE = $KCODE, kcode
-        begin
-          yield
-        ensure
-          $KCODE = orig_kcode
-        end
-      else
-        yield
-      end
-    end
   end
 end

data/lib/active_model/translation.rb

@@ -1,8 +1,6 @@
-require 'active_support/core_ext/hash/reverse_merge'
-
 module ActiveModel
 
-  # == Active Model Translation
+  # == Active \Model \Translation
   #
   # Provides integration between your object and the Rails internationalization
   # (i18n) framework.
@@ -43,19 +41,20 @@ module ActiveModel
     #
     # Specify +options+ with additional translating options.
     def human_attribute_name(attribute, options = {})
-      defaults  = []
+      options   = { :count => 1 }.merge!(options)
       parts     = attribute.to_s.split(".")
       attribute = parts.pop
       namespace = parts.join("/") unless parts.empty?
+      attributes_scope = "#{self.i18n_scope}.attributes"
 
       if namespace
-        lookup_ancestors.each do |klass|
-          defaults << :"#{self.i18n_scope}.attributes.#{klass.model_name.i18n_key}/#{namespace}.#{attribute}"
+        defaults = lookup_ancestors.map do |klass|
+          :"#{attributes_scope}.#{klass.model_name.i18n_key}/#{namespace}.#{attribute}"
         end
-        defaults << :"#{self.i18n_scope}.attributes.#{namespace}.#{attribute}"
+        defaults << :"#{attributes_scope}.#{namespace}.#{attribute}"
       else
-        lookup_ancestors.each do |klass|
-          defaults << :"#{self.i18n_scope}.attributes.#{klass.model_name.i18n_key}.#{attribute}"
+        defaults = lookup_ancestors.map do |klass|
+          :"#{attributes_scope}.#{klass.model_name.i18n_key}.#{attribute}"
         end
       end
 
@@ -63,7 +62,7 @@ module ActiveModel
       defaults << options.delete(:default) if options[:default]
       defaults << attribute.humanize
 
-      options.reverse_merge! :count => 1, :default => defaults
+      options[:default] = defaults
       I18n.translate(defaults.shift, options)
     end
   end

data/lib/active_model/validations.rb

@@ -1,15 +1,10 @@
 require 'active_support/core_ext/array/extract_options'
-require 'active_support/core_ext/array/wrap'
-require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/hash/except'
-require 'active_model/errors'
-require 'active_model/validations/callbacks'
-require 'active_model/validator'
 
 module ActiveModel
 
-  # == Active Model Validations
+  # == Active \Model Validations
   #
   # Provides a full validation framework to your objects.
   #
@@ -35,17 +30,16 @@ module ActiveModel
   #   person.first_name = 'zoolander'
   #   person.valid?                   # => false
   #   person.invalid?                 # => true
-  #   person.errors                   # => #<OrderedHash {:first_name=>["starts with z."]}>
-  #
-  # Note that <tt>ActiveModel::Validations</tt> automatically adds an +errors+ method
-  # to your instances initialized with a new <tt>ActiveModel::Errors</tt> object, so
-  # there is no need for you to do this manually.
+  #   person.errors.messages          # => {first_name:["starts with z."]}
   #
+  # Note that <tt>ActiveModel::Validations</tt> automatically adds an +errors+
+  # method to your instances initialized with a new <tt>ActiveModel::Errors</tt>
+  # object, so there is no need for you to do this manually.
   module Validations
     extend ActiveSupport::Concern
-    include ActiveSupport::Callbacks
 
     included do
+      extend ActiveModel::Callbacks
       extend ActiveModel::Translation
 
       extend  HelperMethods
@@ -66,27 +60,27 @@ module ActiveModel
       #
       #     attr_accessor :first_name, :last_name
       #
-      #     validates_each :first_name, :last_name do |record, attr, value|
+      #     validates_each :first_name, :last_name, allow_blank: true do |record, attr, value|
       #       record.errors.add attr, 'starts with z.' if value.to_s[0] == ?z
       #     end
       #   end
       #
       # Options:
       # * <tt>:on</tt> - Specifies the context where this validation is active
-      #   (e.g. <tt>:on => :create</tt> or <tt>:on => :custom_validation_context</tt>)
+      #   (e.g. <tt>on: :create</tt> or <tt>on: :custom_validation_context</tt>)
       # * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+.
       # * <tt>:allow_blank</tt> - Skip validation if attribute is blank.
       # * <tt>:if</tt> - Specifies a method, proc or string to call to determine
-      #   if the validation should occur (e.g. <tt>:if => :allow_validation</tt>,
-      #   or <tt>:if => Proc.new { |user| user.signup_step > 2 }</tt>). The method,
-      #   proc or string should return or evaluate to a true or false value.
-      # * <tt>:unless</tt> - Specifies a method, proc or string to call to determine if the validation should
-      #   not occur (e.g. <tt>:unless => :skip_validation</tt>, or
-      #   <tt>:unless => Proc.new { |user| user.signup_step <= 2 }</tt>). The
-      #   method, proc or string should return or evaluate to a true or false value.
+      #   if the validation should occur (e.g. <tt>if: :allow_validation</tt>,
+      #   or <tt>if: Proc.new { |user| user.signup_step > 2 }</tt>). The method,
+      #   proc or string should return or evaluate to a +true+ or +false+ value.
+      # * <tt>:unless</tt> - Specifies a method, proc or string to call to
+      #   determine if the validation should not occur (e.g. <tt>unless: :skip_validation</tt>,
+      #   or <tt>unless: Proc.new { |user| user.signup_step <= 2 }</tt>). The
+      #   method, proc or string should return or evaluate to a +true+ or +false+
+      #   value.
       def validates_each(*attr_names, &block)
-        options = attr_names.extract_options!.symbolize_keys
-        validates_with BlockValidator, options.merge(:attributes => attr_names.flatten), &block
+        validates_with BlockValidator, _merge_attributes(attr_names), &block
       end
 
       # Adds a validation method or block to the class. This is useful when
@@ -101,7 +95,7 @@ module ActiveModel
       #     validate :must_be_friends
       #
       #     def must_be_friends
-      #       errors.add(:base, "Must be friends to leave a comment") unless commenter.friend_of?(commentee)
+      #       errors.add(:base, 'Must be friends to leave a comment') unless commenter.friend_of?(commentee)
       #     end
       #   end
       #
@@ -115,7 +109,7 @@ module ActiveModel
       #     end
       #
       #     def must_be_friends
-      #       errors.add(:base, "Must be friends to leave a comment") unless commenter.friend_of?(commentee)
+      #       errors.add(:base, 'Must be friends to leave a comment') unless commenter.friend_of?(commentee)
       #     end
       #   end
       #
@@ -125,15 +119,29 @@ module ActiveModel
       #     include ActiveModel::Validations
       #
       #     validate do
-      #       errors.add(:base, "Must be friends to leave a comment") unless commenter.friend_of?(commentee)
+      #       errors.add(:base, 'Must be friends to leave a comment') unless commenter.friend_of?(commentee)
       #     end
       #   end
       #
+      # Options:
+      # * <tt>:on</tt> - Specifies the context where this validation is active
+      #   (e.g. <tt>on: :create</tt> or <tt>on: :custom_validation_context</tt>)
+      # * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+.
+      # * <tt>:allow_blank</tt> - Skip validation if attribute is blank.
+      # * <tt>:if</tt> - Specifies a method, proc or string to call to determine
+      #   if the validation should occur (e.g. <tt>if: :allow_validation</tt>,
+      #   or <tt>if: Proc.new { |user| user.signup_step > 2 }</tt>). The method,
+      #   proc or string should return or evaluate to a +true+ or +false+ value.
+      # * <tt>:unless</tt> - Specifies a method, proc or string to call to
+      #   determine if the validation should not occur (e.g. <tt>unless: :skip_validation</tt>,
+      #   or <tt>unless: Proc.new { |user| user.signup_step <= 2 }</tt>). The
+      #   method, proc or string should return or evaluate to a +true+ or +false+
+      #   value.
       def validate(*args, &block)
         options = args.extract_options!
         if options.key?(:on)
           options = options.dup
-          options[:if] = Array.wrap(options[:if])
+          options[:if] = Array(options[:if])
           options[:if].unshift("validation_context == :#{options[:on]}")
         end
         args << options
@@ -142,53 +150,121 @@ module ActiveModel
 
       # List all validators that are being used to validate the model using
       # +validates_with+ method.
+      #
+      #   class Person
+      #     include ActiveModel::Validations
+      #
+      #     validates_with MyValidator
+      #     validates_with OtherValidator, on: :create
+      #     validates_with StrictValidator, strict: true
+      #   end
+      #
+      #   Person.validators
+      #   # => [
+      #   #      #<MyValidator:0x007fbff403e808 @options={}>,
+      #   #      #<OtherValidator:0x007fbff403d930 @options={on: :create}>,
+      #   #      #<StrictValidator:0x007fbff3204a30 @options={strict:true}>
+      #   #    ]
       def validators
         _validators.values.flatten.uniq
       end
 
-      # List all validators that being used to validate a specific attribute.
+      # List all validators that are being used to validate a specific attribute.
+      #
+      #   class Person
+      #     include ActiveModel::Validations
+      #
+      #     attr_accessor :name , :age
+      #
+      #     validates_presence_of :name
+      #     validates_inclusion_of :age, in: 0..99
+      #   end
+      #
+      #   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.map do |attribute|
+        attributes.flat_map do |attribute|
           _validators[attribute.to_sym]
-        end.flatten
+        end
       end
 
-      # Check if method is an attribute method or not.
+      # Returns +true+ if +attribute+ is an attribute method, +false+ otherwise.
+      #
+      #  class Person
+      #    include ActiveModel::Validations
+      #
+      #    attr_accessor :name
+      #  end
+      #
+      #  User.attribute_method?(:name) # => true
+      #  User.attribute_method?(:age)  # => false
       def attribute_method?(attribute)
         method_defined?(attribute)
       end
 
       # Copy validators on inheritance.
-      def inherited(base)
+      def inherited(base) #:nodoc:
         dup = _validators.dup
         base._validators = dup.each { |k, v| dup[k] = v.dup }
         super
       end
     end
 
-    # Clean the +Errors+ object if instance is duped
-    def initialize_dup(other) # :nodoc:
+    # Clean the +Errors+ object if instance is duped.
+    def initialize_dup(other) #:nodoc:
       @errors = nil
-      super if defined?(super)
-    end
-
-    # Backport dup from 1.9 so that #initialize_dup gets called
-    unless Object.respond_to?(:initialize_dup, true)
-      def dup # :nodoc:
-        copy = super
-        copy.initialize_dup(self)
-        copy
-      end
+      super
     end
 
-    # Returns the +Errors+ object that holds all information about attribute error messages.
+    # Returns the +Errors+ object that holds all information about attribute
+    # error messages.
+    #
+    #   class Person
+    #     include ActiveModel::Validations
+    #
+    #     attr_accessor :name
+    #     validates_presence_of :name
+    #   end
+    #
+    #   person = Person.new
+    #   person.valid? # => false
+    #   person.errors # => #<ActiveModel::Errors:0x007fe603816640 @messages={name:["can't be blank"]}>
     def errors
       @errors ||= Errors.new(self)
     end
 
-    # Runs all the specified validations and returns true if no errors were added
-    # otherwise false. Context can optionally be supplied to define which callbacks
-    # to test against (the context is defined on the validations using :on).
+    # Runs all the specified validations and returns +true+ if no errors were
+    # added otherwise +false+.
+    #
+    #   class Person
+    #     include ActiveModel::Validations
+    #
+    #     attr_accessor :name
+    #     validates_presence_of :name
+    #   end
+    #
+    #   person = Person.new
+    #   person.name = ''
+    #   person.valid? # => false
+    #   person.name = 'david'
+    #   person.valid? # => true
+    #
+    # Context can optionally be supplied to define which callbacks to test
+    # against (the context is defined on the validations using <tt>:on</tt>).
+    #
+    #   class Person
+    #     include ActiveModel::Validations
+    #
+    #     attr_accessor :name
+    #     validates_presence_of :name, on: :new
+    #   end
+    #
+    #   person = Person.new
+    #   person.valid?       # => true
+    #   person.valid?(:new) # => false
     def valid?(context = nil)
       current_context, self.validation_context = validation_context, context
       errors.clear
@@ -197,8 +273,35 @@ module ActiveModel
       self.validation_context = current_context
     end
 
-    # Performs the opposite of <tt>valid?</tt>. Returns true if errors were added,
-    # false otherwise.
+    # Performs the opposite of <tt>valid?</tt>. Returns +true+ if errors were
+    # added, +false+ otherwise.
+    #
+    #   class Person
+    #     include ActiveModel::Validations
+    #
+    #     attr_accessor :name
+    #     validates_presence_of :name
+    #   end
+    #
+    #   person = Person.new
+    #   person.name = ''
+    #   person.invalid? # => true
+    #   person.name = 'david'
+    #   person.invalid? # => false
+    #
+    # Context can optionally be supplied to define which callbacks to test
+    # against (the context is defined on the validations using <tt>:on</tt>).
+    #
+    #   class Person
+    #     include ActiveModel::Validations
+    #
+    #     attr_accessor :name
+    #     validates_presence_of :name, on: :new
+    #   end
+    #
+    #   person = Person.new
+    #   person.invalid?       # => false
+    #   person.invalid?(:new) # => true
     def invalid?(context = nil)
       !valid?(context)
     end
@@ -219,12 +322,11 @@ module ActiveModel
     #       @data[key]
     #     end
     #   end
-    #
     alias :read_attribute_for_validation :send
 
   protected
 
-    def run_validations!
+    def run_validations! #:nodoc:
       run_callbacks :validate
       errors.empty?
     end