wrap_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ad0381547689374084f65e0d47b22e4319053a7dd31b80323683a09c392bfcf
+  data.tar.gz: e62cc1e2eb866d18b34eff5e7938eab1ec7e75143c892a3bbe2e3ceb228032fe
+SHA512:
+  metadata.gz: 39ed0f2829520f1791cbb34dc6451d0433572ab077fc2dbdd4997db2c79bf7ee57d1d4f4e33ebbf7495f3910c1be6c7a17eb71f679beca1952e470b825ed6cdb
+  data.tar.gz: 994ed0dc6da21d1b56c94f80d2e14ef6f936cf1de083ef14f4c8548cabae7c7e4471dc59fee52608f2f88f7aaabbd494574a20cc80ab3caa54d4d7bd11df464e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 tanmen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# WrapAttributes
+add '_attributes' suffix in rails 
+
+## Usage
+```ruby
+class ApplicationController < ActionController::API
+  include WrapAttributes::AttributesWrapper # <- add
+end
+```
+
+```ruby
+ # request parameter
+ # { 'username' => 'tanmen', 'posts' => [{'text' => 'hallo'}] }
+ # ↓
+ # wrapped parameter
+ # { 'username' => 'tanmen', 'posts_attributes' => [{'text' => 'hallo'}] }
+class UsersController < ApplicationController
+  wrap_attributes :posts # <- add
+
+  private
+
+  def user_params
+    params.require(:user).permit(:username, :posts_attributes)
+  end
+end
+```
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wrap_attributes'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install wrap_attributes
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'WrapAttributes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/tasks/wrap_attributes_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :wrap_attributes do
+#   # Task goes here
+# end

data/lib/wrap_attributes/attributes_wrapper.rb

@@ -0,0 +1,41 @@
+require_relative 'converter'
+
+module WrapAttributes
+  module AttributesWrapper
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_attribute_options, default: []
+    end
+
+    module ClassMethods
+      def wrap_attributes(*keys)
+        self._attribute_options = keys
+      end
+    end
+
+    def process_action(*args)
+      _perform_attribute_parameter_wrapping
+      super
+    end
+
+    private
+
+    def _wrap_attribute_parameters(parameters, attributes)
+      WrapAttributes::convert(parameters, attributes)
+    end
+
+    def _perform_attribute_parameter_wrapping
+      wrapped_keys = request.request_parameters.keys
+      wrap_attribute_parameters = _wrap_attribute_parameters(request.request_parameters,
+                                                             _attribute_options)
+      filtered_attribute_parameters = _wrap_attribute_parameters(request.filtered_parameters.slice(*wrapped_keys),
+                                                        _attribute_options)
+
+      request.parameters.merge! wrap_attribute_parameters
+      request.request_parameters.merge! wrap_attribute_parameters
+
+      request.filtered_parameters.merge! filtered_attribute_parameters
+    end
+  end
+end

data/lib/wrap_attributes/converter.rb

@@ -0,0 +1,39 @@
+module WrapAttributes
+  def self.convert(parameters, attributes)
+    if parameters.is_a?(Symbol) || parameters.is_a?(String)
+      parameters
+    elsif parameters.is_a?(Hash)
+      if attributes.is_a?(Symbol) || attributes.is_a?(String)
+        parameters.map { |key, value| key.to_sym == attributes ? [attribute_key(key), value] : [key, value] }.to_h
+      elsif attributes.is_a?(Hash)
+        parameters.map do |key, params|
+          attr = attributes&.[](key.to_sym)
+          attr.present? ? [attribute_key(key), convert(params, attr)] : [key, params]
+        end.to_h
+      elsif attributes.is_a?(Array)
+        parameters.map do |key, params|
+          attributes.reduce([key, params]) do |pre, cur|
+            if cur.is_a?(Symbol) && cur == key.to_sym
+              [attribute_key(key), params]
+            elsif cur.is_a?(Hash) && cur.keys.include?(key.to_sym)
+              [attribute_key(key), convert(params, cur[key.to_sym])]
+            else
+              pre
+            end
+          end
+        end.to_h
+      end
+    elsif parameters.is_a?(Array)
+      parameters.map do |params|
+        convert(params, attributes)
+      end
+    end
+  end
+
+  private
+
+
+  def self.attribute_key(attribute)
+    (+attribute.to_s).concat('_attributes')
+  end
+end

data/lib/wrap_attributes/railtie.rb

@@ -0,0 +1,4 @@
+module WrapAttributes
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/wrap_attributes/version.rb

@@ -0,0 +1,3 @@
+module WrapAttributes
+  VERSION = '0.1.0'
+end

data/lib/wrap_attributes.rb

@@ -0,0 +1,4 @@
+require 'wrap_attributes/attributes_wrapper'
+
+module WrapAttributes
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: wrap_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tanmen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: convert request parameter to suffix '_attributes'
+email:
+- yt.prog@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/wrap_attributes_tasks.rake
+- lib/wrap_attributes.rb
+- lib/wrap_attributes/attributes_wrapper.rb
+- lib/wrap_attributes/converter.rb
+- lib/wrap_attributes/railtie.rb
+- lib/wrap_attributes/version.rb
+homepage: https://github.com/tanmen/wrap_attributes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: convert request parameter to suffix '_attributes'
+test_files: []