validate-params 0.12.5 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0efef56bcd7c8b05e33859d21078422a2a772d3dbb8241a9d0a0e5818c085a6
-  data.tar.gz: 23936b451c39e8b6425498c75383b4742ab8e43850f83960aeb200846d59dd32
+  metadata.gz: 77ee095dc2316a90b3784532a9d0586777c187b99c63b489129e4c0d6c4c6b2b
+  data.tar.gz: 17f55ad85601e32c1218f76c0b3e804b83cd5159b41308c0a448431f7a360dfc
 SHA512:
-  metadata.gz: 963d02b70917dfb1c81dbe672c62ff750c3ed76ae39943eb719e8385b90cf53e588c0d4599cff3551b367650f43a3f0b88cc975a7147e3a3f6f934670f99092f
-  data.tar.gz: 1ef4c60aba7a23cff17ad899ebe6996b77312203a0a5c11509dcc53bf66c6cd4801eb03d4af63e5fefcae4ce086de115e919c2e11b15390bd81d9a15c409d7e6
+  metadata.gz: 8a6b277ff7d5d03c8926a9ccf3b6b730bed2527de0e70d44fdc1853e749c6701a0072d39aa3e1679be0a22ae93d72569cff7986ff1b71f1d424c80f2b3831c1e
+  data.tar.gz: a5001cd005f065d12ffaa16a6f0f97b1148bf5934ea37e2804d6c5b749f7b666116fdb6b060a49babfa84b354dd3f4ce1685e73bd2f56670dcf579338cb1ae42

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [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
@@ -10,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.5)
+    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

@@ -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

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

data/lib/validate_params/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ValidateParams
-  VERSION = "0.12.5"
+  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.5
+  version: 0.13.0
 platform: ruby
 authors:
 - dcherevatenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-17 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,6 +122,7 @@ 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