validate-params 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77415952a47eed04815a14bc69183dac71d328f3f6457af90d6a53e282217225
-  data.tar.gz: b378c2c29ad38f747952d2b47c2c0431f69a3d71553efea49b9368cb5e985c8d
+  metadata.gz: 4e686013f02bbb7e5fd50eeabb70a7b3abdd3fdcc8458b3e2230d1a288435988
+  data.tar.gz: e2434d12a8b52721b930b426133189db03a84a7dbcb86ed57c1ca98c4b4b06b3
 SHA512:
-  metadata.gz: 4771f99a0060e876b62071201d1b6a1adb920bee3ec352c78d32fc4e5243c06b1aac65846c2a5be07d813375099e506778ec78dcd4486727918895b0d4adb1a4
-  data.tar.gz: 3e1be41784d411fcecf4dc4650d8ba6a25779a76abf8d8f355e1b795b50481c7e5f696240b86e952be9e64afb80541271b453dc4ef2a70d6b4e312a0fcd4a1ae
+  metadata.gz: 809c060682bd2e8b9e49781589f5fe45bd91abfdfdba7d41b1285b12fef5e8d27fb8476acdd8e1ffee73ec1a16c3f5017acb8348faa0e5b9c8735d499496c094
+  data.tar.gz: 34ee15be73ac94a817b144f246b43e89623c4a81261035448e432bce589b51971d3b8022ac6732a8e27197f0f21efb918b85535866a4109d63582a0a7d12da9a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.10.0] - 2023-08-28
+
+- Added support for IO type to validate file uploads
+
+## [0.9.0] - 2023-08-02
+
+- Add :min and :max options to validate param values for Integer types
+
 ## [0.8.0] - 2023-05-30
 
 - Added support for passing array of actions into validate_params_for to run on multiple actions
@@ -17,9 +25,9 @@
 ## [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
+- 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.51"
+gem "rubocop", "~> 1.56"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validate-params (0.8.1)
+    validate-params (0.10.0)
       activesupport (>= 6.1.0)
       i18n (>= 1.6)
 
@@ -28,6 +28,7 @@ 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)
@@ -36,6 +37,7 @@ GEM
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
+    language_server-protocol (3.17.0.3)
     loofah (2.21.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -45,9 +47,10 @@ GEM
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    racc (1.6.2)
+      racc
+    racc (1.7.1)
     rack (2.2.7)
     rack-test (2.1.0)
       rack (>= 1.3)
@@ -58,8 +61,8 @@ GEM
       loofah (~> 2.19, >= 2.19.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -73,17 +76,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.51.0)
+    rubocop (1.56.0)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     tzinfo (2.0.6)
@@ -99,7 +104,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 1.51)
+  rubocop (~> 1.56)
   validate-params!
 
 BUNDLED WITH

data/README.md

@@ -2,7 +2,7 @@
 
 [![Rspec](https://github.com/peopleforce/validate_params/actions/workflows/rspec.yml/badge.svg)](https://github.com/peopleforce/validate_params/actions/workflows/rspec.yml)
 
-ValidateParams is a lightweight, robust Ruby on Rails gem that introduces a simple yet powerful DSL (Domain Specific Language) to validate parameters for your controller actions. It is designed to make your code cleaner, more maintainable, and ensures that your application handles invalid or unexpected parameters gracefully.
+ValidateParams is a lightweight, robust Ruby on Rails gem that introduces a simple yet powerful DSL (Domain Specific Language) to validate and type cast the parameters for your controller actions. It is designed to make your code cleaner, more maintainable, and ensures that your application handles invalid or unexpected parameters gracefully.
 
 ## Installation
 
@@ -25,15 +25,17 @@ class TestController < ActionController::Base
   validate_params :index do |p|
     p.param :name, String, default: "John Doe"
     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 :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
     p.param :date_of_birth, Hash do |pp|
-      pp.param :gt, Date
+      pp.param :gt, Date, min: Date.new(2020, 1, 1), max: Date.new(2021, 1, 1)
       pp.param :lt, Date
     end
     p.param :created_at, Hash do |pp|
-      pp.param :lt, DateTime
+      pp.param :lt, DateTime, min: DateTime.new(2020, 1, 1), max: DateTime.new(2021, 1, 1)
       pp.param :gt, DateTime
     end
   end
@@ -44,10 +46,25 @@ class TestController < ActionController::Base
 end
 ```
 
+### Types
+
+Here are the following supported types along with operations supported.
+
+- String (required, default)
+- Integer (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)
+- Hash - Nested block of types
+
+
 ## 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.
 
+### JSON (Default)
+
 ```json
 {
     "success": false,
@@ -55,16 +72,24 @@ If the parameters are valid, the controller action will be executed as normal. I
         {
             "message": "hired_on must be a valid Date"
         },
-      
+        {
+            "message": "per_page cannot be more than maximum",
+            "max": 50
+        },
+        {
+            "message": "states is an invalid value",
+            "valid_values": ["active", "inactive"]
+        },
+
     ]
 }
 ```
 
-## Format
+### HTML
 
-By default responses are returned in JSON format. To return responses as an empty HTML response, change the :format options in the validate_params methods to :html.
+By default responses are returned in JSON format. To return responses as an empty HTML response with a **400 Bad Request** status, change the :format option in the validate_params methods to **:html**.
 
-Example: 
+Example:
 
 ```ruby
 validate_params :index, format: :html do |p|

data/config/locales/en.yml

@@ -3,3 +3,5 @@ en:
     required: "%{param} is required"
     invalid_type: "%{param} must be a valid %{type}"
     invalid_in: "%{param} is an invalid value"
+    more_than_max: "%{param} cannot be more than maximum"
+    less_than_min: "%{param} cannot be less than minimum"

data/lib/validate_params/param_validator.rb

@@ -36,15 +36,27 @@ module ValidateParams
         end
 
         def date
-          return if Types::Date.valid?(@value)
+          if !Types::Date.valid?(@value)
+            @errors << { message: error_message }
+            return
+          end
 
-          @errors << { message: error_message }
+          formatted_value = Types::Date.cast(@value)
+
+          validate_min(formatted_value) if @options[:min].present?
+          validate_max(formatted_value) if @options[:max].present?
         end
 
         def date_time
-          return if Types::DateTime.valid?(@value)
+          if !Types::DateTime.valid?(@value)
+            @errors << { message: error_message }
+            return
+          end
 
-          @errors << { message: error_message }
+          formatted_value = Types::DateTime.cast(@value)
+
+          validate_min(formatted_value) if @options[:min].present?
+          validate_max(formatted_value) if @options[:max].present?
         end
 
         def integer
@@ -53,13 +65,29 @@ module ValidateParams
             return
           end
 
+          formatted_value = Types::Integer.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
 
+        def io
+          unless Types::IO.valid?(@value)
+            @errors << { message: error_message }
+            return
+          end
+
+          formatted_value = Types::IO.cast(@value)
+
+          validate_min(formatted_value) if @options[:min].present?
+          validate_max(formatted_value) if @options[:max].present?
+        end
+
         def validate_inclusion
           return if @options[:in].include?(@value)
 
@@ -69,6 +97,24 @@ module ValidateParams
           }
         end
 
+        def validate_min(value)
+          return if @options[:min] <= value
+
+          @errors << {
+            message: I18n.t("validate_params.less_than_min", param: error_param_name),
+            min: @options[:min]
+          }
+        end
+
+        def validate_max(value)
+          return if @options[:max] >= value
+
+          @errors << {
+            message: I18n.t("validate_params.more_than_max", param: error_param_name),
+            max: @options[:max]
+          }
+        end
+
         def error_param_name
           case @field
           when Array

data/lib/validate_params/types/i_o.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ValidateParams
+  class Types
+    class IO
+      def self.valid?(value)
+        value.class.method_defined?(:size)
+      end
+
+      def self.cast(raw_value, **)
+        raw_value.size
+      end
+    end
+  end
+end

data/lib/validate_params/validatable.rb

@@ -4,6 +4,8 @@ require "validate_params/types/date"
 require "validate_params/types/date_time"
 require "validate_params/types/integer"
 require "validate_params/types/array"
+require "validate_params/types/string"
+require "validate_params/types/i_o"
 require_relative "param_builder"
 require_relative "param_validator"
 
@@ -25,7 +27,7 @@ module ValidateParams
         @params_validations ||= {}
 
         Array(action).each do |act|
-          @params_validations[act] ||= {options: options, validations: []}
+          @params_validations[act] ||= { options: options, validations: [] }
 
           yield(ParamBuilder.new(validations: @params_validations[act][:validations])) if block
         end

data/lib/validate_params/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validate-params
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.10.0
 platform: ruby
 authors:
 - dcherevatenko
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-30 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -116,17 +116,18 @@ files:
 - lib/validate_params/types/array.rb
 - lib/validate_params/types/date.rb
 - lib/validate_params/types/date_time.rb
+- lib/validate_params/types/i_o.rb
 - lib/validate_params/types/integer.rb
 - lib/validate_params/types/string.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
@@ -141,8 +142,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: []