structured_params 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6e173ab053f1e2c0663487baef3cf54059b6f9a49a6e9a5f83583036d3761e9
-  data.tar.gz: 2cde9e164e2a44671af8f087cfd0dc1f7b5306ee2a21f3b252425d40260c1ff7
+  metadata.gz: 66f5daa7a71dd1470ca9f5d8af4d62dd8b0c40227ce6f07812a04206e0083c06
+  data.tar.gz: 5c9500ee402ecd0c06ab82503ac13b4ed4800cd2a18b87f4b5fecbba692ad4ac
 SHA512:
-  metadata.gz: d84113eb2dbd70e8fbbcb0bae0109dfae9f4d4e3c7314370ac30a22456aa6ae29bfeadbfc73628190a72ce47a699219ec3a71d5531b9e282e6db3c5687fa0000
-  data.tar.gz: cd094fa7736d631982474a7eaa03b41df44122c532434c0a4fc75b0ef406e4e06997c70d2aaf2cd9ffd106626fcc4e3e63a8fbf9b91d4de98cafc281df895d00
+  metadata.gz: 306948118def08f98c24f460f1e5763e72281a2c31e141ba7db9c376ceea5e1a6ac4ab016a28779f84dfa60ebcf74904b62f66d191507c4066c0f9db055067d6
+  data.tar.gz: 57d137f7e64e810356f909045a7e250abe82317b8b5574b8b1f2c4db2e2e23476ef48fc792a7cf168cdad646b649261e2bc9548365827645d1b3f5ec327fe8ed

data/CHANGELOG.md

@@ -1,73 +1,43 @@
 # Changelog
 
-## [0.3.0] - 2025-09-06
+## [0.6.0] - 2026-02-28
 
 ## What's Changed
-* Expand Rails compatibility to support Rails 7.2+ through 8.x
+* Update Ruby and Rails versions with RBS and RuboCop adjustments by @Syati in https://github.com/Syati/structured_params/pull/11
 
 
-**Full Changelog**: https://github.com/Syati/structured_params/compare/v0.2.0...v0.3.0
-
-## [0.2.1] - 2025-09-06
+**Full Changelog**: https://github.com/Syati/structured_params/compare/v0.5.0...v0.6.0
 
+## [0.5.0] - 2025-09-09
+
 ## What's Changed
-* Bump version to 0.2.0 by @Syati in https://github.com/Syati/structured_params/pull/2
-* Update project documentation by @Syati in https://github.com/Syati/structured_params/pull/3
-* Add comparison document for StructuredParams and similar gems by @Syati in https://github.com/Syati/structured_params/pull/4
-* Update Gemfile and CI configuration to support multiple Rails versions by @Syati in https://github.com/Syati/structured_params/pull/5
-* Refactor release workflow to update version and CHANGELOG handling by @Syati in https://github.com/Syati/structured_params/pull/6
+* Update attributes method signatures to use optional keyword arguments… by @Syati in https://github.com/Syati/structured_params/pull/8
 
 
-**Full Changelog**: https://github.com/Syati/structured_params/compare/v0.2.0...v0.2.1
+**Full Changelog**: https://github.com/Syati/structured_params/compare/v0.3.0...v0.5.0
+
+## [0.3.0] - 2025-09-06
 
 ## What's Changed
-* Bump version to 0.2.0 by @Syati in https://github.com/Syati/structured_params/pull/2
-* Update project documentation by @Syati in https://github.com/Syati/structured_params/pull/3
-* Add comparison document for StructuredParams and similar gems by @Syati in https://github.com/Syati/structured_params/pull/4
-* Update Gemfile and CI configuration to support multiple Rails versions by @Syati in https://github.com/Syati/structured_params/pull/5
-* Refactor release workflow to update version and CHANGELOG handling by @Syati in https://github.com/Syati/structured_params/pull/6
+* Expand Rails compatibility to support Rails 7.2+ through 8.x
 
+**Full Changelog**: https://github.com/Syati/structured_params/compare/v0.2.0...v0.3.0
+
+## [0.2.0] - 2025-09-05
 
-**Full Changelog**: https://github.com/Syati/structured_params/compare/v0.2.0...v0.2.1
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [0.2.0] - 2025-09-05
-
 ## What's Changed
 * Improve error handling and serialization features by @Syati in https://github.com/Syati/structured_params/pull/1
 
+**Full Changelog**: https://github.com/Syati/structured_params/compare/v0.1.0...v0.2.0
+
+## [0.1.0] - Initial Release
+
+### Added
+- Initial implementation of StructuredParams with support for structured objects and arrays
+- ActiveModel integration for validation and attributes
+- Strong Parameters compatibility
+- Type system with Object and Array types
+- RBS type definitions
+- Comprehensive test suite
+
 
-**Full Changelog**: https://github.com/Syati/structured_params/compare/v0.1.4...v0.2.0
-
-
-
-**Full Changelog**: https://github.com/Syati/structured_params/compare/v0.1.3...v0.1.4
-
-
-
-### Fixed
-- Fixed error key consistency issue where `errors.import` was using string keys instead of symbol keys
-- Updated method names and comments to use consistent 'structured' terminology instead of 'nested'
-- Fixed type annotations for method calls requiring explicit parameters
-
-### Changed
-- Renamed methods for better consistency:
-  - `each_nested_attribute_name` → `each_structured_attribute_name`
-  - `validate_nested_parameters` → `validate_structured_parameters`
-  - `import_nested_errors` → `import_structured_errors`
-  - `serialize_nested_value` → `serialize_structured_value`
-- Updated documentation to reflect current `:object` and `:array` types instead of `:nested`
-
-## [0.1.0] - Initial Release
-
-### Added
-- Initial implementation of StructuredParams with support for structured objects and arrays
-- ActiveModel integration for validation and attributes
-- Strong Parameters compatibility
-- Type system with Object and Array types
-- RBS type definitions
-- Comprehensive test suite

data/lib/structured_params/params.rb

@@ -18,7 +18,7 @@ module StructuredParams
     # @rbs @errors: ::StructuredParams::Errors?
 
     class << self
-      # @rbs self.@structured_attributes: Hash[Symbol, singleton(::StructuredParams::Params)]?
+      # @rbs @structured_attributes: Hash[Symbol, singleton(::StructuredParams::Params)]?
 
       # Generate permitted parameter structure for Strong Parameters
       #: () -> Array[untyped]
@@ -73,17 +73,26 @@ module StructuredParams
     end
 
     # Convert structured objects to Hash and get attributes
-    #: (symbolize: true) -> Hash[Symbol, untyped]
-    #: (symbolize: false) -> Hash[String, untyped]
-    def attributes(symbolize: false)
+    #: (?symbolize: false, ?compact_mode: :none | :nil_only | :all_blank) -> Hash[String, untyped]
+    #: (?symbolize: true, ?compact_mode: :none | :nil_only | :all_blank) -> Hash[Symbol, untyped]
+    def attributes(symbolize: false, compact_mode: :none)
       attrs = super()
 
       self.class.structured_attributes.each_key do |name|
         value = attrs[name.to_s]
-        attrs[name.to_s] = serialize_structured_value(value)
+        attrs[name.to_s] = serialize_structured_value(value, compact_mode: compact_mode)
       end
 
-      symbolize ? attrs.deep_symbolize_keys : attrs
+      result = symbolize ? attrs.deep_symbolize_keys : attrs
+
+      case compact_mode
+      when :all_blank
+        result.compact_blank
+      when :nil_only
+        result.compact
+      else
+        result
+      end
     end
 
     private
@@ -119,9 +128,7 @@ module StructuredParams
     end
 
     # Validate structured arrays
-    # @rbs attr_name: Symbol
-    # @rbs array_value: Array[untyped]
-    # @rbs return: void
+    #: (Symbol, Array[untyped]) -> void
     def validate_structured_array(attr_name, array_value)
       array_value.each_with_index do |item, index|
         next if item.valid?(validation_context)
@@ -132,9 +139,7 @@ module StructuredParams
     end
 
     # Validate structured objects
-    # @rbs attr_name: Symbol
-    # @rbs object_value: ::StructuredParams::Params
-    # @rbs return: void
+    #: (Symbol, StructuredParams::Params) -> void
     def validate_structured_object(attr_name, object_value)
       return if object_value.valid?(validation_context)
 
@@ -151,13 +156,22 @@ module StructuredParams
     end
 
     # Serialize structured values
-    #: (untyped) -> untyped
-    def serialize_structured_value(value)
+    #: (untyped, ?compact_mode: :none | :nil_only | :all_blank) -> untyped
+    def serialize_structured_value(value, compact_mode: :none)
       case value
       when Array
-        value.map { |item| item.attributes(symbolize: false) }
+        result = value.map { |item| item.attributes(symbolize: false, compact_mode: compact_mode) }
+
+        case compact_mode
+        when :all_blank
+          result.compact_blank
+        when :nil_only
+          result.compact
+        else
+          result
+        end
       when StructuredParams::Params
-        value.attributes(symbolize: false)
+        value.attributes(symbolize: false, compact_mode: compact_mode)
       else
         value
       end

data/lib/structured_params/type/object.rb

@@ -10,6 +10,7 @@ module StructuredParams
       # Get permitted parameter names for use with Strong Parameters
       # @rbs!
       #  def permit_attribute_names: () -> ::Array[untyped]
+
       delegate :permit_attribute_names, to: :value_class
 
       #: (value_class: singleton(StructuredParams::Params), **untyped) -> void

data/lib/structured_params/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module StructuredParams
-  VERSION = '0.3.0' #: string
+  VERSION = '0.6.0' #: string
 end

data/sig/structured_params/params.rbs

@@ -38,10 +38,10 @@ module StructuredParams
     def errors: () -> ::StructuredParams::Errors
 
     # Convert structured objects to Hash and get attributes
-    # : (symbolize: true) -> Hash[Symbol, untyped]
-    # : (symbolize: false) -> Hash[String, untyped]
-    def attributes: (symbolize: true) -> Hash[Symbol, untyped]
-                  | (symbolize: false) -> Hash[String, untyped]
+    # : (?symbolize: false, ?compact_mode: :none | :nil_only | :all_blank) -> Hash[String, untyped]
+    # : (?symbolize: true, ?compact_mode: :none | :nil_only | :all_blank) -> Hash[Symbol, untyped]
+    def attributes: (?symbolize: false, ?compact_mode: :none | :nil_only | :all_blank) -> Hash[String, untyped]
+                  | (?symbolize: true, ?compact_mode: :none | :nil_only | :all_blank) -> Hash[Symbol, untyped]
 
     private
 
@@ -70,8 +70,8 @@ module StructuredParams
     def format_error_path: (Symbol, Integer?) -> String
 
     # Serialize structured values
-    # : (untyped) -> untyped
-    def serialize_structured_value: (untyped) -> untyped
+    # : (untyped, ?compact_mode: :none | :nil_only | :all_blank) -> untyped
+    def serialize_structured_value: (untyped, ?compact_mode: :none | :nil_only | :all_blank) -> untyped
 
     # Integrate structured parameter errors into parent errors
     # : (untyped, String) -> void

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structured_params
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mizuki Yamamoto
@@ -86,7 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="