From fade096abe0661f34b49458af0bcc7e15dc68c54 Mon Sep 17 00:00:00 2001 From: Benjamin Fleischer Date: Wed, 15 Jun 2016 10:39:35 -0500 Subject: [PATCH] Generating docs for version 0.10.0 at ref 7578a3c. --- ActionController.html | 2 +- ActionController/Serialization.html | 2 +- .../Serialization/ClassMethods.html | 2 +- ActiveModel.html | 2 +- ActiveModel/SerializableResource.html | 2 +- ActiveModel/Serializer.html | 2 +- ActiveModel/Serializer/Adapter.html | 2 +- .../Serializer/Adapter/Attributes.html | 2 +- ActiveModel/Serializer/Adapter/Base.html | 2 +- ActiveModel/Serializer/Adapter/Json.html | 2 +- ActiveModel/Serializer/Adapter/JsonApi.html | 2 +- ActiveModel/Serializer/Adapter/Null.html | 2 +- ActiveModel/Serializer/ArraySerializer.html | 2 +- ActiveModel/Serializer/Association.html | 2 +- ActiveModel/Serializer/Associations.html | 2 +- .../Serializer/Associations/ClassMethods.html | 2 +- ActiveModel/Serializer/Attribute.html | 2 +- ActiveModel/Serializer/Attributes.html | 2 +- .../Serializer/Attributes/ClassMethods.html | 2 +- .../Serializer/BelongsToReflection.html | 2 +- ActiveModel/Serializer/Caching.html | 2 +- .../Serializer/Caching/ClassMethods.html | 2 +- .../Serializer/CollectionReflection.html | 2 +- .../Serializer/CollectionSerializer.html | 2 +- ActiveModel/Serializer/Configuration.html | 2 +- ActiveModel/Serializer/ErrorSerializer.html | 2 +- ActiveModel/Serializer/ErrorsSerializer.html | 2 +- ActiveModel/Serializer/Field.html | 2 +- ActiveModel/Serializer/Fieldset.html | 2 +- ActiveModel/Serializer/HasManyReflection.html | 2 +- ActiveModel/Serializer/HasOneReflection.html | 2 +- ActiveModel/Serializer/Links.html | 2 +- .../Serializer/Links/ClassMethods.html | 2 +- ActiveModel/Serializer/Lint.html | 2 +- ActiveModel/Serializer/Lint/Tests.html | 2 +- ActiveModel/Serializer/Meta.html | 2 +- ActiveModel/Serializer/Meta/ClassMethods.html | 2 +- ActiveModel/Serializer/Null.html | 2 +- ActiveModel/Serializer/Reflection.html | 2 +- .../Serializer/SingularReflection.html | 2 +- ActiveModel/Serializer/Type.html | 2 +- ActiveModel/Serializer/Type/ClassMethods.html | 2 +- ActiveModelSerializers.html | 2 +- ActiveModelSerializers/Adapter.html | 2 +- .../Adapter/Attributes.html | 2 +- ActiveModelSerializers/Adapter/Base.html | 2 +- ActiveModelSerializers/Adapter/Json.html | 2 +- ActiveModelSerializers/Adapter/JsonApi.html | 2 +- .../Adapter/JsonApi/Deserialization.html | 2 +- .../Adapter/JsonApi/Error.html | 2 +- .../Adapter/JsonApi/Jsonapi.html | 2 +- .../Adapter/JsonApi/Link.html | 2 +- .../Adapter/JsonApi/Meta.html | 2 +- .../Adapter/JsonApi/PaginationLinks.html | 2 +- .../Adapter/JsonApi/Relationship.html | 2 +- .../Adapter/JsonApi/ResourceIdentifier.html | 2 +- ActiveModelSerializers/Adapter/Null.html | 2 +- ActiveModelSerializers/Callbacks.html | 2 +- .../Callbacks/ClassMethods.html | 2 +- ActiveModelSerializers/Deprecate.html | 2 +- ActiveModelSerializers/Deserialization.html | 2 +- ActiveModelSerializers/JsonPointer.html | 2 +- ActiveModelSerializers/Jsonapi.html | 2 +- .../Jsonapi/ControllerSupport.html | 2 +- ActiveModelSerializers/KeyTransform.html | 2 +- ActiveModelSerializers/Logging.html | 2 +- .../Logging/ClassMethods.html | 2 +- .../Logging/LogSubscriber.html | 2 +- ActiveModelSerializers/Logging/Macros.html | 2 +- ActiveModelSerializers/Model.html | 2 +- ActiveModelSerializers/Railtie.html | 2 +- .../SerializableResource.html | 2 +- .../SerializationContext.html | 2 +- .../SerializationContext/UrlHelpers.html | 2 +- ActiveModelSerializers/Test.html | 2 +- ActiveModelSerializers/Test/Schema.html | 2 +- .../Test/Schema/AssertRequestSchema.html | 2 +- .../Test/Schema/AssertResponseSchema.html | 2 +- .../Test/Schema/AssertSchema.html | 2 +- ActiveModelSerializers/Test/Serializer.html | 2 +- .../Test/Serializer/AssertSerializer.html | 2 +- BulkCacheFetcher.html | 2 +- Grape.html | 2 +- Grape/ActiveModelSerializers.html | 2 +- Grape/Formatters.html | 2 +- Grape/Formatters/ActiveModelSerializers.html | 2 +- Grape/Helpers.html | 2 +- Grape/Helpers/ActiveModelSerializers.html | 2 +- Rails.html | 2 +- Rails/Generators.html | 2 +- Rails/Generators/ResourceGenerator.html | 2 +- Rails/Generators/SerializerGenerator.html | 2 +- _index.html | 55 +- file.0000-namespace.html | 2 +- file.ARCHITECTURE.html | 2 +- file.CHANGELOG.html | 1484 ----------------- file.CONTRIBUTING.html | 207 --- file.README.html | 229 +-- file.STYLE.html | 2 +- file.adapters.html | 2 +- file.add_pagination_links.html | 2 +- file.add_root_key.html | 2 +- file.caching.html | 2 +- file.configuration_options.html | 2 +- file.deserialization.html | 2 +- file.ember-and-json-api.html | 2 +- file.errors.html | 2 +- file.getting_started.html | 2 +- file.grape.html | 2 +- file.instrumentation.html | 2 +- file.key_transforms.html | 2 +- file.logging.html | 2 +- file.outside_controller_use.html | 2 +- file.passing_arbitrary_options.html | 2 +- file.rendering.html | 2 +- file.schema.html | 2 +- file.serialize_poro.html | 2 +- file.serializers.html | 2 +- file.template.html | 2 +- file.test.html | 2 +- file_list.html | 53 +- index.html | 2 +- top-level-namespace.html | 2 +- 123 files changed, 234 insertions(+), 2030 deletions(-) delete mode 100644 file.CHANGELOG.html delete mode 100644 file.CONTRIBUTING.html diff --git a/ActionController.html b/ActionController.html index 758d0e30..9e9e65d9 100644 --- a/ActionController.html +++ b/ActionController.html @@ -106,7 +106,7 @@ diff --git a/ActionController/Serialization.html b/ActionController/Serialization.html index 8bb1f450..4290042c 100644 --- a/ActionController/Serialization.html +++ b/ActionController/Serialization.html @@ -339,7 +339,7 @@ diff --git a/ActionController/Serialization/ClassMethods.html b/ActionController/Serialization/ClassMethods.html index 880b8625..56cfbc72 100644 --- a/ActionController/Serialization/ClassMethods.html +++ b/ActionController/Serialization/ClassMethods.html @@ -165,7 +165,7 @@ diff --git a/ActiveModel.html b/ActiveModel.html index 114bbd59..a9fb3be6 100644 --- a/ActiveModel.html +++ b/ActiveModel.html @@ -120,7 +120,7 @@ subclassed to decorate a resource.

diff --git a/ActiveModel/SerializableResource.html b/ActiveModel/SerializableResource.html index 0df0d07e..2106d9ce 100644 --- a/ActiveModel/SerializableResource.html +++ b/ActiveModel/SerializableResource.html @@ -126,7 +126,7 @@ diff --git a/ActiveModel/Serializer.html b/ActiveModel/Serializer.html index 6dc52279..515fb8a4 100644 --- a/ActiveModel/Serializer.html +++ b/ActiveModel/Serializer.html @@ -1755,7 +1755,7 @@ below is true:

diff --git a/ActiveModel/Serializer/Adapter.html b/ActiveModel/Serializer/Adapter.html index 67af0ede..764197ff 100644 --- a/ActiveModel/Serializer/Adapter.html +++ b/ActiveModel/Serializer/Adapter.html @@ -147,7 +147,7 @@ diff --git a/ActiveModel/Serializer/Adapter/Attributes.html b/ActiveModel/Serializer/Adapter/Attributes.html index 7f632679..02c56a8a 100644 --- a/ActiveModel/Serializer/Adapter/Attributes.html +++ b/ActiveModel/Serializer/Adapter/Attributes.html @@ -239,7 +239,7 @@ diff --git a/ActiveModel/Serializer/Adapter/Base.html b/ActiveModel/Serializer/Adapter/Base.html index 7c1e77c7..db8fe98f 100644 --- a/ActiveModel/Serializer/Adapter/Base.html +++ b/ActiveModel/Serializer/Adapter/Base.html @@ -226,7 +226,7 @@ diff --git a/ActiveModel/Serializer/Adapter/Json.html b/ActiveModel/Serializer/Adapter/Json.html index 5be507fb..113452b8 100644 --- a/ActiveModel/Serializer/Adapter/Json.html +++ b/ActiveModel/Serializer/Adapter/Json.html @@ -239,7 +239,7 @@ diff --git a/ActiveModel/Serializer/Adapter/JsonApi.html b/ActiveModel/Serializer/Adapter/JsonApi.html index 128cd05a..643b4602 100644 --- a/ActiveModel/Serializer/Adapter/JsonApi.html +++ b/ActiveModel/Serializer/Adapter/JsonApi.html @@ -240,7 +240,7 @@ diff --git a/ActiveModel/Serializer/Adapter/Null.html b/ActiveModel/Serializer/Adapter/Null.html index ab95b0e1..68e91c98 100644 --- a/ActiveModel/Serializer/Adapter/Null.html +++ b/ActiveModel/Serializer/Adapter/Null.html @@ -239,7 +239,7 @@ diff --git a/ActiveModel/Serializer/ArraySerializer.html b/ActiveModel/Serializer/ArraySerializer.html index 158671dd..afe5b8c1 100644 --- a/ActiveModel/Serializer/ArraySerializer.html +++ b/ActiveModel/Serializer/ArraySerializer.html @@ -160,7 +160,7 @@ diff --git a/ActiveModel/Serializer/Association.html b/ActiveModel/Serializer/Association.html index 7e3d2ea6..1d77ad9e 100644 --- a/ActiveModel/Serializer/Association.html +++ b/ActiveModel/Serializer/Association.html @@ -583,7 +583,7 @@ diff --git a/ActiveModel/Serializer/Associations.html b/ActiveModel/Serializer/Associations.html index 4664ba66..f27f7267 100644 --- a/ActiveModel/Serializer/Associations.html +++ b/ActiveModel/Serializer/Associations.html @@ -263,7 +263,7 @@ not provided)

diff --git a/ActiveModel/Serializer/Associations/ClassMethods.html b/ActiveModel/Serializer/Associations/ClassMethods.html index 34731549..ea441d50 100644 --- a/ActiveModel/Serializer/Associations/ClassMethods.html +++ b/ActiveModel/Serializer/Associations/ClassMethods.html @@ -488,7 +488,7 @@ diff --git a/ActiveModel/Serializer/Attribute.html b/ActiveModel/Serializer/Attribute.html index 49d2a639..4709401a 100644 --- a/ActiveModel/Serializer/Attribute.html +++ b/ActiveModel/Serializer/Attribute.html @@ -158,7 +158,7 @@ ActiveModel::Serializer class.

diff --git a/ActiveModel/Serializer/Attributes.html b/ActiveModel/Serializer/Attributes.html index 480685da..1827737e 100644 --- a/ActiveModel/Serializer/Attributes.html +++ b/ActiveModel/Serializer/Attributes.html @@ -115,7 +115,7 @@ diff --git a/ActiveModel/Serializer/Attributes/ClassMethods.html b/ActiveModel/Serializer/Attributes/ClassMethods.html index 358c14a1..f3570664 100644 --- a/ActiveModel/Serializer/Attributes/ClassMethods.html +++ b/ActiveModel/Serializer/Attributes/ClassMethods.html @@ -488,7 +488,7 @@ diff --git a/ActiveModel/Serializer/BelongsToReflection.html b/ActiveModel/Serializer/BelongsToReflection.html index 7e01c375..70a18092 100644 --- a/ActiveModel/Serializer/BelongsToReflection.html +++ b/ActiveModel/Serializer/BelongsToReflection.html @@ -167,7 +167,7 @@ diff --git a/ActiveModel/Serializer/Caching.html b/ActiveModel/Serializer/Caching.html index c0994307..ee31fab1 100644 --- a/ActiveModel/Serializer/Caching.html +++ b/ActiveModel/Serializer/Caching.html @@ -629,7 +629,7 @@ customize the cache key

diff --git a/ActiveModel/Serializer/Caching/ClassMethods.html b/ActiveModel/Serializer/Caching/ClassMethods.html index c752965d..22ce8d4e 100644 --- a/ActiveModel/Serializer/Caching/ClassMethods.html +++ b/ActiveModel/Serializer/Caching/ClassMethods.html @@ -1291,7 +1291,7 @@ called with a non-nil value. rubocop:disable Style/ClassVars

diff --git a/ActiveModel/Serializer/CollectionReflection.html b/ActiveModel/Serializer/CollectionReflection.html index f7a9e980..01521ff6 100644 --- a/ActiveModel/Serializer/CollectionReflection.html +++ b/ActiveModel/Serializer/CollectionReflection.html @@ -163,7 +163,7 @@ diff --git a/ActiveModel/Serializer/CollectionSerializer.html b/ActiveModel/Serializer/CollectionSerializer.html index 1add7d7f..da9f413d 100644 --- a/ActiveModel/Serializer/CollectionSerializer.html +++ b/ActiveModel/Serializer/CollectionSerializer.html @@ -703,7 +703,7 @@ the logic right here.

diff --git a/ActiveModel/Serializer/Configuration.html b/ActiveModel/Serializer/Configuration.html index e13b5b10..89fdac2e 100644 --- a/ActiveModel/Serializer/Configuration.html +++ b/ActiveModel/Serializer/Configuration.html @@ -110,7 +110,7 @@ diff --git a/ActiveModel/Serializer/ErrorSerializer.html b/ActiveModel/Serializer/ErrorSerializer.html index fc51de31..770d8ef9 100644 --- a/ActiveModel/Serializer/ErrorSerializer.html +++ b/ActiveModel/Serializer/ErrorSerializer.html @@ -387,7 +387,7 @@ diff --git a/ActiveModel/Serializer/ErrorsSerializer.html b/ActiveModel/Serializer/ErrorsSerializer.html index 48ccbb41..f1033a66 100644 --- a/ActiveModel/Serializer/ErrorsSerializer.html +++ b/ActiveModel/Serializer/ErrorsSerializer.html @@ -494,7 +494,7 @@ diff --git a/ActiveModel/Serializer/Field.html b/ActiveModel/Serializer/Field.html index f51e89cc..4725ce51 100644 --- a/ActiveModel/Serializer/Field.html +++ b/ActiveModel/Serializer/Field.html @@ -405,7 +405,7 @@ block is evaluated in the context of the serializer.

diff --git a/ActiveModel/Serializer/Fieldset.html b/ActiveModel/Serializer/Fieldset.html index 6fd7e0c9..9cf7999b 100644 --- a/ActiveModel/Serializer/Fieldset.html +++ b/ActiveModel/Serializer/Fieldset.html @@ -303,7 +303,7 @@ diff --git a/ActiveModel/Serializer/HasManyReflection.html b/ActiveModel/Serializer/HasManyReflection.html index 0ff274c4..4dad6110 100644 --- a/ActiveModel/Serializer/HasManyReflection.html +++ b/ActiveModel/Serializer/HasManyReflection.html @@ -167,7 +167,7 @@ diff --git a/ActiveModel/Serializer/HasOneReflection.html b/ActiveModel/Serializer/HasOneReflection.html index 0235f510..30d087ce 100644 --- a/ActiveModel/Serializer/HasOneReflection.html +++ b/ActiveModel/Serializer/HasOneReflection.html @@ -167,7 +167,7 @@ diff --git a/ActiveModel/Serializer/Links.html b/ActiveModel/Serializer/Links.html index 0626af1b..4a1cb2ad 100644 --- a/ActiveModel/Serializer/Links.html +++ b/ActiveModel/Serializer/Links.html @@ -115,7 +115,7 @@ diff --git a/ActiveModel/Serializer/Links/ClassMethods.html b/ActiveModel/Serializer/Links/ClassMethods.html index 3583ebd2..8480fd39 100644 --- a/ActiveModel/Serializer/Links/ClassMethods.html +++ b/ActiveModel/Serializer/Links/ClassMethods.html @@ -246,7 +246,7 @@ diff --git a/ActiveModel/Serializer/Lint.html b/ActiveModel/Serializer/Lint.html index bd913bcd..139f074c 100644 --- a/ActiveModel/Serializer/Lint.html +++ b/ActiveModel/Serializer/Lint.html @@ -106,7 +106,7 @@ diff --git a/ActiveModel/Serializer/Lint/Tests.html b/ActiveModel/Serializer/Lint/Tests.html index 3f8da6b2..375292b9 100644 --- a/ActiveModel/Serializer/Lint/Tests.html +++ b/ActiveModel/Serializer/Lint/Tests.html @@ -901,7 +901,7 @@ required unless caching is enabled.

diff --git a/ActiveModel/Serializer/Meta.html b/ActiveModel/Serializer/Meta.html index ec3d8493..b03991a6 100644 --- a/ActiveModel/Serializer/Meta.html +++ b/ActiveModel/Serializer/Meta.html @@ -115,7 +115,7 @@ diff --git a/ActiveModel/Serializer/Meta/ClassMethods.html b/ActiveModel/Serializer/Meta/ClassMethods.html index 8a9c0fd5..92ffd537 100644 --- a/ActiveModel/Serializer/Meta/ClassMethods.html +++ b/ActiveModel/Serializer/Meta/ClassMethods.html @@ -192,7 +192,7 @@ diff --git a/ActiveModel/Serializer/Null.html b/ActiveModel/Serializer/Null.html index 28b93462..5f3a9f88 100644 --- a/ActiveModel/Serializer/Null.html +++ b/ActiveModel/Serializer/Null.html @@ -390,7 +390,7 @@ diff --git a/ActiveModel/Serializer/Reflection.html b/ActiveModel/Serializer/Reflection.html index f1bdde6e..918e143c 100644 --- a/ActiveModel/Serializer/Reflection.html +++ b/ActiveModel/Serializer/Reflection.html @@ -729,7 +729,7 @@ association by its reflection.

diff --git a/ActiveModel/Serializer/SingularReflection.html b/ActiveModel/Serializer/SingularReflection.html index d6c2ded1..b9eda7f5 100644 --- a/ActiveModel/Serializer/SingularReflection.html +++ b/ActiveModel/Serializer/SingularReflection.html @@ -163,7 +163,7 @@ diff --git a/ActiveModel/Serializer/Type.html b/ActiveModel/Serializer/Type.html index 1fa1f227..0f382e97 100644 --- a/ActiveModel/Serializer/Type.html +++ b/ActiveModel/Serializer/Type.html @@ -115,7 +115,7 @@ diff --git a/ActiveModel/Serializer/Type/ClassMethods.html b/ActiveModel/Serializer/Type/ClassMethods.html index 800cbad7..c0285355 100644 --- a/ActiveModel/Serializer/Type/ClassMethods.html +++ b/ActiveModel/Serializer/Type/ClassMethods.html @@ -187,7 +187,7 @@ diff --git a/ActiveModelSerializers.html b/ActiveModelSerializers.html index d5ca8a1c..ceda204b 100644 --- a/ActiveModelSerializers.html +++ b/ActiveModelSerializers.html @@ -453,7 +453,7 @@ Style/AsciiComments TODO: implement!

diff --git a/ActiveModelSerializers/Adapter.html b/ActiveModelSerializers/Adapter.html index a039583a..dab5d92a 100644 --- a/ActiveModelSerializers/Adapter.html +++ b/ActiveModelSerializers/Adapter.html @@ -878,7 +878,7 @@ so that registering 'ActiveModelSerializers::Adapter::Json' and diff --git a/ActiveModelSerializers/Adapter/Attributes.html b/ActiveModelSerializers/Adapter/Attributes.html index de610491..93e50838 100644 --- a/ActiveModelSerializers/Adapter/Attributes.html +++ b/ActiveModelSerializers/Adapter/Attributes.html @@ -212,7 +212,7 @@ diff --git a/ActiveModelSerializers/Adapter/Base.html b/ActiveModelSerializers/Adapter/Base.html index 9066ab49..ac4a0720 100644 --- a/ActiveModelSerializers/Adapter/Base.html +++ b/ActiveModelSerializers/Adapter/Base.html @@ -1073,7 +1073,7 @@ serialization_options(options).

diff --git a/ActiveModelSerializers/Adapter/Json.html b/ActiveModelSerializers/Adapter/Json.html index 74ee0270..145ffa0b 100644 --- a/ActiveModelSerializers/Adapter/Json.html +++ b/ActiveModelSerializers/Adapter/Json.html @@ -320,7 +320,7 @@ diff --git a/ActiveModelSerializers/Adapter/JsonApi.html b/ActiveModelSerializers/Adapter/JsonApi.html index 48dadd2b..fa8186d7 100644 --- a/ActiveModelSerializers/Adapter/JsonApi.html +++ b/ActiveModelSerializers/Adapter/JsonApi.html @@ -851,7 +851,7 @@ definition:

diff --git a/ActiveModelSerializers/Adapter/JsonApi/Deserialization.html b/ActiveModelSerializers/Adapter/JsonApi/Deserialization.html index 595803a5..c7647ff1 100644 --- a/ActiveModelSerializers/Adapter/JsonApi/Deserialization.html +++ b/ActiveModelSerializers/Adapter/JsonApi/Deserialization.html @@ -1050,7 +1050,7 @@ value.

diff --git a/ActiveModelSerializers/Adapter/JsonApi/Error.html b/ActiveModelSerializers/Adapter/JsonApi/Error.html index 31f852ed..f07d240b 100644 --- a/ActiveModelSerializers/Adapter/JsonApi/Error.html +++ b/ActiveModelSerializers/Adapter/JsonApi/Error.html @@ -462,7 +462,7 @@ parameter: A string indicating which query parameter caused the error diff --git a/ActiveModelSerializers/Adapter/JsonApi/Jsonapi.html b/ActiveModelSerializers/Adapter/JsonApi/Jsonapi.html index 22b52fbc..f7d6767a 100644 --- a/ActiveModelSerializers/Adapter/JsonApi/Jsonapi.html +++ b/ActiveModelSerializers/Adapter/JsonApi/Jsonapi.html @@ -356,7 +356,7 @@ meta diff --git a/ActiveModelSerializers/Adapter/JsonApi/Link.html b/ActiveModelSerializers/Adapter/JsonApi/Link.html index f851728a..f99ea213 100644 --- a/ActiveModelSerializers/Adapter/JsonApi/Link.html +++ b/ActiveModelSerializers/Adapter/JsonApi/Link.html @@ -466,7 +466,7 @@ meta diff --git a/ActiveModelSerializers/Adapter/JsonApi/Meta.html b/ActiveModelSerializers/Adapter/JsonApi/Meta.html index 092a5cae..c486830f 100644 --- a/ActiveModelSerializers/Adapter/JsonApi/Meta.html +++ b/ActiveModelSerializers/Adapter/JsonApi/Meta.html @@ -292,7 +292,7 @@ diff --git a/ActiveModelSerializers/Adapter/JsonApi/PaginationLinks.html b/ActiveModelSerializers/Adapter/JsonApi/PaginationLinks.html index f150793f..7e73f735 100644 --- a/ActiveModelSerializers/Adapter/JsonApi/PaginationLinks.html +++ b/ActiveModelSerializers/Adapter/JsonApi/PaginationLinks.html @@ -431,7 +431,7 @@ diff --git a/ActiveModelSerializers/Adapter/JsonApi/Relationship.html b/ActiveModelSerializers/Adapter/JsonApi/Relationship.html index 581ae6a2..22fdb9a5 100644 --- a/ActiveModelSerializers/Adapter/JsonApi/Relationship.html +++ b/ActiveModelSerializers/Adapter/JsonApi/Relationship.html @@ -287,7 +287,7 @@ diff --git a/ActiveModelSerializers/Adapter/JsonApi/ResourceIdentifier.html b/ActiveModelSerializers/Adapter/JsonApi/ResourceIdentifier.html index 5e62835b..2d72f659 100644 --- a/ActiveModelSerializers/Adapter/JsonApi/ResourceIdentifier.html +++ b/ActiveModelSerializers/Adapter/JsonApi/ResourceIdentifier.html @@ -255,7 +255,7 @@ diff --git a/ActiveModelSerializers/Adapter/Null.html b/ActiveModelSerializers/Adapter/Null.html index 2046b295..10bd823c 100644 --- a/ActiveModelSerializers/Adapter/Null.html +++ b/ActiveModelSerializers/Adapter/Null.html @@ -208,7 +208,7 @@ diff --git a/ActiveModelSerializers/Callbacks.html b/ActiveModelSerializers/Callbacks.html index 06d18019..e64c4ac7 100644 --- a/ActiveModelSerializers/Callbacks.html +++ b/ActiveModelSerializers/Callbacks.html @@ -133,7 +133,7 @@ serialization and allow you to trigger logic. Available callbacks are:

diff --git a/ActiveModelSerializers/Callbacks/ClassMethods.html b/ActiveModelSerializers/Callbacks/ClassMethods.html index d897b058..eeccd24c 100644 --- a/ActiveModelSerializers/Callbacks/ClassMethods.html +++ b/ActiveModelSerializers/Callbacks/ClassMethods.html @@ -216,7 +216,7 @@ it is as_json, to_json, or serializable_hash

diff --git a/ActiveModelSerializers/Deprecate.html b/ActiveModelSerializers/Deprecate.html index 9b871d50..7a9a821b 100644 --- a/ActiveModelSerializers/Deprecate.html +++ b/ActiveModelSerializers/Deprecate.html @@ -262,7 +262,7 @@ that it is planned to go away.

diff --git a/ActiveModelSerializers/Deserialization.html b/ActiveModelSerializers/Deserialization.html index 2cb10a2c..edda4465 100644 --- a/ActiveModelSerializers/Deserialization.html +++ b/ActiveModelSerializers/Deserialization.html @@ -230,7 +230,7 @@ diff --git a/ActiveModelSerializers/JsonPointer.html b/ActiveModelSerializers/JsonPointer.html index 5f3a352b..182d8112 100644 --- a/ActiveModelSerializers/JsonPointer.html +++ b/ActiveModelSerializers/JsonPointer.html @@ -180,7 +180,7 @@ diff --git a/ActiveModelSerializers/Jsonapi.html b/ActiveModelSerializers/Jsonapi.html index 3127fec2..aed9c75b 100644 --- a/ActiveModelSerializers/Jsonapi.html +++ b/ActiveModelSerializers/Jsonapi.html @@ -343,7 +343,7 @@ actionpack/lib/action_dispatch/http/parameters.rb

diff --git a/ActiveModelSerializers/Jsonapi/ControllerSupport.html b/ActiveModelSerializers/Jsonapi/ControllerSupport.html index c62ab8f5..0b24cc87 100644 --- a/ActiveModelSerializers/Jsonapi/ControllerSupport.html +++ b/ActiveModelSerializers/Jsonapi/ControllerSupport.html @@ -173,7 +173,7 @@ diff --git a/ActiveModelSerializers/KeyTransform.html b/ActiveModelSerializers/KeyTransform.html index 60488f44..f0325e41 100644 --- a/ActiveModelSerializers/KeyTransform.html +++ b/ActiveModelSerializers/KeyTransform.html @@ -524,7 +524,7 @@ deserialization in the JsonApi adapter.

diff --git a/ActiveModelSerializers/Logging.html b/ActiveModelSerializers/Logging.html index a184026e..2acf0892 100644 --- a/ActiveModelSerializers/Logging.html +++ b/ActiveModelSerializers/Logging.html @@ -262,7 +262,7 @@ diff --git a/ActiveModelSerializers/Logging/ClassMethods.html b/ActiveModelSerializers/Logging/ClassMethods.html index c7c5b70d..153aaaba 100644 --- a/ActiveModelSerializers/Logging/ClassMethods.html +++ b/ActiveModelSerializers/Logging/ClassMethods.html @@ -177,7 +177,7 @@ diff --git a/ActiveModelSerializers/Logging/LogSubscriber.html b/ActiveModelSerializers/Logging/LogSubscriber.html index 734e8e4f..1d654ee0 100644 --- a/ActiveModelSerializers/Logging/LogSubscriber.html +++ b/ActiveModelSerializers/Logging/LogSubscriber.html @@ -245,7 +245,7 @@ diff --git a/ActiveModelSerializers/Logging/Macros.html b/ActiveModelSerializers/Logging/Macros.html index a7f6b823..5de5f130 100644 --- a/ActiveModelSerializers/Logging/Macros.html +++ b/ActiveModelSerializers/Logging/Macros.html @@ -240,7 +240,7 @@ rendered. Adapted from:

diff --git a/ActiveModelSerializers/Model.html b/ActiveModelSerializers/Model.html index 38a18827..141eb1a4 100644 --- a/ActiveModelSerializers/Model.html +++ b/ActiveModelSerializers/Model.html @@ -752,7 +752,7 @@ ActiveModel::Errors :nocov:

diff --git a/ActiveModelSerializers/Railtie.html b/ActiveModelSerializers/Railtie.html index 1845fd5a..134e3c98 100644 --- a/ActiveModelSerializers/Railtie.html +++ b/ActiveModelSerializers/Railtie.html @@ -114,7 +114,7 @@ diff --git a/ActiveModelSerializers/SerializableResource.html b/ActiveModelSerializers/SerializableResource.html index 66fe0797..a6a4cbbe 100644 --- a/ActiveModelSerializers/SerializableResource.html +++ b/ActiveModelSerializers/SerializableResource.html @@ -822,7 +822,7 @@ False when explicit adapter is falsy (nil or false)

diff --git a/ActiveModelSerializers/SerializationContext.html b/ActiveModelSerializers/SerializationContext.html index 4026bcbd..c0135595 100644 --- a/ActiveModelSerializers/SerializationContext.html +++ b/ActiveModelSerializers/SerializationContext.html @@ -559,7 +559,7 @@ diff --git a/ActiveModelSerializers/SerializationContext/UrlHelpers.html b/ActiveModelSerializers/SerializationContext/UrlHelpers.html index 4a093308..827dad5f 100644 --- a/ActiveModelSerializers/SerializationContext/UrlHelpers.html +++ b/ActiveModelSerializers/SerializationContext/UrlHelpers.html @@ -236,7 +236,7 @@ diff --git a/ActiveModelSerializers/Test.html b/ActiveModelSerializers/Test.html index 22f3d3fa..9d8b2ff8 100644 --- a/ActiveModelSerializers/Test.html +++ b/ActiveModelSerializers/Test.html @@ -113,7 +113,7 @@ diff --git a/ActiveModelSerializers/Test/Schema.html b/ActiveModelSerializers/Test/Schema.html index f58361ff..c162f3ac 100644 --- a/ActiveModelSerializers/Test/Schema.html +++ b/ActiveModelSerializers/Test/Schema.html @@ -463,7 +463,7 @@ diff --git a/ActiveModelSerializers/Test/Schema/AssertRequestSchema.html b/ActiveModelSerializers/Test/Schema/AssertRequestSchema.html index 5bb88321..c23235e0 100644 --- a/ActiveModelSerializers/Test/Schema/AssertRequestSchema.html +++ b/ActiveModelSerializers/Test/Schema/AssertRequestSchema.html @@ -213,7 +213,7 @@ diff --git a/ActiveModelSerializers/Test/Schema/AssertResponseSchema.html b/ActiveModelSerializers/Test/Schema/AssertResponseSchema.html index 9a665155..b1a256de 100644 --- a/ActiveModelSerializers/Test/Schema/AssertResponseSchema.html +++ b/ActiveModelSerializers/Test/Schema/AssertResponseSchema.html @@ -213,7 +213,7 @@ diff --git a/ActiveModelSerializers/Test/Schema/AssertSchema.html b/ActiveModelSerializers/Test/Schema/AssertSchema.html index 8f183287..99684088 100644 --- a/ActiveModelSerializers/Test/Schema/AssertSchema.html +++ b/ActiveModelSerializers/Test/Schema/AssertSchema.html @@ -645,7 +645,7 @@ diff --git a/ActiveModelSerializers/Test/Serializer.html b/ActiveModelSerializers/Test/Serializer.html index 426e56a8..01805669 100644 --- a/ActiveModelSerializers/Test/Serializer.html +++ b/ActiveModelSerializers/Test/Serializer.html @@ -218,7 +218,7 @@ diff --git a/ActiveModelSerializers/Test/Serializer/AssertSerializer.html b/ActiveModelSerializers/Test/Serializer/AssertSerializer.html index bc886517..ca20c0a7 100644 --- a/ActiveModelSerializers/Test/Serializer/AssertSerializer.html +++ b/ActiveModelSerializers/Test/Serializer/AssertSerializer.html @@ -701,7 +701,7 @@ diff --git a/BulkCacheFetcher.html b/BulkCacheFetcher.html index 86717558..96e19a65 100644 --- a/BulkCacheFetcher.html +++ b/BulkCacheFetcher.html @@ -312,7 +312,7 @@ found objects, so you can use it for things like setting cache expiration.

diff --git a/Grape.html b/Grape.html index 66276a49..aaffbfb7 100644 --- a/Grape.html +++ b/Grape.html @@ -124,7 +124,7 @@ render helper in Grape::Helpers::ActiveModelSerializers

diff --git a/Grape/ActiveModelSerializers.html b/Grape/ActiveModelSerializers.html index 69facce5..c41957dd 100644 --- a/Grape/ActiveModelSerializers.html +++ b/Grape/ActiveModelSerializers.html @@ -101,7 +101,7 @@ diff --git a/Grape/Formatters.html b/Grape/Formatters.html index c758ab51..c5c79cde 100644 --- a/Grape/Formatters.html +++ b/Grape/Formatters.html @@ -106,7 +106,7 @@ diff --git a/Grape/Formatters/ActiveModelSerializers.html b/Grape/Formatters/ActiveModelSerializers.html index 240d115e..75eae66c 100644 --- a/Grape/Formatters/ActiveModelSerializers.html +++ b/Grape/Formatters/ActiveModelSerializers.html @@ -169,7 +169,7 @@ diff --git a/Grape/Helpers.html b/Grape/Helpers.html index 4cbb3096..b26bea3a 100644 --- a/Grape/Helpers.html +++ b/Grape/Helpers.html @@ -106,7 +106,7 @@ diff --git a/Grape/Helpers/ActiveModelSerializers.html b/Grape/Helpers/ActiveModelSerializers.html index bd422446..30d2b70f 100644 --- a/Grape/Helpers/ActiveModelSerializers.html +++ b/Grape/Helpers/ActiveModelSerializers.html @@ -186,7 +186,7 @@ posts.page, total_pages: posts.total_pages })

diff --git a/Rails.html b/Rails.html index e9a2da6f..eec44d99 100644 --- a/Rails.html +++ b/Rails.html @@ -108,7 +108,7 @@ diff --git a/Rails/Generators.html b/Rails/Generators.html index f1ab10f2..a938f412 100644 --- a/Rails/Generators.html +++ b/Rails/Generators.html @@ -108,7 +108,7 @@ diff --git a/Rails/Generators/ResourceGenerator.html b/Rails/Generators/ResourceGenerator.html index 6d47321b..14d1327d 100644 --- a/Rails/Generators/ResourceGenerator.html +++ b/Rails/Generators/ResourceGenerator.html @@ -111,7 +111,7 @@ diff --git a/Rails/Generators/SerializerGenerator.html b/Rails/Generators/SerializerGenerator.html index 336fa8ba..f07c52f8 100644 --- a/Rails/Generators/SerializerGenerator.html +++ b/Rails/Generators/SerializerGenerator.html @@ -183,7 +183,7 @@ diff --git a/_index.html b/_index.html index c5a0228c..6954f992 100644 --- a/_index.html +++ b/_index.html @@ -67,70 +67,79 @@
  • README
    • -
  • adapters
    • +
  • ARCHITECTURE
    • -
  • caching
    • +
  • README
    • -
  • configuration_options
    • +
  • STYLE
    • -
  • deserialization
    • +
  • adapters
    • -
  • getting_started
    • +
  • caching
    • -
  • instrumentation
    • +
  • configuration_options
    • -
  • key_transforms
    • +
  • deserialization
    • -
  • logging
    • +
  • getting_started
    • -
  • rendering
    • +
  • instrumentation
    • -
  • serializers
    • +
  • key_transforms
    • -
  • add_pagination_links
    • +
  • logging
    • -
  • add_root_key
    • +
  • rendering
    • -
  • outside_controller_use
    • +
  • serializers
    • -
  • passing_arbitrary_options
    • +
  • add_pagination_links
    • -
  • serialize_poro
    • +
  • add_root_key
    • -
  • test
    • +
  • outside_controller_use
    • -
  • ember-and-json-api
    • +
  • passing_arbitrary_options
    • -
  • grape
    • +
  • serialize_poro
    • -
  • errors
    • +
  • test
    • -
  • schema
    • +
  • ember-and-json-api
    • -
  • 0000-namespace
    • +
  • grape
    • -
  • template
    • +
  • errors
    • + + +
  • schema
    • + + +
  • 0000-namespace
    • + + +
  • template
    • @@ -936,7 +945,7 @@ diff --git a/file.0000-namespace.html b/file.0000-namespace.html index 06aeeec6..215833df 100644 --- a/file.0000-namespace.html +++ b/file.0000-namespace.html @@ -205,7 +205,7 @@ RFC or directly via pull request.

    diff --git a/file.ARCHITECTURE.html b/file.ARCHITECTURE.html index 98c77514..9f1403ca 100644 --- a/file.ARCHITECTURE.html +++ b/file.ARCHITECTURE.html @@ -256,7 +256,7 @@ as for records. For example:

    diff --git a/file.CHANGELOG.html b/file.CHANGELOG.html deleted file mode 100644 index c7457a84..00000000 --- a/file.CHANGELOG.html +++ /dev/null @@ -1,1484 +0,0 @@ - - - - - - File: CHANGELOG - - — Documentation by YARD 0.8.7.6 - - - - - - - - - - - - - - - - - - - - - -
    -

    0.10.x

    - -

    master (unreleased)

    - -

    Breaking changes:

    - -

    Features: - #1668 -Exclude nil and empty links. (@sigmike) - #1426 -Add ActiveModelSerializers.config.default_includes (@empact)

    - -

    Fixes: - #1287 -Pass fields options from adapter to serializer. -(@vasilakisfil) - #1710 -Prevent association loading when include_data option is set -to false. (@groyoh) - #1747 -Improve jsonapi mime type registration for Rails 5 (@remear)

    - -

    Misc: - #1734 -Adds documentation for conditional attribute (@lambda2) - #1685 -Replace IncludeTree with IncludeDirective from -the jsonapi gem.

    - -

    v0.10.0 (2016-05-17)

    - -

    Breaking changes: - #1662 -Drop support for Rails 4.0 and Ruby 2.0.0. (@remear)

    - -

    Features: - #1677 -Add assert_schema, assert_request_schema, -assert_request_response_schema. (@bf4) - #1697 -Include actual exception message with custom exceptions; -Test::Schema exceptions are now -Minitest::Assertions. (@bf4) - #1699 -String/Lambda support for conditional attributes/associations (@mtsmfm) - -#1687 -Only calculate _cache_digest (in cache_key) when -skip_digest is false. (@bf4) - #1647 -Restrict usage of serializable_hash options to the -ActiveModel::Serialization and ActiveModel::Serializers::JSON interface. -(@bf4)

    - -

    Fixes: - #1700 -Support pagination link for Kaminari when no data is returned. (@iamnader) -- #1726 -Adds polymorphic option to association definition which includes -association type/nesting in serializer (@cgmckeever)

    - -

    Misc: - #1673 -Adds “How to” guide on using AMS with POROs (@DrSayre) - #1730 -Adds documentation for overriding default serializer based on conditions -(@groyoh/@cgmckeever)

    - -

    v0.10.0.rc5 (2016-04-04)

    - -

    Breaking changes:

    -
    • -

      #1645 -Changed :dashed key transform to :dash. (@remear)

      -
    • -

      #1574 -Default key case for the JsonApi adapter changed to dashed. (@remear)

      -
    - -

    Features: - #1645 -Transform keys referenced in values. (@remear) - #1650 -Fix serialization scope options scope, scope_name -take precedence over serialization_scope in the controller. -Fix tests that required tearing down dynamic methods. (@bf4) - #1644 -Include adapter name in cache key so that the same serializer can be -cached per adapter. (@bf4 via #1346 by @kevintyll) - #1642 -Prefer object.cache_key over the generated cache key. (@bf4 via #1346 by -@kevintyll) - #1637 -Make references to 'ActionController::Base.cache_store' explicit -in order to avoid issues when application controllers inherit from -'ActionController::API'. (@ncuesta) - #1633 -Yield 'serializer' to serializer association blocks. (@bf4) - #1616 -SerializableResource handles no serializer like controller. (@bf4) - #1618 -Get collection root key for empty collection from explicit serializer -option, when possible. (@bf4) - #1574 -Provide key translation. (@remear) - #1494 -Make serializers serializalbe (using the Attributes adapter by default). -(@bf4) - #1550 -Add Rails url_helpers to SerializationContext for use in -links. (@remear, @bf4) - #1004 -JSON API errors object implementation. - Only implements -detail and source as derived from -ActiveModel::Error - Provides checklist of remaining -questions and remaining parts of the spec. - #1515 -Adds support for symbols to the ActiveModel::Serializer.type -method. (@groyoh) - #1504 -Adds the changes missing from #1454 and add more tests for resource -identifier and relationship objects. Fix association block with link -returning data: nil.(@groyoh) - #1372 -Support cache_store.read_multi. (@LcpMarvel) - #1018 -Add more tests and docs for top-level links. (@leandrocp) - #1454 -Add support for relationship-level links and meta attributes. (@beauby) - -#1340 -Add support for resource-level meta. (@beauby)

    - -

    Fixes: - #1657 -Add missing missing require “active_support/json”. (@andreaseger) - #1661 -Fixes read_attribute_for_serialization not seeing methods -defined in serialization superclass (#1653, #1658, #1660), introduced in -#1650. (@bf4) - #1651 -Fix deserialization of nil relationships. (@NullVoxPopuli) - #1480 -Fix setting of cache_store from Rails configuration. (@bf4) Fix -unintentional mutating of value in memory cache store. (@groyoh) - #1622 -Fragment cache changed from per-record to per-serializer. Now, two -serializers that use the same model may be separately cached. (@lserman) - -#1478 -Cache store will now be correctly set when serializers are loaded -before Rails initializes. (@bf4) - #1570 -Fixed pagination issue with last page size. (@bmorrall) - #1516 -No longer return a nil href when only adding meta to a relationship link. -(@groyoh) - #1458 -Preserve the serializer type when fragment caching. (@bdmac) - #1477 -Fix fragment_cached? method to check if caching. (@bdmac) - -#1501 -Adds tests for SerializableResource::use_adapter?,doc typos (@domitian) - -#1488 -Require ActiveSupport's string inflections (@nate00)

    - -

    Misc: - #1608 -Move SerializableResource to ActiveModelSerializers (@groyoh) - #1602 -Add output examples to Adapters docs (@remear) - #1557 -Update docs regarding overriding the root key (@Jwan622) - #1471 -[Cleanup] Serializer caching is its own concern. (@bf4) - #1482 -Document JSON API implementation defs and progress in class. (@bf4) - #1551 -Added codebeat badge (@korzonek) - #1527 -Refactor fragment cache class. (@groyoh) - #1560 -Update rubocop and address its warnings. (@bf4 @groyoh) - #1545 -Document how to pass arbitrary options to the serializer -(@CodedBeardedSignedTaylor) - #1496 -Run all branches against JRuby on CI (@nadavshatz) - #1559 -Add a deprecation DSL. (@bf4 @groyoh) - #1543 -Add the changes missing from #1535. (@groyoh) - #1535 -Move the adapter and adapter folder to active_model_serializers folder and -changes the module namespace. (@domitian @bf4) - #1497 -Add JRuby-9000 to appveyor.yml(@corainchicago) - #1420 -Adds tests and documentation for polymorphism(@marcgarreau)

    - -

    v0.10.0.rc4 (2016-01-27)

    - -

    Breaking changes:

    -
    • -

      #1360 -#1369 -Drop support for Ruby 1.9.3 (@karaAJC, @maurogeorge)

      -
    • -

      #1131 -Remove Serializer#root_name (@beauby)

      -
    • -

      #1138 -Introduce Adapter::Base (@bf4)

      -
    • -

      Adapters now inherit Adapter::Base. 'Adapter' is now a module, no -longer a class.

      -
      • -

        using a class as a namespace that you also inherit from is complicated and -circular at times i.e. buggy (see github.com/rails-api/active_model_serializers/pull/1177)

        -
      • -

        The class methods on Adapter aren't necessarily related to the instance -methods, they're more Adapter functions.

        -
      • -

        named Base because it's a Rails-ism.

        -
      • -

        It helps to isolate and highlight what the Adapter interface actually is.

        -
      -
    • -

      #1418 -serialized collections now use the root option as is; now, only the root -derived from the serializer or object is always pluralized.

      -
    - -

    Features:

    -
    • -

      #1406 -Allow for custom dynamic values in JSON API links (@beauby)

      -
    • -

      #1270 -Adds assert_response_schema test helper (@maurogeorge)

      -
    • -

      #1099 -Adds assert_serializer test helper (@maurogeorge)

      -
    • -

      #1403 -Add support for if/unless on attributes/associations (@beauby)

      -
    • -

      #1248 -Experimental: Add support for JSON API deserialization (@beauby)

      -
    • -

      #1378 -Change association blocks to be evaluated in serializer scope, -rather than association scope. (@bf4)

      -
      • -

        Syntax changes from e.g. has_many :titles do customers.pluck(:title) -end (in #1356) to has_many :titles do -object.customers.pluck(:title) end

        -
      -
    • -

      #1356 -Add inline syntax for attributes and associations (@bf4 @beauby -@noahsilas)

      -
    • -

      Allows defining attributes so that they don't conflict with existing -methods. e.g. attribute :title do 'Mr. Topum Hat' -end

      -
    • -

      Allows defining associations so that they don't conflict with existing -methods. e.g. has_many :titles do customers.pluck(:title) -end

      -
      • -

        Allows dynamic associations, as compared to compare to using virtual_value. -e.g. has_many :reviews, virtual_value: [{ id: 1 }, { id: 2 }]

        -
      -
    • -

      Removes dynamically defined methods on the serializer

      -
    • -

      #1336 -Added support for Grape >= 0.13, < 1.0 (@johnhamelink)

      -
    • -

      #1322 -Instrumenting rendering of resources (@bf4, @maurogeorge)

      -
    • -

      #1291 -Add logging (@maurogeorge)

      -
    • -

      #1272 -Add PORO serializable base class: ActiveModelSerializers::Model (@bf4)

      -
    • -

      #1255 -Make more class attributes inheritable (@bf4)

      -
    • -

      #1249 -Inheritance of serializer inheriting the cache configuration(@Rodrigora)

      -
    • -

      #1247 -Add support for toplevel JSON API links (@beauby)

      -
    • -

      #1246 -Add support for resource-level JSON API links (@beauby)

      -
    • -

      #1225 -Better serializer lookup, use nested serializer when it exists (@beauby)

      -
    • -

      #1213 -type directive for serializer to control type field with -json-api adapter (@youroff)

      -
    • -

      #1172 -Better serializer registration, get more than just the first module (@bf4)

      -
    • -

      #1158 -Add support for wildcards in include option (@beauby)

      -
    • -

      #1127 -Add support for nested associations for JSON and Attributes adapters via -the include option (@NullVoxPopuli, @beauby).

      -
    • -

      #1050 -Add support for toplevel jsonapi member (@beauby, @bf4)

      -
    • -

      #1251 -Rename ArraySerializer to CollectionSerializer for clarity, add -ActiveModelSerializers.config.collection_serializer (@bf4)

      -
    • -

      #1295 -Add config serializer_lookup_enabled that, when disabled, -requires serializers to explicitly specified. (@trek)

      -
    - -

    Fixes:

    -
    • -

      #1352 -Fix generators; Isolate Rails-specifc code in Railties (@dgynn, @bf4)

      -
    • -

      #1384[https://github.com/rails-api/active_model_serializers/pull/1384]Fix -database state leaking across tests (@bf4)

      -
    • -

      #1297 -Fix fields option to restrict relationships as well (@beauby)

      -
    • -

      #1239 -Fix duplicates in JSON API compound documents (@beauby)

      -
    • -

      #1214 -retrieve the key from the reflection options when building associations -(@NullVoxPopuli, @hut8)

      -
    • -

      #1358 -Handle serializer file paths with spaces (@rwstauner, @bf4)

      -
    • -

      #1195 -Fix id override (@beauby)

      -
    • -

      #1185 -Fix options passing in Json and Attributes adapters (@beauby)

      -
    - -

    Misc:

    -
    • -

      #1383 -Simplify reflections handling (@beauby)

      -
    • -

      #1370 -Simplify attributes handling via a mixin (@beauby)

      -
    • -

      #1301 -Mapping JSON API spec / schema to AMS (@bf4)

      -
    • -

      #1271 -Handle no serializer source file to digest (@bf4)

      -
    • -

      #1260 -Serialization and Cache Documentation (@bf4)

      -
    • -

      #1259 -Add more info to CONTRIBUTING (@bf4)

      -
    • -

      #1233 -Top-level meta and meta_key options no longer handled at serializer level -(@beauby)

      -
    • -

      #1232 -fields option no longer handled at serializer level (@beauby)

      -
    • -

      #1220 -Remove empty rubocop.rake (@maurogeorge)

      -
    • -

      #1178 -env CAPTURE_STDERR=false lets devs see hard failures (@bf4)

      -
    • -

      #1177 -Remove Adapter autoloads in favor of require (@bf4)

      -
    • -

      #1117 -FlattenJson adapter no longer inherits Json adapter, renamed to Attributes -(@bf4)

      -
    • -

      #1171 -add require statements to top of file (@shicholas)

      -
    • -

      #1167 -Delegate Serializer.attributes to Serializer.attribute (@bf4)

      -
    • -

      #1174 -Consistently refer to the 'JSON API' and the 'JsonApi' -adapter (@bf4)

      -
    • -

      #1173 -Comment private accessor warnings (@bf4)

      -
    • -

      #1166 -Prefer methods over instance variables (@bf4)

      -
    • -

      #1168 -Fix appveyor failure cache not being expired (@bf4)

      -
    • -

      #1161 -Remove duplicate test helper (@bf4)

      -
    • -

      #1360 -Update CI to test 2.2.2 -> 2.2.3 (@karaAJC)

      -
    • -

      #1371 -Refactor, update, create documentation (@bf4)

      -
    - -

    v0.10.0.rc3 (2015-09-16)

    -
    • -

      #1129 -Remove SerializableResource.serialize in favor of .new (@bf4)

      -
    • -

      #1155 -Outside controller use tutorial (@CodedBeardedSignedTaylor)

      -
    • -

      #1154 -Rubocop fixes for issues introduced by #1089 (@NullVoxPopuli)

      -
    • -

      #1089 -Add ActiveModelSerializers.logger with default null device (@bf4)

      -
    • -

      #1109 -Make better use of Minitest's lifecycle (@bf4)

      -
    • -

      #1144 -Fix Markdown to adapters documentation (@bacarini)

      -
    • -

      #1121 -Refactor add_links in JSONAPI adapter. (@beauby)

      -
    • -

      #1150 -Remove legacy method accidentally reintroduced in #1017 (@beauby)

      -
    • -

      #1149 -Update README with nested included association example. (@mattmueller)

      -
    • -

      #1110 -Add lint tests for AR models (@beauby)

      -
    • -

      #1131 -Extended format for JSONAPI include option (@beauby)

      -
    • -

      adds extended format for include option to JsonApi adapter

      -
    • -

      #1142 -Updating wording on cache expiry in README (@leighhalliday)

      -
    • -

      #1140 -Fix typo in fieldset exception (@lautis)

      -
    • -

      #1132 -Get rid of unnecessary instance variables, and implied dependencies. -(@beauby)

      -
    • -

      #1139 -Documentation for serializing resources without render (@PericlesTheo)

      -
    • -

      #1017 -Make Adapters registerable so they are not namespace-constrained (@bf4)

      -
    • -

      #1120 -Add windows platform to loading sqlite3 (@Eric-Guo)

      -
    • -

      #1123 -Remove url options (@bacarini)

      -
    • -

      #1093 -Factor with_adapter + force cache clear before each test. -(@beauby)

      -
    • -

      #1095 -Add documentation about configuration options. (@beauby)

      -
    • -

      #1069 -Add test coverage; account for no artifacts on CI (@bf4)

      -
    • -

      #1103 -Move id and json_api_type methods from -Serializer to JsonApi. (@beauby)

      -
    • -

      #1106 -Add Style enforcer (via Rubocop) (@bf4)

      -
    • -

      #1079 -Add ArraySerializer#object like Serializer (@bf4)

      -
    • -

      #1096 -Fix definition of serializer attributes with multiple calls to `attri… -(@beauby)

      -
    • -

      #1105 -Add ActiveRecord-backed fixtures. (@beauby)

      -
    • -

      #1108 -Better lint (@bf4)

      -
    • -

      #1102 -Remove remains of embed option. (@beauby)

      -
    • -

      #1090 -Clarify AMS dependencies (@bf4)

      -
    • -

      #1081 -Add configuration option to set resource type to singular/plural (@beauby)

      -
    • -

      #1067 -Fix warnings (@bf4)

      -
    • -

      #1066 -Adding appveyor to the project (@joaomdmoura, @Eric-Guo, @bf4)

      -
    • -

      #1071 -Make testing suite running and pass in Windows (@Eric-Guo, @bf4)

      -
    • -

      #1041 -Adding pagination links (@bacarini)

      -
    • -

      adds support for pagination links at top level of JsonApi -adapter

      -
    • -

      #1063 -Lead by example: lint PORO model (@bf4)

      -
    • -

      #1 -Test caller line parsing and digesting (@bf4)

      -
    • -

      #1048 -Let FlattenJson adapter decide it doesn't include meta (@bf4)

      -
    • -

      #1060 -Update fragment cache to support namespaced objects (@aaronlerch)

      -
    • -

      #1052 -Use underscored json_root when serializing a collection (@whatthewhat)

      -
    • -

      #1051 -Fix some invalid JSON in docs (@tjschuck)

      -
    • -

      #1049 -Fix incorrect s/options = {}/options ||= {} (@bf4)

      -
    • -

      #1037 -allow for type attribute (@lanej)

      -
    • -

      #1034 -allow id attribute to be overriden (@lanej)

      -
    • -

      #1035 -Fixed Comments highlight (@artLopez)

      -
    • -

      #1031 -Disallow to define multiple associations at once (@bolshakov)

      -
    • -

      #1032 -Wrap railtie requirement with rescue (@elliotlarson)

      -
    • -

      #1026 -Bump Version Number to 0.10.0.rc2 (@jfelchner)

      -
    • -

      #985 -Associations implementation refactoring (@bolshakov)

      -
    • -

      #954 -Encapsulate serialization in ActiveModel::SerializableResource (@bf4)

      -
    • -

      #972 -Capture app warnings on test run (@bf4)

      -
    • -

      #1019 -Improve README.md (@baojjeu)

      -
    • -

      #998 -Changing root to model class name (@joaomdmoura)

      -
    • -

      #1006 -Fix adapter inflection bug for api -> API (@bf4)

      -
    • -

      #1016 -require rails/railtie before subclassing Rails::Railtie (@bf4)

      -
    • -

      #1013 -Root option with empty array support (@vyrak, @mareczek)

      -
    • -

      #994 -Starting Docs structure (@joaomdmoura)

      -
    • -

      #1007 -Bug fix for ArraySerializer json_key (@jiajiawang)

      -
    • -

      #1003 -Fix transient test failures (@Rodrigora)

      -
    • -

      #996 -Add linter for serializable resource (@bf4)

      -
    • -

      #990 -Adding json-api meta test (@joaomdmoura)

      -
    • -

      #984 -Add option “key” to serializer associations (@Rodrigora)

      -
    • -

      #982 -Fix typo (@bf4)

      -
    • -

      #981 -Remove unused PORO#to_param (@bf4)

      -
    • -

      #978 -fix generators template bug (@regonn)

      -
    • -

      #975 -Fixes virtual value not being used (@GriffinHeart)

      -
    • -

      #970 -Fix transient tests failures (@Rodrigora)

      -
    • -

      #962 -Rendering objects that doesn't have serializers (@bf4, @joaomdmoura, -@JustinAiken)

      -
    • -

      #939 -Use a more precise generated cache key (@aaronlerch)

      -
    • -

      #971 -Restore has_one to generator (@bf4)

      -
    • -

      #965 -options fedault valueserializable_hash and as_json (@bf4)

      -
    • -

      #959 -TYPO on README.md (@kangkyu)

      -
    - -

    v0.10.0.rc2 (2015-06-16)

    -
    • -

      #958 -Splitting json adapter into two (@joaomdmoura)

      -
    • -

      adds FlattenJSON as default adapter

      -
    • -

      #953 -use model name to determine the type (@lsylvester)

      -
    • -

      uses model name to determine the type

      -
    • -

      #949 -Don't pass serializer option to associated serializers (@bf4, -@edwardloveall)

      -
    • -

      #902 -Added serializer file digest to the cache_key (@cristianbica)

      -
    • -

      #948 -AMS supports JSONAPI 1.0 instead of RC4 (@SeyZ)

      -
    • -

      #936 -Include meta when using json adapter with custom root (@chrisbranson)

      -
    • -

      #942 -Small code styling issue (@thiagofm)

      -
    • -

      #930 -Reverting PR #909 (@joaomdmoura)

      -
    • -

      #924 -Avoid unecessary calls to attribute methods when fragment caching -(@navinpeiris)

      -
    • -

      #925 -Updates JSON API Adapter to generate RC4 schema (@benedikt)

      -
    • -

      adds JSON API support 1.0

      -
    • -

      #918 -Adding rescue_with_handler to clear state (@ryansch)

      -
    • -

      #909 -Defining Json-API Adapter as Default (@joaomdmoura)

      -
    • -

      remove root key option and split JSON adapter

      -
    • -

      #914 -Prevent possible duplicated attributes in serializer (@groyoh)

      -
    • -

      #880 -Inabling subclasses serializers to inherit attributes (@groyoh)

      -
    • -

      #913 -Avoiding the serializer option when instantiating a new one for -ArraySerializer Fixed #911 (@groyoh)

      -
    • -

      #897 -Allow to define custom serializer for given class (@imanel)

      -
    • -

      #892 -Fixed a bug that appeared when json adapter serialize a nil association -(@groyoh)

      -
    • -

      #895 -Adding a test to cover 'meta' and 'meta_key' attr_readers -(@adomokos)

      -
    • -

      #894 -Fixing typos in README.md (@adomokos)

      -
    • -

      #888 -Changed duplicated test name in action controller test (@groyoh)

      -
    • -

      #890 -Remove unused method def_serializer (@JustinAiken)

      -
    • -

      #887 -Fixing tests on JRuby (@joaomdmoura)

      -
    • -

      #885 -Updates rails versions for test and dev (@tonyta)

      -
    - -

    v0.10.0.rc1 (2015-04-22)

    -
    • -

      #810 -Adding Fragment Cache to AMS (@joaomdmoura)

      -
    • -

      adds fragment cache support

      -
    • -

      #868 -Fixed a bug that appears when a nil association is included (@groyoh)

      -
    • -

      #861 -README: Add emphasis to single-word difference (@machty)

      -
    • -

      #858 -Included resource fixes (@mateomurphy)

      -
    • -

      #853 -RC3 Updates for JSON API (@mateomurphy)

      -
    • -

      #852 -Fix options merge order in each_association (@mateomurphy)

      -
    • -

      #850 -Use association value for determining serializer used (@mateomurphy)

      -
    • -

      #843 -Remove the mailing list from the README (@JoshSmith)

      -
    • -

      #842 -Add notes on how you can help to contributing documentation (@JoshSmith)

      -
    • -

      #833 -Cache serializers for class (@lsylvester)

      -
    • -

      #837 -Store options in array serializers (@kurko)

      -
    • -

      #836 -Makes passed in options accessible inside serializers (@kurko)

      -
    • -

      #773 -Make json api adapter 'include' option accept an array -(@sweatypitts)

      -
    • -

      #830 -Add contributing readme (@JoshSmith)

      -
    • -

      #811 -Reimplement serialization scope and scope_name (@mateomurphy)

      -
    • -

      #725 -Support has_one to be compatible with 0.8.x (@ggordon)

      -
    • -

      adds has_one attribute for backwards compatibility

      -
    • -

      #822 -Replace has_one with attribute in template (@bf4)

      -
    • -

      #821 -Fix explicit serializer for associations (@wjordan)

      -
    • -

      #798 -Fix lost test test_include_multiple_posts_and_linked -(@donbobka)

      -
    • -

      #807 -Add Overriding attribute methods section to README. (@alexstophel)

      -
    • -

      #693 -Cache Support at AMS 0.10.0 (@joaomdmoura)

      -
    • -

      adds cache support to attributes and associations.

      -
    • -

      #792 -Association overrides (@kurko)

      -
    • -

      adds method to override association

      -
    • -

      #794 -add to_param for correct URL generation (@carlesjove)

      -
    - -

    v0.10.0-pre

    - - -

    0.09.x

    - -

    v0.9.3 (2015/01/21 20:29 +00:00)

    - -

    Features: - #774 -Fix nested include attributes (@nhocki) - #771 -Make linked resource type names consistent with root names (@sweatypitts) - -#696 -Explicitly set serializer for associations (@ggordon) - #700 -sparse fieldsets (@arenoir) - #768 -Adds support for meta and meta_key attribute -(@kurko)

    - -

    v0.9.1 (2014/12/04 11:54 +00:00)

    -
    • -

      #707 -A Friendly Note on Which AMS Version to Use (@jherdman)

      -
    • -

      #730 -Fixes nested has_many links in JSONAPI (@kurko)

      -
    • -

      #718 -Allow overriding the adapter with render option (@ggordon)

      -
    • -

      #720 -Rename attribute with :key (0.8.x compatibility) (@ggordon)

      -
    • -

      #728 -Use type as key for linked resources (@kurko)

      -
    • -

      #729 -Use the new beta build env on Travis (@joshk)

      -
    • -

      #703 -Support serializer and each_serializer options in renderer (@ggordon, -@mieko)

      -
    • -

      #727 -Includes links inside of linked resources (@kurko)

      -
    • -

      #726 -Bugfix: include nested has_many associations (@kurko)

      -
    • -

      #722 -Fix infinite recursion (@ggordon)

      -
    • -

      #1 -Allow for the implicit use of ArraySerializer when :each_serializer is -specified (@mieko)

      -
    • -

      #692 -Include 'linked' member for json-api collections (@ggordon)

      -
    • -

      #714 -Define as_json instead of to_json (@guilleiguaran)

      -
    • -

      #710 -JSON-API: Don't include linked section if associations are empty -(@guilleiguaran)

      -
    • -

      #711 -Fixes rbx gems bundling on TravisCI (@kurko)

      -
    • -

      #709 -Add type key when association name is different than object type -(@guilleiguaran)

      -
    • -

      #708 -Handle correctly null associations (@guilleiguaran)

      -
    • -

      #691 -Fix embed option for associations (@jacob-s-son)

      -
    • -

      #689 -Fix support for custom root in JSON-API adapter (@guilleiguaran)

      -
    • -

      #685 -Serialize ids as strings in JSON-API adapter (@guilleiguaran)

      -
    • -

      #684 -Refactor adapters to implement support for array serialization -(@guilleiguaran)

      -
    • -

      #682 -Include root by default in JSON-API serializers (@guilleiguaran)

      -
    • -

      #625 -Add DSL for urls (@JordanFaust)

      -
    • -

      #677 -Add support for embed: :ids option for in associations (@guilleiguaran)

      -
    • -

      #681 -Check superclasses for Serializers (@quainjn)

      -
    • -

      #680 -Add support for root keys (@NullVoxPopuli)

      -
    • -

      #675 -Support Rails 4.2.0 (@tricknotes)

      -
    • -

      #667 -Require only activemodel instead of full rails (@guilleiguaran)

      -
    • -

      #653 -Add “_test” suffix to JsonApi::HasManyTest filename. (@alexgenco)

      -
    • -

      #631 -Update build badge URL (@craiglittle)

      -
    - -

    0.9.0.alpha1 - January 7, 2014

    - -

    0.9.0.pre

    -
    • -

      The following methods were removed

      -
    • -

      Model#active_model_serializer

      -
    • -

      Serializer#include!

      -
    • -

      Serializer#include?

      -
    • -

      Serializer#attr_disabled=

      -
    • -

      Serializer#cache

      -
    • -

      Serializer#perform_caching

      -
    • -

      Serializer#schema (needs more discussion)

      -
    • -

      Serializer#attribute

      -
    • -

      Serializer#include_#name? (filter method added)

      -
    • -

      Serializer#attributes (took a hash)

      -
    • -

      The following things were added

      -
    • -

      Serializer#filter method

      -
    • -

      CONFIG object

      -
    • -

      Remove support for ruby 1.8 versions.

      -
    • -

      Require rails >= 3.2.

      -
    • -

      Serializers for associations are being looked up in a parent -serializer's namespace first. Same with controllers' namespaces.

      -
    • -

      Added a "prefix" option in case you want to use a different version of -serializer.

      -
    • -

      Serializers default namespace can be set in -default_serializer_options and inherited by associations.

      -
    • -

      Beginning -of rewrite: c65d387705ec534db171712671ba7fcda4f49f68

      -
    - -

    0.08.x

    - -

    v0.8.3 (2014/12/10 14:45 +00:00)

    -
    • -

      #753 -Test against Ruby 2.2 on Travis CI (@tricknotes)

      -
    • -

      #745 -Missing a word (@jockee)

      -
    - -

    v0.8.2 (2014/09/01 21:00 +00:00)

    -
    • -

      #612 -Feature/adapter (@bolshakov)

      -
    • -

      adds adapters pattern

      -
    • -

      #615 -Rails does not support const_defined? in development mode (@tpitale)

      -
    • -

      #613 -README: typo fix on attributes (@spk)

      -
    • -

      #614 -Fix rails 4.0.x build. (@arthurnn)

      -
    • -

      #610 -ArraySerializer (@bolshakov)

      -
    • -

      #607 -ruby syntax highlights (@zigomir)

      -
    • -

      #602 -Add DSL for associations (@JordanFaust)

      -
    - -

    0.8.1 (May 6, 2013)

    -
    • -

      Fix bug whereby a serializer using 'options' would blow up.

      -
    - -

    0.8.0 (May 5, 2013)

    -
    • -

      Attributes can now have optional types.

      -
    • -

      A new DefaultSerializer ensures that POROs behave the same way as -ActiveModels.

      -
    • -

      If you wish to override ActiveRecord::Base#to_Json, you can now require -'active_record/serializer_override'. We don't recommend you do -this, but many users do, so we've left it optional.

      -
    • -

      Fixed a bug where ActionController wouldn't always have MimeResponds.

      -
    • -

      An optinal caching feature allows you to cache JSON & hashes that AMS -uses. Adding 'cached true' to your Serializers will turn on this -cache.

      -
    • -

      URL helpers used inside of Engines now work properly.

      -
    • -

      Serializers now can filter attributes with only and -except:

      -
    - -

    UserSerializer.new(user, only: [:first_name, :last_name]) -UserSerializer.new(user, except: :first_name)

    -
    • -

      Basic Mongoid support. We now include our mixins in the right place.

      -
    • -

      On Ruby 1.8, we now generate an id method that properly -serializes id columns. See issue #127 for more.

      -
    • -

      Add an alias for scope method to be the name of the context. -By default this is current_user. The name is automatically -set when using serialization_scope in the controller.

      -
    • -

      Pass through serialization options (such as :include) when a -model has no serializer defined.

      -
    - -

    0.7.0 (March 6, 2013)

    -
    • -

      embed_key option to allow embedding by attributes other than -IDs

      -
    • -

      Fix rendering nil with custom serializer

      -
    • -

      Fix global self.root = false

      -
    • -

      Add support for specifying the serializer for an association as a String

      -
    • -

      Able to specify keys on the attributes method

      -
    • -

      Serializer Reloading via ActiveSupport::DescendantsTracker

      -
    • -

      Reduce double map to once; Fixes datamapper eager loading.

      -
    - -

    0.6.0 (October 22, 2012)

    -
    • -

      Serialize sets properly

      -
    • -

      Add root option to ArraySerializer

      -
    • -

      Support polymorphic associations

      -
    • -

      Support :each_serializer in ArraySerializer

      -
    • -

      Add scope method to easily access the scope in the serializer

      -
    • -

      Fix regression with Rails 3.2.6; add Rails 4 support

      -
    • -

      Allow serialization_scope to be disabled with serialization_scope nil

      -
    • -

      Array serializer should support pure ruby objects besides serializers

      -
    - -

    0.05.x

    - -

    0.5.2 (June 5, 2012)

    - -

    0.5.1 (May 23, 2012)

    - -

    0.5.0 (May 16, 2012)

    -
    • -

      First tagged version

      -
    • -

      Changes generators to always generate an ApplicationSerializer

      -
    - -

    0.1.0 (December 21, 2011)

    - -

    First Commit as Rails Serializers 0.0.1

    - -

    (December 1, 2011).

    - -

    Prehistory

    - -
    - - - - - \ No newline at end of file diff --git a/file.CONTRIBUTING.html b/file.CONTRIBUTING.html deleted file mode 100644 index 74b8e4be..00000000 --- a/file.CONTRIBUTING.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - File: CONTRIBUTING - - — Documentation by YARD 0.8.7.6 - - - - - - - - - - - - - - - - - - - - - -
    -

    Have an issue?

    - -

    Before opening an issue, try the following:

    - -
    Consult the documentation
    - -

    See if your issue can be resolved by information in the documentation.

    - - -
    Check for an existing issue
    - -

    Take a look at the issues to see if a similar one has already been created. -If one exists, please add any additional information that might expedite -resolution.

    - -

    Open an issue

    - -

    If the documentation wasn't able to help resolve the issue and no issue -already exists, please open a new issue with the following in mind:

    -
    • -

      Please make sure only to include one issue per report. If you encounter -multiple, unrelated issues, please report them as such.

      -
    • -

      Be detailed. Provide backtraces and example code when possible. Provide -information about your environment. e.g., Ruby version, rails version, etc.

      -
    • -

      Own your issue. Actively participate in the discussion and help drive the -issue to closure.

      -
    • -

      If you resolve your own issue, please share the details on the issue and -close it out. Others might have the same issue and sharing solutions is -helpful.

      -
    - -

    Contributing

    - -

    Contributing can be done in many ways and is not exclusive to code. If you -have thoughts on a particular issue or feature, we encourage you to open -new issues for discussion or add your comments to existing ones.

    - -

    Pull requests

    - -

    We also gladly welcome pull requests. When preparing to work on pull -request, please adhere to these standards:

    -
    • -

      Base work on the master branch unless fixing an issue with 0.9-stable -or 0.8-stable

      -
    • -

      Squash your commits and regularly rebase off master.

      -
    • -

      Provide a description of the changes contained in the pull request.

      -
    • -

      Note any specific areas that should be reviewed.

      -
    • -

      Include tests.

      -
    • -

      The test suite must pass on supported Ruby -versions

      -
    • -

      Include updates to the documentation -where applicable.

      -
    • -

      Update the CHANGELOG -to the appropriate sections with a brief description of the changes.

      -
    • -

      Do not change the VERSION file.

      -
    - -

    Running tests

    - -

    Run all tests

    - -

    $ rake test

    - -

    Run a single test suite

    - -

    $ rake test TEST=path/to/test.rb

    - -

    Run a single test

    - -

    $ rake test TEST=path/to/test.rb -TESTOPTS="--name=test_something"

    - -

    Run tests against different Rails versions by setting the RAILS_VERSION -variable and bundling gems. (save this script somewhere executable and run -from top of AMS repository)

    - -
    #!/usr/bin/env bash
-
-rcommand='puts YAML.load_file("./.travis.yml")["env"]["matrix"].join(" ").gsub("RAILS_VERSION=", "")'
-versions=$(ruby -ryaml -e "$rcommand")
-
-for version in ${versions[@]}; do
-  export RAILS_VERSION="$version"
-  rm -f Gemfile.lock
-  bundle check || bundle --local || bundle
-  bundle exec rake test
-  if [ "$?" -eq 0 ]; then
-    # green in ANSI
-    echo -e "\033[32m **** Tests passed against Rails ${RAILS_VERSION} **** \033[0m"
-  else
-    # red in ANSI
-    echo -e "\033[31m **** Tests failed against Rails ${RAILS_VERSION} **** \033[0m"
-    read -p '[Enter] any key to continue, [q] to quit...' prompt
-    if [ "$prompt" = 'q' ]; then
-      unset RAILS_VERSION
-      exit 1
-    fi
-fi
-  unset RAILS_VERSION
-done
    -
    - - - - - \ No newline at end of file diff --git a/file.README.html b/file.README.html index dbfa707b..46887bd4 100644 --- a/file.README.html +++ b/file.README.html @@ -62,198 +62,75 @@
    -

    ActiveModelSerializers

    - - - - - - - - - - - - - -
    Build Status - Build Status - Build status -
    Code Quality - Code Quality - codebeat - Test Coverage -
    Issue Stats - Pulse -
    -

    About

    +

    Docs - ActiveModel::Serializer 0.10.x

    -

    ActiveModelSerializers brings convention over configuration to your JSON -generation.

    +

    This is the documentation of ActiveModelSerializers, it's focused on +the 0.10.x version.

    +
    -

    ActiveModelSerializers works through two components: -serializers and adapters.

    - -

    Serializers describe which attributes and relationships should be -serialized.

    - -

    Adapters describe how attributes and relationships should be -serialized.

    - -

    SerializableResource co-ordinates the resource, Adapter and Serializer to -produce the resource serialization. The serialization has the -#as_json, #to_json and -#serializable_hash methods used by the Rails JSON Renderer. -(SerializableResource actually delegates these methods to the adapter.)

    - -

    By default ActiveModelSerializers will use the Attributes -Adapter (no JSON root). But we strongly advise you to use -JsonApi Adapter, which follows 1.0 of the format specified -in jsonapi.org/format. Check how to -change the adapter in the sections below.

    - -

    0.10.x is not backward compatible with -0.9.x nor 0.8.x.

    - -

    0.10.x is based on the 0.8.0 code, but with a -more flexible architecture. We'd love your help. Learn how you can help here.

    - -

    It is generally safe and recommended to use the master branch.

    - -

    Installation

    - -

    Add this line to your application's Gemfile:

    - -
    gem 'active_model_serializers', '~> 0.10.0'
-
    - -

    And then execute:

    - -
    $ bundle
    - -

    Getting Started

    - -

    See Getting Started for the -nuts and bolts.

    - -

    More information is available in the Guides and High-level behavior.

    - -

    Getting Help

    - -

    If you find a bug, please report an Issue -and see our contributing guide.

    - -

    If you have a question, please post -to Stack Overflow.

    - -

    If you'd like to chat, we have a community slack.

    - -

    Thanks!

    - -

    Documentation

    +

    General

    -

    High-level behavior

    +

    How to

    + -

    Choose an adapter from adapters:

    +

    Integrations

    -
    ActiveModelSerializers.config.adapter = :json_api # Default: `:attributes`
-
    - -

    Given a serializable -model:

    - -
    # either
-class SomeResource < ActiveRecord::Base
-  # columns: title, body
-end
-# or
-class SomeResource < ActiveModelSerializers::Model
-  attr_accessor :title, :body
-end
-
    - -

    And initialized as:

    - -
    resource = SomeResource.new(title: 'ActiveModelSerializers', body: 'Convention over configuration')
-
    - -

    Given a serializer for the serializable model:

    - -
    class SomeSerializer < ActiveModel::Serializer
-  attribute :title, key: :name
-  attributes :body
-end
-
    - -

    The model can be serialized as:

    - -
    options = {}
-serialization = ActiveModelSerializers::SerializableResource.new(resource, options)
-serialization.to_json
-serialization.as_json
-
    - -

    SerializableResource delegates to the adapter, which it builds as:

    - -
    adapter_options = {}
-adapter = ActiveModelSerializers::Adapter.create(serializer, adapter_options)
-adapter.to_json
-adapter.as_json
-adapter.serializable_hash
-
    - -

    The adapter formats the serializer's attributes and associations -(a.k.a. includes):

    - -
    serializer_options = {}
-serializer = SomeSerializer.new(resource, serializer_options)
-serializer.attributes
-serializer.associations
-
    - -

    See ARCHITECTURE.md for more -information.

    - -

    Contributing

    - -

    See CONTRIBUTING.md

    +

    | Integration | Supported ActiveModelSerializers versions | Gem name and/or +link |—-|—–|—- | Ember.js | 0.9.x | active-model-adapter +| Ember.js | 0.10.x + | docs/integrations/ember-and-json-api.md +| Grape | 0.10.x + | docs/integrations/grape.md | | Grape | +0.9.x | github.com/jrhe/grape-active_model_serializers/ +| | Sinatra | 0.9.x | github.com/SauloSilva/sinatra-active-model-serializers/

    diff --git a/file.STYLE.html b/file.STYLE.html index 816a5ebc..1566f0d4 100644 --- a/file.STYLE.html +++ b/file.STYLE.html @@ -177,7 +177,7 @@ labels here.

    diff --git a/file.adapters.html b/file.adapters.html index 3b05eab8..c6756d61 100644 --- a/file.adapters.html +++ b/file.adapters.html @@ -337,7 +337,7 @@ Adapter class on GitHub

    diff --git a/file.add_pagination_links.html b/file.add_pagination_links.html index 80ba79d0..2ad2c28a 100644 --- a/file.add_pagination_links.html +++ b/file.add_pagination_links.html @@ -187,7 +187,7 @@ is not possible to add pagination links.

    diff --git a/file.add_root_key.html b/file.add_root_key.html index a6cdee4b..90d0dab0 100644 --- a/file.add_root_key.html +++ b/file.add_root_key.html @@ -117,7 +117,7 @@ your serialized endpoints.

    diff --git a/file.caching.html b/file.caching.html index 4ae7d5fb..9c3712ed 100644 --- a/file.caching.html +++ b/file.caching.html @@ -126,7 +126,7 @@ relationships

    diff --git a/file.configuration_options.html b/file.configuration_options.html index a4183f98..ad8de78d 100644 --- a/file.configuration_options.html +++ b/file.configuration_options.html @@ -182,7 +182,7 @@ level jsonapi member in the response document.

    diff --git a/file.deserialization.html b/file.deserialization.html index f9c42af7..5d5ad8f4 100644 --- a/file.deserialization.html +++ b/file.deserialization.html @@ -170,7 +170,7 @@ via the options:

    diff --git a/file.ember-and-json-api.html b/file.ember-and-json-api.html index 6957217a..eb7613f2 100644 --- a/file.ember-and-json-api.html +++ b/file.ember-and-json-api.html @@ -180,7 +180,7 @@ something like this:

    diff --git a/file.errors.html b/file.errors.html index e693a994..72c4b55a 100644 --- a/file.errors.html +++ b/file.errors.html @@ -126,7 +126,7 @@ descriptions.

    diff --git a/file.getting_started.html b/file.getting_started.html index 73334d18..4028e138 100644 --- a/file.getting_started.html +++ b/file.getting_started.html @@ -199,7 +199,7 @@ sets Rails.application.routes.default_url_options.

    diff --git a/file.grape.html b/file.grape.html index 08dbe034..d5158b65 100644 --- a/file.grape.html +++ b/file.grape.html @@ -89,7 +89,7 @@ ActiveModelSerializers is exactly the same.

    diff --git a/file.instrumentation.html b/file.instrumentation.html index e37a9be7..ff5f545a 100644 --- a/file.instrumentation.html +++ b/file.instrumentation.html @@ -104,7 +104,7 @@ API, which allows for subscribing to events, such as for logging.

    diff --git a/file.key_transforms.html b/file.key_transforms.html index b8eefacb..6417759f 100644 --- a/file.key_transforms.html +++ b/file.key_transforms.html @@ -101,7 +101,7 @@ adapter default |

    diff --git a/file.logging.html b/file.logging.html index 83867017..08ed5b02 100644 --- a/file.logging.html +++ b/file.logging.html @@ -79,7 +79,7 @@ instance of ActiveSupport::TaggedLogging logging to STDOUT.

    diff --git a/file.outside_controller_use.html b/file.outside_controller_use.html index 0a59d0b3..3e266bbd 100644 --- a/file.outside_controller_use.html +++ b/file.outside_controller_use.html @@ -124,7 +124,7 @@ you want to be serialized and call .as_json.

    diff --git a/file.passing_arbitrary_options.html b/file.passing_arbitrary_options.html index 85071be2..c6c6dfec 100644 --- a/file.passing_arbitrary_options.html +++ b/file.passing_arbitrary_options.html @@ -95,7 +95,7 @@ our serializer.

    diff --git a/file.rendering.html b/file.rendering.html index 9b3593e5..49146e7f 100644 --- a/file.rendering.html +++ b/file.rendering.html @@ -324,7 +324,7 @@ to add pagination links.

    diff --git a/file.schema.html b/file.schema.html index 9fc5fd55..514ef670 100644 --- a/file.schema.html +++ b/file.schema.html @@ -338,7 +338,7 @@ error.

    diff --git a/file.serialize_poro.html b/file.serialize_poro.html index 22657e43..8f9ca796 100644 --- a/file.serialize_poro.html +++ b/file.serialize_poro.html @@ -93,7 +93,7 @@ cleaner. The above code now becomes: ruby # my_model.rb class MyModel diff --git a/file.serializers.html b/file.serializers.html index 018cb777..3f952ca5 100644 --- a/file.serializers.html +++ b/file.serializers.html @@ -494,7 +494,7 @@ method to return a serializer class based on defined conditions.

    diff --git a/file.template.html b/file.template.html index 51152e87..5e90185b 100644 --- a/file.template.html +++ b/file.template.html @@ -85,7 +85,7 @@ href="https://github.com/rails-api/active_model_serializers/issues/dddd">github. diff --git a/file.test.html b/file.test.html index 4a3f65c1..4c817cbe 100644 --- a/file.test.html +++ b/file.test.html @@ -213,7 +213,7 @@ Example:

    diff --git a/file_list.html b/file_list.html index d9febc30..8de215bd 100644 --- a/file_list.html +++ b/file_list.html @@ -54,70 +54,79 @@
  • README
    • -
  • adapters
    • +
  • ARCHITECTURE
    • -
  • caching
    • +
  • README
    • -
  • configuration_options
    • +
  • STYLE
    • -
  • deserialization
    • +
  • adapters
    • -
  • getting_started
    • +
  • caching
    • -
  • instrumentation
    • +
  • configuration_options
    • -
  • key_transforms
    • +
  • deserialization
    • -
  • logging
    • +
  • getting_started
    • -
  • rendering
    • +
  • instrumentation
    • -
  • serializers
    • +
  • key_transforms
    • -
  • add_pagination_links
    • +
  • logging
    • -
  • add_root_key
    • +
  • rendering
    • -
  • outside_controller_use
    • +
  • serializers
    • -
  • passing_arbitrary_options
    • +
  • add_pagination_links
    • -
  • serialize_poro
    • +
  • add_root_key
    • -
  • test
    • +
  • outside_controller_use
    • -
  • ember-and-json-api
    • +
  • passing_arbitrary_options
    • -
  • grape
    • +
  • serialize_poro
    • -
  • errors
    • +
  • test
    • -
  • schema
    • +
  • ember-and-json-api
    • -
  • 0000-namespace
    • +
  • grape
    • -
  • template
    • +
  • errors
    • + + +
  • schema
    • + + +
  • 0000-namespace
    • + + +
  • template
    • diff --git a/index.html b/index.html index dbfa707b..0d6f61cb 100644 --- a/index.html +++ b/index.html @@ -253,7 +253,7 @@ information.

    diff --git a/top-level-namespace.html b/top-level-namespace.html index 9310c3c2..76d5d81e 100644 --- a/top-level-namespace.html +++ b/top-level-namespace.html @@ -105,7 +105,7 @@