validate-params 0.10.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4bf00d7abf295f6623a9d5662925cca62bea27970d12f7c80bed5f3a38c8771
-  data.tar.gz: 2eed60863aa7042cf3d49fe2efc27f05eeaffabed8271b9af24ba86b84c569f2
+  metadata.gz: 29df4493a4e78d2a93b953b423b01a87870e49e9178720971eba9174aa0a5e1e
+  data.tar.gz: 6368b7cbf5240ff8d05ef54a402fc52ec800e181a6104f4219bae02270745b62
 SHA512:
-  metadata.gz: 1824e14a25d47becc170f70562028df6106cc16f55e183a59b911147cb513a6f137b1eea8ee622682fb0f1095bd8bb50b190a53ed08ae9cb9246856ecd347501
-  data.tar.gz: 278a1b7d1e8d36277214e648c000a3f87cce939c9f224fc29f2e2efd2f0fdf7ede037ca9b9e05a9b61b7e79df095d5b9c80d0f20d74793924f591af92bf634a0
+  metadata.gz: 63379593455a6bf06bb6d8633b8387d170bc602114e53cd5107cbc7e9e5fee524cb66c86d5e7675a9d4e300cc380d982be8cf8739cf34e59e3d4bc76b1c26d0e
+  data.tar.gz: 371f096da45f2eeed375607d1181e227b843b18241c43a9601db90bf8d0357939f65c1413814a7ee031472b504acd776ca72c3d8f1b184a1a05254d938d7de9c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.11.0] - 2023-11-04
+
+- Added support for Float type
+- Improved validation for Array type
+
 ## [0.10.0] - 2023-08-28
 
 - Added support for IO type to validate file uploads

data/Gemfile

@@ -6,4 +6,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
-gem "rubocop", "~> 1.56"
+gem "rubocop", "~> 1.57"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validate-params (0.10.1)
+    validate-params (0.12.0)
       activesupport (>= 6.1.0)
       i18n (>= 1.6)
 
@@ -28,7 +28,6 @@ GEM
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
-    base64 (0.1.1)
     builder (3.2.4)
     concurrent-ruby (1.2.2)
     crass (1.0.6)
@@ -47,7 +46,7 @@ GEM
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     parallel (1.23.0)
-    parser (3.2.2.3)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
     racc (1.7.1)
@@ -61,7 +60,7 @@ GEM
       loofah (~> 2.19, >= 2.19.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.1)
+    regexp_parser (2.8.2)
     rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -76,24 +75,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.56.0)
-      base64 (~> 0.1.1)
+    rubocop (1.57.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.2.2.4)
       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)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
     zeitwerk (2.6.8)
 
 PLATFORMS
@@ -104,7 +102,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 1.56)
+  rubocop (~> 1.57)
   validate-params!
 
 BUNDLED WITH

data/README.md

@@ -27,6 +27,7 @@ class TestController < ActionController::Base
     p.param :occurred_on, Date, required: true, default: proc { Date.today }
     p.param :per_page, Integer, default: 50, min: 1, max: 50
     p.param :quantity, Integer, required: true, in: [1, 2, 3]
+    p.param :weight, Float
     p.param :user_ids, Array, of: Integer, default: [1, 2, 3]
     p.param :states, Array, of: String, default: ["active", "inactive"], reject_blank: true
     p.param :file, IO, min: 1.byte, max: 1.megabyte
@@ -52,10 +53,11 @@ Here are the following supported types along with operations supported.
 
 - String (required, default)
 - Integer (required, default, min, max, in)
+- Float (required, default, min, max, in)
 - Date (required, default, min, max)
 - DateTime (required, default, min, max)
 - IO (required, min, max)
-- Array of: (String|Integer) (default, reject_blank)
+- Array of: (String|Integer|Float) (default, reject_blank)
 - Hash - Nested block of types
 
 

data/lib/validate_params/param_builder.rb

@@ -3,27 +3,60 @@
 module ValidateParams
   module Validatable
     class ParamBuilder
-      def initialize(parent_field: nil, validations:)
-        @parent_field = parent_field
-        @validations = validations
-      end
+      Validation = Struct.new(:field, :type, :options, :children, :parent) do
+        def valid?(value, errors)
+          ParamValidator.call(
+            validation: self,
+            value: value,
+            errors: errors
+          )
 
-      def param(field, type, options = {}, &block)
-        if block
-          yield(ParamBuilder.new(parent_field: field, validations: @validations))
-        else
-          @validations << build_config(field, type, options)
+          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) }
+              end
+            when "Array"
+              values = value ? Array.wrap(value) : [nil]
+              values.each do |item|
+                children.each do |child|
+                  child_value = item[child.field] if item.is_a?(Hash) || item.is_a?(Array)
+                  child.valid?(child_value, errors)
+                end
+              end
+            else
+              raise "Unexpected type: #{type}"
+            end
+          end
+
+          errors.empty?
         end
       end
 
-      private
-        def build_config(field, type, options)
-          if @parent_field.nil?
-            { field: field, type: type, options: options }
-          else
-            { field: { @parent_field => field }, type: type, options: options }
+      def initialize(parent: nil, validations: [])
+        @parent = parent
+        @validations = validations
+      end
+
+      def param(field, type, options = {})
+        validation = Validation.new(field, type, options, [], @parent)
+
+        if block_given?
+          if ![Array, Hash].include?(type)
+            raise "#{type} type cannot have nested definitions, only Array or Hash are supported"
           end
+
+          yield ParamBuilder.new(parent: validation)
         end
+
+        if @parent
+          @parent.children << validation
+        else
+          @validations << validation
+        end
+      end
     end
   end
 end

data/lib/validate_params/param_validator.rb

@@ -9,12 +9,13 @@ module ValidateParams
         new(**args).call
       end
 
-      def initialize(type:, field:, value:, errors:, options: {})
-        @type = type
-        @field = field
+      attr_reader :validation
+
+      def initialize(validation:, value:, errors:)
+        @validation = validation
         @value = value
         @errors = errors
-        @options = options
+        @options = validation.options.presence || {}
       end
 
       def call
@@ -25,7 +26,7 @@ module ValidateParams
           return
         end
 
-        send(@type.to_s.underscore)
+        send(validation.type.to_s.underscore)
       end
 
       private
@@ -72,6 +73,19 @@ module ValidateParams
           validate_max(formatted_value) if @options[:max].present?
         end
 
+        def float
+          unless Types::Float.valid?(@value)
+            @errors << { message: error_message }
+            return
+          end
+
+          formatted_value = Types::Float.cast(@value)
+
+          validate_inclusion if @options[:in].present?
+          validate_min(formatted_value) if @options[:min].present?
+          validate_max(formatted_value) if @options[:max].present?
+        end
+
         def string
           validate_inclusion if @options[:in].present?
         end
@@ -116,18 +130,15 @@ module ValidateParams
         end
 
         def error_param_name
-          case @field
-          when Array
-            "#{@field[0]}[#{@field[1]}]"
-          when Hash
-            @field.map { |k, v| "#{k}[#{v}]" }.first
+          if validation.parent
+            "#{validation.parent.field}[#{validation.field}]"
           else
-            @field
+            validation.field
           end
         end
 
         def error_message
-          I18n.t("validate_params.invalid_type", param: error_param_name, type: @type)
+          I18n.t("validate_params.invalid_type", param: error_param_name, type: validation.type)
         end
 
         def required_error_message

data/lib/validate_params/types/array.rb

@@ -3,25 +3,35 @@
 module ValidateParams
   class Types
     class Array
-      def self.valid?(value, of: String, reject_blank: false, **)
+      def self.valid?(value, of: ::String, reject_blank: false, **)
+        return false unless value.is_a?(::Array)
+
         val = value
-        val = val.reject(&:blank?) if reject_blank
+        val.reject!(&:blank?) if reject_blank
 
         case of.to_s
         when "Integer"
           val.all? { |item| Types::Integer.valid?(item) }
+        when "Float"
+          val.all? { |item| Types::Float.valid?(item) }
+        when "String"
+          val.all? { |item| item.is_a?(::String) }
+        when "Hash"
+          val.all? { |item| item.is_a?(::Hash) }
         else
           true
         end
       end
 
-      def self.cast(raw_value, of: String, reject_blank: false, **)
+      def self.cast(raw_value, of: ::String, reject_blank: false, **)
         value = raw_value
-        value = value.reject!(&:blank?) if reject_blank
+        value.reject!(&:blank?) if reject_blank
 
         case of.to_s
         when "Integer"
           value.map { |item| Types::Integer.cast(item) }
+        when "Float"
+          value.map { |item| Types::Float.cast(item) }
         else
           value
         end

data/lib/validate_params/types/float.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ValidateParams
+  class Types
+    class Float
+      def self.valid?(value)
+        /\A[-+]?\d+(\.\d+)?\z/ === value.to_s
+      end
+
+      def self.cast(raw_value, **)
+        raw_value.to_f
+      end
+    end
+  end
+end

data/lib/validate_params/validatable.rb

@@ -3,6 +3,7 @@
 require "validate_params/types/date"
 require "validate_params/types/date_time"
 require "validate_params/types/integer"
+require "validate_params/types/float"
 require "validate_params/types/array"
 require "validate_params/types/string"
 require "validate_params/types/i_o"
@@ -22,14 +23,17 @@ module ValidateParams
     class_methods do
       attr_reader :params_validations
 
-      def validate_params_for(action, options = {}, &block)
+      def validate_params_for(action, options = {})
         options[:format] ||= :json
         @params_validations ||= {}
 
         Array(action).each do |act|
           @params_validations[act] ||= { options: options, validations: [] }
 
-          yield(ParamBuilder.new(validations: @params_validations[act][:validations])) if block
+          if block_given?
+            param_builder = ParamBuilder.new(validations: @params_validations[act][:validations])
+            yield(param_builder)
+          end
         end
       end
     end
@@ -46,29 +50,15 @@ module ValidateParams
         config = params_validations[action_name.to_sym]
 
         config[:validations].each do |validation|
-          apply_default_values(validation)
-
-          next if validation[:field].is_a?(Hash) &&
-            params[validation[:field].keys.first].is_a?(String)
-
-          parameter_value = if validation[:field].is_a? Hash
-                              params.dig(validation[:field].keys.first,
-                                         validation[:field][validation[:field].keys.first])
-                            else
-                              params[validation[:field]]
-                            end
-
-          ParamValidator.call(
-            type: validation[:type],
-            field: validation[:field],
-            value: parameter_value,
-            errors: errors,
-            options: validation[:options]
-          )
+          apply_default_values(params, validation)
+          validation.valid?(params[validation.field], errors)
         end
 
         if errors.empty?
-          cast_param_values(config[:validations])
+          config[:validations].each do |validation|
+            cast_param_values(params, validation)
+          end
+
           return
         end
 
@@ -80,57 +70,57 @@ module ValidateParams
         end
       end
 
-      def apply_default_values(validation)
-        return unless validation[:options].key?(:default)
+      def apply_default_values(params, validation)
+        validation.children.each do |sub_validation|
+          next if sub_validation.options.blank?
 
-        if validation[:field].is_a?(Hash)
-          validation[:field].each_key do |key|
+          if validation.type == Array
+            Array(params[validation.field]).each do |sub_params|
+              apply_default_values(sub_params, sub_validation)
+            end
+          elsif validation.type == Hash
             # Skip in case hash is configured and string is passed
-            next if hashlike?(params[key])
-            next if params.dig(key, validation[:field][key])
-
-            value = if validation[:options][:default].is_a?(Proc)
-                      validation[:options][:default].call
-                    else
-                      validation[:options][:default]
-                    end
+            next if params[validation.field].is_a?(String)
 
-            params[key] ||= {}
-            params[key][validation[:field][key]] = value
+            params[validation.field] ||= {}
+            apply_default_values(params[validation.field], sub_validation)
+          else
+            apply_default_values(params, sub_validation)
           end
-        else
-          value = if validation[:options][:default].is_a?(Proc)
-                    validation[:options][:default].call
-                  else
-                    validation[:options][:default]
-                  end
-
-          params[validation[:field]] ||= value
         end
+
+        return if validation.children.any?
+
+        options = validation.options.presence || {}
+        return if !options.key?(:default)
+
+        value = options[:default].is_a?(Proc) ? options[:default].call : options[:default]
+        params[validation.field] ||= value
       end
 
-      def cast_param_values(validations)
-        validations.each do |validation|
-          if validation[:field].is_a?(Hash)
-            validation[:field].each_key do |key|
-              next unless hashlike?(params[key])
+      def cast_param_values(params, validation)
+        return unless params
 
-              value = params.dig(key, validation[:field][key])
-              next if value.blank?
+        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)
 
-              params[key][validation[:field][key]] = Types.const_get(validation[:type].name).cast(value, **validation.fetch(:options, {}))
+            cast_param_values(params[validation.field], sub_validation)
+          elsif validation.type == Array
+            params[validation.field].each do |sub_params|
+              cast_param_values(sub_params, sub_validation)
             end
-          else
-            value = params[validation[:field]]
-            next if value.blank?
-
-            params[validation[:field]] = Types.const_get(validation[:type].name).cast(value, **validation.fetch(:options, {}))
           end
         end
-      end
 
-      def hashlike?(obj)
-        obj.is_a?(Hash) || obj.is_a?(ActionController::Parameters)
+        return if validation.children.any?
+
+        value = params[validation.field]
+        return if value.blank?
+
+        options = validation.options.presence || {}
+        params[validation.field] = Types.const_get(validation.type.name).cast(value, **options)
       end
   end
 end

data/lib/validate_params/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validate-params
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.12.0
 platform: ruby
 authors:
 - dcherevatenko
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-31 00:00:00.000000000 Z
+date: 2024-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -116,6 +116,7 @@ files:
 - lib/validate_params/types/array.rb
 - lib/validate_params/types/date.rb
 - lib/validate_params/types/date_time.rb
+- lib/validate_params/types/float.rb
 - lib/validate_params/types/i_o.rb
 - lib/validate_params/types/integer.rb
 - lib/validate_params/types/string.rb
@@ -123,11 +124,11 @@ files:
 - 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
@@ -142,8 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: Gem to validate params in controllers
 test_files: []