sinatra-param-validator 0.11.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b9804f13269515b113bb73dfe65c20304145df75e20d00f41ed0c231d6fd99e
-  data.tar.gz: c0c522b2ad74c5c376a302ca4b9d141f981df498e42239fc1baa45baaab77e70
+  metadata.gz: 2f94e83b8a50e45743393eff54f46c692095fbad50942f68e047713b55397512
+  data.tar.gz: 1394c62c964ad2e4bc51dbd44abf98313757babbbe13748c09f32dc2a2e8863d
 SHA512:
-  metadata.gz: 321cd999434f06ed80943b059aabe476745981d84f0446a247691fea1e836cbdbb011ce8adabe3278f43c5ecfc248f59b603f39aa187e332188531d1030130f0
-  data.tar.gz: e7a9052b36681fe7f84e5b6b519f04db2ea915008511a23027ffa7c0134d9458e9df08b3f356507d149eda4f63c2ea4773c63dbb0acf90f9014a99c3d7a38635
+  metadata.gz: '09cd666c97ce8ffd0750361ca52cfa04b2687351bd4db39918ba6d393ce476917943a16311817cddd50507939978687a4820d8aeb2fbda130dfd64d01a12ac72'
+  data.tar.gz: 2589470cf72e955854bc68ade46b6ccb1ddf2a5e9d1a7ad142e3fcfa5a2f714aa547b850090ee26caec29d33bf3d8c5b476809cb6ef392e3dad20222588bd6b9

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.14.0] - 2022-07-15
+
+- Fix parameter coercion if a parameter is validated multiple times
+- Refactor `param` and `rule` functions into helpers
+- Allow `param` and `rule` to be run independently
+
+## [0.13.0] - 2022-07-15
+
+- Capture `InvalidParameterError`s raised when running the parser 
+
+## [0.12.0] - 2022-07-15
+
+- Switch from a delegator to extending the context
+
 ## [0.11.0] - 2022-07-15
 
 - Fix setting param values to false

data/Gemfile.lock

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

data/lib/sinatra/param_validator/helpers.rb

@@ -13,6 +13,25 @@ module Sinatra
         raise "Filter params failed: #{e}"
       end
 
+      def param(key, type, default: nil, message: nil, **args, &block)
+        parameter = Parameter.new(params[key], type, **args)
+        _update_params_hash key, parameter, default
+        if parameter.valid?
+          _run_block(key, block) if block
+        else
+          _handle_error key, message || parameter.errors
+        end
+      rescue NameError
+        raise 'Invalid parameter type'
+      end
+
+      def rule(name, *args, **kwargs)
+        rule = Rule.new(name, params, *args, **kwargs)
+        _handle_error :rules, rule.errors unless rule.passes?
+      rescue NameError
+        raise 'Invalid rule type'
+      end
+
       def validate(klass, identifier)
         identifier = Identifier.new(identifier) if identifier.is_a? Symbol
         definition = settings.validator_definitions.get(identifier.identifier)
@@ -20,6 +39,27 @@ module Sinatra
         validator.run(self, *identifier.args)
         validator.handle_failure(self) unless validator.success?
       end
+
+      def _handle_error(key, error)
+        raise InvalidParameterError unless defined? @_validator_errors
+
+        @_validator_errors[key] = @_validator_errors.fetch(key, []).concat(Array(error))
+      end
+
+      def _run_block(key, block)
+        args = block.arity == 1 ? [self] : []
+        instance_exec(*args, &block)
+      rescue InvalidParameterError => e
+        _handle_error key, e.message
+      end
+
+      def _update_params_hash(key, parameter, default)
+        if params.key?(key)
+          params[key] = parameter.coerced unless parameter.coerced.nil?
+        elsif !default.nil?
+          params[key] = default.respond_to?(:call) ? default.call : default
+        end
+      end
     end
   end
 end

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

@@ -15,6 +15,7 @@ module Sinatra
 
         def coerce(value)
           return nil if value.nil?
+          return value if value.is_a? ::Date
 
           ::Date.parse(value)
         end

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

@@ -14,6 +14,7 @@ module Sinatra
 
         def coerce(value)
           return nil if value.nil?
+          return value if value.is_a? ::Integer
 
           Integer(value, 10)
         end

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

@@ -15,6 +15,7 @@ module Sinatra
 
         def coerce(value)
           return nil if value.nil?
+          return value if value.is_a? ::Time
 
           ::Time.parse(value)
         end

data/lib/sinatra/param_validator/validator.rb

@@ -16,7 +16,11 @@ module Sinatra
       end
 
       def run(context, *args)
-        @errors = Parser.new(context).parse(@definition, *args).errors
+        context.instance_variable_set(:@_validator_errors, {})
+        context.instance_exec(*args, &@definition)
+        @errors = context.remove_instance_variable(:@_validator_errors)
+      rescue InvalidParameterError => e
+        @errors[:general] = [e.message]
       end
 
       def success?

data/lib/sinatra/param_validator/version.rb

@@ -2,6 +2,6 @@
 
 module Sinatra
   module ParamValidator
-    VERSION = '0.11.0'
+    VERSION = '0.14.0'
   end
 end

data/lib/sinatra/param_validator.rb

@@ -4,7 +4,9 @@ require_relative 'param_validator/camelize'
 require_relative 'param_validator/definitions'
 require_relative 'param_validator/helpers'
 require_relative 'param_validator/identifier'
-require_relative 'param_validator/parser'
+require_relative 'param_validator/invalid_parameter_error'
+require_relative 'param_validator/parameter'
+require_relative 'param_validator/rule'
 require_relative 'param_validator/snake_case'
 require_relative 'param_validator/validator'
 require_relative 'param_validator/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-param-validator
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Rick Selby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-15 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
@@ -154,7 +154,6 @@ files:
 - lib/sinatra/param_validator/parameter/integer.rb
 - lib/sinatra/param_validator/parameter/string.rb
 - lib/sinatra/param_validator/parameter/time.rb
-- lib/sinatra/param_validator/parser.rb
 - lib/sinatra/param_validator/rule.rb
 - lib/sinatra/param_validator/rule/all_or_none_of.rb
 - lib/sinatra/param_validator/rule/any_of.rb

data/lib/sinatra/param_validator/parser.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'delegate'
-
-require_relative 'invalid_parameter_error'
-require_relative 'parameter'
-require_relative 'rule'
-
-module Sinatra
-  module ParamValidator
-    # Run the definition in the given scope
-    class Parser < SimpleDelegator
-      attr_reader :errors
-
-      def initialize(context)
-        super(context)
-        @context = context
-        @errors = {}
-      end
-
-      def parse(definition, *args)
-        instance_exec(*args, &definition)
-
-        self
-      end
-
-      def add_error(key, error)
-        @errors[key] = @errors.fetch(key, []).concat(Array(error))
-      end
-
-      def param(key, type, default: nil, message: nil, **args, &block)
-        parameter = Parameter.new(@context.params[key], type, **args)
-        update_params_hash key, parameter, default
-        if parameter.valid?
-          run_block(key, block) if block
-        else
-          add_error key, message || parameter.errors
-        end
-      rescue NameError
-        raise 'Invalid parameter type'
-      end
-
-      def rule(name, *args, **kwargs)
-        rule = Rule.new(name, @context.params, *args, **kwargs)
-        unless rule.passes?
-          @errors[:rules] ||= []
-          @errors[:rules].push(rule.errors)
-        end
-      rescue NameError
-        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 unless parameter.coerced.nil?
-        elsif !default.nil?
-          @context.params[key] = default.respond_to?(:call) ? default.call : default
-        end
-      end
-    end
-  end
-end