sinatra-param-validator 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dda1b5487b870b26f4b2ca5c6a575a57c91441ac319b78567295ab0b4517a8bc
-  data.tar.gz: 331f3cace8d87a35fa410ae28c3df15e07f851d276ad2a2173ce799572cfae04
+  metadata.gz: 54d6ed44b4046ecc9fd330aef4e719cbe10d4a953a8d07a80226822f59ed66d7
+  data.tar.gz: e70164b07f23972aeffa920719c6de35baff4576eed46260944daf3a1b5e404b
 SHA512:
-  metadata.gz: caceb492da8562135850ecf1c7a77ecd4fd850ab31d714ff1fa555c4316e63074aa7ed9f75e331336ddf30c1921a5d3cc2f895447d7ec76f3767b46448e6a7c4
-  data.tar.gz: 729686317687d72ff23ce570991a88e6731314320f3e702ba631c7452b75e117997fc30207c2cee7be52c1aa458424311666b734061bb7c3aefb6911b07a9dc2
+  metadata.gz: d4d54fc8f4d76d1499d9c15adec02e35ff2f7c36bf99f5606d15b60a579e45da1c0905624c12be5e4a01b645670a5f23603191cf87fd6be0fd3541c1f94f6afb
+  data.tar.gz: c1c40e3b72dcb644adaf9437b0b7b67cfec8e33efad17ded176b74f3d6cf942fd76d3e4b7bf47f11442ebbb279d08907678e7600813b0b8da37c13736e0fdef4

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 ## [Unreleased]
 
+## [0.3.0] - 2022-06-08
+
+- Don't create entries in `params` for parameters that are not passed
+- Don't set validator type during definition
+- Add unique validator conditionals for each validator:
+  - validate
+  - validate_form
+  - validate_url_param
+
+## [0.2.0] - 2022-06-08
+
+- Add validators:
+  - Standard
+  - URL Parameter
+  - Form
+- Add parameters:
+  - Array
+  - Boolean
+  - Date
+  - Float
+  - Hash
+  - Integer
+  - String
+  - Time
+- Add rules:
+  - All or none of
+  - Any of
+  - One of
+
 ## [0.1.0] - 2022-05-16
 
 - Initial release

data/Gemfile.lock

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

data/README.md

@@ -15,7 +15,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Sample Usage
 
 ```ruby
-validator identifier: :user_id do
+validator :user_id do
   param :id, Integer, required: true
 end
 
@@ -23,7 +23,7 @@ get '/user/:id', validate: :user_id do
   # ...
 end
 
-validator identifier: :new_user do
+validator :new_user do
   param :name, String, required: true
   param :age, Integer, required: true, min: 0 
 end
@@ -113,12 +113,16 @@ There are two other provided validators, that handle failure differently:
   * will provide a JSON object with errors to an XHR request
   * will `halt 400`
 
-These validators can be set when a validator is defined:
+These validators can be invoked with a different conditional on the route:
 
 ```ruby
-validator type: :form, identifier: :new_user do
-  param :name, String, required: true
-  param :age, Integer, required: true, min: 0 
+post '/new-user', validate_form: :new_user do
+  # ...
+end
+
+
+get '/user/:id', validate_url_param: :user_id do
+  # ...
 end
 ```
 

data/lib/sinatra/param_validator/helpers.rb

@@ -13,8 +13,9 @@ module Sinatra
         raise "Filter params failed: #{e}"
       end
 
-      def validate(identifier, args = {})
-        validator = settings.validator_definitions.get(identifier)
+      def validate(klass, identifier, args = {})
+        definition = settings.validator_definitions.get(identifier)
+        validator = klass.new(&definition)
         validator.run(self, *args)
         validator.handle_failure(self) unless validator.success?
       end

data/lib/sinatra/param_validator/parser.rb

@@ -21,7 +21,7 @@ module Sinatra
 
       def param(key, type, **args)
         parameter = Parameter.new(@context.params[key], type, **args)
-        @context.params[key] = parameter.coerced
+        @context.params[key] = parameter.coerced if @context.params.key? key
         @errors[key] = parameter.errors unless parameter.valid?
       rescue NameError
         raise 'Invalid parameter type'

data/lib/sinatra/param_validator/snake_case.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Sinatra
+  module ParamValidator
+    # Helpers for validating parameters
+    module SnakeCase
+      def snake_case(string)
+        string.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
+      end
+    end
+  end
+end

data/lib/sinatra/param_validator/validator.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'validation_failed_error'
-require_relative 'validator/form'
-require_relative 'validator/url_param'
-
 module Sinatra
   module ParamValidator
     # Definition of a single validator
@@ -26,6 +22,21 @@ module Sinatra
       def success?
         @errors.empty?
       end
+
+      @validators = []
+
+      class << self
+        attr_reader :validators
+
+        def inherited(subclass)
+          super
+          @validators << subclass
+        end
+      end
     end
   end
 end
+
+require_relative 'validation_failed_error'
+require_relative 'validator/form'
+require_relative 'validator/url_param'

data/lib/sinatra/param_validator/version.rb

@@ -2,6 +2,6 @@
 
 module Sinatra
   module ParamValidator
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/sinatra/param_validator.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'param_validator/camelize'
 require_relative 'param_validator/definitions'
 require_relative 'param_validator/helpers'
 require_relative 'param_validator/parser'
+require_relative 'param_validator/snake_case'
 require_relative 'param_validator/validator'
 require_relative 'param_validator/version'
 
@@ -11,19 +13,29 @@ module Sinatra
   module ParamValidator
     include Camelize
 
-    def validator(identifier:, type: nil, &definition)
-      class_name = 'Sinatra::ParamValidator::Validator'
-      class_name = "#{class_name}::#{camelize(type)}" unless type.nil?
-      settings.validator_definitions.add(identifier, Object.const_get(class_name).new(&definition))
+    def validator(identifier, &definition)
+      settings.validator_definitions.add(identifier, definition)
     end
 
-    def self.registered(app)
-      app.helpers Helpers
-      app.before { filter_params }
-      app.set(:validator_definitions, Definitions.new)
-      app.set(:validate) do |*identifiers|
-        condition do
-          identifiers.each { |identifier| validate identifier }
+    class << self
+      include SnakeCase
+
+      def registered(app)
+        app.helpers Helpers
+        app.before { filter_params }
+        app.set(:validator_definitions, Definitions.new)
+        validator_conditional app, :validate, Sinatra::ParamValidator::Validator
+
+        Sinatra::ParamValidator::Validator.validators.each do |validator|
+          validator_conditional app, :"validate_#{snake_case(validator.to_s.split('::').last)}", validator
+        end
+      end
+
+      def validator_conditional(app, name, klass)
+        app.set(name) do |*identifiers|
+          condition do
+            identifiers.each { |identifier| validate klass, identifier }
+          end
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-param-validator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rick Selby
@@ -157,6 +157,7 @@ files:
 - lib/sinatra/param_validator/rule/all_or_none_of.rb
 - lib/sinatra/param_validator/rule/any_of.rb
 - lib/sinatra/param_validator/rule/one_of.rb
+- lib/sinatra/param_validator/snake_case.rb
 - lib/sinatra/param_validator/validation_failed_error.rb
 - lib/sinatra/param_validator/validator.rb
 - lib/sinatra/param_validator/validator/form.rb