as_json_representations 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8538dc805ef2b3830ae49cb42803e1ca8cfc18fd2baf5149a1c8c2d5ee804a84
-  data.tar.gz: 0f8fe6df1adda47ff911753e502a830d096f698f00454369393afb149bb6eb29
+  metadata.gz: c281672043920d58c37a13f7d482d4cf28eed8cb1f76f6cdbe96c477715cebae
+  data.tar.gz: 1f8e071bd25a5206e738957fc7314ed0db9ed9708c72bee400cbd8bfcaf6e7e5
 SHA512:
-  metadata.gz: 3bf53d9de42ac55e154b462b37b032e808fcc9c42be55a2faaa2609679226c9b33306fc04e86e72e5c0e2f1be6d0e02e9d6e4cdf12f26fd5a08ebbce98053064
-  data.tar.gz: a718f409c924edd9e22fef11cc5b674f2d7957c38ae35c51e3d9ffe8452547cf13a6b3e222041ca647d56ea2e4c91ec6a1d2fd638930e0185179fed46acecc4d
+  metadata.gz: 0043c6b6ff892e063b7cb74ca7cb567d760ce034e48a7f198b5afa60afa379506c591963c8c4a83176fe45cbfd413fd2e4b4e30d198f2e77c330e6ea0566a2ca
+  data.tar.gz: 82b77be08e2b719af905fd33c90ff43954c32ca2705fc0ca02b670033a2d44c9f4d1036f1ed2836945cd02d06e8a69fef3685ce0679d74498c6be7e6a988d2ee

data/Gemfile.lock

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

data/README.md

@@ -84,6 +84,60 @@ user.representation(:private, date: '2017-12-21') # short form
 # {:full_name=>"John Doe", :date=>"2017-12-21", :age=>30, :city=>{:name=>"Madrid"}}
 ```
 
+## Modules Inheritance
+
+You can include a module representation into other module like this example:
+
+```ruby
+module ParentRepresentations
+  include AsJsonRepresentations
+
+  representation :a do {name: name} end
+  representation :b do {name: name} end
+  representation :c do {name: name} end
+end
+
+module ChildRepresentations
+  include ParentRepresentations
+
+  representation :a do # overwrite
+    {color: color}
+  end
+
+  representation :b, extend: true do # extend parent representation with same name
+    {color: color}
+  end
+
+  representation :d, extend: :c do # extend parent representation
+    {color: color}
+  end
+end
+
+class Child
+  include ChildRepresentations
+
+  attr_accessor :color
+
+  def initialize(name, color)
+    @name = name
+    @color = color
+  end
+end
+
+child = Child.new('child', 'red')
+child.as_json(representation: :a) # {color: 'red'}
+child.as_json(representation: :b) # {name: 'child', color: 'red'}
+child.as_json(representation: :c) # {name: 'child'}
+child.as_json(representation: :d) # {name: 'child', color: 'red'}
+```
+
+When you includes representation module (parent) into other module (child):
+
+* Parent representations are included
+* If a representation is redefined, it is overwritten
+* You can extend parent representations
+* You must use `extend: true` when use the same name
+
 ## 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

@@ -1,28 +1,37 @@
+require 'as_json_representations/collection.rb'
+
 module AsJsonRepresentations
   module ClassMethods
     def representation(name, options={}, &block)
       @representations ||= {}
-      @representations[name] = options.merge(block: block)
+      @representations[name] = options.merge(name: name, block: block)
     end
 
     def representations
       @representations
     end
 
-    def render_representation(object, options)
-      name_representation = options.delete(:representation)&.to_sym
-      return {} unless (representation = representations[name_representation])
+    def find_representation(name)
+      representations[name] || @parent&.find_representation(name) if name
+    end
 
-      data = object.instance_exec(options, &representation[:block])
+    def render_representation(object, options)
+      representation_name = options.delete(:representation)&.to_sym
+      return {} unless (representation = find_representation(representation_name))
 
-      while representation[:extend] && (representation = representations[representation[:extend]])
+      data = {}
+      loop do
         data = object.instance_exec(
           options,
           &representation[:block]
         ).merge(data)
-      end
 
-      data
+        representation = [representation[:name], true].include?(representation[:extend]) ?
+          @parent.find_representation(representation[:name]) :
+          find_representation(representation[:extend])
+
+        return data unless representation
+      end
     end
   end
 
@@ -43,6 +52,22 @@ module AsJsonRepresentations
       def representation(name, options={})
         as_json(options.merge(representation: name))
       end
+
+      def self.included(base)
+        return unless base.class == Module
+        AsJsonRepresentations.send(:included, base)
+        base.instance_variable_set :@parent, self
+      end
     end
   end
 end
+
+Array.include(AsJsonRepresentations::Collection)
+
+if defined?(Mongoid::Criteria)
+  Mongoid::Criteria.include(AsJsonRepresentations::Collection)
+end
+
+if defined?(ActiveRecord::Relation)
+  ActiveRecord::Relation.include(AsJsonRepresentations::Collection)
+end

data/lib/as_json_representations/collection.rb

@@ -0,0 +1,13 @@
+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
+  end
+end

data/lib/as_json_representations/version.rb

@@ -1,3 +1,3 @@
 module AsJsonRepresentations
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: as_json_representations
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - rjurado01
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-07 00:00:00.000000000 Z
+date: 2018-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - bin/console
 - bin/setup
 - lib/as_json_representations.rb
+- lib/as_json_representations/collection.rb
 - lib/as_json_representations/version.rb
 homepage: https://github.com/rjurado01/as_json_representations
 licenses:
@@ -92,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Creates representations of your model data