tramway 0.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e8751e6e662061508bb687b258c13f3dcb40460344959595a66c998608e38af
-  data.tar.gz: 66076bba6be9af35c2e787bf43e8e6cb00877bd5f5b53cf4b70ce37a09f78c2b
+  metadata.gz: 817cf3ad464278dbd553e1e6d48c740a85305ca7ad8e4caac6a3d2fecc87041a
+  data.tar.gz: c3b5dadac4b6283f251c5647cb1d5dd2703c858a3e2a4730e0a80424b7c71e1a
 SHA512:
-  metadata.gz: aec595653662af5dfe38f8d402dd799d8da2ad77ba8c3e032aba22c56020467f9b4ee1f701a07e7477ecbd34ff7725c32fac18a6a359513e064dbbdc567d703c
-  data.tar.gz: 5e1799a4d4290ac7bf5e9bd8c1fe524119eb4449ffe0ddeccb3ecf934343160672572c22e834f76a7bebe522d4ca226aa08ce8336ba1f56f88dc53fe692eba72
+  metadata.gz: '079777145b30d2bf2695a14c71b77ef0470a5e29ddd4c0b2bcc43f14bf711e9f96d674bfa814b84eb7dda438167ddaa584717aa52039c2b1a2e8b787ac7e8719'
+  data.tar.gz: be3904286806a86296274d42026d11a00308e80eb5fa14e0f7e794fc78e70b70040a813f727c2723b7b87289b6ff355e068a30a3cbe2ea4bdd95ee9680ca0258

data/README.md

@@ -7,6 +7,7 @@ Unite Ruby on Rails brilliance. Streamline development with Tramway.
   * [Tramway Decorators](https://github.com/Purple-Magic/tramway#tramway-decorators)
   * [Tramway Form](https://github.com/Purple-Magic/tramway#tramway-form)
   * [Tramway Navbar](https://github.com/Purple-Magic/tramway#tramway-navbar)
+  * [Tailwind-styled forms](https://github.com/Purple-Magic/tramway#tailwind-styled-forms)
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -312,10 +313,30 @@ tramway_navbar title: 'Purple Magic' do |nav|
 end
 ```
 
-### Tailwind components
+### Tailwind-styled forms
 
 Tramway uses [Tailwind](https://tailwindcss.com/) by default. All UI helpers are implemented with [ViewComponent](https://github.com/viewcomponent/view_component).
 
+#### tramway_form_for
+
+Tramway provides `tramway_form_for` helper that renders Tailwind-styled forms by default.
+
+```ruby
+= tramway_form_for User.new do |f|
+  = f.text_field :text
+  = f.password_field :password
+  = f.file_field :file
+  = f.submit "Create User"
+```
+
+will render [this](https://play.tailwindcss.com/xho3LfjKkK)
+
+Available form helpers:
+* text_field
+* password_field
+* file_field
+* submit
+
 ## Contributing
 
 Install [lefthook](https://github.com/evilmartians/lefthook)

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  module Form
+    # Provides Tailwind-styled forms
+    class Builder < Tramway::Views::FormBuilder
+      def text_field(attribute, **options, &)
+        input = super(attribute, **options.merge(class: text_input_class))
+        render(Tailwinds::Form::TextFieldComponent.new(input, attribute, object_name:, **options), &)
+      end
+
+      def password_field(attribute, **options, &)
+        input = super(attribute, **options.merge(class: text_input_class))
+        render(Tailwinds::Form::TextFieldComponent.new(input, attribute, object_name:, **options), &)
+      end
+
+      def file_field(attribute, **options, &)
+        input = super(attribute, **options.merge(class: :hidden))
+
+        render(Tailwinds::Form::FileFieldComponent.new(input, attribute, object_name:, **options), &)
+      end
+
+      def submit(action, **options, &)
+        render(Tailwinds::Form::SubmitButtonComponent.new(action, **options), &)
+      end
+
+      private
+
+      def text_input_class
+        'w-full px-3 py-2 border border-gray-300 rounded focus:outline-none focus:border-red-500'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+.mb-4
+  %label.inline-block.bg-blue-500.hover:bg-blue-700.text-white.font-bold.py-2.px-4.rounded.cursor-pointer.mt-4{ for: @for }
+    = @label
+  = @input

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  module Form
+    # Tailwind-styled file_field input
+    class FileFieldComponent < TailwindComponent
+      def initialize(input, attribute, object_name: nil, **options)
+        @label = options[:label] || attribute.to_s.capitalize
+        @for = "#{object_name}_#{attribute}"
+        @input = input
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+.flex.items-center.justify-between
+  %button.bg-red-500.hover:bg-red-700.text-white.font-bold.py-2.px-4.rounded.focus:outline-none.focus:shadow-outline{ type: :submit, name: :commit, **@options }
+    = @text
+  = @content

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  module Form
+    # Tailwind-styled submit button
+    class SubmitButtonComponent < TailwindComponent
+      def initialize(action, **options)
+        @options = options.except :type
+
+        @text = action.is_a?(String) ? action : action.to_s.capitalize
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+.mb-4
+  %label.block.text-gray-700.text-sm.font-bold.mb-2{ for: @for }
+    = @label
+  = @input

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  module Form
+    # Tailwind-styled text field
+    class TextFieldComponent < TailwindComponent
+      def initialize(input, attribute, object_name: nil, **options)
+        @label = options[:label] || attribute.to_s.humanize
+        @for = "#{object_name}_#{attribute}"
+        @input = input
+      end
+    end
+  end
+end

data/lib/tramway/engine.rb

@@ -13,6 +13,12 @@ module Tramway
         loaded_class.include Tramway::Helpers::NavbarHelper
       end
 
+      ActiveSupport.on_load(:action_view) do |loaded_class|
+        require 'tramway/helpers/views_helper'
+
+        loaded_class.include Tramway::Helpers::ViewsHelper
+      end
+
       ActiveSupport.on_load(:action_controller) do |loaded_class|
         require 'tramway/helpers/decorate_helper'
 

data/lib/tramway/helpers/navbar_helper.rb

@@ -4,7 +4,7 @@ require 'tramway/navbar'
 
 module Tramway
   module Helpers
-    # Providing navbar helpers for ActionView
+    # Provides navbar helpers for ActionView
     module NavbarHelper
       def tramway_navbar(**options)
         initialize_navbar

data/lib/tramway/helpers/views_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Helpers
+    # Provides view-oriented helpers for ActionView
+    module ViewsHelper
+      def tramway_form_for(object, *args, **options, &)
+        form_for(object, *args, **options.merge(builder: Tailwinds::Form::Builder), &)
+      end
+    end
+  end
+end

data/lib/tramway/version.rb

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

data/lib/tramway/views/form_builder.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Views
+    # ActionView Form Builder helps us use ViewComponent as form helpers
+    class FormBuilder < ActionView::Helpers::FormBuilder
+      attr_reader :template
+
+      private
+
+      def render(component, &)
+        component.render_in(template, &)
+      end
+    end
+  end
+end

data/lib/tramway.rb

@@ -6,6 +6,7 @@ require 'tramway/engine'
 require 'tramway/base_decorator'
 require 'tramway/base_form'
 require 'tramway/config'
+require 'tramway/views/form_builder'
 require 'view_component/compiler'
 require 'view_component/engine'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.3.1
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-04 00:00:00.000000000 Z
+date: 2023-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -93,6 +93,13 @@ files:
 - Rakefile
 - app/components/tailwind_component.html.haml
 - app/components/tailwind_component.rb
+- app/components/tailwinds/form/builder.rb
+- app/components/tailwinds/form/file_field_component.html.haml
+- app/components/tailwinds/form/file_field_component.rb
+- app/components/tailwinds/form/submit_button_component.html.haml
+- app/components/tailwinds/form/submit_button_component.rb
+- app/components/tailwinds/form/text_field_component.html.haml
+- app/components/tailwinds/form/text_field_component.rb
 - app/components/tailwinds/nav/item_component.html.haml
 - app/components/tailwinds/nav/item_component.rb
 - app/components/tailwinds/navbar_component.html.haml
@@ -113,9 +120,11 @@ files:
 - lib/tramway/helpers/decorate_helper.rb
 - lib/tramway/helpers/form_helper.rb
 - lib/tramway/helpers/navbar_helper.rb
+- lib/tramway/helpers/views_helper.rb
 - lib/tramway/navbar.rb
 - lib/tramway/utils/render.rb
 - lib/tramway/version.rb
+- lib/tramway/views/form_builder.rb
 - lib/types.rb
 homepage: https://github.com/purple-magic/tramway
 licenses: