tailwindcss-rails 2.0.29 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb9d8f1440e51b0b218998c75371cdecbe507b3c9094d052fa6d5d8145f8a8c6
-  data.tar.gz: 9dd8ce840b9a81501eda3167fc2d730c5d8330b9a38227cc63101fd1e39e1d9d
+  metadata.gz: f14bac83bc6a8df8bba207524b748c4f9a1a7689b012b3495814af1276e51172
+  data.tar.gz: 5714edc137dee618ea34462f1c0033d2bf6cafda8180e0448a6a15aea9ae3ab9
 SHA512:
-  metadata.gz: 006b91990412847a8a4795ae5e74a286c5418c4cb13c18bcdcd5de33891951a62767c699b55f306c3f0dcec72d98b965be008abe5c764160f2066c2a41935504
-  data.tar.gz: 19ddfac65eaebdfe5f206666bad2bcbe836f100a1fc0e22dbc04b7b43910fb287fc44e11c89aade63700dcebe4035ea0dcd18241b7abb6c06fdda4cc1a2c9e8c
+  metadata.gz: 8b8e7c71d76761ca29c57bdcfee4d41c585ce8b8fef60186e251689999a93354b2b9603bb9b3f0c6ec796f2478fbe1fcff172014793772e8f46628976c0b535f
+  data.tar.gz: 1a68c451d9f716e7788ec72d9dc726383d9b9f3bd7a5b261997cf5ef60b75fe75632113f4cb549dbc699e053f24999f49056091ac7709f9890da6024f3495134

data/README.md

@@ -38,7 +38,6 @@ This also works with relative paths. If you've installed into your app's directo
 TAILWINDCSS_INSTALL_DIR=node_modules/.bin
 ```
 
-
 ## Developing with Tailwindcss
 
 ### Configuration
@@ -55,20 +54,31 @@ The `tailwindcss:build` is automatically attached to `assets:precompile`, so bef
 
 ### Building for testing
 
-The `tailwindcss:build` task is automatically attached to the `test:prepare` Rake task. The `test:prepare` task is run before some test tasks (e.g. `test:all` and `test:controllers`), but not before the bare `test` task.
+The `tailwindcss:build` task is automatically attached to the `test:prepare` Rake task. This task runs before test commands. If you run `bin/rails test` in your CI environment, your Tailwind output will be generated before tests run.
 
-If your tests need Tailwind assets in your CI environment, it's best to be explicit and run this command:
 
-```
-bin/rails test:prepare test
+### Update assets automatically
+
+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 in a few different ways:
+
+- use the [Puma](https://puma.io/) plugin to integrate "watch" with `rails server`, or
+- run `rails tailwindcss:watch` as a separate process, or
+- run `bin/dev` which uses [Foreman](https://github.com/ddollar/foreman)
+
+#### Puma plugin
+
+The Puma plugin requires you to add this line to your `puma.rb` configuration:
+
+```ruby
+plugin :tailwindcss if ENV.fetch("RAILS_ENV", "development") == "development"
 ```
 
-### Update assets automatically
+and then running `rails server` will run the Tailwind watch process in the background
 
-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.
+#### Run `rails tailwindcss:watch`
+
+This is a flexible command, which can be run with a few different options.
 
 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`.
 
@@ -77,6 +87,11 @@ If you are running `rails tailwindcss:watch` as a process in a Docker container,
 If you are running `rails tailwindcss:watch` in a docker container without a tty, pass the `always` argument to the task to instruct tailwindcss to keep the watcher alive even when `stdin` is closed: `rails tailwindcss:watch[always]`. If you use `bin/dev` then you should modify your `Procfile.dev`.
 
 
+#### Foreman
+
+Running `bin/dev` invokes Foreman to start both the Tailwind watch process and the rails server in development mode based on your `Procfile.dev` file.
+
+
 ### 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]`.
@@ -84,6 +99,24 @@ If you want unminified assets, you can pass a `debug` argument to the rake task,
 Note that you can combine task options, e.g. `rails tailwindcss:watch[debug,poll]`.
 
 
+### Using with PostCSS
+
+If you want to use PostCSS as a preprocessor, create a custom `config/postcss.config.js` and it will be loaded automatically.
+
+For example, to enable nesting:
+
+```js
+// config/postcss.config.js
+module.exports = {
+  plugins: {
+    'postcss-import': {},
+    'tailwindcss/nesting': {},
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+}
+```
+
 ### 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.
@@ -176,6 +209,12 @@ The inline version also works:
 <section class="bg-[url('image.svg')]">Has the image as it's background</section>
 ```
 
+### Conflict with pre-existing asset pipeline stylesheets
+
+If you get a warning `Unrecognized at-rule or error parsing at-rule ‘@tailwind’.` in the browser console after installation, you incorrectly double-process `application.tailwind.css`. This is a misconfiguration, even though the styles will be fully effective in many cases. The file `application.tailwind.css` is installed when running `rails tailwindcss:install` and is placed alongside the common `application.css` in `app/assets/stylesheets`. Because the `application.css` in a newly generated Rails app includes a `require_tree .` directive, the asset pipeline incorrectly processes `application.tailwind.css`, where it should be taken care of by `tailwindcss`. The asset pipeline ignores TailwindCSS's at-directives, and the browser can't process them.
+
+To fix the warning, you can either remove the `application.css`, if you don't plan to use the asset pipeline for stylesheets, and instead rely on TailwindCSS completely for styles. This is what this installer assumes. Else, if you do want to keep using the asset pipeline in parallel, make sure to remove the `require_tree .` line from the `application.css`.
+
 ## License
 
 Tailwind for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/tailwindcss/controller/controller_generator.rb

@@ -3,7 +3,8 @@ require "rails/generators/erb/controller/controller_generator"
 module Tailwindcss
   module Generators
     class ControllerGenerator < Erb::Generators::ControllerGenerator
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
+      source_paths << "lib/templates/erb/controller"
     end
   end
 end

data/lib/generators/tailwindcss/mailer/mailer_generator.rb

@@ -3,7 +3,8 @@ require "rails/generators/erb/mailer/mailer_generator"
 module Tailwindcss
   module Generators
     class MailerGenerator < Erb::Generators::MailerGenerator
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
+      source_paths << "lib/templates/erb/mailer"
     end
   end
 end

data/lib/generators/tailwindcss/mailer/templates/layout.html.erb.tt

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%%= yield %>
+  </body>
+</html>

data/lib/generators/tailwindcss/mailer/templates/layout.text.erb.tt

@@ -0,0 +1 @@
+<%%= yield %>

data/lib/generators/tailwindcss/scaffold/scaffold_generator.rb

@@ -1,4 +1,4 @@
-require 'rails/generators/erb/scaffold/scaffold_generator'
+require "rails/generators/erb/scaffold/scaffold_generator"
 require "rails/generators/resource_helpers"
 
 module Tailwindcss
@@ -6,7 +6,8 @@ module Tailwindcss
     class ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
       include Rails::Generators::ResourceHelpers
 
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
+      source_paths << "lib/templates/erb/scaffold"
 
       argument :attributes, type: :array, default: [], banner: "field:type field:type"
 

data/lib/generators/tailwindcss/scaffold/templates/_form.html.erb.tt

@@ -15,7 +15,7 @@
   <div class="my-5">
 <% if attribute.password_digest? -%>
     <%%= form.label :password %>
-    <%%= form.password_field :password %>
+    <%%= form.password_field :password, class: "block shadow rounded-md border border-gray-200 outline-none px-3 py-2 mt-2 w-full" %>
 </div>
 
 <div class="my-5">

data/lib/generators/tailwindcss/scaffold/templates/index.html.erb.tt

@@ -5,7 +5,7 @@
 
   <div class="flex justify-between items-center">
     <h1 class="font-bold text-4xl"><%= human_name.pluralize %></h1>
-    <%%= link_to 'New <%= human_name.downcase %>', new_<%= singular_route_name %>_path, class: "rounded-lg py-3 px-5 bg-blue-600 text-white block font-medium" %>
+    <%%= link_to "New <%= human_name.downcase %>", new_<%= singular_route_name %>_path, class: "rounded-lg py-3 px-5 bg-blue-600 text-white block font-medium" %>
   </div>
 
   <div id="<%= plural_table_name %>" class="min-w-full">

data/lib/generators/tailwindcss/scaffold/templates/new.html.erb.tt

@@ -3,5 +3,5 @@
 
   <%%= render "form", <%= singular_table_name %>: @<%= singular_table_name %> %>
 
-  <%%= link_to 'Back to <%= human_name.pluralize.downcase %>', <%= index_helper %>_path, class: "ml-2 rounded-lg py-3 px-5 bg-gray-100 inline-block font-medium" %>
+  <%%= link_to "Back to <%= human_name.pluralize.downcase %>", <%= index_helper %>_path, class: "ml-2 rounded-lg py-3 px-5 bg-gray-100 inline-block font-medium" %>
 </div>

data/lib/generators/tailwindcss/scaffold/templates/partial.html.erb.tt

@@ -16,7 +16,7 @@
 <% end -%>
   <%% if action_name != "show" %>
     <%%= link_to "Show this <%= human_name.downcase %>", <%= singular_name %>, class: "rounded-lg py-3 px-5 bg-gray-100 inline-block font-medium" %>
-    <%%= link_to 'Edit this <%= human_name.downcase %>', edit_<%= singular_name %>_path(<%= singular_name %>), class: "rounded-lg py-3 ml-2 px-5 bg-gray-100 inline-block font-medium" %>
+    <%%= link_to "Edit this <%= human_name.downcase %>", edit_<%= singular_name %>_path(<%= singular_name %>), class: "rounded-lg py-3 ml-2 px-5 bg-gray-100 inline-block font-medium" %>
     <hr class="mt-6">
   <%% end %>
 </div>

data/lib/generators/tailwindcss/scaffold/templates/show.html.erb.tt

@@ -6,10 +6,10 @@
 
     <%%= 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" %>
+    <%%= 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" %>
     <div class="inline-block ml-2">
-      <%%= 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" %>
+      <%%= 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" %>
     </div>
-    <%%= 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" %>
+    <%%= 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" %>
   </div>
 </div>

data/lib/install/Procfile.dev

@@ -1,2 +1,2 @@
-web: bin/rails server -p 3000
+web: bin/rails server
 css: bin/rails tailwindcss:watch

data/lib/install/dev

@@ -5,4 +5,12 @@ if ! gem list foreman -i --silent; then
   gem install foreman
 fi
 
+# 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 "$@"

data/lib/puma/plugin/tailwindcss.rb

@@ -0,0 +1,63 @@
+require "puma/plugin"
+
+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 }
+      system(*Tailwindcss::Commands.watch_command)
+    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

data/lib/tailwindcss/commands.rb

@@ -3,6 +3,7 @@ require_relative "upstream"
 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
@@ -34,7 +35,7 @@ module Tailwindcss
             MESSAGE
           end
         else
-          if Tailwindcss::Upstream::NATIVE_PLATFORMS.keys.none? { |p| Gem::Platform.match(Gem::Platform.new(p)) }
+          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
@@ -42,7 +43,7 @@ module Tailwindcss
           end
 
           exe_file = Dir.glob(File.expand_path(File.join(exe_path, "*", "tailwindcss"))).find do |f|
-            Gem::Platform.match(Gem::Platform.new(File.basename(File.dirname(f))))
+            Gem::Platform.match_gem?(Gem::Platform.new(File.basename(File.dirname(f))), GEM_NAME)
           end
         end
 
@@ -73,14 +74,19 @@ module Tailwindcss
       end
 
       def compile_command(debug: false, **kwargs)
-        [
+        command = [
           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 || rails_css_compressor?)
-        end
+        ]
+
+        command << "--minify" unless (debug || rails_css_compressor?)
+
+        postcss_path = Rails.root.join("config/postcss.config.js")
+        command += ["--postcss", postcss_path.to_s] if File.exist?(postcss_path)
+
+        command
       end
 
       def watch_command(always: false, poll: false, **kwargs)

data/lib/tailwindcss/upstream.rb

@@ -1,7 +1,7 @@
 module Tailwindcss
   # constants describing the upstream tailwindcss project
   module Upstream
-    VERSION = "v3.3.2"
+    VERSION = "v3.4.1"
 
     # rubygems platform name => upstream release filename
     NATIVE_PLATFORMS = {

data/lib/tailwindcss/version.rb

@@ -1,3 +1,3 @@
 module Tailwindcss
-  VERSION = "2.0.29"
+  VERSION = "2.3.0"
 end

data/lib/tasks/build.rake

@@ -22,6 +22,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tailwindcss-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.29
+  version: 2.3.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -56,6 +56,8 @@ files:
 - lib/generators/tailwindcss/controller/controller_generator.rb
 - lib/generators/tailwindcss/controller/templates/view.html.erb.tt
 - lib/generators/tailwindcss/mailer/mailer_generator.rb
+- lib/generators/tailwindcss/mailer/templates/layout.html.erb.tt
+- lib/generators/tailwindcss/mailer/templates/layout.text.erb.tt
 - lib/generators/tailwindcss/mailer/templates/view.html.erb.tt
 - lib/generators/tailwindcss/mailer/templates/view.text.erb.tt
 - lib/generators/tailwindcss/scaffold/scaffold_generator.rb
@@ -70,6 +72,7 @@ files:
 - lib/install/dev
 - lib/install/tailwind.config.js
 - lib/install/tailwindcss.rb
+- lib/puma/plugin/tailwindcss.rb
 - lib/tailwindcss-rails.rb
 - lib/tailwindcss/commands.rb
 - lib/tailwindcss/engine.rb
@@ -97,9 +100,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Integrate Tailwind CSS with the asset pipeline in Rails.