as_json_representations 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d489e6472aa1956629b9a73dfa7fe239e1ae9cd3d794f23a69085da4909bcead
-  data.tar.gz: a1eff31bbd91cc4ba2c04cc2518b5b4a2e90864fa20161230f21b4d4882fd0a0
+  metadata.gz: a2411f12b165485b579cf9650b2ee1de6d197daa4fdbea9ecd952b31b0c68a8f
+  data.tar.gz: 3c4e24fb9e8d229ee9177e605535cc8ab2bdd6a968b15d1e611f1abea1965821
 SHA512:
-  metadata.gz: e1c6f1861aecfac8d575788cc90acb4d313dc51e2f045968f26819741f0a5260c8366c5a734ff5f0697891218736f5a18eb28da2b8a532e95640aea1579555be
-  data.tar.gz: d7a542c0ddda417baad9977535c42160ebc8880a56d22491b11ad35b0cf708736450080ec34787cf3632b525b0300042819f1a93368c72228e46004b1de73f54
+  metadata.gz: ab50b7d16894eb166c95a833d433b8138380b9f5eb51ff01719d61a32b550e623e1801bcb413abee8e3c63accfeabc2fe616316199e9989b7c027b91f6cf4543
+  data.tar.gz: 294d76aaeb638dbe1fa55c04c89300a0c376c4af9739d19d72c7bd450562f08fac89efb85e7c798eeb773fae0a68dbefe70feb6b159fa94a42ba9fa8e3b9cb50

data/.gitignore

@@ -9,4 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history
 *.gem

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in as_json_representations.gemspec
 gemspec
+
+gem 'byebug'

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    as_json_representations (0.4.1)
+    as_json_representations (0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    byebug (11.0.1)
     diff-lcs (1.3)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -28,8 +29,9 @@ PLATFORMS
 DEPENDENCIES
   as_json_representations!
   bundler (~> 1.15)
-  rake (~> 10.0)
+  byebug
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.4
+   1.17.3

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/as_json_representations.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/as_json_representations.rb

@@ -1,22 +1,34 @@
 require 'as_json_representations/collection.rb'
 
 module AsJsonRepresentations
+  QUERY_METHODS = %i[includes eager_load preload].freeze
+
   module ClassMethods
     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]
+
+      QUERY_METHODS.each do |option|
+        next unless (extend_option_value = extend_representation[option])
+        @representations[name][option] = extend_option_value + (options[option] || [])
+      end
     end
 
     def representations
       @representations
     end
 
-    def parent
-      @parent
+    def parent_entity
+      @parent_entity
     end
 
     def find_representation(name)
-      representations[name] || @parent&.find_representation(name) if name
+      representations[name] || @parent_entity&.find_representation(name) if name
     end
 
     def render_representation(object, options)
@@ -32,7 +44,7 @@ module AsJsonRepresentations
 
         representation =
           if representation[:extend] == true
-            representation[:class].parent&.find_representation(representation[:name])
+            representation[:class].parent_entity&.find_representation(representation[:name])
           else
             find_representation(representation[:extend])
           end
@@ -51,7 +63,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 +73,13 @@ module AsJsonRepresentations
       end
 
       def self.included(base)
-        return unless base.class == Module
-        AsJsonRepresentations.send(:included, base)
-        base.instance_variable_set :@parent, 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

@@ -1,13 +1,33 @@
 module AsJsonRepresentations
   module Collection
-    def as_json(options={})
-      map do |item|
-        item.respond_to?(:as_json) ? item.as_json(options) : item
-      end
-    end
-
     def representation(name, options={})
       as_json(options.merge(representation: name))
     end
+
+    def self.included(base)
+      base.class_eval do
+        def as_json(options={})
+          subject = self
+
+          if respond_to?(:klass) && klass.respond_to?(:representations)
+            # call supported methods of ActiveRecord::QueryMethods
+            QUERY_METHODS.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
+          end
+
+          return super if respond_to? :super
+
+          subject.map do |item|
+            item.respond_to?(:as_json) ? item.as_json(options) : item
+          end
+        end
+      end
+    end
   end
 end

data/lib/as_json_representations/version.rb

@@ -1,3 +1,3 @@
 module AsJsonRepresentations
-  VERSION = '0.4.1'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: as_json_representations
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - rjurado01
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -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.1.2
 signing_key: 
 specification_version: 4
 summary: Creates representations of your model data