Module: ActiveModel::Serializer::Lint::Tests

Defined in:
lib/active_model/serializer/lint.rb

Overview

Active Model Serializer Lint Tests

You can test whether an object is compliant with the Active Model Serializers API by including ActiveModel::Serializer::Lint::Tests in your TestCase. It will include tests that tell you whether your object is fully compliant, or if not, which aspects of the API are not implemented.

Note an object is not required to implement all APIs in order to work with Active Model Serializers. This module only intends to provide guidance in case you want all features out of the box.

These tests do not attempt to determine the semantic correctness of the returned values. For instance, you could implement serializable_hash to always return {}, and the tests would pass. It is up to you to ensure that the values are semantically meaningful.

Instance Method Summary (collapse)

Instance Method Details

- (Object) test_active_model_errors 



122
123
124
 
# File 'lib/active_model/serializer/lint.rb', line 122

def test_active_model_errors
  assert_respond_to resource, :errors
end

- (Object) test_active_model_errors_human_attribute_name 



126
127
128
129
 
# File 'lib/active_model/serializer/lint.rb', line 126

def test_active_model_errors_human_attribute_name
  assert_respond_to resource.class, :human_attribute_name
  assert_equal(-2, resource.class.method(:human_attribute_name).arity)
end

- (Object) test_active_model_errors_lookup_ancestors 



131
132
133
134
 
# File 'lib/active_model/serializer/lint.rb', line 131

def test_active_model_errors_lookup_ancestors
  assert_respond_to resource.class, :lookup_ancestors
  assert_equal 0, resource.class.method(:lookup_ancestors).arity
end

- (Object) test_as_json

Passes if the object responds to as_json and if it takes zero or one arguments. Fails otherwise.

as_json returns a hash representation of a serialized object. It may delegate to serializable_hash Typically, it is implemented either by including ActiveModel::Serialization which includes ActiveModel::Serializers::JSON. or by the JSON gem when required.



54
55
56
57
58
 
# File 'lib/active_model/serializer/lint.rb', line 54

def test_as_json
  assert_respond_to resource, :as_json
  resource.as_json
  resource.as_json(nil)
end

- (Object) test_cache_key

Passes if the object responds to cache_key Fails otherwise.

cache_key returns a (self-expiring) unique key for the object, and is part of the (self-expiring) cache_key, which is used by the adapter. It is not required unless caching is enabled.



79
80
81
82
83
 
# File 'lib/active_model/serializer/lint.rb', line 79

def test_cache_key
  assert_respond_to resource, :cache_key
  actual_arity = resource.method(:cache_key).arity
  assert_includes [-1, 0], actual_arity, "expected #{actual_arity.inspect} to be 0 or -1"
end

- (Object) test_id

Passes if the object responds to id and if it takes no arguments. Fails otherwise.

id returns a unique identifier for the object. It is not required unless caching is enabled.



104
105
106
107
 
# File 'lib/active_model/serializer/lint.rb', line 104

def test_id
  assert_respond_to resource, :id
  assert_equal 0, resource.method(:id).arity
end

- (Object) test_model_name

Passes if the object's class responds to model_name and if it is in an instance of ActiveModel::Name. Fails otherwise.

model_name returns an ActiveModel::Name instance. It is used by the serializer to identify the object's type. It is not required unless caching is enabled.



116
117
118
119
120
 
# File 'lib/active_model/serializer/lint.rb', line 116

def test_model_name
  resource_class = resource.class
  assert_respond_to resource_class, :model_name
  assert_instance_of resource_class.model_name, ActiveModel::Name
end

- (Object) test_read_attribute_for_serialization

Passes if the object responds to read_attribute_for_serialization and if it requires one argument (the attribute to be read). Fails otherwise.

read_attribute_for_serialization gets the attribute value for serialization Typically, it is implemented by including ActiveModel::Serialization.



36
37
38
39
40
41
42
43
 
# File 'lib/active_model/serializer/lint.rb', line 36

def test_read_attribute_for_serialization
  assert_respond_to resource, :read_attribute_for_serialization, 'The resource should respond to read_attribute_for_serialization'
  actual_arity = resource.method(:read_attribute_for_serialization).arity
  # using absolute value since arity is:
  #  1 for def read_attribute_for_serialization(name); end
  # -1 for alias :read_attribute_for_serialization :send
  assert_equal 1, actual_arity.abs, "expected #{actual_arity.inspect}.abs to be 1 or -1"
end

- (Object) test_serializable_hash

Passes if the object responds to serializable_hash and if it takes zero or one arguments. Fails otherwise.

serializable_hash returns a hash representation of a object's attributes. Typically, it is implemented by including ActiveModel::Serialization.



24
25
26
27
28
 
# File 'lib/active_model/serializer/lint.rb', line 24

def test_serializable_hash
  assert_respond_to resource, :serializable_hash, 'The resource should respond to serializable_hash'
  resource.serializable_hash
  resource.serializable_hash(nil)
end

- (Object) test_to_json

Passes if the object responds to to_json and if it takes zero or one arguments. Fails otherwise.

to_json returns a string representation (JSON) of a serialized object. It may be called on the result of as_json. Typically, it is implemented on all objects when the JSON gem is required.



67
68
69
70
71
 
# File 'lib/active_model/serializer/lint.rb', line 67

def test_to_json
  assert_respond_to resource, :to_json
  resource.to_json
  resource.to_json(nil)
end

- (Object) test_updated_at

Passes if the object responds to updated_at and if it takes no arguments. Fails otherwise.

updated_at returns a Time object or iso8601 string and is part of the (self-expiring) cache_key, which is used by the adapter. It is not required unless caching is enabled.



92
93
94
95
96
 
# File 'lib/active_model/serializer/lint.rb', line 92

def test_updated_at
  assert_respond_to resource, :updated_at
  actual_arity = resource.method(:updated_at).arity
  assert_equal 0, actual_arity
end