dartsass-rails 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 926726f873ae7ec4d5b024cfad0dc452c290baa35842100bd98c74bb13d91eea
-  data.tar.gz: 65e0520536f1b0649f1394386df0dde7a0f4774155b7a689e04e514e96e3de81
+  metadata.gz: 165bcaadffc761840fcd9a39e1b2f6f862974e62b22dab5e6841d485dc94d072
+  data.tar.gz: 6629e2d3f46c0a2787fc8af5ba25298f613f5817b3e237c988958ef8d57f2aca
 SHA512:
-  metadata.gz: 22ab26793030f9679e5e130567322e999027df10275e922de89f3ffc9ce2976e5dfae6d9b1a8db7c03cf92cd2bd044867e0d30c73fbe1337f45d1d1afba5f92e
-  data.tar.gz: 3d5c7241ad28f38147543e8dda20f49abc49fbe1361206fb19a1381861a3581701eb3004ced39dd7449bd3082d8d6c1d7a1fbe51aec4d55194ac39ddb44bb93b
+  metadata.gz: d5dceba364d547b14f80da2eebf9b55c7b402b911ffa242ccab950b1c54425ca334d5b42916903ea82fa7f0536f1150a6931c8a9c727ef92b05ce2b2dd0b20c1
+  data.tar.gz: 352ac02425d2b164d506c36496d19ea016e423e0c01c2bcf4b0e0474fb5c6aad261994be84c1a880b3079694219bcea1c77e932fa1a9caa32ca682700b64171c

data/README.md

@@ -2,13 +2,13 @@
 
 [Sass](https://sass-lang.com) is a stylesheet language that’s compiled to CSS. It allows you to use variables, nested rules, mixins, functions, and more, all with a fully CSS-compatible syntax.
 
-This gem wraps [the standalone executable version](https://github.com/sass/dart-sass/releases) of the Dart version of Sass. These executables are platform specific, but included in this gem are the ones for macOS, Linux, and Windows. The Linux and Windows versions are the ones for 64-bit, and the macOS version is compiled for Intel but will run on ARM as well.
+This gem wraps [the standalone executable version](https://github.com/sass/dart-sass/releases) of the Dart version of Sass. These executables are platform specific, but included in this gem are the ones for macOS (Intel, Apple Silicon), Linux (x86-64, AArch64), and Windows (x86-64).
 
-The installer will create your Sass input file in `app/assets/stylesheets/application.scss`. This is where you should import all the style files to be compiled [using the @use rule](https://sass-lang.com/documentation/at-rules/use). When you run `rails dartsass:build`, this input file will be used to generate the output in `app/assets/builds/application.css`. That's the output CSS that you'll include in your app.
+The installer will create your default Sass input file in `app/assets/stylesheets/application.scss`. This is where you should import all the style files to be compiled [using the @use rule](https://sass-lang.com/documentation/at-rules/use). When you run `rails dartsass:build`, this input file will be used to generate the output in `app/assets/builds/application.css`. That's the output CSS that you'll include in your app. The load path for Sass is automatically configured to be `app/assets/stylesheets`.
 
-If you need to use a custom input or output file, you can run `bundle exec dartsass` to access the platform-specific executable, and give it your own build options.
+If you need to configure the build process – beyond configuring the build files – you can run `bundle exec dartsass` to access the platform-specific executable, and give it your own build options.
 
-When you're developing your application, you want to run Dart Sass in watch mode, so changes are automatically reflected in the generated CSS output. You can do this either by running `rails dartsass:watch` as a separate process, or by running `./bin/dev` which uses [foreman](https://github.com/ddollar/foreman) to starts both the Dart Sass watch process and the rails server in development mode.
+When you're developing your application, you want to run Dart Sass in watch mode, so changes are automatically reflected in the generated CSS output. You can do this either by running `rails dartsass:watch` as a separate process, or by running `./bin/dev` which uses [foreman](https://github.com/ddollar/foreman) to start both the Dart Sass watch process and the rails server in development mode.
 
 
 ## Installation
@@ -16,11 +16,110 @@ When you're developing your application, you want to run Dart Sass in watch mode
 1. Run `./bin/bundle add dartsass-rails`
 2. Run `./bin/rails dartsass:install`
 
-
 ## Building in production
 
 The `dartsass:build` is automatically attached to `assets:precompile`, so before the asset pipeline digests the files, the Dart Sass output will be generated.
 
+## Configuring builds
+
+By default, only `app/assets/stylesheets/application.scss` will be built. If you'd like to change the path of this stylesheet, add additional entry points, or customize the name of the built file, use the `Rails.application.config.dartsass.builds` configuration hash.
+
+
+```ruby
+# config/initializers/dartsass.rb
+Rails.application.config.dartsass.builds = {
+  "app/index.sass"  => "app.css",
+  "site.scss"       => "site.css"
+}
+```
+
+The hash key is the relative path to a Sass file in `app/assets/stylesheets/` and the hash value will be the name of the file output to `app/assets/builds/`.
+
+## Configuring build options
+
+By default, sass is invoked with `--style=compressed --no-source-map`. You can adjust these options by overwriting `Rails.application.config.dartsass.build_options`.
+
+```ruby
+# config/initializers/dartsass.rb
+Rails.application.config.dartsass.build_options << " --quiet-deps"
+```
+
+## Importing assets from gems
+`dartsass:build` includes application [assets paths](https://guides.rubyonrails.org/asset_pipeline.html#search-paths) as Sass [load paths](https://sass-lang.com/documentation/at-rules/use#load-paths). Assuming the gem has made assets visible to the Rails application, no additional configuration is required to use them.
+
+## Migrating from sass-rails
+
+If you're migrating from [sass-rails](https://github.com/rails/sass-rails)
+(applies to [sassc-rails](https://github.com/sass/sassc-rails) as well)
+and want to switch to dartsass-rails, follow these instructions below:
+
+1. Remove the sass-rails gem from the Gemfile by running
+
+    ```
+    ./bin/bundle remove sass-rails
+    ```
+
+1. Install dartsass-rails by following the
+    [Installation](#installation) instructions above
+
+1. Remove any references to Sass files from the Sprockets manifest file:
+    `app/assets/config/manifest.js`
+
+1. In your continuous integration pipeline, before running any tests that
+    interact with the browser, make sure to build the Sass files by running:
+
+    ```
+    bundle exec rails dartsass:build
+    ```
+
+## Troubleshooting
+
+Some common problems experienced by users:
+
+### LoadError: cannot load such file -- sassc
+
+The reason for the above error is that Sprockets is trying to build Sass files
+but the sass-rails or sassc-rails gems are not installed. This is expected,
+since Dart Sass is used instead to build Sass files, and the solution is
+to make sure that Sprockets is not building any Sass files.
+
+There are three reasons why this error can occur:
+
+#### Sass files are referenced in the Sprockets manifest file
+
+If any Sass files are referenced in the Sprockets manifest file
+(`app/assets/config/manifest.js`) Sprockets will try to build the Sass files and
+fail.
+
+##### Solution
+
+Remove any references to Sass files from the Sprockets manifest file. These are
+now handled by Dart Sass. If you have more Sass files than `application.scss`,
+make sure these are compiled by Dart Sass
+(see [Configuring builds](#configuring-builds) above).
+
+#### Running locally
+
+If you receive this error when running the Rails server locally and have
+already removed any references to Sass files from the Sprockets manifest file,
+the Dart Sass process is most likely not running.
+
+##### Solution
+
+Make sure the Dart Sass process is running by starting the Rails sever by
+running: `./bin/dev`.
+
+#### Running continuous integration pipelines
+
+If you receive this error when running tests that interact with the browser in
+a continuous integration pipeline and have removed any references to Sass files
+from the Sprockets manifest file, the Sass files have most likely not been
+built.
+
+#####  Solution
+
+Add a step to the continuous integration pipeline to build the Sass files with
+the following command: `bundle exec rails dartsass:build`.
 
 ## Version
 

data/exe/dartsass

@@ -2,17 +2,21 @@
 # because rubygems shims assume a gem's executables are Ruby
 
 require "shellwords"
+require "rbconfig"
 
-os = Gem::Platform.local.os
+system_config = RbConfig::CONFIG
+platform_string = "#{system_config["host_cpu"]}-#{system_config["host_os"]}"
 
-exe_path = 
-  case os
-  when "darwin"  then File.join(__dir__, "darwin/sass")
-  when "linux"   then File.join(__dir__, "linux/sass")
-  when "mingw32" then File.join(__dir__, "mingw32/sass.bat")
+exe_path =
+  case platform_string
+  when /aarch64-linux/ then File.join(__dir__, "aarch64-linux/sass")
+  when /arm64-darwin/ then File.join(__dir__, "arm64-darwin/sass")
+  when /darwin/ then File.join(__dir__, "darwin/sass")
+  when /linux/ then File.join(__dir__, "linux/sass")
+  when /mswin|mingw|cygwin/ then File.join(__dir__, "mingw32/sass.bat")
   else
     STDERR.puts(<<~ERRMSG)
-      ERROR: dartsass-rails does not support the #{os} operating system
+      ERROR: dartsass-rails does not support the #{platform_string} platform
     ERRMSG
     exit 1
   end

data/lib/dartsass/engine.rb

@@ -2,5 +2,8 @@ require "rails"
 
 module Dartsass
   class Engine < ::Rails::Engine
+    config.dartsass = ActiveSupport::OrderedOptions.new
+    config.dartsass.builds = { "application.scss" => "application.css" }
+    config.dartsass.build_options = "--style=compressed --no-source-map"
   end
 end

data/lib/dartsass/version.rb

@@ -1,3 +1,3 @@
 module Dartsass
-  VERSION = "0.1.1"
+  VERSION = "0.4.0"
 end

data/lib/install/dartsass.rb

@@ -5,6 +5,13 @@ say "Build into app/assets/builds"
 empty_directory "app/assets/builds"
 keep_file "app/assets/builds"
 
+if (sprockets_manifest_path = Rails.root.join("app/assets/config/manifest.js")).exist?
+  append_to_file sprockets_manifest_path, %(//= link_tree ../builds\n)
+
+  say "Stop linking stylesheets automatically"
+  gsub_file "app/assets/config/manifest.js", "//= link_directory ../stylesheets .css\n", ""
+end
+
 if Rails.root.join(".gitignore").exist?
   append_to_file(".gitignore", %(\n/app/assets/builds/*\n!/app/assets/builds/.keep\n))
 end

data/lib/tasks/build.rake

@@ -1,14 +1,34 @@
-DARTSASS_COMPILE_COMMAND = "#{Pathname.new(__dir__).to_s}/../../exe/dartsass #{Rails.root.join("app/assets/stylesheets/application.scss")} #{Rails.root.join("app/assets/builds/application.scss")}"
+EXEC_PATH      = "#{Pathname.new(__dir__).to_s}/../../exe/dartsass"
+CSS_LOAD_PATH  = Rails.root.join("app/assets/stylesheets")
+CSS_BUILD_PATH = Rails.root.join("app/assets/builds")
+
+def dartsass_build_mapping
+  Rails.application.config.dartsass.builds.map { |input, output|
+    "#{CSS_LOAD_PATH.join(input)}:#{CSS_BUILD_PATH.join(output)}"
+  }.join(" ")
+end
+
+def dartsass_build_options
+  Rails.application.config.dartsass.build_options
+end
+
+def dartsass_load_paths
+  [ CSS_LOAD_PATH ].concat(Rails.application.config.assets.paths).map { |path| "--load-path #{path}" }.join(" ")
+end
+
+def dartsass_compile_command
+   "#{EXEC_PATH} #{dartsass_build_options} #{dartsass_load_paths} #{dartsass_build_mapping}"
+end
 
 namespace :dartsass do
   desc "Build your Dart Sass CSS"
-  task :build do
-    system DARTSASS_COMPILE_COMMAND
+  task build: :environment do
+    system dartsass_compile_command, exception: true
   end
 
   desc "Watch and build your Dart Sass CSS on file changes"
-  task :watch do
-    system "#{DARTSASS_COMPILE_COMMAND} -w"
+  task watch: :environment do
+    system "#{dartsass_compile_command} -w", exception: true
   end
 end
 

data/lib/tasks/clobber.rake

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

data/lib/tasks/install.rake

@@ -1,6 +1,6 @@
 namespace :dartsass do
   desc "Install Dart Sass into the app"
   task :install do
-    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/dartsass.rb", __dir__)}"
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/dartsass.rb", __dir__)}", exception: true
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dartsass-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-22 00:00:00.000000000 Z
+date: 2022-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -35,6 +35,8 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- exe/aarch64-linux/sass
+- exe/arm64-darwin/sass
 - exe/dartsass
 - exe/darwin/LICENSE
 - exe/darwin/sass
@@ -77,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.14
 signing_key:
 specification_version: 4
 summary: Integrate Dart Sass with the asset pipeline in Rails.