tramway 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56f897f311d05eaa3d077f0f02a2b28d116bd2bbdfb7f460b05ab3d481b5b57e
-  data.tar.gz: 4dec440f2451c89ff6b1bd10c93d79ff9a12a99c528129bb19b267bd7f59b95b
+  metadata.gz: def2792e8c3e1ebae5e4d2fa04b7e5edf92b72e4aed0f892cf8152e203c8daf2
+  data.tar.gz: 77eace6936af7c9597f49634ea5da28f699b4011f4ccac811259e659732ca192
 SHA512:
-  metadata.gz: 732effab54397590ae4320802c803c70fe648765ff200ce0e994e396c13eabed2501361c645a7e2a55019a81cdba4987e26615c7c71e5aa05ab1add573188d06
-  data.tar.gz: 77a23247e58a804ff62e2c4a1071db86aae1d746832268d39da9e70fcab5e276264b16d60125da72be38ff40e4f2a01c182cd453b56c66eb02766fe649f65f7c
+  metadata.gz: d6f7a8ed6f51a4658625b8df8f1db6ec2eb7619284eafc6acf0b46d67f0fb9eaf3bfe95e818d7226f52a93a6b81eb271e64335acf76640501132b890e000938d
+  data.tar.gz: 197a0227f09dbccacf37e82d2e5d15a585928b0ec60863c1ce43c20e012b568037e0880f9ffda49a21846c66dcec72f6b1931ff0790509d9c01b6b8da71727d8

data/README.md

@@ -1227,6 +1227,17 @@ In case you need to use Stimulus `change` action with Tramway Select
 <% end %>
 ```
 
+Remote form example:
+
+```erb
+<%= tramway_form_for @user, remote: true do |f| %>
+  <%= f.text_field :name %>
+  <%= f.email_field :email %>
+<% end %>
+```
+
+With `remote: true`, Tramway submits the form on each input `change` via inline JavaScript; no additional controller setup is required.
+
 ### Tailwind-styled pagination for Kaminari
 
 Tramway uses [Tailwind](https://tailwindcss.com/) by default. It has tailwind-styled pagination for [kaminari](https://github.com/kaminari/kaminari).

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

@@ -12,13 +12,19 @@ module Tramway
 
       def initialize(object_name, object, template, options)
         @horizontal = options[:horizontal] || false
+        @remote = options[:remote_submit] || false
 
         options.merge!(class: [options[:class], 'flex flex-row items-center gap-2'].compact.join(' ')) if @horizontal
 
-        super
+        @form_object_class = options[:form_object_class]
+
+        if form_object(object)
+          super(object_name, form_object(object), template, options)
+        else
+          super
+        end
 
         @form_size = options[:size] || options['size'] || :medium
-        @form_object_class = options[:form_object_class]
       end
 
       def common_field(component_name, input_method, attribute, **options, &)
@@ -137,20 +143,55 @@ module Tramway
         unbound_method.bind(self)
       end
 
-      def form_object
-        @form_object_class&.new object
+      def form_object(obj = nil)
+        return obj if obj.is_a?(Tramway::BaseForm)
+        return object if object.is_a?(Tramway::BaseForm)
+
+        @form_object_class&.new(obj || object)
       end
 
       def get_value(attribute, options)
-        options[:value] || form_object&.public_send(attribute).presence || object.presence&.public_send(attribute)
+        return options[:value] if options.key?(:value)
+
+        form_obj = form_object
+        form_value = form_object_value(form_obj, attribute)
+        return form_value unless form_value.nil?
+
+        ensure_object_responds!(attribute, form_obj)
+        object_value(attribute)
+      end
+
+      def form_object_value(form_obj, attribute)
+        return if form_obj.blank?
+
+        form_obj.public_send(attribute)
+      end
+
+      def ensure_object_responds!(attribute, form_obj)
+        return unless object.present? && !object.respond_to?(attribute)
+
+        form_object_part = form_obj.present? ? "#{form_obj.class} or " : ''
+        message = "Neither form object nor object respond to #{attribute}. " \
+                  "You should define #{attribute} method in #{form_object_part}#{object.class}"
+
+        raise ArgumentError, message
+      end
+
+      def object_value(attribute)
+        return if object.blank?
+
+        object.public_send(attribute)
       end
 
       def default_options(attribute, options)
+        options.merge!(horizontal: true) if @horizontal
+        options.merge!(onchange: 'this.form.requestSubmit()') if @remote
+
         {
           attribute:,
           label: label_build(attribute, options),
-          for: for_id(attribute),
-          options: options.merge(horizontal: @horizontal),
+          for: options[:id].presence || for_id(attribute),
+          options: options,
           size: form_size
         }
       end

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

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

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

@@ -4,6 +4,20 @@ module Tramway
   module Form
     # Tailwind-styled checkbox field
     class CheckboxComponent < TailwindComponent
+      def label_classes
+        default_classes = 'cursor-pointer mb-0'
+
+        case size
+        when :small
+          default_classes += ' text-sm'
+        when :medium
+          default_classes += ' text-base'
+        when :large
+          default_classes += ' text-lg'
+        end
+
+        default_classes
+      end
     end
   end
 end

data/app/components/tramway/form/date_field_component.html.haml

@@ -1,6 +1,6 @@
 %div{ class: default_container_classes }
   - if @label
-    = component('tramway/form/label', for: @for) do
+    = component('tramway/form/label', for: @for, class: 'mb-0') do
       = @label
   - classes = "#{size_class(:text_input)} #{text_input_base_classes}"
   = @input.call @attribute, **@options.merge(class: classes), value: @value

data/app/components/tramway/form/datetime_field_component.html.haml

@@ -1,6 +1,6 @@
 %div{ class: default_container_classes }
   - if @label
-    = component('tramway/form/label', for: @for) do
+    = component('tramway/form/label', for: @for, class: 'mb-0') do
       = @label
   - classes = "#{size_class(:text_input)} #{text_input_base_classes}"
   = @input.call @attribute, **@options.merge(class: classes), value: @value

data/app/components/tramway/form/label_component.html.haml

@@ -1,2 +1,2 @@
-%label{ for: @for, class: form_label_classes }
+%label{ for: @for, class: "#{form_label_classes} #{options[:class]}" }
   = content

data/app/components/tramway/form/label_component.rb

@@ -5,10 +5,11 @@ module Tramway
     # Form label for all tailwind-styled forms
     class LabelComponent < Tramway::BaseComponent
       option :for
+      option :options, optional: true, default: -> { {} }
 
       def form_label_classes
         theme_classes(
-          classic: 'block text-sm font-semibold mb-2 text-white'
+          classic: 'block font-semibold text-white'
         )
       end
     end

data/app/components/tramway/form/number_field_component.html.haml

@@ -1,6 +1,6 @@
 %div{ class: default_container_classes }
   - if @label
-    = component('tramway/form/label', for: @for) do
+    = component('tramway/form/label', for: @for, class: 'mb-0') do
       = @label
   - classes = "#{size_class(:text_input)} #{text_input_base_classes}"
   = @input.call @attribute, **@options.merge(class: classes), value: @value

data/app/components/tramway/form/select_component.html.haml

@@ -1,6 +1,6 @@
 %div{ class: default_container_classes }
   - if @label
-    = component('tramway/form/label', for: @for) do
+    = component('tramway/form/label', for: @for, class: 'mb-0') do
       = @label
   - classes = "#{size_class(:select_input)} #{select_base_classes}"
   = @input.call(@attribute, @collection, { selected: @value }, @options.merge(class: classes))

data/app/components/tramway/form/text_area_component.html.haml

@@ -1,6 +1,6 @@
 %div{ class: default_container_classes }
   - if @label
-    = component('tramway/form/label', for: @for) do
+    = component('tramway/form/label', for: @for, class: 'mb-0') do
       = @label
   - classes = "#{size_class(:text_input)} #{text_input_base_classes}"
   = @input.call @attribute, **@options.merge(class: classes), value: @value

data/app/components/tramway/form/text_field_component.html.haml

@@ -1,6 +1,6 @@
 %div{ class: default_container_classes }
   - if @label
-    = component('tramway/form/label', for: @for) do
+    = component('tramway/form/label', for: @for, class: 'mb-0') do
       = @label
   - classes = "#{size_class(:text_input)} #{text_input_base_classes}"
   = @input.call @attribute, **@options.merge(class: classes), value: @value

data/app/components/tramway/form/time_field_component.html.haml

@@ -1,6 +1,6 @@
 %div{ class: default_container_classes }
   - if @label
-    = component('tramway/form/label', for: @for) do
+    = component('tramway/form/label', for: @for, class: 'mb-0') do
       = @label
   - classes = "#{size_class(:text_input)} #{text_input_base_classes}"
   = @input.call @attribute, **@options.merge(class: classes), value: @value

data/app/components/tramway/form/tramway_select_component.html.haml

@@ -1,6 +1,6 @@
 .relative{ class: default_container_classes }
   - if @label
-    = component('tramway/form/label', for: @for) do
+    = component('tramway/form/label', for: @for, class: 'mb-0') do
       = @label
   %div{ role: :combobox, data: tramway_select_hash, id: "#{@for}_tramway_select", class: tramway_select_classes }
     - classes = "#{size_class(:tramway_select_input)} #{select_base_classes}"

data/config/tailwind.config.js

@@ -333,6 +333,10 @@ module.exports = {
     'bg-red-100',
     'text-red-800',
     'space-x-2',
+    'h-5',
+    'w-5',
+    'rounded-full',
+    'mb-0',
 
     // === Tramway select dropdown positioning ===
     'absolute',

data/docs/AGENTS.md

@@ -173,6 +173,10 @@ Available `tramway_form_for` helpers:
 - `tramway_select`
 - `submit`
 
+### Rule 7.1
+Use `tramway_form_for(remote: true)` only when the form must submit asynchronously and update part of the current page (for example: modal forms, inline edits, or list updates without full page reload).
+For standard create/update flows that redirect and show regular flash messages, keep it synchronous (do not set `remote: true`).
+
 ### Rule 8
 Inherit all components from Tramway::BaseComponent
 
@@ -532,7 +536,15 @@ Always `tramway_decorate` and `tramway_form` for creating these types of objects
 In Tramway Decorators, use `delegate_attributes` method instead of `delegate :something, to: :object`
 
 ### Rule 33
-In case you want to use container on the page, use `tramway_container` helper instead of creating a component for that or using a plain div with Tailwind classes.
+In case you want to use container on the page, use `tramway_container` helper instead of creating a component for that or using a plain div with Tailwind classes. In case you need to use container in layout view, use `tramway_main_container` for this. Here is example of using `tramway_main_container` inside application layout.
+
+```
+= tramway_main_container do
+  - if flash.any?
+    = tramway_flash text: flash[:notice].presence || flash[:alert],
+      type: flash[:notice].present? ? :will : :rage,
+      id: 'flash-container'
+```
 
 ## Controller Patterns
 

data/lib/tramway/helpers/views_helper.rb

@@ -11,12 +11,12 @@ module Tramway
       def tramway_form_for(object, *, size: :medium, **options, &)
         form_object_class = object.is_a?(Tramway::BaseForm) ? object.class : nil
 
-        form_for(
-          object,
-          *,
-          **options.merge(builder: Tramway::Form::Builder, size: normalize_form_size(size), form_object_class:),
-          &
-        )
+        form_for(object, *, **options.merge(
+          builder: Tramway::Form::Builder,
+          size: normalize_form_size(size),
+          form_object_class:,
+          remote_submit: options[:remote] || false
+        ), &)
       end
 
       def tramway_table(**options, &)

data/lib/tramway/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - kalashnikovisme