validate-params 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cc4a4179e78c2c12842ddac40a4745028bbbf7f5f90cc0031fcaa3ae5db1422
-  data.tar.gz: 33e7a943d361d305a14e1a4c6f0d97f8f20f078d89ee872857238db5b947ab90
+  metadata.gz: '08d564962e2a87e458df54cfaa8682f1495e83b5c17762517a9065ad79021b59'
+  data.tar.gz: 167f2b5dc20f1d028973596a4f365bb5a5c2bbc1b067a6a938d31c8ab906cc9b
 SHA512:
-  metadata.gz: 2d081f19216d1a04527a13366857f37a25c818398dffa4703540b4f806593942d75d6759b4a8892fc2512dd72fa6a882d3a5ef7f9b57ac178b6c160b5d26896f
-  data.tar.gz: c484a35d91d3b3d3ff7c96b301063bb497e25dfea5621b3db3ade98b36a5981cae8555b451eff9d9b8240a579826b762f91025a5f86859d4e33476e9325ccd86
+  metadata.gz: 40b1206f8a9fe7e18c54509530186f01143cfef09a8b1eb36853001c55984133b4ddee940238fe98e87b41407e218899d3ad030b7877a3b964b37f1848157076
+  data.tar.gz: db14ee08edf2d3a9f0127053596c2e3e3032817c143a935dc51418139b3d2facf133c76945445a990803258c95ee4da23f2a05007c189c8c23c54ae3ff8fd1e6

data/CHANGELOG.md

@@ -1,11 +1,15 @@
 ## [Unreleased]
 
+## [0.5.2] - 2023-05-29
+
+- Support to handle HTML and JSON response formats
+
 ## [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.lock

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

data/README.md

@@ -20,7 +20,7 @@ Definition of the validator with symbols as keys:
 
 ```ruby
 class TestController < ActionController::Base
-  include ValidateParams::ParamsValidator
+  include ValidateParams::Validatable
 
   validate_params :index do |p|
     p.param :name, String, default: "John Doe"
@@ -41,6 +41,23 @@ class TestController < ActionController::Base
   end
 end
 ```
+
+## 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.
+
+## Format
+
+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.
+
+Example: 
+
+```ruby
+validate_params :index, format: :html do |p|
+    p.param :name, String, default: "John Doe"
+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.

data/lib/validate_params/types/date.rb

@@ -0,0 +1,19 @@
+module ValidateParams
+  class Types
+    class Date
+      def self.valid?(value)
+        value = value.to_s
+        return false if !/\d{4}-\d{2}-\d{2}/.match?(value)
+
+        parsed_date = begin
+                        ::Date.strptime(value, "%Y-%m-%d")
+                      rescue StandardError
+                        nil
+                      end
+        return false if parsed_date.nil?
+        return false if parsed_date.year > 9999
+        true
+      end
+    end
+  end
+end

data/lib/validate_params/types/date_time.rb

@@ -0,0 +1,12 @@
+module ValidateParams
+  class Types
+    class DateTime
+      def self.valid?(value)
+        Time.at(Integer(value))
+        true
+      rescue ArgumentError, TypeError
+        false
+      end
+    end
+  end
+end

data/lib/validate_params/types/integer.rb

@@ -0,0 +1,10 @@
+module ValidateParams
+  class Types
+    class Integer
+      def self.valid?(value)
+        value = value.to_s
+        /\A[-+]?\d+\z/ === value
+      end
+    end
+  end
+end

data/lib/validate_params/{params_validator.rb → validatable.rb}

@@ -1,7 +1,11 @@
-require "active_support/concern"
+# frozen_string_literal: true
+
+require "validate_params/types/date"
+require "validate_params/types/date_time"
+require "validate_params/types/integer"
 
 module ValidateParams
-  module ParamsValidator
+  module Validatable
     extend ::ActiveSupport::Concern
 
     included do
@@ -23,8 +27,9 @@ module ValidateParams
         end
       end
 
-      def validate_params_for(request_action, &block)
-        @request_action = request_action
+      def validate_params_for(controller_action, options = {}, &block)
+        @controller_action = controller_action
+        @response_format = options[:format] || :html
 
         yield(self) if block
       end
@@ -34,8 +39,12 @@ module ValidateParams
       self.class.instance_variable_get(:@params_validations) || []
     end
 
-    def request_action
-      self.class.instance_variable_get(:@request_action) || nil
+    def controller_action
+      self.class.instance_variable_get(:@controller_action) || nil
+    end
+
+    def response_format
+      self.class.instance_variable_get(:@response_format) || nil
     end
 
     private
@@ -89,7 +98,7 @@ module ValidateParams
     end
 
     def perform_validate_params
-      return unless request_action.present? && request_action == action_name.to_sym
+      return unless controller_action.present? && controller_action == action_name.to_sym
 
       errors = []
 
@@ -114,19 +123,19 @@ module ValidateParams
 
         case params_validation[:type].to_s
         when "Date"
-          if invalid_date?(parameter_value)
+          unless ValidateParams::Types::Date.valid?(parameter_value)
             errors << {
               message: build_error_message(error_param_name(params_validation[:field]), params_validation[:type])
             }
           end
         when "DateTime"
-          if invalid_datetime?(parameter_value)
+          unless ValidateParams::Types::DateTime.valid?(parameter_value)
             errors << {
               message: build_error_message(error_param_name(params_validation[:field]), params_validation[:type])
             }
           end
         when "Integer"
-         if invalid_integer?(parameter_value)
+          unless ValidateParams::Types::Integer.valid?(parameter_value)
             errors << {
               message: build_error_message(error_param_name(params_validation[:field]), params_validation[:type])
             }
@@ -153,29 +162,12 @@ module ValidateParams
 
       return if errors.empty?
 
-      render json: { success: false, errors: errors }, status: :unprocessable_entity
-    end
-
-    def invalid_date?(value)
-      return true unless /\d{4}-\d{2}-\d{2}/.match?(value)
-
-      parsed_date = begin
-                      Date.strptime(value, "%Y-%m-%d")
-                    rescue StandardError
-                      nil
-                    end
-      parsed_date.blank? || parsed_date.year > 9999
-    end
-
-    def invalid_datetime?(value)
-      Time.at(Integer(value))
-      false
-    rescue ArgumentError, TypeError
-      true
-    end
-
-    def invalid_integer?(value)
-      value.to_s !~ /\A[-+]?[0-9]+\z/
+      case response_format
+      when :html
+        head :bad_request
+      else
+        render json: { success: false, errors: errors }, status: :bad_request
+      end
     end
 
     class ParamBuilder

data/lib/validate_params/version.rb

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

data/lib/validate_params.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require_relative "validate_params/version"
-require_relative "validate_params/params_validator"
+require_relative "validate_params/validatable"
+Dir[File.join(__dir__, 'validate_params/types', '*.rb')].each { |file| require file }
+Dir[File.join(__dir__, 'validate_params/validators', '*.rb')].each { |file| require file }
 
 module ValidateParams
   class Error < StandardError; end
 end
 
 ActiveSupport.on_load(:action_controller) do
-  include ValidateParams::ParamsValidator
+  include ValidateParams::Validatable
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validate-params
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - dcherevatenko
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -96,15 +96,19 @@ files:
 - Rakefile
 - config/locales/en.yml
 - lib/validate_params.rb
-- lib/validate_params/params_validator.rb
+- lib/validate_params/types/date.rb
+- lib/validate_params/types/date_time.rb
+- lib/validate_params/types/integer.rb
+- lib/validate_params/validatable.rb
+- lib/validate_params/validators/date.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
@@ -119,8 +123,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: []