tramway 2.2.5.4 → 2.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7951f9f78870d2dc7a6d12d1125fffe641251d68de9039231c44be35d3be322e
-  data.tar.gz: 2665a1a1d5b8187d9b7a7ec2d19ff75a56e41028195c3eac13c603e85affee5e
+  metadata.gz: 908989b8908005e2022039beec8b7b47c4a7200166c77fe33c2dd27891d2fe58
+  data.tar.gz: b57f2f3717522d10885d7ba83464590ff21ce87fa24af5c46deb85b0fac806cd
 SHA512:
-  metadata.gz: 0d0ca70e859144c58767deca5c540faa6e472a7ada951089ef3aa735f3eeb969e99daa47b0aad7bd679e237255f7ef384e8eecbd01cc2fcf970a11330de4e808
-  data.tar.gz: cd3ad4af73eb6a2b3720da8cd0ecee12155a98f53e2017d7c3c4327bea120f1fa03d8e44344844f4315420b8fd61462cd369b8162d4ccbf76d162c0c82741782
+  metadata.gz: 7824108d8dfe9a0c3da312a26d12a84fe1df9424550c6edb29b864634109cc793e883a9f13ff90a7ab40d2e9b833cc6068194055410837cb554dd0e467f802f7
+  data.tar.gz: befb3fe2ad460b34f002ffd58b01ab4c1f9996ff5f402e714bb54b6fa013091004b55e7ed8b558b551dd017bba4609c01072370eae034b77c51f978a8703fa4e

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/app/components/tailwind_component.rb

@@ -18,21 +18,24 @@ class TailwindComponent < Tramway::BaseComponent
       select_input: 'text-sm px-2 py-1',
       file_button: 'text-sm px-3 py-1',
       submit_button: 'text-sm px-3 py-1',
-      multiselect_input: 'text-sm px-2 py-1 h-10'
+      multiselect_input: 'text-sm px-2 py-1 h-10',
+      checkbox_input: 'h-4 w-4'
     },
     medium: {
       text_input: 'text-base px-3 py-2',
       select_input: 'text-base px-3 py-2',
       file_button: 'text-base px-4 py-2',
       submit_button: 'text-base px-4 py-2',
-      multiselect_input: 'text-base px-2 py-1 h-12'
+      multiselect_input: 'text-base px-2 py-1 h-12',
+      checkbox_input: 'h-5 w-5'
     },
     large: {
       text_input: 'text-xl px-4 py-3',
       select_input: 'text-xl px-4 py-3',
       file_button: 'text-xl px-5 py-3',
       submit_button: 'text-xl px-5 py-3',
-      multiselect_input: 'text-xl px-3 py-2 h-15'
+      multiselect_input: 'text-xl px-3 py-2 h-15',
+      checkbox_input: 'h-6 w-6'
     }
   }.freeze
 
@@ -67,6 +70,13 @@ class TailwindComponent < Tramway::BaseComponent
     )
   end
 
+  def checkbox_base_classes
+    theme_classes(
+      classic: 'rounded-full border border-gray-700 bg-gray-900 text-gray-100 shadow-inner focus:outline-none ' \
+               'focus:ring-2 focus:ring-gray-600'
+    )
+  end
+
   def form_label_classes
     theme_classes(
       classic: 'block text-sm font-semibold mb-2 text-gray-200'

data/app/components/tailwinds/form/builder.rb

@@ -68,6 +68,10 @@ module Tailwinds
         render(Tailwinds::Form::FileFieldComponent.new(input:, **default_options(attribute, sanitized_options)), &)
       end
 
+      def check_box(attribute, **, &)
+        common_field(:checkbox, :check_box, attribute, **, &)
+      end
+
       def select(attribute, collection, **options, &)
         sanitized_options = sanitize_options(options)
 

data/app/components/tailwinds/form/checkbox_component.html.haml

@@ -0,0 +1,7 @@
+.flex.items-start.gap-2.mb-4
+  - classes = "#{size_class(:checkbox_input)} #{checkbox_base_classes}"
+  = @input.call @attribute, **@options.merge(class: classes)
+  - if @label
+    %div
+      = component('tailwinds/form/label', for: @for) do
+        = @label

data/app/components/tailwinds/form/checkbox_component.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  module Form
+    # Tailwind-styled checkbox field
+    class CheckboxComponent < TailwindComponent
+    end
+  end
+end

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
 
@@ -422,6 +425,24 @@ and in a controller
   end
 ```
 
+### Rule 27
+Don't create scopes for enumerated values, use `scope: :shallow` of the enumerize gem.
+
+Do this 
+
+```
+enumerize :role, in: [:admin, :default], scope: :shallow
+```
+
+Instead of this
+
+```
+scope :for_role, -> (role) { where role: role }
+```
+
+### Rule 28
+In case, you need to make a one link in tramway_table on each row. Use `tramway_row href: your_link` instead of putting the like inside a cell.
+
 ## Controller Patterns
 
 - Keep actions short and explicit with guard clauses.

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/utils/field.rb

@@ -23,8 +23,10 @@ module Tramway
 
       def field_name(field_data)
         case field_data.to_sym
-        when :text_area, :select, :multiselect
+        when :text_area, :select, :multiselect, :check_box
           field_data
+        when :checkbox
+          :check_box
         else
           "#{field_data}_field"
         end

data/lib/tramway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tramway
-  VERSION = '2.2.5.4'
+  VERSION = '2.2.7'
 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.7
 platform: ruby
 authors:
 - kalashnikovisme
@@ -156,6 +156,8 @@ files:
 - app/components/tailwinds/flash_component.html.haml
 - app/components/tailwinds/flash_component.rb
 - app/components/tailwinds/form/builder.rb
+- app/components/tailwinds/form/checkbox_component.html.haml
+- app/components/tailwinds/form/checkbox_component.rb
 - app/components/tailwinds/form/date_field_component.html.haml
 - app/components/tailwinds/form/date_field_component.rb
 - app/components/tailwinds/form/datetime_field_component.html.haml
@@ -263,6 +265,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