validate-params 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b32fa7c57a158e0ef8e52c18256b07043bcad0db71c74a34aaa133e2251bce83
-  data.tar.gz: c82e56a0e5f5d5727d3d80f9724a5701dfcdf9bc72cff8b7b33fbcd0d1e1a213
+  metadata.gz: e4a258ed30473649f0653321c8ba39c756cf6e88748d56334d3f5e3655b848f6
+  data.tar.gz: 372fef2f81ba16caae4b8bb0761e9ccc1db69855607fda37fa3ff324d6efe9f1
 SHA512:
-  metadata.gz: ab2532167e3f8c333a40d199b66b80a5a1d46e66cea87714ed6cd04e7001855ab47beb9b4583be740a7ec9802a48272c4a5835f6e4cf41ec03cec50cfba14ef1
-  data.tar.gz: e5b3faaf1b1d60313c2cca7ae067ee94b3fbbe06ef49b3b53dd3777677714a0b7cb07a22da18f4f8e639929a16485a4b4fa895a77139b2dc2c0d4bf6a03524c0
+  metadata.gz: 0cc0c6d36439278009bd32ca26e832d5daaa728f8f8b68147e323db08cdfed7050ddc614a55b8a9f7d7c8134e958c0df3e3303e28113aaa585db988cf463a18c
+  data.tar.gz: 966e2f1354c35e26d69396552f178769c734fe58d0dcfdd7f88e74e4e81b49ccd97c97c628cc3bd499a160f9e1bd6207f2fb6225d6ea3f254d6076a017025090

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.3.0] - 2023-05-12
+
+- Add required attribute support
+
 ## [0.1.0] - 2023-05-10
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    validate-params (0.2.0)
+    validate-params (0.3.0)
       activesupport (>= 6.1.0)
 
 GEM

data/README.md

@@ -2,9 +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)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/validate_params`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+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.
 
 ## Installation
 
@@ -18,14 +16,23 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+Definition of the validator with symbols as keys:
+
 ```ruby
 class TestController < ActionController::Base
   include ValidateParams::ParamsValidator
 
   validate_params :index do |p|
-    p.param :id_param, Integer
-    p.param :date_param, Date
-    p.param :datetime_param, DateTime
+    p.param :occurred_on, Date, required: true
+    p.param :quantity, Integer
+    p.param :date_of_birth, Hash do |pp|
+      pp.param :gt, Date
+      pp.param :lt, Date
+    end
+    p.param :created_at, Hash do |pp|
+      pp.param :lt, DateTime
+      pp.param :gt, DateTime
+    end
   end
 
   def index
@@ -33,8 +40,6 @@ class TestController < ActionController::Base
   end
 end
 ```
-
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -44,3 +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.
+
+## Credits
+
+Built by the team at [PeopleForce](https://peopleforce.io), the HRM for small to medium sized tech businesses.

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  validate_params:
+    params_validator:
+      required: "The parameter %{field} is required"
+      invalid: "Invalid %{type} value '%{value}' for parameter %{field}"

data/lib/validate_params/params_validator.rb

@@ -12,9 +12,14 @@ module ValidateParams
     class_methods do
       attr_accessor :params_validations, :method
 
-      def param(field, type, required = false, default: nil)
+      def param(field, type, required: false, default: nil, &block)
         @params_validations ||= []
-        @params_validations << { field: field, type: type, required: required, default: default }
+        @params_validations <<
+          if block
+            yield(ParamBuilder.new(field))
+          else
+            ParamBuilder.new.param(field, type, required: required, default: default)
+          end
       end
 
       def validate_params_for(request_action, &block)
@@ -34,8 +39,12 @@ module ValidateParams
 
     private
 
-    def build_error_message(field, field_type, field_value)
-      I18n.t("api.public.invalid_parameter", field: field, field_type: field_type, field_value: field_value)
+    def build_error_message(field, type, value)
+      I18n.t("validate_params.params_validator.invalid", field: field, type: type, value: value)
+    end
+
+    def build_required_message(field)
+      I18n.t("validate_params.params_validator.required", field: field)
     end
 
     def error_param_name(field)
@@ -53,7 +62,15 @@ module ValidateParams
       params_validations.each do |params_validation|
         next if params_validation[:default].blank?
 
-        params[params_validation[:field]] ||= params_validation[:default]
+        if params_validation[:field].is_a?(Hash)
+          params_validation[:field].each_key do |key|
+            next if params.dig(key, params_validation[:field][key])
+
+            params.merge!(key => { params_validation[:field][key] => params_validation[:default] })
+          end
+        else
+          params[params_validation[:field]] ||= params_validation[:default]
+        end
       end
     end
 
@@ -64,14 +81,19 @@ module ValidateParams
 
       for params_validation in params_validations
         parameter_value = if params_validation[:field].is_a? Hash
-                            request.params.dig(params_validation[:field].keys.first,
-                                               params_validation[:field][params_validation[:field].keys.first])
+                            params.dig(params_validation[:field].keys.first,
+                                       params_validation[:field][params_validation[:field].keys.first])
                           else
-                            request.params[params_validation[:field]]
+                            params[params_validation[:field]]
                           end
 
         next if parameter_value.blank? && !params_validation[:required]
 
+        if parameter_value.blank? && params_validation[:required]
+          errors << build_required_message(error_param_name(params_validation[:field]))
+          next
+        end
+
         case params_validation[:type].to_s
         when "Date"
           if invalid_date?(parameter_value)
@@ -126,5 +148,19 @@ module ValidateParams
     def invalid_integer?(value)
       value !~ /\A[-+]?[0-9]+\z/
     end
+
+    class ParamBuilder
+      def initialize(parent_field = nil)
+        @parent_field = parent_field
+      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 }
+        end
+      end
+    end
   end
 end

data/lib/validate_params/version.rb

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

data/validate_params.gemspec

@@ -24,10 +24,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  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 "rspec", "~> 3.0"
-  spec.add_development_dependency "actionpack", ">= 6.1.0"
 
   spec.add_dependency "activesupport", ">= 6.1.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: validate-params
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - dcherevatenko
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -94,16 +94,17 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- config/locales/en.yml
 - lib/validate_params.rb
 - lib/validate_params/params_validator.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
@@ -118,8 +119,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.0.9
+signing_key: 
 specification_version: 4
 summary: Gem to validate params in controllers
 test_files: []