tramway 2.2.5.4 → 2.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7951f9f78870d2dc7a6d12d1125fffe641251d68de9039231c44be35d3be322e
-  data.tar.gz: 2665a1a1d5b8187d9b7a7ec2d19ff75a56e41028195c3eac13c603e85affee5e
+  metadata.gz: da9fb27f70518c08c00dc9b65368f3425460df6ed0b9cb7506ea1fd4140cbd64
+  data.tar.gz: 32ec241b81c1e6120b410e62a8a22932720721be1ed34b73c64bf43fa63e5a5d
 SHA512:
-  metadata.gz: 0d0ca70e859144c58767deca5c540faa6e472a7ada951089ef3aa735f3eeb969e99daa47b0aad7bd679e237255f7ef384e8eecbd01cc2fcf970a11330de4e808
-  data.tar.gz: cd3ad4af73eb6a2b3720da8cd0ecee12155a98f53e2017d7c3c4327bea120f1fa03d8e44344844f4315420b8fd61462cd369b8162d4ccbf76d162c0c82741782
+  metadata.gz: 2279a03d5e72a3e5a943b22ce54b11dfab5cf6970c59e59541fe0f6be3209cef4c6b2547917ff5bcbfea1e7488a482f645b9e0b720e7f6b0daef1962d3f62b85
+  data.tar.gz: a310b92c15be5e0bcedeab69e2bf7e512f183581acae65e9b50f4c7464129346b86e83f56b34954d86b3d7d9f50bfd7230745747974b9f1e95ffc6884db2d5fd

data/README.md

@@ -654,9 +654,28 @@ end
 * `with:` - a proc with a normalization
 * `apply_on_nil` - by default is `false`. When `true` Tramway Form applies normalization on `nil` values
 
+### Validations
+
+Tramway Form supports `validates` method to add form-level validations before saving.
+
+```ruby
+class UserForm < Tramway::BaseForm
+  properties :email, :role
+
+  validates :email, format: { with: /@/ }, allow_nil: true
+  validates :role, presence: true
+end
+```
+
+`validates` uses the standard ActiveModel/ActiveRecord validation options (for example `presence: true`,
+`format:`, `length:`, `allow_nil`, `allow_blank`, etc.), so `with:` is optional unless a validator
+requires it (like `format`).
+
+When validations fail, `submit` returns `false` and adds errors to the form object, and `submit!` raises `ActiveRecord::RecordInvalid`.
+
 ### Form inheritance
 
-Tramway Form supports inheritance of `properties`, `normalizations`, and `fields`.
+Tramway Form supports inheritance of `properties`, `normalizations`, `validations`, and `fields`.
 
 **Example**
 
@@ -665,6 +684,7 @@ class UserForm < TramwayForm
   properties :email, :password
 
   normalizes :email, with: ->(value) { value.strip.downcase }
+  validates :email, format: { with: /@/ }, allow_nil: true
 
   fields email: :email,
     password: :password
@@ -676,6 +696,7 @@ end
 
 AdminForm.properties # returns [:email, :password, :permissions]
 AdminForm.normalizations # contains the normalization of :email
+AdminForm.validators_on(:email) # includes the validation of :email
 AdminForm.fields # { email: :email, password: :password }
 ```
 

data/docs/AGENTS.md

@@ -106,6 +106,9 @@ end
 ### Rule 2
 Normalize input with `normalizes` (from Tramway) for attributes like email, phone, etc. Don't use `normalizes` in model unless it requested explicitly.
 
+### Rule 2.1
+When you need form-level validation, use Tramway Form `validates` on the form object (ActiveModel/ActiveRecord validation options like `presence: true` work, and `with:` is optional unless a validator requires it). Keep data integrity validations in the model unless the request explicitly needs form-only logic.
+
 ### Rule 3
 Use Tramway Navbar for navigation
 

data/lib/tramway/base_form.rb

@@ -2,6 +2,7 @@
 
 require 'tramway/forms/properties'
 require 'tramway/forms/normalizations'
+require 'tramway/forms/validations'
 require 'tramway/forms/fields'
 require 'tramway/duck_typing'
 
@@ -12,6 +13,7 @@ module Tramway
     include Tramway::Forms::Properties
     include Tramway::Forms::Fields
     include Tramway::Forms::Normalizations
+    include Tramway::Forms::Validations
     include Tramway::DuckTyping::ActiveRecordCompatibility
 
     attr_reader :object, :initial_object
@@ -27,6 +29,7 @@ module Tramway
       def inherited(subclass)
         __initialize_properties subclass
         __initialize_normalizations subclass
+        __initialize_validations subclass
         __initialize_fields subclass
 
         super
@@ -36,6 +39,8 @@ module Tramway
     def submit(params)
       __submit params
 
+      return false if object.errors.any?
+
       object.save.tap do
         __object
       end
@@ -44,6 +49,8 @@ module Tramway
     def submit!(params)
       __submit params
 
+      raise ActiveRecord::RecordInvalid, object if object.errors.any?
+
       object.save!.tap do
         __object
       end
@@ -71,7 +78,10 @@ module Tramway
     private
 
     def __submit(params)
-      __apply_properties __apply_normalizations params
+      normalized_params = __apply_normalizations(params)
+
+      __apply_properties normalized_params
+      __apply_validations normalized_params
     end
 
     def __object

data/lib/tramway/forms/validations.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+module Tramway
+  module Forms
+    # Provides form validations for Tramway forms
+    module Validations
+      def self.included(base)
+        base.include ActiveModel::Validations
+        base.extend ClassMethods
+      end
+
+      # A collection of methods that would be using in users forms
+      module ClassMethods
+        def __initialize_validations(_subclass); end
+      end
+
+      # rubocop:disable Naming/PredicateMethod
+      def __apply_validations(_params)
+        valid?
+      end
+      # rubocop:enable Naming/PredicateMethod
+    end
+  end
+end

data/lib/tramway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tramway
-  VERSION = '2.2.5.4'
+  VERSION = '2.2.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 2.2.5.4
+  version: 2.2.6
 platform: ruby
 authors:
 - kalashnikovisme
@@ -263,6 +263,7 @@ files:
 - lib/tramway/forms/fields.rb
 - lib/tramway/forms/normalizations.rb
 - lib/tramway/forms/properties.rb
+- lib/tramway/forms/validations.rb
 - lib/tramway/helpers/component_helper.rb
 - lib/tramway/helpers/decorate_helper.rb
 - lib/tramway/helpers/form_helper.rb