active_mappers 1.4.0 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aeca810a9999765703a5f64cc394c4b30cbb2d0891f6648c5402efa1d336ffdd
-  data.tar.gz: 8e77fda2149230f5bab01d50083bd8254b84bd34d28306abc86f829a7741d151
+  metadata.gz: 74222f3c7d4f7ba70429c27aefde7a52c5fb34c811f904ed6608e22c4687df80
+  data.tar.gz: 97c3d7bc5d23f0b73f59ffe9e9edb4f32c4fbb5007ae1d9767c0625f1cb52563
 SHA512:
-  metadata.gz: 7cc3c0b2848d31fc0edf7448fcacf68cbce32c9919255363199d9fbfdc86ce97e8d779effb4187ddb3d93157042fc69e7037d5ebf418ebcc702830e6301906f0
-  data.tar.gz: 337e71b30d908254f7e394d7767888fcd90bcd7a70b1a88796a315d68de7bcda105986f3b0d5746b1d292a7a4a8af35a8eee17e730fc765ed84a533430ee4918
+  metadata.gz: 10575096699c2016d0e0fae9e4eb815daa01e5c6b607441acb11b482538c941fc3680b50270c9c549e023774e2e2d266682da59628085fd1b187082df0c63440
+  data.tar.gz: c4c854c19f6e51fef45fde92c7b178aef063718d98fce57a7fb856626621a612a448ba9fa84eafecdd6ecb7506def98e5009078a7279666d774dcdb37b1d792f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_mappers (1.4.0)
+    active_mappers (1.4.4)
       activesupport (>= 4.2)
       method_source (~> 0.9.2)
       mocha (>= 1.8.0)
@@ -11,29 +11,31 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (6.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
     concurrent-ruby (1.1.5)
-    i18n (1.6.0)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     metaclass (0.0.4)
     method_source (0.9.2)
-    minitest (5.11.3)
-    mocha (1.8.0)
+    minitest (5.13.0)
+    mocha (1.9.0)
       metaclass (~> 0.0.1)
     rake (12.3.1)
-    ruby2ruby (2.4.2)
+    ruby2ruby (2.4.4)
       ruby_parser (~> 3.1)
       sexp_processor (~> 4.6)
-    ruby_parser (3.13.0)
+    ruby_parser (3.14.1)
       sexp_processor (~> 4.9)
-    sexp_processor (4.12.0)
+    sexp_processor (4.13.0)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    zeitwerk (2.2.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -32,7 +32,7 @@ Then, depending on your usage you may want to create an `app/mappers` folder in
 
 You will put all your mappers inside of it.
 
-## Usage
+## Basic usage
 
 ```ruby
 UserMapper.with(user)
@@ -49,7 +49,7 @@ UserMapper.with(user)
 # }
 ```
 
-### Setup (optional)
+## Setup (optional)
 
 You may want to customize some parts of ActiveMappers behavior.
 
@@ -71,7 +71,7 @@ Here is the list of configurable options
 | `ignored_namespaces`    | `Array`   | `[]`      | Namespaces to ignore when generating json root key name            |
 | `root_keys_transformer` | `Proc`    | See below | Custom way to change a mapper class name into a JSON root key      |
 
-**Root Keys Transformer**
+### Root Keys Transformer
 
 A root key transform is used to transform the mapper class name into a JSON root key name.
 
@@ -101,9 +101,9 @@ config.root_keys_transformer = proc do |key|
 end
 ```
 
-### Creating a mapper
+## API
 
-**Declaring your attributes**
+### Declaring your attributes
 
 Most basic usage, just declare the attributes you want to display.
 
@@ -113,7 +113,7 @@ class UserMapper < ActiveMappers::Base # You must extend ActiveMappers::Base in
 end
 ```
 
-**Delegating your attributes**
+### Delegating your attributes
 
 Say you have a model with the following structure :
 
@@ -144,7 +144,7 @@ class UserMapper < ActiveMappers::Base
 end
 ```
 
-**Declaring relationship**
+### Declaring relationship
 
 You can declare any type of relationship (`has_one`, `belongs_to`, `has_many`, etc) and the mapper that matches it will automatically be fetched and used.
 
@@ -179,14 +179,13 @@ 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
 end
+```
 
-
-
-**Declaring polymorphic relationships**
+### Declaring polymorphic relationships
 
 Consider the following polymorphic relation :
 
@@ -202,7 +201,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 :
 
@@ -226,7 +225,7 @@ end
 
 Then, based of the `XXX_type` column, the mapper will automatically resolve to either `AdminUserMapper` or `NormalUserMapper`
 
-**Rendering a collection of different classes**
+### Rendering a collection of different classes
 
 Say you want to render many resources with a single Mapper
 
@@ -266,7 +265,7 @@ Will generate the following :
 
 Again, just like the above polymorphic declaration, the mapper will automatically resolve to the corresponding one.
 
-**Custom Attributes**
+### Custom Attributes
 
 If you need to implement custom attributes you can always use the `each` statement.
 
@@ -299,7 +298,7 @@ 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**
+### 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.
 
@@ -317,7 +316,7 @@ end
 RewardMapper.with(reward, context: user)
 ```
 
-**Scope**
+### Scope
 
 ActiveMappers does not yet support inheritance. However we provide an even better alternative named `scope`.
 
@@ -385,7 +384,7 @@ By default, root will be enabled, meaning a UserMapper, will generate a JSON pre
 }
 ```
 
-**Custom Root**
+### Custom Root
 
 If you want to customize the root name, you can use
 
@@ -401,7 +400,7 @@ which will generate :
 }
 ```
 
-**Rootless**
+### Rootless
 
 If you do not want to set any root, use :
 

data/active_mappers.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'active_mappers'
-  s.version     = '1.4.0'
-  s.date        = '2019-05-10'
+  s.version     = '1.4.5'
+  s.date        = '2020-08-27'
   s.summary     = 'Slick, fast view layer for you Rails API.'
   s.description = 'Fast, simple, declarative way to design your API\'s view layer'
   s.authors     = ['Michaël Villeneuve']

data/lib/active_mappers.rb

@@ -44,27 +44,36 @@ module ActiveMappers
     def self.relation(key, mapper = nil, **options)
       path = options[:optional_path] || key
       each do |resource|
-        relation_class_name = resource.class&.reflect_on_association(options[:optional_path] || key)&.class_name
-        raise "undefined relation : #{key.to_s}" if (mapper.nil? && relation_class_name.nil?)
-
-        mapper_to_use = mapper || KeyTransformer.resource_class_to_mapper(relation_class_name, self)       
-        raise "'#{mapper_to_use.name}' should be a mapper" unless mapper_to_use.ancestors.map(&:to_s).include?("ActiveMappers::Base")
+        mapper_to_use = if mapper
+          mapper
+        else
+          relation_class_name = resource.class&.reflect_on_association(options[:optional_path] || key)&.class_name
+          raise "undefined relation : #{key.to_s}" if (mapper.nil? && relation_class_name.nil?)
+          KeyTransformer.resource_class_to_mapper(relation_class_name, self)
+        end
         
-        { key => mapper_to_use.with(path.to_s.split('.').inject(resource, :try), options.merge(rootless: true)) }
+        raise "'#{mapper_to_use.name}' should be a mapper" unless mapper_to_use.ancestors.map(&:to_s).include?("ActiveMappers::Base")
+
+        { key => mapper_to_use.with(path.to_s.split('.').inject(resource, :try), default_options.merge(options)) }
       end
     end
 
-    def self.polymorphic(key)
-      each do |resource|
-        resource_mapper = "#{KeyTransformer.base_namespace(self)}::#{resource.send("#{key}_type")}Mapper".constantize
-        { key => resource_mapper.with(resource.send(key), rootless: true) }
+    def self.polymorphic(key, **options)
+      each do |resource, context|
+        options[:context] = context
+        if polymorphic_resource = resource.send("#{key}_type")
+          resource_mapper = "#{KeyTransformer.base_namespace(self)}::#{polymorphic_resource}Mapper".constantize
+          { key => resource_mapper.with(resource.send(key), default_options.merge(options)) }
+        else
+          {}
+        end
       end
     end
 
-    def self.acts_as_polymorph
+    def self.acts_as_polymorph(**options)
       each do |resource|
         mapper = KeyTransformer.resource_to_mapper(resource, self)
-        mapper.with(resource, rootless: true)
+        mapper.with(resource, default_options.merge(options))
       rescue NameError
         raise NotImplementedError, 'No mapper found for this type of resource'
       end
@@ -76,7 +85,7 @@ module ActiveMappers
 
     def self.with(args, options = {})
       return evaluate_scopes(args, options) unless options[:scope].nil?
-      
+
       response = if options[:rootless]
         args.respond_to?(:each) ? all(args, options[:context]) : one(args, options[:context])
       else
@@ -86,14 +95,13 @@ module ActiveMappers
     end
 
     def self.evaluate_scopes(args, options)
-      class_to_call = "::#{name}Scope#{options[:scope].capitalize}".constantize rescue raise("ActiveMappers [#{name}] No scope named #{options[:scope]} found")
+      class_to_call = "::#{name}Scope#{options[:scope].capitalize}".constantize rescue (options[:fallback_on_missing_scope] ? self : raise("ActiveMappers [#{name}] No scope named #{options[:scope]} found"))
       return class_to_call.with(args, options.except(:scope))
     end
 
     def self.scope(*params, &block)
-      raise "ActiveMappers [#{name}] scope must be a bloc" if block.nil? || !block.respond_to?(:call)
+      raise "ActiveMappers [#{name}] scope must be a block" if block.nil? || !block.respond_to?(:call)
 
-      
       params.each do |param|
         block_content = Ruby2Ruby.new.process(RubyParser.new.process(block.source).to_a.last)
         eval("class ::#{name}Scope#{param.capitalize} < ::#{name} ; #{block_content}; end")
@@ -103,7 +111,7 @@ module ActiveMappers
     def self.render_with_root(args, options = {})
       resource_name = options[:root]
       resource_name ||= KeyTransformer.apply_on(self.name)
-      
+
       if args.respond_to?(:each)
         { resource_name.to_s.pluralize.to_sym => all(args, options[:context]) }
       else
@@ -124,5 +132,10 @@ module ActiveMappers
 
       KeyTransformer.format_keys(renderers)
     end
+
+    def self.default_options
+      { rootless: true, fallback_on_missing_scope: true }
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_mappers
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.5
 platform: ruby
 authors:
 - Michaël Villeneuve
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -101,7 +101,7 @@ homepage: https://github.com/fidme/active_mappers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,9 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Slick, fast view layer for you Rails API.
 test_files: []