diff --git a/lib/generators/tailwindcss/scaffold/templates/show.html.erb.tt b/lib/generators/tailwindcss/scaffold/templates/show.html.erb.tt
index 4bf94e8f..2b6687d2 100644
--- a/lib/generators/tailwindcss/scaffold/templates/show.html.erb.tt
+++ b/lib/generators/tailwindcss/scaffold/templates/show.html.erb.tt
@@ -1,15 +1,15 @@
-
-
- <%% if notice.present? %>
-
<%%= notice %>
- <%% end %>
-
- <%%= render @<%= singular_table_name %> %>
-
- <%%= link_to 'Edit this <%= singular_table_name %>', edit_<%= singular_table_name %>_path(@<%= singular_table_name %>), class: "mt-2 rounded-lg py-3 px-5 bg-gray-100 inline-block font-medium" %>
-
- <%%= button_to 'Destroy this <%= singular_table_name %>', <%= singular_table_name %>_path(@<%= singular_table_name %>), method: :delete, class: "mt-2 rounded-lg py-3 px-5 bg-gray-100 font-medium" %>
-
- <%%= link_to 'Back to <%= plural_table_name %>', <%= index_helper %>_path, class: "ml-2 rounded-lg py-3 px-5 bg-gray-100 inline-block font-medium" %>
-
+<%% content_for :title, "Showing <%= human_name.downcase %>" %>
+
+
+ <%% if notice.present? %>
+
<%%= notice %>
+ <%% end %>
+
+
Showing <%= human_name.downcase %>
+
+ <%%= render @<%= singular_table_name %> %>
+
+ <%%= link_to "Edit this <%= human_name.downcase %>", <%= edit_helper(type: :path) %>, class: "w-full sm:w-auto text-center rounded-md px-3.5 py-2.5 bg-gray-100 hover:bg-gray-50 inline-block font-medium" %>
+ <%%= link_to "Back to <%= human_name.pluralize.downcase %>", <%= index_helper %>_path, class: "w-full sm:w-auto text-center mt-2 sm:mt-0 sm:ml-2 rounded-md px-3.5 py-2.5 bg-gray-100 hover:bg-gray-50 inline-block font-medium" %>
+ <%%= button_to "Destroy this <%= human_name.downcase %>", <%= model_resource_name(prefix: "@") %>, method: :delete, form_class: "sm:inline-block mt-2 sm:mt-0 sm:ml-2", class: "w-full rounded-md px-3.5 py-2.5 text-white bg-red-600 hover:bg-red-500 font-medium cursor-pointer", data: { turbo_confirm: "Are you sure?" } %>
diff --git a/lib/generators/test_unit/scaffold/scaffold_generator.rb b/lib/generators/test_unit/scaffold/scaffold_generator.rb
new file mode 100644
index 00000000..ff809b32
--- /dev/null
+++ b/lib/generators/test_unit/scaffold/scaffold_generator.rb
@@ -0,0 +1,21 @@
+require "rails/generators/test_unit/scaffold/scaffold_generator"
+
+module TestUnit # :nodoc:
+ module Generators # :nodoc:
+ class ScaffoldGenerator < Base # :nodoc:
+ def fix_system_test
+ if turbo_defined?
+ gsub_file File.join("test/system", class_path, "#{file_name.pluralize}_test.rb"),
+ /(click_on.*Destroy this.*)$/,
+ "accept_confirm { \\1 }"
+ end
+ end
+
+ private
+
+ def turbo_defined?
+ defined?(Turbo)
+ end
+ end
+ end
+end
diff --git a/lib/install/Procfile.dev b/lib/install/Procfile.dev
index 023e98a0..da151fee 100644
--- a/lib/install/Procfile.dev
+++ b/lib/install/Procfile.dev
@@ -1,2 +1,2 @@
-web: bin/rails server -p 3000
+web: bin/rails server
css: bin/rails tailwindcss:watch
diff --git a/lib/install/application.css b/lib/install/application.css
new file mode 100644
index 00000000..f1d8c73c
--- /dev/null
+++ b/lib/install/application.css
@@ -0,0 +1 @@
+@import "tailwindcss";
diff --git a/lib/install/application.tailwind.css b/lib/install/application.tailwind.css
deleted file mode 100644
index 8666d2f3..00000000
--- a/lib/install/application.tailwind.css
+++ /dev/null
@@ -1,13 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
-
-/*
-
-@layer components {
- .btn-primary {
- @apply py-2 px-4 bg-blue-200;
- }
-}
-
-*/
diff --git a/lib/install/dev b/lib/install/dev
index 2daf7764..ad72c7d5 100755
--- a/lib/install/dev
+++ b/lib/install/dev
@@ -1,9 +1,16 @@
-#!/usr/bin/env bash
+#!/usr/bin/env sh
-if ! command -v foreman &> /dev/null
-then
+if ! gem list foreman -i --silent; then
echo "Installing foreman..."
gem install foreman
fi
-foreman start -f Procfile.dev
+# Default to port 3000 if not specified
+export PORT="${PORT:-3000}"
+
+# Let the debug gem allow remote connections,
+# but avoid loading until `debugger` is called
+export RUBY_DEBUG_OPEN="true"
+export RUBY_DEBUG_LAZY="true"
+
+exec foreman start -f Procfile.dev "$@"
diff --git a/lib/install/tailwindcss.rb b/lib/install/install_tailwindcss.rb
similarity index 61%
rename from lib/install/tailwindcss.rb
rename to lib/install/install_tailwindcss.rb
index 413f86b8..3d471d07 100644
--- a/lib/install/tailwindcss.rb
+++ b/lib/install/install_tailwindcss.rb
@@ -1,19 +1,23 @@
APPLICATION_LAYOUT_PATH = Rails.root.join("app/views/layouts/application.html.erb")
CENTERING_CONTAINER_INSERTION_POINT = /^\s*<%= yield %>/.freeze
+TAILWIND_ASSET_PATH = Rails.root.join("app/assets/tailwind/application.css")
if APPLICATION_LAYOUT_PATH.exist?
- say "Add Tailwindcss include tags and container element in application layout"
- insert_into_file APPLICATION_LAYOUT_PATH.to_s, <<~ERB.indent(4), before: /^\s*<%= stylesheet_link_tag/
- <%= stylesheet_link_tag "tailwind", "inter-font", "data-turbo-track": "reload" %>
- ERB
+ unless File.read(APPLICATION_LAYOUT_PATH).match?(/stylesheet_link_tag :app/)
+ say "Add Tailwindcss include tags in application layout"
+ insert_into_file APPLICATION_LAYOUT_PATH.to_s, <<~ERB.indent(4), before: /^\s*<%= stylesheet_link_tag/
+ <%= stylesheet_link_tag "tailwind", "data-turbo-track": "reload" %>
+ ERB
+ end
+ say "Add Tailwindcss container element in application layout"
if File.open(APPLICATION_LAYOUT_PATH).read =~ /\n\s*<%= yield %>\n\s*<\/body>/
insert_into_file APPLICATION_LAYOUT_PATH.to_s, %(
\n ), before: CENTERING_CONTAINER_INSERTION_POINT
insert_into_file APPLICATION_LAYOUT_PATH.to_s, %(\n ), after: CENTERING_CONTAINER_INSERTION_POINT
end
else
say "Default application.html.erb is missing!", :red
- say %( Add <%= stylesheet_link_tag "tailwind", "inter-font", "data-turbo-track": "reload" %> within the tag in your custom layout.)
+ say %( Add <%= stylesheet_link_tag "tailwind", "data-turbo-track": "reload" %> within the tag in your custom layout.)
end
say "Build into app/assets/builds"
@@ -28,14 +32,9 @@
append_to_file(".gitignore", %(\n/app/assets/builds/*\n!/app/assets/builds/.keep\n))
end
-unless Rails.root.join("config/tailwind.config.js").exist?
- say "Add default config/tailwindcss.config.js"
- copy_file "#{__dir__}/tailwind.config.js", "config/tailwind.config.js"
-end
-
-unless Rails.root.join("app/assets/stylesheets/application.tailwind.css").exist?
- say "Add default app/assets/stylesheets/application.tailwind.css"
- copy_file "#{__dir__}/application.tailwind.css", "app/assets/stylesheets/application.tailwind.css"
+unless TAILWIND_ASSET_PATH.exist?
+ say "Add default #{TAILWIND_ASSET_PATH}"
+ copy_file "#{__dir__}/application.css", TAILWIND_ASSET_PATH
end
if Rails.root.join("Procfile.dev").exist?
@@ -49,7 +48,7 @@
end
say "Add bin/dev to start foreman"
-copy_file "#{__dir__}/dev", "bin/dev"
+copy_file "#{__dir__}/dev", "bin/dev", force: true
chmod "bin/dev", 0755, verbose: false
say "Compile initial Tailwind build"
diff --git a/lib/install/tailwind.config.js b/lib/install/tailwind.config.js
deleted file mode 100644
index 34c0c842..00000000
--- a/lib/install/tailwind.config.js
+++ /dev/null
@@ -1,21 +0,0 @@
-const defaultTheme = require('tailwindcss/defaultTheme')
-
-module.exports = {
- content: [
- './app/helpers/**/*.rb',
- './app/javascript/**/*.js',
- './app/views/**/*.{erb,haml,html,slim}'
- ],
- theme: {
- extend: {
- fontFamily: {
- sans: ['Inter var', ...defaultTheme.fontFamily.sans],
- },
- },
- },
- plugins: [
- require('@tailwindcss/forms'),
- require('@tailwindcss/aspect-ratio'),
- require('@tailwindcss/typography'),
- ]
-}
diff --git a/lib/install/upgrade_tailwindcss.rb b/lib/install/upgrade_tailwindcss.rb
new file mode 100644
index 00000000..d6ecadab
--- /dev/null
+++ b/lib/install/upgrade_tailwindcss.rb
@@ -0,0 +1,69 @@
+TAILWIND_CONFIG_PATH = Rails.root.join("config/tailwind.config.js")
+APPLICATION_LAYOUT_PATH = Rails.root.join("app/views/layouts/application.html.erb")
+POSTCSS_CONFIG_PATH = Rails.root.join("config/postcss.config.js")
+OLD_TAILWIND_ASSET_PATH = Rails.root.join("app/assets/stylesheets/application.tailwind.css")
+TAILWIND_ASSET_PATH = Rails.root.join("app/assets/tailwind/application.css")
+
+unless TAILWIND_CONFIG_PATH.exist?
+ say "Default tailwind.config.js is missing!", :red
+ abort
+end
+
+if File.read(TAILWIND_CONFIG_PATH).match?(/defaultTheme/)
+ say "Removing references to 'defaultTheme' from #{TAILWIND_CONFIG_PATH}"
+ gsub_file TAILWIND_CONFIG_PATH.to_s, /^(.*defaultTheme)/, "// \\1"
+end
+
+if POSTCSS_CONFIG_PATH.exist?
+ say "Moving PostCSS configuration to application root directory"
+ copy_file POSTCSS_CONFIG_PATH, Rails.root.join("postcss.config.js")
+ remove_file POSTCSS_CONFIG_PATH
+end
+
+if APPLICATION_LAYOUT_PATH.exist?
+ if File.read(APPLICATION_LAYOUT_PATH).match?(/"inter-font"/)
+ say "Strip Inter font CSS from application layout"
+ gsub_file APPLICATION_LAYOUT_PATH.to_s, %r{, "inter-font"}, ""
+ else
+ say "Inter font CSS not detected.", :green
+ end
+
+ if File.read(APPLICATION_LAYOUT_PATH).match?(/stylesheet_link_tag :app/) &&
+ File.read(APPLICATION_LAYOUT_PATH).match?(/stylesheet_link_tag "tailwind"/)
+ say "Remove unnecessary stylesheet_link_tag from application layout"
+ gsub_file APPLICATION_LAYOUT_PATH.to_s, %r{^\s*<%= stylesheet_link_tag "tailwind".*%>$}, ""
+ end
+else
+ say "Default application.html.erb is missing!", :red
+ say %( Please check your layouts and remove any "inter-font" stylesheet links.)
+end
+
+if OLD_TAILWIND_ASSET_PATH.exist?
+ say "Moving #{OLD_TAILWIND_ASSET_PATH} to #{TAILWIND_ASSET_PATH}"
+ copy_file OLD_TAILWIND_ASSET_PATH, TAILWIND_ASSET_PATH
+ remove_file OLD_TAILWIND_ASSET_PATH
+end
+
+if system("npx --version")
+ # We're pinning to v4.1.4 because v4.1.5 of the upgrade tool introduces a dependency version check
+ # on tailwind and I haven't been able to figure out how to get that to work reliably and I am
+ # extremely frustrated with the whole thing. See #544
+ #
+ # At some point we will probably need to unpin this at which point I am sincerely hoping that
+ # someone else will do it.
+ say "Running the upstream Tailwind CSS upgrader"
+ command = Shellwords.join(["npx", "@tailwindcss/upgrade@4.1.4", "--force", "--config", TAILWIND_CONFIG_PATH.to_s])
+ success = run(command, abort_on_failure: false)
+ unless success
+ say "The upgrade tool failed!", :red
+ say %( You probably need to update your configuration. Please read the error messages,)
+ say %( and check the Tailwind CSS upgrade guide at https://tailwindcss.com/docs/upgrade-guide.)
+ abort
+ end
+else
+ say "Could not run the Tailwind upgrade tool. Please see https://tailwindcss.com/docs/upgrade-guide for manual instructions.", :red
+ abort
+end
+
+say "Compile initial Tailwind build"
+run "rails tailwindcss:build"
diff --git a/lib/puma/plugin/tailwindcss.rb b/lib/puma/plugin/tailwindcss.rb
new file mode 100644
index 00000000..4624d7e8
--- /dev/null
+++ b/lib/puma/plugin/tailwindcss.rb
@@ -0,0 +1,72 @@
+require "puma/plugin"
+require "tailwindcss/commands"
+
+Puma::Plugin.create do
+ attr_reader :puma_pid, :tailwind_pid, :log_writer
+
+ def start(launcher)
+ @log_writer = launcher.log_writer
+ @puma_pid = $$
+ @tailwind_pid = fork do
+ Thread.new { monitor_puma }
+ # Using IO.popen(command, 'r+') will avoid watch_command read from $stdin.
+ # If we use system(*command) instead, IRB and Debug can't read from $stdin
+ # correctly bacause some keystrokes will be taken by watch_command.
+ begin
+ IO.popen(Tailwindcss::Commands.watch_command, 'r+') do |io|
+ IO.copy_stream(io, $stdout)
+ end
+ rescue Interrupt
+ end
+ end
+
+ launcher.events.on_stopped { stop_tailwind }
+
+ in_background do
+ monitor_tailwind
+ end
+ end
+
+ private
+ def stop_tailwind
+ Process.waitpid(tailwind_pid, Process::WNOHANG)
+ log "Stopping tailwind..."
+ Process.kill(:INT, tailwind_pid) if tailwind_pid
+ Process.wait(tailwind_pid)
+ rescue Errno::ECHILD, Errno::ESRCH
+ end
+
+ def monitor_puma
+ monitor(:puma_dead?, "Detected Puma has gone away, stopping tailwind...")
+ end
+
+ def monitor_tailwind
+ monitor(:tailwind_dead?, "Detected tailwind has gone away, stopping Puma...")
+ end
+
+ def monitor(process_dead, message)
+ loop do
+ if send(process_dead)
+ log message
+ Process.kill(:INT, $$)
+ break
+ end
+ sleep 2
+ end
+ end
+
+ def tailwind_dead?
+ Process.waitpid(tailwind_pid, Process::WNOHANG)
+ false
+ rescue Errno::ECHILD, Errno::ESRCH
+ true
+ end
+
+ def puma_dead?
+ Process.ppid != puma_pid
+ end
+
+ def log(...)
+ log_writer.log(...)
+ end
+end
diff --git a/lib/tailwindcss-rails.rb b/lib/tailwindcss-rails.rb
index 198aac3d..2b86ff1c 100644
--- a/lib/tailwindcss-rails.rb
+++ b/lib/tailwindcss-rails.rb
@@ -1,6 +1,6 @@
module Tailwindcss
end
-require "tailwindcss/upstream"
-require "tailwindcss/version"
-require "tailwindcss/engine"
+require_relative "tailwindcss/version"
+require_relative "tailwindcss/engine"
+require_relative "tailwindcss/commands"
diff --git a/lib/tailwindcss/commands.rb b/lib/tailwindcss/commands.rb
new file mode 100644
index 00000000..99ad30e0
--- /dev/null
+++ b/lib/tailwindcss/commands.rb
@@ -0,0 +1,43 @@
+require "tailwindcss/ruby"
+
+module Tailwindcss
+ module Commands
+ class << self
+ def compile_command(debug: false, **kwargs)
+ debug = ENV["TAILWINDCSS_DEBUG"].present? if ENV.key?("TAILWINDCSS_DEBUG")
+ rails_root = defined?(Rails) ? Rails.root : Pathname.new(Dir.pwd)
+
+ command = [
+ Tailwindcss::Ruby.executable(**kwargs),
+ "-i", rails_root.join("app/assets/tailwind/application.css").to_s,
+ "-o", rails_root.join("app/assets/builds/tailwind.css").to_s,
+ ]
+
+ command << "--minify" unless (debug || rails_css_compressor?)
+
+ postcss_path = rails_root.join("postcss.config.js")
+ command += ["--postcss", postcss_path.to_s] if File.exist?(postcss_path)
+
+ command
+ end
+
+ def watch_command(always: false, poll: false, **kwargs)
+ compile_command(**kwargs).tap do |command|
+ command << "-w"
+ command << "always" if always
+ command << "-p" if poll
+ end
+ end
+
+ def command_env(verbose:)
+ {}.tap do |env|
+ env["DEBUG"] = "1" if verbose
+ end
+ end
+
+ def rails_css_compressor?
+ defined?(Rails) && Rails&.application&.config&.assets&.css_compressor.present?
+ end
+ end
+ end
+end
diff --git a/lib/tailwindcss/engine.rb b/lib/tailwindcss/engine.rb
index 4b9b9fdc..7b88c5f1 100644
--- a/lib/tailwindcss/engine.rb
+++ b/lib/tailwindcss/engine.rb
@@ -2,14 +2,16 @@
module Tailwindcss
class Engine < ::Rails::Engine
- initializer "tailwindcss.assets" do
- Rails.application.config.assets.precompile += %w( inter-font.css )
- end
-
initializer "tailwindcss.disable_generator_stylesheets" do
Rails.application.config.generators.stylesheets = false
end
+ initializer "tailwindcss.exclude_asset_path", before: "propshaft.append_assets_path" do
+ if Rails.application.config.assets.excluded_paths # the app may not be using Propshaft
+ Rails.application.config.assets.excluded_paths << Rails.root.join("app/assets/tailwind")
+ end
+ end
+
config.app_generators do |g|
g.template_engine :tailwindcss
end
diff --git a/lib/tailwindcss/upstream.rb b/lib/tailwindcss/upstream.rb
index 489bbe4a..358db1c0 100644
--- a/lib/tailwindcss/upstream.rb
+++ b/lib/tailwindcss/upstream.rb
@@ -1,15 +1,6 @@
module Tailwindcss
- # constants describing the upstream tailwindcss project
module Upstream
- VERSION = "v3.0.23"
-
- # rubygems platform name => upstream release filename
- NATIVE_PLATFORMS = {
- "arm64-darwin" => "tailwindcss-macos-arm64",
- "x64-mingw32" => "tailwindcss-windows-x64.exe",
- "x86_64-darwin" => "tailwindcss-macos-x64",
- "x86_64-linux" => "tailwindcss-linux-x64",
- "aarch64-linux" => "tailwindcss-linux-arm64",
- }
+ VERSION = Tailwindcss::Ruby::Upstream::VERSION
+ deprecate_constant :VERSION
end
end
diff --git a/lib/tailwindcss/version.rb b/lib/tailwindcss/version.rb
index 62f41fb6..7ab2db8d 100644
--- a/lib/tailwindcss/version.rb
+++ b/lib/tailwindcss/version.rb
@@ -1,3 +1,3 @@
module Tailwindcss
- VERSION = "2.0.8"
+ VERSION = "4.2.3"
end
diff --git a/lib/tasks/build.rake b/lib/tasks/build.rake
index 760a478e..603c8059 100644
--- a/lib/tasks/build.rake
+++ b/lib/tasks/build.rake
@@ -1,14 +1,30 @@
-TAILWIND_COMPILE_COMMAND = "#{RbConfig.ruby} #{Pathname.new(__dir__).to_s}/../../exe/tailwindcss -i #{Rails.root.join("app/assets/stylesheets/application.tailwind.css")} -o #{Rails.root.join("app/assets/builds/tailwind.css")} -c #{Rails.root.join("config/tailwind.config.js")} --minify"
-
namespace :tailwindcss do
desc "Build your Tailwind CSS"
- task :build do
- system TAILWIND_COMPILE_COMMAND
+ task build: :environment do |_, args|
+ debug = args.extras.include?("debug")
+ verbose = args.extras.include?("verbose")
+
+ command = Tailwindcss::Commands.compile_command(debug: debug)
+ env = Tailwindcss::Commands.command_env(verbose: verbose)
+ puts "Running: #{Shellwords.join(command)}" if verbose
+
+ system(env, *command, exception: true)
end
desc "Watch and build your Tailwind CSS on file changes"
- task :watch do
- system "#{TAILWIND_COMPILE_COMMAND} -w"
+ task watch: :environment do |_, args|
+ debug = args.extras.include?("debug")
+ poll = args.extras.include?("poll")
+ always = args.extras.include?("always")
+ verbose = args.extras.include?("verbose")
+
+ command = Tailwindcss::Commands.watch_command(always: always, debug: debug, poll: poll)
+ env = Tailwindcss::Commands.command_env(verbose: verbose)
+ puts "Running: #{Shellwords.join(command)}" if verbose
+
+ system(env, *command)
+ rescue Interrupt
+ puts "Received interrupt, exiting tailwindcss:watch" if args.extras.include?("verbose")
end
end
@@ -16,6 +32,8 @@ Rake::Task["assets:precompile"].enhance(["tailwindcss:build"])
if Rake::Task.task_defined?("test:prepare")
Rake::Task["test:prepare"].enhance(["tailwindcss:build"])
+elsif Rake::Task.task_defined?("spec:prepare")
+ Rake::Task["spec:prepare"].enhance(["tailwindcss:build"])
elsif Rake::Task.task_defined?("db:test:prepare")
Rake::Task["db:test:prepare"].enhance(["tailwindcss:build"])
end
diff --git a/lib/tasks/install.rake b/lib/tasks/install.rake
index 2a571cad..f94ec2a1 100644
--- a/lib/tasks/install.rake
+++ b/lib/tasks/install.rake
@@ -1,6 +1,6 @@
namespace :tailwindcss do
desc "Install Tailwind CSS into the app"
task :install do
- system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/tailwindcss.rb", __dir__)}"
+ system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/install_tailwindcss.rb", __dir__)}"
end
end
diff --git a/lib/tasks/upgrade.rake b/lib/tasks/upgrade.rake
new file mode 100644
index 00000000..05047523
--- /dev/null
+++ b/lib/tasks/upgrade.rake
@@ -0,0 +1,6 @@
+namespace :tailwindcss do
+ desc "Upgrade app from Tailwind CSS v3 to v4"
+ task :upgrade do
+ system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/upgrade_tailwindcss.rb", __dir__)}"
+ end
+end
diff --git a/rakelib/package.rake b/rakelib/package.rake
deleted file mode 100644
index a7970e67..00000000
--- a/rakelib/package.rake
+++ /dev/null
@@ -1,108 +0,0 @@
-# coding: utf-8
-#
-# Rake tasks to manage native gem packages with binary executables from tailwindlabs/tailwindcss
-#
-# TL;DR: run "rake package"
-#
-# The native platform gems (defined by Tailwindcss::Upstream::NATIVE_PLATFORMS) will each contain
-# two files in addition to what the vanilla ruby gem contains:
-#
-# exe/
-# ├── tailwindcss # generic ruby script to find and run the binary
-# └──
/
-# └── tailwindcss # the tailwindcss binary executable
-#
-# The ruby script `exe/tailwindcss` is installed into the user's path, and it simply locates the
-# binary and executes it. Note that this script is required because rubygems requires that
-# executables declared in a gemspec must be Ruby scripts.
-#
-# As a concrete example, an x86_64-linux system will see these files on disk after installing
-# tailwindcss-rails-1.x.x-x86_64-linux.gem:
-#
-# exe/
-# ├── tailwindcss
-# └── x86_64-linux/
-# └── tailwindcss
-#
-# So the full set of gem files created will be:
-#
-# - pkg/tailwindcss-rails-1.0.0.gem
-# - pkg/tailwindcss-rails-1.0.0-aarch64-linux.gem
-# - pkg/tailwindcss-rails-1.0.0-arm64-darwin.gem
-# - pkg/tailwindcss-rails-1.0.0-x64-mingw32.gem
-# - pkg/tailwindcss-rails-1.0.0-x86_64-darwin.gem
-# - pkg/tailwindcss-rails-1.0.0-x86_64-linux.gem
-#
-# Note that in addition to the native gems, a vanilla "ruby" gem will also be created without
-# either the `exe/tailwindcss` script or a binary executable present.
-#
-#
-# New rake tasks created:
-#
-# - rake gem:ruby # Build the ruby gem
-# - rake gem:aarch64-linux # Build the aarch64-linux gem
-# - rake gem:arm64-darwin # Build the arm64-darwin gem
-# - rake gem:x64-mingw32 # Build the x64-mingw32 gem
-# - rake gem:x86_64-darwin # Build the x86_64-darwin gem
-# - rake gem:x86_64-linux # Build the x86_64-linux gem
-# - rake download # Download all tailwindcss binaries
-#
-# Modified rake tasks:
-#
-# - rake gem # Build all the gem files
-# - rake package # Build all the gem files (same as `gem`)
-# - rake repackage # Force a rebuild of all the gem files
-#
-# Note also that the binary executables will be lazily downloaded when needed, but you can
-# explicitly download them with the `rake download` command.
-#
-require "rubygems/package_task"
-require "open-uri"
-require_relative "../lib/tailwindcss/upstream"
-
-def tailwindcss_download_url(filename)
- "https://github.com/tailwindlabs/tailwindcss/releases/download/#{Tailwindcss::Upstream::VERSION}/#{filename}"
-end
-
-TAILWINDCSS_RAILS_GEMSPEC = Bundler.load_gemspec("tailwindcss-rails.gemspec")
-
-gem_path = Gem::PackageTask.new(TAILWINDCSS_RAILS_GEMSPEC).define
-desc "Build the ruby gem"
-task "gem:ruby" => [gem_path]
-
-exepaths = []
-Tailwindcss::Upstream::NATIVE_PLATFORMS.each do |platform, filename|
- TAILWINDCSS_RAILS_GEMSPEC.dup.tap do |gemspec|
- exedir = File.join(gemspec.bindir, platform) # "exe/x86_64-linux"
- exepath = File.join(exedir, "tailwindcss") # "exe/x86_64-linux/tailwindcss"
- exepaths << exepath
-
- # modify a copy of the gemspec to include the native executable
- gemspec.platform = platform
- gemspec.files += [exepath, "LICENSE-DEPENDENCIES"]
-
- # create a package task
- gem_path = Gem::PackageTask.new(gemspec).define
- desc "Build the #{platform} gem"
- task "gem:#{platform}" => [gem_path]
-
- directory exedir
- file exepath => [exedir] do
- release_url = tailwindcss_download_url(filename)
- warn "Downloading #{exepath} from #{release_url} ..."
-
- # lazy, but fine for now.
- URI.open(release_url) do |remote|
- File.open(exepath, "wb") do |local|
- local.write(remote.read)
- end
- end
- FileUtils.chmod(0755, exepath, verbose: true)
- end
- end
-end
-
-desc "Download all tailwindcss binaries"
-task "download" => exepaths
-
-CLOBBER.add(exepaths.map { |p| File.dirname(p) })
diff --git a/tailwindcss-rails.gemspec b/tailwindcss-rails.gemspec
index 672c9885..45c19c28 100644
--- a/tailwindcss-rails.gemspec
+++ b/tailwindcss-rails.gemspec
@@ -14,9 +14,24 @@ Gem::Specification.new do |spec|
"rubygems_mfa_required" => "true"
}
+ spec.required_rubygems_version = ">= 3.2.0" # for Gem::Platform#match_gem?
+
spec.files = Dir["{app,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]
- spec.bindir = "exe"
- spec.executables << "tailwindcss"
- spec.add_dependency "railties", ">= 6.0.0"
+ spec.add_dependency "railties", ">= 7.0.0"
+ spec.add_dependency "tailwindcss-ruby", "~> 4.0"
+
+ # TODO: remove this after a suitable period of time after the v4.0.0 release.
+ spec.post_install_message = <<~TEXT
+ == Upgrading to Tailwind CSS v4 ==
+
+ If you are upgrading to tailwindcss-rails 4.x, please read the upgrade guide at:
+
+ https://github.com/rails/tailwindcss-rails/blob/main/README.md#upgrading-your-application-from-tailwind-v3-to-v4
+
+ If you're not ready to upgrade yet, please pin to version 3 in your Gemfile:
+
+ gem "tailwindcss-rails", "~> 3.3.1"
+
+ TEXT
end
diff --git a/test/integration/user_install_test.sh b/test/integration/user_install_test.sh
new file mode 100755
index 00000000..bfd7a87c
--- /dev/null
+++ b/test/integration/user_install_test.sh
@@ -0,0 +1,76 @@
+#! /usr/bin/env bash
+# reproduce the documented user journey for installing and running tailwindcss-rails
+# this is run in the CI pipeline, non-zero exit code indicates a failure
+
+set -o pipefail
+set -eux
+
+# set up dependencies
+rm -f Gemfile.lock
+bundle remove actionmailer || true
+bundle remove rails || true
+bundle add rails --skip-install ${RAILSOPTS:-}
+bundle install --prefer-local
+
+# do our work a directory with spaces in the name (#176, #184)
+rm -rf "My Workspace"
+mkdir "My Workspace"
+pushd "My Workspace"
+
+# create a rails app
+bundle exec rails -v
+bundle exec rails new test-install --skip-bundle
+pushd test-install
+
+# make sure to use the same version of rails (e.g., install from git source if necessary)
+bundle remove rails --skip-install
+bundle add rails --skip-install ${RAILSOPTS:-}
+
+# use the tailwindcss-rails under test
+bundle add tailwindcss-rails --skip-install --path="../.."
+bundle add tailwindcss-ruby --skip-install ${TAILWINDCSSOPTS:-}
+bundle install --prefer-local
+bundle show --paths | fgrep tailwind
+bundle binstubs --all
+
+# install tailwindcss
+bin/rails tailwindcss:install
+
+# TEST: tailwind was installed correctly
+grep -q "<> Rakefile
+task :still_here do
+ puts "Rake process did not exit early"
+end
+EOF
+
+cat >> app/assets/tailwind/application.css < "Rails 8.0.0.beta" ]] ; then
+ # TEST: presence of the generated file
+ bin/rails generate authentication
+ grep -q PasswordsController app/controllers/passwords_controller.rb
+fi
+
+# TEST: presence of the generated file
+bin/rails generate scaffold post title:string body:text published:boolean
+grep -q "Show" app/views/posts/index.html.erb
+
+# TEST: the "accept_confirm" system test change was applied cleanly
+grep -q "accept_confirm { click_on \"Destroy this post\"" test/system/posts_test.rb
+
+# TEST: contents of the css file
+bin/rails tailwindcss:build[verbose]
+grep -q "py-2" app/assets/builds/tailwind.css
+
+# TEST: contents include application.css directives
+grep -q "#abc12399" app/assets/builds/tailwind.css
+
+echo "OK"
diff --git a/test/integration/user_upgrade_test.sh b/test/integration/user_upgrade_test.sh
new file mode 100755
index 00000000..d6017efc
--- /dev/null
+++ b/test/integration/user_upgrade_test.sh
@@ -0,0 +1,90 @@
+#! /usr/bin/env bash
+# reproduce the documented user journey for installing and running tailwindcss-rails
+# this is run in the CI pipeline, non-zero exit code indicates a failure
+
+set -o pipefail
+set -eux
+
+# set up dependencies
+rm -f Gemfile.lock
+bundle remove actionmailer || true
+bundle remove rails || true
+bundle add rails --skip-install ${RAILSOPTS:-}
+bundle install --prefer-local
+
+# do our work a directory with spaces in the name (#176, #184)
+rm -rf "My Workspace"
+mkdir "My Workspace"
+pushd "My Workspace"
+
+# create a rails app
+bundle exec rails -v
+bundle exec rails new test-upgrade --skip-bundle
+pushd test-upgrade
+
+# make sure to use the same version of rails (e.g., install from git source if necessary)
+bundle remove rails --skip-install
+bundle add rails --skip-install ${RAILSOPTS:-}
+
+# set up app with tailwindcss-rails v3 and tailwindcss-ruby v3
+bundle add tailwindcss-rails --skip-install --version 3.3.0
+bundle add tailwindcss-ruby --skip-install --version 3.4.17
+bundle install --prefer-local
+bundle show --paths | fgrep tailwind
+bundle binstubs --all
+
+# install tailwindcss
+bin/rails tailwindcss:install
+grep -q inter-font app/views/layouts/application.html.erb
+
+if [[ $(rails -v) > "Rails 8.0.0.beta" ]] ; then
+ # install auth templates
+ bin/rails generate authentication
+ grep -q PasswordsController app/controllers/passwords_controller.rb
+fi
+
+# install scaffold templates
+bin/rails generate scaffold post title:string body:text published:boolean
+grep -q "Show this post" app/views/posts/index.html.erb
+
+# upgrade time!
+bundle remove tailwindcss-rails --skip-install
+bundle remove tailwindcss-ruby --skip-install
+
+bundle add tailwindcss-rails --skip-install --path="../.."
+bundle add tailwindcss-ruby --skip-install ${TAILWINDCSSOPTS:---version 4.0.0}
+
+bundle install --prefer-local
+bundle show --paths | fgrep tailwind
+bundle binstubs --all
+
+# create a postcss file
+cat < config/postcss.config.js
+module.exports = {
+ plugins: {
+ autoprefixer: {},
+ },
+}
+EOF
+
+bin/rails tailwindcss:upgrade
+
+# TEST: removal of inter-font CSS
+if grep -q inter-font app/views/layouts/application.html.erb ; then
+ echo "FAIL: inter-font CSS not removed"
+ exit 1
+fi
+
+# TEST: moving the postcss file
+test ! -a config/postcss.config.js
+test -a postcss.config.js
+
+# TEST: moving application.tailwind.css
+test ! -a app/assets/stylesheets/application.tailwind.css
+test -a app/assets/tailwind/application.css
+
+# generate CSS
+bin/rails tailwindcss:build[verbose]
+grep -q "py-2" app/assets/builds/tailwind.css
+
+echo "OK"
diff --git a/test/lib/generators/tailwindcss/authentication_generator_test.rb b/test/lib/generators/tailwindcss/authentication_generator_test.rb
new file mode 100644
index 00000000..bdf712b0
--- /dev/null
+++ b/test/lib/generators/tailwindcss/authentication_generator_test.rb
@@ -0,0 +1,16 @@
+require "test_helper"
+
+if Rails::VERSION::MAJOR >= 8
+ require "generators/tailwindcss/authentication/authentication_generator"
+
+ class Tailwindcss::Generators::AuthenticationGeneratorTest < Rails::Generators::TestCase
+ tests Tailwindcss::Generators::AuthenticationGenerator
+ destination TAILWINDCSS_TEST_APP_ROOT
+
+ test "generates the new session template" do
+ run_generator
+
+ assert_file "app/views/sessions/new.html.erb"
+ end
+ end
+end
diff --git a/test/lib/generators/tailwindcss/controller_generator_test.rb b/test/lib/generators/tailwindcss/controller_generator_test.rb
index 42b67ec6..62f3b1ee 100644
--- a/test/lib/generators/tailwindcss/controller_generator_test.rb
+++ b/test/lib/generators/tailwindcss/controller_generator_test.rb
@@ -3,14 +3,45 @@
class Tailwindcss::Generators::ControllerGeneratorTest < Rails::Generators::TestCase
tests Tailwindcss::Generators::ControllerGenerator
- destination Dir.mktmpdir
+ destination TAILWINDCSS_TEST_APP_ROOT
arguments %w(Messages index show)
test "generates correct view templates" do
run_generator
- assert_file "app/views/messages/index.html.erb"
- assert_file "app/views/messages/show.html.erb"
+
+ ["index", "show"].each do |view|
+ assert_file "app/views/messages/#{view}.html.erb"
+ end
+ end
+
+ test "generates correct view templates when namespaced" do
+ run_generator ["admin/messages", "index", "show"]
+
+ ["index", "show"].each do |view|
+ assert_file "app/views/admin/messages/#{view}.html.erb"
+ end
end
-end
+ [
+ "lib/templates/erb/controller",
+ "lib/templates/tailwindcss/controller",
+ ].each do |templates_path|
+ test "overriding generator templates in #{templates_path}" do
+ override_dir = File.join(destination_root, templates_path)
+ FileUtils.mkdir_p override_dir
+ File.open(File.join(override_dir, "view.html.erb"), "w") { |f| f.puts "This is a custom template" }
+
+ # change directory because the generator adds a relative path to source_paths
+ Dir.chdir(destination_root) do
+ run_generator
+ end
+
+ ["index", "show"].each do |view|
+ assert_file "app/views/messages/#{view}.html.erb" do |body|
+ assert_match("This is a custom template", body, "index custom template should be used")
+ end
+ end
+ end
+ end
+end
diff --git a/test/lib/generators/tailwindcss/mailer_generator_test.rb b/test/lib/generators/tailwindcss/mailer_generator_test.rb
index db604bd3..e6fa61cc 100644
--- a/test/lib/generators/tailwindcss/mailer_generator_test.rb
+++ b/test/lib/generators/tailwindcss/mailer_generator_test.rb
@@ -3,8 +3,8 @@
require "generators/tailwindcss/mailer/mailer_generator"
class Tailwindcss::Generators::MailerGeneratorTest < Rails::Generators::TestCase
- tests Rails::Generators::MailerGenerator
- destination Dir.mktmpdir
+ tests Tailwindcss::Generators::MailerGenerator
+ destination TAILWINDCSS_TEST_APP_ROOT
arguments %w(Notifications invoice)
@@ -20,6 +20,60 @@ class Tailwindcss::Generators::MailerGeneratorTest < Rails::Generators::TestCase
assert_match %r(app/views/notifications_mailer/invoice\.text\.erb), view
assert_match(/\= @greeting/, view)
end
+
+ assert_file "app/views/layouts/mailer.text.erb" do |view|
+ assert_match("<%= yield %>", view)
+ end
+
+ assert_file "app/views/layouts/mailer.html.erb" do |view|
+ assert_match("<%= yield %>", view)
+ end
end
-end
+ test "generates correct mailer view templates with namespace" do
+ run_generator ["admin/notifications", "invoice"]
+
+ assert_file "app/views/admin/notifications_mailer/invoice.html.erb" do |view|
+ assert_match %r(app/views/admin/notifications_mailer/invoice\.html\.erb), view
+ assert_match(/\= @greeting/, view)
+ end
+
+ assert_file "app/views/admin/notifications_mailer/invoice.text.erb" do |view|
+ assert_match %r(app/views/admin/notifications_mailer/invoice\.text\.erb), view
+ assert_match(/\= @greeting/, view)
+ end
+
+ assert_file "app/views/layouts/admin/mailer.text.erb" do |view|
+ assert_match("<%= yield %>", view)
+ end
+
+ assert_file "app/views/layouts/admin/mailer.html.erb" do |view|
+ assert_match("<%= yield %>", view)
+ end
+ end
+
+ [
+ "lib/templates/erb/mailer",
+ "lib/templates/tailwindcss/mailer",
+ ].each do |templates_path|
+ test "overriding generator templates in #{templates_path}" do
+ override_dir = File.join(destination_root, templates_path)
+ FileUtils.mkdir_p override_dir
+ File.open(File.join(override_dir, "view.html.erb"), "w") { |f| f.puts "This is a custom template" }
+ File.open(File.join(override_dir, "layout.html.erb"), "w") { |f| f.puts "This is a custom layout" }
+
+ # change directory because the generator adds a relative path to source_paths
+ Dir.chdir(destination_root) do
+ run_generator
+ end
+
+ assert_file "app/views/notifications_mailer/invoice.html.erb" do |view|
+ assert_match("This is a custom template", view)
+ end
+
+ assert_file "app/views/layouts/mailer.html.erb" do |view|
+ assert_match("This is a custom layout", view)
+ end
+ end
+ end
+end
diff --git a/test/lib/generators/tailwindcss/scaffold_generator_test.rb b/test/lib/generators/tailwindcss/scaffold_generator_test.rb
index 2973a7a4..fb7db462 100644
--- a/test/lib/generators/tailwindcss/scaffold_generator_test.rb
+++ b/test/lib/generators/tailwindcss/scaffold_generator_test.rb
@@ -3,13 +3,47 @@
class Tailwindcss::Generators::ScaffoldGeneratorTest < Rails::Generators::TestCase
tests Tailwindcss::Generators::ScaffoldGenerator
- destination Dir.mktmpdir
+ destination TAILWINDCSS_TEST_APP_ROOT
arguments %w(message title:string content:text)
- test "generates correct view templates" do
+ test "generates view templates" do
run_generator
- %w(index edit new show _form _message).each { |view| assert_file "app/views/messages/#{view}.html.erb" }
+ %w(index edit new show _form _message).each do |view|
+ assert_file "app/views/messages/#{view}.html.erb"
+ end
+ end
+
+ test "generates view templates with namespace" do
+ run_generator [ "admin/role", "name:string", "description:string" ]
+
+ %w(index edit new show _form _role).each do |view|
+ assert_file "app/views/admin/roles/#{view}.html.erb"
+ end
+ end
+
+ [
+ "lib/templates/tailwindcss/scaffold",
+ "lib/templates/erb/scaffold",
+ ].each do |templates_path|
+ test "overriding generator templates in #{templates_path}" do
+ override_dir = File.join(destination_root, templates_path)
+ FileUtils.mkdir_p override_dir
+ File.open(File.join(override_dir, "index.html.erb"), "w") { |f| f.puts "This is a custom template" }
+
+ # change directory because the generator adds a relative path to source_paths
+ Dir.chdir(destination_root) do
+ run_generator
+ end
+
+ %w(edit new show _form _message).each do |view|
+ assert_file "app/views/messages/#{view}.html.erb"
+ end
+
+ assert_file "app/views/messages/index.html.erb" do |body|
+ assert_match("This is a custom template", body, "index custom template should be used")
+ end
+ end
end
end
diff --git a/test/lib/tailwindcss/commands_test.rb b/test/lib/tailwindcss/commands_test.rb
new file mode 100644
index 00000000..d09481a4
--- /dev/null
+++ b/test/lib/tailwindcss/commands_test.rb
@@ -0,0 +1,129 @@
+require "test_helper"
+require "minitest/mock"
+
+class Tailwindcss::CommandsTest < ActiveSupport::TestCase
+ attr_accessor :executable
+
+ def setup
+ super
+ @executable = Tailwindcss::Ruby.executable
+ end
+
+ test ".compile_command" do
+ Rails.stub(:root, File) do # Rails.root won't work in this test suite
+ actual = Tailwindcss::Commands.compile_command
+ assert_kind_of(Array, actual)
+ assert_equal(executable, actual.first)
+ assert_includes(actual, "-i")
+ assert_includes(actual, "-o")
+ end
+ end
+
+ test ".compile_command debug flag" do
+ Rails.stub(:root, File) do # Rails.root won't work in this test suite
+ actual = Tailwindcss::Commands.compile_command
+ assert_kind_of(Array, actual)
+ assert_equal(executable, actual.first)
+ assert_includes(actual, "--minify")
+
+ actual = Tailwindcss::Commands.compile_command(debug: true)
+ assert_kind_of(Array, actual)
+ assert_equal(executable, actual.first)
+ refute_includes(actual, "--minify")
+ end
+ end
+
+ test ".compile_command debug environment variable" do
+ begin
+ Rails.stub(:root, File) do # Rails.root won't work in this test suite
+ ENV["TAILWINDCSS_DEBUG"] = ""
+ actual = Tailwindcss::Commands.compile_command
+ assert_kind_of(Array, actual)
+ assert_includes(actual, "--minify")
+
+ actual = Tailwindcss::Commands.compile_command(debug: true)
+ assert_kind_of(Array, actual)
+ assert_includes(actual, "--minify")
+
+ ENV["TAILWINDCSS_DEBUG"] = "any non-blank value"
+ actual = Tailwindcss::Commands.compile_command
+ assert_kind_of(Array, actual)
+ refute_includes(actual, "--minify")
+
+ actual = Tailwindcss::Commands.compile_command(debug: true)
+ assert_kind_of(Array, actual)
+ refute_includes(actual, "--minify")
+ end
+ ensure
+ ENV.delete('TAILWINDCSS_DEBUG')
+ end
+ end
+
+ test ".compile_command when Rails compression is on" do
+ Rails.stub(:root, File) do # Rails.root won't work in this test suite
+ Tailwindcss::Commands.stub(:rails_css_compressor?, true) do
+ actual = Tailwindcss::Commands.compile_command
+ assert_kind_of(Array, actual)
+ refute_includes(actual, "--minify")
+ end
+
+ Tailwindcss::Commands.stub(:rails_css_compressor?, false) do
+ actual = Tailwindcss::Commands.compile_command
+ assert_kind_of(Array, actual)
+ assert_includes(actual, "--minify")
+ end
+ end
+ end
+
+ test ".compile_command when postcss.config.js exists" do
+ Dir.mktmpdir do |tmpdir|
+ Rails.stub(:root, Pathname.new(tmpdir)) do # Rails.root won't work in this test suite
+ actual = Tailwindcss::Commands.compile_command
+ assert_kind_of(Array, actual)
+ assert_equal(executable, actual.first)
+ refute_includes(actual, "--postcss")
+
+ config_file = Rails.root.join("postcss.config.js")
+ FileUtils.touch(config_file)
+ actual = Tailwindcss::Commands.compile_command
+ assert_kind_of(Array, actual)
+ assert_equal(executable, actual.first)
+ assert_includes(actual, "--postcss")
+ postcss_index = actual.index("--postcss")
+ assert_equal(actual[postcss_index + 1], config_file.to_s)
+ end
+ end
+ end
+
+ test ".watch_command" do
+ Rails.stub(:root, File) do # Rails.root won't work in this test suite
+ actual = Tailwindcss::Commands.watch_command
+ assert_kind_of(Array, actual)
+ assert_equal(executable, actual.first)
+ assert_includes(actual, "-w")
+ refute_includes(actual, "-p")
+ assert_includes(actual, "--minify")
+
+ actual = Tailwindcss::Commands.watch_command(debug: true)
+ assert_kind_of(Array, actual)
+ assert_equal(executable, actual.first)
+ assert_includes(actual, "-w")
+ refute_includes(actual, "-p")
+ refute_includes(actual, "--minify")
+
+ actual = Tailwindcss::Commands.watch_command(poll: true)
+ assert_kind_of(Array, actual)
+ assert_equal(executable, actual.first)
+ assert_includes(actual, "-w")
+ refute_includes(actual, "always")
+ assert_includes(actual, "-p")
+ assert_includes(actual, "--minify")
+
+ actual = Tailwindcss::Commands.watch_command(always: true)
+ assert_kind_of(Array, actual)
+ assert_equal(executable, actual.first)
+ assert_includes(actual, "-w")
+ assert_includes(actual, "always")
+ end
+ end
+end
diff --git a/test/test_helper.rb b/test/test_helper.rb
index da96cabe..68614219 100644
--- a/test/test_helper.rb
+++ b/test/test_helper.rb
@@ -4,10 +4,22 @@
require "rails"
require "rails/test_help"
require "debug"
-require_relative "../lib/tailwindcss-rails"
require "rails/test_unit/reporter"
Rails::TestUnitReporter.executable = "bin/test"
+TAILWINDCSS_TEST_APP_ROOT = Dir.mktmpdir
+Rails::Generators.templates_path << File.join(TAILWINDCSS_TEST_APP_ROOT, "lib/templates")
+
class ActiveSupport::TestCase
+ def setup
+ FileUtils.rm_rf(TAILWINDCSS_TEST_APP_ROOT)
+ FileUtils.mkdir_p(TAILWINDCSS_TEST_APP_ROOT)
+ end
+
+ def teardown
+ FileUtils.rm_rf(TAILWINDCSS_TEST_APP_ROOT)
+ end
end
+
+require_relative "../lib/tailwindcss-rails"