cssbundling-rails 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 157a239ed259b5466360204b02cbe2b260f6bd1fe9357e7a8d190f24658f21e4
-  data.tar.gz: beaa568932183609d735427a7cb32f3bc8a54c468296eeb86bd09f1e101b9c76
+  metadata.gz: f1cb16bc8fd46769c9ceee9130fe3146da522850768c6d004043cab54fa45595
+  data.tar.gz: cd894d657fcc8d2d55c14d61674f85627ea6e7cb0d3d2375c1d8ea5529f531b4
 SHA512:
-  metadata.gz: 50acd8f5b93b5f7be810b2fed9a563fc1a5526362985206865d3478e01b1f555e97018793c129f62835552475a929a22579eef2722e6eb0b77787ff99901e78e
-  data.tar.gz: b50e046ba8cef422ee3d7d404696e66dae05c341d1f7342f98d92d748cece0b81e9c6198dd096e89700334dbc49605b0c970de1c20b0c443d8178e5ec90ab2a9
+  metadata.gz: ef825dd44a3654b15d488894b19f01020be3020129a2ba45934b5e7860f17824120336109dc15de9a109c6d3e0bf080b0686bed761ade6d29314bb238a905d96
+  data.tar.gz: 2b7c58fb054093ad72f89b34472ae38b0a33ea9a16b4565139d90860c6cb1affa890fac65e7530f37ae626bcf2d8f718072cabe752b637990cf1354b6b295ecd

data/README.md

@@ -1,13 +1,15 @@
 # CSS Bundling for Rails
 
-Use [Tailwind CSS](https://tailwindcss.com), [PostCSS](https://postcss.org), or [Dart Sass](https://sass-lang.com/) to bundle and process your JavaScript, then deliver it via the asset pipeline in Rails. This gem provides installers to get you going with the bundler of your choice in a new Rails application, and a convention to use `app/assets/builds` to hold your bundled output as artifacts that are not checked into source control (the installer adds this directory to `.gitignore` by default).
+Use [Tailwind CSS](https://tailwindcss.com), [PostCSS](https://postcss.org), [Dart Sass](https://sass-lang.com/), or [Bootstrap](https://getbootstrap.com/) to bundle and process your CSS, then deliver it via the asset pipeline in Rails. This gem provides installers to get you going with the bundler of your choice in a new Rails application, and a convention to use `app/assets/builds` to hold your bundled output as artifacts that are not checked into source control (the installer adds this directory to `.gitignore` by default).
 
-You develop using this approach by running the bundler in watch mode in a terminal with `yarn build:css --watch` (and your Rails server in another, if you're not using something like [puma-dev](https://github.com/puma/puma-dev)). Whenever the bundler detects changes to any of the stylesheet files in your project, it'll bundle `app/assets/stylesheets/application.[bundler].css` into `app/assets/builds/application.css`. This build output takes over from the regular asset pipeline default file. So you continue to refer to the build output in your layout using the standard asset pipeline approach with `<%= stylesheet_include_tag "application" %>`.
+You develop using this approach by running the bundler in watch mode in a terminal with `yarn build:css --watch` (and your Rails server in another, if you're not using something like [puma-dev](https://github.com/puma/puma-dev)). Whenever the bundler detects changes to any of the stylesheet files in your project, it'll bundle `app/assets/stylesheets/application.[bundler].css` into `app/assets/builds/application.css`. This build output takes over from the regular asset pipeline default file. So you continue to refer to the build output in your layout using the standard asset pipeline approach with `<%= stylesheet_link_tag "application" %>`.
 
 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.
+
 That's it!
 
 You can configure your bundler options in the `build:css` script in `package.json` or via the installer-generated `tailwind.config.js` for Tailwind or `postcss.config.js` for PostCSS.
@@ -15,13 +17,13 @@ You can configure your bundler options in the `build:css` script in `package.jso
 
 ## Installation
 
-You must already have node and yarn installed on your system. Then:
+You must already have node and yarn installed on your system. You will also need npx version 7.1.0 or later. Then:
 
 1. Add `cssbundling-rails` to your Gemfile with `gem 'cssbundling-rails'`
 2. Run `./bin/bundle install`
-3. Run `./bin/rails css:install:[tailwind|postcss|sass]`
+3. Run `./bin/rails css:install:[tailwind|postcss|sass|bootstrap]`
 
-Or, in Rails 7+, you can preconfigure your new application to use a specific bundler with `rails new myapp --css [tailwind|postcss|sass]`.
+Or, in Rails 7+, you can preconfigure your new application to use a specific bundler with `rails new myapp --css [tailwind|postcss|sass|bootstrap]`.
 
 
 ## License

data/lib/cssbundling/version.rb

@@ -1,3 +1,3 @@
 module Cssbundling
-  VERSION = "0.1.0"
+  VERSION = "0.1.5"
 end

data/lib/install/Procfile.dev

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

data/lib/install/bootstrap/application.bootstrap.scss

@@ -0,0 +1 @@
+@import 'bootstrap/scss/bootstrap';

data/lib/install/bootstrap/install.rb

@@ -0,0 +1,14 @@
+say "Install Bootstrap with Popperjs/core"
+copy_file "#{__dir__}/application.bootstrap.scss",
+   "app/assets/stylesheets/application.bootstrap.scss"
+run "yarn add sass bootstrap @popperjs/core"
+
+if Rails.root.join("app/javascript/application.js").exist?
+  say "Appending Bootstrap JavaScript import to default entry point"
+  append_to_file "app/javascript/application.js", %(import * as bootstrap from "bootstrap"\n)
+else
+  say %(Add import * as bootstrap from "bootstrap" to your entry point JavaScript file), :red
+end
+
+say "Add build:css script"
+run %(npm set-script build:css "sass ./app/assets/stylesheets/application.bootstrap.scss ./app/assets/builds/application.css --no-source-map --load-path=node_modules")

data/lib/install/dev

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+foreman start -f Procfile.dev

data/lib/install/install.rb

@@ -3,8 +3,11 @@ empty_directory "app/assets/builds"
 keep_file "app/assets/builds"
 append_to_file "app/assets/config/manifest.js", %(//= link_tree ../builds\n)
 
+say "Stop linking stylesheets automatically"
+gsub_file "app/assets/config/manifest.js", "//= link_directory ../stylesheets .css", ""
+
 if Rails.root.join(".gitignore").exist?
-  append_to_file(".gitignore", %(/app/assets/builds\n))
+  append_to_file(".gitignore", %(/app/assets/builds\n!/app/assets/builds/.keep\n))
 end
 
 say "Remove app/assets/stylesheets/application.css so build output can take over"
@@ -14,3 +17,17 @@ unless Rails.root.join("package.json").exist?
   say "Add default package.json"
   copy_file "#{__dir__}/package.json", "package.json"
 end
+
+if Rails.root.join("Procfile.dev").exist?
+  append_to_file "Procfile.dev", "css: yarn build:css --watch"
+else
+  say "Add default Procfile.dev"
+  copy_file "#{__dir__}/Procfile.dev", "Procfile.dev"
+
+  say "Ensure foreman is install"
+  run "gem install foreman"
+end
+
+say "Add bin/dev to start foreman"
+copy_file "#{__dir__}/dev", "bin/dev"
+chmod "bin/dev", 0755, verbose: false

data/lib/install/sass/install.rb

@@ -3,4 +3,4 @@ copy_file "#{__dir__}/application.sass.scss", "app/assets/stylesheets/applicatio
 run "yarn add sass"
 
 say "Add build:css script"
-run %(npm set-script build:css "sass ./app/assets/stylesheets/application.sass.scss ./app/assets/builds/application.css --no-source-map")
+run %(npm set-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/package.json

@@ -2,6 +2,6 @@
   "name": "app",
   "private": "true",
   "scripts": {
-    "build:css": "tailwindcss -i ./app/assets/stylesheets/application.tw.css -o ./app/assets/builds/application.css"
+    "build:css": "tailwindcss -i ./app/assets/stylesheets/application.tailwind.css -o ./app/assets/builds/application.css"
   }
 }

data/lib/tasks/cssbundling/build.rake

@@ -6,4 +6,4 @@ namespace :css do
 end
 
 Rake::Task["assets:precompile"].enhance(["css:build"])
-Rake::Task["test:prepare"].enhance(["css:build"])
+Rake::Task["test:prepare"].enhance(["css:build"]) if Rake::Task.task_defined?("test:prepare")

data/lib/tasks/cssbundling/install.rake

@@ -19,5 +19,10 @@ namespace :css do
     task sass: "css:install:shared" do
       system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/sass/install.rb",  __dir__)}"
     end
+
+    desc "Install Bootstrap"
+    task bootstrap: "css:install:shared" do
+      system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/bootstrap/install.rb",  __dir__)}"
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cssbundling-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2021-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,6 +36,10 @@ files:
 - lib/cssbundling-rails.rb
 - lib/cssbundling/engine.rb
 - lib/cssbundling/version.rb
+- lib/install/Procfile.dev
+- lib/install/bootstrap/application.bootstrap.scss
+- lib/install/bootstrap/install.rb
+- lib/install/dev
 - lib/install/install.rb
 - lib/install/package.json
 - lib/install/postcss/application.postcss.css