params_ready_rails5 0.0.7

data/lib/params_ready/value/constraint.rb

@@ -0,0 +1,198 @@
+require 'set'
+require_relative '../extensions/undefined'
+require_relative '../extensions/registry'
+require_relative '../error'
+
+module ParamsReady
+  module Value
+
+    class Constraint
+      class Error < ParamsReadyError; end
+
+      extend Extensions::Registry
+      registry :constraint_types, as: :constraint_type, getter: true
+
+      def self.register(name)
+        Constraint.register_constraint_type(name, self)
+      end
+
+      attr_reader :condition
+
+      def initialize(cond)
+        @condition = cond.freeze
+        freeze
+      end
+
+      def clamp?; false; end
+
+      def self.build(cond, *args, **opts, &block)
+        if block.nil?
+          new cond, *args, **opts
+        else
+          new cond, block, *args, **opts
+        end
+      end
+
+      def self.instance(cond, *args, **opts)
+        case cond
+        when Range
+          RangeConstraint.new(cond, *args, **opts)
+        when Array, Set
+          EnumConstraint.new(cond, *args, **opts)
+        else
+          raise ParamsReadyError, "Unknown constraint type: " + cond.class.name
+        end
+      end
+
+      def valid?(input)
+        raise ParamsReadyError, 'This is an abstract class'
+      end
+
+      def error_message
+        "didn't pass validation"
+      end
+    end
+
+    class RangeConstraint < Constraint
+      register :range
+
+      def initialize(cond, *args, **opts)
+        raise ParamsReadyError, "Expected Range, got: " + cond.class.name unless cond.is_a?(Range)
+        super cond, *args, **opts
+      end
+
+      def valid?(input)
+        @condition.include?(input)
+      end
+
+      def error_message
+        'not in range'
+      end
+
+      def clamp(value)
+        if value < @condition.min
+          @condition.min
+        elsif value > @condition.max
+          @condition.max
+        else
+          value
+        end
+      end
+
+      def clamp?
+        return false if @condition.min.nil? || @condition.max.nil?
+
+        true
+      end
+    end
+
+    class EnumConstraint < Constraint
+      register :enum
+
+      def initialize(cond, *args, **opts)
+        raise ParamsReadyError, "Expected Set or Array, got: " + cond.class.name unless
+          cond.is_a?(Set) ||
+          cond.is_a?(Array)
+        super cond, *args, **opts
+      end
+
+      def valid?(input)
+        if input.is_a?(String)
+          @condition.include?(input) || @condition.include?(input.to_sym)
+        else
+          @condition.include?(input)
+        end
+      end
+
+      def error_message
+        'not in enum'
+      end
+    end
+
+    class OperatorConstraint < Constraint
+      register :operator
+
+      OPERATORS = [:=~, :<, :<=, :==, :>=, :>].to_set.freeze
+
+      def initialize(operator, value, *args, **opts)
+        unless OPERATORS.member? operator
+          raise ParamsReadyError, "Unsupported operator: #{operator}"
+        end
+        cond = Condition.instance(operator, value)
+        super(cond, *args, **opts)
+      end
+
+      def clamp(value)
+        return value if valid?(value)
+
+        @condition.clamp(value)
+      end
+
+      def clamp?
+        @condition.clamp?
+      end
+
+      def valid?(input)
+        @condition.true?(input)
+      end
+
+      def error_message
+        @condition.error_message
+      end
+
+      module ClampingCondition
+        CLAMPING_OPERATORS = %i(<= == >=).to_set.freeze
+        def clamp(_)
+          case @operator
+          when :<=, :>=, :==
+            get_value
+          else
+            raise "Unexpected operator: #{@operator}"
+          end
+        end
+
+        def clamp?
+          CLAMPING_OPERATORS.member? @operator
+        end
+      end
+
+      class Condition
+        include ClampingCondition
+
+        def initialize(operator, value)
+          @operator = operator
+          @value = value
+        end
+
+        def true?(input)
+          input.send(@operator, get_value)
+        end
+
+        def error_message
+          "not #{@operator} #{get_value}"
+        end
+
+        def self.instance(operator, value)
+          case value
+          when Method, Proc
+             DynamicCondition.new operator, value
+          else
+             StaticCondition.new operator, value
+          end
+        end
+      end
+
+      class StaticCondition < Condition
+        def get_value
+          @value
+        end
+      end
+
+      class DynamicCondition < Condition
+        def get_value
+          @value.call
+        end
+      end
+    end
+  end
+end

data/lib/params_ready/value/custom.rb

@@ -0,0 +1,56 @@
+require_relative '../parameter/value_parameter'
+
+module ParamsReady
+  module Value
+    class DowncaseStringCoder < StringCoder
+      def self.coerce(value, context)
+        string = super
+        string.downcase
+      end
+    end
+
+    Parameter::ValueParameterBuilder.register_coder :downcase_string, DowncaseStringCoder
+
+    class FormattedDecimalCoder < DecimalCoder
+      EU = /^(\d{1,3}( \d{3})+|\d+),\d{1,2}$/.freeze
+      US = /^(\d{1,3}(,\d{3})+).\d{1,2}$/.freeze
+
+      def self.coerce(value, context)
+        value = if value.is_a? String
+          stripped = value.strip
+          if EU.match? stripped
+            stripped.gsub(/[ ,]/, ' ' => '', ',' => '.')
+          elsif US.match? stripped
+            stripped.delete(',')
+          else
+            stripped
+          end
+        else
+          value
+        end
+        super
+      end
+    end
+
+    Parameter::ValueParameterBuilder.register_coder :formatted_decimal, FormattedDecimalCoder
+
+    class CheckboxBooleanCoder < BooleanCoder
+      def self.format(value, format)
+        return value unless format.marshal? :boolean
+        return value ? 'true' : nil
+      end
+    end
+
+    Parameter::ValueParameterBuilder.register_coder :checkbox_boolean, CheckboxBooleanCoder
+
+    class NonEmptyStringCoder < StringCoder
+      def self.coerce(value, _)
+        return Extensions::Undefined if value.nil? || value.empty?
+
+        super
+      end
+    end
+
+    Parameter::ValueParameterBuilder.register_coder :non_empty_string, NonEmptyStringCoder
+  end
+end

data/lib/params_ready/value/validator.rb

@@ -0,0 +1,81 @@
+require_relative 'constraint'
+
+module ParamsReady
+  module Value
+    class Validator
+      attr_reader :constraint, :strategy
+
+      def self.instance(name_or_constraint, *args, strategy: :raise, **opts, &block)
+        constraint = case name_or_constraint
+        when Value::Constraint
+          name_or_constraint
+        when Symbol
+          type = Value::Constraint.constraint_type(name_or_constraint)
+          type.build(*args, **opts, &block)
+        else
+          valid, missing_method = valid_constraint?(name_or_constraint, strategy)
+          on_constraint_invalid(missing_method) unless valid
+          name_or_constraint
+        end
+        new(constraint, strategy: strategy)
+      end
+
+      def self.on_constraint_invalid(missing_method)
+        raise ParamsReadyError, "Not a valid constraint, '#{missing_method}' unimplemented"
+      end
+
+      def self.valid_constraint?(constraint, strategy)
+        return [false, 'valid?'] unless constraint.respond_to?(:valid?)
+        return [false, 'error_message'] unless constraint.respond_to?(:error_message)
+        return [true, nil] unless strategy == :clamp
+        return [false, 'clamp'] unless constraint.respond_to? :clamp
+
+        [true, nil]
+      end
+
+      def initialize(constraint, strategy: :raise)
+        @constraint = constraint
+        @strategy = check_strategy(constraint, strategy)
+        freeze
+      end
+
+      def check_strategy(constraint, strategy)
+        case strategy.to_sym
+        when :raise, :undefine
+          strategy.to_sym
+        when :clamp
+          if constraint.respond_to? :clamp?
+            raise ParamsReadyError, 'Clamping not applicable' unless constraint.clamp?
+          end
+          strategy.to_sym
+        else
+          raise ParamsReadyError, "Unexpected constraint strategy #{strategy}"
+        end
+      end
+
+      def validate(value, result)
+        return [value, result] if Extensions::Undefined.value_indefinite?(value)
+
+        if constraint.valid? value
+          [value, result]
+        else
+          case strategy
+          when :raise
+            e = Constraint::Error.new("value '#{value}' #{constraint.error_message}")
+            if result.nil?
+              raise e
+            else
+              result.error! e
+            end
+            [Extensions::Undefined, result]
+          when :clamp
+            [constraint.clamp(value), result]
+          else
+            [Extensions::Undefined, result]
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/params_ready/version.rb

@@ -0,0 +1,7 @@
+module ParamsReady
+  VERSION = '0.0.7'.freeze
+
+  def self.gem_version
+    ::Gem::Version.new(VERSION)
+  end
+end

data/lib/params_ready.rb

@@ -0,0 +1,28 @@
+require 'ruby2_keywords'
+require 'arel'
+
+require_relative 'params_ready/parameter/array_parameter'
+require_relative 'params_ready/parameter/struct_parameter'
+require_relative 'params_ready/parameter/enum_set_parameter'
+require_relative 'params_ready/parameter/polymorph_parameter'
+require_relative 'params_ready/parameter/tuple_parameter'
+require_relative 'params_ready/parameter/value_parameter'
+
+require_relative 'params_ready/value/custom'
+require_relative 'params_ready/value/validator'
+
+require_relative 'params_ready/input_context'
+require_relative 'params_ready/output_parameters'
+require_relative 'params_ready/parameter_definer'
+require_relative 'params_ready/parameter_user'
+require_relative 'params_ready/query_context'
+
+require_relative 'params_ready/query/array_grouping'
+require_relative 'params_ready/query/custom_predicate'
+require_relative 'params_ready/query/exists_predicate'
+require_relative 'params_ready/query/fixed_operator_predicate'
+require_relative 'params_ready/query/nullness_predicate'
+require_relative 'params_ready/query/polymorph_predicate'
+require_relative 'params_ready/query/relation'
+require_relative 'params_ready/query/variable_operator_predicate'
+require_relative 'params_ready/version'

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: params_ready_rails5
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Tomas Milsimer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: memory_profiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: "Create well defined controller interfaces. Sanitize, coerce and constrain
+  \nincoming parameters to safely populate data models, hold session state in URI
+  variables \nacross different locations, build SQL queries, apply ordering and offset/keyset
+  pagination.\n"
+email: tomas.milsimer@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/arel/cte_name.rb
+- lib/params_ready.rb
+- lib/params_ready/builder.rb
+- lib/params_ready/error.rb
+- lib/params_ready/extensions/class_reader_writer.rb
+- lib/params_ready/extensions/collection.rb
+- lib/params_ready/extensions/delegation.rb
+- lib/params_ready/extensions/finalizer.rb
+- lib/params_ready/extensions/freezer.rb
+- lib/params_ready/extensions/hash.rb
+- lib/params_ready/extensions/late_init.rb
+- lib/params_ready/extensions/registry.rb
+- lib/params_ready/extensions/undefined.rb
+- lib/params_ready/format.rb
+- lib/params_ready/helpers/arel_builder.rb
+- lib/params_ready/helpers/callable.rb
+- lib/params_ready/helpers/conditional_block.rb
+- lib/params_ready/helpers/find_in_hash.rb
+- lib/params_ready/helpers/interface_definer.rb
+- lib/params_ready/helpers/key_map.rb
+- lib/params_ready/helpers/memo.rb
+- lib/params_ready/helpers/options.rb
+- lib/params_ready/helpers/parameter_definer_class_methods.rb
+- lib/params_ready/helpers/parameter_storage_class_methods.rb
+- lib/params_ready/helpers/parameter_user_class_methods.rb
+- lib/params_ready/helpers/relation_builder_wrapper.rb
+- lib/params_ready/helpers/rule.rb
+- lib/params_ready/helpers/storage.rb
+- lib/params_ready/helpers/usage_rule.rb
+- lib/params_ready/input_context.rb
+- lib/params_ready/intent.rb
+- lib/params_ready/marshaller/array_marshallers.rb
+- lib/params_ready/marshaller/builder_module.rb
+- lib/params_ready/marshaller/collection.rb
+- lib/params_ready/marshaller/definition_module.rb
+- lib/params_ready/marshaller/enum_set_marshallers.rb
+- lib/params_ready/marshaller/parameter_module.rb
+- lib/params_ready/marshaller/polymorph_marshallers.rb
+- lib/params_ready/marshaller/struct_marshallers.rb
+- lib/params_ready/marshaller/tuple_marshallers.rb
+- lib/params_ready/ordering/column.rb
+- lib/params_ready/ordering/ordering.rb
+- lib/params_ready/output_parameters.rb
+- lib/params_ready/pagination/abstract_pagination.rb
+- lib/params_ready/pagination/cursor.rb
+- lib/params_ready/pagination/direction.rb
+- lib/params_ready/pagination/keyset_pagination.rb
+- lib/params_ready/pagination/keysets.rb
+- lib/params_ready/pagination/nulls.rb
+- lib/params_ready/pagination/offset_pagination.rb
+- lib/params_ready/pagination/tendency.rb
+- lib/params_ready/parameter/abstract_struct_parameter.rb
+- lib/params_ready/parameter/array_parameter.rb
+- lib/params_ready/parameter/definition.rb
+- lib/params_ready/parameter/enum_set_parameter.rb
+- lib/params_ready/parameter/parameter.rb
+- lib/params_ready/parameter/polymorph_parameter.rb
+- lib/params_ready/parameter/state.rb
+- lib/params_ready/parameter/struct_parameter.rb
+- lib/params_ready/parameter/tuple_parameter.rb
+- lib/params_ready/parameter/value_parameter.rb
+- lib/params_ready/parameter_definer.rb
+- lib/params_ready/parameter_user.rb
+- lib/params_ready/query/array_grouping.rb
+- lib/params_ready/query/custom_predicate.rb
+- lib/params_ready/query/exists_predicate.rb
+- lib/params_ready/query/fixed_operator_predicate.rb
+- lib/params_ready/query/grouping.rb
+- lib/params_ready/query/join_clause.rb
+- lib/params_ready/query/nullness_predicate.rb
+- lib/params_ready/query/polymorph_predicate.rb
+- lib/params_ready/query/predicate.rb
+- lib/params_ready/query/predicate_operator.rb
+- lib/params_ready/query/relation.rb
+- lib/params_ready/query/structured_grouping.rb
+- lib/params_ready/query/variable_operator_predicate.rb
+- lib/params_ready/query_context.rb
+- lib/params_ready/restriction.rb
+- lib/params_ready/result.rb
+- lib/params_ready/value/coder.rb
+- lib/params_ready/value/constraint.rb
+- lib/params_ready/value/custom.rb
+- lib/params_ready/value/validator.rb
+- lib/params_ready/version.rb
+homepage: https://github.com/lame-impala/params_ready
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Define controller interfaces in Rails
+test_files: []