as_json_representations 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7303933b1ec6f554b43cb2c14c09325faf4cbd50935537da910d1a8069d6cfb6
-  data.tar.gz: d1420afac1861f0e044544bb9a48cebdd55ec77875e9487eb99175406a2cdad3
+  metadata.gz: daa006efc48883832cee9320fdd7c6f97857739664befca6e43a9926b7e32f87
+  data.tar.gz: aca509444daca9ce848074ddab33a5e7db143d5bc4aef381fb55e8c62f208fc5
 SHA512:
-  metadata.gz: e701364c44f827f43decab103fd106b00a30cb691c30fcfc1de2182b6e52c75f855c074118f1eedcdcf307ead5d0d4541f0730e4ee4208fcb29a2447cba47c43
-  data.tar.gz: f6c989bd434fc0c17f3ba6cbe23dec6d59c1ee58ae33589648854d0e8017ed65e890aa36e317cbdc47ca802c577ffb767194586c1e054c6d3922f031a8b3da01
+  metadata.gz: 171f411f75287d344bfc1372dbde7fdaf97384c149ca704ef948eff4330d23fbb91e2f15057a42f3184e783a767025da2de26aaa931e3e68c062a25dcdcd372c
+  data.tar.gz: 0257036af2c8696a39a11afe994523c178185c705a00bb448cbfd04125cd457701420c3c122cad7605ca14ddd6cc89f1039742e18f5176c3c22d51d962b94840

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    as_json_representations (0.4.3)
+    as_json_representations (0.5.0)
 
 GEM
   remote: https://rubygems.org/
@@ -32,4 +32,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.4
+   1.17.2

data/README.md

@@ -4,6 +4,18 @@
 
 Creates representations of your model data in a simple and clean way.
 
+## Features
+
+* Easy to use
+* Easy to define representations
+* Support representations hinheritance
+* Support module definition
+* Support options
+* Support ActiveRecord collection options
+* Faster
+
+The performance of this gem is up to **7x higher** than other for a simple class instance serialization: [test](https://github.com/rjurado01/as_json_representations_benchmarks)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -138,6 +150,23 @@ When you includes representation module (parent) into other module (child):
 * You can extend parent representations
 * You must use `extend: true` when use the same name
 
+## ActiveRecord collection options
+
+You can use this ActiveRecord option when you define a representation:
+
+* [includes](https://apidock.com/rails/ActiveRecord/QueryMethods/includes)
+
+```
+representation :private, includes: [:city]
+  {
+    age: age,
+    city: city.as_json(representation: :basic)
+  }
+end
+```
+
+This options will be used on the collection before to serializing it automatically.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/as_json_representations.rb

@@ -5,6 +5,16 @@ module AsJsonRepresentations
     def representation(name, options={}, &block)
       @representations ||= {}
       @representations[name] = options.merge(name: name, class: self, block: block)
+
+      # copy parent representation options that should be inherited
+      return unless options[:extend]
+      extend_representation_name = options[:extend] == true ? name : options[:extend]
+      extend_representation = (parent_entity || self).representations[extend_representation_name]
+
+      %i[includes eager_load].each do |option|
+        next unless (extend_option_value = extend_representation[option])
+        @representations[name][option] = extend_option_value + (options[option] || [])
+      end
     end
 
     def representations
@@ -51,7 +61,7 @@ module AsJsonRepresentations
           if !options[:representation] && defined?(super)
             super(options)
           else
-            #{base}.render_representation(self, options)
+            #{base}.render_representation(self, options.dup)
           end
         end
       }
@@ -61,9 +71,13 @@ module AsJsonRepresentations
       end
 
       def self.included(base)
-        return unless base.class == Module
-        AsJsonRepresentations.send(:included, base)
-        base.instance_variable_set :@parent_entity, self
+        if base.class == Module
+          AsJsonRepresentations.send(:included, base)
+          base.instance_variable_set :@parent_entity, self
+        else
+          context = self
+          base.define_singleton_method(:representations) { context.representations }
+        end
       end
     end
   end

data/lib/as_json_representations/collection.rb

@@ -5,11 +5,23 @@ module AsJsonRepresentations
     end
 
     def self.included(base)
-      return if base.respond_to? :as_json
-
       base.class_eval do
         def as_json(options={})
-          map do |item|
+          subject = self
+
+          # call supported methods of ActiveRecord::QueryMethods
+          %i[includes eager_load].each do |method|
+            next unless respond_to? method
+
+            args = klass.representations.dig(options[:representation], method)
+
+            # we need to reassign because ActiveRecord returns new object
+            subject = subject.public_send(method, args) if args
+          end
+
+          return super if respond_to? :super
+
+          subject.map do |item|
             item.respond_to?(:as_json) ? item.as_json(options) : item
           end
         end

data/lib/as_json_representations/version.rb

@@ -1,3 +1,3 @@
 module AsJsonRepresentations
-  VERSION = '0.4.3'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: as_json_representations
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - rjurado01
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2019-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Creates representations of your model data