pastore 0.0.4 → 0.2.0

data/lib/pastore/params/validations/number_validation.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Pastore
+  module Params
+    # Implements the validation logic for number parameters.
+    class NumberValidation < Validation
+      def initialize(name, value, modifier, **options)
+        @min          = options[:min]
+        @max          = options[:max]
+        @clamp        = options[:clamp] || [-Float::INFINITY, Float::INFINITY]
+
+        super(name, 'number', value, modifier, **options)
+      end
+
+      private
+
+      def validate!
+        # check for value presence and if it's allowed to be blank
+        check_presence!
+
+        # don't go further if value is blank
+        return if value.to_s.strip == ''
+
+        # check if value is a number
+        # check if number is between min and max
+        # check if value is within specified clamping range, and correct if necessary
+        return unless check_if_number! && check_min_max! && check_clamp!
+
+        # check if value is in the list of allowed values
+        check_allowed_values!
+
+        # apply the modifier
+        apply_modifier!
+      end
+
+      def check_if_number!
+        return true if value.is_a?(Integer) || value.is_a?(Float)
+
+        if value.is_a?(String) && numeric?
+          @value = value.to_f
+          @value = value.to_i if value.modulo(1).zero?
+
+          return true
+        end
+
+        add_error(:invalid_type, "#{@name} has invalid type: #{@type} expected")
+
+        false
+      end
+
+      def check_min_max!
+        min_invalid = @min && value < @min
+        max_invalid = @max && value > @max
+
+        add_error(:too_small, "#{@name} should be greater than #{@min}") if min_invalid
+        add_error(:too_large, "#{@name} should be smaller than #{@max}") if max_invalid
+
+        min_invalid || max_invalid ? false : true
+      end
+
+      def check_clamp!
+        @value = @value.clamp(@clamp.first || -Float::INFINITY, @clamp.last || Float::INFINITY)
+      end
+    end
+  end
+end

data/lib/pastore/params/validations/object_validation.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Pastore
+  module Params
+    # Implements the validation logic for object parameters.
+    class ObjectValidation < Validation
+      def initialize(name, value, modifier, **options)
+        super(name, 'object', value, modifier, **options)
+      end
+
+      private
+
+      def validate!
+        # check for value presence and if it's allowed to be blank
+        check_presence!
+
+        # don't go further if value is blank
+        return if value.to_s.strip == ''
+
+        # check if value is a boolean
+        return unless check_if_object!
+
+        # check if value is in the list of allowed values
+        check_allowed_values!
+
+        # apply the modifier
+        apply_modifier!
+      end
+
+      def check_if_object!
+        return true if [Hash, HashWithIndifferentAccess, ActionController::Parameters, Array].include?(value.class)
+
+        # When value is a string, try to parse it as JSON
+        if value.is_a?(String)
+          begin
+            @value = JSON.parse(value)
+            return true
+          rescue JSON::ParserError
+            # Do nothing
+          end
+        end
+
+        add_error(:invalid_type, "#{@name} has invalid type: #{@type} expected")
+
+        false
+      end
+    end
+  end
+end

data/lib/pastore/params/validations/string_validation.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Pastore
+  module Params
+    # Implements the validation logic for string parameters.
+    class StringValidation < Validation
+      def initialize(name, value, modifier, **options)
+        @format = options[:format]
+
+        super(name, 'string', value, modifier, **options)
+      end
+
+      private
+
+      def validate!
+        # check for value presence and if it's allowed to be blank
+        check_presence!
+
+        # don't go further if value is blank
+        return if value.to_s.strip == ''
+
+        # check if value is a string
+        return unless check_if_string! && check_format!
+
+        # check if value is in the list of allowed values
+        check_allowed_values!
+
+        # apply the modifier
+        apply_modifier!
+      end
+
+      def check_if_string!
+        return true if value.is_a?(String)
+
+        @value = @value.to_s
+
+        true
+      end
+
+      # Check if the value matches the specified format
+      def check_format!
+        return true if @format.nil?
+
+        add_error(:invalid_format, "#{@name} has invalid format") if value.match(@format).nil?
+
+        true
+      end
+    end
+  end
+end

data/lib/pastore/params.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require_relative 'params/settings'
+
+module Pastore
+  # Implements the features for Rails controller params validation.
+  module Params
+    class ParamAlreadyDefinedError < StandardError; end
+    class ScopeConflictError < StandardError; end
+    class InvalidValidationTypeError < StandardError; end
+    class InvalidParamTypeError < StandardError; end
+    class InvalidValueError < StandardError; end
+
+    extend ActiveSupport::Concern
+
+    included do
+      before_action do
+        pastore_params = self.class.pastore_params
+        validation_errors = pastore_params.validate(params, action_name)
+        next if validation_errors.empty?
+
+        if pastore_params.invalid_params_cbk.present?
+          instance_eval(&pastore_params.invalid_params_cbk)
+          response.status = pastore_params.response_status
+        else
+          render json: { message: 'Unprocessable Entity', errors: validation_errors }, status: pastore_params.response_status
+        end
+      end
+    end
+
+    # Implement Pastore::Params class methods
+    module ClassMethods
+      attr_accessor :_pastore_params
+
+      def pastore_params
+        self._pastore_params ||= Settings.new(superclass)
+      end
+
+      def on_invalid_params(&block)
+        pastore_params.invalid_params_cbk = block
+      end
+
+      def invalid_params_status(status)
+        pastore_params.response_status = status
+      end
+
+      def param(name, **options)
+        pastore_params.add(name, **options)
+      end
+
+      def scope(*keys, &block)
+        return unless block_given?
+
+        pastore_params.set_scope(*keys)
+        block.call
+        pastore_params.reset_scope!
+      end
+
+      def method_added(name, *args, &block)
+        pastore_params.save_for(name)
+        super
+      end
+    end
+  end
+end

data/lib/pastore/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pastore
-  VERSION = '0.0.4'
+  VERSION = '0.2.0'
 end

data/lib/pastore.rb

@@ -2,7 +2,7 @@
 
 require_relative 'pastore/version'
 require_relative 'pastore/guards'
-require_relative 'pastore/params_validators'
+require_relative 'pastore/params'
 
 module Pastore
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pastore
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Groza Sergiu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-02 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -42,6 +42,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".vscode/launch.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -49,10 +50,20 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docs/Guards.md
+- docs/Params.md
 - lib/pastore.rb
 - lib/pastore/guards.rb
 - lib/pastore/guards/settings.rb
-- lib/pastore/params_validators.rb
+- lib/pastore/params.rb
+- lib/pastore/params/action_param.rb
+- lib/pastore/params/settings.rb
+- lib/pastore/params/validation.rb
+- lib/pastore/params/validations/boolean_validation.rb
+- lib/pastore/params/validations/date_validation.rb
+- lib/pastore/params/validations/number_validation.rb
+- lib/pastore/params/validations/object_validation.rb
+- lib/pastore/params/validations/string_validation.rb
 - lib/pastore/version.rb
 homepage: https://github.com/demetra-it/pastore
 licenses:

data/lib/pastore/params_validators.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Pastore
-  # Implements the features for Rails controller params validation.
-  module ParamsValidators
-  end
-end