Skip to content
This repository
tree: 4bbd05c90e
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 68 lines (64 sloc) 3.103 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
module ActiveModel
  # == Active Model Acceptance Validator
  module Validations
    class AcceptanceValidator < EachValidator
      def initialize(options)
        super(options.reverse_merge(:allow_nil => true, :accept => "1"))
      end

      def validate_each(record, attribute, value)
        unless value == options[:accept]
          record.errors.add(attribute, :accepted, options.except(:accept, :allow_nil))
        end
      end

      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)
        klass.send(:attr_writer, *attr_writers)
      end
    end

    module HelperMethods
      # Encapsulates the pattern of wanting to validate the acceptance of a
      # terms of service check box (or similar agreement). Example:
      #
      # class Person < ActiveRecord::Base
      # validates_acceptance_of :terms_of_service
      # validates_acceptance_of :eula, :message => "must be abided"
      # end
      #
      # If the database column does not exist, the +terms_of_service+ attribute
      # is entirely virtual. This check is performed only if +terms_of_service+
      # is not +nil+ and by default on save.
      #
      # Configuration options:
      # * <tt>:message</tt> - A custom error message (default is: "must be
      # accepted").
      # * <tt>:on</tt> - Specifies when this validation is active. Runs in all
      # validation contexts by default (+nil+), other options are <tt>:create</tt>
      # and <tt>:update</tt>.
      # * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+ (default
      # is true).
      # * <tt>:accept</tt> - Specifies value that is considered accepted.
      # The default value is a string "1", which makes it easy to relate to
      # an HTML checkbox. This should be set to +true+ if you are validating
      # a database column, since the attribute is typecast from "1" to +true+
      # before validation.
      # * <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 (for example,
      # <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.
      # * <tt>:strict</tt> - Specifies whether validation should be strict.
      # See <tt>ActiveModel::Validation#validates!</tt> for more information.
      def validates_acceptance_of(*attr_names)
        validates_with AcceptanceValidator, _merge_attributes(attr_names)
      end
    end
  end
end
Something went wrong with that request. Please try again.