composite_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 728406d0c72c5784491933ad9691c991a6f00f2c0addf33fb2ca6b6b4b1549b7
+  data.tar.gz: c3d833672c2e2e9a8c9c65d4cd0cc463ff0372a7f4a15f3fb6846a3e11714486
+SHA512:
+  metadata.gz: 2bada78d9a5b84295d95dbadbccf0af42a3ef46e5c8689293700685a4db4265a42a1a1d05228839cb1967b997e0c39eef054f977ea38f11faa5447c1289ecaa8
+  data.tar.gz: 9da9513d7b8d44cd1780fb0d878ae37aa51ac058f045e88d18943263192b003f06634529fb65ebf75aead2413d715a8c9d003ddd03eb9183231598d906101325

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# 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).
+
+## [Unreleased]
+
+## [0.1.0] - 2024-01-01
+
+### Added
+- Initial release of CompositeValidator
+- Support for validating single associated models
+- Support for validating collections of models
+- Support for validation contexts
+- Automatic nil handling
+- Error message aggregation from associated models

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 sho-work
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,165 @@
+# CompositeValidator
+
+CompositeValidator is an ActiveModel validator that allows you to validate associated models and compose their validation errors to the parent model. It supports both single associations and collections, making it perfect for form objects that aggregate multiple models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'composite_validator'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install composite_validator
+
+## Usage
+
+### Basic Usage
+
+```ruby
+class User
+  include ActiveModel::Model
+  include ActiveModel::Validations
+
+  attr_accessor :name, :email
+
+  validates :name, presence: true
+  validates :email, presence: true, format: { with: URI::MailTo::EMAIL_REGEXP }
+end
+
+class UserCredentials
+  include ActiveModel::Model
+  include ActiveModel::Validations
+
+  attr_accessor :password, :password_confirmation
+
+  validates :password, presence: true, length: { minimum: 8 }
+  validates :password_confirmation, presence: true
+  validate :passwords_match
+
+  private
+
+  def passwords_match
+    return if password == password_confirmation
+    errors.add(:password_confirmation, "doesn't match Password")
+  end
+end
+
+class UserRegistration
+  include ActiveModel::Model
+  include ActiveModel::Validations
+
+  attr_accessor :user, :user_credentials
+
+  validates :user, composite: true
+  validates :user_credentials, composite: true
+end
+
+# Usage
+user = User.new(name: '', email: 'invalid-email')
+credentials = UserCredentials.new(password: 'short', password_confirmation: 'different')
+registration = UserRegistration.new(user: user, user_credentials: credentials)
+
+registration.valid? # => false
+registration.errors[:user]
+# => ["Name can't be blank and Email is invalid"]
+registration.errors[:user_credentials]
+# => ["Password is too short (minimum is 8 characters) and Password confirmation doesn't match Password"]
+```
+
+### Working with Collections
+
+CompositeValidator automatically handles collections of objects:
+
+```ruby
+class OrderItem
+  include ActiveModel::Model
+  include ActiveModel::Validations
+
+  attr_accessor :product_name, :quantity
+
+  validates :product_name, presence: true
+  validates :quantity, numericality: { greater_than: 0 }
+end
+
+class Order
+  include ActiveModel::Model
+  include ActiveModel::Validations
+
+  attr_accessor :items
+
+  validates :items, composite: true
+end
+
+# Usage
+items = [
+  OrderItem.new(product_name: 'Widget', quantity: 5),
+  OrderItem.new(product_name: '', quantity: -1)
+]
+order = Order.new(items: items)
+
+order.valid? # => false
+order.errors[:items]
+# => ["Product name can't be blank and Quantity must be greater than 0"]
+```
+
+### Using Validation Contexts
+
+You can specify a validation context to use when validating the associated models:
+
+```ruby
+class Article
+  include ActiveModel::Model
+  include ActiveModel::Validations
+
+  attr_accessor :title, :content
+
+  validates :title, presence: true
+  validates :content, presence: true, length: { minimum: 100 }, on: :publish
+end
+
+class ArticleForm
+  include ActiveModel::Model
+  include ActiveModel::Validations
+
+  attr_accessor :article
+
+  validates :article, composite: { context: :publish }
+end
+
+# Usage
+article = Article.new(title: 'My Article', content: 'Short content')
+form = ArticleForm.new(article: article)
+
+form.valid? # => false
+form.errors[:article]
+# => ["Content is too short (minimum is 100 characters)"]
+```
+
+### Features
+
+- **Automatic nil handling**: If the associated object is nil, validation is skipped
+- **Collection support**: Automatically detects and validates collections (arrays, etc.)
+- **Struct support**: Properly handles Struct objects (treats them as single objects, not collections)
+- **Context support**: Pass validation contexts to associated models
+- **Clear error messages**: Aggregates all error messages from associated models
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sho-work/composite_validator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/active_model/validations/composite_validator.rb

@@ -0,0 +1,91 @@
+require 'active_model/validations'
+
+module ActiveModel
+  module Validations
+    # Composite Validator. Inherits from ActiveModel::EachValidator.
+    #
+    # Usage:
+    #   class UserRegistration
+    #     include ActiveModel::Validations
+    #
+    #     attr_accessor :user, :user_credentials
+    #
+    #     validates :user, composite: true
+    #     validates :user_credentials, composite: true
+    #   end
+    class CompositeValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        Validator
+          .call(parent: self, record: record, attribute: attribute, value: value)
+      end
+
+      class Validator
+        private_class_method :new
+
+        class << self
+          def call(parent:, record:, attribute:, value:)
+            new(
+              parent: parent, record: record, attribute: attribute, value: value
+            ).call
+          end
+        end
+
+        def initialize(parent:, record:, attribute:, value:)
+          @parent = parent
+          @record = record
+          @attribute = attribute
+          @value = value
+        end
+
+        def call
+          return if value.nil? || valid?
+
+          add_error!
+        end
+
+        private
+
+        attr_reader :parent, :record, :attribute, :value
+
+        delegate :options, to: :parent
+
+        def associations
+          @associations ||= \
+            if value.class.include?(Enumerable) && !value.is_a?(Struct)
+              value
+            else
+              [value]
+            end.select { _1.respond_to?(:valid?) }
+        end
+
+        def valid?
+          invalid_associations.empty?
+        end
+
+        def invalid_associations
+          @invalid_associations ||= \
+            associations.select { _1.invalid?(context) }
+        end
+
+        def invalid_message
+          invalid_associations
+            .map { _1.errors.full_messages.to_sentence }
+            .to_sentence
+        end
+
+        def context = options.try(:[], :context)
+
+        def add_error!
+          record
+            .errors
+            .add(
+              attribute,
+              :invalid_association,
+              association: invalid_message
+            )
+        end
+      end
+      private_constant :Validator
+    end
+  end
+end

data/lib/composite_validator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CompositeValidator
+  VERSION = "0.1.0"
+end

data/lib/composite_validator.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "composite_validator/version"
+require "active_model/validations/composite_validator"

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: composite_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sho-work
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: CompositeValidator allows you to validate associated models and compose
+  their validation errors to the parent model. It supports both single associations
+  and collections.
+email:
+- sho-work@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/active_model/validations/composite_validator.rb
+- lib/composite_validator.rb
+- lib/composite_validator/version.rb
+homepage: https://github.com/sho-work/composite_validator
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sho-work/composite_validator
+  source_code_uri: https://github.com/sho-work/composite_validator
+  changelog_uri: https://github.com/sho-work/composite_validator/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: ActiveModel validator for composing validations from associated models
+test_files: []