railsui 3.1.4 → 3.2.0

data/lib/railsui/form_builder.rb

@@ -0,0 +1,307 @@
+require "action_view"
+
+module Railsui
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    delegate :content_tag, :tag, :safe_join, :capture, to: :@template
+
+    def text_field(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-input")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def email_field(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-input")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def password_field(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-input")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def number_field(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-input")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def telephone_field(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-input")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+    alias phone_field telephone_field
+
+    def url_field(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-input")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def date_field(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-input")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def datetime_field(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-input")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def time_field(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-input")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def color_field(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-input-color")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def search_field(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-input")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def text_area(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-textarea")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def select(method, choices = nil, options = {}, html_options = {})
+      field_wrapper(method, html_options) do
+        add_default_class!(html_options, "form-select")
+        add_error_class!(html_options) if has_error?(method)
+        super(method, choices, options, html_options)
+      end
+    end
+
+    def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
+      wrapper_options = options.delete(:wrapper) || {}
+      label_text = options.delete(:label)
+      label_class = options.delete(:label_class) || "form-label"
+      is_required = options.delete(:required) || false
+
+      # Set default flex layout for the wrapper
+      wrapper_class = "flex items-center justify-start gap-2"
+      wrapper_options[:class] = [wrapper_class, wrapper_options[:class]].compact.join(" ")
+
+      content_tag(:div, wrapper_options) do
+        add_default_class!(options, "form-input-checkbox")
+        add_error_class!(options) if has_error?(method)
+
+        if label_text
+          check_box_html = super(method, options, checked_value, unchecked_value)
+          label_options = { class: label_class }
+          label_options[:required] = true if is_required
+          label_html = label(method, label_text, label_options)
+          safe_join([check_box_html, label_html])
+        else
+          super(method, options, checked_value, unchecked_value)
+        end
+      end
+    end
+
+    def radio_button(method, tag_value, options = {})
+      wrapper_options = options.delete(:wrapper) || {}
+      label_text = options.delete(:label)
+
+      # Set default flex layout for the wrapper
+      wrapper_class = "flex items-center justify-start gap-2"
+      wrapper_options[:class] = [wrapper_class, wrapper_options[:class]].compact.join(" ")
+
+      content_tag(:div, wrapper_options) do
+        add_default_class!(options, "form-input-radio")
+        add_error_class!(options) if has_error?(method)
+
+        if label_text
+          radio_html = super(method, tag_value, options)
+          label_html = label(method, label_text, value: tag_value, class: "form-label")
+          safe_join([radio_html, label_html])
+        else
+          super(method, tag_value, options)
+        end
+      end
+    end
+
+    def file_field(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "form-file")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def rich_text_area(method, options = {})
+      field_wrapper(method, options) do
+        add_default_class!(options, "trix-content")
+        add_error_class!(options) if has_error?(method)
+        super(method, options)
+      end
+    end
+
+    def range_field(method, options = {})
+      # Extract wrapper options and add stimulus controller to the form group
+      wrapper_options = options.delete(:wrapper) || {}
+      wrapper_options["data-controller"] = "railsui-range"
+
+      field_wrapper(method, options.merge(wrapper: wrapper_options)) do
+        add_default_class!(options, "form-input-range")
+        add_error_class!(options) if has_error?(method)
+
+        # Add stimulus target and action data attributes to the input
+        options["data-railsui-range-target"] = "range"
+        options["data-action"] = "input->railsui-range#onInput"
+
+        super(method, options)
+      end
+    end
+
+
+    def switch_field(method, options = {})
+      label_text = options.delete(:label) || method.to_s.humanize
+
+      field_wrapper(method, options.merge(label: false)) do
+        add_default_class!(options, "form-input-switch")
+        add_error_class!(options) if has_error?(method)
+
+        # Create switch input without hidden field
+        switch_html = @template.check_box(@object_name, method, objectify_options(options.merge(include_hidden: false)), "1", "0")
+        label_html = label(method, label_text)
+        safe_join([switch_html, label_html])
+      end
+    end
+
+    def button_toggle(method, tag_value, options = {})
+      label_text = options.delete(:label) || tag_value.to_s.humanize
+      variant = options.delete(:variant) # sm, lg, ghost, muted
+
+      field_wrapper(method, options.merge(label: label_text)) do
+        base_class = "form-input-button-toggle"
+        base_class += "-#{variant}" if variant
+        add_default_class!(options, base_class)
+
+        # Call ActionView radio_button helper directly to avoid flex wrapper
+        @template.radio_button(@object_name, method, tag_value, objectify_options(options))
+      end
+    end
+
+    def label(method, text = nil, options = {})
+      add_default_class!(options, "form-label")
+      # Check both the required option and model validators
+      is_required = options.delete(:required) || required_field?(method)
+      options[:class] += " form-label-required" if is_required
+      super(method, text, options)
+    end
+
+    def error_message(method)
+      return unless has_error?(method)
+
+      content_tag(:p, class: "mt-1 text-sm text-red-600 dark:text-red-400") do
+        @object.errors[method].join(", ")
+      end
+    end
+
+    def form_group(method = nil, options = {}, &block)
+      content_tag(:div, class: "form-group #{options[:class]}", &block)
+    end
+
+    def form_help(text, options = {})
+      add_default_class!(options, "form-help text-xs")
+      content_tag(:p, text, options)
+    end
+
+    def submit(value = nil, options = {})
+      add_default_class!(options, "btn btn-primary")
+      super(value, options)
+    end
+
+    private
+
+    def field_wrapper(method, options = {}, &block)
+      wrapper_options = options.delete(:wrapper) || {}
+      label_text = options.delete(:label)
+      help_text = options.delete(:help)
+      skip_label = options.delete(:skip_label) || false
+      is_required = options[:required] || false
+
+      form_group(method, wrapper_options) do
+        elements = []
+
+        # Add label unless skipped
+        unless skip_label
+          label_options = options.delete(:label_options) || {}
+          # Pass the required flag to the label
+          label_options[:required] = is_required if is_required
+          elements << label(method, label_text, label_options) if label_text != false
+        end
+
+        # Add the field
+        elements << capture(&block)
+
+        # Add error message
+        elements << error_message(method) if has_error?(method)
+
+        # Add help text
+        if help_text
+          elements << content_tag(:p, help_text, class: "form-help")
+        end
+
+        safe_join(elements)
+      end
+    end
+
+    def add_default_class!(options, css_class)
+      options[:class] = [css_class, options[:class]].compact.join(" ")
+    end
+
+    def add_error_class!(options)
+      options[:class] = [options[:class], "form-input-error"].compact.join(" ")
+    end
+
+    def has_error?(method)
+      @object.respond_to?(:errors) && @object.errors[method].present?
+    end
+
+    def required_field?(method)
+      return false unless @object.class.respond_to?(:validators_on)
+
+      @object.class.validators_on(method).any? do |validator|
+        validator.is_a?(ActiveModel::Validations::PresenceValidator)
+      end
+    end
+  end
+end

data/lib/railsui/pages.rb

@@ -1,14 +1,20 @@
 module Railsui
   module Pages
-    CONFIG_FILE = Railsui::Engine.root.join("config", "pages.yml")
-    VIEWS_FOLDER = Rails.root.join("app/views/rui/pages")
+    CONFIG_FILE = Railsui::Engine.root.join('config', 'pages.yml')
+    VIEWS_FOLDER = Rails.root.join('app/views/rui/pages')
 
     def self.all_pages
       @all_pages ||= load_pages_config
     end
 
     def self.theme_pages
-      all_pages[Railsui.config.theme]
+      theme = Railsui.config.theme
+      return {} if theme.nil?
+
+      pages = all_pages[theme]
+      return {} if pages.nil?
+
+      pages
     end
 
     def self.get_pages(theme)
@@ -24,10 +30,14 @@ module Railsui
     end
 
     def self.all_pages_installed?
+      return false if theme_pages.nil? || theme_pages.empty?
+
       theme_pages.keys.all? { |page| page_exists?(page) }
     end
 
     def self.installed_pages
+      return {} if theme_pages.nil?
+
       theme_pages.select { |page, details| page_enabled?(page) && page_exists?(page) }
     end
 
@@ -35,6 +45,7 @@ module Railsui
 
     def self.load_pages_config
       return {} unless File.exist?(CONFIG_FILE)
+
       YAML.safe_load_file(CONFIG_FILE)
     end
   end

data/lib/railsui/theme_helper.rb

@@ -16,10 +16,10 @@ module Railsui
       inactive_class = html_options.delete(:inactive_class) || ""
 
       active = if (paths = Array.wrap(starts_with)) && paths.present?
-        paths.any? { |path| request.path.start_with?(path) }
-      else
-        request.path == url
-      end
+                 paths.any? { |path| request.path.start_with?(path) }
+               else
+                 request.path == url
+               end
 
       classes = active ? active_class : inactive_class
       html_options[:class] << classes unless classes.empty?
@@ -42,11 +42,11 @@ module Railsui
       "https://randomuser.me/api/portraits/#{variant}/#{id}.jpg"
     end
 
-    def conditional_link_to(route_helper, options = {}, &block)
+    def conditional_link_to(route_helper, options = {}, &)
       if Rails.application.routes.url_helpers.method_defined?(route_helper)
-        link_to send(route_helper), options, &block
+        link_to(send(route_helper), options, &)
       else
-        content_tag(:div, options, &block)
+        content_tag(:div, options, &)
       end
     end
 
@@ -68,7 +68,7 @@ module Railsui
       content_classes = content_for(:body_classes).to_s.strip
 
       # Combine existing Railsui config classes with any additional classes
-      combined_classes = [Railsui.config.body_classes.to_s.strip, content_classes].reject(&:empty?).join(' ')
+      combined_classes = [Railsui.config.body_classes.to_s.strip, content_classes].reject(&:empty?).join(" ")
 
       # Return the combined classes or an empty string if none
       combined_classes.presence || ""

data/lib/railsui/theme_setup.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fileutils'
+require "fileutils"
 
 module Railsui
   module ThemeSetup
@@ -36,7 +36,8 @@ module Railsui
         controller_name = File.basename(file, ".js").sub("_controller", "")
         import_name = controller_name.camelize
         registration_name = controller_name.dasherize
-        "import #{import_name}Controller from \"./#{File.basename(file, '.js')}\";\napplication.register(\"#{registration_name}\", #{import_name}Controller);"
+        "import #{import_name}Controller from \"./#{File.basename(file,
+                                                                  ".js")}\";\napplication.register(\"#{registration_name}\", #{import_name}Controller);"
       end.join("\n")
 
       js_content = <<-JAVASCRIPT.strip_heredoc
@@ -61,25 +62,26 @@ module Railsui
       railsui_index_content += "\n\n#{js_content}"
 
       # Write the railsui/index.js file
-      create_file railsui_index_js_path, "import { application } from \"../application\"\n\n#{railsui_index_content}", force: true
+      create_file railsui_index_js_path, "import { application } from \"../application\"\n\n#{railsui_index_content}",
+                  force: true
 
       # Read the existing main index.js content
       index_js_content = File.exist?(index_js_path) ? File.read(index_js_path) : ""
 
       # Remove old import statements for railsui controllers
-      new_index_js_content = index_js_content.gsub(/import .* from "\.\/railsui\/.*";\n*/, "")
+      new_index_js_content = index_js_content.gsub(%r{import .* from "\./railsui/.*";\n*}, "")
 
       # Add the new import statement for railsui/index.js if not already present
-      unless new_index_js_content.include?('import "./railsui"')
-        new_index_js_content += "import \"./railsui\"\n"
-      end
+      new_index_js_content += "import \"./railsui\"\n" unless new_index_js_content.include?('import "./railsui"')
 
       # Write the updated content back to main index.js
       create_file index_js_path, new_index_js_content, force: true
-      say("Updated app/javascript/controllers/index.js and created app/javascript/controllers/railsui/index.js successfully.", :green)
+      say(
+        "Updated app/javascript/controllers/index.js and created app/javascript/controllers/railsui/index.js successfully.", :green
+      )
     end
 
-   def copy_theme_stylesheets(theme)
+    def copy_theme_stylesheets(theme)
       say("Copying theme-specific stylesheets", :yellow)
 
       # Define paths
@@ -99,7 +101,7 @@ module Railsui
 
       # Generate import statements for stylesheets
       import_statements = stylesheet_files.map do |file|
-        "@import \"../stylesheets/railsui/#{File.basename(file, '.css')}\";"
+        "@import \"../stylesheets/railsui/#{File.basename(file, ".css")}\";"
       end.join("\n")
 
       # Read the existing application.tailwind.css content
@@ -108,12 +110,12 @@ module Railsui
       # Remove old @tailwind directives and import statements for tailwindcss and railsui stylesheets
       cleaned_css_content = application_css_content
       cleaned_css_content = cleaned_css_content.gsub(/@import "tailwindcss";\n*/, "")
-      cleaned_css_content = cleaned_css_content.gsub(/@import "\.\.\/stylesheets\/railsui\/.*";\n*/, "")
+      cleaned_css_content = cleaned_css_content.gsub(%r{@import "\.\./stylesheets/railsui/.*";\n*}, "")
 
       # Add the new import statements in the correct order
       new_application_css_content = [
         '@import "tailwindcss";',
-        cleaned_css_content.strip,  # Preserving existing content
+        cleaned_css_content.strip, # Preserving existing content
         import_statements
       ].join("\n")
 
@@ -127,7 +129,6 @@ module Railsui
       add_yarn_packages(theme_dependencies(theme))
     end
 
-
     def remove_action_text_defaults
       say "Remove default ActionText CSS"
       # remove import from application.tailwind.css if present as we add it to another imported css file.
@@ -142,20 +143,54 @@ module Railsui
     def theme_dependencies(theme)
       case theme
       when "hound"
-        ["@tailwindcss/typography", "apexcharts", "railsui-stimulus", "stimulus-use","tailwindcss@latest", "@tailwindcss/cli@latest", "tippy.js"]
+        ["@tailwindcss/typography", "apexcharts", "railsui-stimulus", "stimulus-use", "tailwindcss@latest", "@tailwindcss/cli@latest", "tippy.js"]
       when "shepherd"
-        ["@tailwindcss/typography", "apexcharts", "flatpickr", "hotkeys-js", "photoswipe", "railsui-stimulus", "stimulus-use", "tippy.js", "tailwindcss@latest", "@tailwindcss/cli@latest"]
-      when "retriever"
-        ["@tailwindcss/typography", "apexcharts", "autoprefixer", "flatpickr","railsui-stimulus", "stimulus-use", "tailwindcss@latest", "@tailwindcss/cli@latest", "tippy.js"]
-      when "setter"
-        ["@tailwindcss/typography", "railsui-stimulus", "stimulus-use", "tailwindcss@latest", "@tailwindcss/cli@latest", "tippy.js"]
+        ["@tailwindcss/typography", "apexcharts", "flatpickr", "hotkeys-js", "photoswipe", "railsui-stimulus",
+         "stimulus-use", "tippy.js", "tailwindcss@latest", "@tailwindcss/cli@latest"]
+      when "corgie"
+        ["@tailwindcss/typography", "railsui-stimulus", "stimulus-use", "tailwindcss@latest", "@tailwindcss/cli@latest", "tippy.js", "marked", "highlight.js", "sanitize-html"]
       else
-        ["@tailwindcss/typography", "railsui-stimulus", "stimulus-use", "tailwindcss@latest", "@tailwindcss/cli@latest" "tippy.js"]
+        ["@tailwindcss/typography", "railsui-stimulus", "stimulus-use", "tailwindcss@latest",
+         "@tailwindcss/cli@latest", "tippy.js"]
       end
     end
 
     def add_yarn_packages(packages)
-      run "yarn add #{packages.join(' ')} --latest"
+      package_manager = detect_package_manager
+      say "Using #{package_manager} to install packages...", :green
+
+      case package_manager
+      when "yarn"
+        run "yarn add #{packages.join(" ")}"
+      when "npm"
+        run "npm install #{packages.join(" ")}"
+      when "pnpm"
+        run "pnpm add #{packages.join(" ")}"
+      when "bun"
+        run "bun add #{packages.join(" ")}"
+      else
+        # Fallback to yarn if no package manager detected
+        say "No package manager detected, falling back to yarn", :yellow
+        run "yarn add #{packages.join(" ")}"
+      end
+    end
+
+    def detect_package_manager
+      # Check for lock files in order of preference
+      if File.exist?(Rails.root.join("yarn.lock"))
+        "yarn"
+      elsif File.exist?(Rails.root.join("package-lock.json"))
+        "npm"
+      elsif File.exist?(Rails.root.join("pnpm-lock.yaml"))
+        "pnpm"
+      elsif File.exist?(Rails.root.join("bun.lockb"))
+        "bun"
+      elsif File.exist?(Rails.root.join("package.json"))
+        # Check for package.json to determine if we should use npm as default
+        "npm" # Default to npm if package.json exists but no lock file
+      else
+        "yarn" # Fallback to yarn
+      end
     end
 
     # Mailers
@@ -164,12 +199,13 @@ module Railsui
 
       rails_command "generate mailer Railsui minimal promotion transactional"
 
-combined_mailer_setup = <<-RUBY
+      combined_mailer_setup = <<-RUBY
   layout "rui/railsui_mailer"
   helper :application
-RUBY
+      RUBY
 
-      insert_into_file Rails.root.join("app/mailers/railsui_mailer.rb").to_s, combined_mailer_setup, after: "class RailsuiMailer < ApplicationMailer\n"
+      insert_into_file Rails.root.join("app/mailers/railsui_mailer.rb").to_s, combined_mailer_setup,
+                       after: "class RailsuiMailer < ApplicationMailer\n"
 
       copy_sample_mailers(theme)
     end
@@ -181,16 +217,14 @@ RUBY
     end
 
     def update_railsui_mailer_layout(theme)
-      source_file = Rails.root.join('app/views/layouts/rui/railsui_mailer.html.erb')
-      if File.exist?(source_file)
-        remove_file source_file
-      end
+      source_file = Rails.root.join("app/views/layouts/rui/railsui_mailer.html.erb")
+      remove_file source_file if File.exist?(source_file)
 
       copy_file "themes/#{theme}/views/layouts/rui/railsui_mailer.html.erb", source_file, force: true
     end
 
     def update_application_helper
-content = <<-RUBY
+      content = <<-RUBY
   def spacer(amount = 16)
     render "rui/shared/email_spacer", amount: amount
   end
@@ -205,7 +239,7 @@ content = <<-RUBY
   def email_callout(&block)
     render "rui/shared/email_callout", block: block
   end
-RUBY
+      RUBY
 
       insert_into_file "#{Rails.root}/app/helpers/application_helper.rb", content, after: "module ApplicationHelper\n"
     end
@@ -236,7 +270,7 @@ RUBY
     end
 
     def copy_railsui_pages_routes
-      routes_file = Rails.root.join('config/routes.rb')
+      routes_file = Rails.root.join("config/routes.rb")
 
       # Define the regex pattern for the `rui` namespace block
       namespace_pattern = /^\s*namespace :rui do.*?end\n/m
@@ -253,17 +287,17 @@ RUBY
       route_content = File.read(routes_file)
 
       # Remove the existing `rui` namespace block if present
-      updated_content = route_content.gsub(namespace_pattern, '')
+      updated_content = route_content.gsub(namespace_pattern, "")
 
       # Append the new routes block after the initial `Rails.application.routes.draw do` line
       updated_content.sub!("Rails.application.routes.draw do\n", "Rails.application.routes.draw do\n#{routes_block}")
 
       # Write the updated content back to the routes file
-      File.open(routes_file, 'w') { |file| file.write(updated_content) }
+      File.write(routes_file, updated_content)
     end
 
     # Pages
-    def copy_railsui_page_controller(theme)
+    def copy_railsui_page_controller(_theme)
       copy_file "controllers/pages_controller.rb", "app/controllers/rui/pages_controller.rb", force: true
     end
 
@@ -275,28 +309,28 @@ RUBY
       directory "themes/#{theme}/views/layouts/rui", "app/views/layouts/rui", force: true
     end
 
-    def copy_railsui_head(theme)
+    def copy_railsui_head(_theme)
       layout_file = "app/views/layouts/application.html.erb"
       return unless File.exist?(layout_file)
 
-      unless File.read(layout_file).include?('<%= railsui_head %>')
-    content = <<-ERB
+      return if File.read(layout_file).include?("<%= railsui_head %>")
+
+      content = <<-ERB
     <%= railsui_head %>
-    ERB
-        insert_into_file layout_file, "\n#{content}", before: '</head>'
-      end
+      ERB
+      insert_into_file layout_file, "\n#{content}", before: "</head>"
     end
 
-    def copy_railsui_launcher(theme)
+    def copy_railsui_launcher(_theme)
       layout_file = "app/views/layouts/application.html.erb"
       return unless File.exist?(layout_file)
 
-      unless File.read(layout_file).include?('<%= railsui_launcher if Rails.env.development? %>')
-    content = <<-ERB
+      return if File.read(layout_file).include?("<%= railsui_launcher if Rails.env.development? %>")
+
+      content = <<-ERB
     <%= railsui_launcher if Rails.env.development? %>
-    ERB
-        insert_into_file layout_file, "\n#{content}", before: '</body>'
-      end
+      ERB
+      insert_into_file layout_file, "\n#{content}", before: "</body>"
     end
 
     def copy_railsui_images(theme)
@@ -317,7 +351,7 @@ RUBY
         FileUtils.rm_rf(directory_path)
         say("Removed existing #{thing} in #{directory_path}")
       end
-    rescue => e
+    rescue StandardError => e
       say("Error removing directory #{directory_path}: #{e.message}", :red)
       raise e
     end
@@ -327,10 +361,10 @@ RUBY
       route_content = File.read(file)
 
       # Remove route associated with railsui/pages#<page>
-      route_content.gsub!(/^\s*get\s+'#{page}',\s+to:\s+'railsui\/pages##{page}'\s*$/, '')
+      route_content.gsub!(%r{^\s*get\s+'#{page}',\s+to:\s+'railsui/pages##{page}'\s*$}, "")
 
       # Write the updated content back to the file
-      File.open(file, 'w') { |f| f.write(route_content) }
+      File.write(file, route_content)
     end
   end
 end