Commit Graph

51 Commits

Author SHA1 Message Date
Anson Hoyt
173f3f2a17 Explain how to include an attribute named "object" 2013-06-06 14:41:45 -04:00
Tee Parham
d10b5f6ac0 add ruby 1.8 install note [ci skip]
fixes #310
2013-05-30 15:25:06 -06:00
David Verhasselt
2cc598c74a Update README.md
Setting AMS::Serializer.root = false doesn't automatically disable root for the ArraySerializer.
2013-05-21 12:00:39 +03:00
David Verhasselt
1614ef3b12 Create new section 'Disabling root' in README 2013-05-14 11:30:22 +03:00
David Verhasselt
358b6a8875 Update README.md 2013-05-14 10:42:28 +03:00
David Verhasselt
5504293776 Update README.md
I'm a bit embarrassed to admit that it took me a while to figure out this was a possibility, so I figured maybe this change will save some other poor chaps their time and/or pride.
2013-05-13 18:23:20 +03:00
vanstee
6b6afb8a83 Bump minor version specified in Gemfile 2013-05-11 02:33:27 -04:00
Steve Klabnik
48e5ca29f1 Add Coveralls for code coverage. 2013-05-05 13:38:56 -07:00
Steve Klabnik
a0b07259ae Add CodeClimate badge. 2013-05-05 13:04:39 -07:00
Gosha Arinich
1482081766 add support of mongoid collection serialization 2013-05-05 21:50:34 +03:00
Silvio Relli
9ca71c2443 Update README.md
Fixed typo in documentation about the number of options to disable the root element for arrays
2013-05-02 16:27:06 +03:00
Tee Parham
6b0ceba148 fix travis links
The existing links work, but redirect.
2013-04-24 21:55:50 -06:00
Steve Klabnik
049cff57c2 Merge pull request #250 from gabetax/documentation/belongs_to
Document inclusion of belongs_to ActiveRecord associations
2013-03-23 05:43:28 -07:00
Gabe Martin-Dempesy
01d1228772 Document inclusion of belongs_to ActiveRecord associations 2013-03-23 00:48:00 -05:00
Michael Kaiser-Nyman
1fc314786e fix grammar in readme 2013-03-22 15:19:13 -07:00
beerlington
4a13f86961 Reference scope by same name as serialization scope
By default, the serialization scope uses current_user, and you can
now reference the scope as "current_user" in the serializer. If you
override the scope using "serialization_scope" in your controller,
it will use that method name instead.
2013-03-18 14:44:38 -04:00
Attila Domokos
5f9209e619 Fixing README.md 2013-03-13 20:53:20 -04:00
Paul McMahon
87509e9537 More clearly recommend to add to Gemfile 2013-03-10 17:48:34 +09:00
Steve Klabnik
e76a16486f Merge pull request #170 from FundingGates/master
Support optional types for computed attributes
2013-03-08 09:11:29 -08:00
Miloš Hadžić
befac17160 Update release version in README. 2013-03-06 17:40:41 +01:00
Jeremy Redburn
7cd7d295e0 Adding 'embed_key' option to allow embedding attributes other than ID 2013-03-05 18:52:31 -05:00
Steve Klabnik
585b1bc508 No longer recommend installation from git 2013-03-05 15:28:56 -08:00
Steve Klabnik
49cca10592 Merge pull request #172 from vladson/patch-1
Added description of default_serializer_options to README.md. Fixes #168
2013-03-05 14:46:06 -08:00
Paulo H. C. de Oliveira
e322f903cf Update README.md file to better describe scope.
This commit also corrects the code about deactivating globally the root name of arrays.
2013-03-05 13:37:11 -03:00
Kir Shatrov
dd989043e3 Gemfile improvement in README 2013-02-09 23:04:25 +02:00
Steve Klabnik
cef10cf01d Revert "Merge pull request #186 from gerfuls/master"
This reverts commit d030cd99cf, reversing
changes made to a1d5561eac.
2013-01-15 11:51:42 -05:00
Joshua Dover
016412b3d7 Fixed README typo 2013-01-12 19:18:08 -06:00
Steve Klabnik
a1d5561eac Merge pull request #185 from kevins90/update_readme_object_accessor
Revised one more instance in the doc referring to the object method alias
2013-01-11 10:10:05 -08:00
Kevin Tham
3cd953ffa8 Revised one more instance in the doc referring to the method alias to access the object being serialized 2013-01-11 10:01:37 -08:00
Enio Lopes
97e7ec1d32 Uses colon on :meta_key 2013-01-11 11:22:45 -02:00
Enio Lopes
244021d65c Corrects some markdown properties, identation and text 2013-01-11 11:06:26 -02:00
Enio Lopes
0994f3dda8 Adds documentation for usage of meta and meta_key options 2013-01-11 00:18:53 -02:00
Steve Klabnik
e4d244f865 Merge pull request #183 from kevins90/update_readme_associations
Update association section on README.md
2013-01-10 10:51:05 -08:00
Kevin Tham
1b6ccbbe7b Update association section on README.md to reflect deprecation of the prefix of the serializer class being used as the accessor to the object we wish to serialize. (reason was previously that the name of the object being serialized is not necessarily going to be the prefix of the serializer class and worse the prefix could have been an attribute of the object itself) 2013-01-10 10:02:38 -08:00
Vladislav
ccc9c2c696 Update README.md
Spelling and murkup mistakes fixed.
2013-01-06 13:31:35 +04:00
Dan Gebhardt
3b1d2faf51 Append an _id or _ids suffix to associations' keys. Embed objects in root according to their serializers' names.
An `_id` suffix will be appended to the name of HasOne associations, while `_ids` will be appended to the singularized name of HasMany associations. Association keys can still be overridden with the `key` option.

Furthermore, objects embedded in the root are now by default named according to their serializer, instead of the key used for their associations.
2012-12-21 15:14:50 -05:00
Jose Angel Cortinas
d0ab0ccc97 Take a stab at documenting AMS support.
Specifically when used in objects that are not ActiveRecord objects.
2012-12-17 17:17:32 -06:00
Vladislav
fde724e210 Added description of default_serializer_options
In example it's used to set up root: false for controller
2012-12-15 01:35:52 +04:00
Matt Rogish
72652ce37e Adding info to the readme on how to specify the type, adding an additional
test to cover a computed property without a type
2012-12-11 10:33:17 -05:00
Gabe Martin-Dempesy
0e02e79af8 Update documentation to use ActiveSupport.on_load to disable root 2012-11-30 13:47:09 -06:00
Francesco Rodriguez
d3b02ab8b3 update travis link [ci skip] 2012-11-20 20:37:23 -05:00
Alexandre de Oliveira
3fd7d6ae2f Fixes repo URL in the README's installation instructions
When the gem moved over to github.com/rails_api/, the README instructions
were still pointing to github.com/josevalim/.
2012-11-19 01:05:00 -02:00
Gary S. Weaver
9cd472c160 #133 making :serializer and :polymorphic documentation less verbose 2012-10-09 09:37:59 -04:00
Gary S. Weaver
257adfc80e #133 adding documentation for :serializer and :polymorphic options on associations 2012-10-08 17:17:14 -04:00
Jo Liss
afc3beef16 Merge pull request #122 from oriolgual/patch-1
Document how to embed ids or objects per association
2012-09-12 14:23:50 -07:00
Dan Gebhardt
7fc8606101 documentation of conditional include options for serializers 2012-08-29 10:54:56 -04:00
Oriol Gual
027f1580dc Document how to embed ids or objects per association 2012-08-27 11:51:16 +03:00
Ray Cohen
63465fda68 fix custom attributes with scope readme section 2012-07-28 13:01:06 -04:00
Tee Parham
6a37cfe219 fix typo in README 2012-07-23 14:07:49 -06:00
Tee Parham
663d443884 Merge branch 'array-serializer-root' of github.com:teeparham/active_model_serializers into readme-arrays 2012-07-23 13:02:04 -06:00