sass-embedded 1.6.2 → 1.83.1

data/lib/sass/embedded.rb

@@ -1,22 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../ext/sass/embedded'
-require_relative '../../ext/sass/embedded_sass_pb'
-require_relative 'compile_error'
-require_relative 'compile_result'
-require_relative 'embedded/async'
-require_relative 'embedded/channel'
-require_relative 'embedded/compiler'
-require_relative 'embedded/dispatcher'
-require_relative 'embedded/host'
-require_relative 'embedded/protofier'
-require_relative 'embedded/structifier'
-require_relative 'embedded/varint'
-require_relative 'embedded/version'
-require_relative 'logger/silent'
-require_relative 'logger/source_location'
-require_relative 'logger/source_span'
-require_relative 'value'
+require_relative 'compiler'
 
 # The Sass module.
 #
@@ -28,208 +12,96 @@ require_relative 'value'
 # @example
 #   Sass.compile_string('h1 { font-size: 40px; }')
 module Sass
+  @compiler = nil
+  @mutex = Mutex.new
+
+  # rubocop:disable Layout/LineLength
   class << self
     # Compiles the Sass file at +path+ to CSS.
-    # @param (see Embedded#compile)
-    # @return (see Embedded#compile)
-    # @raise (see Embedded#compile)
-    # @see Embedded#compile
-    def compile(path, **kwargs)
-      instance.compile(path, **kwargs)
+    # @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, fatal_deprecations: [], future_deprecations: [], logger: nil, quiet_deps: false, silence_deprecations: [], verbose: false)
+    # @param (see Compiler#compile)
+    # @return (see Compiler#compile)
+    # @raise (see Compiler#compile)
+    # @see Compiler#compile
+    def compile(...)
+      compiler.compile(...)
     end
 
     # Compiles a stylesheet whose contents is +source+ to CSS.
-    # @param (see Embedded#compile_string)
-    # @return (see Embedded#compile_string)
-    # @raise (see Embedded#compile_string)
-    # @see Embedded#compile_string
-    def compile_string(source, **kwargs)
-      instance.compile_string(source, **kwargs)
+    # @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, fatal_deprecations: [], future_deprecations: [], logger: nil, quiet_deps: false, silence_deprecations: [], verbose: false)
+    # @param (see Compiler#compile_string)
+    # @return (see Compiler#compile_string)
+    # @raise (see Compiler#compile_string)
+    # @see Compiler#compile_string
+    def 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
-      if defined? @instance
-        @instance = Embedded.new if @instance.closed?
-      else
-        @instance = Embedded.new
+    def compiler
+      return @compiler if @compiler
+
+      @mutex.synchronize do
+        return @compiler if @compiler
+
+        compiler = Class.new(Compiler) do
+          def initialize
+            @channel = Compiler.const_get(:Channel).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-connection-reaper-#{@connection.id}"
+                  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
+
         at_exit do
-          @instance.close
+          compiler.close
         end
-      end
-      @instance
-    end
-  end
-
-  # The {Embedded} host for using dart-sass-embedded. Each instance creates
-  # its own communication {Channel} 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
-      @channel = Channel.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 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 [CompileError]
-    # @see https://sass-lang.com/documentation/js-api/modules#compile
-    def compile(path,
-                load_paths: [],
-
-                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?
-
-      Protofier.from_proto_compile_response(
-        Host.new(@channel).compile_request(
-          path: path,
-          source: nil,
-          importer: nil,
-          load_paths: load_paths,
-          syntax: nil,
-          url: nil,
-          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 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 [CompileError]
-    # @see https://sass-lang.com/documentation/js-api/modules#compileString
-    def compile_string(source,
-                       importer: nil,
-                       load_paths: [],
-                       syntax: :scss,
-                       url: nil,
-
-                       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?
-
-      Protofier.from_proto_compile_response(
-        Host.new(@channel).compile_request(
-          path: nil,
-          source: source,
-          importer: importer,
-          load_paths: load_paths,
-          syntax: syntax,
-          url: url,
-          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/modules#info
-    def info
-      @info ||= "sass-embedded\t#{Host.new(@channel).version_request.implementation_version}"
-    end
-
-    def close
-      @channel.close
-    end
-
-    def closed?
-      @channel.closed?
+        @compiler = compiler
+      end
     end
   end
+  # rubocop:enable Layout/LineLength
 end

data/lib/sass/embedded_protocol.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Sass
+  # @see https://github.com/sass/sass/blob/HEAD/spec/embedded-protocol.md
+  module EmbeddedProtocol
+    require_relative '../../ext/sass/embedded_sass_pb'
+  end
+
+  private_constant :EmbeddedProtocol
+end

data/lib/sass/exception.rb

@@ -0,0 +1,74 @@
+# 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.to_tty? if highlight.nil?
+      if highlight
+        @full_message.dup
+      else
+        @full_message.gsub(/\e\[[0-9;]*m/, '')
+      end
+    end
+
+    # @return [String]
+    def to_css
+      content = full_message(highlight: false, order: :top)
+
+      <<~CSS.freeze
+        /* #{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.serialize_quoted_string(content).gsub(/[^[:ascii:]][\h\t ]?/) do |match|
+            ordinal = match.ord
+            replacement = "\\#{ordinal.to_s(16)}"
+            if match.length > 1
+              replacement << ' ' if ordinal < 0x100000
+              replacement << match[1]
+            end
+            replacement
+          end};
+        }
+      CSS
+    end
+  end
+
+  # An exception thrown by Sass Script.
+  class ScriptError < StandardError
+    # @!visibility private
+    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) if Process.respond_to?(:_fork)
+  end
+
+  private_constant :ForkTracker
+end

data/lib/sass/logger/silent.rb

@@ -3,11 +3,13 @@
 module Sass
   # A namespace for built-in Loggers.
   #
-  # @see https://sass-lang.com/documentation/js-api/modules/Logger
+  # @see https://sass-lang.com/documentation/js-api/modules/logger/
   module Logger
     module_function
 
     # A Logger that silently ignores all warnings and debug messages.
+    #
+    # @see https://sass-lang.com/documentation/js-api/variables/logger.silent/
     def silent
       Silent
     end
@@ -16,9 +18,9 @@ module Sass
     module Silent
       module_function
 
-      def warn(message, deprecation: false, span: nil, stack: nil); end
+      def warn(message, options); end
 
-      def debug(message, span: nil); end
+      def debug(message, options); end
     end
 
     private_constant :Silent

data/lib/sass/logger/source_location.rb

@@ -6,15 +6,16 @@ module Sass
     #
     # This is always associated with a {SourceSpan} which indicates which file it refers to.
     #
-    # @see https://sass-lang.com/documentation/js-api/interfaces/SourceLocation
+    # @see https://sass-lang.com/documentation/js-api/interfaces/sourcelocation/
     class SourceLocation
       # @return [Integer]
       attr_reader :offset, :line, :column
 
-      def initialize(offset, line, column)
-        @offset = offset
-        @line = line
-        @column = column
+      # @!visibility private
+      def initialize(source_location)
+        @offset = source_location.offset
+        @line = source_location.line
+        @column = source_location.column
       end
     end
   end

data/lib/sass/logger/source_span.rb

@@ -4,7 +4,7 @@ module Sass
   module Logger
     # A span of text within a source file.
     #
-    # @see https://sass-lang.com/documentation/js-api/interfaces/SourceSpan
+    # @see https://sass-lang.com/documentation/js-api/interfaces/sourcespan/
     class SourceSpan
       # @return [SourceLocation]
       attr_reader :start, :end
@@ -15,12 +15,13 @@ module Sass
       # @return [String, nil]
       attr_reader :url, :context
 
-      def initialize(start, end_, text, url, context)
-        @start = start
-        @end = end_
-        @text = text
-        @url = url == '' ? nil : url
-        @context = context == '' ? nil : context
+      # @!visibility private
+      def initialize(source_span)
+        @start = source_span.start.nil? ? nil : Logger::SourceLocation.new(source_span.start)
+        @end = source_span.end.nil? ? nil : Logger::SourceLocation.new(source_span.end)
+        @text = source_span.text
+        @url = source_span.url == '' ? nil : source_span.url
+        @context = source_span.context == '' ? nil : source_span.context
       end
     end
   end

data/lib/sass/node_package_importer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Sass
+  # The built-in Node.js package importer. This loads pkg: URLs from node_modules
+  # according to the standard Node.js resolution algorithm.
+  #
+  # @see https://sass-lang.com/documentation/js-api/classes/nodepackageimporter/
+  class NodePackageImporter
+    # @param entry_point_directory [String] The directory where the {NodePackageImporter} should start when resolving
+    #   `pkg:` URLs in sources other than files on disk.
+    def initialize(entry_point_directory)
+      raise ArgumentError, 'entry_point_directory must be set' if entry_point_directory.nil?
+
+      @entry_point_directory = File.absolute_path(entry_point_directory)
+    end
+  end
+end

data/lib/sass/serializer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Sass
+  # The {Serializer} module.
+  module Serializer
+    module_function
+
+    CSS_ESCAPE = [*"\x01".."\x08", *"\x0A".."\x1F", "\x7F"]
+                 .product([*'0'..'9', *'a'..'f', *'A'..'F', "\t", ' ', nil])
+                 .each_with_object({ "\0" => "\uFFFD", '\\' => '\\\\', '"' => '\\"', "'" => "\\'" }) do |(c, x), h|
+                   h["#{c}#{x}".freeze] = "\\#{c.ord.to_s(16)}#{" #{x}" if x}".freeze
+                 end.freeze
+
+    private_constant :CSS_ESCAPE
+
+    def serialize_quoted_string(string)
+      if !string.include?('"') || string.include?("'")
+        %("#{string.gsub(/[\0\\"]|[\x01-\x08\x0A-\x1F\x7F][\h\t ]?/, CSS_ESCAPE)}")
+      else
+        %('#{string.gsub(/[\0\\']|[\x01-\x08\x0A-\x1F\x7F][\h\t ]?/, CSS_ESCAPE)}')
+      end
+    end
+
+    def serialize_unquoted_string(string)
+      string.tr("\0", "\uFFFD").gsub(/\n */, ' ')
+    end
+  end
+
+  private_constant :Serializer
+end

data/lib/sass/value/argument_list.rb

@@ -7,24 +7,31 @@ module Sass
     # An argument list comes from a rest argument. It's distinct from a normal {List} in that it may contain a keyword
     # map as well as the positional arguments.
     #
-    # @see https://sass-lang.com/documentation/js-api/classes/SassArgumentList
-    class ArgumentList < Value::List
+    # @see https://sass-lang.com/documentation/js-api/classes/sassargumentlist/
+    class ArgumentList < List
       # @param contents [Array<Value>]
-      # @param keywords [Hash<::String, Value>]
+      # @param keywords [Hash<Symbol, Value>]
       # @param separator [::String]
       def initialize(contents = [], keywords = {}, separator = ',')
-        super(contents, separator: separator)
+        super(contents, separator:)
 
         @id = 0
         @keywords_accessed = false
-        @keywords = keywords.transform_keys(&:to_s).freeze
+        @keywords = keywords.freeze
       end
 
-      # @return [Hash<::String, Value>]
+      # @return [Hash<Symbol, Value>]
       def keywords
         @keywords_accessed = true
         @keywords
       end
+
+      private
+
+      def initialize_dup(orig)
+        @id = 0
+        super
+      end
     end
   end
 end

data/lib/sass/value/boolean.rb

@@ -4,7 +4,7 @@ module Sass
   module Value
     # Sass's boolean type.
     #
-    # @see https://sass-lang.com/documentation/js-api/classes/SassBoolean
+    # @see https://sass-lang.com/documentation/js-api/classes/sassboolean/
     class Boolean
       include Value