active_mappers 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ec2a77d6b91e05de5d86ab9a43b37d5fd7245085d696ccd9c7fb5aa900a42a3
-  data.tar.gz: b930be8ee3ac6adf404cfe9c0bad1107b9eb3287912c347b940438f2bab95af4
+  metadata.gz: aeca810a9999765703a5f64cc394c4b30cbb2d0891f6648c5402efa1d336ffdd
+  data.tar.gz: 8e77fda2149230f5bab01d50083bd8254b84bd34d28306abc86f829a7741d151
 SHA512:
-  metadata.gz: 9d29e59cc9231aab42657fbc2eb8c8e8106ed3a5e61752763efa3454de2775f4a7189886ebf46f626ea7b74b6d70c93bb3cf6c930dc23a77b7ffdb10cdfeaa8b
-  data.tar.gz: 774c84aea5e4b793ea0ce59ea8160ad2b626fe1d3d53392bc7d4909eff89c9629b7e69c1859ae8b6dc1198407f671554250430d26333d1ee8fbe26c4b657afe0
+  metadata.gz: 7cc3c0b2848d31fc0edf7448fcacf68cbce32c9919255363199d9fbfdc86ce97e8d779effb4187ddb3d93157042fc69e7037d5ebf418ebcc702830e6301906f0
+  data.tar.gz: 337e71b30d908254f7e394d7767888fcd90bcd7a70b1a88796a315d68de7bcda105986f3b0d5746b1d292a7a4a8af35a8eee17e730fc765ed84a533430ee4918

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_mappers (1.3.0)
+    active_mappers (1.4.0)
       activesupport (>= 4.2)
       method_source (~> 0.9.2)
       mocha (>= 1.8.0)

data/README.md

@@ -7,12 +7,12 @@ If you have ever done Rails API development, you must have considered using a la
 
 There are multiple solutions out on the market, here is a quick overview of each :
 
-| Solution                 | Pros                                                                               | Cons                                                  |
-| ------------------------ | ---------------------------------------------------------------------------------- | ----------------------------------------------------- |
-| JBuilder                 | Simple, easy, integrates with the default View layer                               | Very slow, dedicated to JSON                          |
-| Active Model Serializers | Simple, easy to declare                                                            | Can be hard to customize, slow, project is abandonned |
-| fast_json_api            | As simple as AMS, fast                                                             | Hard to customize, JSONAPI standard is required       |
-| ActiveMappers            | Blazing fast, Easy to declare/customize, works with any format output (JSON, Hash) | Limited number of options (for now)                   |
+| Solution                 | Pros                                                                               | Cons                                                 |
+| ------------------------ | ---------------------------------------------------------------------------------- | ---------------------------------------------------- |
+| JBuilder                 | Simple, easy, integrates with the default View layer                               | Very slow, dedicated to JSON                         |
+| Active Model Serializers | Simple, easy to declare                                                            | Can be hard to customize, slow, project is abandoned |
+| fast_json_api            | As simple as AMS, fast                                                             | Hard to customize, JSONAPI standard is required      |
+| ActiveMappers            | Blazing fast, Easy to declare/customize, works with any format output (JSON, Hash) | Limited number of options (for now)                  |
 
 ## Installation
 
@@ -179,9 +179,9 @@ It also works with namespaced resources.
 
 If you need you can specify more options :
 
-```ruby
+````ruby
 class UserMapper < ActiveMappers::Base
-  relation :account, AccountMapper, scope: :admin 
+  relation :account, AccountMapper, scope: :admin
 end
 
 
@@ -202,7 +202,7 @@ end
 class NormalUser
   has_many :posts, class_name: 'Post', as: :author
 end
-```
+````
 
 In order to use the `author` polymorphic attribute in your `PostMapper` you need to declare the following :
 
@@ -299,6 +299,24 @@ Will generate the following:
 You can declare any number of `each` in a single mapper.
 Actually, `each` is used to implement every above features.
 
+**Context**
+
+In most cases declaring your mapper with your resource should be enough. However, sometimes you may need to give your mapper a context in order to allow it to resolve a method or something else.
+
+At fidme we found a use case where we need to send an instance of a user along with a mapper in order to call a model method with user as params.
+
+To solve this use case we use the context option, for instance :
+
+```ruby
+class RewardMapper < ActiveMappers::Base
+  each do |reward, context|
+    { user_reward: reward.of_user(context) }
+  end
+end
+
+RewardMapper.with(reward, context: user)
+```
+
 **Scope**
 
 ActiveMappers does not yet support inheritance. However we provide an even better alternative named `scope`.
@@ -336,7 +354,6 @@ UserMapper.with(User.first, scope: :owner)
 # => { pseudo: 'michael33', email: 'mvilleneuve@fidme.com' }
 ```
 
-
 ## Using a mapper
 
 Even though there are many ways to declare a mapper, there is only one way to use it
@@ -418,7 +435,8 @@ module ActiveMappers
   end
 end
 ```
-and then: 
+
+and then:
 
 ```ruby
 class UserMapper < ActiveMappers::Base

data/active_mappers.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'active_mappers'
-  s.version     = '1.3.0'
+  s.version     = '1.4.0'
   s.date        = '2019-05-10'
   s.summary     = 'Slick, fast view layer for you Rails API.'
   s.description = 'Fast, simple, declarative way to design your API\'s view layer'

data/lib/active_mappers.rb

@@ -78,7 +78,7 @@ module ActiveMappers
       return evaluate_scopes(args, options) unless options[:scope].nil?
       
       response = if options[:rootless]
-        args.respond_to?(:each) ? all(args) : one(args)
+        args.respond_to?(:each) ? all(args, options[:context]) : one(args, options[:context])
       else
         render_with_root(args, options)
       end
@@ -105,21 +105,21 @@ module ActiveMappers
       resource_name ||= KeyTransformer.apply_on(self.name)
       
       if args.respond_to?(:each)
-        { resource_name.to_s.pluralize.to_sym => all(args) }
+        { resource_name.to_s.pluralize.to_sym => all(args, options[:context]) }
       else
-        { resource_name.to_s.singularize.to_sym => one(args) }
+        { resource_name.to_s.singularize.to_sym => one(args, options[:context]) }
       end
     end
 
-    def self.all(collection)
-      collection.map { |el| one(el) }.compact
+    def self.all(collection, context = nil)
+      collection.map { |el| one(el, context) }.compact
     end
 
-    def self.one(resource)
+    def self.one(resource, context = nil)
       return nil unless resource
       return {} if @@renderers[name].nil? # Mapper is empty
       renderers = @@renderers[name].map do |renderer|
-        renderer.call(resource)
+        renderer.call(resource, context)
       end.reduce(&:merge)
 
       KeyTransformer.format_keys(renderers)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_mappers
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Michaël Villeneuve