ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-22 22:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Generating docs for version 0.10.0 at ref 7578a3c.

Browse Source
This commit is contained in:
Benjamin Fleischer 2016-06-15 10:39:35 -05:00
parent dd0d9c6835
commit fade096abe
123 changed files with 234 additions and 2030 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ActionController.html
View File

@ -106,7 +106,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActionController/Serialization.html
View File

@ -339,7 +339,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActionController/Serialization/ClassMethods.html
View File

@ -165,7 +165,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel.html
View File

@ -120,7 +120,7 @@ subclassed to decorate a resource.</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/SerializableResource.html
View File

@ -126,7 +126,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:30 2016 by
Generated on Wed Jun 15 10:39:33 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer.html
View File

@ -1755,7 +1755,7 @@ below is true:</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:30 2016 by
Generated on Wed Jun 15 10:39:32 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Adapter.html
View File

@ -147,7 +147,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Adapter/Attributes.html
View File

@ -239,7 +239,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Adapter/Base.html
View File

@ -226,7 +226,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Adapter/Json.html
View File

@ -239,7 +239,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:33 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Adapter/JsonApi.html
View File

@ -240,7 +240,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Adapter/Null.html
View File

@ -239,7 +239,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/ArraySerializer.html
View File

@ -160,7 +160,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Association.html
View File

@ -583,7 +583,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:33 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Associations.html
View File

@ -263,7 +263,7 @@ not provided)</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Associations/ClassMethods.html
View File

@ -488,7 +488,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Attribute.html
View File

@ -158,7 +158,7 @@ ActiveModel::Serializer class.</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:30 2016 by
Generated on Wed Jun 15 10:39:33 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Attributes.html
View File

@ -115,7 +115,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Attributes/ClassMethods.html
View File

@ -488,7 +488,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/BelongsToReflection.html
View File

@ -167,7 +167,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Caching.html
View File

@ -629,7 +629,7 @@ customize the cache key</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Caching/ClassMethods.html
View File

@ -1291,7 +1291,7 @@ called with a non-nil value. rubocop:disable Style/ClassVars</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/CollectionReflection.html
View File

@ -163,7 +163,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/CollectionSerializer.html
View File

@ -703,7 +703,7 @@ the logic right here.</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Configuration.html
View File

@ -110,7 +110,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/ErrorSerializer.html
View File

@ -387,7 +387,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/ErrorsSerializer.html
View File

@ -494,7 +494,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Field.html
View File

@ -405,7 +405,7 @@ block is evaluated in the context of the serializer.</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:30 2016 by
Generated on Wed Jun 15 10:39:33 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Fieldset.html
View File

@ -303,7 +303,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:30 2016 by
Generated on Wed Jun 15 10:39:33 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/HasManyReflection.html
View File

@ -167,7 +167,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/HasOneReflection.html
View File

@ -167,7 +167,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Links.html
View File

@ -115,7 +115,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Links/ClassMethods.html
View File

@ -246,7 +246,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Lint.html
View File

@ -106,7 +106,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Lint/Tests.html
View File

@ -901,7 +901,7 @@ required unless caching is enabled.</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Meta.html
View File

@ -115,7 +115,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Meta/ClassMethods.html
View File

@ -192,7 +192,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Null.html
View File

@ -390,7 +390,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:30 2016 by
Generated on Wed Jun 15 10:39:32 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Reflection.html
View File

@ -729,7 +729,7 @@ association by its reflection.</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:30 2016 by
Generated on Wed Jun 15 10:39:33 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/SingularReflection.html
View File

@ -163,7 +163,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Type.html
View File

@ -115,7 +115,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModel/Serializer/Type/ClassMethods.html
View File

@ -187,7 +187,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers.html
View File

@ -453,7 +453,7 @@ Style/AsciiComments TODO: implement!</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter.html
View File

@ -878,7 +878,7 @@ so that registering &#39;ActiveModelSerializers::Adapter::Json&#39; and
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/Attributes.html
View File

@ -212,7 +212,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/Base.html
View File

@ -1073,7 +1073,7 @@ serialization_options(options).</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/Json.html
View File

@ -320,7 +320,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/JsonApi.html
View File

@ -851,7 +851,7 @@ definition:</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/JsonApi/Deserialization.html
View File

@ -1050,7 +1050,7 @@ value.</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:32 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/JsonApi/Error.html
View File

@ -462,7 +462,7 @@ parameter: A string indicating which query parameter caused the error</code></pr
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:32 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/JsonApi/Jsonapi.html
View File

@ -356,7 +356,7 @@ meta</code></pre>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:32 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/JsonApi/Link.html
View File

@ -466,7 +466,7 @@ meta</code></pre>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/JsonApi/Meta.html
View File

@ -292,7 +292,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/JsonApi/PaginationLinks.html
View File

@ -431,7 +431,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/JsonApi/Relationship.html
View File

@ -287,7 +287,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/JsonApi/ResourceIdentifier.html
View File

@ -255,7 +255,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Adapter/Null.html
View File

@ -208,7 +208,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Callbacks.html
View File

@ -133,7 +133,7 @@ serialization and allow you to trigger logic. Available callbacks are:</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Callbacks/ClassMethods.html
View File

@ -216,7 +216,7 @@ it is as_json, to_json, or serializable_hash</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Deprecate.html
View File

@ -262,7 +262,7 @@ that it is planned to go away.</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Deserialization.html
View File

@ -230,7 +230,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/JsonPointer.html
View File

@ -180,7 +180,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Jsonapi.html
View File

@ -343,7 +343,7 @@ actionpack/lib/action_dispatch/http/parameters.rb</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:32 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Jsonapi/ControllerSupport.html
View File

@ -173,7 +173,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:32 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/KeyTransform.html
View File

@ -524,7 +524,7 @@ deserialization in the JsonApi adapter.</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Logging.html
View File

@ -262,7 +262,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Logging/ClassMethods.html
View File

@ -177,7 +177,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Logging/LogSubscriber.html
View File

@ -245,7 +245,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:30 2016 by
Generated on Wed Jun 15 10:39:33 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Logging/Macros.html
View File

@ -240,7 +240,7 @@ rendered. Adapted from:</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Model.html
View File

@ -752,7 +752,7 @@ ActiveModel::Errors :nocov:</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:30 2016 by
Generated on Wed Jun 15 10:39:33 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Railtie.html
View File

@ -114,7 +114,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:30 2016 by
Generated on Wed Jun 15 10:39:33 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/SerializableResource.html
View File

@ -822,7 +822,7 @@ False when explicit adapter is falsy (nil or false)</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/SerializationContext.html
View File

@ -559,7 +559,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:32 2016 by
Generated on Wed Jun 15 10:39:35 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/SerializationContext/UrlHelpers.html
View File

@ -236,7 +236,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Test.html
View File

@ -113,7 +113,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Test/Schema.html
View File

@ -463,7 +463,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Test/Schema/AssertRequestSchema.html
View File

@ -213,7 +213,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Test/Schema/AssertResponseSchema.html
View File

@ -213,7 +213,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Test/Schema/AssertSchema.html
View File

@ -645,7 +645,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Test/Serializer.html
View File

@ -218,7 +218,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
ActiveModelSerializers/Test/Serializer/AssertSerializer.html
View File

@ -701,7 +701,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
BulkCacheFetcher.html
View File

@ -312,7 +312,7 @@ found objects, so you can use it for things like setting cache expiration.</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:32 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
Grape.html
View File

@ -124,7 +124,7 @@ render helper in Grape::Helpers::ActiveModelSerializers</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
Grape/ActiveModelSerializers.html
View File

@ -101,7 +101,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:30 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
Grape/Formatters.html
View File

@ -106,7 +106,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
Grape/Formatters/ActiveModelSerializers.html
View File

@ -169,7 +169,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
Grape/Helpers.html
View File

@ -106,7 +106,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
Grape/Helpers/ActiveModelSerializers.html
View File

@ -186,7 +186,7 @@ posts.page, total_pages: posts.total_pages })</p>
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:29 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
Rails.html
View File

@ -108,7 +108,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
Rails/Generators.html
View File

@ -108,7 +108,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:28 2016 by
Generated on Wed Jun 15 10:39:31 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
Rails/Generators/ResourceGenerator.html
View File

@ -111,7 +111,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:30 2016 by
Generated on Wed Jun 15 10:39:33 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
Rails/Generators/SerializerGenerator.html
View File

@ -183,7 +183,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:31 2016 by
Generated on Wed Jun 15 10:39:34 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

55
_index.html
View File

@ -67,70 +67,79 @@
<li class="r1"><a href="index.html" title="README">README</a></li>
<li class="r2"><a href="file.adapters.html" title="adapters">adapters</a></li>
<li class="r2"><a href="file.ARCHITECTURE.html" title="ARCHITECTURE">ARCHITECTURE</a></li>
<li class="r1"><a href="file.caching.html" title="caching">caching</a></li>
<li class="r1"><a href="file.README.html" title="README">README</a></li>
<li class="r2"><a href="file.configuration_options.html" title="configuration_options">configuration_options</a></li>
<li class="r2"><a href="file.STYLE.html" title="STYLE">STYLE</a></li>
<li class="r1"><a href="file.deserialization.html" title="deserialization">deserialization</a></li>
<li class="r1"><a href="file.adapters.html" title="adapters">adapters</a></li>
<li class="r2"><a href="file.getting_started.html" title="getting_started">getting_started</a></li>
<li class="r2"><a href="file.caching.html" title="caching">caching</a></li>
<li class="r1"><a href="file.instrumentation.html" title="instrumentation">instrumentation</a></li>
<li class="r1"><a href="file.configuration_options.html" title="configuration_options">configuration_options</a></li>
<li class="r2"><a href="file.key_transforms.html" title="key_transforms">key_transforms</a></li>
<li class="r2"><a href="file.deserialization.html" title="deserialization">deserialization</a></li>
<li class="r1"><a href="file.logging.html" title="logging">logging</a></li>
<li class="r1"><a href="file.getting_started.html" title="getting_started">getting_started</a></li>
<li class="r2"><a href="file.rendering.html" title="rendering">rendering</a></li>
<li class="r2"><a href="file.instrumentation.html" title="instrumentation">instrumentation</a></li>
<li class="r1"><a href="file.serializers.html" title="serializers">serializers</a></li>
<li class="r1"><a href="file.key_transforms.html" title="key_transforms">key_transforms</a></li>
<li class="r2"><a href="file.add_pagination_links.html" title="add_pagination_links">add_pagination_links</a></li>
<li class="r2"><a href="file.logging.html" title="logging">logging</a></li>
<li class="r1"><a href="file.add_root_key.html" title="add_root_key">add_root_key</a></li>
<li class="r1"><a href="file.rendering.html" title="rendering">rendering</a></li>
<li class="r2"><a href="file.outside_controller_use.html" title="outside_controller_use">outside_controller_use</a></li>
<li class="r2"><a href="file.serializers.html" title="serializers">serializers</a></li>
<li class="r1"><a href="file.passing_arbitrary_options.html" title="passing_arbitrary_options">passing_arbitrary_options</a></li>
<li class="r1"><a href="file.add_pagination_links.html" title="add_pagination_links">add_pagination_links</a></li>
<li class="r2"><a href="file.serialize_poro.html" title="serialize_poro">serialize_poro</a></li>
<li class="r2"><a href="file.add_root_key.html" title="add_root_key">add_root_key</a></li>
<li class="r1"><a href="file.test.html" title="test">test</a></li>
<li class="r1"><a href="file.outside_controller_use.html" title="outside_controller_use">outside_controller_use</a></li>
<li class="r2"><a href="file.ember-and-json-api.html" title="ember-and-json-api">ember-and-json-api</a></li>
<li class="r2"><a href="file.passing_arbitrary_options.html" title="passing_arbitrary_options">passing_arbitrary_options</a></li>
<li class="r1"><a href="file.grape.html" title="grape">grape</a></li>
<li class="r1"><a href="file.serialize_poro.html" title="serialize_poro">serialize_poro</a></li>
<li class="r2"><a href="file.errors.html" title="errors">errors</a></li>
<li class="r2"><a href="file.test.html" title="test">test</a></li>
<li class="r1"><a href="file.schema.html" title="schema">schema</a></li>
<li class="r1"><a href="file.ember-and-json-api.html" title="ember-and-json-api">ember-and-json-api</a></li>
<li class="r2"><a href="file.0000-namespace.html" title="0000-namespace">0000-namespace</a></li>
<li class="r2"><a href="file.grape.html" title="grape">grape</a></li>
<li class="r1"><a href="file.template.html" title="template">template</a></li>
<li class="r1"><a href="file.errors.html" title="errors">errors</a></li>
<li class="r2"><a href="file.schema.html" title="schema">schema</a></li>
<li class="r1"><a href="file.0000-namespace.html" title="0000-namespace">0000-namespace</a></li>
<li class="r2"><a href="file.template.html" title="template">template</a></li>
</ul>
@ -936,7 +945,7 @@
</div>
<div id="footer">
Generated on Wed Jun 15 10:31:22 2016 by
Generated on Wed Jun 15 10:39:24 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
file.0000-namespace.html
View File

@ -205,7 +205,7 @@ RFC or directly via pull request.</p>
</div></div>
<div id="footer">
Generated on Wed Jun 15 10:31:27 2016 by
Generated on Wed Jun 15 10:39:29 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
file.ARCHITECTURE.html
View File

@ -256,7 +256,7 @@ as for records. For example:</p>
</div></div>
<div id="footer">
Generated on Wed Jun 15 10:25:09 2016 by
Generated on Wed Jun 15 10:39:25 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

1484
file.CHANGELOG.html
View File

File diff suppressed because it is too large Load Diff

207
file.CONTRIBUTING.html
View File

@ -1,207 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
File: CONTRIBUTING
&mdash; Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!file.CONTRIBUTING.html";
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> &raquo;
<span class="title">File: CONTRIBUTING</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><div id='filecontents'>
<h2 id="label-Have+an+issue-3F">Have an issue?</h2>
<p>Before opening an issue, try the following:</p>
<h5 id="label-Consult+the+documentation">Consult the documentation</h5>
<p>See if your issue can be resolved by information in the documentation.</p>
<ul><li>
<p><a
href="https://github.com/rails-api/active_model_serializers/tree/master/docs">0.10
(master) Documentation</a></p>
</li><li>
<p><a
href="http://www.rubydoc.info/github/rails-api/active_model_serializers/v0.10.0"><img
src="http://img.shields.io/badge/yard-docs-blue.svg"></a></p>
</li><li>
<p><a href="docs">Guides</a></p>
</li><li>
<p><a
href="https://github.com/rails-api/active_model_serializers/tree/0-9-stable">0.9
(0-9-stable) Documentation</a></p>
</li><li>
<p><a
href="https://github.com/rails-api/active_model_serializers/tree/0-8-stable">0.8
(0-8-stable) Documentation</a></p>
</li></ul>
<h5 id="label-Check+for+an+existing+issue">Check for an existing issue</h5>
<p>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.</p>
<h4 id="label-Open+an+issue">Open an issue</h4>
<p>If the documentation wasn&#39;t able to help resolve the issue and no issue
already exists, please open a new issue with the following in mind:</p>
<ul><li>
<p>Please make sure only to include one issue per report. If you encounter
multiple, unrelated issues, please report them as such.</p>
</li><li>
<p>Be detailed. Provide backtraces and example code when possible. Provide
information about your environment. e.g., Ruby version, rails version, etc.</p>
</li><li>
<p>Own your issue. Actively participate in the discussion and help drive the
issue to closure.</p>
</li><li>
<p>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.</p>
</li></ul>
<h2 id="label-Contributing">Contributing</h2>
<p>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.</p>
<h4 id="label-Pull+requests">Pull requests</h4>
<p>We also gladly welcome pull requests. When preparing to work on pull
request, please adhere to these standards:</p>
<ul><li>
<p>Base work on the master branch unless fixing an issue with <a
href="https://github.com/rails-api/active_model_serializers/tree/0-9-stable">0.9-stable</a>
or <a
href="https://github.com/rails-api/active_model_serializers/tree/0-8-stable">0.8-stable</a></p>
</li><li>
<p>Squash your commits and regularly rebase off master.</p>
</li><li>
<p>Provide a description of the changes contained in the pull request.</p>
</li><li>
<p>Note any specific areas that should be reviewed.</p>
</li><li>
<p>Include tests.</p>
</li><li>
<p>The test suite must pass on <a href=".travis.yml">supported Ruby
versions</a></p>
</li><li>
<p>Include updates to the <a
href="https://github.com/rails-api/active_model_serializers/tree/master/docs">documentation</a>
where applicable.</p>
</li><li>
<p>Update the <a
href="https://github.com/rails-api/active_model_serializers/blob/master/CHANGELOG.md">CHANGELOG</a>
to the appropriate sections with a brief description of the changes.</p>
</li><li>
<p>Do not change the VERSION file.</p>
</li></ul>
<h4 id="label-Running+tests">Running tests</h4>
<p>Run all tests</p>
<p><code>$ rake test</code></p>
<p>Run a single test suite</p>
<p><code>$ rake test TEST=path/to/test.rb</code></p>
<p>Run a single test</p>
<p><code>$ rake test TEST=path/to/test.rb
TESTOPTS=&quot;--name=test_something&quot;</code></p>
<p>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)</p>
<pre class="code ruby"><code class="ruby">#!/usr/bin/env bash
rcommand=&#39;puts YAML.load_file(&quot;./.travis.yml&quot;)[&quot;env&quot;][&quot;matrix&quot;].join(&quot; &quot;).gsub(&quot;RAILS_VERSION=&quot;, &quot;&quot;)&#39;
versions=$(ruby -ryaml -e &quot;$rcommand&quot;)
for version in ${versions[@]}; do
export RAILS_VERSION=&quot;$version&quot;
rm -f Gemfile.lock
bundle check || bundle --local || bundle
bundle exec rake test
if [ &quot;$?&quot; -eq 0 ]; then
# green in ANSI
echo -e &quot;\033[32m **** Tests passed against Rails ${RAILS_VERSION} **** \033[0m&quot;
else
# red in ANSI
echo -e &quot;\033[31m **** Tests failed against Rails ${RAILS_VERSION} **** \033[0m&quot;
read -p &#39;[Enter] any key to continue, [q] to quit...&#39; prompt
if [ &quot;$prompt&quot; = &#39;q&#39; ]; then
unset RAILS_VERSION
exit 1
fi
fi
unset RAILS_VERSION
done</code></pre>
</div></div>
<div id="footer">
Generated on Wed Jun 15 10:25:09 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>
</body>
</html>

229
file.README.html
View File

@ -62,198 +62,75 @@
<iframe id="search_frame"></iframe>
<div id="content"><div id='filecontents'>
<h1 id="label-ActiveModelSerializers">ActiveModelSerializers</h1>
<table>
<tr>
<td>Build Status</td>
<td>
<a href="https://travis-ci.org/rails-api/active_model_serializers"><img src="https://travis-ci.org/rails-api/active_model_serializers.svg?branch=master" alt="Build Status" ></a>
<a href="https://ci.appveyor.com/project/joaomdmoura/active-model-serializers/branch/master"><img src="https://ci.appveyor.com/api/projects/status/x6xdjydutm54gvyt/branch/master?svg=true" alt="Build status"></a>
</td>
</tr>
<tr>
<td>Code Quality</td>
<td>
<a href="https://codeclimate.com/github/rails-api/active_model_serializers"><img src="https://codeclimate.com/github/rails-api/active_model_serializers/badges/gpa.svg" alt="Code Quality"></a>
<a href="https://codebeat.co/projects/github-com-rails-api-active_model_serializers"><img src="https://codebeat.co/badges/a9ab35fa-8b5a-4680-9d4e-a81f9a55ebcd" alt="codebeat" ></a>
<a href="https://codeclimate.com/github/rails-api/active_model_serializers/coverage"><img src="https://codeclimate.com/github/rails-api/active_model_serializers/badges/coverage.svg" alt="Test Coverage"></a>
</td>
</tr>
<tr>
<td>Issue Stats</td>
<td>
<a href="https://github.com/rails-api/active_model_serializers/pulse/monthly">Pulse</a>
</td>
</tr>
</table>
<h2 id="label-About">About</h2>
<h1 id="label-Docs+-+ActiveModel-3A-3ASerializer+0.10.x">Docs - ActiveModel::Serializer 0.10.x</h1>
<p>ActiveModelSerializers brings convention over configuration to your JSON
generation.</p>
<p>This is the documentation of ActiveModelSerializers, it&#39;s focused on
the <strong>0.10.x version.</strong></p>
<hr>
<p>ActiveModelSerializers works through two components:
<strong>serializers</strong> and <strong>adapters</strong>.</p>
<p>Serializers describe <em>which</em> attributes and relationships should be
serialized.</p>
<p>Adapters describe <em>how</em> attributes and relationships should be
serialized.</p>
<p>SerializableResource co-ordinates the resource, Adapter and Serializer to
produce the resource serialization. The serialization has the
<code>#as_json</code>, <code>#to_json</code> and
<code>#serializable_hash</code> methods used by the Rails JSON Renderer.
(SerializableResource actually delegates these methods to the adapter.)</p>
<p>By default ActiveModelSerializers will use the <strong>Attributes
Adapter</strong> (no JSON root). But we strongly advise you to use
<strong>JsonApi Adapter</strong>, which follows 1.0 of the format specified
in <a href="http://jsonapi.org/format">jsonapi.org/format</a>. Check how to
change the adapter in the sections below.</p>
<p><code>0.10.x</code> is <strong>not</strong> backward compatible with
<code>0.9.x</code> nor <code>0.8.x</code>.</p>
<p><code>0.10.x</code> is based on the <code>0.8.0</code> code, but with a
more flexible architecture. We&#39;d love your help. <a
href="CONTRIBUTING.md">Learn how you can help here.</a></p>
<p>It is generally safe and recommended to use the master branch.</p>
<h2 id="label-Installation">Installation</h2>
<p>Add this line to your application&#39;s Gemfile:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>active_model_serializers</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>~&gt; 0.10.0</span><span class='tstring_end'>&#39;</span></span>
</code></pre>
<p>And then execute:</p>
<pre class="code ruby"><code class="ruby">$ bundle</code></pre>
<h2 id="label-Getting+Started">Getting Started</h2>
<p>See <a href="docs/general/getting_started.md">Getting Started</a> for the
nuts and bolts.</p>
<p>More information is available in the <a href="docs">Guides</a> and <a
href="README.md#high-level-behavior">High-level behavior</a>.</p>
<h2 id="label-Getting+Help">Getting Help</h2>
<p>If you find a bug, please report an <a
href="https://github.com/rails-api/active_model_serializers/issues/new">Issue</a>
and see our <a href="CONTRIBUTING.md">contributing guide</a>.</p>
<p>If you have a question, please <a
href="http://stackoverflow.com/questions/tagged/active-model-serializers">post
to Stack Overflow</a>.</p>
<p>If you&#39;d like to chat, we have a <a
href="http://amserializers.herokuapp.com">community slack</a>.</p>
<p>Thanks!</p>
<h2 id="label-Documentation">Documentation</h2>
<h2 id="label-General">General</h2>
<ul><li>
<p><a
href="https://github.com/rails-api/active_model_serializers/tree/master">0.10
(master) Documentation</a></p>
<p><a href="general/getting_started.md">Getting Started</a></p>
</li><li>
<p><a
href="http://www.rubydoc.info/github/rails-api/active_model_serializers/v0.10.0"><img
src="http://img.shields.io/badge/yard-docs-blue.svg"></a></p>
<p><a href="general/configuration_options.md">Configuration Options</a></p>
</li><li>
<p><a href="docs">Guides</a></p>
<p><a href="general/serializers.md">Serializers</a></p>
</li><li>
<p><a
href="https://github.com/rails-api/active_model_serializers/tree/0-9-stable">0.9
(0-9-stable) Documentation</a></p>
<p><a href="general/adapters.md">Adapters</a></p>
</li><li>
<p><a
href="http://www.rubydoc.info/github/rails-api/active_model_serializers/0-9-stable"><img
src="http://img.shields.io/badge/yard-docs-blue.svg"></a></p>
<p><a href="general/rendering.md">Rendering</a></p>
</li><li>
<p><a
href="https://github.com/rails-api/active_model_serializers/tree/0-8-stable">0.8
(0-8-stable) Documentation</a></p>
<p><a href="general/caching.md">Caching</a></p>
</li><li>
<p><a
href="http://www.rubydoc.info/github/rails-api/active_model_serializers/0-8-stable"><img
src="http://img.shields.io/badge/yard-docs-blue.svg"></a></p>
<p><a href="general/logging.md">Logging</a></p>
</li><li>
<p><a href="general/deserialization.md">Deserialization</a></p>
</li><li>
<p><a href="general/instrumentation.md">Instrumentation</a></p>
</li><li>
<p>JSON API</p>
</li><li>
<p><a href="jsonapi/schema.md">Schema</a></p>
</li><li>
<p><a href="jsonapi/errors.md">Errors</a></p>
</li><li>
<p><a href="ARCHITECTURE.md">ARCHITECTURE</a></p>
</li></ul>
<h2 id="label-High-level+behavior">High-level behavior</h2>
<h2 id="label-How+to">How to</h2>
<ul><li>
<p><a href="howto/add_root_key.md">How to add root key</a></p>
</li><li>
<p><a href="howto/add_pagination_links.md">How to add pagination links</a></p>
</li><li>
<p><a href="howto/outside_controller_use.md">Using ActiveModelSerializers
Outside Of Controllers</a></p>
</li><li>
<p><a href="howto/test.md">Testing ActiveModelSerializers</a></p>
</li><li>
<p><a href="howto/passing_arbitrary_options.md">Passing Arbitrary Options</a></p>
</li><li>
<p><a href="howto/serialize_poro.md">How to serialize a Plain-Old Ruby Object
(PORO)</a></p>
</li></ul>
<p>Choose an adapter from <a
href="lib/active_model_serializers/adapter">adapters</a>:</p>
<h2 id="label-Integrations">Integrations</h2>
<pre class="code ruby"><code class="ruby"><span class='const'>ActiveModelSerializers</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span> <span class='op'>=</span> <span class='symbol'>:json_api</span> <span class='comment'># Default: `:attributes`
</span></code></pre>
<p>Given a <a href="lib/active_model/serializer/lint.rb">serializable
model</a>:</p>
<pre class="code ruby"><code class="ruby"><span class='comment'># either
</span><span class='kw'>class</span> <span class='const'>SomeResource</span> <span class='op'>&lt;</span> <span class='const'>ActiveRecord</span><span class='op'>::</span><span class='const'>Base</span>
<span class='comment'># columns: title, body
</span><span class='kw'>end</span>
<span class='comment'># or
</span><span class='kw'>class</span> <span class='const'>SomeResource</span> <span class='op'>&lt;</span> <span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>Model</span>
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:title</span><span class='comma'>,</span> <span class='symbol'>:body</span>
<span class='kw'>end</span>
</code></pre>
<p>And initialized as:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_resource'>resource</span> <span class='op'>=</span> <span class='const'>SomeResource</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>title:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ActiveModelSerializers</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>body:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Convention over configuration</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
</code></pre>
<p>Given a serializer for the serializable model:</p>
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>SomeSerializer</span> <span class='op'>&lt;</span> <span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Serializer</span>
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:title</span><span class='comma'>,</span> <span class='label'>key:</span> <span class='symbol'>:name</span>
<span class='id identifier rubyid_attributes'>attributes</span> <span class='symbol'>:body</span>
<span class='kw'>end</span>
</code></pre>
<p>The model can be serialized as:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_serialization'>serialization</span> <span class='op'>=</span> <span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>SerializableResource</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_serialization'>serialization</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
<span class='id identifier rubyid_serialization'>serialization</span><span class='period'>.</span><span class='id identifier rubyid_as_json'>as_json</span>
</code></pre>
<p>SerializableResource delegates to the adapter, which it builds as:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_adapter_options'>adapter_options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_adapter'>adapter</span> <span class='op'>=</span> <span class='const'>ActiveModelSerializers</span><span class='op'>::</span><span class='const'>Adapter</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_serializer'>serializer</span><span class='comma'>,</span> <span class='id identifier rubyid_adapter_options'>adapter_options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_adapter'>adapter</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
<span class='id identifier rubyid_adapter'>adapter</span><span class='period'>.</span><span class='id identifier rubyid_as_json'>as_json</span>
<span class='id identifier rubyid_adapter'>adapter</span><span class='period'>.</span><span class='id identifier rubyid_serializable_hash'>serializable_hash</span>
</code></pre>
<p>The adapter formats the serializer&#39;s attributes and associations
(a.k.a. includes):</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_serializer_options'>serializer_options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_serializer'>serializer</span> <span class='op'>=</span> <span class='const'>SomeSerializer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='comma'>,</span> <span class='id identifier rubyid_serializer_options'>serializer_options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_attributes'>attributes</span>
<span class='id identifier rubyid_serializer'>serializer</span><span class='period'>.</span><span class='id identifier rubyid_associations'>associations</span>
</code></pre>
<p>See <a href="docs/ARCHITECTURE.md">ARCHITECTURE.md</a> for more
information.</p>
<h2 id="label-Contributing">Contributing</h2>
<p>See <a href="CONTRIBUTING.md">CONTRIBUTING.md</a></p>
<p>| Integration | Supported ActiveModelSerializers versions | Gem name and/or
link |—-|—–|—- | Ember.js | 0.9.x | <a
href="https://github.com/ember-data/active-model-adapter">active-model-adapter</a>
| Ember.js | 0.10.x + | <a
href="integrations/ember-and-json-api.md">docs/integrations/ember-and-json-api.md</a>
| Grape | 0.10.x + | <a
href="integrations/grape.md">docs/integrations/grape.md</a> | | Grape |
0.9.x | <a
href="https://github.com/jrhe/grape-active_model_serializers">github.com/jrhe/grape-active_model_serializers</a>/
| | Sinatra | 0.9.x | <a
href="https://github.com/SauloSilva/sinatra-active-model-serializers">github.com/SauloSilva/sinatra-active-model-serializers</a>/</p>
</div></div>
<div id="footer">
Generated on Wed Jun 15 10:31:22 2016 by
Generated on Wed Jun 15 10:39:25 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
file.STYLE.html
View File

@ -177,7 +177,7 @@ labels here</a>.</p>
</div></div>
<div id="footer">
Generated on Wed Jun 15 10:25:09 2016 by
Generated on Wed Jun 15 10:39:25 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

2
file.adapters.html
View File

@ -337,7 +337,7 @@ Adapter class on GitHub</a></p>
</div></div>
<div id="footer">
Generated on Wed Jun 15 10:31:23 2016 by
Generated on Wed Jun 15 10:39:25 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.2.4).
</div>

Some files were not shown because too many files have changed in this diff Show More