1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/activemodel/lib/active_model/lint.rb

94 lines
3.6 KiB
Ruby
Raw Normal View History

2009-08-29 02:49:18 -04:00
# You can test whether an object is compliant with the ActiveModel API by
# including ActiveModel::Lint::Tests in your TestCase. It will included
# tests that tell you whether your object is fully compliant, or if not,
2009-08-29 02:49:18 -04:00
# which aspects of the API are not implemented.
#
# These tests do not attempt to determine the semantic correctness of the
# returned values. For instance, you could implement valid? to always
# return true, and the tests would pass. It is up to you to ensure that
# the values are semantically meaningful.
#
# Objects you pass in are expected to return a compliant object from a
# call to to_model. It is perfectly fine for to_model to return self.
module ActiveModel
module Lint
module Tests
2009-08-29 02:49:18 -04:00
# valid?
# ------
#
# Returns a boolean that specifies whether the object is in a valid or invalid
# state.
def test_valid?
assert model.respond_to?(:valid?), "The model should respond to valid?"
assert_boolean model.valid?, "valid?"
2009-08-29 02:49:18 -04:00
end
# new_record?
# -----------
#
# Returns a boolean that specifies whether the object has been persisted yet.
# This is used when calculating the URL for an object. If the object is
# not persisted, a form for that object, for instance, will be POSTed to the
# collection. If it is persisted, a form for the object will put PUTed to the
# URL for the object.
def test_new_record?
assert model.respond_to?(:new_record?), "The model should respond to new_record?"
assert_boolean model.new_record?, "new_record?"
2009-08-29 02:49:18 -04:00
end
def test_destroyed?
assert model.respond_to?(:destroyed?), "The model should respond to destroyed?"
assert_boolean model.destroyed?, "destroyed?"
2009-08-29 02:49:18 -04:00
end
2009-12-31 08:19:30 -05:00
# naming
# ------
#
# Model.model_name must returns a string with some convenience methods as
# :human and :partial_path. Check ActiveModel::Naming for more information.
#
def test_model_naming
assert model.class.respond_to?(:model_name), "The model should respond to model_name"
model_name = model.class.model_name
assert_kind_of String, model_name
assert_kind_of String, model_name.human
assert_kind_of String, model_name.partial_path
assert_kind_of String, model_name.singular
assert_kind_of String, model_name.plural
2009-12-31 08:19:30 -05:00
end
2009-08-29 02:49:18 -04:00
# errors
# ------
#
# Returns an object that has :[] and :full_messages defined on it. See below
# for more details.
# Returns an Array of Strings that are the errors for the attribute in
# question. If localization is used, the Strings should be localized
# for the current locale. If no error is present, this method should
# return an empty Array.
def test_errors_aref
assert model.respond_to?(:errors), "The model should respond to errors"
assert model.errors[:hello].is_a?(Array), "errors#[] should return an Array"
2009-08-29 02:49:18 -04:00
end
# Returns an Array of all error messages for the object. Each message
# should contain information about the field, if applicable.
def test_errors_full_messages
assert model.respond_to?(:errors), "The model should respond to errors"
assert model.errors.full_messages.is_a?(Array), "errors#full_messages should return an Array"
end
2009-08-29 02:49:18 -04:00
private
def model
assert @model.respond_to?(:to_model), "The object should respond_to to_model"
@model.to_model
2009-08-29 02:49:18 -04:00
end
def assert_boolean(result, name)
assert result == true || result == false, "#{name} should be a boolean"
end
2009-08-29 02:49:18 -04:00
end
end
end