structured_params 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7df8a9794d83f7ff21ab449fcc1c8d294ef6fcc2f07efa3f06312847efd98351
-  data.tar.gz: 06b6b58ad9d4b5969ae944a4d84b49cb7eb163c8096ced05d345384b418ad651
+  metadata.gz: 99bd6bd346b7e55ee390e747bb9ff232aa84af52e0198b48d162b42e7caed5f8
+  data.tar.gz: b4746d75c8201e0751e1d413155697a2f23da1d0da667491749838db0a6c0c19
 SHA512:
-  metadata.gz: 9c67223de7d299fc05e4edb7d3f07a662ab08517f1fd515ecd20b5fed2bcbd9c1415a91ec64ec96ca71d79e584eb456b56e3a16ca1e5877f75c837f0be4817a3
-  data.tar.gz: a219e6a26311d776b6b68c3dee2a0ea40bc7faf4cbb00cf55fd9f390e3594bb862514aff5fc833477540bac3acf3f6173e08c97026379369b8bd6fd6019bcfcf
+  metadata.gz: 2aef79c11cbb97312962a39869726aa7ce95ef1e1b3f29974d3d8bc1d1637487ef7cb85dbe47742866db1db9572e83999bb52095fe634247c1170cafd0ff5433
+  data.tar.gz: b2a6bce45a08f4521979084f2ecd6b20385b7aeec3794ae2cfb8bd57d6888e87ffdae4dae10a4887b07e47417afc80d256235e25bc8ce5c9c96a3316391f81ab

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [0.9.2] - 2026-04-02
+
+## What's Changed
+* Clarify gemspec summary to describe type-safe parameter validation by @Syati in https://github.com/Syati/structured_params/pull/13
+* Addressing PR comments by @Syati in https://github.com/Syati/structured_params/pull/14
+
+
+**Full Changelog**: https://github.com/Syati/structured_params/compare/v0.9.1...v0.9.2
+
 ## [0.9.1] - 2026-03-18
 
 **Full Changelog**: https://github.com/Syati/structured_params/compare/v0.9.0...v0.9.1

data/lib/structured_params/attribute_methods.rb

@@ -0,0 +1,29 @@
+# rbs_inline: enabled
+# frozen_string_literal: true
+
+module StructuredParams
+  # Extends ActiveModel::Attributes to define +attr_before_type_cast+ accessors
+  # for each attribute, mirroring ActiveRecord::AttributeMethods::BeforeTypeCast.
+  #
+  # Example:
+  #   class UserParams < StructuredParams::Params
+  #     attribute :age, :integer
+  #   end
+  #
+  #   params = UserParams.new(age: "42abc")
+  #   params.age                    # => 42  (type-cast)
+  #   params.age_before_type_cast   # => "42abc"  (raw input)
+  module AttributeMethods
+    extend ActiveSupport::Concern
+
+    included do
+      # Override attribute to also define `attr_before_type_cast`
+      # via ActiveModel::Attribute#value_before_type_cast
+      #: (Symbol name, *untyped) -> void
+      def self.attribute(name, ...)
+        super
+        define_method(:"#{name}_before_type_cast") { @attributes[name.to_s].value_before_type_cast }
+      end
+    end
+  end
+end

data/lib/structured_params/params.rb

@@ -11,9 +11,13 @@ module StructuredParams
   # Strong Parameters example (API):
   #   class UserParams < StructuredParams::Params
   #     attribute :name, :string
+  #     attribute :age, :integer
   #     attribute :address, :object, value_class: AddressParams
   #     attribute :hobbies, :array, value_class: HobbyParams
   #     attribute :tags, :array, value_type: :string
+  #
+  #     # Validate raw input before type casting (e.g., "12x" for integer fields)
+  #     validates_raw :age, format: { with: /\A\d+\z/, message: 'must be numeric string' }
   #   end
   #
   #   # In controller:
@@ -49,6 +53,8 @@ module StructuredParams
   class Params
     include ActiveModel::Model
     include ActiveModel::Attributes
+    include AttributeMethods
+    include Validations
 
     # @rbs @errors: ::StructuredParams::Errors?
 

data/lib/structured_params/validations.rb

@@ -0,0 +1,72 @@
+# rbs_inline: enabled
+# frozen_string_literal: true
+
+module StructuredParams
+  # Provides +validates_raw+ which validates raw parameter values before type casting.
+  #
+  # Internally delegates to ActiveModel's +validates+ on the +_before_type_cast+
+  # attribute, then remaps errors back to the original attribute name.
+  # This means all standard ActiveModel validators (format, numericality, etc.)
+  # work as-is on the raw input value.
+  #
+  # Example:
+  #   class UserParams < StructuredParams::Params
+  #     attribute :age, :integer
+  #     validates_raw :age, format: { with: /\A\d+\z/, message: 'must be numeric string' }
+  #   end
+  #
+  #   params = UserParams.new(age: "abc")
+  #   params.valid?            # => false
+  #   params.errors[:age]      # => ["must be numeric string"]
+  module Validations
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :validates_raw_btc_map, instance_accessor: false, default: {}
+      class_attribute :validates_raw_remap_validator_installed, instance_accessor: false, default: false
+    end
+
+    # @rbs module ClassMethods
+    class_methods do
+      # Validates raw attribute value before type casting.
+      #
+      # Accepts the same options as +validates+ (format, numericality, presence, etc.),
+      # but validates the raw input value before it is converted by ActiveModel::Attributes.
+      #
+      # Examples:
+      #   validates_raw :age,   format: { with: /\A\d+\z/ }
+      #   validates_raw :score, numericality: { only_integer: true }
+      #   validates_raw :code,  format: { with: /\A[A-Z]+\z/, message: 'must be uppercase' }
+      #
+      #: (*Symbol, **untyped) -> void
+      def validates_raw(*attr_names, **options)
+        btc_map = attr_names.to_h { |attr| [attr.to_sym, :"#{attr}_before_type_cast"] }
+        validates(*btc_map.values, **options)
+        self.validates_raw_btc_map = validates_raw_btc_map.merge(btc_map)
+        validates_raw_install_remap_validator_once
+      end
+
+      #: () -> void
+      def validates_raw_install_remap_validator_once
+        return if validates_raw_remap_validator_installed
+
+        set_callback(:validate, :after, :validates_raw_remap_errors)
+
+        self.validates_raw_remap_validator_installed = true
+      end
+      private :validates_raw_install_remap_validator_once
+    end
+
+    private
+
+    #: () -> void
+    def validates_raw_remap_errors
+      self.class.validates_raw_btc_map.each do |attr, btc|
+        next if errors.where(btc).none?
+
+        errors.where(btc).dup.each { |e| errors.import(e, attribute: attr) }
+        errors.delete(btc)
+      end
+    end
+  end
+end

data/lib/structured_params/version.rb

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

data/lib/structured_params.rb

@@ -10,6 +10,8 @@ require_relative 'structured_params/version'
 
 # errors
 require_relative 'structured_params/errors'
+require_relative 'structured_params/attribute_methods'
+require_relative 'structured_params/validations'
 
 # types (load first for module definition)
 require_relative 'structured_params/type/object'

data/sig/structured_params/attribute_methods.rbs

@@ -0,0 +1,23 @@
+# Generated from lib/structured_params/attribute_methods.rb with RBS::Inline
+
+module StructuredParams
+  # Extends ActiveModel::Attributes to define +attr_before_type_cast+ accessors
+  # for each attribute, mirroring ActiveRecord::AttributeMethods::BeforeTypeCast.
+  #
+  # Example:
+  #   class UserParams < StructuredParams::Params
+  #     attribute :age, :integer
+  #   end
+  #
+  #   params = UserParams.new(age: "42abc")
+  #   params.age                    # => 42  (type-cast)
+  #   params.age_before_type_cast   # => "42abc"  (raw input)
+  module AttributeMethods
+    extend ActiveSupport::Concern
+
+    # Override attribute to also define `attr_before_type_cast`
+    # via ActiveModel::Attribute#value_before_type_cast
+    # : (Symbol name, *untyped) -> void
+    def self.attribute: (Symbol name, *untyped) -> void
+  end
+end

data/sig/structured_params/params.rbs

@@ -10,9 +10,13 @@ module StructuredParams
   # Strong Parameters example (API):
   #   class UserParams < StructuredParams::Params
   #     attribute :name, :string
+  #     attribute :age, :integer
   #     attribute :address, :object, value_class: AddressParams
   #     attribute :hobbies, :array, value_class: HobbyParams
   #     attribute :tags, :array, value_type: :string
+  #
+  #     # Validate raw input before type casting (e.g., "12x" for integer fields)
+  #     validates_raw :age, format: { with: /\A\d+\z/, message: 'must be numeric string' }
   #   end
   #
   #   # In controller:
@@ -50,6 +54,10 @@ module StructuredParams
 
     include ActiveModel::Attributes
 
+    include AttributeMethods
+
+    include Validations
+
     @errors: ::StructuredParams::Errors?
 
     self.@structured_attributes: Hash[Symbol, singleton(::StructuredParams::Params)]?

data/sig/structured_params/validations.rbs

@@ -0,0 +1,47 @@
+# Generated from lib/structured_params/validations.rb with RBS::Inline
+
+module StructuredParams
+  # Provides +validates_raw+ which validates raw parameter values before type casting.
+  #
+  # Internally delegates to ActiveModel's +validates+ on the +_before_type_cast+
+  # attribute, then remaps errors back to the original attribute name.
+  # This means all standard ActiveModel validators (format, numericality, etc.)
+  # work as-is on the raw input value.
+  #
+  # Example:
+  #   class UserParams < StructuredParams::Params
+  #     attribute :age, :integer
+  #     validates_raw :age, format: { with: /\A\d+\z/, message: 'must be numeric string' }
+  #   end
+  #
+  #   params = UserParams.new(age: "abc")
+  #   params.valid?            # => false
+  #   params.errors[:age]      # => ["must be numeric string"]
+  module Validations
+    extend ActiveSupport::Concern
+
+    # @rbs module ClassMethods
+    module ClassMethods
+      # Validates raw attribute value before type casting.
+      #
+      # Accepts the same options as +validates+ (format, numericality, presence, etc.),
+      # but validates the raw input value before it is converted by ActiveModel::Attributes.
+      #
+      # Examples:
+      #   validates_raw :age,   format: { with: /\A\d+\z/ }
+      #   validates_raw :score, numericality: { only_integer: true }
+      #   validates_raw :code,  format: { with: /\A[A-Z]+\z/, message: 'must be uppercase' }
+      #
+      # : (*Symbol, **untyped) -> void
+      def validates_raw: (*Symbol, **untyped) -> void
+
+      # : () -> void
+      def validates_raw_install_remap_validator_once: () -> void
+    end
+
+    private
+
+    # : () -> void
+    def validates_raw_remap_errors: () -> void
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structured_params
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Mizuki Yamamoto
@@ -59,16 +59,20 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - lib/structured_params.rb
+- lib/structured_params/attribute_methods.rb
 - lib/structured_params/errors.rb
 - lib/structured_params/params.rb
 - lib/structured_params/type/array.rb
 - lib/structured_params/type/object.rb
+- lib/structured_params/validations.rb
 - lib/structured_params/version.rb
 - sig/structured_params.rbs
+- sig/structured_params/attribute_methods.rbs
 - sig/structured_params/errors.rbs
 - sig/structured_params/params.rbs
 - sig/structured_params/type/array.rbs
 - sig/structured_params/type/object.rbs
+- sig/structured_params/validations.rbs
 - sig/structured_params/version.rbs
 homepage: https://github.com/Syati/structured_params
 licenses:
@@ -95,5 +99,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: StructuredParams allows you to validate pass parameter.
+summary: Type-safe parameter validation and form objects for Rails.
 test_files: []