tailwindcss-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1163e758264ac53f96714d98fc94a2bea5fd6d271750e18387e0aeab94c11e1
+  data.tar.gz: a0dc1753bbe2302d2c43d5856c49178a1fa717fed6ff20825a6da43b1c3db8f3
+SHA512:
+  metadata.gz: 73a2a8ac0954d8dd882cd5b341a59d1d904404b227f889907817a5b6268a27b5bf404a690fda7d270b1b04ed97eb4d00bb898d3662f27a87711c7b36bccde17c
+  data.tar.gz: e012f02964ab2aababaf643dabf8a3f25383c9ca364db91c3218c9cd5d5add8b8d10c6d66e7f831ad0e7c71c4f6ae0b22beb2e2597688f517c8eeeb12ee42d15

data/README.md

@@ -0,0 +1,159 @@
+# Tailwindcss::Ruby
+
+A self-contained `tailwindcss` executable, wrapped up in a ruby gem. That's it. Nothing else.
+
+If you're looking to leverage tailwindcss in your Rails project, please see https://github.com/rails/tailwindcss-rails for integration that is supported by the Rails team.
+
+
+## Installation
+
+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)
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add tailwindcss-ruby
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install tailwindcss-ruby
+```
+
+### 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
+```
+
+
+## Versioning
+
+This gem will always have the same version number as the underlying TailwindCSS release. For example, the gem with version v3.4.13 will package upstream TailwindCSS v3.4.13.
+
+If there ever needs to be multiple releases for the same version of TailwindCSS, the version will contain an additional digit. For example, if we re-released TailwindCSS v3.4.13, it might be shipped in gem version v3.4.13.1 or v3.4.13.2.
+
+
+## Usage
+
+### Ruby
+
+The gem makes available `Tailwindcss::Ruby.executable` which is the path to the vendored standalone executable.
+
+``` ruby
+require "tailwindcss/ruby"
+Tailwindcss::Ruby.executable
+# => "/path/to/installs/ruby/3.3.5/lib/ruby/gems/3.3.0/gems/tailwindcss-ruby-0.1.0-x86_64-linux/exe/x86_64-linux/tailwindcss"
+```
+
+
+### Command line
+
+This gem provides an executable `tailwindcss` shim that will run the vendored standalone executable.
+
+``` bash
+# where is the shim?
+$ bundle exec which tailwindcss
+/path/to/installs/ruby/3.3/bin/tailwindcss
+
+# run the actual executable through the shim
+$ bundle exec tailwindcss --help
+["/path/to/installs/ruby/3.3.5/lib/ruby/gems/3.3.0/gems/tailwindcss-rails-2.6.0-x86_64-linux/exe/x86_64-linux/tailwindcss", "--help"]
+
+tailwindcss v3.4.3
+
+Usage:
+   tailwindcss [--input input.css] [--output output.css] [--watch] [options...]
+   tailwindcss init [--full] [--postcss] [options...]
+
+Commands:
+   init [options]
+
+Options:
+   -i, --input              Input file
+   -o, --output             Output file
+   -w, --watch              Watch for changes and rebuild as needed
+   -p, --poll               Use polling instead of filesystem events when watching
+       --content            Content paths to use for removing unused classes
+       --postcss            Load custom PostCSS configuration
+   -m, --minify             Minify the output
+   -c, --config             Path to a custom config file
+       --no-autoprefixer    Disable autoprefixer
+   -h, --help               Display usage information
+```
+
+
+## Troubleshooting
+
+### `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.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/flavorjones/tailwindcss-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/flavorjones/tailwindcss-ruby/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+Tailwind CSS is [released under the MIT License](https://github.com/tailwindlabs/tailwindcss/blob/next/LICENSE).
+
+## Code of Conduct
+
+Everyone interacting in the Tailwindcss::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/flavorjones/tailwindcss-ruby/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/exe/tailwindcss

@@ -0,0 +1,19 @@
+#! /usr/bin/env ruby
+# because rubygems shims assume a gem's executables are Ruby
+
+require "tailwindcss/commands"
+
+begin
+  command = [Tailwindcss::Ruby.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::Ruby::UnsupportedPlatformException, Tailwindcss::Ruby::ExecutableNotFoundException => e
+  STDERR.puts("ERROR: " + e.message)
+  exit 1
+end

data/lib/tailwindcss/ruby/upstream.rb

@@ -0,0 +1,18 @@
+module Tailwindcss
+  module Ruby
+    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",
+      }
+    end
+  end
+end

data/lib/tailwindcss/ruby/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Tailwindcss
+  module Ruby
+    VERSION = "0.1.0"
+  end
+end

data/lib/tailwindcss/ruby.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative "ruby/version"
+require_relative "ruby/upstream"
+
+module Tailwindcss
+  module Ruby
+    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::Ruby::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
+    end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: tailwindcss-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Dalessio
+- David Heinemeier Hansson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-25 00:00:00.000000000 Z
+dependencies: []
+description: A self-contained `tailwindcss` executable, wrapped up in a ruby gem.
+  That's it. Nothing else.
+email:
+- mike.dalessio@gmail.com
+- david@loudthinking.com
+executables:
+- tailwindcss
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- exe/tailwindcss
+- lib/tailwindcss/ruby.rb
+- lib/tailwindcss/ruby/upstream.rb
+- lib/tailwindcss/ruby/version.rb
+homepage: https://github.com/flavorjones/tailwindcss-ruby
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/flavorjones/tailwindcss-ruby
+  changelog_uri: https://github.com/flavorjones/tailwindcss-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A self-contained `tailwindcss` executable.
+test_files: []