tramway 3.1.2.7 → 4.0

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

@@ -2,12 +2,47 @@
 
 require 'rails/generators'
 require 'fileutils'
+require_relative 'font_awesome_helpers'
+require_relative 'layout_helpers'
 
 module Tramway
   module Generators
     # nodoc
-    # rubocop:disable Metrics/ModuleLength
+    # rubocop:disable-next Metrics/ModuleLength
     module InstallGeneratorHelpers
+      TAILWIND_SCROLLBAR_UTILITY = <<~CSS.chomp
+        @layer utilities {
+          .tramway-scrollbar {
+            scrollbar-width: thin;
+            scrollbar-color: rgba(82, 82, 91, 0.9) rgba(9, 9, 11, 0.92);
+          }
+
+          .tramway-scrollbar::-webkit-scrollbar {
+            width: 0.5rem;
+          }
+
+          .tramway-scrollbar::-webkit-scrollbar-track {
+            background: rgba(9, 9, 11, 0.92);
+          }
+
+          .tramway-scrollbar::-webkit-scrollbar-thumb {
+            border-radius: 9999px;
+            background: rgba(82, 82, 91, 0.9);
+          }
+
+          .tramway-scrollbar::-webkit-scrollbar-thumb:hover {
+            background: rgba(113, 113, 122, 0.95);
+          }
+
+          .tramway-scrollbar::-webkit-scrollbar-corner {
+            background: transparent;
+          }
+        }
+      CSS
+
+      TAILWIND_APPLICATION_STYLESHEET_CONTENT =
+        "@import \"tailwindcss\";\n\n#{TAILWIND_SCROLLBAR_UTILITY}\n".freeze
+
       private
 
       def gem_dependencies
@@ -78,12 +113,13 @@ module Tramway
 
       def stimulus_controller_imports
         [
-          'import { TramwaySelect, TableRowPreview, UiCheckbox, Tooltip } from "@tramway/tramway"'
+          'import { Navbar, TramwaySelect, TableRowPreview, UiCheckbox, Tooltip } from "@tramway/tramway"'
         ]
       end
 
       def stimulus_controller_registrations
         [
+          "application.register('tramway-navbar', Navbar)",
           "application.register('tramway-select', TramwaySelect)",
           "application.register('table-row-preview', TableRowPreview)",
           "application.register('ui--checkbox', UiCheckbox)",
@@ -95,28 +131,6 @@ module Tramway
         @agents_file_path ||= File.join(destination_root, 'AGENTS.md')
       end
 
-      def application_layout_haml_path
-        @application_layout_haml_path ||= File.join(destination_root, 'app/views/layouts/application.html.haml')
-      end
-
-      def application_layout_erb_path
-        @application_layout_erb_path ||= File.join(destination_root, 'app/views/layouts/application.html.erb')
-      end
-
-      def trix_haml_tags
-        "    = stylesheet_link_tag \"trix\", \"data-turbo-track\": \"reload\"\n    " \
-          "= javascript_include_tag \"trix\", \"data-turbo-track\": \"reload\", defer: true\n"
-      end
-
-      def trix_erb_tags
-        "    <%= stylesheet_link_tag \"trix\", \"data-turbo-track\": \"reload\" %>\n    " \
-          "<%= javascript_include_tag \"trix\", \"data-turbo-track\": \"reload\", defer: true %>\n"
-      end
-
-      def trix_already_present?(content)
-        content.include?('stylesheet_link_tag "trix"') || content.include?("stylesheet_link_tag 'trix'")
-      end
-
       def codex_agents_instruction
         'If you are Codex, use the tramway-skill skill for Tramway/Rails work in this project. ' \
           'If tramway-skill is not installed, install it from https://github.com/Purple-Magic/tramway-skill/.'
@@ -134,15 +148,16 @@ module Tramway
       end
 
       def safelist_section(content)
-        match = content.match(/safelist\s*:\s*\[(.*?)\]\s*,?/m)
-        match&.[](1)
+        open_index, close_index = safelist_bracket_range(content)
+        return nil unless open_index
+
+        content[(open_index + 1)...close_index]
       end
 
       def insert_entries(content, entries)
-        match = content.match(/safelist\s*:\s*\[(.*?)\](\s*,?)/m)
-        return content unless match
+        _open_index, closing_index = safelist_bracket_range(content)
+        return content unless closing_index
 
-        closing_index = match.begin(0) + match[0].rindex(']')
         indentation = closing_indentation(content, closing_index)
         formatted_entries = entries.map { |entry| "#{indentation}'#{entry}',\n" }.join
 
@@ -154,6 +169,33 @@ module Tramway
         content.dup.insert(closing_index, insertion)
       end
 
+      # Finds the `[`/`]` pair that delimits the `safelist` array, ignoring brackets that
+      # appear inside quoted entries (e.g. `'md:transition-[width]'`) since a naive regex
+      # would otherwise stop at the first `]`, wherever it occurs.
+      def safelist_bracket_range(content)
+        start_index = content =~ /safelist\s*:\s*\[/
+        return [nil, nil] unless start_index
+
+        open_index = content.index('[', start_index)
+        close_index = matching_bracket_index(content, open_index)
+
+        [open_index, close_index]
+      end
+
+      def matching_bracket_index(content, open_index)
+        depth = 0
+
+        content[open_index..].to_enum(:scan, /'[^']*'|"[^"]*"|[\[\]]/).each do
+          token = Regexp.last_match[0]
+          next unless ['[', ']'].include?(token)
+
+          depth += token == '[' ? 1 : -1
+          return open_index + Regexp.last_match.end(0) - 1 if depth.zero?
+        end
+
+        nil
+      end
+
       def closing_indentation(content, index)
         line_start = content.rindex("\n", index - 1) || 0
         line = content[line_start..index]
@@ -171,30 +213,39 @@ module Tramway
         content.end_with?("\n") ? "\n" : "\n\n"
       end
 
-      # rubocop:disable Metrics/MethodLength
       def append_missing_imports(content)
         content = remove_legacy_stimulus_imports(content)
+        content = normalize_tramway_stimulus_imports(content)
         missing_imports = stimulus_controller_imports.reject { |line| content.include?(line) }
         return content if missing_imports.empty?
 
         import_lines = content.each_line.with_index.filter_map do |line, index|
           index if line.lstrip.start_with?('import ')
         end
-        insertion = "#{missing_imports.join("\n")}\n"
+        insert_missing_imports(content, missing_imports.join("\n"), import_lines)
+      end
+
+      def insert_missing_imports(content, imports, import_lines)
+        insertion = "#{imports}\n"
         updated = content.dup
 
-        if import_lines.any?
-          insertion_index = updated.lines[0..import_lines.max].join.length
-          updated.insert(insertion_index, insertion)
-        else
-          updated.prepend(insertion)
-        end
+        return updated.prepend(insertion) unless import_lines.any?
 
+        insertion_index = updated.lines[0..import_lines.max].join.length
+        updated.insert(insertion_index, insertion)
         updated
       end
-      # rubocop:enable Metrics/MethodLength
+
+      def normalize_tramway_stimulus_imports(content)
+        tramway_import_lines = content.each_line.select { |line| tramway_stimulus_import_line?(line) }
+        return content unless tramway_import_lines.any?
+        return content if normalized_tramway_import_lines?(tramway_import_lines)
+
+        content.each_line.reject { |line| tramway_stimulus_import_line?(line) }.join
+      end
 
       def append_missing_registrations(content)
+        content = normalize_tramway_stimulus_registrations(content)
         missing_registrations = stimulus_controller_registrations.reject { |line| content.include?(line) }
         return content if missing_registrations.empty?
 
@@ -221,6 +272,36 @@ module Tramway
         content.each_line.reject { |line| legacy_imports.include?(line.strip) }.join
       end
 
+      def tramway_stimulus_import_line?(line)
+        line.strip.match?(%r{^import \{.*\} from ["']@tramway/tramway["']$})
+      end
+
+      def normalize_tramway_stimulus_registrations(content)
+        tramway_registration_lines = content.each_line.select { |line| tramway_stimulus_registration_line?(line) }
+        return content if tramway_registration_lines.sort == stimulus_controller_registrations.sort
+        return content unless tramway_registration_lines.any?
+
+        content.each_line.reject { |line| tramway_stimulus_registration_line?(line) }.join
+      end
+
+      def tramway_stimulus_registration_line?(line)
+        tramway_registration_prefixes.any? { |prefix| line.strip.start_with?(prefix) }
+      end
+
+      def normalized_tramway_import_lines?(tramway_import_lines)
+        tramway_import_lines.one? && tramway_import_lines.first.strip == stimulus_controller_imports.first
+      end
+
+      def tramway_registration_prefixes
+        [
+          "application.register('tramway-navbar'",
+          "application.register('tramway-select'",
+          "application.register('table-row-preview'",
+          "application.register('ui--checkbox'",
+          "application.register('tramway-tooltip'"
+        ]
+      end
+
       def remove_legacy_importmap_pins(content)
         content.each_line.reject { |line| legacy_importmap_pins.include?(line.strip) }.join
       end
@@ -255,12 +336,12 @@ module Tramway
         say_status(:warning, "Skipping AGENTS.md update: #{e.message}")
       end
     end
-    # rubocop:enable Metrics/ModuleLength
 
-    # Running `rails generate tramway:install` will invoke this generator
-    #
+    # Installs Tramway dependencies and app wiring for a host Rails app.
     class InstallGenerator < Rails::Generators::Base
       include InstallGeneratorHelpers
+      include InstallGeneratorFontAwesomeHelpers
+      include InstallGeneratorLayoutHelpers
 
       desc 'Installs Tramway dependencies and Tailwind safelist configuration.'
 
@@ -310,15 +391,14 @@ module Tramway
         path = tailwind_application_stylesheet_path
         FileUtils.mkdir_p(File.dirname(path))
 
-        return create_file(path, "#{tailwind_css_import_line}\n") unless File.exist?(path)
+        return create_file(path, TAILWIND_APPLICATION_STYLESHEET_CONTENT) unless File.exist?(path)
 
         content = File.read(path)
-        return if content.include?(tailwind_css_import_line)
+        return if content.include?(tailwind_css_import_line) && content.include?(TAILWIND_SCROLLBAR_UTILITY)
 
-        File.open(path, 'a') do |file|
-          file.write("\n") unless content.empty? || content.end_with?("\n")
-          file.write("#{tailwind_css_import_line}\n")
-        end
+        updated = content.include?(tailwind_css_import_line) ? content : "#{content}\n#{tailwind_css_import_line}\n"
+        updated = "#{updated}\n#{TAILWIND_SCROLLBAR_UTILITY}\n" unless updated.include?(TAILWIND_SCROLLBAR_UTILITY)
+        File.write(path, updated)
       end
 
       def ensure_importmap_pin
@@ -348,30 +428,16 @@ module Tramway
 
       def ensure_trix_in_application_layout
         if File.exist?(application_layout_haml_path)
+          ensure_font_awesome_in_haml_layout
           ensure_trix_in_haml_layout
         elsif File.exist?(application_layout_erb_path)
+          ensure_font_awesome_in_erb_layout
           ensure_trix_in_erb_layout
         end
       end
 
-      private
-
-      def ensure_trix_in_haml_layout
-        content = File.read(application_layout_haml_path)
-        return if trix_already_present?(content)
-        return unless content.match?(/^\s+%body/)
-
-        updated = content.sub(/^(\s+%body)/, "#{trix_haml_tags}\\1")
-        File.write(application_layout_haml_path, updated)
-      end
-
-      def ensure_trix_in_erb_layout
-        content = File.read(application_layout_erb_path)
-        return if trix_already_present?(content)
-        return unless content.include?('</head>')
-
-        updated = content.sub('</head>', "#{trix_erb_tags}  </head>")
-        File.write(application_layout_erb_path, updated)
+      def ensure_navbar_sidebar_offset_in_application_layout
+        ensure_navbar_sidebar_offset
       end
     end
   end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Generators
+    # Layout helpers for Tramway generator template updates.
+    module InstallGeneratorLayoutHelpers
+      private
+
+      def application_layout_haml_path
+        @application_layout_haml_path ||= File.join(destination_root, 'app/views/layouts/application.html.haml')
+      end
+
+      def application_layout_erb_path
+        @application_layout_erb_path ||= File.join(destination_root, 'app/views/layouts/application.html.erb')
+      end
+
+      def trix_haml_tags
+        "    = stylesheet_link_tag \"trix\", \"data-turbo-track\": \"reload\"\n    " \
+          "= javascript_include_tag \"trix\", \"data-turbo-track\": \"reload\", defer: true\n"
+      end
+
+      def trix_erb_tags
+        "    <%= stylesheet_link_tag \"trix\", \"data-turbo-track\": \"reload\" %>\n    " \
+          "<%= javascript_include_tag \"trix\", \"data-turbo-track\": \"reload\", defer: true %>\n"
+      end
+
+      def trix_already_present?(content)
+        content.include?('stylesheet_link_tag "trix"') || content.include?("stylesheet_link_tag 'trix'")
+      end
+
+      def font_awesome_already_present?(content)
+        content.include?('stylesheet_link_tag "font-awesome"') ||
+          content.include?("stylesheet_link_tag 'font-awesome'")
+      end
+
+      def navbar_sidebar_offset_class
+        'md:pl-72 transition-all duration-300 ease-in-out'
+      end
+
+      def ensure_trix_in_haml_layout
+        content = File.read(application_layout_haml_path)
+        return if trix_already_present?(content)
+        return unless content.match?(/^\s+%body/)
+
+        updated = content.sub(/^(\s+%body)/, "#{trix_haml_tags}\\1")
+        File.write(application_layout_haml_path, updated)
+      end
+
+      def ensure_trix_in_erb_layout
+        content = File.read(application_layout_erb_path)
+        return if trix_already_present?(content)
+        return unless content.include?('</head>')
+
+        updated = content.sub('</head>', "#{trix_erb_tags}  </head>")
+        File.write(application_layout_erb_path, updated)
+      end
+
+      def ensure_navbar_sidebar_offset
+        if File.exist?(application_layout_haml_path)
+          ensure_navbar_sidebar_offset_in_haml_layout
+        elsif File.exist?(application_layout_erb_path)
+          ensure_navbar_sidebar_offset_in_erb_layout
+        end
+      end
+
+      def ensure_navbar_sidebar_offset_in_haml_layout
+        content = File.read(application_layout_haml_path)
+        return if content.include?(navbar_sidebar_offset_class)
+        return unless content.match?(/= tramway_main_container(?: class: '[^']*')? do/)
+
+        File.write(
+          application_layout_haml_path,
+          content.sub(
+            /= tramway_main_container(?: class: '[^']*')? do/,
+            "= tramway_main_container class: '#{navbar_sidebar_offset_class}' do"
+          )
+        )
+      end
+
+      def ensure_navbar_sidebar_offset_in_erb_layout
+        content = File.read(application_layout_erb_path)
+        return if content.include?(navbar_sidebar_offset_class)
+        return unless content.match?(/<%= tramway_main_container(?: class: '[^']*')? do %>/)
+
+        File.write(
+          application_layout_erb_path,
+          content.sub(
+            /<%= tramway_main_container(?: class: '[^']*')? do %>/,
+            "<%= tramway_main_container class: '#{navbar_sidebar_offset_class}' do %>"
+          )
+        )
+      end
+    end
+  end
+end

data/lib/tramway/engine.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'font-awesome-rails'
+
 module Tramway
   # Rails plugin is the Engine
   #
@@ -17,8 +19,14 @@ module Tramway
     end
 
     initializer 'tramway.assets.precompile' do |app|
+      font_awesome_font_paths.each do |path|
+        path_string = path.to_s
+        app.config.assets.paths << path_string unless app.config.assets.paths.include?(path_string)
+      end
+
       app.config.assets.precompile += %w[
         tramway/tramway.js
+        font-awesome.css
       ]
     end
 
@@ -88,6 +96,10 @@ module Tramway
       end
     end
 
+    def font_awesome_font_paths
+      [FontAwesome::Rails::Engine.root.join('app/assets/fonts')]
+    end
+
     def configure_pagination
       ActiveSupport.on_load(:action_controller) do
         # Detecting tramway views path

data/lib/tramway/forms/validations.rb

@@ -16,11 +16,10 @@ module Tramway
         def __initialize_validations(_subclass); end
       end
 
-      # rubocop:disable Naming/PredicateMethod
+      # rubocop:disable-next Naming/PredicateMethod
       def __apply_validations(_params)
         valid?
       end
-      # rubocop:enable Naming/PredicateMethod
     end
   end
 end

data/lib/tramway/helpers/navbar_helper.rb

@@ -6,11 +6,13 @@ module Tramway
   module Helpers
     # Provides navbar helpers for ActionView
     module NavbarHelper
-      def tramway_navbar(with_entities: true, **options)
+      def tramway_navbar(with_entities: true, direction: :vertical, **options)
+        @tramway_navbar_direction = direction.presence&.to_sym || :vertical
         initialize_navbar(with_entities:)
 
         yield @navbar if block_given?
 
+        options[:direction] = direction if options[:direction].nil?
         assign_navbar_items(options)
 
         render_navbar_component(options)

data/lib/tramway/helpers/table_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Tramway
+  module Helpers
+    # Provides size helpers for Tramway tables
+    module TableHelper
+      TABLE_SIZES = %i[small medium large].freeze
+
+      def tramway_table_size
+        context = tramway_table_context
+        return :medium unless context.respond_to?(:tramway_table_size)
+
+        TABLE_SIZES.include?(context.tramway_table_size) ? context.tramway_table_size : :medium
+      end
+
+      def normalize_table_size(size)
+        TABLE_SIZES.include?(size) ? size : :medium
+      end
+
+      def tramway_table_context
+        return __vc_original_view_context if respond_to?(:__vc_original_view_context)
+
+        view_context if respond_to?(:view_context)
+      end
+    end
+  end
+end

data/lib/tramway/helpers/views_helper.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require 'tramway/helpers/table_helper'
+
 module Tramway
   module Helpers
     # Provides view-oriented helpers for ActionView
     module ViewsHelper
       include Tramway::Helpers::ComponentHelper
+      include Tramway::Helpers::TableHelper
 
       FORM_SIZES = %i[small medium large].freeze
 
@@ -19,8 +22,16 @@ module Tramway
         ), &)
       end
 
-      def tramway_table(**options, &)
-        component 'tramway/table', options:, &
+      def tramway_table(size: :medium, **options, &)
+        component 'tramway/table', size: normalize_table_size(size), options:, &
+      end
+
+      def tramway_grid(rows:, columns:, outline: false, **options, &)
+        component 'tramway/grid', rows:, columns:, outline:, options:, &
+      end
+
+      def tramway_card(size: [1, 1], **options, &)
+        component 'tramway/grid/card', size:, options:, &
       end
 
       def tramway_header(headers: nil, columns: nil, **options, &)
@@ -63,6 +74,8 @@ module Tramway
       end
 
       def tramway_main_container(**options, &)
+        options[:id] ||= 'tramway-main-container'
+        options[:class] = tramway_main_container_classes(options[:class])
         component 'tramway/containers/main', options:, &
       end
 
@@ -102,6 +115,17 @@ module Tramway
       def normalize_form_size(size)
         FORM_SIZES.include?(size) ? size : :medium
       end
+
+      def tramway_main_container_classes(value)
+        classes = Array(value).flat_map { _1.to_s.split }
+
+        return classes.join(' ') if @tramway_navbar_direction.nil?
+
+        classes = classes.reject { _1.start_with?('md:pl-') || _1.start_with?('md:pr-') }
+        classes << 'md:pl-72' if @tramway_navbar_direction == :vertical
+
+        classes.join(' ')
+      end
     end
   end
 end

data/lib/tramway/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tramway
 version: !ruby/object:Gem::Version
-  version: 3.1.2.7
+  version: '4.0'
 platform: ruby
 authors:
 - kalashnikovisme
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: font-awesome-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: haml-rails
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +100,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -96,7 +110,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -138,7 +152,10 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/builds/tailwind.css
 - app/assets/javascripts/tramway/tramway.js
+- app/assets/stylesheets/font-awesome.css
+- app/assets/tailwind/application.css
 - app/components/tailwind_component.html.haml
 - app/components/tailwind_component.rb
 - app/components/tramway/actions_buttons_container_component.html.haml
@@ -207,6 +224,10 @@ files:
 - app/components/tramway/form/tramway_select/selected_item_template_component.rb
 - app/components/tramway/form/tramway_select_component.html.haml
 - app/components/tramway/form/tramway_select_component.rb
+- app/components/tramway/grid/card_component.html.haml
+- app/components/tramway/grid/card_component.rb
+- app/components/tramway/grid_component.html.haml
+- app/components/tramway/grid_component.rb
 - app/components/tramway/native_text_component.html.haml
 - app/components/tramway/native_text_component.rb
 - app/components/tramway/nav/item/button_component.html.haml
@@ -266,7 +287,9 @@ files:
 - config/routes.rb
 - config/tailwind.config.js
 - docs/AGENTS.md
+- lib/generators/tramway/install/font_awesome_helpers.rb
 - lib/generators/tramway/install/install_generator.rb
+- lib/generators/tramway/install/layout_helpers.rb
 - lib/kaminari/helpers/tag.rb
 - lib/rules/turbo_html_attributes_rules.rb
 - lib/tasks/tramway_tasks.rake
@@ -296,6 +319,7 @@ files:
 - lib/tramway/helpers/form_helper.rb
 - lib/tramway/helpers/navbar_helper.rb
 - lib/tramway/helpers/routes_helper.rb
+- lib/tramway/helpers/table_helper.rb
 - lib/tramway/helpers/views_helper.rb
 - lib/tramway/navbar.rb
 - lib/tramway/searchable.rb
@@ -326,7 +350,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Tramway Rails Engine
 test_files: []