better_params 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af64b05bc75c0e695f916a16c20cd9b6aeea3037637e8254407210932af06c94
+  data.tar.gz: e43f0a8bf5b81b16ffe8e8f40eb5fdadc29e442d26896a0baa0b55c920860ac6
+SHA512:
+  metadata.gz: b400e185ed05996e1a3924b1018803b671dcf9d13ff1c4adf2b6f5e33fad915d81a03ef630b2a3990d543ff5d0c66e8103dcfeba96cb9df5a314fa7e6c131d03
+  data.tar.gz: 5737d14e62aab364364ef1c3481bcda2f2e203f3e216a130352e1b06e1051aaab24206a09a5060c84d4a03f9ceb0cef5111d2843ffae365ea145ae4abb03944f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 
+
+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,154 @@
+# BetterParams
+Adds useful methods to `ActionController::Parameters` for modifying parameters.
+
+## Usage
+`ActionController::Parameters` has useful methods for modifying parameters.
+
+### AddDestroyInfo
+Adds the *_destroy* attribute to existing *has_many* associations that were not passed for modification.
+The method accepts 2 parameters: an Active Record Object and a symbolic list of association names.
+Supports nested lists.
+```ruby
+object.association_a.ids
+# result
+[1,2]
+
+object.association_b.ids
+# result
+[1,2]
+
+ActionController::Parameters.new(
+                              a: 'a',
+                              association_a: [
+                                { id: 1, name: 'X1' },
+                                { name: 'Y1' }
+                              ],
+                              association_b: [
+                                { id: 1, name: 'X2' },
+                                { name: 'Y2' }
+                              ]
+                            ).add_destroy_info(object, :association_a)
+# result
+{
+  a: 'a',
+  association_a: [
+    { id: 1, name: 'X1' },
+    { id: 2, _destroy: true },
+    { name: 'Y1' },
+  ],
+  association_b: [
+    { id: 1, name: 'X2' },
+    { name: 'Y2' },
+  ]
+}
+```
+
+### Booleans
+Converts a parameter to a Boolean value.
+The method accepts 1 parameters: Symbolic list of attribute names.
+Supports nested lists.
+```ruby
+ActionController::Parameters.new(a: 'true', b: 'false', c: 'not_bool', d: 'true')
+                            .booleans(:a, :b, :c)
+# result
+{ a: true, b: false, c: false, d: 'true' }
+```
+
+### Datetimes
+Converts a parameter to a Time value.
+The method accepts 1 parameters: Symbolic list of attribute names.
+Supports nested lists.
+```ruby
+ActionController::Parameters.new(a: '2020-01-01', b: '2020-01-01')
+                            .datetimes(:a)
+# result
+{ a: 2020-01-01 00:00:00 +0700, b: '2020-01-01' }
+```
+
+### PrepareNestedAttributes
+Adds the *_attributes* Postfix to nested parameters, which allows creating a group of related entities using the `assign_attributes` method.
+The method accepts 1 parameters: Symbolic list of association names.
+Supports nested lists.
+```ruby
+ActionController::Parameters.new(
+                                  a: 'a',
+                                  association_a: [{ a: 'a' }],
+                                  association_b: [
+                                    {
+                                      b: 'b',
+                                      association_b_a: [{ ba: 'b_a' }]
+                                    }
+                                  ]
+                            ).prepare_nested_attributes(
+                              :association_a,
+                              association_b: [:association_b_a]
+                            )
+# result
+{
+  a: 'a',
+  association_a_attributes: [{ a: 'a' }],
+  association_b_attributes: [
+    {
+      b: 'b',
+      association_b_a_attributes: [{ ba: 'ba' }]
+    }
+  ]
+}
+```
+
+### RemoveBlanks
+Deletes keys with empty values.
+Not supports nested lists.
+```ruby
+ActionController::Parameters.new(a: 'a', b: '')
+                            .remove_blanks
+# result
+{ a: 'a' }
+```
+
+### ReplaceBlanksByNil
+Replaces blanks by nil.
+The method accepts 1 parameters: Symbolic list of attribute names.
+Supports nested lists.
+```ruby
+ActionController::Parameters.new(a: '', b: '')
+                            .replace_blanks_by_nil(:a)
+# result
+{ a: nil, b: '' }
+```
+
+### StripValues
+Removes leading and trailing spaces.
+The method accepts 1 parameters: Symbolic list of attribute names.
+Supports nested lists.
+```ruby
+ActionController::Parameters.new(a: ' a ', b: ' b ')
+                            .strip_values(:a)
+# result
+{ a: 'a', b: ' b ' }
+```
+
+Note: For all parameters, you must make a permit
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'better_params'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install better_params
+```
+
+## 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    = 'BetterParams'
+  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/better_params.rb

@@ -0,0 +1,7 @@
+require 'better_params/railtie'
+require 'better_params/base'
+
+module BetterParams
+end
+
+ActionController::Parameters.include BetterParams::Base

data/lib/better_params/base.rb

@@ -0,0 +1,31 @@
+require 'better_params/converters'
+require 'better_params/params_destroy_info'
+
+require 'better_params/base/convert_keys'
+require 'better_params/base/transform_values_for_keys'
+
+require 'better_params/base/add_destroy_info'
+require 'better_params/base/booleans'
+require 'better_params/base/datetimes'
+require 'better_params/base/prepare_nested_attributes'
+require 'better_params/base/remove_blanks'
+require 'better_params/base/replace_blanks_by_nil'
+require 'better_params/base/strip_values'
+
+module BetterParams
+  # The module depends on the 'params' controller instance variable
+  module Base
+    extend ActiveSupport::Concern
+
+    include ConvertKeys
+    include TransformValuesForKeys
+
+    include AddDestroyInfo
+    include Booleans
+    include Datetimes
+    include PrepareNestedAttributes
+    include RemoveBlanks
+    include ReplaceBlanksByNil
+    include StripValues
+  end
+end

data/lib/better_params/base/add_destroy_info.rb

@@ -0,0 +1,9 @@
+module BetterParams
+  module Base
+    module AddDestroyInfo
+      def add_destroy_info(object, *keys)
+        ParamsDestroyInfo.add(self, object, *keys)
+      end
+    end
+  end
+end

data/lib/better_params/base/booleans.rb

@@ -0,0 +1,11 @@
+module BetterParams
+  module Base
+    module Booleans
+      def booleans(*keys)
+        transform_values_for_keys(*keys) do |value|
+          Converters.to_b(value) if value
+        end
+      end
+    end
+  end
+end

data/lib/better_params/base/convert_keys.rb

@@ -0,0 +1,44 @@
+module BetterParams
+  module Base
+    module ConvertKeys
+      # Not used directly
+      def convert_keys(keys, &block)
+        merge_attributes = ->(params, key, attributes) do
+          params.merge(block.call(key) => attributes).except(key)
+        end
+
+        params = self
+        keys.each do |key|
+          if key.is_a? Hash
+            key.each do |nested_key, key_from_key|
+              nested_params = params[nested_key]
+              next if nested_params.nil?
+
+              nested_attributes =
+                if nested_params.is_a?(Array)
+                  nested_params.map do |item|
+                    item.convert_keys(key_from_key, &block)
+                  end
+                else
+                  nested_params.convert_keys(key_from_key, &block)
+                end
+
+              params = merge_attributes.call(
+                params,
+                nested_key,
+                nested_attributes
+              )
+            end
+          else
+            attributes = params[key]
+            next if attributes.nil?
+
+            params = merge_attributes.call(params, key, attributes)
+          end
+        end
+
+        params
+      end
+    end
+  end
+end

data/lib/better_params/base/datetimes.rb

@@ -0,0 +1,9 @@
+module BetterParams
+  module Base
+    module Datetimes
+      def datetimes(*keys)
+        transform_values_for_keys(*keys) { |value| value && Time.parse(value) }
+      end
+    end
+  end
+end

data/lib/better_params/base/prepare_nested_attributes.rb

@@ -0,0 +1,9 @@
+module BetterParams
+  module Base
+    module PrepareNestedAttributes
+      def prepare_nested_attributes(*keys)
+        convert_keys(keys) { |key| "#{key}_attributes".to_sym }
+      end
+    end
+  end
+end

data/lib/better_params/base/remove_blanks.rb

@@ -0,0 +1,9 @@
+module BetterParams
+  module Base
+    module RemoveBlanks
+      def remove_blanks
+        select { |_key, value| value.present? }
+      end
+    end
+  end
+end

data/lib/better_params/base/replace_blanks_by_nil.rb

@@ -0,0 +1,9 @@
+module BetterParams
+  module Base
+    module ReplaceBlanksByNil
+      def replace_blanks_by_nil(*keys)
+        transform_values_for_keys(*keys) { |value| value.blank? ? nil : value }
+      end
+    end
+  end
+end

data/lib/better_params/base/strip_values.rb

@@ -0,0 +1,33 @@
+module BetterParams
+  module Base
+    module StripValues
+      def strip_values(*keys)
+        keys.reduce(self) do |result, key|
+          if key.is_a?(Hash)
+            key.reduce(result) do |hash_result, (hash_key, hash_value)|
+              next hash_result unless hash_result.key?(hash_key)
+
+              nested = hash_result[hash_key]
+              next hash_result if nested.nil?
+
+              nested =
+                if nested.is_a?(Array)
+                  nested.map do |nested_object|
+                    nested_object.strip_values(*hash_value)
+                  end
+                else
+                  nested.strip_values(*hash_value)
+                end
+
+              hash_result.merge(hash_key => nested)
+            end
+          else
+            next result unless result.key?(key)
+
+            result.merge(key => result[key]&.strip)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/better_params/base/transform_values_for_keys.rb

@@ -0,0 +1,10 @@
+module BetterParams
+  module Base
+    module TransformValuesForKeys
+      # Not used directly
+      def transform_values_for_keys(*keys, &block)
+        merge(slice(*keys).transform_values { |value| block.call(value) })
+      end
+    end
+  end
+end

data/lib/better_params/converters.rb

@@ -0,0 +1,12 @@
+module BetterParams
+  # Auxiliary class for converting values
+  class Converters
+    # Converts to a Boolean value
+    def self.to_b(value)
+      return true if value.is_a? TrueClass
+      return false if value.is_a? FalseClass
+
+      value.to_s.downcase == 'true'
+    end
+  end
+end

data/lib/better_params/params_destroy_info.rb

@@ -0,0 +1,74 @@
+module BetterParams
+  class ParamsDestroyInfo
+    def self.add(*args)
+      new.add(*args)
+    end
+
+    # For all has_many relations from a keys array adds information
+    # about destroying objects by an algorythm:
+    # If a nested object doesn't exists in a passed object it will be destroyed.
+    def add(original_params, object, *keys)
+      return original_params if object.nil?
+
+      # Process every key and merge updated information to params
+      prepare_keys(keys).reduce(original_params) do |params, (key, nested_keys)|
+        # Don't needs to process key if params is not passed
+        nested_params = params[key]
+        next params if nested_params.nil?
+
+        # Can't process key if a nested object doesn't exists
+        relation = object.public_send(key)
+        next params if relation.nil?
+
+        if relation.is_a? Enumerable
+          # If a relation is a has_many, needs to add information about destroying
+          nested_params = add_destroy_info(nested_params, relation)
+
+          # Needs to go deeper to the every object in an array if has nested keys
+          unless nested_keys.nil?
+            nested_params = add_nested_destroy_info(
+              nested_params, relation, nested_keys
+            )
+          end
+        else
+          # If a relation is a single object we needs to go deeper
+          nested_params = add(nested_params, relation, *nested_keys)
+        end
+
+        next params.merge(key => nested_params)
+      end
+    end
+
+    protected
+
+    # Converts all keys to the same format -
+    # hash with array values where value can be nil
+    def prepare_keys(keys)
+      keys.reduce({}) do |hash, key|
+        hash.merge(key.is_a?(Hash) ? key : { key => nil })
+      end
+    end
+
+    # Adds { id: 1, _destroy: true } objects to an array if an object with id
+    # is not exists in the array but exists in a relation
+    def add_destroy_info(params_array, relation)
+      existed_ids = relation.map(&:id)
+      passed_ids = params_array.map { |attributes| attributes[:id] }.compact
+      ids_to_destroy = existed_ids - passed_ids
+      params_array + ids_to_destroy.map do |id|
+        ActionController::Parameters.new(id: id, _destroy: true).permit!
+      end
+    end
+
+    def add_nested_destroy_info(params_array, relation, nested_keys)
+      nested_objects_by_id = relation.group_by(&:id).transform_values(&:first)
+      params_array.map do |attributes|
+        id = attributes[:id]
+        nested_object = nested_objects_by_id[id]
+        next attributes if nested_object.nil?
+
+        add(attributes, nested_object, *nested_keys)
+      end
+    end
+  end
+end

data/lib/better_params/railtie.rb

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

data/lib/better_params/version.rb

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

data/lib/tasks/better_params_tasks.rake

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

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: better_params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bazov Peter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !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'
+description: Extension for default Rails params with useful features.
+email:
+- petr@sequenia.com
+- sb.truefalse@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/better_params.rb
+- lib/better_params/base.rb
+- lib/better_params/base/add_destroy_info.rb
+- lib/better_params/base/booleans.rb
+- lib/better_params/base/convert_keys.rb
+- lib/better_params/base/datetimes.rb
+- lib/better_params/base/prepare_nested_attributes.rb
+- lib/better_params/base/remove_blanks.rb
+- lib/better_params/base/replace_blanks_by_nil.rb
+- lib/better_params/base/strip_values.rb
+- lib/better_params/base/transform_values_for_keys.rb
+- lib/better_params/converters.rb
+- lib/better_params/params_destroy_info.rb
+- lib/better_params/railtie.rb
+- lib/better_params/version.rb
+- lib/tasks/better_params_tasks.rake
+homepage: http://sequenia.com/
+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: Better Params
+test_files: []