cssbundling-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 157a239ed259b5466360204b02cbe2b260f6bd1fe9357e7a8d190f24658f21e4
+  data.tar.gz: beaa568932183609d735427a7cb32f3bc8a54c468296eeb86bd09f1e101b9c76
+SHA512:
+  metadata.gz: 50acd8f5b93b5f7be810b2fed9a563fc1a5526362985206865d3478e01b1f555e97018793c129f62835552475a929a22579eef2722e6eb0b77787ff99901e78e
+  data.tar.gz: b50e046ba8cef422ee3d7d404696e66dae05c341d1f7342f98d92d748cece0b81e9c6198dd096e89700334dbc49605b0c970de1c20b0c443d8178e5ec90ab2a9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2021 David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# 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).
+
+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" %>`.
+
+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`).
+
+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.
+
+
+## Installation
+
+You must already have node and yarn installed on your system. 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]`
+
+Or, in Rails 7+, you can preconfigure your new application to use a specific bundler with `rails new myapp --css [tailwind|postcss|sass]`.
+
+
+## License
+
+CSS Bundling for Rails is released under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/cssbundling/engine.rb

@@ -0,0 +1,4 @@
+module Cssbundling
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/cssbundling/version.rb

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

data/lib/cssbundling-rails.rb

@@ -0,0 +1,5 @@
+module Cssbundling
+end
+
+require "cssbundling/version"
+require "cssbundling/engine"

data/lib/install/install.rb

@@ -0,0 +1,16 @@
+say "Build into app/assets/builds"
+empty_directory "app/assets/builds"
+keep_file "app/assets/builds"
+append_to_file "app/assets/config/manifest.js", %(//= link_tree ../builds\n)
+
+if Rails.root.join(".gitignore").exist?
+  append_to_file(".gitignore", %(/app/assets/builds\n))
+end
+
+say "Remove app/assets/stylesheets/application.css so build output can take over"
+remove_file "app/assets/stylesheets/application.css"
+
+unless Rails.root.join("package.json").exist?
+  say "Add default package.json"
+  copy_file "#{__dir__}/package.json", "package.json"
+end

data/lib/install/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "app",
+  "private": "true"
+}

data/lib/install/postcss/application.postcss.css

@@ -0,0 +1 @@
+/* Entry point for your PostCSS build */

data/lib/install/postcss/install.rb

@@ -0,0 +1,7 @@
+say "Install PostCSS w/ postcss-preset-env"
+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-preset-env"
+
+say "Add build:css script"
+run %(npm set-script build:css "postcss ./app/assets/stylesheets/application.postcss.css -o ./app/assets/builds/application.css")

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

@@ -0,0 +1,10 @@
+module.exports = {
+  plugins: [
+    require('postcss-preset-env')({ 
+      stage: 2,
+      features: {
+        'nesting-rules': true
+      }
+    })
+  ],
+}

data/lib/install/sass/application.sass.scss

@@ -0,0 +1 @@
+// Entry point for your Sass build

data/lib/install/sass/install.rb

@@ -0,0 +1,6 @@
+say "Install Sass"
+copy_file "#{__dir__}/application.sass.scss", "app/assets/stylesheets/application.sass.scss"
+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")

data/lib/install/tailwind/application.tailwind.css

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

data/lib/install/tailwind/install.rb

@@ -0,0 +1,7 @@
+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"
+
+say "Add build:css script"
+run %(npm set-script build:css "tailwindcss -i ./app/assets/stylesheets/application.tailwind.css -o ./app/assets/builds/application.css")

data/lib/install/tailwind/package.json

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

data/lib/install/tailwind/tailwind.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  mode: 'jit',
+  purge: [
+    './app/views/**/*.html.erb',
+    './app/helpers/**/*.rb',
+    './app/javascript/**/*.js'
+  ]
+}

data/lib/tasks/cssbundling/build.rake

@@ -0,0 +1,9 @@
+namespace :css do
+  desc "Build your CSS bundle"
+  task :build do
+    system "yarn install && yarn build:css"
+  end
+end
+
+Rake::Task["assets:precompile"].enhance(["css:build"])
+Rake::Task["test:prepare"].enhance(["css:build"])

data/lib/tasks/cssbundling/install.rake

@@ -0,0 +1,23 @@
+namespace :css do
+  namespace :install do
+    desc "Install shared elements for all bundlers"
+    task :shared do
+      system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/install.rb",  __dir__)}"
+    end
+
+    desc "Install Tailwind"
+    task tailwind: "css:install:shared" do
+      system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/tailwind/install.rb",  __dir__)}"
+    end
+
+    desc "Install PostCSS"
+    task postcss: "css:install:shared" do
+      system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/postcss/install.rb",  __dir__)}"
+    end
+
+    desc "Install Sass"
+    task sass: "css:install:shared" do
+      system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../install/sass/install.rb",  __dir__)}"
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: cssbundling-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Heinemeier Hansson
+- Dom Christie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: 
+email: david@loudthinking.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/cssbundling-rails.rb
+- lib/cssbundling/engine.rb
+- lib/cssbundling/version.rb
+- lib/install/install.rb
+- lib/install/package.json
+- lib/install/postcss/application.postcss.css
+- lib/install/postcss/install.rb
+- lib/install/postcss/postcss.config.js
+- lib/install/sass/application.sass.scss
+- lib/install/sass/install.rb
+- lib/install/tailwind/application.tailwind.css
+- lib/install/tailwind/install.rb
+- lib/install/tailwind/package.json
+- lib/install/tailwind/tailwind.config.js
+- lib/tasks/cssbundling/build.rake
+- lib/tasks/cssbundling/install.rake
+homepage: https://github.com/rails/cssbundling-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Bundle and process CSS with Tailwind, PostCSS, or Sass in Rails via Node.js.
+test_files: []