validate-params 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d696ca11ac7883af0c1213783efa1f9d5b0ea21643c5fb91af78f6d1edfe7d3
-  data.tar.gz: 4646124157428bbd8906accd5bb1d3c50debb88a0010abd3d1543a72c2c4265d
+  metadata.gz: 1cc4a4179e78c2c12842ddac40a4745028bbbf7f5f90cc0031fcaa3ae5db1422
+  data.tar.gz: 33e7a943d361d305a14e1a4c6f0d97f8f20f078d89ee872857238db5b947ab90
 SHA512:
-  metadata.gz: 59247d076c2d88dcc3b277660f109b3194844da3c78ed4fd41d3d07bb79f51728e60fb2c8cfe6668b1ce479826d5f24ac58eb2a07a924b5cfa4b086934662cd5
-  data.tar.gz: c42359ad0c204034e6ca1d545301a907bbe92c5f7d857a13e41b1c41bbfe9cc31cb2904d3fccdf684552bdd903ab314f46c34c22fa9d2e799e70e41d731cf304
+  metadata.gz: 2d081f19216d1a04527a13366857f37a25c818398dffa4703540b4f806593942d75d6759b4a8892fc2512dd72fa6a882d3a5ef7f9b57ac178b6c160b5d26896f
+  data.tar.gz: c484a35d91d3b3d3ff7c96b301063bb497e25dfea5621b3db3ade98b36a5981cae8555b451eff9d9b8240a579826b762f91025a5f86859d4e33476e9325ccd86

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.5.0] - 2023-05-15
+
+- Support for Proc as options for default to set param default values
+- Add :in options to validate param values against a list of values for String and Integer types
+- Updated JSON formats of error messages to be more consistent
+
 ## [0.3.0] - 2023-05-12
 
 - Add required attribute support

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validate-params (0.3.0)
+    validate-params (0.5.1)
       activesupport (>= 6.1.0)
 
 GEM
@@ -43,8 +43,6 @@ GEM
     nokogiri (1.14.3)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.14.3-arm64-darwin)
-      racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
@@ -74,7 +72,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.50.2)
+    rubocop (1.51.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -93,8 +91,6 @@ GEM
     zeitwerk (2.6.8)
 
 PLATFORMS
-  arm64-darwin-21
-  arm64-darwin-22
   ruby
 
 DEPENDENCIES
@@ -102,7 +98,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 1.21)
+  rubocop (~> 1.51)
   validate-params!
 
 BUNDLED WITH

data/README.md

@@ -23,8 +23,9 @@ class TestController < ActionController::Base
   include ValidateParams::ParamsValidator
 
   validate_params :index do |p|
-    p.param :occurred_on, Date, required: true
-    p.param :quantity, Integer
+    p.param :name, String, default: "John Doe"
+    p.param :occurred_on, Date, required: true, default: proc { Date.today }
+    p.param :quantity, Integer, required: true, in: [1, 2, 3]
     p.param :date_of_birth, Hash do |pp|
       pp.param :gt, Date
       pp.param :lt, Date
@@ -48,7 +49,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/validate_params.
+Bug reports and pull requests are welcome on GitHub at https://github.com/peopleforce/validate_params.
 
 ## Credits
 

data/config/locales/en.yml

@@ -1,4 +1,5 @@
 en:
   validate_params:
-    required: "The parameter %{field} is required"
-    invalid: "Invalid %{type} value '%{value}' for parameter %{field}"
+    required: "%{param} is required"
+    invalid_type: "%{param} must be a valid %{type}"
+    invalid_in: "%{param} is an invalid value"

data/lib/validate_params/params_validator.rb

@@ -12,14 +12,15 @@ module ValidateParams
     class_methods do
       attr_accessor :params_validations, :method
 
-      def param(field, type, required: false, default: nil, &block)
+      def param(field, type, options = {}, &block)
         @params_validations ||= []
-        @params_validations <<
-          if block
-            yield(ParamBuilder.new(field))
-          else
-            ParamBuilder.new.param(field, type, required: required, default: default)
-          end
+
+        if block
+          param_builder = ParamBuilder.new(field)
+          @params_validations += yield(param_builder)
+        else
+          @params_validations << ParamBuilder.new.param(field, type, options)
+        end
       end
 
       def validate_params_for(request_action, &block)
@@ -39,12 +40,12 @@ module ValidateParams
 
     private
 
-    def build_error_message(field, type, value)
-      I18n.t("validate_params.invalid", field: field, type: type, value: value)
+    def build_error_message(param, type)
+      I18n.t("validate_params.invalid_type", param: param, type: type)
     end
 
-    def build_required_message(field)
-      I18n.t("validate_params.required", field: field)
+    def build_required_message(param)
+      I18n.t("validate_params.required", param: param)
     end
 
     def error_param_name(field)
@@ -60,16 +61,29 @@ module ValidateParams
 
     def set_params_defaults
       params_validations.each do |params_validation|
-        next if params_validation[:default].blank?
+        next if params_validation[:options][:default].blank?
 
         if params_validation[:field].is_a?(Hash)
           params_validation[:field].each_key do |key|
+            # Skip in case hash is configured and string is passed
+            next if params.dig(key).is_a? Hash
             next if params.dig(key, params_validation[:field][key])
 
-            params.merge!(key => { params_validation[:field][key] => params_validation[:default] })
+            value = if params_validation[:options][:default].is_a?(Proc)
+                      params_validation[:options][:default].call
+                    else
+                      params_validation[:options][:default]
+                    end
+            params.merge!(key => { params_validation[:field][key] => value })
           end
         else
-          params[params_validation[:field]] ||= params_validation[:default]
+          value = if params_validation[:options][:default].is_a?(Proc)
+                    params_validation[:options][:default].call
+                  else
+                    params_validation[:options][:default]
+                  end
+
+          params[params_validation[:field]] ||= value
         end
       end
     end
@@ -80,6 +94,10 @@ module ValidateParams
       errors = []
 
       for params_validation in params_validations
+        # Skip in case hash is configured and string is passed
+        next if params_validation[:field].is_a?(Hash) &&
+          params.dig(params_validation[:field].keys.first).is_a?(String)
+
         parameter_value = if params_validation[:field].is_a? Hash
                             params.dig(params_validation[:field].keys.first,
                                        params_validation[:field][params_validation[:field].keys.first])
@@ -87,37 +105,48 @@ module ValidateParams
                             params[params_validation[:field]]
                           end
 
-        next if parameter_value.blank? && !params_validation[:required]
+        next if parameter_value.blank? && !params_validation[:options][:required]
 
-        if parameter_value.blank? && params_validation[:required]
-          errors << build_required_message(error_param_name(params_validation[:field]))
+        if parameter_value.blank? && params_validation[:options][:required]
+          errors << { message: build_required_message(error_param_name(params_validation[:field])) }
           next
         end
 
         case params_validation[:type].to_s
         when "Date"
           if invalid_date?(parameter_value)
-            errors << build_error_message(
-              error_param_name(params_validation[:field]),
-              params_validation[:type],
-              parameter_value
-            )
+            errors << {
+              message: build_error_message(error_param_name(params_validation[:field]), params_validation[:type])
+            }
           end
         when "DateTime"
           if invalid_datetime?(parameter_value)
-            errors << build_error_message(
-              error_param_name(params_validation[:field]),
-              params_validation[:type],
-              parameter_value
-            )
+            errors << {
+              message: build_error_message(error_param_name(params_validation[:field]), params_validation[:type])
+            }
           end
         when "Integer"
-          if invalid_integer?(parameter_value)
-            errors << build_error_message(
-              error_param_name(params_validation[:field]),
-              params_validation[:type],
-              parameter_value
-            )
+         if invalid_integer?(parameter_value)
+            errors << {
+              message: build_error_message(error_param_name(params_validation[:field]), params_validation[:type])
+            }
+            next
+          end
+
+          parameter_value = parameter_value.to_i
+          if params_validation[:options][:in].present? && !params_validation[:options][:in].include?(parameter_value)
+            errors << {
+              message: I18n.t("validate_params.invalid_in", param: error_param_name(params_validation[:field])),
+              valid_values: params_validation[:options][:in]
+            }
+          end
+        when "String"
+          parameter_value = parameter_value.to_s
+          if params_validation[:options][:in].present? && !params_validation[:options][:in].include?(parameter_value)
+            errors << {
+              message: I18n.t("validate_params.invalid_in", param: error_param_name(params_validation[:field])),
+              valid_values: params_validation[:options][:in]
+            }
           end
         end
       end
@@ -131,10 +160,10 @@ module ValidateParams
       return true unless /\d{4}-\d{2}-\d{2}/.match?(value)
 
       parsed_date = begin
-        Date.strptime(value, "%Y-%m-%d")
-      rescue StandardError
-        nil
-      end
+                      Date.strptime(value, "%Y-%m-%d")
+                    rescue StandardError
+                      nil
+                    end
       parsed_date.blank? || parsed_date.year > 9999
     end
 
@@ -146,20 +175,22 @@ module ValidateParams
     end
 
     def invalid_integer?(value)
-      value !~ /\A[-+]?[0-9]+\z/
+      value.to_s !~ /\A[-+]?[0-9]+\z/
     end
 
     class ParamBuilder
       def initialize(parent_field = nil)
         @parent_field = parent_field
+        @params_validations = []
       end
 
-      def param(field, type, required: false, default: nil)
-        if @parent_field
-          { field: { @parent_field => field }, type: type, required: required, default: default }
-        else
-          { field: field, type: type, required: required, default: default }
+      def param(field, type, options = {})
+        unless @parent_field
+          return { field: field, type: type, options: options }
         end
+
+        @params_validations << { field: { @parent_field => field }, type: type, options: options }
+        @params_validations
       end
     end
   end

data/lib/validate_params/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validate-params
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - dcherevatenko
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -100,11 +100,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
@@ -119,8 +119,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.2.3
+signing_key:
 specification_version: 4
 summary: Gem to validate params in controllers
 test_files: []