sinatra-param-validator 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f474d7b6ff2e2ed3de6f58e3bd0ab0b328cc11886ac36701c5a1557a8713e5be
-  data.tar.gz: 378f0b0bb00df8adca7f951175133833d68ce457066f79423aadb52cab1ba6fb
+  metadata.gz: d0704f790d84c6f56cc3f0d68f55ed3bcd95b5fa76fb9d185bb3b5421bb62348
+  data.tar.gz: 352199c3b098d9adb0e1666ee538b373a72afdb13c1cbd62ea686943fc7e4954
 SHA512:
-  metadata.gz: 045a26ac9992b92e1dab3c63527b6ebfd2b70c84b554d20a7f38abfa070f0402da47776d663619c0ae1ff95c681a52ccfb7da34fa2f5c10928c28626c77f75a9
-  data.tar.gz: cefd05d4f4babca139755e05d891802e375732bc944d278a8313e14759e87cd58b300c567e236ccf844897233072ce37e79d9c70f27385babd8b35435008a5c3
+  metadata.gz: 8df45995e8e88d7ead9edfdd8985f2b43a5904e08005f205a815286f2fa0fb36acb98494538f5bb30ee7733db8f8faf061cfc09ce48763f26176538881c9135e
+  data.tar.gz: 03caf360ce521261397eca9558f5dfe8f74df3bd6a3c1932cd5fda802f257f3025199cbd0c8f29098b231ccf6fea982947ff52fc5b19ea5309e746a8e5384293

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [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
+
 ## [0.4.0] - 2022-06-09
 
 - Allow custom error messages to be used when validation fails

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sinatra-param-validator (0.4.0)
+    sinatra-param-validator (0.7.0)
 
 GEM
   remote: https://rubygems.org/

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`
@@ -115,6 +118,23 @@ end
 If you wish to indicate a validation failure within a block, raise `Sinatra::ParameterValidator::InvalidParameterError`
 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:
@@ -149,7 +169,6 @@ post '/new-user', validate_form: :new_user do
   # ...
 end
 
-
 get '/user/:id', validate_url_param: :user_id do
   # ...
 end
@@ -170,8 +189,6 @@ post '/number', validate: vi(:new_user, 10) do
 end
 ```
 
-
-
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.

data/lib/sinatra/param_validator/parameter/common.rb

@@ -9,13 +9,17 @@ module Sinatra
 
         def initialize(value, **options)
           @errors = []
-          @coerced = coerce value
           @options = options
 
+          begin
+            @coerced = coerce value
+          rescue ArgumentError
+            @errors.push "'#{value}' is not a valid #{self.class}"
+            return
+          end
+
           validate_options
           validate unless nil_and_ok?
-        rescue ArgumentError
-          @errors.push "'#{value}' is not a valid #{self.class}"
         end
 
         def valid?

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,11 +50,22 @@ module Sinatra
         raise 'Invalid rule type'
       end
 
+      private
+
       def run_block(key, block)
-        @context.instance_exec(&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/version.rb

@@ -2,6 +2,6 @@
 
 module Sinatra
   module ParamValidator
-    VERSION = '0.4.0'
+    VERSION = '0.7.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-param-validator
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Rick Selby