ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-23 06:16:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
776 Commits 15 Branches 40 Tags 5 MiB
eaedcefa4e
Commit Graph

284 Commits

Author SHA1 Message Date
twinturbo
e923174a26 #cache_key delegates to #object by default 2013-03-14 22:40:06 +01:00
twinturbo
b4395f281b Add basic caching 2013-03-14 22:40:06 +01:00
Michael Rykov
37b0690fb8 Add a Responder to handle respond_with(resource) 2013-03-13 16:45:23 -07:00
Steve Klabnik
f4916f113f Merge pull request #223 from tchak/id-serialization-with-hooks 
use `read_attribute_for_serialization` to serialize ids
 2013-03-08 09:17:19 -08: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
tchak
e2c10f4440 use read_attribute_for_serialization to serialize ids 
* in order to allow some optimisation in simple cases, we call `read_attribute_for_serialization` on parent with association_id name
 2013-03-08 09:57:42 +01:00
Adam Stanton
da26ebd26f Merge branch 'create-default-serializer' into HEAD 
Conflicts:
	lib/active_model/array_serializer.rb
 2013-03-05 21:48:58 -08:00
Steve Klabnik
dc2257977f Merge pull request #198 from jredburn/master 
'embed_key' option to allow embedding by attributes other than IDs
 2013-03-05 15:57:34 -08:00
Steve Klabnik
06c65871a8 Merge pull request #213 from michihuber/fix_rendering_nil_with_custom_serializer 
Fix rendering nil with custom serializer
 2013-03-05 15:54:51 -08: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
d638e21c8c Merge pull request #180 from fellix/fix-remove-root-globally 
Fix global ``` self.root = false ```
 2013-03-05 15:48:08 -08:00
Steve Klabnik
95937c6fc7 Merge pull request #167 from GateGuru/feature/specify-association-serializers-as-strings 
Add support for specifying the serializer for an association as a String...
 2013-03-05 15:04:29 -08:00
Ismael Abreu
2d2094b588 changes to be able to specify multiple attributes with keys 2013-03-05 02:45:22 +00:00
Michi Huber
c7a420d295 Don't fail if object is nil, render null 2013-02-26 11:17:28 +01:00
Michi Huber
58a063eff0 serialization test: respect root settings when root object is nil 2013-02-26 11:12:28 +01:00
Adam Stanton
b4616d737c Restore order of fields in hash to original order. 2013-02-11 07:04:59 -08:00
Adam Stanton
c4fcf96eb4 Move DefaultSerializer from array_serializer.rb to serializer.rb 2013-02-10 09:49:11 -08:00
Adam Stanton
8f6218c587 Create DefaultSerializer so that as_json uses same interface. 
This is to ensure that PORO's as_json is called if no serializer
is specified.

Original behaviour was that serializable_hash was being called,
overriding the as_json method.
 2013-02-10 09:06:24 -08:00
Lee Mallabone
d35999a7ee Add failing test to show behavior of custom serializer with nils. 2013-02-06 17:32:15 -08:00
Rafael Felix
82951c1f8a Fix global `` self.root = false `` 
Using the on_load hook does not change the defined root on
Serializer#inherited.

Related to #179
 2013-01-24 09:13:41 -02:00
Blake Watters
b0aced9ea2 Add support for specifying the serializer for an association as a String. 
This enables the deferral of the resolution of the serializer class to prevent NameError exceptions due to reference cycles between serializer classes.
 2013-01-05 23:49:28 -05:00
Steve Klabnik
e3bfd07ac4 Merge pull request #161 from kevins90/fix_attr_name_as_serializer_underscored_prefix 
Fix serialization of attribute whose name matches the serializer prefix underscored
 2013-01-05 14:09:15 -08: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
Jérémy Lecour
c68a18630b Test : use a deducted serializer on non-ActiveRecord models 2012-12-20 17:06:19 +01: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
Matt Rogish
25c564bd6f Adding optional type for attributes 2012-12-10 19:58:58 -05:00
Steve Klabnik
6780cd3df5 Merge pull request #138 from tchak/meta 
Meta object
 2012-12-10 10:48:39 -08:00
Godfrey Chan
6581f8ce41 Fix default_serializer_options, closes #112 & #113 
Allow options such as :serializer, :scope, :root etc to be set via
default_serializer_options and allow the inline options to override such
defaults.
 2012-12-03 03:09:58 -08:00
Francesco Rodriguez
6be6599bb7 Fix failing tests on Rails master 2012-11-25 14:56:58 -05:00
Kevin Tham
14a35ab2f8 Remove unneeded method aliasing of attribute reader: object, with the underscored class name of serializer, to fix issue where a model's attribute name matches that of the underscored prefix of the serializer 2012-11-25 00:17:17 -08:00
Jean Boussier
06e8218193 Throw a descriptive error if attempting to serialize an array with Serializer not ArraySerializer #143 2012-11-22 23:27:18 -05:00
Jo Liss
2fc083a1fe Merge pull request #117 from joliss/computed-attributes 
Make schema not crash on computed attributes & associations
 2012-11-22 08:31:18 -08:00
tchak
a71698d5bb Add support for meta key 
Test for meta_key serialization
 2012-11-22 13:44:59 +01:00
Tee Parham
2cb7a41780 move ArraySerializer tests into separate file 2012-11-20 10:58:16 -07:00
Tee Parham
f47a10cadc move test fakes to separate file 2012-11-20 10:44:23 -07:00
Samnang Chhun
96ce310595 Add alias_method ActiveModel::Serializer.root= to be consistency with ActiveModel::ArraySerializer 2012-11-20 00:29:00 +07:00
Jo Liss
538b0c0916 Make schema not crash on computed associations 
We pick nil here as well.
 2012-10-31 20:07:08 +01:00
Jo Liss
6281a9149e Make schema not crash on computed attributes 
We do not know the type for computed attributes, so we pick nil.

Perhaps at some point we might add a :type option for attributes (or
not), but in any case it's important to not crash when there are
computed attributes.
 2012-10-31 20:07:08 +01:00
Jo Liss
ee3cec3d0c When objects are sideloaded multiple times, serialize them only once 
To achieve this, we make the following change when sideloading: Instead
of serializing associations and discarding duplicate *hashes*, we
memorize the *objects* (records) that we have already serialized, and
only serialize those that are new.

This change is mostly transparent, and brings down serialization time
from 3.1 seconds to 1.0 seconds on my set of sample data.

There is one change in the behavior: If you sideload the same object
multiple times, and it yields different hashes, like so:

    embed :ids, include: true
    has_many :comments
    has_many :recent_comments, root: comments, serializer: CommentShortSerializer

then previously, it would be included multiple times, whereas now, the
first hash wins. (I haven't actually tested this.) I don't know that
either option is preferable. It's not covered by the test suite, and I
think it's an edge case that is OK to ignore entirely.
 2012-10-29 23:15:32 +01:00
Jo Liss
28ee88ca9a In the test, use the same :hash across serializers 
Otherwise, `include!` will not remember the unique_values of
already-sideloaded hashes across serializer calls.
 2012-10-29 22:48:51 +01:00
José Valim
be70c5c846 Revert "clean up lazy loading of serialization support for 
ActiveRecord::Base and ActionController::Base"

The whole idea of having a lazy hook is that it can be executed
in the context of different targets. The moment you hardcode the class,
the hooks can no longer run in the proper context.

This reverts commit 506e2ac9ad.
 2012-10-17 19:28:02 +02:00
Jo Liss
3c5e58bf13 Merge pull request #129 from dgeb/active-record-init 
clean up lazy loading of serialization support
 2012-09-21 11:34:30 -07:00
Jo Liss
0a5d3eb953 Fix assertion for Ruby 1.8.7 2012-09-21 16:57:51 +02:00
Jo Liss
646d57c438 Make test suite compatible with Rails 4 
Rails 4 changes the JSONP content_type to text/javascript
 2012-09-21 16:36:42 +02:00
Dan Gebhardt
281b45ad2a match method should not be used for routes; instead, a specific HTTP method should be used 2012-09-20 21:17:07 -04:00
Dan Gebhardt
506e2ac9ad clean up lazy loading of serialization support for ActiveRecord::Base and ActionController::Base 2012-09-20 14:23:59 -04:00
Dan Gebhardt
42221a6140 define include_XXX? methods, which can be overridden to conditionally include attributes and associations 2012-08-29 09:26:41 -04:00
Dan Gebhardt
68dc57eb73 simplified the API for include_associations!() to make conditional includes cleaner 2012-08-29 07:42:23 -04:00
twinturbo
38859d1f3d Easier to work with polymorphic interface 2012-08-25 17:39:39 +02:00
Alex Kwiatkowski & Will Bagby
754aa295ba Return empty hash when url_options not provided 2012-08-07 12:56:58 -04:00
Ray Cohen
424dacb457 scope option to render takes precedence over serialization_scope 2012-07-28 21:06:15 -04:00
Ray Cohen
1e7c69c729 Test for having scope option to render override the controller's serialization scope 2012-07-28 19:05:45 -04:00
José Valim
b813646076 assert_include is not available before 1.9 2012-07-21 10:01:27 +02:00
José Valim
e886f597c7 Sets are not ordered, do not depend on the order 2012-07-21 09:48:12 +02:00
José Valim
ef7d475912 Merge pull request #94 from teeparham/array-serializer-root 
Add root option to ArraySerializer
 2012-07-21 00:38:18 -07:00
José Valim
62484e758c Merge pull request #95 from twinturbo/set-serializer 
Close #90
 2012-07-21 00:37:31 -07:00
twinturbo
6f3b250dc9 Don't include empty polymoprhic associations 
Take this serializer:

class TodoSerializer < ActiveModel::Serializer
  root :todo, :include => true
  has_one :reference, :polymorphic => true
end

A nil reference would generate this JSON:

{
  "todo": { "reference": null },
  "nil_classes": []
}

This commit prevents the `nil_classes` key from being added when
serializing and including nil polymoprhic associations.
 2012-07-16 15:08:01 +02:00
twinturbo
486d282922 Raise error when associations cannot be included 
include! only works when the source serializer has a root set. The
as_json method sets up some state for the include! method. If a child
association has associations with `:include => true` or `root foo,
:include => true` would cause an undefined method error for `NilClass`.
This is entirely unhelpful for the end user.

This commit raise an error when this situation occurs. It makes it clear
that it's not a problem with AMS but the serialization graph.
 2012-07-16 14:18:58 +02:00
twinturbo
5111615ac1 Actually test set serialization 2012-07-15 13:42:29 +02:00
Bradley Priest
f85c624d02 Fix travis 2012-07-15 18:50:47 +08:00
twinturbo
7072e79787 Close #90 2012-07-15 12:18:41 +02:00
twinturbo
cbd7d7d385 Add test for nested included polymoprhic associations 2012-07-15 11:49:36 +02:00
twinturbo
c4e5cd547b Add test for complex polymorphic associations 2012-07-15 11:49:36 +02:00
twinturbo
9f20fe8b36 Test passes 2012-07-15 11:49:36 +02:00
twinturbo
3ca1621011 Add failing test for polymorphic with include 2012-07-15 11:49:36 +02:00
twinturbo
7e96856b87 Support serialize polymorphic id 2012-07-15 11:49:36 +02:00
twinturbo
32f8779114 Basic rooted polymorphism 2012-07-15 11:49:36 +02:00
Tee Parham
84c7cfa988 fix test for custom serializer, add test for :each_serializer 2012-07-14 22:03:14 -06:00
Tee Parham
0832e42917 add class attribute :root to ArraySerializer 
You can now set the default behavior for Array serialization in a
single place
 2012-07-14 21:44:23 -06:00
José Valim
56824f055b Update master 2012-07-14 18:17:36 +03:00
twinturbo
7936e3efba Add "scope" method 2012-07-14 14:54:23 +02:00
José Valim
3e87c6414d Merge pull request #92 from twinturbo/query-attributes 
Close #86
 2012-07-14 04:16:07 -07:00
twinturbo
2b9cd97436 Close #86 2012-07-14 13:12:26 +02:00
José Valim
d6a68ed14f Merge pull request #85 from pushcx/master 
Allow setting :each_serializer in 'render :json' calls
 2012-07-14 04:05:40 -07:00
Bradley Priest
7eb2b90b7c Automatically include ArraySerializer in ActiveRecord::Relation 
fixes #81
 2012-07-10 10:17:54 +08:00
Peter Harkins
1c820a9ba7 Allow setting the serializer for ArraySerializer. 2012-06-21 11:12:13 -05:00
Tee Parham
c898e3daf9 remove unncessary is_a?(Hash) check 2012-06-12 10:38:32 -07:00
Andy Lindeman
47850677e9 Allows serialization_scope to be disabled with serialization_scope nil 2012-06-05 12:37:09 -04:00
Yehuda Katz
7afac9cd5c Fix the tests 2012-06-05 10:18:05 +02:00
Yehuda Katz
6e2554d741 Merge pull request #62 from highgroove/cleanup_scope_instance_variables 
Remove left over references to scope instance variable
 2012-06-05 00:32:23 -07:00
Yehuda Katz
3cb74887df Merge pull request #65 from teeparham/array-root 
use :root option in render :json
 2012-06-05 00:31:13 -07:00
Tee Parham
f35a2261d2 support different serializations in ArraySerializer 
ArraySerializer can serialize arrays of Hash, ActiveModel::Serializer,
or any PORO that responds to :as_json

Each item in the array should not include its type as a root element,
since normal arrays do not do this. If you want "typed" collections,
don't use an Array.
 2012-05-30 14:52:52 -06:00
Tee Parham
00db4dd6db rename test methods so tests run 
incidentally test_array_serializer_with_root fails
 2012-05-30 11:14:49 -06:00
Tee Parham
9962069ae9 delete identical test 2012-05-30 10:55:35 -06:00
Tee Parham
dd00e218b1 use :root option in render :json 
ArraySerializer can now render arrays with no root
 2012-05-18 12:45:43 -06:00
José Valim
5beecd5947 Fix the build on 1.8.7 :trollface: 2012-05-17 19:28:15 +02:00
José Valim
37d894f94e Fix build the correct way, ensure new apps work, closes #63 2012-05-17 19:18:01 +02:00
vanstee
81fddb55d3 Remove left over references to scope instance variable 2012-05-16 22:54:26 -04:00
Yehuda Katz
56b61b1532 Add URL to serializers (closes #61) 
Thanks so much to @vanstee for the initial
implementation!
 2012-05-16 18:35:30 -07:00
Yehuda Katz
5f4f6a3483 Merged on_load 2012-05-16 18:17:21 -07:00
Yehuda Katz
0f1ec7a3cf Add support for customizing fields 2012-05-16 18:13:59 -07:00
James A. Rosen
4c17a22207 add ActiveSupport.on_load announcement 2012-05-16 15:31:32 -07:00
tomhuda
33d4842dcd Prep for 0.5.0 2012-05-16 14:17:10 -07:00
ctide
f17e4cde39 Add a :root option to associations, which enables you to define what the root level key will be for the associated objects. 2012-02-22 19:35:10 -08:00
Carl Lerche
4e8a2af1ec Allow passing in the serializer class from the render method 2012-01-20 12:17:37 -08:00
Yehuda Katz
55647286da Make it possible to supply default serializer 
options in a controller.
 2012-01-11 21:30:10 -07:00
Yehuda Katz
671fc14888 remove scope as a separate concept and pass it in 
as an option.
 2012-01-11 21:16:02 -07:00
Yehuda Katz
4ad9c64e46 Allow serializers to receive instructions to 
explicitly include or exclude specific lists of
associations.
 2012-01-11 20:56:36 -07:00
Yehuda Katz
cb316b00f7 Write more tests 2012-01-11 20:28:07 -07:00
Yehuda Katz
2bae9363c7 Test custom embed options per association 2012-01-11 20:21:29 -07:00
Yehuda Katz
d2c88c9dd2 Clean up pending tests 2012-01-11 20:09:28 -07:00
Yehuda Katz
d42634a1d2 Remove dead code. 2012-01-11 15:54:41 -07:00
Yehuda Katz
b22eebf569 More refactoring: 
* Changed associations to be classes
* remove @hash and always use @options[:hash]
* pass serializer options down to child serializers
 2012-01-11 15:28:49 -07:00
Yehuda Katz
89103f1e74 Test that has_one works. 2012-01-11 13:07:43 -07:00
Yehuda Katz
72b8213bee If an existing association exists, use it to 
get the value if none was provided.
 2012-01-11 13:06:19 -07:00
Yehuda Katz
dd0b56c748 HasOne associations work 2012-01-11 12:26:49 -07:00
Yehuda Katz
f9d0259340 Start cleaning up serializers to support 
include/exclude functionality.

This process involves building a few lower-level
primitives so not as much logic is hardcoded in
monolithic helper methods.
 2012-01-11 12:18:18 -07:00
Yehuda Katz
ab1a4074ba Revert polymorphism 2012-01-11 11:13:32 -07:00
Yehuda Katz
a8760fa854 Add pry 2012-01-10 15:16:00 -07:00
Yehuda Katz
4965558d27 with ember :ids, :include => true, has_one 
associations should include plural versions at
the root, not singular ones.
 2012-01-10 15:16:00 -07:00
José Valim
1470e3a3f4 Merge pull request #24 from Adman65/polymorphic-associations 
Polymorphic associations
 2012-01-03 03:40:56 -08:00
adman65
09bb41fbdb Add test cases for nil polymorphic associations 2012-01-03 13:37:39 +02:00
Yehuda Katz
87d2d77ac8 In a controller, the current controller name should be the default root for collections 2012-01-01 16:01:59 -08:00
Yehuda Katz
e23553be23 The Array serializer should not make a child root for every item in the Array 2011-12-29 18:13:25 -08:00
adman65
da0c33f53c Improve polymorphic associations 2011-12-21 20:25:40 +02:00
José Valim
b9d56a5168 Fix constant lookup when serializer is not available. 2011-12-21 09:11:04 +01:00
José Valim
cc5f102e2d Remove implicit constant lookup in serializers in favor active_model_serializer API. 2011-12-21 08:48:29 +01:00
José Valim
97ff4d28e6 Allow as_json(true) to be given. 2011-12-21 08:17:22 +01:00
adman65
c8c8246e24 Pull in upstream 2011-12-21 00:00:09 +02:00
Yehuda Katz
df9ad0ef11 Improve serializers: 
* Many nested levels of associations can now insert
  their information alongside the original when
  embed :ids, :include => true is true
* Add support for passing options to serializers
* Fix Array serializers so they don't try to insert
  roots for each child object and so they can be
  provided a root.
* TODO: Array serializers should require a root
* TODO: Make merging associations at the root more
  efficient if possible
 2011-12-20 00:03:29 -08:00
Yehuda Katz
8bdb7da272 Fix compatibility mistakes with ActiveRecord 2011-12-19 23:07:55 -08:00
Adman65
1e32090477 Serialize polymorphic id like a composite FK 2011-12-12 14:41:34 +01:00
Adman65
638614ffde Move polymorphic type into the serializable_hash 2011-12-12 14:33:18 +01:00
Adman65
9fa716e452 Fixes #12 2011-12-12 13:13:38 +01:00
Adman65
2c240cf2e0 Implicit detection for has_many serializer 2011-12-09 16:16:09 +01:00
Yehuda Katz
09ddc79ce0 Better tests for embeds 2011-12-07 15:12:56 -08:00
Yehuda Katz
57ef67dcb4 Allow attribute aliasing 2011-12-07 14:35:07 -08:00
Yehuda Katz
7dd3bdaca9 We can't just piggyback on serialization because it may already be included at this point. 2011-12-07 12:25:11 -08:00
Yehuda Katz
ca7786c2e0 Rename :as to :key, as it's confusing 2011-12-07 12:16:22 -08:00
Yehuda Katz
0f4b61fbcf Provide a schema for a serializer 2011-12-07 11:56:27 -08:00
Adman65
498c780a8f Closes #4 2011-12-06 15:52:28 +02:00
Adman65
73ecb94d24 Remove railtie 2011-12-02 00:27:20 +02:00
Adman65
fffce85c5d Remove Rails dependency 
Move configuration into a Railtie.
Only dependency is now activemodel
 2011-12-01 19:10:56 +02:00
José Valim
5a230e8e66 Added tests. 2011-12-01 08:19:14 +01:00