fields-serializer 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 968cff087294a5ca3abe9dba8156639eb2a60c7a
-  data.tar.gz: 32764dc22f65232dce5c1bfba8940b968e49245f
+  metadata.gz: a4eb7b537453470e5785c408759a7cefd465931b
+  data.tar.gz: 6aeab9610fdc44c06d6555f7a2a2f32d0ad3f7ba
 SHA512:
-  metadata.gz: 46e56499debd139d9292746fac8e46ecc112a73a5f61811cbd1acbe31ab95e3cf437c2d4aad3a2ba7c1a52674c5c619d62ac66cfee2319ddf1c49d3f12e1e783
-  data.tar.gz: 7e0709ed97e68ccadf161a2329bdf6580b70b78fd5c76256814bf44901e1f969c39a7feb21cfeb92c98124780b76afe465aff2fb73498038f23636a9049dd872
+  metadata.gz: 11d02a736631a8580b55a550718a70315354f48a68a3afa742db813145da57e179c62a376d6ea53095e8b8829437cd580d03e93f7386e42c96cebd48852d4b53
+  data.tar.gz: 04c6ea5ce89247bb960c760f1efff1eb4713f719ef2dd53f629571bc4a1e26663cd640afe07a769659a8b285017e81ce4b26fed0ae4231496311456f82a5cff1

data/lib/fields/serializer/fields_tree.rb

@@ -4,6 +4,7 @@ require "active_model_serializers"
 module Fields
   module Serializer
 
+    # A class to store a tree structure of a model klass, its attributes and associations.
     class FieldsTree
       attr_reader :klass, :fields, :associations
 
@@ -17,6 +18,14 @@ module Fields
         self if fields.present? || associations.present?
       end
       
+      # Adds a new field (json api notation) to the tree structure:
+      #
+      #   user_tree.notation
+      #     #=> [:name, :surname, { subjects: [:title, { posts: { comments: :count } }], followers: :nickname }]
+      #
+      #   user_tree.merge!("subjects.posts.date").notation
+      #     #=> [:name, :surname, { subjects: [:title, { posts: [{ comments: :count }, :date] }], followers: :nickname }]
+      #
       def merge!(join_field)
         return self unless join_field.present?
         parent, rest = join_field.to_s.split(".", 2)
@@ -28,6 +37,11 @@ module Fields
         self
       end
       
+      # Return the tree structure in Rails includes notation including both associations and fields
+      #
+      #   user_tree.notation
+      #     #=> [:name, :surname, { subjects: [:title, { posts: :comments }], followers: :nickname }]
+      #
       def notation
         if fields.present?
           if associations.present?
@@ -39,7 +53,12 @@ module Fields
           associations_to_notation.presence
         end
       end
-      
+
+      # Return the tree structure in Rails includes notation including only associations
+      #
+      #   user_tree.notation
+      #     #=> [{ subjects: { posts: :comments }}, :followers]
+      #
       def to_includes
         to_includes = associations.inject([]) do |result, (k, v)|
           v_includes = v.to_includes

data/lib/fields/serializer/version.rb

@@ -1,5 +1,5 @@
 module Fields
   module Serializer
-    VERSION = "0.6.1"
+    VERSION = "0.6.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fields-serializer
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Stuart Chinery