easy_params 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5a19f19d20a42ef6a6ba3e606298c3dbf696a22c9dcdc9e42a8ffe48e1e67db
-  data.tar.gz: fce70967d59989d5e650289483d5437f4ebb80793d49b3a446d252796017117c
+  metadata.gz: 8a23a79fb06b0d9c02b836dc314e420f1339b20473d740f4427a6f1a9e740efe
+  data.tar.gz: e1ddbee8e7b5aa08fb3e9f1f2dc925ecc179a8f95ac3276e2aeb839f7e3cbe9d
 SHA512:
-  metadata.gz: 3f690f1a17df11da94e8f707c99f97854aec48ca890320c0345159286c4e10ac19448a5b3a6557936c6076b4bf4e886cd51841ef394b3a205c91626a680b598f
-  data.tar.gz: c43521492ce73961d7ff7fb562ba7b8ba944f03c928a8c68298f8f6f168c21ab698d4acdf3fe2dd073296bec99418cf14adffd8446cc751541b32136b452e972
+  metadata.gz: 9a9968cc2201493bd774562cc9590d47537b870238ac5b64b33167c9b084feb14c067b6b4ee9a36f54abdff18a198c8d99474b8dc531fab45ebbffd61ae08c11
+  data.tar.gz: 11d7e883cc4a229c14b9323e94f8372e2f38d2c238e883884c2fe733bab4918be6ad62c13da09621fbb0e8b5b85405d7d2d9cb8197abc3cbf0d762b6657c2a7d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easy_params (0.3.0)
+    easy_params (0.4.0)
       activemodel (>= 3.2, < 8)
       dry-struct (~> 1.4)
       dry-types (~> 1.5)
@@ -9,46 +9,55 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activesupport (7.0.4.3)
+    activemodel (7.1.2)
+      activesupport (= 7.1.2)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     diff-lcs (1.4.4)
     docile (1.3.5)
-    dry-configurable (0.14.0)
+    drb (2.2.0)
+      ruby2_keywords
+    dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.6)
-    dry-container (0.9.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.13, >= 0.13.0)
-    dry-core (0.7.1)
-      concurrent-ruby (~> 1.0)
-    dry-inflector (0.3.0)
-    dry-logic (1.2.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5)
-    dry-struct (1.4.0)
-      dry-core (~> 0.5, >= 0.5)
-      dry-types (~> 1.5)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-struct (1.6.0)
+      dry-core (~> 1.0, < 2)
+      dry-types (>= 1.7, < 2)
       ice_nine (~> 0.11)
-    dry-types (1.5.1)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.2)
+      bigdecimal (~> 3.0)
       concurrent-ruby (~> 1.0)
-      dry-container (~> 0.3)
-      dry-core (~> 0.5, >= 0.5)
-      dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 1.0, >= 1.0.2)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
     json (2.6.3)
     method_source (1.0.0)
-    minitest (5.18.1)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
@@ -89,6 +98,7 @@ GEM
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -98,6 +108,7 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   ruby

data/README.md

@@ -51,10 +51,10 @@ end
 Validation messages for nested attributes will look like this.
 ```ruby
 {
-  :"sections/0/id"=>an_instance_of(Array),
-  :"sections/0/post/id"=>an_instance_of(Array),
-  :"post/id"=>an_instance_of(Array),
-  :"post/sections/0/id"=>an_instance_of(Array)
+  :"sections[0].id"=>an_instance_of(Array),
+  :"sections[0].post.id"=>an_instance_of(Array),
+  :"post.id"=>an_instance_of(Array),
+  :"post.sections[0].id"=>an_instance_of(Array)
  }
 ```
 Optionally you can use more compact form

data/lib/easy_params/base.rb

@@ -11,55 +11,93 @@ module EasyParams
       'EasyParams::Base'
     end
 
-    %w[Integer Decimal Float Bool String Array Date DateTime Time Struct StructDSL].each do |type|
-      send(:define_singleton_method, type.underscore) { EasyParams::Types.const_get(type) }
-    end
-
     validate do
       validate_nested
     end
 
+    # %w[Integer Decimal Float Bool String Date DateTime Time Array Struct StructDSL].each do |type|
+    %w[Integer Decimal Float Bool String Date DateTime Time].each do |type_name|
+      send(:define_singleton_method, type_name.underscore) do |param_name, default: nil, normalize: nil, **validations|
+        type = EasyParams::Types.const_get(type_name)
+        type = type.default(default) if default
+        type = type.constructor { |value| value == Dry::Types::Undefined ? value : normalize.call(value) } if normalize
+        validates param_name, **validations if validations.any?
+        public_send(:attribute, param_name, type)
+      end
+    end
+
+    def self.each(param_name, normalize: nil, **validations, &block)
+      validates param_name, **validations if validations.any?
+      type = EasyParams::Types::Each
+      type = type.constructor { |value| value == Dry::Types::Undefined ? value : normalize.call(value) } if normalize
+      public_send(:attribute, param_name, type, &block)
+    end
+
+    def self.has(param_name, normalize: nil, **validations, &block)
+      validates param_name, **validations if validations.any?
+      type = EasyParams::Types::Struct
+      type = type.constructor { |value| value == Dry::Types::Undefined ? value : normalize.call(value) } if normalize
+      public_send(:attribute, param_name, type, &block)
+    end
+
+    def self.array(param_name, of:, normalize: nil, **validations, &block)
+      validates param_name, **validations if validations.any?
+      of_type = EasyParams::Types.const_get(of.to_s.camelcase)
+      type = EasyParams::Types::Array
+      type = type.constructor { |value| value == Dry::Types::Undefined ? value : normalize.call(value) } if normalize
+      public_send(:attribute, param_name, type.of(of_type), &block)
+    end
+
+    def self.param(method_name, type_name, of: nil, default: nil, **validations, &block)
+      type = EasyParams::Types.const_get(type_name.to_s.camelcase)
+      type = type.default(default) if default
+      type = type.of(EasyParams::Types.const_get(of.to_s.camelcase)) if of && type_name != :each
+      validates method_name, **validations if validations.any?
+      public_send(:attribute, method_name, type, &block)
+    end
+
     private
 
     def validate_nested
-      attributes.each(&run_nested_validations)
+      attributes.each do |_, value|
+        case value
+        when *EasyParams::Types::ARRAY_OF_STRUCTS_TYPES_LIST
+          value.each(&:valid?)
+        when *EasyParams::Types::STRUCT_TYPES_LIST
+          value.valid?
+        end
+      end
+      attributes.each(&aggregate_nested_errors)
     end
 
-    def run_nested_validations
+    def aggregate_nested_errors
       proc do |attr_name, value, array_index, error_key_prefix|
         case value
-        when Array
+        when *EasyParams::Types::ARRAY_OF_STRUCTS_TYPES_LIST
           value.each.with_index do |element, i|
-            run_nested_validations[attr_name, element, i, error_key_prefix]
+            aggregate_nested_errors[attr_name, element, "[#{i}]", error_key_prefix]
           end
-        when self.class.struct
-          handle_struct_validation(value, error_key_prefix, attr_name, array_index)
+        when *EasyParams::Types::STRUCT_TYPES_LIST
+          handle_nested_errors(value, error_key_prefix, attr_name, array_index)
         end
       end
     end
 
-    def handle_struct_validation(value, error_key_prefix, attr_name, array_index)
-      if value.invalid?
-        error_key_components = [error_key_prefix, attr_name, array_index]
-        attr_error_key_prefix = error_key_components.compact.join('/')
-        add_errors_on_top_level(value, attr_error_key_prefix)
-      end
-      value.attributes.each do |nested_attr_name, nested_value|
-        run_nested_validations[nested_attr_name, nested_value, nil, attr_error_key_prefix]
-      end
+    def handle_nested_errors(value, error_key_prefix, attr_name, array_index)
+      return if value.errors.blank?
+
+      error_key_components = [error_key_prefix, attr_name, array_index]
+      attr_error_key_prefix = error_key_components.compact.join('.').gsub(/\.\[(\d+)\]/, '[\1]')
+      add_errors_on_top_level(value, attr_error_key_prefix)
     end
 
     if defined? ActiveModel::Error
       def add_errors_on_top_level(value, attr_error_key_prefix)
-        value.errors.each do |error|
-          next unless error.options[:message]
-
-          errors.add("#{attr_error_key_prefix}/#{error.attribute}", error.options[:message])
-        end
+        value.errors.each { |error| errors.add("#{attr_error_key_prefix}.#{error.attribute}", error.message) }
       end
     else
       def add_errors_on_top_level(value, attr_error_key_prefix)
-        value.errors.each { |key, message| errors.add("#{attr_error_key_prefix}/#{key}", message) }
+        value.errors.each { |key, message| errors.add("#{attr_error_key_prefix}.#{key}", message) }
       end
     end
   end

data/lib/easy_params/types.rb

@@ -3,15 +3,19 @@
 module EasyParams
   module Types
     Struct    = EasyParams::Base.meta(omittable: true)
-    StructDSL = ::Class.new(EasyParams::Base).extend(EasyParams::DSL).meta(omittable: true)
+    Has       = EasyParams::Base.meta(omittable: true)
     Integer   = Dry::Types['params.integer'].optional.meta(omittable: true).default(nil)
     Decimal   = Dry::Types['params.decimal'].optional.meta(omittable: true).default(nil)
     Float     = Dry::Types['params.float'].optional.meta(omittable: true).default(nil)
-    Bool      = Dry::Types['strict.bool'].optional.meta(omittable: true).default(nil)
+    Bool      = Dry::Types['params.bool'].optional.meta(omittable: true).default(nil)
     String    = Dry::Types['string'].optional.meta(omittable: true).default(nil)
-    Array     = Dry::Types['array'].of(Struct).meta(omittable: true).default([])
+    Array     = Dry::Types['array'].meta(omittable: true).default([])
+    Each      = Dry::Types['array'].of(Struct).meta(omittable: true).default([])
     Date      = Dry::Types['params.date'].optional.meta(omittable: true).default(nil)
     DateTime  = Dry::Types['params.date_time'].optional.meta(omittable: true).default(nil)
     Time      = Dry::Types['params.time'].optional.meta(omittable: true).default(nil)
+
+    STRUCT_TYPES_LIST = [Struct, Has].freeze
+    ARRAY_OF_STRUCTS_TYPES_LIST = [Array.of(Struct), Each].freeze
   end
 end

data/lib/easy_params/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EasyParams
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/easy_params.rb

@@ -4,7 +4,6 @@ require 'dry-struct'
 require 'dry-types'
 require 'active_model'
 require 'easy_params/base'
-require 'easy_params/dsl'
 require 'easy_params/types'
 require 'easy_params/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_params
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrii Baran
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-24 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -82,7 +82,6 @@ files:
 - easy_params.gemspec
 - lib/easy_params.rb
 - lib/easy_params/base.rb
-- lib/easy_params/dsl.rb
 - lib/easy_params/types.rb
 - lib/easy_params/version.rb
 homepage: https://github.com/andriy-baran/easy_params

data/lib/easy_params/dsl.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module EasyParams
-  # Makes definition more compact
-  # Do not use if your attributes have name like
-  # integer, decimal, float, bool, string, array, date, datetime, time, struct
-  module DSL
-    def each(&block)
-      array.of(struct_dsl, &block)
-    end
-
-    def has(&block)
-      struct_dsl(&block)
-    end
-
-    def method_missing(method_name, *args, &block)
-      public_send(:attribute, method_name, *args, &block)
-    end
-
-    def respond_to_missing?(*)
-      true
-    end
-  end
-end