sinatra-param-validator 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1312fa49d8b256875f1c6de21269a7be31ab1c3f2ca0a5efdb9902c31b5406d4
-  data.tar.gz: 4b483ce648a24026e26964b0cdd358a4f1256ffe7dc810770e8dbf2b98204306
+  metadata.gz: e29508460ddab60a223a9a68607cf1463c71b4bec8b4aa8fc74596d25174a296
+  data.tar.gz: 2e25b479bfe8de0cde6eae7ccc2bb060ea66dee9d547120d5daca616d1c87f42
 SHA512:
-  metadata.gz: 2714270e73581d5beb88eb136516fc1d5275d05ebe2a3c5efca08d54b64bb2bcda467cb45cb4ab3fa7fee063606171356f9fe869cbedc0950afc7b92cb5dc8eb
-  data.tar.gz: 692691bde5e786c23897080967004fc5fb5b695d49942fd671db69ef6ec91c00771a0afbfc5e69954b5e22f8e585829c8e08a04b6a954cf14ec46b1c19dfdf8c
+  metadata.gz: b373671727a80340866970d2f1ef3b327735d622bcccad5bd27fcdf622351790cf017d0f516280ed741956ab1c0d249c6d546bad3b2a07f08c5943ca324f0437
+  data.tar.gz: 57c9eeb497333f36fb2eb2167edf4bd47df88139bcd29e6201402893c325ec3bb4888254278a7ab46a2f6d185079a5e7173478ba510f3b621af47b39fb68fe7e

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.8.0] - 2022-07-09
+
+- Add form helpers for form validator
+
+## [0.7.0] - 2022-06-09
+
+- Add `default` option for parameters
+- Allow `default` option to be a proc or a lambda
+
+## [0.6.0] - 2022-06-09
+
+- Add `block` to run blocks of code in the route context
+
 ## [0.5.0] - 2022-06-09
 
 - Allow the validator to be passed to the block for a valid parameter

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sinatra-param-validator (0.5.0)
+    sinatra-param-validator (0.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -85,4 +85,4 @@ DEPENDENCIES
   sinatra-param-validator!
 
 BUNDLED WITH
-   2.3.13
+   2.3.17

data/README.md

@@ -69,6 +69,9 @@ param :number, Integer, required: true, in: 0..100
 
 All parameters have the following validations available:
 
+* `default`
+  * Set a default value if this parameter was not provided 
+  * This can be a lambda or a proc if required
 * `nillable`
   * If this is set, all other validations are skipped if the value is nil
 * `required`
@@ -118,12 +121,20 @@ with a message, and it will be passed through as an error for the parameter.
 If you need to do further validation with your parameter, the validator can be passed to the block:
 
 ```ruby
-
 param :number, Integer, required: true do |validator|
   validator.param :digit, Integer, min: params[:number]
 end
 ```
 
+If you need to run some code in the route context, you can just use the `block` keyword:
+
+```ruby
+block do |validator|
+  #...
+  validator.param :val, Integer
+end
+```
+
 ## Rules
 
 Rules work on multiple parameters:

data/lib/sinatra/param_validator/parser.rb

@@ -24,9 +24,13 @@ module Sinatra
         @errors[key] = @errors.fetch(key, []).concat(Array(error))
       end
 
-      def param(key, type, message: nil, **args, &block)
+      def block(&block)
+        run_block :block, block
+      end
+
+      def param(key, type, default: nil, message: nil, **args, &block)
         parameter = Parameter.new(@context.params[key], type, **args)
-        @context.params[key] = parameter.coerced if @context.params.key?(key) && parameter.coerced
+        update_params_hash key, parameter, default
         if parameter.valid?
           run_block(key, block) if block
         else
@@ -46,12 +50,22 @@ module Sinatra
         raise 'Invalid rule type'
       end
 
+      private
+
       def run_block(key, block)
         args = block.arity == 1 ? [self] : []
         @context.instance_exec(*args, &block)
       rescue InvalidParameterError => e
         add_error key, e.message
       end
+
+      def update_params_hash(key, parameter, default)
+        if @context.params.key?(key)
+          @context.params[key] = parameter.coerced if parameter.coerced
+        elsif !default.nil?
+          @context.params[key] = default.respond_to?(:call) ? default.call : default
+        end
+      end
     end
   end
 end

data/lib/sinatra/param_validator/validator/form.rb

@@ -5,6 +5,33 @@ module Sinatra
     class Validator
       # A form validator
       class Form < Validator
+        # Helpers for Sinatra templates
+        module Helpers
+          def form_values(hash)
+            hash = IndifferentHash[hash]
+            flash.now[:params] = flash.now.key?(:params) ? hash.merge(flash.now[:params]) : hash
+          end
+
+          def form_value(field)
+            flash[:params]&.fetch(field, nil)
+          end
+
+          def form_error?(field = nil)
+            return !flash[:form_errors].nil? && !flash[:form_errors]&.empty? if field.nil?
+
+            (flash[:form_errors] || {}).key?(field)
+          end
+
+          def form_errors(field)
+            (flash[:form_errors] || {}).fetch(field, [])
+          end
+
+          def invalid_feedback(field, default = nil)
+            fields = Array(field)
+            fields.any? { |f| form_error? f } ? fields.map { |f| form_errors f }.flatten.join('<br />') : default
+          end
+        end
+
         def handle_failure(context)
           case context.request.preferred_type.to_s
           when 'application/json' then return json_failure(context)

data/lib/sinatra/param_validator/version.rb

@@ -2,6 +2,6 @@
 
 module Sinatra
   module ParamValidator
-    VERSION = '0.5.0'
+    VERSION = '0.8.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-param-validator
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Rick Selby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2022-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test