sinatra-param-validator 0.12.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b892596c037b0e00101f33a36c3fef30985e3514e3f0b74d706e55c27e03f921
-  data.tar.gz: 8c6d082dc416b889ca799fb49de1fef7f11af81656c5be29d30f8c191529a4c1
+  metadata.gz: 0635a378cefa1851f127f94720dbcdb8a6abe12093af7fcdafcccb5066c3a10d
+  data.tar.gz: 2a8fe28e566133d4e72aa0188824f184a02984475dc1f79796d3d7a98e914957
 SHA512:
-  metadata.gz: 85089ee9a10e79bd4cf56684e3e63a6487ea6015c093bebd17b720ea52851679790316f0c65bfc4b47bcfe399bc13d4a4c2062127c69c0c1743957663522cc14
-  data.tar.gz: 608f712978969fe990aefa8e2d1c90daa99871d9c9588c86b82fe0ae30873a256f8b27d4c834ad445014c32895a53a626090b32a1993469d8e40dd50bb079191
+  metadata.gz: 4ff032b54cf35d989b81613ee6b965a40a8b18699d183fdeef32c08a5b0d8a520415ec43a270c6b84d288446bae8813fd17a8eb9f1d5c77fcee3ad8b8eb5bb63
+  data.tar.gz: adc4c502ff12a8730598c28c13871ecd52e4c8749bbe4c5ea7b9256727cd3997b9b31152e4d22c3e908ae39eca8c40b236a65ebf8c7e5ff1dfa41fd75b632b7d

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [0.15.0] - 2022-07-19
+
+- Pass message to raised exception
+- Allow rules to run blocks
+
+## [0.14.0] - 2022-07-18
+
+- 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-18
+
+- Capture `InvalidParameterError`s raised when running the parser 
+
 ## [0.12.0] - 2022-07-15
 
 - Switch from a delegator to extending the context

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sinatra-param-validator (0.12.0)
+    sinatra-param-validator (0.15.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,29 @@ 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, &block)
+        rule = Rule.new(name, params, *args, **kwargs)
+        if rule.passes?
+          _run_block(:rules, block) if block
+        else
+          _handle_error :rules, rule.errors unless rule.passes?
+        end
+      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 +43,27 @@ module Sinatra
         validator.run(self, *identifier.args)
         validator.handle_failure(self) unless validator.success?
       end
+
+      def _handle_error(key, error)
+        raise InvalidParameterError, error 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/rule/all_or_none_of.rb

@@ -1,29 +1,18 @@
 # frozen_string_literal: true
 
+require_relative 'common'
+
 module Sinatra
   module ParamValidator
     class Rule
       # Rule to enforce all given params, or none of them
       class AllOrNoneOf
-        attr_reader :errors
-
-        def initialize(params, *fields, **_kwargs)
-          @errors = []
-          @params = params
-          @fields = fields
-
-          validate(fields)
-        end
-
-        def passes?
-          @errors.empty?
-        end
+        include Common
 
-        def validate(fields)
-          count = fields.count { |f| @params.key? f }
-          return if count.zero? || count == fields.count
+        def validate
+          return if count.zero? || count == @fields.count
 
-          @errors.push "All or none of [#{fields.join ', '}] must be provided"
+          @errors.push "All or none of [#{@fields.join ', '}] must be provided"
         end
       end
     end

data/lib/sinatra/param_validator/rule/any_of.rb

@@ -1,27 +1,16 @@
 # frozen_string_literal: true
 
+require_relative 'common'
+
 module Sinatra
   module ParamValidator
     class Rule
       # Rule to enforce at least one of the given params exists
       class AnyOf
-        attr_reader :errors
-
-        def initialize(params, *fields, **_kwargs)
-          @errors = []
-          @params = params
-          @fields = fields
-
-          validate(fields)
-        end
-
-        def passes?
-          @errors.empty?
-        end
+        include Common
 
-        def validate(fields)
-          count = fields.count { |f| @params.key? f }
-          @errors.push "One of [#{fields.join ', '}] must be provided" if count < 1
+        def validate
+          @errors.push "One of [#{@fields.join ', '}] must be provided" if count < 1
         end
       end
     end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sinatra
+  module ParamValidator
+    class Rule
+      # Common validation methods shared between rules
+      module Common
+        attr_reader :errors
+
+        def initialize(params, *fields, **_kwargs)
+          @errors = []
+          @params = params
+          @fields = fields
+
+          validate
+        end
+
+        def count
+          @count ||= (@fields & @params.keys.map(&:to_sym)).count
+        end
+
+        def passes?
+          @errors.empty?
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/param_validator/rule/one_of.rb

@@ -1,28 +1,17 @@
 # frozen_string_literal: true
 
+require_relative 'common'
+
 module Sinatra
   module ParamValidator
     class Rule
       # Rule to enforce only one of the given params has been given
       class OneOf
-        attr_reader :errors
-
-        def initialize(params, *fields, **_kwargs)
-          @errors = []
-          @params = params
-          @fields = fields
-
-          validate(fields)
-        end
-
-        def passes?
-          @errors.empty?
-        end
+        include Common
 
-        def validate(fields)
-          count = fields.count { |f| @params.key? f }
-          @errors.push "Only one of [#{fields.join ', '}] is allowed" if count > 1
-          @errors.push "One of [#{fields.join ', '}] must be provided" if count < 1
+        def validate
+          @errors.push "Only one of [#{@fields.join ', '}] is allowed" if count > 1
+          @errors.push "One of [#{@fields.join ', '}] must be provided" if count < 1
         end
       end
     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.12.0'
+    VERSION = '0.15.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.12.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Rick Selby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-15 00:00:00.000000000 Z
+date: 2022-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
@@ -154,10 +154,10 @@ 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
+- lib/sinatra/param_validator/rule/common.rb
 - lib/sinatra/param_validator/rule/one_of.rb
 - lib/sinatra/param_validator/snake_case.rb
 - lib/sinatra/param_validator/validation_failed_error.rb

data/lib/sinatra/param_validator/parser.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require 'delegate'
-
-require_relative 'invalid_parameter_error'
-require_relative 'parameter'
-require_relative 'rule'
-
-module Sinatra
-  module ParamValidator
-    # Methods to add to the context for handling parameters
-    module ValidatorMethods
-      def _add_error(key, error)
-        @__validator_errors[key] = @__validator_errors.fetch(key, []).concat(Array(error))
-      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
-          _add_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)
-        unless rule.passes?
-          @__validator_errors[:rules] ||= []
-          @__validator_errors[:rules].push(rule.errors)
-        end
-      rescue NameError
-        raise 'Invalid rule type'
-      end
-
-      def _run_block(key, block)
-        args = block.arity == 1 ? [self] : []
-        instance_exec(*args, &block)
-      rescue InvalidParameterError => e
-        _add_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
-
-    # Run the definition in the given scope
-    class Parser
-      attr_reader :errors
-
-      def initialize(context)
-        @context = context
-      end
-
-      def parse(definition, *args)
-        @context.extend(ValidatorMethods)
-        @context.instance_variable_set(:@__validator_errors, {})
-        @context.instance_exec(*args, &definition)
-        @errors = @context.instance_variable_get(:@__validator_errors)
-
-        self
-      end
-    end
-  end
-end