shadcn-rails 0.1.0

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

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/base"
+
+module Shadcn
+  module Generators
+    # Generator for installing shadcn-rails in a Rails application
+    # Usage: rails generate shadcn:install
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :theme, type: :string, default: "neutral",
+        desc: "Base color theme (neutral, slate, stone, zinc, gray)"
+      class_option :css_variables, type: :boolean, default: true,
+        desc: "Use CSS variables for theming"
+      class_option :dark_mode, type: :string, default: "class",
+        desc: "Dark mode strategy (class, media, selector)"
+      class_option :skip_tailwind, type: :boolean, default: false,
+        desc: "Skip Tailwind CSS configuration"
+
+      desc "Installs shadcn-rails and configures your application"
+
+      def create_initializer
+        template "initializer.rb.tt", "config/initializers/shadcn.rb"
+      end
+
+      def create_config_file
+        template "shadcn.yml.tt", "config/shadcn.yml"
+      end
+
+      def add_stylesheet
+        return if options[:skip_tailwind]
+
+        if File.exist?("app/assets/stylesheets/application.tailwind.css")
+          inject_into_file "app/assets/stylesheets/application.tailwind.css", before: "@tailwind base;" do
+            "/* shadcn-rails styles */\n@import \"shadcn/base\";\n@import \"shadcn/components\";\n\n"
+          end
+        elsif File.exist?("app/assets/stylesheets/application.css")
+          append_to_file "app/assets/stylesheets/application.css" do
+            "\n/*\n *= require shadcn/base\n *= require shadcn/components\n */\n"
+          end
+        else
+          say "Could not find application stylesheet. Please manually import shadcn/base.css and shadcn/components.css", :yellow
+        end
+      end
+
+      def configure_tailwind
+        return if options[:skip_tailwind]
+        return unless File.exist?("tailwind.config.js")
+
+        inject_into_file "tailwind.config.js", after: "content: [" do
+          "\n    './app/components/**/*.{rb,html,erb}',\n    './app/views/**/*.{html,erb}',"
+        end
+
+        say "Updated tailwind.config.js to include component paths", :green
+      end
+
+      def setup_stimulus_controllers
+        if importmap?
+          setup_importmap
+        elsif using_esbuild? || using_webpack?
+          setup_bundler
+        else
+          say "Could not detect JavaScript bundler. Please manually configure Stimulus controllers.", :yellow
+        end
+      end
+
+      def display_post_install_message
+        say ""
+        say "=" * 60, :green
+        say "  shadcn-rails has been installed!", :green
+        say "=" * 60, :green
+        say ""
+        say "Next steps:", :yellow
+        say "  1. Ensure Tailwind CSS is configured with the shadcn theme"
+        say "  2. Import the Stimulus controllers in your application"
+        say "  3. Start using components in your views:"
+        say ""
+        say "     <%= render Shadcn::ButtonComponent.new(variant: :primary) do %>"
+        say "       Click me"
+        say "     <% end %>"
+        say ""
+        say "For more information, visit: https://github.com/iheanyi/shadcn-rails"
+        say ""
+      end
+
+      private
+
+      def importmap?
+        File.exist?("config/importmap.rb")
+      end
+
+      def using_esbuild?
+        File.exist?("esbuild.config.mjs") ||
+          (File.exist?("package.json") && File.read("package.json").include?("esbuild"))
+      end
+
+      def using_webpack?
+        File.exist?("webpack.config.js") ||
+          (File.exist?("package.json") && File.read("package.json").include?("webpack"))
+      end
+
+      def setup_importmap
+        append_to_file "config/importmap.rb" do
+          <<~RUBY
+
+            # shadcn-rails Stimulus controllers
+            pin "shadcn", to: "shadcn/index.js"
+          RUBY
+        end
+
+        # Update application.js to register controllers
+        if File.exist?("app/javascript/controllers/application.js")
+          append_to_file "app/javascript/controllers/application.js" do
+            <<~JS
+
+              // Import and register shadcn-rails controllers
+              import { registerShadcnControllers } from "shadcn"
+              registerShadcnControllers(application)
+            JS
+          end
+        end
+
+        say "Configured importmap for shadcn-rails", :green
+      end
+
+      def setup_bundler
+        # Add to package.json dependencies
+        if File.exist?("package.json")
+          say "Please add the following to your JavaScript entry point:", :yellow
+          say ""
+          say "  import { registerShadcnControllers } from 'shadcn-rails'"
+          say "  registerShadcnControllers(application)"
+          say ""
+        end
+      end
+    end
+  end
+end

data/lib/generators/shadcn/install/templates/initializer.rb.tt

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# shadcn-rails configuration
+Shadcn::Rails.configure do |config|
+  # Style preset (currently only "default" is supported)
+  config.style = "default"
+
+  # Base color theme: neutral, stone, zinc, gray, slate
+  config.base_color = "<%= options[:theme] %>"
+
+  # Whether to use CSS variables for theming
+  config.css_variables = <%= options[:css_variables] %>
+
+  # Prefix for Tailwind classes (e.g., "tw-")
+  # config.tailwind_prefix = ""
+
+  # Default border radius for components
+  config.radius = "0.5rem"
+
+  # Dark mode strategy: :class, :media, or :selector
+  config.dark_mode = :<%= options[:dark_mode] %>
+
+  # Icon library to use: :lucide (default)
+  # config.icon_library = :lucide
+
+  # Register custom component aliases
+  # config.alias_component :my_button, MyCustomButtonComponent
+
+  # Register custom themes
+  # config.register_theme :corporate, {
+  #   primary: "210 100% 50%",
+  #   primary_foreground: "0 0% 100%",
+  #   ...
+  # }
+end

data/lib/generators/shadcn/install/templates/shadcn.yml.tt

@@ -0,0 +1,35 @@
+# shadcn-rails configuration file
+# This file mirrors the components.json structure from shadcn/ui
+
+# Style preset (currently only "default" is supported)
+style: "default"
+
+# Tailwind CSS configuration
+tailwind:
+  # Path to your CSS file (for Tailwind CSS v4, leave config blank)
+  css: "app/assets/stylesheets/application.tailwind.css"
+
+  # Base color theme: neutral, stone, zinc, gray, slate
+  base_color: "<%= options[:theme] %>"
+
+  # Use CSS variables for theming
+  css_variables: <%= options[:css_variables] %>
+
+  # Prefix for Tailwind utility classes (e.g., "tw-")
+  prefix: ""
+
+# Dark mode configuration
+dark_mode: "<%= options[:dark_mode] %>"
+
+# Component aliases for path mapping
+aliases:
+  components: "app/components"
+  ui: "app/components/shadcn"
+  lib: "lib"
+  hooks: "app/javascript/hooks"
+
+# Custom themes (optional)
+# themes:
+#   corporate:
+#     primary: "210 100% 50%"
+#     primary_foreground: "0 0% 100%"

data/lib/generators/shadcn/theme/theme_generator.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/base"
+
+module Shadcn
+  module Generators
+    # Generator for switching or customizing themes
+    # Usage: rails generate shadcn:theme slate
+    class ThemeGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      argument :theme_name, type: :string, default: "neutral",
+        banner: "theme_name"
+
+      class_option :list, type: :boolean, default: false,
+        desc: "List all available themes"
+
+      desc "Changes the shadcn-rails theme or creates a custom theme"
+
+      AVAILABLE_THEMES = %w[neutral slate stone zinc gray].freeze
+
+      def validate_theme
+        if options[:list]
+          display_available_themes
+          exit 0
+        end
+
+        unless AVAILABLE_THEMES.include?(theme_name)
+          say "Error: Unknown theme '#{theme_name}'", :red
+          display_available_themes
+          exit 1
+        end
+      end
+
+      def update_initializer
+        initializer_path = "config/initializers/shadcn.rb"
+
+        if File.exist?(initializer_path)
+          gsub_file initializer_path,
+            /config\.base_color = ["']?\w+["']?/,
+            "config.base_color = \"#{theme_name}\""
+          say "Updated initializer to use '#{theme_name}' theme", :green
+        else
+          say "Initializer not found. Run 'rails generate shadcn:install' first.", :yellow
+        end
+      end
+
+      def update_config_file
+        config_path = "config/shadcn.yml"
+
+        if File.exist?(config_path)
+          gsub_file config_path,
+            /base_color: \w+/,
+            "base_color: #{theme_name}"
+          say "Updated shadcn.yml to use '#{theme_name}' theme", :green
+        end
+      end
+
+      def update_stylesheet
+        # Check for theme import in stylesheet
+        stylesheet_path = "app/assets/stylesheets/application.tailwind.css"
+
+        if File.exist?(stylesheet_path)
+          content = File.read(stylesheet_path)
+
+          # Remove existing theme import
+          AVAILABLE_THEMES.each do |theme|
+            next if theme == "neutral" # neutral uses base.css
+            gsub_file stylesheet_path, /@import ["']shadcn\/themes\/#{theme}["'];\n?/, ""
+          end
+
+          # Add new theme import if not neutral
+          unless theme_name == "neutral"
+            inject_into_file stylesheet_path, after: '@import "shadcn/base";' do
+              "\n@import \"shadcn/themes/#{theme_name}\";"
+            end
+          end
+
+          say "Updated stylesheet with '#{theme_name}' theme", :green
+        end
+      end
+
+      def display_completion_message
+        say ""
+        say "Theme changed to '#{theme_name}'!", :green
+        say ""
+        say "The following colors are now active:", :yellow
+        display_theme_preview(theme_name)
+        say ""
+      end
+
+      private
+
+      def display_available_themes
+        say ""
+        say "Available themes:", :green
+        say ""
+        AVAILABLE_THEMES.each do |theme|
+          say "  - #{theme}"
+        end
+        say ""
+        say "Usage: rails generate shadcn:theme slate"
+        say ""
+      end
+
+      def display_theme_preview(theme)
+        case theme
+        when "neutral"
+          say "  Primary: Pure black/white"
+          say "  Style: Clean, minimal"
+        when "slate"
+          say "  Primary: Cool blue-gray"
+          say "  Style: Professional, corporate"
+        when "stone"
+          say "  Primary: Warm gray-brown"
+          say "  Style: Earthy, natural"
+        when "zinc"
+          say "  Primary: Cool gray"
+          say "  Style: Modern, sleek"
+        when "gray"
+          say "  Primary: True gray"
+          say "  Style: Neutral, balanced"
+        end
+      end
+    end
+  end
+end

data/lib/shadcn/rails/class_merger.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+module Shadcn
+  module Rails
+    # Utility class for merging CSS classes intelligently
+    # Handles Tailwind CSS class conflicts similar to tailwind-merge
+    class ClassMerger
+      # Class groups that conflict with each other
+      # Later classes in the same group override earlier ones
+      CLASS_GROUPS = {
+        # Display
+        display: %w[block inline-block inline flex inline-flex grid inline-grid hidden],
+
+        # Position
+        position: %w[static fixed absolute relative sticky],
+
+        # Overflow
+        overflow: %w[overflow-auto overflow-hidden overflow-visible overflow-scroll],
+        overflow_x: %w[overflow-x-auto overflow-x-hidden overflow-x-visible overflow-x-scroll],
+        overflow_y: %w[overflow-y-auto overflow-y-hidden overflow-y-visible overflow-y-scroll],
+
+        # Flex direction
+        flex_direction: %w[flex-row flex-row-reverse flex-col flex-col-reverse],
+
+        # Flex wrap
+        flex_wrap: %w[flex-wrap flex-wrap-reverse flex-nowrap],
+
+        # Justify content
+        justify: %w[justify-start justify-end justify-center justify-between justify-around justify-evenly],
+
+        # Align items
+        items: %w[items-start items-end items-center items-baseline items-stretch],
+
+        # Align content
+        content: %w[content-start content-end content-center content-between content-around content-evenly],
+
+        # Align self
+        self: %w[self-auto self-start self-end self-center self-stretch],
+
+        # Font size
+        font_size: %w[text-xs text-sm text-base text-lg text-xl text-2xl text-3xl text-4xl text-5xl text-6xl text-7xl text-8xl text-9xl],
+
+        # Font weight
+        font_weight: %w[font-thin font-extralight font-light font-normal font-medium font-semibold font-bold font-extrabold font-black],
+
+        # Text align
+        text_align: %w[text-left text-center text-right text-justify],
+
+        # Whitespace
+        whitespace: %w[whitespace-normal whitespace-nowrap whitespace-pre whitespace-pre-line whitespace-pre-wrap],
+
+        # Text decoration
+        text_decoration: %w[underline overline line-through no-underline],
+
+        # Border style
+        border_style: %w[border-solid border-dashed border-dotted border-double border-none],
+
+        # Cursor
+        cursor: %w[cursor-auto cursor-default cursor-pointer cursor-wait cursor-text cursor-move cursor-not-allowed]
+      }.freeze
+
+      # Regex patterns for conflicting classes
+      CONFLICT_PATTERNS = {
+        # Spacing (margin, padding)
+        /^m-/ => :margin,
+        /^mx-/ => :margin_x,
+        /^my-/ => :margin_y,
+        /^mt-/ => :margin_top,
+        /^mr-/ => :margin_right,
+        /^mb-/ => :margin_bottom,
+        /^ml-/ => :margin_left,
+        /^p-/ => :padding,
+        /^px-/ => :padding_x,
+        /^py-/ => :padding_y,
+        /^pt-/ => :padding_top,
+        /^pr-/ => :padding_right,
+        /^pb-/ => :padding_bottom,
+        /^pl-/ => :padding_left,
+
+        # Sizing
+        /^w-/ => :width,
+        /^min-w-/ => :min_width,
+        /^max-w-/ => :max_width,
+        /^h-/ => :height,
+        /^min-h-/ => :min_height,
+        /^max-h-/ => :max_height,
+        /^size-/ => :size,
+
+        # Colors
+        /^bg-/ => :background,
+        /^text-(?!left|center|right|justify|xs|sm|base|lg|xl|2xl|3xl|4xl|5xl|6xl|7xl|8xl|9xl)/ => :text_color,
+        /^border-(?!solid|dashed|dotted|double|none|[0-9])/ => :border_color,
+        /^ring-(?!offset)/ => :ring_color,
+        /^ring-offset-(?!\d)/ => :ring_offset_color,
+
+        # Border radius
+        /^rounded(?:-|$)/ => :border_radius,
+        /^rounded-t(?:-|$)/ => :border_radius_top,
+        /^rounded-r(?:-|$)/ => :border_radius_right,
+        /^rounded-b(?:-|$)/ => :border_radius_bottom,
+        /^rounded-l(?:-|$)/ => :border_radius_left,
+        /^rounded-tl(?:-|$)/ => :border_radius_top_left,
+        /^rounded-tr(?:-|$)/ => :border_radius_top_right,
+        /^rounded-bl(?:-|$)/ => :border_radius_bottom_left,
+        /^rounded-br(?:-|$)/ => :border_radius_bottom_right,
+
+        # Border width
+        /^border(?:-[0-9]|$)/ => :border_width,
+        /^border-t(?:-[0-9]|$)/ => :border_width_top,
+        /^border-r(?:-[0-9]|$)/ => :border_width_right,
+        /^border-b(?:-[0-9]|$)/ => :border_width_bottom,
+        /^border-l(?:-[0-9]|$)/ => :border_width_left,
+
+        # Opacity
+        /^opacity-/ => :opacity,
+
+        # Z-index
+        /^z-/ => :z_index,
+
+        # Gap
+        /^gap-/ => :gap,
+        /^gap-x-/ => :gap_x,
+        /^gap-y-/ => :gap_y,
+
+        # Grid
+        /^grid-cols-/ => :grid_cols,
+        /^grid-rows-/ => :grid_rows,
+        /^col-span-/ => :col_span,
+        /^row-span-/ => :row_span,
+
+        # Shadow
+        /^shadow(?:-|$)/ => :shadow,
+
+        # Transition
+        /^transition(?:-|$)/ => :transition,
+        /^duration-/ => :duration,
+        /^ease-/ => :ease,
+
+        # Transform
+        /^scale-/ => :scale,
+        /^rotate-/ => :rotate,
+        /^translate-x-/ => :translate_x,
+        /^translate-y-/ => :translate_y
+      }.freeze
+
+      class << self
+        # Merge CSS classes, handling conflicts
+        # @param args [Array] Classes to merge (strings, hashes, arrays, or nil)
+        # @return [String] Merged class string
+        def merge(*args)
+          classes = flatten_classes(args)
+          dedupe_classes(classes).join(" ")
+        end
+
+        private
+
+        # Flatten nested arrays and handle conditional hashes
+        def flatten_classes(args)
+          args.flat_map do |arg|
+            case arg
+            when nil, false
+              []
+            when String
+              arg.split
+            when Array
+              flatten_classes(arg)
+            when Hash
+              arg.filter_map { |klass, condition| klass.to_s if condition }
+            else
+              arg.to_s.split
+            end
+          end
+        end
+
+        # Remove duplicate/conflicting classes, keeping last occurrence
+        def dedupe_classes(classes)
+          class_groups = {}
+          result = []
+
+          classes.each do |klass|
+            # Strip responsive/state prefixes for conflict detection
+            base_class = strip_prefixes(klass)
+            group = find_conflict_group(base_class)
+
+            if group
+              # Get the prefix (like "sm:", "hover:", etc.)
+              prefix = klass.sub(base_class, "")
+
+              # Create a unique key combining prefix and group
+              key = "#{prefix}:#{group}"
+
+              # If we've seen this group before, remove the old class
+              if class_groups[key]
+                result.delete(class_groups[key])
+              end
+
+              class_groups[key] = klass
+            end
+
+            result << klass
+          end
+
+          result.uniq
+        end
+
+        # Strip responsive and state prefixes
+        def strip_prefixes(klass)
+          klass.gsub(/^(?:sm:|md:|lg:|xl:|2xl:|hover:|focus:|active:|disabled:|dark:|group-hover:|peer-\w+:)+/, "")
+        end
+
+        # Find the conflict group for a class
+        def find_conflict_group(klass)
+          # Check static groups first
+          CLASS_GROUPS.each do |group, classes|
+            return group if classes.include?(klass)
+          end
+
+          # Check pattern-based groups
+          CONFLICT_PATTERNS.each do |pattern, group|
+            return group if klass.match?(pattern)
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end