structured_params 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c06ea969ca1b6ba0b64271bc9b168519fecbb48d754c234489e9b509cd22578
-  data.tar.gz: 9f10004fd987e2e5af527857860d72d6d4ccaf19ec98dec0ac673c9db20ec473
+  metadata.gz: 465e05cd489fded0858ba6430045d1ed8a479b864f7190e0e561e095b979224a
+  data.tar.gz: d79203675ccaff61fb740f30af56056bc77a2356b703080a58468eaa852ed614
 SHA512:
-  metadata.gz: 6354a4d7f609f46093ed55f8cab4873d2f0f15370f0ad4a1e6719e7e5e02ff12a17ce0bd34f5b82bb1129ed6d933cfa51aa6de353b7fe7cf18882d857f3daa23
-  data.tar.gz: ff1fe2be0beb5024f7afa1e8f41a4b32dc55aeee061d633d40ca0052802129b507962d0a38bcad826d10da98ac7c64bd3b25edb7f6bc4c65a3117449fbc8aef9
+  metadata.gz: ab616001f00cbddd9e88603869019d00c4f185f80d5c4476b1af0c670c46d96b00e0cf6bf668e1f39c20c1d8e7537d18b29fab23f00beb697096cdff5873226d
+  data.tar.gz: bd10044d6178f1ce7e6b8ac60c9b437c6efb329d5ad0077dd167feae0ff34253457f9f492b2096f2138e159fb3d6fbbbc8f86f0326c5f72999ede42b5525ad0e

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+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.1.1] - 2025-01-03
+
+### 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

@@ -2,12 +2,12 @@
 # frozen_string_literal: true
 
 module StructuredParams
-  # Parameter model that supports nested structures
+  # Parameter model that supports structured objects and arrays
   #
   # Usage example:
   #   class UserParameter < StructuredParams::Params
   #     attribute :name, :string
-  #     attribute :address, :nested, value_class: AddressParameter
+  #     attribute :address, :object, value_class: AddressParameter
   #     attribute :hobbies, :array, value_class: HobbyParameter
   #     attribute :tags, :array, value_type: :string
   #   end
@@ -30,9 +30,9 @@ module StructuredParams
         end
       end
 
-      # Get names of nested StructuredParams attributes
+      # Get names of StructuredParams attributes (object and array types)
       #: () { (String) -> void } -> void
-      def each_nested_attribute_name
+      def each_structured_attribute_name
         attribute_types.each do |name, type|
           yield name if structured_params_type?(type)
         end
@@ -40,7 +40,7 @@ module StructuredParams
 
       private
 
-      # Determine if the specified type is a nested parameter type
+      # Determine if the specified type is a StructuredParams type
       #: (untyped) -> bool
       def structured_params_type?(type)
         type.is_a?(StructuredParams::Type::Object) ||
@@ -48,8 +48,8 @@ module StructuredParams
       end
     end
 
-    # Integrate validation of nested objects
-    validate :validate_nested_parameters
+    # Integrate validation of structured objects
+    validate :validate_structured_parameters
 
     #: (untyped) -> void
     def initialize(params)
@@ -57,14 +57,14 @@ module StructuredParams
       super(**processed_params)
     end
 
-    # Convert nested objects to Hash and get attributes
+    # Convert structured objects to Hash and get attributes
     #: (symbolize: bool) -> Hash[untyped, untyped]
     def attributes(symbolize: false)
       attrs = super()
 
-      self.class.each_nested_attribute_name do |name|
+      self.class.each_structured_attribute_name do |name|
         value = attrs[name.to_s]
-        attrs[name.to_s] = serialize_nested_value(value)
+        attrs[name.to_s] = serialize_structured_value(value)
       end
 
       symbolize ? attrs.deep_symbolize_keys : attrs
@@ -86,40 +86,40 @@ module StructuredParams
       end
     end
 
-    # Execute nested parameter validation
+    # Execute structured parameter validation
     #: () -> void
-    def validate_nested_parameters
-      self.class.each_nested_attribute_name do |attr_name|
+    def validate_structured_parameters
+      self.class.each_structured_attribute_name do |attr_name|
         value = attribute(attr_name)
         next if value.blank?
 
         case value
         when Array
-          validate_nested_array(attr_name, value)
+          validate_structured_array(attr_name, value)
         else
-          validate_nested_object(attr_name, value)
+          validate_structured_object(attr_name, value)
         end
       end
     end
 
-    # Validate nested arrays
+    # Validate structured arrays
     #: (String, Array[untyped]) -> void
-    def validate_nested_array(attr_name, array_value)
+    def validate_structured_array(attr_name, array_value)
       array_value.each_with_index do |item, index|
         next if item.valid?(validation_context)
 
         error_path = format_error_path(attr_name, index)
-        import_nested_errors(item.errors, error_path)
+        import_structured_errors(item.errors, error_path)
       end
     end
 
-    # Validate nested objects
+    # Validate structured objects
     #: (String, StructuredParams::Params) -> void
-    def validate_nested_object(attr_name, object_value)
+    def validate_structured_object(attr_name, object_value)
       return if object_value.valid?(validation_context)
 
-      error_path = format_error_path(attr_name)
-      import_nested_errors(object_value.errors, error_path)
+      error_path = format_error_path(attr_name, nil)
+      import_structured_errors(object_value.errors, error_path)
     end
 
     # Format error path using dot notation (always consistent)
@@ -130,22 +130,22 @@ module StructuredParams
       path_parts.join('.')
     end
 
-    # Integrate nested errors into parent errors
+    # Integrate structured parameter errors into parent errors
     #: (untyped, String) -> void
-    def import_nested_errors(nested_errors, prefix)
-      nested_errors.each do |error|
-        errors.import(error, attribute: "#{prefix}.#{error.attribute}")
+    def import_structured_errors(structured_errors, prefix)
+      structured_errors.each do |error|
+        errors.import(error, attribute: :"#{prefix}.#{error.attribute}")
       end
     end
 
-    # Serialize nested values
+    # Serialize structured values
     #: (untyped) -> untyped
-    def serialize_nested_value(value)
+    def serialize_structured_value(value)
       case value
       when Array
-        value.map(&:attributes)
+        value.map { |item| item.attributes(symbolize: false) }
       when StructuredParams::Params
-        value.attributes
+        value.attributes(symbolize: false)
       else
         value
       end

data/lib/structured_params/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structured_params
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mizuki Yamamoto
@@ -44,6 +44,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - lib/structured_params.rb
 - lib/structured_params/params.rb