tramway 0.5.5.1 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e2e7bd75d61196a4ba4302fe3c05d5dfce6928a35ea0d97022b9170ce911ca8
-  data.tar.gz: 1b89b1fb5a18ae6d28c8afb1b8a1d94da832f0855c1acf1f5ab4f9fb0f1d4bd7
+  metadata.gz: ff761d41cd4748bf3d7e1451825da24764f69077b842e92f7be6baf0f14dff55
+  data.tar.gz: d9c3b25519ab3eb4dfe9c7d2e26d8dffb339a2743b6c5c494495bd4c5b71fc6c
 SHA512:
-  metadata.gz: 4565144363a3419833bb267231fc403ff49c1da50caa3ee4ec936d6a2245fc2ddf89ab111af33cc7a5759cd9bc51d90cc456e5108acc78b73e99ca7ea5107158
-  data.tar.gz: a83591d638a439dcd659474cfd50b73f9f292bff11fd2e18987c821df25888a9de4ae68d16fb2d7048eb36949869350339b8c3104ffaa71f92f97042d2a84ba9
+  metadata.gz: bb0c9c5121dc9a8213a0011c07265b2c42a486218966725df559c31f48b1f1e0cbbb50dc7fd10ddaac13f00a14d55ae57be42e121a1c1d44b1560822425f54af
+  data.tar.gz: 4488ab5046c8fee6150ee80459df3859f0a2d8b62948cfb91af93052dce2f0788aa067dde8261c9df0708ad31c853c522adc65c91c907cc71b4418c17bfc4244

data/README.md

@@ -29,17 +29,18 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem "tramway"
-gem "haml-rails"
-gem "kaminari"
-gem "view_component"
 ```
 
-OR
+Then install Tramway and its dependencies:
 
 ```shell
-bundle add tramway view_component kaminari view_component
+bundle install
+bin/rails g tramway:install
 ```
 
+The install generator adds the required gems (`haml-rails`, `kaminari`, `view_component`, and `dry-initializer`) to your
+application's Gemfile—if they are not present—and appends the Tailwind safelist configuration Tramway ships with.
+
 ## Getting Started
 
 **Step 1**
@@ -78,7 +79,9 @@ end
 
 **Step 4**
 
-Copy this [file](https://github.com/Purple-Magic/tramway/blob/main/config/tailwind.config.js) to config/tailwind.config.js
+If you ran `bin/rails g tramway:install`, the Tailwind safelist was already appended to `config/tailwind.config.js`.
+Otherwise, copy this [file](https://github.com/Purple-Magic/tramway/blob/main/config/tailwind.config.js) to
+`config/tailwind.config.js`.
 
 
 **Step 5**
@@ -581,6 +584,7 @@ Tramway provides `tramway_form_for` helper that renders Tailwind-styled forms by
 ```ruby
 = tramway_form_for @user do |f|
   = f.text_field :text
+  = f.email_field :email
   = f.password_field :password
   = f.select :role, [:admin, :user]
   = f.multiselect :permissions, [['Create User', 'create_user'], ['Update user', 'update_user']]
@@ -592,12 +596,38 @@ will render [this](https://play.tailwindcss.com/xho3LfjKkK)
 
 Available form helpers:
 * text_field
+* email_field
 * password_field
 * file_field
 * select
 * multiselect ([Stimulus-based](https://github.com/Purple-Magic/tramway#stimulus-based-inputs))
 * submit
 
+**Examples**
+
+1. Sign In Form for `devise` authentication
+
+*app/views/devise/sessions/new.html.haml*
+```haml
+  = tramway_form_for(resource, as: resource_name, url: session_path(resource_name), class: 'bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4') do |f|
+    = component 'forms/errors', record: resource
+
+    = f.text_field :email, placeholder: "Your email"
+    = f.password_field :password, placeholder: "Your password"
+
+    = f.submit "Sign In"
+```
+
+2. Sign In Form for Rails authorization
+
+*app/views/sessions/new.html.haml*
+```haml
+= form_with url: login_path, scope: :session, local: true, builder: Tailwinds::Form::Builder do |form|
+    = form.email_field :email
+    = form.password_field :password
+    = form.submit "Log in"
+```
+
 #### Stimulus-based inputs
 
 `tramway_form_for` provides Tailwind-styled Stimulus-based custom inputs.

data/app/components/tailwinds/back_button_component.html.haml

@@ -0,0 +1,2 @@
+%a.btn.btn-delete.bg-orange-500.hover:bg-orange-700.text-white.font-bold.py-2.px-4.rounded.ml-2{ onclick: "window.history.back(); return false;", href: '#' }
+  = t('actions.back')

data/app/components/tailwinds/back_button_component.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  # Backbutton component
+  class BackButtonComponent < BaseComponent
+  end
+end

data/app/components/tailwinds/base_component.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  # Shared base component for Tailwinds components
+  class BaseComponent < Tramway::Component::Base
+  end
+end

data/app/components/tailwinds/button_component.html.haml

@@ -0,0 +1,12 @@
+- if text.present?
+  - if method == :get
+    = link_to text, path, class: classes, **options.except(:class)
+  - else
+    = button_to text, path, method:, class: classes, **options.except(:class)
+- else
+  - if method == :get
+    = link_to path, class: classes, **options.except(:class) do
+      = content
+  - else
+    = button_to path, method:, class: classes, **options.except(:class) do
+      = content

data/app/components/tailwinds/button_component.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  # Default Tramway button
+  #
+  class ButtonComponent < BaseComponent
+    option :text, optional: true, default: -> {}
+    option :path
+    option :color, default: -> { :blue }
+    option :type, default: -> { :default }
+    option :size, default: -> { :middle }
+    option :method, optional: true, default: -> { :get }
+    option :options, optional: true, default: -> { {} }
+
+    def size_classes
+      case size
+      when :small
+        'text-sm py-1 px-1'
+      when :middle
+        'py-2 px-4'
+      end
+    end
+
+    def classes
+      (default_classes +
+        light_mode_classes +
+        dark_mode_classes +
+        (method == :get ? %w[px-1 h-fit] : ['cursor-pointer'])).compact.join(' ')
+    end
+
+    def default_classes
+      [
+        'btn',
+        'btn-primary',
+        'font-bold',
+        'rounded-sm',
+        'flex',
+        'flex-row',
+        size_classes.to_s,
+        options[:class].to_s
+      ]
+    end
+
+    def light_mode_classes
+      [
+        "bg-#{color}-500",
+        "hover:bg-#{color}-700",
+        'text-white'
+      ]
+    end
+
+    def dark_mode_classes
+      [
+        "dark:bg-#{color}-600",
+        "dark:hover:bg-#{color}-800",
+        'dark:text-gray-300'
+      ]
+    end
+  end
+end

data/app/components/tailwinds/containers/narrow_component.html.haml

@@ -0,0 +1,3 @@
+.container.p-4.flex.align-center.justify-center.w-full.mx-auto.bg-gray-100.dark:bg-gray-900.text-gray-900.dark:text-white{ id: }
+  .flex.flex-col.justify-center.w-full.py-8.dark:text-white
+    = content

data/app/components/tailwinds/containers/narrow_component.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Tailwinds
+  module Containers
+    # Default page container in Tramway
+    class NarrowComponent < Tramway::Component::Base
+      option :id, optional: true, default: proc { SecureRandom.uuid }
+    end
+  end
+end

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

@@ -11,34 +11,33 @@ module Tailwinds
         @form_size = options[:size] || options['size'] || :middle
       end
 
-      def text_field(attribute, **options, &)
+      def common_field(component_name, input_method, attribute, **options, &)
         sanitized_options = sanitize_options(options)
 
-        render(Tailwinds::Form::TextFieldComponent.new(
-                 input: input(:text_field),
+        component_class = "Tailwinds::Form::#{component_name.to_s.camelize}Component".constantize
+
+        render(component_class.new(
+                 input: input(input_method),
                  value: get_value(attribute, sanitized_options),
                  **default_options(attribute, sanitized_options)
-               ), &)
+               ),
+               &)
       end
 
-      def number_field(attribute, **options, &)
-        sanitized_options = sanitize_options(options)
+      def text_field(attribute, **, &)
+        common_field(:text_field, :text_field, attribute, **, &)
+      end
 
-        render(Tailwinds::Form::NumberFieldComponent.new(
-                 input: input(:number_field),
-                 value: get_value(attribute, sanitized_options),
-                 **default_options(attribute, sanitized_options)
-               ), &)
+      def email_field(attribute, **, &)
+        common_field(:text_field, :email_field, attribute, **, &)
       end
 
-      def text_area(attribute, **options, &)
-        sanitized_options = sanitize_options(options)
+      def number_field(attribute, **, &)
+        common_field(:number_field, :number_field, attribute, **, &)
+      end
 
-        render(Tailwinds::Form::TextAreaComponent.new(
-                 input: input(:text_area),
-                 value: get_value(attribute, sanitized_options),
-                 **default_options(attribute, sanitized_options)
-               ), &)
+      def text_area(attribute, **, &)
+        common_field(:text_area, :text_area, attribute, **, &)
       end
 
       def password_field(attribute, **options, &)
@@ -95,7 +94,7 @@ module Tailwinds
       end
 
       def get_value(attribute, options)
-        options[:value] || object.public_send(attribute)
+        options[:value] || (object.present? ? object.public_send(attribute) : nil)
       end
 
       def default_options(attribute, options)

data/config/tailwind.config.js

@@ -1,13 +1,25 @@
 module.exports = {
   safelist: [
+    // === Navbar ===
+    'ml-4',
+    
+    // === Custom table layout utilities ===
     'div-table',
     'div-table-row',
     'div-table-cell',
+    'sm:text-base',
+    'last:border-b-0',
+
+    // === Visibility and typography helpers ===
     'hidden',
+    'xl:hidden',
     'text-xl',
     'text-4xl',
     'font-bold',
-    'xl:hidden',
+    'text-right',
+
+    // === Grid templates used for configurable layouts ===
+    'grid',
     'grid-cols-1',
     'grid-cols-2',
     'grid-cols-3',
@@ -18,44 +30,112 @@ module.exports = {
     'grid-cols-8',
     'grid-cols-9',
     'grid-cols-10',
-    'text-right',
-    'w-2/3',
+
+    // === Page container and alignment helpers ===
+    'container',
+    'mx-auto',
+    'align-center',
+    'justify-center',
+
+    // === Flexbox layout utilities ===
     'flex',
-    'bg-purple-700',
+    'flex-col',
+    'flex-wrap',
+    'flex-row-reverse',
+    'flex-auto',
+    'flex-initial',
+    'justify-between',
+    'justify-end',
+    'space-x-1',
+    'items-center',
+
+    // === Responsive visibility helpers ===
+    'sm:hidden',
+    'sm:flex',
+
+    // === Sizing utilities ===
+    'w-2/3',
+    'w-full',
+    'w-fit',
+    'w-8',
+    'min-w-96',
+    'max-w-full',
+
+    // === Spacing utilities ===
+    'p-4',
     'px-6',
-    'px-3',
     'px-4',
+    'px-3',
+    'py-8',
     'py-4',
     'py-2',
     'mb-2',
-    'dark:placeholder-gray-400',
+    'mt-8',
+    'mt-2',
+
+    // === Pagination styles ===
+    'bg-white',
+    'rounded-md',
+    'hover:bg-purple-100',
+    'hover:bg-gray-100',
+    'hover:bg-gray-300',
+    'hover:text-gray-800',
+
+    // === Dark mode pagination styles ===
     'dark:text-white',
     'dark:bg-gray-800',
-    'dark:bg-gray-900',
     'dark:hover:bg-gray-700',
+    'dark:bg-gray-900',
     'dark:bg-gray-700',
     'dark:text-gray-400',
-    'dark:hover:bg-gray-700',
     'dark:hover:text-gray-400',
-    'ml-4',
-    'sm:text-base',
-    'sm:hidden',
-    'sm:flex',
-    'last:border-b-0',
-    'hover:bg-gray-100',
-    'hover:bg-gray-300',
-    'hover:text-gray-800',
-    'mt-8',
-    'justify-between',
-    'space-x-1',
-    'justify-end',
-    'mt-2',
+    'dark:placeholder-gray-400',
+
+    // === Button and badge helpers ===
+    'bg-purple-700',
+    'rounded',
+    'rounded-full',
+    'rounded-t',
+    'font-medium',
+    'font-normal',
+    'text-xs',
+
+    // === Form state helpers ===
     'disabled:bg-gray-100',
     'disabled:text-gray-400',
     'disabled:cursor-not-allowed',
-    // pagination
-    'bg-white', 'rounded-md', 'hover:bg-purple-100', 'dark:text-white', 'dark:bg-gray-800', 'dark:hover:bg-gray-700',
-    // multiselect styles
-    'absolute', 'shadow', 'top-11', 'z-40', 'w-full', 'lef-0', 'rounded', 'max-h-select', 'overflow-y-auto', 'cursor-pointer', 'rounded-t', 'border-b', 'hover:bg-teal-100', 'items-center', 'border-transparent', 'border-l-2,', 'relative', 'hover:border-teal-100', 'leading-6', 'bg-transparent', 'appearance-none', 'outline-none', 'h-full' , 'justify-center', 'm-1', 'font-medium', 'rounded-full', 'text-teal-700', 'bg-teal-100', 'border', 'border-teal-300', 'text-xs', 'font-normal', 'leading-none', 'max-w-full', 'flex-initial', 'flex-auto', 'flex-row-reverse',, 'flex-col', 'min-w-96', 'w-fit', 'flex-wrap', 'w-8', 'border-l',
+    'mb-4',
+    'bg-red-500',
+    'hover:bg-red-700',
+
+    // === Multiselect dropdown positioning ===
+    'absolute',
+    'relative',
+    'shadow',
+    'top-11',
+    'z-40',
+    'left-0',
+    'max-h-select',
+    'overflow-y-auto',
+    'cursor-pointer',
+
+    // === Multiselect option styling ===
+    'border-b',
+    'border',
+    'border-l',
+    'border-l-2',
+    'border-transparent',
+    'border-teal-300',
+    'hover:border-teal-100',
+    'bg-teal-100',
+    'bg-transparent',
+    'text-teal-700',
+    'leading-6',
+    'leading-none',
+    'appearance-none',
+    'outline-none',
+    'h-full',
+    'm-1',
+    'hover:bg-teal-100',
   ],
 }

data/lib/generators/tramway/install/install_generator.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'fileutils'
+
+module Tramway
+  module Generators
+    # Running `rails generate tramway:install` will invoke this generator
+    #
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Installs Tramway dependencies and Tailwind safelist configuration.'
+
+      def ensure_dependencies
+        missing_dependencies = gem_dependencies.reject do |dependency|
+          gemfile_contains?(dependency[:name])
+        end
+
+        return if missing_dependencies.empty?
+
+        append_to_file 'Gemfile', <<~GEMS
+
+          # Tramway dependencies
+          #{missing_dependencies.pluck(:declaration).join("\n")}
+
+        GEMS
+      end
+
+      def ensure_tailwind_safelist
+        return create_tailwind_config unless File.exist?(tailwind_config_path)
+
+        source_entries = extract_safelist_entries(File.read(gem_tailwind_config_path))
+        target_content = File.read(tailwind_config_path)
+        target_entries = extract_safelist_entries(target_content)
+
+        missing_entries = source_entries - target_entries
+        return if missing_entries.empty?
+
+        File.write(tailwind_config_path, insert_entries(target_content, missing_entries))
+      end
+
+      def ensure_tailwind_application_stylesheet
+        path = tailwind_application_stylesheet_path
+        FileUtils.mkdir_p(File.dirname(path))
+
+        return create_file(path, "#{tailwind_css_import_line}\n") unless File.exist?(path)
+
+        content = File.read(path)
+        return if content.include?(tailwind_css_import_line)
+
+        File.open(path, 'a') do |file|
+          file.write("\n") unless content.empty? || content.end_with?("\n")
+          file.write("#{tailwind_css_import_line}\n")
+        end
+      end
+
+      private
+
+      def gem_dependencies
+        @gem_dependencies ||= [
+          { name: 'haml-rails', declaration: 'gem "haml-rails"' },
+          { name: 'kaminari', declaration: 'gem "kaminari"' },
+          { name: 'view_component', declaration: 'gem "view_component"' },
+          { name: 'dry-initializer', declaration: "gem 'dry-initializer'" }
+        ]
+      end
+
+      def gemfile_path
+        @gemfile_path ||= File.join(destination_root, 'Gemfile')
+      end
+
+      def gemfile_contains?(name)
+        return false unless File.exist?(gemfile_path)
+
+        content = File.read(gemfile_path)
+        content.match?(/^\s*gem ['"]#{Regexp.escape(name)}['"]/)
+      end
+
+      def tailwind_config_path
+        @tailwind_config_path ||= File.join(destination_root, 'config/tailwind.config.js')
+      end
+
+      def gem_tailwind_config_path
+        @gem_tailwind_config_path ||= File.expand_path('../../../../config/tailwind.config.js', __dir__)
+      end
+
+      def tailwind_application_stylesheet_path
+        @tailwind_application_stylesheet_path ||= File.join(destination_root, 'app/assets/tailwind/application.css')
+      end
+
+      def tailwind_css_import_line
+        '@import "tailwindcss";'
+      end
+
+      def create_tailwind_config
+        create_file tailwind_config_path, File.read(gem_tailwind_config_path)
+      end
+
+      def extract_safelist_entries(content)
+        section = safelist_section(content)
+        return [] if section.nil?
+
+        section.scan(/'([^']+)'/).flatten.map(&:strip).reject(&:empty?).uniq
+      end
+
+      def safelist_section(content)
+        match = content.match(/safelist\s*:\s*\[(.*?)\]\s*,?/m)
+        match&.[](1)
+      end
+
+      def insert_entries(content, entries)
+        match = content.match(/safelist\s*:\s*\[(.*?)\](\s*,?)/m)
+        return content unless match
+
+        closing_index = match.begin(0) + match[0].rindex(']')
+        indentation = closing_indentation(content, closing_index)
+        formatted_entries = entries.map { |entry| "#{indentation}'#{entry}',\n" }.join
+
+        needs_leading_newline = content[closing_index - 1] != "\n"
+        insertion = String.new
+        insertion << "\n" if needs_leading_newline
+        insertion << formatted_entries
+
+        content.dup.insert(closing_index, insertion)
+      end
+
+      def closing_indentation(content, index)
+        line_start = content.rindex("\n", index - 1) || 0
+        line = content[line_start..index]
+        line[/^\s*/] || '  '
+      end
+    end
+  end
+end

data/lib/tramway/helpers/views_helper.rb

@@ -12,6 +12,45 @@ module Tramway
           &
         )
       end
+
+      def tramway_table(**options, &)
+        component 'tailwinds/table', options:, &
+      end
+
+      def tramway_row(**options, &)
+        component 'tailwinds/table/row',
+                  cells: options.delete(:cells),
+                  href: options.delete(:href),
+                  options:,
+                  &
+      end
+
+      def tramway_cell(&)
+        component 'tailwinds/table/cell', &
+      end
+
+      def tramway_button(path:, text: nil, method: :get, **options)
+        component 'tailwinds/button',
+                  text:,
+                  path:,
+                  method:,
+                  color: options.delete(:color),
+                  type: options.delete(:type),
+                  size: options.delete(:size),
+                  options:
+      end
+
+      def tramway_back_button
+        component 'tailwinds/back_button'
+      end
+
+      def tramway_container(id: nil, &)
+        if id.present?
+          component 'tailwinds/containers/narrow', id: id, &
+        else
+          component 'tailwinds/containers/narrow', &
+        end
+      end
     end
   end
 end

data/lib/tramway/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 0.5.5.1
+  version: '0.6'
 platform: ruby
 authors:
 - kalashnikovisme
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-23 00:00:00.000000000 Z
+date: 2025-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -143,6 +143,13 @@ files:
 - app/assets/javascripts/tramway/table_row_preview_controller.js
 - app/components/tailwind_component.html.haml
 - app/components/tailwind_component.rb
+- app/components/tailwinds/back_button_component.html.haml
+- app/components/tailwinds/back_button_component.rb
+- app/components/tailwinds/base_component.rb
+- app/components/tailwinds/button_component.html.haml
+- app/components/tailwinds/button_component.rb
+- app/components/tailwinds/containers/narrow_component.html.haml
+- app/components/tailwinds/containers/narrow_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
@@ -214,6 +221,7 @@ files:
 - app/views/tramway/layouts/application.html.haml
 - config/routes.rb
 - config/tailwind.config.js
+- lib/generators/tramway/install/install_generator.rb
 - lib/kaminari/helpers/tag.rb
 - lib/rules/turbo_html_attributes_rules.rb
 - lib/tasks/tramway_tasks.rake