Remove the upstream tailwindcss packaging

This is being extracted into the tailwindcss-ruby gem.

Author: flavorjones

.gitignore

@@ -13,4 +13,3 @@
 *.gem
 .idea/
 **/tmp/
-/exe/*/tailwindcss

CHANGELOG.md

@@ -1,3 +1,14 @@
+## next / unreleased
+
+### Notable changes
+
+* The upstream `tailwindcss` executable has been extracted from this gem into a new dependency, `tailwindcss-ruby`.
+
+  In advance of the upcoming TailwindCSS v4 release, we are decoupling the `tailwindcss` executable
+  from the Rails integration. This will allow users to upgrade TailwindCSS at a time of their
+  choosing, and allow early adopters to start using the beta releases.
+
+
 ## v2.7.7 / 2024-10-02
 
 * Proactively support changes to Rails's authentication templates shipping in Rails 8.0.0.beta2 (which is not yet released). (#407, #408) @seanpdoyle @flavorjones

CONTRIBUTING.md

@@ -23,23 +23,14 @@ gem "tailwindcss-rails", path: "/path/to/tailwindcss-rails"
 ```
 
 
-## Updating to the latest upstream tailwindcss version
-
-Update `lib/tailwindcss/upstream.rb` with the upstream version.
-
-Run `bundle exec rake clobber` then `bundle exec rake download` to ensure the tailwindcss binaries can be downloaded, and that you have the correct versions on local disk.
-
 ## Cutting a release of tailwindcss-rails
 
 - bump the version
   - [ ] update `lib/tailwindcss/version.rb`
   - [ ] update `CHANGELOG.md`
   - [ ] commit and create a git tag
-- build the native gems:
-  - [ ] `bundle exec rake clobber` to clean up possibly-old tailwindcss executables
-  - [ ] `bundle exec rake package`
 - push
-  - [ ] `for g in pkg/*.gem ; do gem push $g ; done`
+  - [ ] `gem push pkg/*.gem`
   - [ ] `git push && git push --tags`
 - announce
   - [ ] create a release at https://github.com/rails/tailwindcss-rails/releases

Gemfile.lock

@@ -3,6 +3,7 @@ PATH
   specs:
     tailwindcss-rails (2.7.7)
       railties (>= 7.0.0)
+      tailwindcss-ruby
 
 GEM
   remote: https://rubygems.org/
@@ -128,6 +129,7 @@ GEM
       io-console (~> 0.5)
     securerandom (0.3.1)
     stringio (3.1.1)
+    tailwindcss-ruby (0.1.0-x86_64-linux)
     thor (1.3.1)
     timeout (0.4.1)
     tzinfo (2.0.6)

LICENSE-DEPENDENCIES

@@ -35,34 +35,7 @@ With Rails 7 you can generate a new application preconfigured with Tailwind by u
 1. Run `./bin/bundle add tailwindcss-rails`
 2. Run `./bin/rails tailwindcss:install`
 
-This gem wraps [the standalone executable version](https://tailwindcss.com/blog/standalone-cli) of the Tailwind CSS v3 framework. These executables are platform specific, so there are actually separate underlying gems per platform, but the correct gem will automatically be picked for your platform.
-
-Supported platforms are:
-
-- arm64-darwin (macos-arm64)
-- x64-mingw32 (windows-x64)
-- x64-mingw-ucr (windows-x64)
-- x86_64-darwin (macos-x64)
-- x86_64-linux (linux-x64)
-- aarch64-linux (linux-arm64)
-- arm-linux (linux-armv7)
-
-
-### Using a local installation of `tailwindcss`
-
-If you are not able to use the vendored standalone executables (for example, if you're on an unsupported platform), you can use a local installation of the `tailwindcss` executable by setting an environment variable named `TAILWINDCSS_INSTALL_DIR` to the directory path containing the executable.
-
-For example, if you've installed `tailwindcss` so that the executable is found at `/path/to/node_modules/bin/tailwindcss`, then you should set your environment variable like so:
-
-``` sh
-TAILWINDCSS_INSTALL_DIR=/path/to/node_modules/bin
-```
-
-or, for relative paths like `./node_modules/.bin/tailwindcss`:
-
-``` sh
-TAILWINDCSS_INSTALL_DIR=node_modules/.bin
-```
+This gem depends on the `tailwindcss-ruby` gem to install a working tailwind executable. You can also use a local (npm-based) installation if you prefer, please go to https://github.com/flavorjones/tailwindcss-ruby for more information.
 
 
 ## Developing with Tailwindcss
@@ -206,41 +179,7 @@ For Tailwind to work, your class names need to be spelled out. If you need to ma
 
 ### `ERROR: Cannot find the tailwindcss executable` for supported platform
 
-Some users are reporting this error even when running on one of the supported native platforms:
-
-- arm64-darwin
-- x64-mingw32
-- x64-mingw-ucrt
-- x86_64-darwin
-- x86_64-linux
-- aarch64-linux
-
-#### Check Bundler PLATFORMS
-
-A possible cause of this is that Bundler has not been told to include native gems for your current platform. Please check your `Gemfile.lock` file to see whether your native platform is included in the `PLATFORMS` section. If necessary, run:
-
-``` sh
-bundle lock --add-platform <platform-name>
-```
-
-and re-bundle.
-
-
-#### Check BUNDLE_FORCE_RUBY_PLATFORM
-
-Another common cause of this is that bundler is configured to always use the "ruby" platform via the
-`BUNDLE_FORCE_RUBY_PLATFORM` config parameter being set to `true`. Please remove this configuration:
-
-``` sh
-bundle config unset force_ruby_platform
-# or
-bundle config set --local force_ruby_platform false
-```
-
-and re-bundle.
-
-See https://bundler.io/man/bundle-config.1.html for more information.
-
+See https://github.com/flavorjones/tailwindcss-ruby for help.
 
 ### Using asset-pipeline assets
 
@@ -280,5 +219,4 @@ Or, if you do want to keep using the asset pipeline in parallel, make sure to re
 ## License
 
 Tailwind for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).
-Tailwind CSS is released under the [MIT License](https://opensource.org/licenses/MIT).
 The Inter font is released under the [SIL Open Font License, Version 1.1](https://github.com/rsms/inter/blob/master/LICENSE.txt).

README.md

@@ -1,7 +1,6 @@
 module Tailwindcss
 end
 
-require_relative "tailwindcss/upstream"
 require_relative "tailwindcss/version"
 require_relative "tailwindcss/engine"
 require_relative "tailwindcss/commands"

exe/tailwindcss

@@ -1,81 +1,11 @@
-require_relative "upstream"
+require "tailwindcss/ruby"
 
 module Tailwindcss
   module Commands
-    DEFAULT_DIR = File.expand_path(File.join(__dir__, "..", "..", "exe"))
-    GEM_NAME = "tailwindcss-rails"
-
-    # raised when the host platform is not supported by upstream tailwindcss's binary releases
-    class UnsupportedPlatformException < StandardError
-    end
-
-    # raised when the tailwindcss executable could not be found where we expected it to be
-    class ExecutableNotFoundException < StandardError
-    end
-
-    # raised when TAILWINDCSS_INSTALL_DIR does not exist
-    class DirectoryNotFoundException < StandardError
-    end
-
     class << self
-      def platform
-        [:cpu, :os].map { |m| Gem::Platform.local.send(m) }.join("-")
-      end
-
-      def executable(exe_path: DEFAULT_DIR)
-        tailwindcss_install_dir = ENV["TAILWINDCSS_INSTALL_DIR"]
-        if tailwindcss_install_dir
-          if File.directory?(tailwindcss_install_dir)
-            warn "NOTE: using TAILWINDCSS_INSTALL_DIR to find tailwindcss executable: #{tailwindcss_install_dir}"
-            exe_path = tailwindcss_install_dir
-            exe_file = File.expand_path(File.join(tailwindcss_install_dir, "tailwindcss"))
-          else
-            raise DirectoryNotFoundException, <<~MESSAGE
-              TAILWINDCSS_INSTALL_DIR is set to #{tailwindcss_install_dir}, but that directory does not exist.
-            MESSAGE
-          end
-        else
-          if Tailwindcss::Upstream::NATIVE_PLATFORMS.keys.none? { |p| Gem::Platform.match_gem?(Gem::Platform.new(p), GEM_NAME) }
-            raise UnsupportedPlatformException, <<~MESSAGE
-              tailwindcss-rails does not support the #{platform} platform
-              Please install tailwindcss following instructions at https://tailwindcss.com/docs/installation
-            MESSAGE
-          end
-
-          exe_file = Dir.glob(File.expand_path(File.join(exe_path, "*", "tailwindcss"))).find do |f|
-            Gem::Platform.match_gem?(Gem::Platform.new(File.basename(File.dirname(f))), GEM_NAME)
-          end
-        end
-
-        if exe_file.nil? || !File.exist?(exe_file)
-          raise ExecutableNotFoundException, <<~MESSAGE
-            Cannot find the tailwindcss executable for #{platform} in #{exe_path}
-
-            If you're using bundler, please make sure you're on the latest bundler version:
-
-                gem install bundler
-                bundle update --bundler
-
-            Then make sure your lock file includes this platform by running:
-
-                bundle lock --add-platform #{platform}
-                bundle install
-
-            See `bundle lock --help` output for details.
-
-            If you're still seeing this message after taking those steps, try running
-            `bundle config` and ensure `force_ruby_platform` isn't set to `true`. See
-            https://github.com/rails/tailwindcss-rails#check-bundle_force_ruby_platform
-            for more details.
-          MESSAGE
-        end
-
-        exe_file
-      end
-
       def compile_command(debug: false, **kwargs)
         command = [
-          executable(**kwargs),
+          Tailwindcss::Ruby.executable(**kwargs),
           "-i", Rails.root.join("app/assets/stylesheets/application.tailwind.css").to_s,
           "-o", Rails.root.join("app/assets/builds/tailwind.css").to_s,
           "-c", Rails.root.join("config/tailwind.config.js").to_s,

lib/tailwindcss-rails.rb

@@ -1,17 +1,6 @@
 module Tailwindcss
-  # constants describing the upstream tailwindcss project
   module Upstream
-    VERSION = "v3.4.13"
-
-    # rubygems platform name => upstream release filename
-    NATIVE_PLATFORMS = {
-      "arm64-darwin" => "tailwindcss-macos-arm64",
-      "x64-mingw32" => "tailwindcss-windows-x64.exe",
-      "x64-mingw-ucrt" => "tailwindcss-windows-x64.exe",
-      "x86_64-darwin" => "tailwindcss-macos-x64",
-      "x86_64-linux" => "tailwindcss-linux-x64",
-      "aarch64-linux" => "tailwindcss-linux-arm64",
-      "arm-linux" => "tailwindcss-linux-armv7",
-    }
+    VERSION = Tailwindcss::Ruby::Upstream::VERSION
+    deprecate_constant :VERSION
   end
 end