validate-params 0.12.4 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49259451d9cfaab7442c2efbebcf863fd95ffaa5939d20bfda60f74a790ebcde
-  data.tar.gz: 93b889e507e6a14faa28715ce53fc0a8609dd4903a7b1400a4398fad401d9105
+  metadata.gz: 77ee095dc2316a90b3784532a9d0586777c187b99c63b489129e4c0d6c4c6b2b
+  data.tar.gz: 17f55ad85601e32c1218f76c0b3e804b83cd5159b41308c0a448431f7a360dfc
 SHA512:
-  metadata.gz: feb837f5b782d6aa7715b8cc4f508a4c5280221ce4760e818c7b39e10955340db62aaad82ac512257ac01071ca66f6b7246af7de8f4570e3f130acf78a74a7c3
-  data.tar.gz: 80276c1107d9fd4395b4e3e9cd9bc0fa472b5ea22eedd3303e26521650e7bb25ae56d37285641ace765c6d9f8765345e9b0117538c070be71a83dac64e425b77
+  metadata.gz: 8a6b277ff7d5d03c8926a9ccf3b6b730bed2527de0e70d44fdc1853e749c6701a0072d39aa3e1679be0a22ae93d72569cff7986ff1b71f1d424c80f2b3831c1e
+  data.tar.gz: a5001cd005f065d12ffaa16a6f0f97b1148bf5934ea37e2804d6c5b749f7b666116fdb6b060a49babfa84b354dd3f4ce1685e73bd2f56670dcf579338cb1ae42

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-## [0.12.3] - 2024-04-14
+## [0.13.0] - 2024-04-16
+
+- Added `:scrub_invalid_utf8` and `:scrub_invalid_utf8_replacement` options to String type to handle invalid UTF-8 characters
+- Added [configurator](README.md#configuration) to change default behaviour for certain options
+
+
+## [0.12.5] - 2024-04-15
+
+- Restrict validation rules for Hash type objects
+
+## [0.12.4] - 2024-04-14
 
 - Revert 0.12.2 changes
 
@@ -6,6 +16,19 @@
 
 - Default option for Integer type should support empty string as well
 
+## [0.12.2] - 2024-03-11
+
+- Added inheritance of validate params rule between child and parent controllers
+
+## [0.12.1] - 2024-03-05
+
+- Fixed support of ActionController::Parameters along with Hash
+
+## [0.12.0] - 2024-03-05
+
+- Added support of array of hashes
+- Improved nested attributes validation
+
 ## [0.11.0] - 2023-11-04
 
 - Added support for Float type

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validate-params (0.12.4)
+    validate-params (0.13.0)
       activesupport (>= 6.1.0)
       i18n (>= 1.6)
 

data/README.md

@@ -8,11 +8,28 @@ ValidateParams is a lightweight, robust Ruby on Rails gem that introduces a simp
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add validate_params
+    $ bundle add validate-params
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install validate_params
+    $ gem install validate-params
+
+
+## Configuration
+
+To configure default options, create `config/initializers/validate_params.rb` file. Configuration example:
+
+```ruby
+Rails.application.config.after_initialize do
+    ValidateParams::Validatable.configure do |config|
+      config.scrub_invalid_utf8 = true # Default: false
+      config.scrub_invalid_utf8_replacement = "�" # Default: empty string
+    end
+end
+```
+Currently only these options are supported in configuration. If you need more options, please create an issue.
+
+**Be aware**: `scrub_invalid_utf8` mutates parameters value passed into controller. Learn more in [params mutation](#params-mutation) section.
 
 ## Usage
 
@@ -51,7 +68,7 @@ end
 
 Here are the following supported types along with operations supported.
 
-- String (required, default)
+- String (required, default, scrub_invalid_utf8, scrub_invalid_utf8_replacement)
 - Integer (required, default, min, max, in)
 - Float (required, default, min, max, in)
 - Date (required, default, min, max)
@@ -61,6 +78,14 @@ Here are the following supported types along with operations supported.
 - Hash - Nested block of types
 
 
+### Params mutation
+
+String type supports `scrub_invalid_utf8` and `scrub_invalid_utf8_replacement` options to handle invalid UTF-8 characters.
+If `scrub_invalid_utf8` is set to true, it will replace invalid UTF-8 characters with the value of `scrub_invalid_utf8_replacement`.
+
+This modified value will be passed to the controller parameters.
+
+
 ## Response
 
 If the parameters are valid, the controller action will be executed as normal. If the parameters are invalid, a **400 Bad Request** response will be returned with a JSON body containing the errors, or an empty HTML response.
@@ -81,8 +106,7 @@ If the parameters are valid, the controller action will be executed as normal. I
         {
             "message": "states is an invalid value",
             "valid_values": ["active", "inactive"]
-        },
-
+        }
     ]
 }
 ```

data/docker-compose.yml

@@ -10,3 +10,4 @@ services:
 
 volumes:
   bundler:
+

data/lib/validate_params/configuration.rb

@@ -0,0 +1,17 @@
+module ValidateParams
+  class Configuration
+    attr_accessor :scrub_invalid_utf8, :scrub_invalid_utf8_replacement
+
+    def initialize
+      @scrub_invalid_utf8 = false
+      @scrub_invalid_utf8_replacement = ""
+    end
+
+    def to_h
+      {
+        scrub_invalid_utf8: scrub_invalid_utf8,
+        scrub_invalid_utf8_replacement: scrub_invalid_utf8_replacement,
+      }
+    end
+  end
+end

data/lib/validate_params/extenstions/string.rb

@@ -0,0 +1,7 @@
+class String
+  alias original_blank? blank?
+
+  def blank?
+    self.scrub.original_blank?
+  end
+end

data/lib/validate_params/param_builder.rb

@@ -14,9 +14,9 @@ module ValidateParams
           if children.any?
             case type.to_s
             when "Hash"
-              # Skip in case hash is configured and string is passed
-              if !value.is_a?(String)
-                children.each { |c| c.valid?(value&.[](c.field), errors) }
+              children.each do |child|
+                child_value = value[child.field] if value.is_a?(Hash) || value.is_a?(ActionController::Parameters)
+                child.valid?(child_value, errors)
               end
             when "Array"
               values = value ? Array.wrap(value) : [nil]
@@ -43,6 +43,7 @@ module ValidateParams
       end
 
       def param(field, type, options = {})
+        options = ValidateParams::Validatable.configuration.to_h.merge(options)
         validation = Validation.new(field, type, options, [], @parent)
 
         if block_given?

data/lib/validate_params/param_validator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/inflector"
+require "validate_params/extenstions/string"
 
 module ValidateParams
   module Validatable
@@ -30,6 +31,12 @@ module ValidateParams
       end
 
       private
+        def hash
+          return if @value.is_a?(Hash) || @value.is_a?(ActionController::Parameters)
+
+          @errors << { message: error_message }
+        end
+
         def array
           return if Types::Array.valid?(@value, **@options)
 

data/lib/validate_params/types/string.rb

@@ -1,10 +1,18 @@
 # frozen_string_literal: true
 
+require "validate_params/utilities/scrubber"
+
 module ValidateParams
   class Types
     class String
-      def self.cast(raw_value, **)
-        raw_value.to_s
+      def self.cast(raw_value, scrub_invalid_utf8: false, **)
+        value = raw_value.to_s
+
+        if scrub_invalid_utf8
+          value = Validatable::Utilities::Scrubber.scrub(raw_value)
+        end
+
+        value
       end
     end
   end

data/lib/validate_params/utilities/scrubber.rb

@@ -0,0 +1,13 @@
+module ValidateParams
+  module Validatable
+    module Utilities
+      class Scrubber
+        def self.scrub(input_string, replacement: Validatable.configuration.scrub_invalid_utf8_replacement)
+          input_string
+            .scrub(replacement)
+            .tr("\u0000", replacement)
+        end
+      end
+    end
+  end
+end

data/lib/validate_params/validatable.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "validate_params/configuration"
+
 require "validate_params/types/date"
 require "validate_params/types/date_time"
 require "validate_params/types/integer"
@@ -16,6 +18,14 @@ module ValidateParams
   module Validatable
     extend ::ActiveSupport::Concern
 
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
     included do
       before_action :perform_validate_params
     end
@@ -79,9 +89,6 @@ module ValidateParams
               apply_default_values(sub_params, sub_validation)
             end
           elsif validation.type == Hash
-            # Skip in case hash is configured and string is passed
-            next if params[validation.field].is_a?(String)
-
             params[validation.field] ||= {}
             apply_default_values(params[validation.field], sub_validation)
           else
@@ -108,9 +115,6 @@ module ValidateParams
 
         validation.children.each do |sub_validation|
           if validation.type == Hash
-            # Skip in case hash is configured and string is passed
-            next if params[validation.field].is_a?(String)
-
             cast_param_values(params[validation.field], sub_validation)
           elsif validation.type == Array
             params[validation.field].each do |sub_params|

data/lib/validate_params/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ValidateParams
-  VERSION = "0.12.4"
+  VERSION = "0.13.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validate-params
 version: !ruby/object:Gem::Version
-  version: 0.12.4
+  version: 0.13.0
 platform: ruby
 authors:
 - dcherevatenko
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-14 00:00:00.000000000 Z
+date: 2024-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -111,6 +111,8 @@ files:
 - config/locales/en.yml
 - docker-compose.yml
 - lib/validate_params.rb
+- lib/validate_params/configuration.rb
+- lib/validate_params/extenstions/string.rb
 - lib/validate_params/param_builder.rb
 - lib/validate_params/param_validator.rb
 - lib/validate_params/types/array.rb
@@ -120,15 +122,16 @@ files:
 - lib/validate_params/types/i_o.rb
 - lib/validate_params/types/integer.rb
 - lib/validate_params/types/string.rb
+- lib/validate_params/utilities/scrubber.rb
 - lib/validate_params/validatable.rb
 - lib/validate_params/version.rb
 - sig/validate_params.rbs
 - validate_params.gemspec
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,8 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Gem to validate params in controllers
 test_files: []