easy_params 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e5797272eae09e65c24f46558c801f19126e71e4ca940bdfaeecfaab478fe7d
-  data.tar.gz: 95d1a80d4f0635013658713c6dccc45058e707cae9e90ec88036313c673819ee
+  metadata.gz: a707b8082dc9c58012a4b8f93c93d2c8543b3ee85d96f64d972b9a074b3bed29
+  data.tar.gz: 2d0a8eeea15d0418f91c4fb48e128d1f965db24773a81a9ac4f23d6c2b01500e
 SHA512:
-  metadata.gz: 1e76c8c64f7568d0ef3633eb3ca86a1cf1f03f331d528aa7a941c8197a2030dbbeb3fc77149b7dd0416b4776b3a8b547a6e0c451a6e1c3af92835b25e2d6815c
-  data.tar.gz: 82f361cf4ebce4db3ab3bbc9fd7ca196a3dc57a91c3156df1b2e18d443922a900998f58c43b5a12571346de047c1f9e803ad45e109dcb32c028840c44ebf0681
+  metadata.gz: 941a6c062c86638aa540eba6ac2fc697ba9177b7521c344bed4ae71b88747b5419c1c8b15cf44da9d5dea5098bf6a6de910125173bdfa75cb4838f353f28caec
+  data.tar.gz: 7a07ba572c6fe6890368b7b1b0458cf934ee07953e4bd84a60728945c5f852d2a8206fe0e6cf83b70be343dda5683927b9e29d49292cb8181461ffa567611cb9

data/.ruby-version

@@ -0,0 +1 @@
+3.4.1

data/Gemfile

@@ -5,6 +5,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in easy_params.gemspec
 gemspec
 
+gem 'ostruct'
 gem 'pry'
 gem 'rake', '~> 12.0'
 gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -1,96 +1,111 @@
 PATH
   remote: .
   specs:
-    easy_params (0.5.0)
+    easy_params (0.6.1)
       activemodel (>= 3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.1.3)
-      activesupport (= 7.1.3)
-    activesupport (7.1.3)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activesupport (8.0.2)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.6)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
     coderay (1.1.3)
-    concurrent-ruby (1.2.3)
-    connection_pool (2.4.1)
-    diff-lcs (1.4.4)
-    docile (1.3.5)
-    drb (2.2.0)
-      ruby2_keywords
-    i18n (1.14.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    drb (2.2.3)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    method_source (1.0.0)
-    minitest (5.21.2)
-    mutex_m (0.2.0)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    json (2.13.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    method_source (1.1.0)
+    minitest (5.25.5)
+    ostruct (0.6.2)
+    parallel (1.27.0)
+    parser (3.3.9.0)
       ast (~> 2.4.1)
       racc
-    pry (0.14.2)
+    prism (1.4.0)
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.7.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (2.8.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    regexp_parser (2.10.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
     rspec_vars_helper (0.1.0)
       rspec (>= 2.4)
-    rubocop (1.52.1)
+    rubocop (1.79.0)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.46.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
+      tsort (>= 0.2.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.46.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    simplecov (0.21.2)
+    securerandom (0.4.1)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
 
 PLATFORMS
+  arm64-darwin-24
   ruby
 
 DEPENDENCIES
   easy_params!
+  ostruct
   pry
   rake (~> 12.0)
   rspec (~> 3.0)
@@ -99,4 +114,4 @@ DEPENDENCIES
   simplecov (~> 0.17)
 
 BUNDLED WITH
-   2.2.3
+   2.7.1

data/README.md

@@ -1,14 +1,14 @@
 # EasyParams
 
-[![Gem Version](https://badge.fury.io/rb/nina.svg)](https://badge.fury.io/rb/nina)
+[![Gem Version](https://badge.fury.io/rb/easy_params.svg)](https://badge.fury.io/rb/easy_params)
 [![Maintainability](https://api.codeclimate.com/v1/badges/17872804ce576b8b0df2/maintainability)](https://codeclimate.com/github/andriy-baran/easy_params/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/17872804ce576b8b0df2/test_coverage)](https://codeclimate.com/github/andriy-baran/easy_params/test_coverage)
 
-Provides an easy way define structure, validation rules, type coercion and set default values for any hash-like structure. It's built on top of `active_model`.
+Provides an easy way to define structure, validation rules, type coercion, and default values for any hash-like structure. It's built on top of `ActiveModel`.
 
 ## Types
 
-Dry types are wrapped by class methods. Avaliable types: `integer`, `decimal`, `float`, `bool`, `string`, `array`, `date`, `datetime`, `time`
+Available types: `integer`, `decimal`, `float`, `bool`, `string`, `array`, `date`, `datetime`, `time`
 
 ## Installation
 
@@ -32,20 +32,54 @@ To define attribute we have a set of methods which match types list. Ex.
 ```ruby
 integer(param_name, default: nil, normalize: nil, **validations)
 ```
-* `:default` provides a value to return if got `nil` as input or there were errors during coersion.
-* `normalize` a proc or lambda that accepts single argument and changes it in some way. It's get called before coercion.
-* `validations` mimics `activemodel/validation` can be any supported validation `presence: true, numericality: { only_integer: true, greater_than: 0 }`
+* `:default` provides a value to return if we get `nil` as input or there were errors during coercion.
+* `:normalize` is a Proc or lambda that accepts a single argument and transforms it. It gets called before coercion.
+* `validations` mimic ActiveModel validations; can be any supported validation, e.g., `presence: true, numericality: { only_integer: true, greater_than: 0 }`
 
-In addition we have special option for an `array` type
+In addition, there is a special option for the `array` type:
 * `:of` accepts `:integer`, `:decimal`, `:float`, `:bool`, `:string`, `:date`, `:datetime`, `:time` (`:array` is not supported)
 
 There are two special types:
 
 | type              | method to define | default |
 |-------------------|------------------|---------|
-| :struct           | has              | {}      |
+| :struct           | has              | nil     |
 | :array_of_structs | each             | []      |
 
+### Defaults for nested types
+
+- **has (struct)**: `default:` must be a Hash. When the input is `nil`, the nested struct is instantiated with that hash; otherwise the provided input is used. If no `default:` is given and the input is `nil`, the value will be `nil`.
+
+  ```ruby
+  has :shipping_address, default: { country: 'US' } do
+    string :country, default: 'US'
+    string :city
+  end
+  ```
+
+- **each (array_of_structs)**: `default:` should be an Array (typically an array of hashes). When the input is `nil`, the collection defaults to an empty array `[]`. If you provide a default array, each element will be coerced into the nested struct.
+
+  ```ruby
+  each :items, default: [{ qty: 1 }] do
+    integer :qty, default: 1
+  end
+  ```
+
+- **Override precedence**: Container-level defaults override attribute-level defaults for the same keys. Attribute defaults apply only when the key is absent (or `nil`) in the provided default/input.
+
+  ```ruby
+  has :user, default: { role: 'admin' } do
+    string :role, default: 'guest'
+    string :name, default: 'Anonymous'
+  end
+  # input: nil => role: 'admin', name: 'Anonymous'
+
+  each :items, default: [{ qty: 2 }, {}] do
+    integer :qty, default: 1
+  end
+  # input: nil => items.map(&:qty) == [2, 1]
+  ```
+
 ```ruby
 # app/params/api/v2/icqa/move_params.rb
 class Api::V1::Carts::MoveParams < EasyParams::Base
@@ -83,7 +117,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_params. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/easy_params/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at [github.com/andriy-baran/easy_params](https://github.com/andriy-baran/easy_params). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/andriy-baran/easy_params/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -92,4 +126,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the EasyParams project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/easy_params/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the EasyParams project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/andriy-baran/easy_params/blob/master/CODE_OF_CONDUCT.md).

data/easy_params.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
 
   version_string = ['>= 3.2']
 
-  spec.add_runtime_dependency 'activemodel', version_string
+  spec.add_dependency 'activemodel', version_string
 end

data/lib/easy_params/base.rb

@@ -7,9 +7,11 @@ module EasyParams
     include EasyParams::Types::Struct
     include EasyParams::Validation
 
+    attr_writer :default
+
     def initialize(params = {})
       self.class.schema.each do |attr, type|
-        public_send("#{attr}=", type.coerce(params[attr])) if params
+        public_send("#{attr}=", type.coerce(params.to_h[attr]))
       end
     end
 
@@ -28,25 +30,33 @@ module EasyParams
         @schema ||= {}
       end
 
-      def each(param_name, normalize: nil, **validations, &block)
+      def each(param_name, definition = nil, default: nil, normalize: nil, **validations, &block)
         validates param_name, **validations if validations.any?
-        type = EasyParams::Types::Each.with_type(&block)
-        type = customize_type(type, nil, &normalize)
-        public_send(:attribute, param_name, type)
+        if definition && !(definition < EasyParams::Base)
+          raise ArgumentError, "definition for attribute #{param_name.inspect} must be a subclass of EasyParams::Base"
+        end
+
+        type = EasyParams::Types::Each.with_type(definition, &block)
+        type = customize_type(type, default, &normalize)
+        attribute(param_name, type)
       end
 
-      def has(param_name, normalize: nil, **validations, &block)
+      def has(param_name, definition = nil, default: nil, normalize: nil, **validations, &block)
         validates param_name, **validations if validations.any?
-        type = Class.new(EasyParams::Types::Struct.class).tap { |c| c.class_eval(&block) }.new
-        type = customize_type(type, nil, &normalize)
-        public_send(:attribute, param_name, type)
+        if definition && !(definition < EasyParams::Base)
+          raise ArgumentError, "definition for attribute #{param_name.inspect} must be a subclass of EasyParams::Base"
+        end
+
+        type = (definition || Class.new(EasyParams::Base).tap { |c| c.class_eval(&block) }).new
+        type = customize_type(type, default, &normalize)
+        attribute(param_name, type)
       end
 
-      def array(param_name, of:, normalize: nil, **validations)
+      def array(param_name, of:, default: nil, normalize: nil, **validations)
         validates param_name, **validations if validations.any?
         type = EasyParams::Types::Array.of(EasyParams::Types.const_get(of.to_s.camelcase))
-        type = customize_type(type, nil, &normalize)
-        public_send(:attribute, param_name, type)
+        type = customize_type(type, default, &normalize)
+        attribute(param_name, type)
       end
 
       private
@@ -64,7 +74,7 @@ module EasyParams
         validates param_name, **validations if validations.any?
         type = EasyParams::Types.const_get(type_name)
         type = customize_type(type, default, &normalize)
-        public_send(:attribute, param_name, type)
+        attribute(param_name, type)
       end
     end
 
@@ -81,7 +91,7 @@ module EasyParams
         result[key] = case value
                       when EasyParams::Types::StructsCollection
                         value.map(&:to_h)
-                      when EasyParams::Types::Struct.class
+                      when EasyParams::Base
                         value.to_h
                       else
                         value

data/lib/easy_params/types/collection.rb

@@ -16,20 +16,16 @@ module EasyParams
       end
 
       def coerce(value)
-        value = @normalize_proc.call(Array(value)) if @normalize_proc
-        self.class.new(@title, Array(value).map do |v|
-                                 @of_type.coerce(v)
-                               end, @normalize_proc, of: @of_type, &@coerce_proc)
+        input = value || @default
+        input = @normalize_proc.call(Array(input)) if @normalize_proc
+        coerced = Array(input).map { |v| @of_type.coerce(v) }
+        self.class.new(@title, coerced, @normalize_proc, of: @of_type, &@coerce_proc)
       end
 
       def normalize(&block)
         self.class.new(@title, @default, block, of: @of_type, &@coerce_proc)
       end
 
-      def self.optional
-        self.class.new(@title, @default, @normalize_proc, of: @of_type, &@coerce_proc)
-      end
-
       def default(value)
         self.class.new(@title, value, @normalize_proc, of: @of_type, &@coerce_proc)
       end
@@ -41,8 +37,8 @@ module EasyParams
 
     # base interface for array of structs type
     class StructsCollection < Collection
-      def with_type(&block)
-        of_type = Class.new(EasyParams::Types::Struct.class).tap { |c| c.class_eval(&block) }.new
+      def with_type(definition = nil, &block)
+        of_type = (definition || Class.new(EasyParams::Base).tap { |c| c.class_eval(&block) }).new
         self.class.new(@title, @default, @normalize_proc, of: of_type)
       end
     end

data/lib/easy_params/types/generic.rb

@@ -19,14 +19,6 @@ module EasyParams
         self.class.new(@title, value, @normalize_proc, &@coerce_proc)
       end
 
-      def optional
-        self.class.new(@title, @default, @normalize_proc, &@coerce_proc)
-      end
-
-      def optional?
-        @optional
-      end
-
       def normalize(&block)
         self.class.new(@title, @default, block, &@coerce_proc)
       end

data/lib/easy_params/types/struct.rb

@@ -8,8 +8,14 @@ module EasyParams
         false
       end
 
+      def default(value)
+        self.default = value
+        self
+      end
+
       def coerce(input)
-        return if input.blank?
+        return if input.nil? && @default.nil?
+        return self.class.new(@default) if input.nil? && @default.is_a?(Hash)
 
         self.class.new(input)
       end

data/lib/easy_params/types.rb

@@ -9,7 +9,7 @@ module EasyParams
         { '0' => false, 'f' => false, 'false' => false, 'False' => false, 'FALSE' => false, 'F' => false }
       ).freeze
 
-    Struct    = Class.new(EasyParams::Base).new
+    Struct    = EasyParams::Base.new
     Array     = Collection.new(:array)
     Each      = StructsCollection.new(:array_of_structs)
     Integer   = Generic.new(:integer, &:to_i)

data/lib/easy_params/validation.rb

@@ -10,7 +10,7 @@ module EasyParams
         case value
         when EasyParams::Types::StructsCollection
           value.each(&:valid?)
-        when EasyParams::Types::Struct.class
+        when EasyParams::Base
           value.valid?
         end
       end
@@ -24,7 +24,7 @@ module EasyParams
           value.each.with_index do |element, i|
             aggregate_nested_errors[attr_name, element, "[#{i}]", error_key_prefix]
           end
-        when EasyParams::Types::Struct.class
+        when EasyParams::Base
           handle_nested_errors(value, error_key_prefix, attr_name, array_index)
         end
       end

data/lib/easy_params/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: easy_params
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Andrii Baran
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -36,6 +35,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -61,7 +61,6 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/andriy-baran/easy_params
   source_code_uri: https://github.com/andriy-baran/easy_params
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,8 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: A tool that handles common tasks needed when working with params in Rails
 test_files: []