dartsass-sprockets 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ab3cc3dd35bada15e7bc557efce4b403181bb5ee117487e99e22441fe60df97
-  data.tar.gz: 981e5d83fb052ffd0ddb4e3b9ec686ab81ae49b703db88672224f4a3997c22c5
+  metadata.gz: 97ecd8e6a0a54de66fe07748636aa80c19d0a15e61259cf84fa4176bab3299f2
+  data.tar.gz: 05040dc70d0af1710fd6e6525912fe684fdd12c09aae41b8e6784ab0c9677d1d
 SHA512:
-  metadata.gz: 48fee21a6ded6e569d8f48aa92bb514cae6980b5fd748a99d0f6b1631961efccba54cddb11983364e203656266fabe29163a8077c30a8263e5aef514d6bc0495
-  data.tar.gz: 8d8690cb0a58cc7a87d39c571c4d18fd9411d1c1c15d3ccfd5f238fbafca65bfc05cf6cd9c27901b3483026153d4693701ba9c8912b4da238359fb137affe9e6
+  metadata.gz: ef8f73113bc5107745a3339297790c4ed857ed961c8d1935982fd9a5e05f0f35d66403db69b1f76bce7c2edfce3123a7e60d8df6af1ec970896499220fed08d4
+  data.tar.gz: 1b82505cf1465ade855b79fd954a7047943600a0fc26ae25643f934768974db8441cdb2d44f2522a8f4d169cb4fe8b0432fa0196385df20fd4b61532823ad03a

data/README.md

@@ -33,30 +33,79 @@ The current version of `dartsass-sprockets` supports:
 
 For older versions of Ruby and Rails may be supported with earlier versions of this gem.
 
-### Upgrading to Dart Sass
+## CSS Minification (Production)
 
-This gem is a drop-in replacement to [sass-rails](https://github.com/rails/sass-rails).
-Note the following differences:
+This gem uses a Railtie to automatically set the following
+configuration in all environments *except* Development:
 
-* This library does not apply SASS processing to `.css` files. Please ensure all your SASS files have file extension `.scss`.
-* `config.sass.style` values `:nested` and `:compact` will behave as `:expanded`. Use `:compressed` for minification.
-* `config.sass.line_comments` option is ignored and will always be disabled.
+```ruby
+# set automatically by this gem
+config.assets.css_compressor = :sass
+```
+
+This causes Sprockets to minify *all* CSS assets (both Sass and plain CSS) using Dart Sass.
+This minification is done as a *second-pass* after compiling the Sass to CSS,
+and is done irrespective of whether the `config.sass.style` option is set to `:compressed`.
+To disable this behavior, set `config.assets.css_compressor = false`.
 
-## Inline Source Maps
+## Source Maps (Development)
 
 To turn on inline source maps, add the following configuration
-to your `development.rb` file:
+to your `config/environments/development.rb` file:
 
 ```ruby
-# config/environments/development.rb
+# in config/environments/development.rb
 config.sass.inline_source_maps = true
 ```
 
-After adding this config line, you may need to clear your assets cache
-(`rm -r tmp/cache/assets`), stop Spring, and restart your Rails server.
+Note these source maps appended *inline* to the compiled `application.css` file.
+(This option will *not* generate additional files.)
+
+## Silencing Deprecation Warnings
 
-Note these source maps are *inline* and will be appended to the compiled
-`application.css` file. (They will *not* generate additional files.)
+To silence common deprecation warnings, add the following
+configuration. Refer to details in the below section.
+
+```ruby
+# in config/application.rb
+config.sass.quiet_deps = true
+config.sass.silence_deprecations = ['import']
+```
+
+## Advanced Configuration
+
+The following options are exposed via `Rails.application.config.sass.{option}`.
+Options denoted with * are handed by the sass-embedded gem and passed into Dart Sass;
+refer to [the sass-embedded documentation](https://rubydoc.info/gems/sass-embedded/Sass)
+and the [Dart Sass documentation](https://sass-lang.com/documentation/js-api/interfaces/options/).
+
+| Option                  | Type            | Description                                                                                                                   |
+|-------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------|
+| `load_paths`            | `Array<String>` | Additional paths to look for imported files.                                                                                  |
+| `inline_source_maps`    | `Boolean`       | If `true`, will append source maps inline to the generated CSS file. Refer to section below.                                  |
+| `style`*                | `Symbol`        | `:expanded` (default) or `:compressed`. See note about CSS Minification below.                                                |
+| `charset`*              | `Boolean`       | Whether to include a @charset declaration or byte-order mark in the CSS output (default `true`).                              |
+| `logger`*               | `Object`        | An object to use to handle warnings and/or debug messages from Sass.                                                          |
+| `alert_ascii`*          | `Boolean`       | If `true`, Dart Sass will exclusively use ASCII characters in its error and warning messages (default `false`).               |
+| `alert_color`*          | `Boolean`       | If `true`, Dart Sass will use ANSI color escape codes in its error and warning messages (default `false`).                    |
+| `verbose`*              | `Boolean`       | By default (`false`) Dart Sass logs up to five occurrences of each deprecation warning. Setting to `true` removes this limit. |
+| `quiet_deps`*           | `Boolean`       | If `true`, Dart Sass won’t print warnings that are caused by dependencies (default `false`).                                  |
+| `silence_deprecations`* | `Array<String>` | An array of active deprecations to ignore. Refer to (deprecations)[dartsass-deprecations].                                    |
+| `fatal_deprecations`*   | `Array<String>` | An array of deprecations to treat as fatal. Refer to (deprecations)[dartsass-deprecations].                                   |
+| `future_deprecations`*  | `Array<String>` | An array of future deprecations to opt-into early. Refer to (deprecations)[dartsass-deprecations].                            |
+| `importers`*            | `Array<Object>` | Custom importers to use when resolving `@import` directives.                                                                  |
+
+When changing config options in Development environment, you may need to clear
+your assets cache (`rm -r tmp/cache/assets`) and restart your Rails server.
+
+### Upgrading from Legacy Sass Rails
+
+This gem is a drop-in replacement to [sass-rails](https://github.com/rails/sass-rails).
+Note the following differences:
+
+* This library does not apply SASS processing to `.css` files. Please ensure all your SASS files have file extension `.scss`.
+* `config.sass.style` values `:nested` and `:compact` will behave as `:expanded`. Use `:compressed` for minification.
+* `config.sass.line_comments` option is ignored and will always be disabled.
 
 ## Alternatives
 
@@ -80,3 +129,5 @@ Note these source maps are *inline* and will be appended to the compiled
 3. Commit your changes (`git commit -am 'Add some feature'`) - try to include tests
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+[dartsass-deprecations]: https://github.com/sass/sass/blob/40c50cb/js-api-doc/deprecations.d.ts#L260

data/lib/sassc/rails/compressor.rb

@@ -16,16 +16,7 @@ module Sprockets
     end
 
     def call(*args)
-      input = if defined?(data)
-                data # sprockets 2.x
-              else
-                args[0][:data] # sprockets 3.x
-              end
-
-      SassC::Engine.new(input, { style: :compressed }).render
+      SassC::Engine.new(args[0][:data], { style: :compressed }).render
     end
-
-    # sprockets 2.x
-    alias evaluate call
   end
 end

data/lib/sassc/rails/railtie.rb

@@ -15,8 +15,8 @@ module SassC
       # Initialize the load paths to an empty array
       config.sass.load_paths = []
 
-      # Display line comments above each selector as a debugging aid
-      config.sass.line_comments = true
+      # Silence deprecation warnings during compilation that come from dependencies
+      config.sass.quiet_deps = false
 
       # Set the default stylesheet engine
       # It can be overridden by passing:
@@ -72,11 +72,8 @@ module SassC
       end
 
       initializer :setup_compression, group: :all do |app|
-        if ::Rails.env.development?
-          # Use expanded output instead of the sass default of :nested unless specified
-          app.config.sass.style ||= :expanded
-        else
-          app.config.assets.css_compressor = :sass unless app.config.assets.key?(:css_compressor)
+        unless ::Rails.env.development?
+          app.config.assets.css_compressor = :sass unless app.config.assets.key?(:css_compressor) # rubocop:disable Style/SoleNestedConditional
         end
       end
     end

data/lib/sassc/rails/template.rb

@@ -3,79 +3,76 @@
 require 'sprockets/version'
 require 'sprockets/sass_processor'
 require 'sprockets/utils'
+require 'sprockets/uri_utils'
 
 module SassC
   module Rails
     class SassTemplate < Sprockets::SassProcessor
+      PASS_THRU_OPTIONS = %i[
+        style
+        charset
+        importers
+        logger
+        alert_ascii
+        alert_color
+        verbose
+        quiet_deps
+        silence_deprecations
+        fatal_deprecations
+        future_deprecations
+      ].freeze
+
       def initialize(options = {}, &block) # rubocop:disable Lint/MissingSuper
         @cache_version = options[:cache_version]
-        @cache_key = "#{self.class.name}:#{VERSION}:#{SassC::VERSION}:#{@cache_version}"
-        # @importer_class = options[:importer] || Sass::Importers::Filesystem
+        @cache_key = "#{self.class.name}:#{VERSION}:#{::SassC::VERSION}:#{@cache_version}"
+        @importer_class = options[:importer] || ::SassC::Rails::Importer
         @sass_config = options[:sass_config] || {}
         @functions = Module.new do
+          include ::SassC::Script::Functions
           include Functions
           include options[:functions] if options[:functions]
           class_eval(&block) if block_given?
         end
       end
 
-      def call(input)
+      def call(input) # rubocop:disable Metrics/AbcSize
         context = input[:environment].context_class.new(input)
 
         options = {
+          load_paths: input[:environment].paths | (::Rails.application.config.sass.load_paths || []),
           filename: input[:filename],
-          line_comments: line_comments?,
           syntax: self.class.syntax,
-          load_paths: input[:environment].paths,
-          importer: SassC::Rails::Importer,
+          functions: @functions,
+          importer: @importer_class,
           sprockets: {
             context: context,
             environment: input[:environment],
             dependencies: context.metadata[:dependency_paths]
           }
-        }.merge!(config_options) { |key, left, right| safe_merge(key, left, right) }
-
-        engine = ::SassC::Engine.new(input[:data], options)
+        }
 
-        css = Sprockets::Utils.module_include(::SassC::Script::Functions, @functions) do
-          engine.render
+        PASS_THRU_OPTIONS.each do |option|
+          options[option] = ::Rails.application.config.sass.send(option)
         end
 
-        context.metadata.merge(data: css)
-      end
-
-      def config_options
-        opts = { style: sass_style, load_paths: load_paths }
-
         if ::Rails.application.config.sass.inline_source_maps
-          opts.merge!(source_map_file: '.',
-                      source_map_embed: true,
-                      source_map_contents: true)
+          options.merge!(source_map_file: '.',
+                         source_map_embed: true,
+                         source_map_contents: true)
         end
 
-        opts
-      end
-
-      def sass_style
-        (::Rails.application.config.sass.style || :expanded).to_sym
-      end
-
-      def load_paths
-        ::Rails.application.config.sass.load_paths || []
-      end
+        engine = ::SassC::Engine.new(input[:data], options.compact)
 
-      def line_comments?
-        ::Rails.application.config.sass.line_comments
-      end
+        css = engine.render
 
-      def safe_merge(_key, left, right)
-        if [left, right].all? { |v| v.is_a? Hash }
-          left.merge(right) { |k, l, r| safe_merge(k, l, r) }
-        elsif [left, right].all? { |v| v.is_a? Array }
-          (left + right).uniq
-        else
-          right
+        # Track all imported files
+        sass_dependencies = Set.new([input[:filename]])
+        engine.dependencies.map do |dependency|
+          sass_dependencies << dependency.options[:filename]
+          context.metadata[:dependencies] << Sprockets::URIUtils.build_file_digest_uri(dependency.options[:filename])
         end
+
+        context.metadata.merge(data: css, sass_dependencies: sass_dependencies)
       end
 
       # The methods in the Functions module were copied here from sprockets in order to

data/lib/sassc/rails/version.rb

@@ -2,6 +2,6 @@
 
 module SassC
   module Rails
-    VERSION = '3.1.0'
+    VERSION = '3.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dartsass-sprockets
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Ryan Boland
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-31 00:00:00.000000000 Z
+date: 2025-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.69'
+        version: 1.80.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.69'
+        version: 1.80.1
 - !ruby/object:Gem::Dependency
   name: sprockets
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Use Dart Sass with Sprockets and the Ruby on Rails asset pipeline.