tailwindcss-rails 2.0.8 → 2.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455499b0b7fa6964424684bd84fddabb55a4a108b771e8d313426b8eed4206b1
-  data.tar.gz: ddc6b66aa707db1b31179253d5916bd76b9404b545f6078642b03c1f8b97ed80
+  metadata.gz: 0d154c6d0679b9cbb20eb9d720cdf83f121ddbe841b0c278bcd6800b5e800610
+  data.tar.gz: 1364721dab0dac09481e2d07f81dbc8479bd07d676b5f249bca37477e9a25586
 SHA512:
-  metadata.gz: ae4eb4c8a4ab5081c92c7eb45865a8613a19c9510de0d95a3bfd6f4f2bfc7b20cf0ef9878b422687615aef6d9ddb7c3661f833308a0ff8b5d6753c494f5cf1d8
-  data.tar.gz: 0bfa67897290033712bb6c593f24c1d48d89a94708c897231e16a089ddb24e01e61a69693fdebcc2c6c3cd42f4c818111ede930643f4dbc819f48106cabffd87
+  metadata.gz: 91d844b8de7ca2d6b216b88cec302fd2092a7b908fd69a2c9f4f313c611c50ec44562bf0826d1118366a12061be90c34927459e8a972387088dd3502cd36a385
+  data.tar.gz: afa67781c4448af64cab2b6d428b3830c9622ede98d925523dedb612a9b8ec192a56abd62791730efa2c33755d394b9336cece627e4893910a33b3afd5c53cbd

data/README.md

@@ -2,51 +2,78 @@
 
 [Tailwind CSS](https://tailwindcss.com) is a utility-first CSS framework packed with classes like flex, pt-4, text-center and rotate-90 that can be composed to build any design, directly in your markup.
 
-This gem wraps [the standalone executable version](https://tailwindcss.com/blog/standalone-cli) of the Tailwind CSS 3 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 Linux x64, macOS arm64, macOS x64, and Windows x64. (Note that due to this setup, you must install the actual gems – you can't pin your gem to the github repo.)
+## Installation
 
-You can customize the Tailwind build through the `config/tailwind.config.js` file, just like you would if Tailwind was running in a traditional node installation. All the first-party plugins are supported.
+With Rails 7 you can generate a new application preconfigured with Tailwind by using `--css tailwind`. If you're adding Tailwind later, you need to:
 
-The installer will create your Tailwind input file in `app/assets/stylesheets/application.tailwind.css`. This is where you import the plugins you want to use, and where you can setup your custom `@apply` rules. When you run `rails tailwindcss:build`, this input file will be used to generate the output in `app/assets/builds/tailwind.css`. That's the output CSS that you'll include in your app (the installer automatically configures this, alongside the Inter font as well).
+1. Run `./bin/bundle add tailwindcss-rails`
+2. Run `./bin/rails tailwindcss:install`
 
-If you need to use a custom input or output file, you can run `bundle exec tailwindcss` to access the platform-specific executable, and give it your own build options.
+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 Linux x64, macOS arm64, macOS x64, and Windows x64. (Note that due to this setup, you must install the actual gems – you can't pin your gem to the github repo.)
 
-When you're developing your application, you want to run Tailwind in watch mode, so changes are automatically reflected in the generated CSS output. You can do this either by running `rails tailwindcss:watch` as a separate process, or by running `./bin/dev` which uses [foreman](https://github.com/ddollar/foreman) to starts both the Tailwind watch process and the rails server in development mode.
 
+## Developing with Tailwindcss
 
-## Installation
+### Configuration
 
-With Rails 7 you can generate a new application preconfigured with Tailwind by using `--css tailwind`. If you're adding Tailwind later, you need to:
+You can customize the Tailwind build through the `config/tailwind.config.js` file, just like you would if Tailwind was running in a traditional node installation. All the first-party plugins are supported.
 
-1. Run `./bin/bundle add tailwindcss-rails`
-2. Run `./bin/rails tailwindcss:install`
+The installer will create your Tailwind input file in `app/assets/stylesheets/application.tailwind.css`. This is where you import the plugins you want to use, and where you can setup your custom `@apply` rules. When you run `rails tailwindcss:build`, this input file will be used to generate the output in `app/assets/builds/tailwind.css`. That's the output CSS that you'll include in your app (the installer automatically configures this, alongside the Inter font as well).
 
 
-## Building in production
+### Building for production
 
 The `tailwindcss:build` is automatically attached to `assets:precompile`, so before the asset pipeline digests the files, the Tailwind output will be generated.
 
-## Building for testing
+
+### Building for testing
 
 The `tailwindcss:build` is automatically attached to `test:prepare`, which runs before Rails tests. (Note that this currently only applies to rails `test:*` tasks (like `test:all` or `test:controllers`), not "rails test", as that doesn't load `test:prepare`).
 
-## Conflict with sassc-rails
 
-Tailwind uses modern CSS features that are not recognized by the `sassc-rails` extension that was included by default in the Gemfile for Rails 6. In order to avoid any errors like `SassC::SyntaxError`, you must remove that gem from your Gemfile.
+### Update assets automatically
 
-## Class names must be spelled out
+While you're developing your application, you want to run Tailwind in "watch" mode, so changes are automatically reflected in the generated CSS output. You can do this by:
+
+- running `rails tailwindcss:watch` as a separate process,
+- or by running `./bin/dev` which uses [foreman](https://github.com/ddollar/foreman) to start both the Tailwind watch process and the rails server in development mode.
+
+If you are running `rails tailwindcss:watch` as a process in a Docker container, set `tty: true` in `docker-compose.yml` for the appropriate container to keep the watch process running.
+
+If you are running `rails tailwindcss:watch` on a system that doesn't fully support file system events, pass a `poll` argument to the task to instruct tailwindcss to instead use polling: `rails tailwindcss:watch[poll]`. If you use `bin/dev` then you should modify your `Procfile.dev`.
+
+
+### Debugging with unminified assets
+
+If you want unminified assets, you can pass a `debug` argument to the rake task, i.e. `rails tailwindcss:build[debug]` or `rails tailwindcss:watch[debug]`.
+
+Note that you can combine task options, e.g. `rails tailwindcss:watch[debug,poll]`.
+
+
+### Custom inputs or outputs
+
+If you need to use a custom input or output file, you can run `bundle exec tailwindcss` to access the platform-specific executable, and give it your own build options.
 
-For Tailwind to work, your class names need to be spelled out. They can't be programmatically composed. So no "text-gray-#{grade}", only "text-gray-500".
 
 ## Troubleshooting
 
 Some common problems experienced by users ...
 
+### Conflict with sassc-rails
+
+Tailwind uses modern CSS features that are not recognized by the `sassc-rails` extension that was included by default in the Gemfile for Rails 6. In order to avoid any errors like `SassC::SyntaxError`, you must remove that gem from your Gemfile.
+
+### Class names must be spelled out
+
+For Tailwind to work, your class names need to be spelled out. They can't be programmatically composed. So no "text-gray-#{grade}", only "text-gray-500".
+
 ### 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

data/exe/tailwindcss

@@ -1,46 +1,19 @@
 #! /usr/bin/env ruby
 # because rubygems shims assume a gem's executables are Ruby
 
-require "shellwords"
-require "tailwindcss/upstream"
-
-supported_platforms = Tailwindcss::Upstream::NATIVE_PLATFORMS.keys
-platform = [:cpu, :os].map { |m| Gem::Platform.local.send(m) }.join("-")
-
-if supported_platforms.none? { |supported_platform| Gem::Platform.match(supported_platform) }
-  STDERR.puts(<<~ERRMSG)
-    ERROR: tailwindcss-rails does not support the #{platform} platform
-    Please install tailwindcss following instructions at https://tailwindcss.com/docs/installation
-  ERRMSG
+require "tailwindcss/commands"
+
+begin
+  command = [Tailwindcss::Commands.executable, *ARGV]
+  puts command.inspect
+  if Gem.win_platform?
+    # use system rather than exec as exec inexplicably fails to find the executable on Windows
+    # see related https://github.com/rubys/sprockets-esbuild/pull/4
+    system(*command, exception: true)
+  else
+    exec(*command)
+  end
+rescue Tailwindcss::Commands::UnsupportedPlatformException, Tailwindcss::Commands::ExecutableNotFoundException => e
+  STDERR.puts("ERROR: " + e.message)
   exit 1
 end
-
-exe_path = Dir.glob(File.join(__dir__, "*", "tailwindcss")).find do |f|
-  Gem::Platform.match(File.basename(File.dirname(f)))
-end
-if exe_path.nil?
-  STDERR.puts(<<~ERRMSG)
-    ERROR: Cannot find the tailwindcss executable for #{platform} in #{__dir__}
-    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.
-  ERRMSG
-  exit 1
-end
-
-command = Shellwords.join([exe_path, ARGV].flatten)
-puts "+ #{command}"
-exec(command)

data/lib/install/tailwind.config.js

@@ -2,6 +2,7 @@ const defaultTheme = require('tailwindcss/defaultTheme')
 
 module.exports = {
   content: [
+    './public/*.html',
     './app/helpers/**/*.rb',
     './app/javascript/**/*.js',
     './app/views/**/*.{erb,haml,html,slim}'

data/lib/tailwindcss/commands.rb

@@ -0,0 +1,77 @@
+require_relative "upstream"
+
+module Tailwindcss
+  module Commands
+    # 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
+
+    class << self
+      def platform
+        [:cpu, :os].map { |m| Gem::Platform.local.send(m) }.join("-")
+      end
+
+      def executable(
+        exe_path: File.expand_path(File.join(__dir__, "..", "..", "exe"))
+      )
+        if Tailwindcss::Upstream::NATIVE_PLATFORMS.keys.none? { |p| Gem::Platform.match(p) }
+          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_path = Dir.glob(File.expand_path(File.join(exe_path, "*", "tailwindcss"))).find do |f|
+          Gem::Platform.match(File.basename(File.dirname(f)))
+        end
+
+        if exe_path.nil?
+          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_path
+      end
+
+      def compile_command(debug: false, **kwargs)
+        [
+          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,
+        ].tap do |command|
+          command << "--minify" unless debug
+        end
+      end
+
+      def watch_command(poll: false, **kwargs)
+        compile_command(**kwargs).tap do |command|
+          command << "-w"
+          command << "-p" if poll
+        end
+      end
+    end
+  end
+end

data/lib/tailwindcss/upstream.rb

@@ -1,12 +1,13 @@
 module Tailwindcss
   # constants describing the upstream tailwindcss project
   module Upstream
-    VERSION = "v3.0.23"
+    VERSION = "v3.1.8"
 
     # 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",

data/lib/tailwindcss/version.rb

@@ -1,3 +1,3 @@
 module Tailwindcss
-  VERSION = "2.0.8"
+  VERSION = "2.0.13"
 end

data/lib/tailwindcss-rails.rb

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

data/lib/tasks/build.rake

@@ -1,14 +1,19 @@
-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 do |_, args|
+    debug = args.extras.include?("debug")
+    command = Tailwindcss::Commands.compile_command(debug: debug)
+    puts command.inspect
+    system(*command, exception: true)
   end
 
   desc "Watch and build your Tailwind CSS on file changes"
-  task :watch do
-    system "#{TAILWIND_COMPILE_COMMAND} -w"
+  task :watch do |_, args|
+    debug = args.extras.include?("debug")
+    poll = args.extras.include?("poll")
+    command = Tailwindcss::Commands.watch_command(debug: debug, poll: poll)
+    puts command.inspect
+    system(*command)
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tailwindcss-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.0.13
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -70,6 +70,7 @@ files:
 - lib/install/tailwind.config.js
 - lib/install/tailwindcss.rb
 - lib/tailwindcss-rails.rb
+- lib/tailwindcss/commands.rb
 - lib/tailwindcss/engine.rb
 - lib/tailwindcss/upstream.rb
 - lib/tailwindcss/version.rb
@@ -97,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Integrate Tailwind CSS with the asset pipeline in Rails.