adequate_serializer 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fec099288058f8a38ccdd3fdccfe9ce2c2d67c1
-  data.tar.gz: d4177cde980e80c2b7adfe7b8c7a0c5f52b538cb
+  metadata.gz: 75d51f7e119da79d4844eaf7588c35f5822f1d3a
+  data.tar.gz: 5f287e45995db1e14a3cba9224c30696037005a5
 SHA512:
-  metadata.gz: ef07a512dc0006b231d6d8f512b2c1423ea7d0eb9ff1a948aa3ba25bf5cc276e6dfc91018e47e9ef07f572541b64a36b6eb3db87c5f36118c4cdc92fac8a8c22
-  data.tar.gz: 79eca37e71344bccda080dac51425395d612a576c9e5cdc11943c3be836cbcf2684b697a7dca8c8c7239a21c6fb3ec7a4c36b49e8fa4241a79fdcaff87193829
+  metadata.gz: 64b355e2ca1f0f92e0e7db1d321e8a98fbd15cd010c01616b05ccb5ef8d9da4341945710f95b6907b76c4eaf8805247458d15e5e41982f7a4fcef5803a8b031e
+  data.tar.gz: a9c19e14e8ba3672d61b6e1311bc3ffe7ec1290d9e675d916b22a9acda90c9a258c5451879cc4057792fc4d2e541c9219b68df6beedd13f7eea6757fa4a16eab

data/README.md

@@ -97,17 +97,32 @@ Within a serializer's methods, you can access the object being serialized as
 
 ### Associations
 
-If you want to include associations, just specify them in the controller.
+Associations that always have to be included can be specified in the
+serializer:
+
+```ruby
+class UserSerializer::Base
+  attributes :id, :created_at, :updated_at
+  associations :posts, :comments
+end
+```
+
+If the association only needs to be included for certain endpoints, it can be
+specified in the controller:
 
 ```ruby
 serialize(@user, includes: :posts)
 ```
 
-In this case the PostSerializer will be used to nest the user's posts under the
-`posts` key in the user JSON object.
+The PostSerializer will be used to nest the user's posts under the
+`posts` key in the user JSON object in both cases.
+
+You can also include multiple associations or even nest them by using the
+`includes` syntax.
 
-You can also include multiple associations by using an array of association
-keys.
+```ruby
+serialize(@user, includes: [:posts, comments: :user])
+```
 
 #### Overriding association methods
 
@@ -116,6 +131,7 @@ If you want to override any association, you can use:
 ```ruby
 class UserSerializer::Base
   attributes :id, :created_at, :updated_at
+  associations :posts
 
   def posts
     object.posts.published

data/lib/adequate_serializer/base.rb

@@ -6,18 +6,26 @@ module AdequateSerializer
     include Helper
 
     class << self
+      attr_accessor :_associations
       attr_accessor :_attributes
     end
 
     def self.inherited(base)
+      base._associations = (_associations || []).dup
       base._attributes = (_attributes || []).dup
     end
 
-    def self.attributes(*attrs)
-      attrs.each do |attr|
-        @_attributes << attr
+    def self.attributes(*attributes)
+      attributes.each do |attribute|
+        @_attributes << attribute
 
-        define_method_for(attr)
+        define_method_for(attribute)
+      end
+    end
+
+    def self.associations(*associations)
+      associations.each do |association|
+        @_associations << association
       end
     end
 
@@ -48,13 +56,7 @@ module AdequateSerializer
     end
 
     def associations
-      return {} if includes.nil?
-
-      if includes.respond_to?(:each)
-        serialize_multiple_associations(includes)
-      else
-        { includes => serialize_association(includes) }
-      end
+      serialize_multiple_associations(normalized_associations)
     end
 
     private
@@ -74,15 +76,30 @@ module AdequateSerializer
       name.to_sym
     end
 
-    def serialize_multiple_associations(association_keys)
-      association_keys.each_with_object({}) do |key, hash|
-        hash[key] = serialize_association(key)
+    def normalized_associations
+      all_associations = Array(includes) | self.class._associations
+
+      all_associations.each_with_object({}) do |(key, value), hash|
+        if key.is_a?(Hash)
+          hash.merge!(key)
+        else
+          hash[key] ||= value
+        end
+      end
+    end
+
+    def serialize_multiple_associations(associations)
+      associations.each_with_object({}) do |(key, includes), hash|
+        hash[key] = serialize_association(key, includes)
       end
     end
 
-    def serialize_association(association_key)
+    def serialize_association(association_key, includes)
       associated_objects = associated_objects(association_key)
-      serialize(associated_objects, root: false)
+
+      unless associated_objects.nil?
+        serialize(associated_objects, root: false, includes: includes)
+      end
     end
 
     def associated_objects(association_key)

data/lib/adequate_serializer/version.rb

@@ -1,3 +1,3 @@
 module AdequateSerializer
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adequate_serializer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Bastian Bartmann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-24 00:00:00.000000000 Z
+date: 2015-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport