cssbundling-rails 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45868eda1ae67158b652d75c9ad8d89bc55bf67ac62e0539b8a30b91122d0186
-  data.tar.gz: d6b0d91eaf919c44628aa7c9edbdf3a56d3d34e0ace6651dd42aca2091acb30e
+  metadata.gz: 80c2c969114694a1020f70a4f5025ddaaddd9814c802646e768631942a1adbdf
+  data.tar.gz: d5a828cf779270bf0f05257fcc2e9ee33fbbae7b23e5f668bcad26779a0131f0
 SHA512:
-  metadata.gz: 517e8067a0fabc88db726ca0d89c4ec488a3815aef2c6c5cf5e4df254c2706ed6826693610062e4fe0385b3d42688217f46de5005bd8b631b8ba8e8f10720346
-  data.tar.gz: f81ead37fb5b36fbf09a1d8751ae67fbeb3e28d82baa80d177cd0779d8c3bc36ed62b686021ce3fba5cb817f1c431d585346a6e067502e33e3483b283b501b80
+  metadata.gz: a42545bdef51ea41c6c386067a643a84c862fe996b0f1d519891ada561db3ad067796a66172ee628bcfc993540644529dfda0c6b938410a121d727c04e111ada
+  data.tar.gz: 1ed4b170f44f51e8db2d04e7d963702bacef1eab17099eac42a9df6166f1aa4ad480b60caa11437973e219ab1c35c3a6292eb08252db42ccf26c88ddc08ac4bb

data/README.md

@@ -8,9 +8,7 @@ Whenever the bundler detects changes to any of the stylesheet files in your proj
 
 When you deploy your application to production, the `css:build` task attaches to the `assets:precompile` task to ensure that all your package dependencies from `package.json` have been installed via yarn, and then runs `yarn build:css` to process your stylesheet entrypoint, as it would in development. This output is then picked up by the asset pipeline, digested, and copied into public/assets, as any other asset pipeline file.
 
-This also happens in testing where the bundler attaches to the `test:prepare` task to ensure the stylesheets have been bundled before testing commences. (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`).
-
-If your test framework does not define a `test:prepare` Rake task, ensure that your test framework runs `css:build` to bundle stylesheets before testing commences. If your setup uses [jsbundling-rails](https://github.com/rails/jsbundling-rails) (ie, esbuild + tailwind), you will also need to run `javascript:build`.
+This also happens in testing where the bundler attaches to the `test:prepare` task to ensure the stylesheets have been bundled before testing commences. If your test framework does not call the `test:prepare` Rake task, ensure that your test framework runs `css:build` to bundle stylesheets before testing commences. If your setup uses [jsbundling-rails](https://github.com/rails/jsbundling-rails) (ie, esbuild + tailwind), you will also need to run `javascript:build`.
 
 That's it!
 
@@ -45,6 +43,14 @@ Some CSS packages use new CSS features that are not supported by the default Sas
 
 A common issue is that your repository does not contain the output directory used by the build commands. You must have `app/assets/builds` available. Add the directory with a `.gitkeep` file, and you'll ensure it's available in production.
 
+### Why isn't Rails using my updated css files?
+
+Watch out - if you precompile your files locally, those will be served over the dynamically created ones you expect. The solution:
+
+```shell
+rails assets:clobber 
+```
+
 ## License
 
 CSS Bundling for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/cssbundling/version.rb

@@ -1,3 +1,3 @@
 module Cssbundling
-  VERSION = "1.1.2"
+  VERSION = "1.3.0"
 end

data/lib/install/Procfile_for_bun.dev

@@ -0,0 +1,2 @@
+web: env RUBY_DEBUG_OPEN=true bin/rails server
+css: bun run build:css --watch

data/lib/install/Procfile_for_node.dev

@@ -0,0 +1,2 @@
+web: env RUBY_DEBUG_OPEN=true bin/rails server
+css: yarn build:css --watch

data/lib/install/bootstrap/install.rb

@@ -1,7 +1,10 @@
-say "Install Bootstrap with Bootstrap Icons and Popperjs/core"
+require_relative "../helpers"
+self.extend Helpers
+
+say "Install Bootstrap with Bootstrap Icons, Popperjs/core and Autoprefixer"
 copy_file "#{__dir__}/application.bootstrap.scss",
    "app/assets/stylesheets/application.bootstrap.scss"
-run "yarn add sass bootstrap bootstrap-icons @popperjs/core"
+run "#{bundler_cmd} add sass bootstrap bootstrap-icons @popperjs/core postcss postcss-cli autoprefixer nodemon"
 
 inject_into_file "config/initializers/assets.rb", after: /.*Rails.application.config.assets.paths.*\n/ do
   <<~RUBY
@@ -16,16 +19,14 @@ else
   say %(Add import * as bootstrap from "bootstrap" to your entry point JavaScript file), :red
 end
 
-say "Add build:css script"
-build_script = "sass ./app/assets/stylesheets/application.bootstrap.scss:./app/assets/builds/application.css --no-source-map --load-path=node_modules"
+add_package_json_script("build:css:compile", "sass ./app/assets/stylesheets/application.bootstrap.scss:./app/assets/builds/application.css --no-source-map --load-path=node_modules")
+add_package_json_script("build:css:prefix", "postcss ./app/assets/builds/application.css --use=autoprefixer --output=./app/assets/builds/application.css")
+add_package_json_script("build:css", "#{bundler_run_cmd} build:css:compile && #{bundler_run_cmd} build:css:prefix")
+add_package_json_script("watch:css", "nodemon --watch ./app/assets/stylesheets/ --ext scss --exec \"#{bundler_run_cmd} build:css\"", false)
 
-case `npx -v`.to_f
-when 7.1...8.0
-  run %(npm set-script build:css "#{build_script}")
-  run %(yarn build:css)
-when (8.0..)
-  run %(npm pkg set scripts.build:css="#{build_script}")
-  run %(yarn build:css)
-else
-  say %(Add "scripts": { "build:css": "#{build_script}" } to your package.json), :green
-end
+gsub_file "Procfile.dev", "build:css --watch", "watch:css"
+
+package_json = JSON.parse(File.read("package.json"))
+package_json["browserslist"] ||= {}
+package_json["browserslist"] = ["defaults"]
+File.write("package.json", JSON.pretty_generate(package_json))

data/lib/install/bulma/install.rb

@@ -1,18 +1,11 @@
+require_relative "../helpers"
+self.extend Helpers
+
 say "Install Bulma"
 copy_file "#{__dir__}/application.bulma.scss",
    "app/assets/stylesheets/application.bulma.scss"
-run "yarn add sass bulma"
+run "#{bundler_cmd} add sass bulma"
 
 say "Add build:css script"
-build_script = "sass ./app/assets/stylesheets/application.bulma.scss:./app/assets/builds/application.css --no-source-map --load-path=node_modules"
-
-case `npx -v`.to_f
-when 7.1...8.0
-  run %(npm set-script build:css "#{build_script}")
-  run %(yarn build:css)
-when (8.0..)
-  run %(npm pkg set scripts.build:css="#{build_script}")
-  run %(yarn build:css)
-else
-  say %(Add "scripts": { "build:css": "#{build_script}" } to your package.json), :green
-end
+add_package_json_script "build:css",
+  "sass ./app/assets/stylesheets/application.bulma.scss:./app/assets/builds/application.css --no-source-map --load-path=node_modules"

data/lib/install/dev

@@ -5,4 +5,7 @@ if ! gem list foreman -i --silent; then
   gem install foreman
 fi
 
+# Default to port 3000 if not specified
+export PORT="${PORT:-3000}"
+
 exec foreman start -f Procfile.dev "$@"

data/lib/install/helpers.rb

@@ -0,0 +1,42 @@
+require 'json'
+
+module Helpers
+  def bundler_cmd
+    using_bun? ? "bun" : "yarn"
+  end
+
+  def bundler_run_cmd
+    using_bun? ? "bun run" : "yarn"
+  end
+
+  def using_bun?
+    File.exist?('bun.lockb') || (tool_exists?('bun') && !File.exist?('yarn.lock'))
+  end
+
+  def tool_exists?(tool)
+    system "command -v #{tool} > /dev/null"
+  end
+
+  def add_package_json_script(name, script, run_script=true)
+    if using_bun?
+      package_json = JSON.parse(File.read("package.json"))
+      package_json["scripts"] ||= {}
+      package_json["scripts"][name] = script
+      File.write("package.json", JSON.pretty_generate(package_json))
+      run %(bun run #{name}) if run_script
+    else
+      case `npx -v`.to_f
+      when 7.1...8.0
+        say "Add #{name} script"
+        run %(npm set-script #{name} "#{script}")
+        run %(yarn #{name}) if run_script
+      when (8.0..)
+        say "Add #{name} script"
+        run %(npm pkg set scripts.#{name}="#{script}")
+        run %(yarn #{name}) if run_script
+      else
+        say %(Add "scripts": { "#{name}": "#{script}" } to your package.json), :green
+      end
+    end
+  end
+end

data/lib/install/install.rb

@@ -1,3 +1,6 @@
+require_relative "helpers"
+self.extend Helpers
+
 say "Build into app/assets/builds"
 empty_directory "app/assets/builds"
 keep_file "app/assets/builds"
@@ -41,10 +44,10 @@ unless Rails.root.join("package.json").exist?
 end
 
 if Rails.root.join("Procfile.dev").exist?
-  append_to_file "Procfile.dev", "css: yarn build:css --watch\n"
+  append_to_file "Procfile.dev", "css: #{bundler_run_cmd} build:css --watch\n"
 else
   say "Add default Procfile.dev"
-  copy_file "#{__dir__}/Procfile.dev", "Procfile.dev"
+  copy_file "#{__dir__}/#{using_bun? ? "Procfile_for_bun" : "Procfile_for_node"}", "Procfile.dev"
 
   say "Ensure foreman is installed"
   run "gem install foreman"

data/lib/install/postcss/install.rb

@@ -1,18 +1,11 @@
+require_relative "../helpers"
+self.extend Helpers
+
 say "Install PostCSS w/ nesting and autoprefixer"
 copy_file "#{__dir__}/postcss.config.js", "postcss.config.js"
 copy_file "#{__dir__}/application.postcss.css", "app/assets/stylesheets/application.postcss.css"
-run "yarn add postcss postcss-cli postcss-nesting autoprefixer"
+run "#{bundler_cmd} add postcss postcss-cli postcss-import postcss-nesting autoprefixer"
 
 say "Add build:css script"
-build_script = "postcss ./app/assets/stylesheets/application.postcss.css -o ./app/assets/builds/application.css"
-
-case `npx -v`.to_f
-when 7.1...8.0
-  run %(npm set-script build:css "#{build_script}")
-  run %(yarn build:css)
-when (8.0..)
-  run %(npm pkg set scripts.build:css="#{build_script}")
-  run %(yarn build:css)
-else
-  say %(Add "scripts": { "build:css": "#{build_script}" } to your package.json), :green
-end
+add_package_json_script "build:css",
+  "postcss ./app/assets/stylesheets/application.postcss.css -o ./app/assets/builds/application.css"

data/lib/install/postcss/postcss.config.js

@@ -1,5 +1,6 @@
 module.exports = {
   plugins: [
+    require('postcss-import'),
     require('postcss-nesting'),
     require('autoprefixer'),
   ],

data/lib/install/sass/install.rb

@@ -1,17 +1,10 @@
+require_relative "../helpers"
+self.extend Helpers
+
 say "Install Sass"
 copy_file "#{__dir__}/application.sass.scss", "app/assets/stylesheets/application.sass.scss"
-run "yarn add sass"
+run "#{bundler_cmd} add sass"
 
 say "Add build:css script"
-build_script = "sass ./app/assets/stylesheets/application.sass.scss:./app/assets/builds/application.css --no-source-map --load-path=node_modules"
-
-case `npx -v`.to_f
-when 7.1...8.0
-  run %(npm set-script build:css "#{build_script}")
-  run %(yarn build:css)
-when (8.0..)
-  run %(npm pkg set scripts.build:css="#{build_script}")
-  run %(yarn build:css)
-else
-  say %(Add "scripts": { "build:css": "#{build_script}" } to your package.json), :green
-end
+add_package_json_script "build:css",
+  "sass ./app/assets/stylesheets/application.sass.scss:./app/assets/builds/application.css --no-source-map --load-path=node_modules"

data/lib/install/tailwind/install.rb

@@ -1,18 +1,11 @@
+require_relative "../helpers"
+self.extend Helpers
+
 say "Install Tailwind (+PostCSS w/ autoprefixer)"
 copy_file "#{__dir__}/tailwind.config.js", "tailwind.config.js"
 copy_file "#{__dir__}/application.tailwind.css", "app/assets/stylesheets/application.tailwind.css"
-run "yarn add tailwindcss@latest postcss@latest autoprefixer@latest"
+run "#{bundler_cmd} add tailwindcss@latest postcss@latest autoprefixer@latest"
 
 say "Add build:css script"
-build_script = "tailwindcss -i ./app/assets/stylesheets/application.tailwind.css -o ./app/assets/builds/application.css --minify"
-
-case `npx -v`.to_f
-when 7.1...8.0
-  run %(npm set-script build:css "#{build_script}")
-  run %(yarn build:css)
-when (8.0..)
-  run %(npm pkg set scripts.build:css="#{build_script}")
-  run %(yarn build:css)
-else
-  say %(Add "scripts": { "build:css": "#{build_script}" } to your package.json), :green
-end
+add_package_json_script "build:css",
+  "tailwindcss -i ./app/assets/stylesheets/application.tailwind.css -o ./app/assets/builds/application.css --minify"

data/lib/tasks/cssbundling/build.rake

@@ -1,18 +1,48 @@
 namespace :css do
+  desc "Install JavaScript dependencies"
+  task :install do
+    command = install_command
+    unless system(command)
+      raise "cssbundling-rails: Command install failed, ensure #{command.split.first} is installed"
+    end
+  end
+
   desc "Build your CSS bundle"
-  task :build do
-    unless system "yarn install && yarn build:css"
-      raise "cssbundling-rails: Command css:build failed, ensure yarn is installed and `yarn build:css` runs without errors"
+  build_task = task :build do
+    command = build_command
+    unless system(command)
+      raise "cssbundling-rails: Command build failed, ensure `#{command}` runs without errors"
     end
   end
+  build_task.prereqs << :install unless ENV["SKIP_YARN_INSTALL"] || ENV["SKIP_BUN_INSTALL"]
+end
+
+def install_command
+  return "bun install" if File.exist?('bun.lockb') || (tool_exists?('bun') && !File.exist?('yarn.lock'))
+  return "yarn install" if File.exist?('yarn.lock') || tool_exists?('yarn')
+  raise "cssbundling-rails: No suitable tool found for installing JavaScript dependencies"
 end
 
-if Rake::Task.task_defined?("assets:precompile")
-  Rake::Task["assets:precompile"].enhance(["css:build"])
+def build_command
+  return "bun run build:css" if File.exist?('bun.lockb') || (tool_exists?('bun') && !File.exist?('yarn.lock'))
+  return "yarn build:css" if File.exist?('yarn.lock') || tool_exists?('yarn')
+  raise "cssbundling-rails: No suitable tool found for building CSS"
 end
 
-if Rake::Task.task_defined?("test:prepare")
-  Rake::Task["test:prepare"].enhance(["css:build"])
-elsif Rake::Task.task_defined?("db:test:prepare")
-  Rake::Task["db:test:prepare"].enhance(["css:build"])
+def tool_exists?(tool)
+  system "command -v #{tool} > /dev/null"
+end
+
+unless ENV["SKIP_CSS_BUILD"]
+  if Rake::Task.task_defined?("assets:precompile")
+    Rake::Task["assets:precompile"].enhance(["css:build"])
+  end
+
+  if Rake::Task.task_defined?("test:prepare")
+    Rake::Task["test:prepare"].enhance(["css:build"])
+  elsif Rake::Task.task_defined?("spec:prepare")
+    Rake::Task["spec:prepare"].enhance(["css:build"])
+  elsif Rake::Task.task_defined?("db:test:prepare")
+    Rake::Task["db:test:prepare"].enhance(["css:build"])
+  end
 end

data/lib/tasks/cssbundling/clobber.rake

@@ -1,7 +1,7 @@
 namespace :css do
   desc "Remove CSS builds"
   task :clobber do
-    rm_rf Dir["app/assets/builds/**/[^.]*.css"], verbose: false
+    rm_rf Dir["app/assets/builds/**/[^.]*.{css,css.map}"], verbose: false
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cssbundling-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.3.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-14 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -36,12 +36,14 @@ files:
 - lib/cssbundling-rails.rb
 - lib/cssbundling/engine.rb
 - lib/cssbundling/version.rb
-- lib/install/Procfile.dev
+- lib/install/Procfile_for_bun.dev
+- lib/install/Procfile_for_node.dev
 - lib/install/bootstrap/application.bootstrap.scss
 - lib/install/bootstrap/install.rb
 - lib/install/bulma/application.bulma.scss
 - lib/install/bulma/install.rb
 - lib/install/dev
+- lib/install/helpers.rb
 - lib/install/install.rb
 - lib/install/package.json
 - lib/install/postcss/application.postcss.css
@@ -75,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Bundle and process CSS with Tailwind, Bootstrap, PostCSS, Sass in Rails via

data/lib/install/Procfile.dev

@@ -1,2 +0,0 @@
-web: unset PORT && bin/rails server
-css: yarn build:css --watch