Controller parameters wrapping feature #89
Conversation
alex-rogachev
force-pushed
the
params-wrapper
branch
3 times, most recently
from
d5877fc to
38dab69
Compare
alex-rogachev
force-pushed
the
params-wrapper
branch
4 times, most recently
from
1c0f0d6 to
54d8f8b
Compare
alex-rogachev
force-pushed
the
params-wrapper
branch
from
54d8f8b to
cc2162f
Compare
lib/rage/controller/api.rb
Outdated
| wrap_options = self.class.__wrap_parameters_options | ||
|
|
||
| wrapped_params = if wrap_options[:include] | ||
| @__params.slice(*[wrap_options[:include]].flatten) |
There was a problem hiding this comment.
Not sure what this line means. Can we just use *?
| @__params.slice(*[wrap_options[:include]].flatten) | |
| @__params.slice(*wrap_options[:include]) |
There was a problem hiding this comment.
yeah, I added flatten to support both symbol and array options, like exclude: :param and exclude: [:param1, :param2] but now I think that this is redundant and Rails supports only array options anyway so I'm going to remove flatten
lib/rage/controller/api.rb
Outdated
| wrapped_params = if wrap_options[:include] | ||
| @__params.slice(*[wrap_options[:include]].flatten) | ||
| elsif wrap_options[:exclude] | ||
| @__params.except(*[wrap_options[:exclude]].flatten) |
There was a problem hiding this comment.
| @__params.except(*[wrap_options[:exclude]].flatten) | |
| @__params.except(*wrap_options[:exclude]) |
lib/rage/controller/api.rb
Outdated
| @__params | ||
| end | ||
|
|
||
| @__params = @__params.merge({wrap_key => wrapped_params}) |
There was a problem hiding this comment.
Simple assign should be much faster.
| @__params = @__params.merge({wrap_key => wrapped_params}) | |
| @__params[wrap_key] = wrapped_params |
There was a problem hiding this comment.
totally makes sense 👍
lib/rage/controller/api.rb
Outdated
| # wrap_parameters :user, include: [:name, :age] | ||
| # @example | ||
| # wrap_parameters :user, exclude: :address | ||
| def wrap_parameters(key, options = {}) |
There was a problem hiding this comment.
Any specific reason you are not using keyword arguments here?
| end | ||
| end | ||
|
|
||
| context 'and :include option is set as Array' do |
There was a problem hiding this comment.
Could you please also add a test case for when the :include option is not present in the params?
| end | ||
| end | ||
|
|
||
| context 'and :exclude option is set as Array' do |
There was a problem hiding this comment.
Could you please also add a test case for when the :exclude option is not present in the params?
Implementation of wrappers for controller parameters.
Controllers got new class method
wrap_parametersthat accepts 2 parameters:key(mandatory) andoptions(optional). If called, all parameters are wrapped into a nested hash like this:{query_param: 'queryparam', body_param: 'bodyparam', action: 'action', controller: 'controller', wrapping_key: {query_param: 'queryparam', body_param: 'bodyparam', action: 'action', controller: 'controller'}}wherewrapping_keyis the key set with thewrap_parametersmethod.Parameters get wrapped only if there is no param that is named like the key passed during wrap_parameters call. Also, the 'Content_Type' header has to be present for the parameters to be wrapped.
Currently 2 options are available: include and exclude. When called with include option, the logic will only wrap parameters that are passed along with this option. If called with exclude option, all parameters except those that were passed with the option will be wrapped.
Possible enhancements: