docs/ARCHITECTURE.md in active_model_serializers-0.10.0.rc4 vs docs/ARCHITECTURE.md in active_model_serializers-0.10.0.rc5

- old
+ new

@@ -1,7 +1,13 @@ [Back to Guides](README.md) +This document focuses on architecture the 0.10.x version of ActiveModelSerializers. If you are interested in the architecture of the 0.8 or 0.9 versions, +please refer to the [0.8 README](https://github.com/rails-api/active_model_serializers/blob/0-8-stable/README.md) or +[0.9 README](https://github.com/rails-api/active_model_serializers/blob/0-9-stable/README.md). + +The original design is also available [here](https://github.com/rails-api/active_model_serializers/blob/d72b66d4c5355b0ff0a75a04895fcc4ea5b0c65e/README.textile). + # ARCHITECTURE An **`ActiveModel::Serializer`** wraps a [serializable resource](https://github.com/rails/rails/blob/4-2-stable/activemodel/lib/active_model/serialization.rb) and exposes an `attributes` method, among a few others. It allows you to specify which attributes and associations should be represented in the serializatation of the resource. @@ -15,11 +21,11 @@ The **`ActiveModel::Adapter`** describes the structure of the JSON document generated from a serializer. For example, the `Attributes` example represents each serializer as its unmodified attributes. The `JsonApi` adapter represents the serializer as a [JSON API](http://jsonapi.org/) document. -The **`ActiveModel::SerializableResource`** acts to coordinate the serializer(s) and adapter +The **`ActiveModelSerializers::SerializableResource`** acts to coordinate the serializer(s) and adapter to an object that responds to `to_json`, and `as_json`. It is used in the controller to encapsulate the serialization resource when rendered. However, it can also be used on its own to serialize a resource outside of a controller, as well. ## Primitive handling @@ -54,20 +60,20 @@ - For a collection - `:serializer` specifies the collection serializer and - `:each_serializer` specifies the serializer for each resource in the collection. - For a single resource, the `:serializer` option is the resource serializer. - Options are partitioned in serializer options and adapter options. Keys for adapter options are specified by - [`ADAPTER_OPTIONS`](https://github.com/rails-api/active_model_serializers/blob/master/lib/active_model/serializable_resource.rb#L4). + [`ADAPTER_OPTION_KEYS`](https://github.com/rails-api/active_model_serializers/blob/master/lib/active_model_serializers/serializable_resource.rb#L5). The remaining options are serializer options. Details: 1. **ActionController::Serialization** - 1. `serializable_resource = ActiveModel::SerializableResource.new(resource, options)` + 1. `serializable_resource = ActiveModelSerializers::SerializableResource.new(resource, options)` 1. `options` are partitioned into `adapter_opts` and everything else (`serializer_opts`). - The adapter options keys for the are defined by `ADAPTER_OPTIONS`. -1. **ActiveModel::SerializableResource** + The `adapter_opts` keys are defined in `ActiveModelSerializers::SerializableResource::ADAPTER_OPTION_KEYS`. +1. **ActiveModelSerializers::SerializableResource** 1. `if serializable_resource.serializer?` (there is a serializer for the resource, and an adapter is used.) - Where `serializer?` is `use_adapter? && !!(serializer)` - Where `use_adapter?`: 'True when no explicit adapter given, or explicit value is truthy (non-nil); False when explicit adapter is falsy (nil or false)' - Where `serializer`: @@ -86,11 +92,11 @@ resource as defined by the serializer. ## What does a 'serializable resource' look like? - An `ActiveRecord::Base` object. -- Any Ruby object at passes or otherwise passes the +- Any Ruby object that passes the [Lint](http://www.rubydoc.info/github/rails-api/active_model_serializers/ActiveModel/Serializer/Lint/Tests) [code](https://github.com/rails-api/active_model_serializers/blob/master/lib/active_model/serializer/lint.rb). ActiveModelSerializers provides a [`ActiveModelSerializers::Model`](https://github.com/rails-api/active_model_serializers/blob/master/lib/active_model_serializers/model.rb), @@ -114,7 +120,7 @@ ``` would be serialized the same as ```ruby -ActiveModel::SerializableResource.new(MyModel.new(level: 'awesome'), adapter: :json).as_json +ActiveModelSerializers::SerializableResource.new(MyModel.new(level: 'awesome'), adapter: :json).as_json ```