sass-embedded 1.69.4-aarch64-linux-gnu → 1.69.6-aarch64-linux-gnu

data/lib/sass/compiler.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require_relative 'canonicalize_context'
+require_relative 'compile_result'
+require_relative 'compiler/connection'
+require_relative 'compiler/dispatcher'
+require_relative 'compiler/host'
+require_relative 'compiler/resilient_dispatcher'
+require_relative 'compiler/varint'
+require_relative 'embedded_protocol'
+require_relative 'exception'
+require_relative 'fork_tracker'
+require_relative 'logger/silent'
+require_relative 'logger/source_location'
+require_relative 'logger/source_span'
+require_relative 'serializer'
+require_relative 'value'
+
+module Sass
+  # The {Compiler} for using dart-sass. Each instance creates its own
+  # communication {Dispatcher} with a dedicated compiler process.
+  #
+  # @example
+  #   sass = Sass::Compiler.new
+  #   result = sass.compile_string('h1 { font-size: 40px; }')
+  #   result = sass.compile('style.scss')
+  #   sass.close
+  class Compiler
+    def initialize
+      @dispatcher = ResilientDispatcher.new(Dispatcher)
+    end
+
+    # Compiles the Sass file at +path+ to CSS.
+    # @param path [String]
+    # @param load_paths [Array<String>] Paths in which to look for stylesheets loaded by rules like
+    #   {@use}[https://sass-lang.com/documentation/at-rules/use/] and {@import}[https://sass-lang.com/documentation/at-rules/import/].
+    # @param charset [Boolean] By default, if the CSS document contains non-ASCII characters, Sass adds a +@charset+
+    #   declaration (in expanded output mode) or a byte-order mark (in compressed mode) to indicate its encoding to
+    #   browsers or other consumers. If +charset+ is +false+, these annotations are omitted.
+    # @param source_map [Boolean] Whether or not Sass should generate a source map.
+    # @param source_map_include_sources [Boolean] Whether Sass should include the sources in the generated source map.
+    # @param style [String, Symbol] The OutputStyle of the compiled CSS.
+    # @param functions [Hash<String, Proc>] Additional built-in Sass functions that are available in all stylesheets.
+    # @param importers [Array<Object>] Custom importers that control how Sass resolves loads from rules like
+    #   {@use}[https://sass-lang.com/documentation/at-rules/use/] and {@import}[https://sass-lang.com/documentation/at-rules/import/].
+    # @param alert_ascii [Boolean] If this is +true+, the compiler will exclusively use ASCII characters in its error
+    #   and warning messages. Otherwise, it may use non-ASCII Unicode characters as well.
+    # @param alert_color [Boolean] If this is +true+, the compiler will use ANSI color escape codes in its error and
+    #   warning messages. If it's +false+, it won't use these. If it's +nil+, the compiler will determine whether or
+    #   not to use colors depending on whether the user is using an interactive terminal.
+    # @param logger [Object] An object to use to handle warnings and/or debug messages from Sass.
+    # @param quiet_deps [Boolean] If this option is set to +true+, Sass won’t print warnings that are caused by
+    #   dependencies. A “dependency” is defined as any file that’s loaded through +load_paths+ or +importer+.
+    #   Stylesheets that are imported relative to the entrypoint are not considered dependencies.
+    # @param verbose [Boolean] By default, Dart Sass will print only five instances of the same deprecation warning per
+    #   compilation to avoid deluging users in console noise. If you set verbose to +true+, it will instead print every
+    #   deprecation warning it encounters.
+    # @return [CompileResult]
+    # @raise [ArgumentError, CompileError]
+    # @see https://sass-lang.com/documentation/js-api/functions/compile/
+    def compile(path,
+                load_paths: [],
+
+                charset: true,
+                source_map: false,
+                source_map_include_sources: false,
+                style: :expanded,
+
+                functions: {},
+                importers: [],
+
+                alert_ascii: false,
+                alert_color: nil,
+                logger: nil,
+                quiet_deps: false,
+                verbose: false)
+      raise ArgumentError, 'path must be set' if path.nil?
+
+      Host.new(@dispatcher).compile_request(
+        path:,
+        source: nil,
+        importer: nil,
+        load_paths:,
+        syntax: nil,
+        url: nil,
+        charset:,
+        source_map:,
+        source_map_include_sources:,
+        style:,
+        functions:,
+        importers:,
+        alert_color:,
+        alert_ascii:,
+        logger:,
+        quiet_deps:,
+        verbose:
+      )
+    end
+
+    # Compiles a stylesheet whose contents is +source+ to CSS.
+    # @param source [String]
+    # @param importer [Object] The importer to use to handle loads that are relative to the entrypoint stylesheet.
+    # @param load_paths [Array<String>] Paths in which to look for stylesheets loaded by rules like
+    #   {@use}[https://sass-lang.com/documentation/at-rules/use/] and {@import}[https://sass-lang.com/documentation/at-rules/import/].
+    # @param syntax [String, Symbol] The Syntax to use to parse the entrypoint stylesheet.
+    # @param url [String] The canonical URL of the entrypoint stylesheet. If this is passed along with +importer+, it's
+    #   used to resolve relative loads in the entrypoint stylesheet.
+    # @param charset [Boolean] By default, if the CSS document contains non-ASCII characters, Sass adds a +@charset+
+    #   declaration (in expanded output mode) or a byte-order mark (in compressed mode) to indicate its encoding to
+    #   browsers or other consumers. If +charset+ is +false+, these annotations are omitted.
+    # @param source_map [Boolean] Whether or not Sass should generate a source map.
+    # @param source_map_include_sources [Boolean] Whether Sass should include the sources in the generated source map.
+    # @param style [String, Symbol] The OutputStyle of the compiled CSS.
+    # @param functions [Hash<String, Proc>] Additional built-in Sass functions that are available in all stylesheets.
+    # @param importers [Array<Object>] Custom importers that control how Sass resolves loads from rules like
+    #   {@use}[https://sass-lang.com/documentation/at-rules/use/] and {@import}[https://sass-lang.com/documentation/at-rules/import/].
+    # @param alert_ascii [Boolean] If this is +true+, the compiler will exclusively use ASCII characters in its error
+    #   and warning messages. Otherwise, it may use non-ASCII Unicode characters as well.
+    # @param alert_color [Boolean] If this is +true+, the compiler will use ANSI color escape codes in its error and
+    #   warning messages. If it's +false+, it won't use these. If it's +nil+, the compiler will determine whether or
+    #   not to use colors depending on whether the user is using an interactive terminal.
+    # @param logger [Object] An object to use to handle warnings and/or debug messages from Sass.
+    # @param quiet_deps [Boolean] If this option is set to +true+, Sass won’t print warnings that are caused by
+    #   dependencies. A “dependency” is defined as any file that’s loaded through +load_paths+ or +importer+.
+    #   Stylesheets that are imported relative to the entrypoint are not considered dependencies.
+    # @param verbose [Boolean] By default, Dart Sass will print only five instances of the same deprecation warning per
+    #   compilation to avoid deluging users in console noise. If you set verbose to +true+, it will instead print every
+    #   deprecation warning it encounters.
+    # @return [CompileResult]
+    # @raise [ArgumentError, CompileError]
+    # @see https://sass-lang.com/documentation/js-api/functions/compilestring/
+    def compile_string(source,
+                       importer: nil,
+                       load_paths: [],
+                       syntax: :scss,
+                       url: nil,
+
+                       charset: true,
+                       source_map: false,
+                       source_map_include_sources: false,
+                       style: :expanded,
+
+                       functions: {},
+                       importers: [],
+
+                       alert_ascii: false,
+                       alert_color: nil,
+                       logger: nil,
+                       quiet_deps: false,
+                       verbose: false)
+      raise ArgumentError, 'source must be set' if source.nil?
+
+      Host.new(@dispatcher).compile_request(
+        path: nil,
+        source:,
+        importer:,
+        load_paths:,
+        syntax:,
+        url:,
+        charset:,
+        source_map:,
+        source_map_include_sources:,
+        style:,
+        functions:,
+        importers:,
+        alert_color:,
+        alert_ascii:,
+        logger:,
+        quiet_deps:,
+        verbose:
+      )
+    end
+
+    # @return [String] Information about the Sass implementation.
+    # @see https://sass-lang.com/documentation/js-api/variables/info/
+    def info
+      @info ||= Host.new(@dispatcher).version_request
+    end
+
+    def close
+      @dispatcher.close
+    end
+
+    def closed?
+      @dispatcher.closed?
+    end
+  end
+end

data/lib/sass/embedded/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Sass
-  class Embedded
-    VERSION = '1.69.4'
+  module Embedded
+    VERSION = '1.69.6'
   end
 end

data/lib/sass/embedded.rb

@@ -1,19 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'canonicalize_context'
-require_relative 'compile_error'
-require_relative 'compile_result'
-require_relative 'embedded/connection'
-require_relative 'embedded/dispatcher'
-require_relative 'embedded/host'
-require_relative 'embedded/resilient_dispatcher'
-require_relative 'embedded/varint'
+require_relative 'compiler'
 require_relative 'embedded/version'
-require_relative 'embedded_protocol'
-require_relative 'logger/silent'
-require_relative 'logger/source_location'
-require_relative 'logger/source_span'
-require_relative 'value'
 
 # The Sass module.
 #
@@ -25,224 +13,96 @@ require_relative 'value'
 # @example
 #   Sass.compile_string('h1 { font-size: 40px; }')
 module Sass
-  @instance = nil
+  @compiler = nil
   @mutex = Mutex.new
 
   # rubocop:disable Layout/LineLength
   class << self
     # Compiles the Sass file at +path+ to CSS.
     # @overload compile(path, load_paths: [], charset: true, source_map: false, source_map_include_sources: false, style: :expanded, functions: {}, importers: [], alert_ascii: false, alert_color: nil, logger: nil, quiet_deps: false, verbose: false)
-    # @param (see Embedded#compile)
-    # @return (see Embedded#compile)
-    # @raise (see Embedded#compile)
-    # @see Embedded#compile
+    # @param (see Compiler#compile)
+    # @return (see Compiler#compile)
+    # @raise (see Compiler#compile)
+    # @see Compiler#compile
     def compile(...)
-      instance.compile(...)
+      compiler.compile(...)
     end
 
     # Compiles a stylesheet whose contents is +source+ to CSS.
     # @overload compile_string(source, importer: nil, load_paths: [], syntax: :scss, url: nil, charset: true, source_map: false, source_map_include_sources: false, style: :expanded, functions: {}, importers: [], alert_ascii: false, alert_color: nil, logger: nil, quiet_deps: false, verbose: false)
-    # @param (see Embedded#compile_string)
-    # @return (see Embedded#compile_string)
-    # @raise (see Embedded#compile_string)
-    # @see Embedded#compile_string
+    # @param (see Compiler#compile_string)
+    # @return (see Compiler#compile_string)
+    # @raise (see Compiler#compile_string)
+    # @see Compiler#compile_string
     def compile_string(...)
-      instance.compile_string(...)
+      compiler.compile_string(...)
     end
 
-    # @param (see Embedded#info)
-    # @return (see Embedded#info)
-    # @raise (see Embedded#info)
-    # @see Embedded#info
+    # @param (see Compiler#info)
+    # @return (see Compiler#info)
+    # @raise (see Compiler#info)
+    # @see Compiler#info
     def info
-      instance.info
+      compiler.info
     end
 
     private
 
-    def instance
-      return @instance if @instance
+    def compiler
+      return @compiler if @compiler
 
       @mutex.synchronize do
-        return @instance if @instance
+        return @compiler if @compiler
+
+        compiler = Class.new(Compiler) do
+          def initialize
+            @dispatcher = Compiler.const_get(:ResilientDispatcher).new(Class.new(Compiler.const_get(:Dispatcher)) do
+              def initialize
+                super
+
+                idle_timeout = 10
+                @last_accessed_time = current_time
+
+                Thread.new do
+                  Thread.current.name = 'sass-embedded-process-reaper'
+                  duration = idle_timeout
+                  loop do
+                    sleep(duration.negative? ? idle_timeout : duration)
+                    break if @mutex.synchronize do
+                      raise Errno::EBUSY if _closed?
+
+                      duration = idle_timeout - (current_time - @last_accessed_time)
+                      duration.negative? && _idle? && _close
+                    end
+                  end
+                  close
+                rescue Errno::EBUSY
+                  # do nothing
+                end
+              end
+
+              private
+
+              def _idle
+                super
+
+                @last_accessed_time = current_time
+              end
+
+              def current_time
+                Process.clock_gettime(Process::CLOCK_MONOTONIC)
+              end
+            end)
+          end
+        end.new
 
-        @instance = Embedded.new
         at_exit do
-          @instance.close
+          compiler.close
         end
-      end
 
-      @instance
+        @compiler = compiler
+      end
     end
   end
   # rubocop:enable Layout/LineLength
-
-  # The {Embedded} host for using dart-sass. Each instance creates its own
-  # communication {Dispatcher} with a dedicated compiler process.
-  #
-  # @example
-  #   embedded = Sass::Embedded.new
-  #   result = embedded.compile_string('h1 { font-size: 40px; }')
-  #   result = embedded.compile('style.scss')
-  #   embedded.close
-  class Embedded
-    def initialize
-      @dispatcher = ResilientDispatcher.new
-    end
-
-    # Compiles the Sass file at +path+ to CSS.
-    # @param path [String]
-    # @param load_paths [Array<String>] Paths in which to look for stylesheets loaded by rules like
-    #   {@use}[https://sass-lang.com/documentation/at-rules/use/] and {@import}[https://sass-lang.com/documentation/at-rules/import/].
-    # @param charset [Boolean] By default, if the CSS document contains non-ASCII characters, Sass adds a +@charset+
-    #   declaration (in expanded output mode) or a byte-order mark (in compressed mode) to indicate its encoding to
-    #   browsers or other consumers. If +charset+ is +false+, these annotations are omitted.
-    # @param source_map [Boolean] Whether or not Sass should generate a source map.
-    # @param source_map_include_sources [Boolean] Whether Sass should include the sources in the generated source map.
-    # @param style [String, Symbol] The OutputStyle of the compiled CSS.
-    # @param functions [Hash<String, Proc>] Additional built-in Sass functions that are available in all stylesheets.
-    # @param importers [Array<Object>] Custom importers that control how Sass resolves loads from rules like
-    #   {@use}[https://sass-lang.com/documentation/at-rules/use/] and {@import}[https://sass-lang.com/documentation/at-rules/import/].
-    # @param alert_ascii [Boolean] If this is +true+, the compiler will exclusively use ASCII characters in its error
-    #   and warning messages. Otherwise, it may use non-ASCII Unicode characters as well.
-    # @param alert_color [Boolean] If this is +true+, the compiler will use ANSI color escape codes in its error and
-    #   warning messages. If it's +false+, it won't use these. If it's +nil+, the compiler will determine whether or
-    #   not to use colors depending on whether the user is using an interactive terminal.
-    # @param logger [Object] An object to use to handle warnings and/or debug messages from Sass.
-    # @param quiet_deps [Boolean] If this option is set to +true+, Sass won’t print warnings that are caused by
-    #   dependencies. A “dependency” is defined as any file that’s loaded through +load_paths+ or +importer+.
-    #   Stylesheets that are imported relative to the entrypoint are not considered dependencies.
-    # @param verbose [Boolean] By default, Dart Sass will print only five instances of the same deprecation warning per
-    #   compilation to avoid deluging users in console noise. If you set verbose to +true+, it will instead print every
-    #   deprecation warning it encounters.
-    # @return [CompileResult]
-    # @raise [ArgumentError, CompileError]
-    # @see https://sass-lang.com/documentation/js-api/functions/compile/
-    def compile(path,
-                load_paths: [],
-
-                charset: true,
-                source_map: false,
-                source_map_include_sources: false,
-                style: :expanded,
-
-                functions: {},
-                importers: [],
-
-                alert_ascii: false,
-                alert_color: nil,
-                logger: nil,
-                quiet_deps: false,
-                verbose: false)
-      raise ArgumentError, 'path must be set' if path.nil?
-
-      Host.new(@dispatcher).compile_request(
-        path: path,
-        source: nil,
-        importer: nil,
-        load_paths: load_paths,
-        syntax: nil,
-        url: nil,
-        charset: charset,
-        source_map: source_map,
-        source_map_include_sources: source_map_include_sources,
-        style: style,
-        functions: functions,
-        importers: importers,
-        alert_color: alert_color,
-        alert_ascii: alert_ascii,
-        logger: logger,
-        quiet_deps: quiet_deps,
-        verbose: verbose
-      )
-    end
-
-    # Compiles a stylesheet whose contents is +source+ to CSS.
-    # @param source [String]
-    # @param importer [Object] The importer to use to handle loads that are relative to the entrypoint stylesheet.
-    # @param load_paths [Array<String>] Paths in which to look for stylesheets loaded by rules like
-    #   {@use}[https://sass-lang.com/documentation/at-rules/use/] and {@import}[https://sass-lang.com/documentation/at-rules/import/].
-    # @param syntax [String, Symbol] The Syntax to use to parse the entrypoint stylesheet.
-    # @param url [String] The canonical URL of the entrypoint stylesheet. If this is passed along with +importer+, it's
-    #   used to resolve relative loads in the entrypoint stylesheet.
-    # @param charset [Boolean] By default, if the CSS document contains non-ASCII characters, Sass adds a +@charset+
-    #   declaration (in expanded output mode) or a byte-order mark (in compressed mode) to indicate its encoding to
-    #   browsers or other consumers. If +charset+ is +false+, these annotations are omitted.
-    # @param source_map [Boolean] Whether or not Sass should generate a source map.
-    # @param source_map_include_sources [Boolean] Whether Sass should include the sources in the generated source map.
-    # @param style [String, Symbol] The OutputStyle of the compiled CSS.
-    # @param functions [Hash<String, Proc>] Additional built-in Sass functions that are available in all stylesheets.
-    # @param importers [Array<Object>] Custom importers that control how Sass resolves loads from rules like
-    #   {@use}[https://sass-lang.com/documentation/at-rules/use/] and {@import}[https://sass-lang.com/documentation/at-rules/import/].
-    # @param alert_ascii [Boolean] If this is +true+, the compiler will exclusively use ASCII characters in its error
-    #   and warning messages. Otherwise, it may use non-ASCII Unicode characters as well.
-    # @param alert_color [Boolean] If this is +true+, the compiler will use ANSI color escape codes in its error and
-    #   warning messages. If it's +false+, it won't use these. If it's +nil+, the compiler will determine whether or
-    #   not to use colors depending on whether the user is using an interactive terminal.
-    # @param logger [Object] An object to use to handle warnings and/or debug messages from Sass.
-    # @param quiet_deps [Boolean] If this option is set to +true+, Sass won’t print warnings that are caused by
-    #   dependencies. A “dependency” is defined as any file that’s loaded through +load_paths+ or +importer+.
-    #   Stylesheets that are imported relative to the entrypoint are not considered dependencies.
-    # @param verbose [Boolean] By default, Dart Sass will print only five instances of the same deprecation warning per
-    #   compilation to avoid deluging users in console noise. If you set verbose to +true+, it will instead print every
-    #   deprecation warning it encounters.
-    # @return [CompileResult]
-    # @raise [ArgumentError, CompileError]
-    # @see https://sass-lang.com/documentation/js-api/functions/compilestring/
-    def compile_string(source,
-                       importer: nil,
-                       load_paths: [],
-                       syntax: :scss,
-                       url: nil,
-
-                       charset: true,
-                       source_map: false,
-                       source_map_include_sources: false,
-                       style: :expanded,
-
-                       functions: {},
-                       importers: [],
-
-                       alert_ascii: false,
-                       alert_color: nil,
-                       logger: nil,
-                       quiet_deps: false,
-                       verbose: false)
-      raise ArgumentError, 'source must be set' if source.nil?
-
-      Host.new(@dispatcher).compile_request(
-        path: nil,
-        source: source,
-        importer: importer,
-        load_paths: load_paths,
-        syntax: syntax,
-        url: url,
-        charset: charset,
-        source_map: source_map,
-        source_map_include_sources: source_map_include_sources,
-        style: style,
-        functions: functions,
-        importers: importers,
-        alert_color: alert_color,
-        alert_ascii: alert_ascii,
-        logger: logger,
-        quiet_deps: quiet_deps,
-        verbose: verbose
-      )
-    end
-
-    # @return [String] Information about the Sass implementation.
-    # @see https://sass-lang.com/documentation/js-api/variables/info/
-    def info
-      @info ||= Host.new(@dispatcher).version_request
-    end
-
-    def close
-      @dispatcher.close
-    end
-
-    def closed?
-      @dispatcher.closed?
-    end
-  end
 end

data/lib/sass/exception.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Sass
+  # An exception thrown because a Sass compilation failed.
+  class CompileError < StandardError
+    # @return [String, nil]
+    attr_reader :sass_stack
+
+    # @return [Logger::SourceSpan, nil]
+    attr_reader :span
+
+    # @return [Array<String>]
+    attr_reader :loaded_urls
+
+    # @!visibility private
+    def initialize(message, full_message, sass_stack, span, loaded_urls)
+      super(message)
+
+      @full_message = full_message
+      @sass_stack = sass_stack
+      @span = span
+      @loaded_urls = loaded_urls
+    end
+
+    # @return [String]
+    def full_message(highlight: nil, order: nil, **)
+      return super if @full_message.nil?
+
+      highlight = Exception.respond_to?(:to_tty?) && Exception.to_tty? if highlight.nil?
+      if highlight
+        +@full_message
+      else
+        @full_message.gsub(/\e\[[0-9;]*m/, '')
+      end
+    end
+
+    # @return [String]
+    def to_css
+      content = full_message(highlight: false, order: :top)
+
+      <<~CSS
+        /* #{content.gsub('*/', "*\u2060/").gsub("\r\n", "\n").split("\n").join("\n * ")} */
+
+        body::before {
+          position: static;
+          display: block;
+          padding: 1em;
+          margin: 0 0 1em;
+          border-width: 0 0 2px;
+          border-bottom-style: solid;
+          font-family: monospace, monospace;
+          white-space: pre;
+          content: #{Serializer.dump_quoted_string(content)};
+        }
+      CSS
+    end
+  end
+
+  # An exception thrown by Sass Script.
+  class ScriptError < StandardError
+    def initialize(message, name = nil)
+      super(name.nil? ? message : "$#{name}: #{message}")
+    end
+  end
+end

data/lib/sass/fork_tracker.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Sass
+  # The {ForkTracker} module.
+  #
+  # It tracks objects that need to be closed after `Process.fork`.
+  module ForkTracker
+    HASH = {}.compare_by_identity
+
+    MUTEX = Mutex.new
+
+    private_constant :HASH, :MUTEX
+
+    module_function
+
+    def add(obj)
+      MUTEX.synchronize do
+        HASH[obj] = true
+      end
+    end
+
+    def delete(obj)
+      MUTEX.synchronize do
+        HASH.delete(obj)
+      end
+    end
+
+    def each(...)
+      MUTEX.synchronize do
+        HASH.keys
+      end.each(...)
+    end
+
+    # The {CoreExt} module.
+    #
+    # It closes objects after `Process.fork`.
+    module CoreExt
+      def _fork
+        pid = super
+        ForkTracker.each(&:close) if pid.zero?
+        pid
+      end
+    end
+
+    private_constant :CoreExt
+
+    Process.singleton_class.prepend(CoreExt)
+  end
+
+  private_constant :ForkTracker
+end