RubyGems - active_model_serializers - Versions diffs - 0.10.7 → 0.10.14 - Mend

active_model_serializers 0.10.7 → 0.10.14

Files changed (213) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +82 -1
data/README.md +20 -21
data/lib/action_controller/serialization.rb +11 -1
data/lib/active_model/serializable_resource.rb +2 -0
data/lib/active_model/serializer/adapter/attributes.rb +2 -0
data/lib/active_model/serializer/adapter/base.rb +2 -0
data/lib/active_model/serializer/adapter/json.rb +2 -0
data/lib/active_model/serializer/adapter/json_api.rb +2 -0
data/lib/active_model/serializer/adapter/null.rb +2 -0
data/lib/active_model/serializer/adapter.rb +2 -0
data/lib/active_model/serializer/array_serializer.rb +2 -0
data/lib/active_model/serializer/association.rb +2 -0
data/lib/active_model/serializer/attribute.rb +2 -0
data/lib/active_model/serializer/belongs_to_reflection.rb +2 -0
data/lib/active_model/serializer/collection_serializer.rb +16 -7
data/lib/active_model/serializer/concerns/caching.rb +7 -2
data/lib/active_model/serializer/error_serializer.rb +2 -0
data/lib/active_model/serializer/errors_serializer.rb +2 -0
data/lib/active_model/serializer/field.rb +2 -0
data/lib/active_model/serializer/fieldset.rb +3 -1
data/lib/active_model/serializer/has_many_reflection.rb +2 -0
data/lib/active_model/serializer/has_one_reflection.rb +2 -0
data/lib/active_model/serializer/lazy_association.rb +6 -2
data/lib/active_model/serializer/link.rb +23 -0
data/lib/active_model/serializer/lint.rb +2 -0
data/lib/active_model/serializer/null.rb +2 -0
data/lib/active_model/serializer/reflection.rb +9 -4
data/lib/active_model/serializer/version.rb +3 -1
data/lib/active_model/serializer.rb +35 -18
data/lib/active_model_serializers/adapter/attributes.rb +23 -0
data/lib/active_model_serializers/adapter/base.rb +2 -0
data/lib/active_model_serializers/adapter/json.rb +2 -0
data/lib/active_model_serializers/adapter/json_api/deserialization.rb +2 -0
data/lib/active_model_serializers/adapter/json_api/error.rb +2 -0
data/lib/active_model_serializers/adapter/json_api/jsonapi.rb +2 -0
data/lib/active_model_serializers/adapter/json_api/link.rb +2 -0
data/lib/active_model_serializers/adapter/json_api/meta.rb +2 -0
data/lib/active_model_serializers/adapter/json_api/pagination_links.rb +7 -1
data/lib/active_model_serializers/adapter/json_api/relationship.rb +2 -0
data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +3 -1
data/lib/active_model_serializers/adapter/json_api.rb +14 -9
data/lib/active_model_serializers/adapter/null.rb +2 -0
data/lib/active_model_serializers/adapter.rb +3 -1
data/lib/active_model_serializers/callbacks.rb +2 -0
data/lib/active_model_serializers/deprecate.rb +2 -0
data/lib/active_model_serializers/deserialization.rb +2 -0
data/lib/active_model_serializers/json_pointer.rb +2 -0
data/lib/active_model_serializers/logging.rb +2 -0
data/lib/active_model_serializers/lookup_chain.rb +2 -0
data/lib/active_model_serializers/model/caching.rb +26 -0
data/lib/active_model_serializers/model.rb +2 -0
data/lib/active_model_serializers/railtie.rb +4 -0
data/lib/active_model_serializers/register_jsonapi_renderer.rb +2 -0
data/lib/active_model_serializers/serializable_resource.rb +4 -2
data/lib/active_model_serializers/serialization_context.rb +2 -0
data/lib/active_model_serializers/test/schema.rb +2 -0
data/lib/active_model_serializers/test/serializer.rb +2 -0
data/lib/active_model_serializers/test.rb +2 -0
data/lib/active_model_serializers.rb +20 -10
data/lib/generators/rails/resource_override.rb +2 -0
data/lib/generators/rails/serializer_generator.rb +2 -0
data/lib/grape/active_model_serializers.rb +2 -0
data/lib/grape/formatters/active_model_serializers.rb +2 -0
data/lib/grape/helpers/active_model_serializers.rb +2 -0
data/lib/tasks/rubocop.rake +8 -1
metadata +53 -328
data/.github/ISSUE_TEMPLATE.md +0 -29
data/.github/PULL_REQUEST_TEMPLATE.md +0 -15
data/.gitignore +0 -35
data/.rubocop.yml +0 -105
data/.simplecov +0 -110
data/.travis.yml +0 -52
data/CODE_OF_CONDUCT.md +0 -74
data/CONTRIBUTING.md +0 -105
data/Gemfile +0 -72
data/Rakefile +0 -74
data/active_model_serializers.gemspec +0 -63
data/appveyor.yml +0 -28
data/bin/bench +0 -171
data/bin/bench_regression +0 -316
data/bin/rubocop +0 -38
data/bin/serve_benchmark +0 -39
data/docs/README.md +0 -41
data/docs/STYLE.md +0 -58
data/docs/general/adapters.md +0 -269
data/docs/general/caching.md +0 -58
data/docs/general/configuration_options.md +0 -185
data/docs/general/deserialization.md +0 -100
data/docs/general/fields.md +0 -31
data/docs/general/getting_started.md +0 -133
data/docs/general/instrumentation.md +0 -40
data/docs/general/key_transforms.md +0 -40
data/docs/general/logging.md +0 -21
data/docs/general/rendering.md +0 -293
data/docs/general/serializers.md +0 -483
data/docs/how-open-source-maintained.jpg +0 -0
data/docs/howto/add_pagination_links.md +0 -138
data/docs/howto/add_relationship_links.md +0 -140
data/docs/howto/add_root_key.md +0 -62
data/docs/howto/grape_integration.md +0 -42
data/docs/howto/outside_controller_use.md +0 -66
data/docs/howto/passing_arbitrary_options.md +0 -27
data/docs/howto/serialize_poro.md +0 -73
data/docs/howto/test.md +0 -154
data/docs/howto/upgrade_from_0_8_to_0_10.md +0 -265
data/docs/integrations/ember-and-json-api.md +0 -147
data/docs/integrations/grape.md +0 -19
data/docs/jsonapi/errors.md +0 -56
data/docs/jsonapi/schema/schema.json +0 -366
data/docs/jsonapi/schema.md +0 -151
data/docs/rfcs/0000-namespace.md +0 -106
data/docs/rfcs/template.md +0 -15
data/test/action_controller/adapter_selector_test.rb +0 -62
data/test/action_controller/explicit_serializer_test.rb +0 -135
data/test/action_controller/json/include_test.rb +0 -246
data/test/action_controller/json_api/deserialization_test.rb +0 -112
data/test/action_controller/json_api/errors_test.rb +0 -40
data/test/action_controller/json_api/fields_test.rb +0 -66
data/test/action_controller/json_api/linked_test.rb +0 -202
data/test/action_controller/json_api/pagination_test.rb +0 -124
data/test/action_controller/json_api/transform_test.rb +0 -189
data/test/action_controller/lookup_proc_test.rb +0 -49
data/test/action_controller/namespace_lookup_test.rb +0 -232
data/test/action_controller/serialization_scope_name_test.rb +0 -235
data/test/action_controller/serialization_test.rb +0 -472
data/test/active_model_serializers/adapter_for_test.rb +0 -208
data/test/active_model_serializers/json_pointer_test.rb +0 -22
data/test/active_model_serializers/logging_test.rb +0 -77
data/test/active_model_serializers/model_test.rb +0 -142
data/test/active_model_serializers/railtie_test_isolated.rb +0 -68
data/test/active_model_serializers/register_jsonapi_renderer_test_isolated.rb +0 -161
data/test/active_model_serializers/serialization_context_test_isolated.rb +0 -71
data/test/active_model_serializers/test/schema_test.rb +0 -131
data/test/active_model_serializers/test/serializer_test.rb +0 -62
data/test/active_record_test.rb +0 -9
data/test/adapter/attributes_test.rb +0 -40
data/test/adapter/deprecation_test.rb +0 -100
data/test/adapter/json/belongs_to_test.rb +0 -45
data/test/adapter/json/collection_test.rb +0 -104
data/test/adapter/json/has_many_test.rb +0 -53
data/test/adapter/json/transform_test.rb +0 -93
data/test/adapter/json_api/belongs_to_test.rb +0 -155
data/test/adapter/json_api/collection_test.rb +0 -96
data/test/adapter/json_api/errors_test.rb +0 -76
data/test/adapter/json_api/fields_test.rb +0 -96
data/test/adapter/json_api/has_many_explicit_serializer_test.rb +0 -96
data/test/adapter/json_api/has_many_test.rb +0 -173
data/test/adapter/json_api/has_one_test.rb +0 -80
data/test/adapter/json_api/include_data_if_sideloaded_test.rb +0 -213
data/test/adapter/json_api/json_api_test.rb +0 -33
data/test/adapter/json_api/linked_test.rb +0 -413
data/test/adapter/json_api/links_test.rb +0 -95
data/test/adapter/json_api/pagination_links_test.rb +0 -206
data/test/adapter/json_api/parse_test.rb +0 -137
data/test/adapter/json_api/relationship_test.rb +0 -397
data/test/adapter/json_api/resource_meta_test.rb +0 -100
data/test/adapter/json_api/toplevel_jsonapi_test.rb +0 -82
data/test/adapter/json_api/transform_test.rb +0 -512
data/test/adapter/json_api/type_test.rb +0 -193
data/test/adapter/json_test.rb +0 -46
data/test/adapter/null_test.rb +0 -22
data/test/adapter/polymorphic_test.rb +0 -218
data/test/adapter_test.rb +0 -67
data/test/array_serializer_test.rb +0 -22
data/test/benchmark/app.rb +0 -65
data/test/benchmark/benchmarking_support.rb +0 -67
data/test/benchmark/bm_active_record.rb +0 -81
data/test/benchmark/bm_adapter.rb +0 -38
data/test/benchmark/bm_caching.rb +0 -119
data/test/benchmark/bm_lookup_chain.rb +0 -83
data/test/benchmark/bm_transform.rb +0 -45
data/test/benchmark/config.ru +0 -3
data/test/benchmark/controllers.rb +0 -83
data/test/benchmark/fixtures.rb +0 -219
data/test/cache_test.rb +0 -651
data/test/collection_serializer_test.rb +0 -127
data/test/fixtures/active_record.rb +0 -113
data/test/fixtures/poro.rb +0 -225
data/test/generators/scaffold_controller_generator_test.rb +0 -24
data/test/generators/serializer_generator_test.rb +0 -75
data/test/grape_test.rb +0 -196
data/test/lint_test.rb +0 -49
data/test/logger_test.rb +0 -20
data/test/poro_test.rb +0 -9
data/test/serializable_resource_test.rb +0 -79
data/test/serializers/association_macros_test.rb +0 -37
data/test/serializers/associations_test.rb +0 -468
data/test/serializers/attribute_test.rb +0 -153
data/test/serializers/attributes_test.rb +0 -52
data/test/serializers/caching_configuration_test_isolated.rb +0 -170
data/test/serializers/configuration_test.rb +0 -32
data/test/serializers/fieldset_test.rb +0 -14
data/test/serializers/meta_test.rb +0 -202
data/test/serializers/options_test.rb +0 -32
data/test/serializers/read_attribute_for_serialization_test.rb +0 -79
data/test/serializers/reflection_test.rb +0 -427
data/test/serializers/root_test.rb +0 -21
data/test/serializers/serialization_test.rb +0 -55
data/test/serializers/serializer_for_test.rb +0 -136
data/test/serializers/serializer_for_with_namespace_test.rb +0 -88
data/test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json +0 -6
data/test/support/isolated_unit.rb +0 -84
data/test/support/rails5_shims.rb +0 -53
data/test/support/rails_app.rb +0 -38
data/test/support/schemas/active_model_serializers/test/schema_test/my/index.json +0 -6
data/test/support/schemas/active_model_serializers/test/schema_test/my/show.json +0 -6
data/test/support/schemas/custom/show.json +0 -7
data/test/support/schemas/hyper_schema.json +0 -93
data/test/support/schemas/render_using_json_api.json +0 -43
data/test/support/schemas/simple_json_pointers.json +0 -10
data/test/support/serialization_testing.rb +0 -79
data/test/test_helper.rb +0 -70

data/docs/jsonapi/schema/schema.json DELETED Viewed

@@ -1,366 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "JSON API Schema",
-  "description": "This is a schema for responses in the JSON API format. For more, see http://jsonapi.org",
-  "oneOf": [
-    {
-      "$ref": "#/definitions/success"
-    },
-    {
-      "$ref": "#/definitions/failure"
-    },
-    {
-      "$ref": "#/definitions/info"
-    }
-  ],
-  "definitions": {
-    "success": {
-      "type": "object",
-      "required": [
-        "data"
-      ],
-      "properties": {
-        "data": {
-          "$ref": "#/definitions/data"
-        },
-        "included": {
-          "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".",
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/resource"
-          },
-          "uniqueItems": true
-        },
-        "meta": {
-          "$ref": "#/definitions/meta"
-        },
-        "links": {
-          "description": "Link members related to the primary data.",
-          "allOf": [
-            {
-              "$ref": "#/definitions/links"
-            },
-            {
-              "$ref": "#/definitions/pagination"
-            }
-          ]
-        },
-        "jsonapi": {
-          "$ref": "#/definitions/jsonapi"
-        }
-      },
-      "additionalProperties": false
-    },
-    "failure": {
-      "type": "object",
-      "required": [
-        "errors"
-      ],
-      "properties": {
-        "errors": {
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/error"
-          },
-          "uniqueItems": true
-        },
-        "meta": {
-          "$ref": "#/definitions/meta"
-        },
-        "jsonapi": {
-          "$ref": "#/definitions/jsonapi"
-        }
-      },
-      "additionalProperties": false
-    },
-    "info": {
-      "type": "object",
-      "required": [
-        "meta"
-      ],
-      "properties": {
-        "meta": {
-          "$ref": "#/definitions/meta"
-        },
-        "links": {
-          "$ref": "#/definitions/links"
-        },
-        "jsonapi": {
-          "$ref": "#/definitions/jsonapi"
-        }
-      },
-      "additionalProperties": false
-    },
-    "meta": {
-      "description": "Non-standard meta-information that can not be represented as an attribute or relationship.",
-      "type": "object",
-      "additionalProperties": true
-    },
-    "data": {
-      "description": "The document's \"primary data\" is a representation of the resource or collection of resources targeted by a request.",
-      "oneOf": [
-        {
-          "$ref": "#/definitions/resource"
-        },
-        {
-          "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.",
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/resource"
-          },
-          "uniqueItems": true
-        }
-      ]
-    },
-    "resource": {
-      "description": "\"Resource objects\" appear in a JSON API document to represent resources.",
-      "type": "object",
-      "required": [
-        "type",
-        "id"
-      ],
-      "properties": {
-        "type": {
-          "type": "string"
-        },
-        "id": {
-          "type": "string"
-        },
-        "attributes": {
-          "$ref": "#/definitions/attributes"
-        },
-        "relationships": {
-          "$ref": "#/definitions/relationships"
-        },
-        "links": {
-          "$ref": "#/definitions/links"
-        },
-        "meta": {
-          "$ref": "#/definitions/meta"
-        }
-      },
-      "additionalProperties": false
-    },
-    "links": {
-      "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.",
-      "type": "object",
-      "properties": {
-        "self": {
-          "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.",
-          "type": "string",
-          "format": "uri"
-        },
-        "related": {
-          "$ref": "#/definitions/link"
-        }
-      },
-      "additionalProperties": true
-    },
-    "link": {
-      "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.",
-      "oneOf": [
-        {
-          "description": "A string containing the link's URL.",
-          "type": "string",
-          "format": "uri"
-        },
-        {
-          "type": "object",
-          "required": [
-            "href"
-          ],
-          "properties": {
-            "href": {
-              "description": "A string containing the link's URL.",
-              "type": "string",
-              "format": "uri"
-            },
-            "meta": {
-              "$ref": "#/definitions/meta"
-            }
-          }
-        }
-      ]
-    },
-    "attributes": {
-      "description": "Members of the attributes object (\"attributes\") represent information about the resource object in which it's defined.",
-      "type": "object",
-      "patternProperties": {
-        "^(?!relationships$|links$)\\w[-\\w_]*$": {
-          "description": "Attributes may contain any valid JSON value."
-        }
-      },
-      "additionalProperties": false
-    },
-    "relationships": {
-      "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.",
-      "type": "object",
-      "patternProperties": {
-        "^\\w[-\\w_]*$": {
-          "properties": {
-            "links": {
-              "$ref": "#/definitions/links"
-            },
-            "data": {
-              "description": "Member, whose value represents \"resource linkage\".",
-              "oneOf": [
-                {
-                  "$ref": "#/definitions/relationshipToOne"
-                },
-                {
-                  "$ref": "#/definitions/relationshipToMany"
-                }
-              ]
-            },
-            "meta": {
-              "$ref": "#/definitions/meta"
-            }
-          },
-          "additionalProperties": false
-        }
-      },
-      "additionalProperties": false
-    },
-    "relationshipToOne": {
-      "description": "References to other resource objects in a to-one (\"relationship\"). Relationships can be specified by including a member in a resource's links object.",
-      "anyOf": [
-        {
-          "$ref": "#/definitions/empty"
-        },
-        {
-          "$ref": "#/definitions/linkage"
-        }
-      ]
-    },
-    "relationshipToMany": {
-      "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.",
-      "type": "array",
-      "items": {
-        "$ref": "#/definitions/linkage"
-      },
-      "uniqueItems": true
-    },
-    "empty": {
-      "description": "Describes an empty to-one relationship.",
-      "type": "null"
-    },
-    "linkage": {
-      "description": "The \"type\" and \"id\" to non-empty members.",
-      "type": "object",
-      "required": [
-        "type",
-        "id"
-      ],
-      "properties": {
-        "type": {
-          "type": "string"
-        },
-        "id": {
-          "type": "string"
-        },
-        "meta": {
-          "$ref": "#/definitions/meta"
-        }
-      },
-      "additionalProperties": false
-    },
-    "pagination": {
-      "type": "object",
-      "properties": {
-        "first": {
-          "description": "The first page of data",
-          "oneOf": [
-            { "type": "string", "format": "uri" },
-            { "type": "null" }
-          ]
-        },
-        "last": {
-          "description": "The last page of data",
-          "oneOf": [
-            { "type": "string", "format": "uri" },
-            { "type": "null" }
-          ]
-        },
-        "prev": {
-          "description": "The previous page of data",
-          "oneOf": [
-            { "type": "string", "format": "uri" },
-            { "type": "null" }
-          ]
-        },
-        "next": {
-          "description": "The next page of data",
-          "oneOf": [
-            { "type": "string", "format": "uri" },
-            { "type": "null" }
-          ]
-        }
-      }
-    },
-    "jsonapi": {
-      "description": "An object describing the server's implementation",
-      "type": "object",
-      "properties": {
-        "version": {
-          "type": "string"
-        },
-        "meta": {
-          "$ref": "#/definitions/meta"
-        }
-      },
-      "additionalProperties": false
-    },
-    "error": {
-      "type": "object",
-      "properties": {
-        "id": {
-          "description": "A unique identifier for this particular occurrence of the problem.",
-          "type": "string"
-        },
-        "links": {
-          "$ref": "#/definitions/links"
-        },
-        "status": {
-          "description": "The HTTP status code applicable to this problem, expressed as a string value.",
-          "type": "string"
-        },
-        "code": {
-          "description": "An application-specific error code, expressed as a string value.",
-          "type": "string"
-        },
-        "title": {
-          "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.",
-          "type": "string"
-        },
-        "detail": {
-          "description": "A human-readable explanation specific to this occurrence of the problem.",
-          "type": "string"
-        },
-        "source": {
-          "type": "object",
-          "properties": {
-            "pointer": {
-              "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].",
-              "type": "string"
-            },
-            "parameter": {
-              "description": "A string indicating which query parameter caused the error.",
-              "type": "string"
-            }
-          }
-        },
-        "meta": {
-          "$ref": "#/definitions/meta"
-        }
-      },
-      "additionalProperties": false
-    }
-  }
-}

data/docs/jsonapi/schema.md DELETED Viewed

@@ -1,151 +0,0 @@
-[Back to Guides](../README.md)
-[![JSON API 1.0](https://img.shields.io/badge/JSON%20API-1.0-lightgrey.svg)](http://jsonapi.org/)
-## JSON API Requests
-- [Query Parameters Spec](http://jsonapi.org/format/#query-parameters)
-Headers:
-- Request: `Accept: application/vnd.api+json`
-- Response: `Content-Type: application/vnd.api+json`
-### [Fetching Data](http://jsonapi.org/format/#fetching)
-A server MUST support fetching resource data for every URL provided as:
-- a `self` link as part of the top-level links object
-- a `self` link as part of a resource-level links object
-- a `related` link as part of a relationship-level links object
-Example supported requests
-- Individual resource or collection
-  - GET /articles
-  - GET /articles/1
-  - GET /articles/1/author
-- Relationships
-  - GET /articles/1/relationships/comments
-  - GET /articles/1/relationships/author
-- Optional: [Inclusion of related resources](http://jsonapi.org/format/#fetching-includes) `JSONAPI::IncludeDirective`
-  - GET /articles/1?`include`=comments
-  - GET /articles/1?`include`=comments.author
-  - GET /articles/1?`include`=author,comments.author
-  - GET /articles/1/relationships/comments?`include`=comments.author
-- Optional: [Sparse Fieldsets](http://jsonapi.org/format/#fetching-sparse-fieldsets) `ActiveModel::Serializer::Fieldset`
-  - GET /articles?`include`=author&`fields`[articles]=title,body&`fields`[people]=name
-- Optional: [Sorting](http://jsonapi.org/format/#fetching-sorting)
-  - GET /people?`sort`=age
-  - GET /people?`sort`=age,author.name
-  - GET /articles?`sort`=-created,title
-- Optional: [Pagination](http://jsonapi.org/format/#fetching-pagination)
-  - GET /articles?`page`[number]=3&`page`[size]=1
-- Optional: [Filtering](http://jsonapi.org/format/#fetching-filtering)
-  - GET /comments?`filter`[post]=1
-  - GET /comments?`filter`[post]=1,2
-  - GET /comments?`filter`[post]=1,2
-### [CRUD Actions](http://jsonapi.org/format/#crud)
-### [Asynchronous Processing](http://jsonapi.org/recommendations/#asynchronous-processing)
-### [Bulk Operations Extension](http://jsonapi.org/extensions/bulk/)
-## JSON API Document Schema
-| JSON API object       | JSON API properties                                                                                | Required | ActiveModelSerializers representation |
-|-----------------------|----------------------------------------------------------------------------------------------------|----------|---------------------------------------|
-| schema                | oneOf (success, failure, info)                                                                     |          |
-| success               | data, included, meta, links, jsonapi                                                               |          | AM::SerializableResource
-| success.meta          | meta                                                                                               |          | AMS::Adapter::Base#meta
-| success.included      | UniqueArray(resource)                                                                              |          | AMS::Adapter::JsonApi#serializable_hash_for_collection
-| success.data          | data                                                                                               |          |
-| success.links         | allOf (links, pagination)                                                                          |          | AMS::Adapter::JsonApi#links_for
-| success.jsonapi       | jsonapi                                                                                            |          |
-| failure               | errors, meta, jsonapi                                                                              | errors   | AMS::Adapter::JsonApi#failure_document, #1004
-| failure.errors        | UniqueArray(error)                                                                                 |          | AM::S::ErrorSerializer, #1004
-| meta                  | Object                                                                                             |          |
-| data                  | oneOf (resource, UniqueArray(resource))                                                            |          | AMS::Adapter::JsonApi#serializable_hash_for_collection,#serializable_hash_for_single_resource
-| resource              | String(type), String(id),<br>attributes, relationships,<br>links, meta                                   | type, id | AM::S::Adapter::JsonApi#primary_data_for
-| links                 | Uri(self), Link(related)                                                                           |          | #1028, #1246, #1282
-| link                  | oneOf (linkString, linkObject)                                                                     |          |
-| link.linkString       | Uri                                                                                                |          |
-| link.linkObject       | Uri(href), meta                                                                                    | href     |
-| attributes            | patternProperties(<br>`"^(?!relationships$|links$)\\w[-\\w_]*$"`),<br>any valid JSON                      |          | AM::Serializer#attributes, AMS::Adapter::JsonApi#resource_object_for
-| relationships         | patternProperties(<br>`"^\\w[-\\w_]*$"`);<br>links, relationships.data, meta                              |          | AMS::Adapter::JsonApi#relationships_for
-| relationships.data    | oneOf (relationshipToOne, relationshipToMany)                                                      |          | AMS::Adapter::JsonApi#resource_identifier_for
-| relationshipToOne     | anyOf(empty, linkage)                                                                              |          |
-| relationshipToMany    | UniqueArray(linkage)                                                                               |          |
-| empty                 | null                                                                                               |          |
-| linkage               | String(type), String(id), meta                                                                     | type, id | AMS::Adapter::JsonApi#primary_data_for
-| pagination            | pageObject(first), pageObject(last),<br>pageObject(prev), pageObject(next)                            |          | AMS::Adapter::JsonApi::PaginationLinks#serializable_hash
-| pagination.pageObject | oneOf(Uri, null)                                                                                   |          |
-| jsonapi               | String(version), meta                                                                              |          | AMS::Adapter::JsonApi::Jsonapi#as_json
-| error                 | String(id), links, String(status),<br>String(code), String(title),<br>String(detail), error.source, meta |          | AM::S::ErrorSerializer, AMS::Adapter::JsonApi::Error.resource_errors
-| error.source          | String(pointer), String(parameter)                                                                 |          | AMS::Adapter::JsonApi::Error.error_source
-| pointer               | [JSON Pointer RFC6901](https://tools.ietf.org/html/rfc6901)                                        |          | AMS::JsonPointer
-The [http://jsonapi.org/schema](schema/schema.json) makes a nice roadmap.
-### Success Document
-- [ ] success
-  - [ ] data: `"$ref": "#/definitions/data"`
-  - [ ] included: array of unique items of type `"$ref": "#/definitions/resource"`
-  - [ ] meta: `"$ref": "#/definitions/meta"`
-  - [ ] links:
-    - [ ] link: `"$ref": "#/definitions/links"`
-    - [ ] pagination: ` "$ref": "#/definitions/pagination"`
-  - [ ] jsonapi: ` "$ref": "#/definitions/jsonapi"`
-### Failure Document
-- [ ] failure
-  - [x] errors: array of unique items of type ` "$ref": "#/definitions/error"`
-  - [ ] meta:  `"$ref": "#/definitions/meta"`
-  - [ ] jsonapi: `"$ref": "#/definitions/jsonapi"`
-### Info Document
-- [ ] info
-  - [ ] meta: `"$ref": "#/definitions/meta"`
-  - [ ] links: `"$ref": "#/definitions/links"`
-  - [ ] jsonapi: ` "$ref": "#/definitions/jsonapi"`
-### Definitions
-- [ ] definitions:
-  - [ ] meta
-  - [ ] data: oneOf (resource, array of unique resources)
-  - [ ] resource
-    - [ ] attributes
-    - [ ] relationships
-      - [ ] relationshipToOne
-        - [ ] empty
-        - [ ] linkage
-          - [ ] meta
-      - [ ] relationshipToMany
-        - [ ] linkage
-          - [ ] meta
-    - [ ] links
-    - [ ] meta
-  - [ ] links
-    - [ ] link
-      - [ ] uri
-      - [ ] href, meta
-  - [ ] pagination
-  - [ ] jsonapi
-    - [ ] meta
-  - [ ] error
-    - [ ] id: a unique identifier for this particular occurrence of the problem.
-    - [ ] links: a links object containing the following members:
-      - [ ] about: a link that leads to further details about this particular occurrence of the problem.
-    - [ ] status: the HTTP status code applicable to this problem, expressed as a string value.
-    - [ ] code: an application-specific error code, expressed as a string value.
-    - [ ] title: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
-    - [x] detail: a human-readable explanation specific to this occurrence of the problem.
-    - [x] source: an object containing references to the source of the error, optionally including any of the following members:
-      -  [x] pointer: a JSON Pointer [RFC6901](https://tools.ietf.org/html/rfc6901) to the associated entity in the request document [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute].
-      -  [x] parameter: a string indicating which query parameter caused the error.
-    - [ ] meta: a meta object containing non-standard meta-information about the error.

data/docs/rfcs/0000-namespace.md DELETED Viewed

@@ -1,106 +0,0 @@
-- Start Date: (2015-10-29)
-- RFC PR: https://github.com/rails-api/active_model_serializers/pull/1310
-- ActiveModelSerializers Issue: https://github.com/rails-api/active_model_serializers/issues/1298
-# Summary
-Provide a consistent API for the user of the AMS.
-# Motivation
-The actual public API is defined under `ActiveModelSerializers`,
-`ActiveModel::Serializer` and `ActiveModel`.
-At the `ActiveModel::Serializer` we have:
-- `ActiveModel::Serializer.config`
-- `ActiveModel::Serializer`
-At the `ActiveModelSerializers` we have:
-- `ActiveModelSerializers::Model`
-- `ActiveModelSerializers.logger`
-At `ActiveModel` we have:
-- `ActiveModel::SerializableResource`
-The idea here is to provide a single namespace `ActiveModelSerializers` to the user.
-Following the same idea we have on other gems like
-[Devise](https://github.com/plataformatec/devise/blob/e9c82472ffe7c43a448945f77e034a0e47dde0bb/lib/devise.rb),
-[Refile](https://github.com/refile/refile/blob/6b24c293d044862dafbf1bfa4606672a64903aa2/lib/refile.rb) and
-[Active Job](https://github.com/rails/rails/blob/30bacc26f8f258b39e12f63fe52389a968d9c1ea/activejob/lib/active_job.rb)
-for example.
-This way we are clarifing the boundaries of
-[ActiveModelSerializers and Rails](https://github.com/rails-api/active_model_serializers/blob/master/CHANGELOG.md#prehistory)
-and make clear that the `ActiveModel::Serializer` class is no longer the primary
-behavior of the ActiveModelSerializers.
-# Detailed design
-## New classes and modules organization
-Since this will be a big change we can do this on baby steps, read small pull requests. A
-possible approach is:
-- All new code will be in `lib/active_model_serializers/` using
-  the module namespace `ActiveModelSerializers`.
-- Move all content under `ActiveModel::Serializer` to be under
-  `ActiveModelSerializers`, the adapter is on this steps;
-- Move all content under `ActiveModel` to be under `ActiveModelSerializers`,
-  the `SerializableResource` is on this step;
-- Change all public API that doesn't make sense, keeping in mind only to keep
-  this in the same namespace
-- Update the README;
-- Update the docs;
-The following table represents the current and the desired classes and modules
-at the first moment.
-| Current                                                | Desired                                          | Notes              |
-|--------------------------------------------------------|--------------------------------------------------|--------------------|
-| `ActiveModelSerializers` and `ActiveModel::Serializer` | `ActiveModelSerializers`                         | The main namespace |
-| `ActiveModelSerializers.logger`                        | `ActiveModelSerializers.logger`                  ||
-| `ActiveModelSerializers::Model`                        | `ActiveModelSerializers::Model`                  ||
-| `ActiveModel::SerializableResource`                    | `ActiveModelSerializers::SerializableResource`   ||
-| `ActiveModel::Serializer`                              | `ActiveModelSerializers::Serializer`             | The name can be discussed in a future pull request. For example, we can rename this to `Resource` [following this idea](https://github.com/rails-api/active_model_serializers/pull/1301/files#r42963185) more info about naming in the next section|
-| `ActiveModel::Serializer.config`                       | `ActiveModelSerializers.config`                ||
-## Renaming of class and modules
-When moving some content to the new namespace we can find some names that does
-not make much sense like `ActiveModel::Serializer::Adapter::JsonApi`.
-Discussion of renaming existing classes / modules and JsonApi objects will
-happen in separate pull requests, and issues, and in the google doc
-https://docs.google.com/document/d/1rcrJr0sVcazY2Opd_6Kmv1iIwuHbI84s1P_NzFn-05c/edit?usp=sharing
-Some of names already have a definition.
-- Adapters get their own namespace under ActiveModelSerializers. E.g
-  `ActiveModelSerializers::Adapter`
-- Serializers get their own namespace under ActiveModelSerializers. E.g
-  `ActiveModelSerializers::Serializer`
-## Keeping compatibility
-All moved classes or modules be aliased to their old name and location with
-deprecation warnings, such as
-[was done for CollectionSerializer](https://github.com/rails-api/active_model_serializers/pull/1251).
-# Drawbacks
-This will be a breaking change, so all users serializers will be broken after a
-major bump.
-All pull requests will need to rebase since the architeture will change a lot.
-# Alternatives
-We can keep the way it is, and keep in mind to not add another namespace as a
-public API.
-# Unresolved questions
-What is the better class name to be used to the class that will be inherited at
-the creation of a serializer. This can be discussed in other RFC or directly via
-pull request.

data/docs/rfcs/template.md DELETED Viewed

@@ -1,15 +0,0 @@
-- Start Date: (YYYY-MM-DD)
-- RFC PR: https://github.com/rails-api/active_model_serializers/pull/dddd
-- ActiveModelSerializers Issue: https://github.com/rails-api/active_model_serializers/issues/dddd
-# Summary
-# Motivation
-# Detailed design
-# Drawbacks
-# Alternatives
-# Unresolved questions