validate-params 0.12.5 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0efef56bcd7c8b05e33859d21078422a2a772d3dbb8241a9d0a0e5818c085a6
-  data.tar.gz: 23936b451c39e8b6425498c75383b4742ab8e43850f83960aeb200846d59dd32
+  metadata.gz: c7e15b3464314531ae9f982d69feb1fd6ad5f57ee9964cf37e83ba7fa9fe6939
+  data.tar.gz: f45cfcdaceaa64d3883165e0e8c9b7d4f86d8e065e8cc144e104006c7619c0b0
 SHA512:
-  metadata.gz: 963d02b70917dfb1c81dbe672c62ff750c3ed76ae39943eb719e8385b90cf53e588c0d4599cff3551b367650f43a3f0b88cc975a7147e3a3f6f934670f99092f
-  data.tar.gz: 1ef4c60aba7a23cff17ad899ebe6996b77312203a0a5c11509dcc53bf66c6cd4801eb03d4af63e5fefcae4ce086de115e919c2e11b15390bd81d9a15c409d7e6
+  metadata.gz: 0266c77d4a5ac354cd2056f2c9da2db95fc41566c0c02d83023d983c9b13c40a09fd8aabe5cb9a8bf39cc9a300a8f21d79e1c06db1a18f95d5eea8a115f314b3
+  data.tar.gz: 77d490ec23d2b849e4be9e45e11cdef57e76f125f1dc0a10f59de38f1b53ebe274b0215779e91661f09b77cc94e1d8506c9477ff9763bf27952b276e7a46213a

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.13.1] - 2024-04-22
+
+- Improved checking for empty strings
+
+## [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 +19,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

@@ -5,5 +5,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in validate_params.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-gem "rubocop", "~> 1.57"
+gem "rake", "~> 13.2"
+gem "rubocop", "~> 1.63"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validate-params (0.12.5)
+    validate-params (0.13.1)
       activesupport (>= 6.1.0)
       i18n (>= 1.6)
 
@@ -31,26 +31,26 @@ GEM
     builder (3.2.4)
     concurrent-ruby (1.2.2)
     crass (1.0.6)
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     erubi (1.12.0)
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     loofah (2.21.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mini_portile2 (2.8.2)
+    mini_portile2 (2.8.6)
     minitest (5.18.0)
-    nokogiri (1.14.3)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.15.6)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    parallel (1.23.0)
-    parser (3.2.2.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
-    racc (1.7.1)
-    rack (2.2.7)
+    racc (1.7.3)
+    rack (2.2.9)
     rack-test (2.1.0)
       rack (>= 1.3)
     rails-dom-testing (2.0.3)
@@ -59,35 +59,35 @@ GEM
     rails-html-sanitizer (1.5.0)
       loofah (~> 2.19, >= 2.19.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.2)
+    rake (13.2.1)
+    regexp_parser (2.9.0)
     rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.57.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    rubocop (1.63.3)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
     ruby-progressbar (1.13.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -100,9 +100,9 @@ PLATFORMS
 DEPENDENCIES
   actionpack (>= 6.1.0)
   bundler (~> 2.0)
-  rake (~> 13.0)
+  rake (~> 13.2)
   rspec (~> 3.0)
-  rubocop (~> 1.57)
+  rubocop (~> 1.63)
   validate-params!
 
 BUNDLED WITH

data/README.md

@@ -8,11 +8,30 @@ 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
+require "validate_params/validatable"
+
+Rails.application.config.before_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 +70,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 +80,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 +108,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
@@ -19,7 +20,7 @@ module ValidateParams
       end
 
       def call
-        return if @value.blank? && !@options[:required]
+        return if @value.nil? && !@options[:required]
 
         if @value.blank? && @options[:required]
           @errors << { message: required_error_message }

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.1"
 end

data/validate_params.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "actionpack", ">= 6.1.0"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.2"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_dependency "activesupport", ">= 6.1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validate-params
 version: !ruby/object:Gem::Version
-  version: 0.12.5
+  version: 0.13.1
 platform: ruby
 authors:
 - dcherevatenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-17 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -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