sass-embedded 0.13.4 → 0.16.1

data/lib/sass/embedded/{render.rb → legacy.rb}

@@ -3,9 +3,50 @@
 require 'base64'
 require 'json'
 require 'pathname'
-require_relative 'url'
+require 'uri'
 
+# The Sass module.
+#
+# This communicates with Embedded Dart Sass using the Embedded Sass protocol.
 module Sass
+  class << self
+    # @deprecated
+    # The global {.include_paths} for Sass files. This is meant for plugins and
+    # libraries to register the paths to their Sass stylesheets to that they may
+    # be included via `@import` or `@use`. This include path is used by every
+    # instance of {Sass::Embedded}. They are lower-precedence than any include
+    # paths passed in via the `include_paths` option.
+    #
+    # If the `SASS_PATH` environment variable is set,
+    # the initial value of `include_paths` will be initialized based on that.
+    # The variable should be a colon-separated list of path names
+    # (semicolon-separated on Windows).
+    #
+    # @example
+    #   Sass.include_paths << File.dirname(__FILE__) + '/sass'
+    # @return [Array]
+    def include_paths
+      Embedded.include_paths
+    end
+
+    # @deprecated
+    # The global {.render} method. This instantiates a global {Embedded} instance
+    # and calls {Embedded#render}.
+    #
+    # See {Embedded#render} for supported options.
+    #
+    # @example
+    #   Sass.render(data: 'h1 { font-size: 40px; }')
+    # @example
+    #   Sass.render(file: 'style.css')
+    # @return [Result]
+    # @raise [ProtocolError]
+    # @raise [RenderError]
+    def render(**kwargs)
+      instance.render(**kwargs)
+    end
+  end
+
   # The {Embedded} host for using dart-sass-embedded. Each instance creates
   # its own {Channel}.
   #
@@ -309,11 +350,17 @@ module Sass
         raise result if result.is_a? StandardError
 
         if result&.key? :contents
-          @importer_results[canonical_url] = ImporterResult.new(result[:contents], :scss)
+          @importer_results[canonical_url] = {
+            contents: result[:contents],
+            syntax: :scss
+          }
           canonical_url
         elsif result&.key? :file
           canonical_url = Url.path_to_file_url(File.absolute_path(result[:file]))
-          @importer_results[canonical_url] = ImporterResult.new(File.read(result[:file]), :scss)
+          @importer_results[canonical_url] = {
+            contents: File.read(result[:file]),
+            syntax: :scss
+          }
           canonical_url
         end
       end
@@ -323,6 +370,35 @@ module Sass
       end
     end
 
+    # @deprecated
+    # The {Url} module.
+    module Url
+      # The {::URI::Parser} that is in consistent with RFC 2396 (URI Generic Syntax) and dart:core library.
+      URI_PARSER = URI::Parser.new({ RESERVED: ';/?:@&=+$,' })
+
+      FILE_SCHEME = 'file://'
+
+      private_constant :URI_PARSER, :FILE_SCHEME
+
+      module_function
+
+      def path_to_file_url(path)
+        if File.absolute_path? path
+          URI_PARSER.escape "#{FILE_SCHEME}#{Gem.win_platform? ? '/' : ''}#{path}"
+        else
+          URI_PARSER.escape path
+        end
+      end
+
+      def file_url_to_path(url)
+        if url.start_with? FILE_SCHEME
+          URI_PARSER.unescape url[(FILE_SCHEME.length + (Gem.win_platform? ? 1 : 0))..]
+        else
+          URI_PARSER.unescape url
+        end
+      end
+    end
+
     private_constant :LegacyImporter
   end
 end

data/lib/sass/embedded/observer.rb

@@ -43,5 +43,7 @@ module Sass
         @subscription.send_message(*args)
       end
     end
+
+    private_constant :Observer
   end
 end

data/lib/sass/embedded/protofier.rb

@@ -0,0 +1,329 @@
+# frozen_string_literal: true
+
+module Sass
+  class Embedded
+    # The {Protofier} between Pure Ruby types and Protobuf Ruby types.
+    class Protofier
+      ONEOF_MESSAGE = EmbeddedProtocol::InboundMessage
+                      .descriptor
+                      .lookup_oneof('message')
+                      .to_h do |field_descriptor|
+        [field_descriptor.subtype, field_descriptor.name]
+      end
+
+      private_constant :ONEOF_MESSAGE
+
+      def initialize(function_registry)
+        @function_registry = function_registry
+      end
+
+      def to_proto_value(obj)
+        case obj
+        when Sass::Value::String
+          Sass::EmbeddedProtocol::Value.new(
+            string: Sass::EmbeddedProtocol::Value::String.new(
+              text: obj.text,
+              quoted: obj.quoted?
+            )
+          )
+        when Sass::Value::Number
+          Sass::EmbeddedProtocol::Value.new(
+            number: Sass::EmbeddedProtocol::Value::Number.new(
+              value: obj.value.to_f,
+              numerators: obj.numerator_units,
+              denominators: obj.denominator_units
+            )
+          )
+        when Sass::Value::Color
+          if obj.instance_eval { @hue.nil? }
+            Sass::EmbeddedProtocol::Value.new(
+              rgb_color: Sass::EmbeddedProtocol::Value::RgbColor.new(
+                red: obj.red,
+                green: obj.green,
+                blue: obj.blue,
+                alpha: obj.alpha.to_f
+              )
+            )
+          elsif obj.instance_eval { @saturation.nil? }
+            Sass::EmbeddedProtocol::Value.new(
+              hwb_color: Sass::EmbeddedProtocol::Value::HwbColor.new(
+                hue: obj.hue.to_f,
+                whiteness: obj.whiteness.to_f,
+                blackness: obj.blackness.to_f,
+                alpha: obj.alpha.to_f
+              )
+            )
+          else
+            Sass::EmbeddedProtocol::Value.new(
+              hsl_color: Sass::EmbeddedProtocol::Value::HslColor.new(
+                hue: obj.hue.to_f,
+                saturation: obj.saturation.to_f,
+                lightness: obj.lightness.to_f,
+                alpha: obj.alpha.to_f
+              )
+            )
+          end
+        when Sass::Value::ArgumentList
+          Sass::EmbeddedProtocol::Value.new(
+            argument_list: Sass::EmbeddedProtocol::Value::ArgumentList.new(
+              id: obj.instance_eval { @id },
+              contents: obj.contents.map { |element| to_proto_value(element) },
+              keywords: obj.keywords.transform_values { |value| to_proto_value(value) },
+              separator: to_proto_separator(obj.separator)
+            )
+          )
+        when Sass::Value::List
+          Sass::EmbeddedProtocol::Value.new(
+            list: Sass::EmbeddedProtocol::Value::List.new(
+              contents: obj.contents.map { |element| to_proto_value(element) },
+              separator: to_proto_separator(obj.separator),
+              has_brackets: obj.bracketed?
+            )
+          )
+        when Sass::Value::Map
+          Sass::EmbeddedProtocol::Value.new(
+            map: Sass::EmbeddedProtocol::Value::Map.new(
+              entries: obj.contents.map do |key, value|
+                Sass::EmbeddedProtocol::Value::Map::Entry.new(
+                  key: to_proto_value(key),
+                  value: to_proto_value(value)
+                )
+              end
+            )
+          )
+        when Sass::Value::Function
+          if obj.id
+            Sass::EmbeddedProtocol::Value.new(
+              compiler_function: Sass::EmbeddedProtocol::Value::CompilerFunction.new(
+                id: obj.id
+              )
+            )
+          else
+            Sass::EmbeddedProtocol::Value.new(
+              host_function: Sass::EmbeddedProtocol::Value::HostFunction.new(
+                id: @function_registry.register(obj.callback),
+                signature: obj.signature
+              )
+            )
+          end
+        when Sass::Value::Boolean
+          Sass::EmbeddedProtocol::Value.new(
+            singleton: obj.value ? :TRUE : :FALSE
+          )
+        when Sass::Value::Null
+          Sass::EmbeddedProtocol::Value.new(
+            singleton: :NULL
+          )
+        else
+          raise Sass::ScriptError, "Unknown Sass::Value #{obj}"
+        end
+      end
+
+      def from_proto_value(proto)
+        value = proto.method(proto.value).call
+        case proto.value
+        when :string
+          Sass::Value::String.new(
+            value.text,
+            quoted: value.quoted
+          )
+        when :number
+          Sass::Value::Number.new(
+            value.value,
+            value.numerators,
+            value.denominators
+          )
+        when :rgb_color
+          Sass::Value::Color.new(
+            red: value.red,
+            green: value.green,
+            blue: value.blue,
+            alpha: value.alpha
+          )
+        when :hsl_color
+          Sass::Value::Color.new(
+            hue: value.hue,
+            saturation: value.saturation,
+            lightness: value.lightness,
+            alpha: value.alpha
+          )
+        when :hwb_color
+          Sass::Value::Color.new(
+            hue: value.hue,
+            whiteness: value.whiteness,
+            blackness: value.blackness,
+            alpha: value.alpha
+          )
+        when :argument_list
+          Sass::Value::ArgumentList.new(
+            value.contents.map do |i|
+              from_proto_value(i)
+            end,
+            value.keywords.entries.to_h do |entry|
+              [entry.first, from_proto_value(entry.last)]
+            end,
+            from_proto_separator(value.separator)
+          ).instance_eval do
+            @id = value.id
+            self
+          end
+        when :list
+          Sass::Value::List.new(
+            value.contents.map do |element|
+              from_proto_value(element)
+            end,
+            separator: from_proto_separator(value.separator),
+            bracketed: value.has_brackets
+          )
+        when :map
+          Sass::Value::Map.new(
+            value.entries.to_h do |entry|
+              [from_proto_value(entry.key), from_proto_value(entry.value)]
+            end
+          )
+        when :compiler_function
+          Sass::Value::Function.new(value.id)
+        when :host_function
+          raise ProtocolError, 'The compiler may not send Value.host_function to host'
+        when :singleton
+          case value
+          when :TRUE
+            Sass::Value::Boolean::TRUE
+          when :FALSE
+            Sass::Value::Boolean::FALSE
+          when :NULL
+            Sass::Value::Null::NULL
+          else
+            raise Sass::ScriptError "Unknown Value.singleton #{value}"
+          end
+        else
+          raise Sass::ScriptError, "Unknown Value.value #{value}"
+        end
+      end
+
+      private
+
+      def to_proto_separator(separator)
+        case separator
+        when ','
+          :COMMA
+        when ' '
+          :SPACE
+        when '/'
+          :SLASH
+        when nil
+          :UNDECIDED
+        else
+          raise Sass::ScriptError, "Unknown ListSeparator #{separator}"
+        end
+      end
+
+      def from_proto_separator(separator)
+        case separator
+        when :COMMA
+          ','
+        when :SPACE
+          ' '
+        when :SLASH
+          '/'
+        when :UNDECIDED
+          nil
+        else
+          raise Sass::ScriptError, "Unknown ListSeparator #{separator}"
+        end
+      end
+
+      class << self
+        def from_proto_compile_response(compile_response)
+          if compile_response.result == :failure
+            raise CompileError.new(
+              compile_response.failure.formatted || compile_response.failure.message,
+              compile_response.failure.message,
+              compile_response.failure.stack_trace,
+              from_proto_source_span(compile_response.failure.span)
+            )
+          end
+
+          CompileResult.new(
+            compile_response.success.css,
+            compile_response.success.source_map,
+            compile_response.success.loaded_urls
+          )
+        end
+
+        def from_proto_source_span(source_span)
+          return nil if source_span.nil?
+
+          Logger::SourceSpan.new(from_proto_source_location(source_span.start),
+                                 from_proto_source_location(source_span.end),
+                                 source_span.text,
+                                 source_span.url,
+                                 source_span.context)
+        end
+
+        def from_proto_source_location(source_location)
+          return nil if source_location.nil?
+
+          Logger::SourceLocation.new(source_location.offset,
+                                     source_location.line,
+                                     source_location.column)
+        end
+
+        def from_proto_message(proto)
+          message = EmbeddedProtocol::OutboundMessage.decode(proto)
+          message.method(message.message).call
+        end
+
+        def to_proto_message(message)
+          EmbeddedProtocol::InboundMessage.new(
+            ONEOF_MESSAGE[message.class.descriptor] => message
+          ).to_proto
+        end
+
+        def to_proto_syntax(syntax)
+          case syntax&.to_sym
+          when :scss
+            EmbeddedProtocol::Syntax::SCSS
+          when :indented
+            EmbeddedProtocol::Syntax::INDENTED
+          when :css
+            EmbeddedProtocol::Syntax::CSS
+          else
+            raise ArgumentError, 'syntax must be one of :scss, :indented, :css'
+          end
+        end
+
+        def to_proto_output_style(style)
+          case style&.to_sym
+          when :expanded
+            EmbeddedProtocol::OutputStyle::EXPANDED
+          when :compressed
+            EmbeddedProtocol::OutputStyle::COMPRESSED
+          else
+            raise ArgumentError, 'style must be one of :expanded, :compressed'
+          end
+        end
+
+        def to_struct(obj)
+          return obj unless obj.is_a? Hash
+
+          struct = Object.new
+          obj.each do |key, value|
+            if value.respond_to? :call
+              struct.define_singleton_method key.to_sym do |*args, **kwargs|
+                value.call(*args, **kwargs)
+              end
+            else
+              struct.define_singleton_method key.to_sym do
+                value
+              end
+            end
+          end
+          struct
+        end
+      end
+    end
+
+    private_constant :Protofier
+  end
+end

data/lib/sass/embedded/version.rb

@@ -2,6 +2,6 @@
 
 module Sass
   class Embedded
-    VERSION = '0.13.4'
+    VERSION = '0.16.1'
   end
 end

data/lib/sass/embedded/version_context.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../embedded_protocol'
-require_relative 'observer'
-
 module Sass
   class Embedded
     # The {Observer} for {Embedded#info}.
@@ -32,5 +29,7 @@ module Sass
         end
       end
     end
+
+    private_constant :VersionContext
   end
 end

data/lib/sass/embedded.rb

@@ -1,19 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'compile_error'
-require_relative 'compile_result'
-require_relative 'embedded/channel'
-require_relative 'embedded/compile_context'
-require_relative 'embedded/render'
-require_relative 'embedded/url'
-require_relative 'embedded/version'
-require_relative 'embedded/version_context'
-require_relative 'importer_result'
-require_relative 'logger'
-
 module Sass
   # The {Embedded} host for using dart-sass-embedded. Each instance creates
-  # its own {Channel}.
+  # its own communication {Channel} with a dedicated compiler process.
   #
   # @example
   #   embedded = Sass::Embedded.new
@@ -48,27 +37,25 @@ module Sass
 
       raise ArgumentError, 'path must be set' if path.nil?
 
-      message = CompileContext.new(@channel,
-                                   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).receive_message
-
-      raise CompileError.from_proto(message.failure) if message.failure
-
-      CompileResult.from_proto(message.success)
+      Protofier.from_proto_compile_response(
+        CompileContext.new(@channel,
+                           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).receive_message
+      )
     end
 
     # The {Embedded#compile_string} method.
@@ -96,27 +83,25 @@ module Sass
                        verbose: false)
       raise ArgumentError, 'source must be set' if source.nil?
 
-      message = CompileContext.new(@channel,
-                                   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).receive_message
-
-      raise CompileError.from_proto(message.failure) if message.failure
-
-      CompileResult.from_proto(message.success)
+      Protofier.from_proto_compile_response(
+        CompileContext.new(@channel,
+                           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).receive_message
+      )
     end
 
     # The {Embedded#info} method.

data/lib/sass/embedded_protocol.rb

@@ -1,9 +1,3 @@
 # frozen_string_literal: true
 
 require_relative '../../ext/sass/embedded_sass_pb'
-
-module Sass
-  module EmbeddedProtocol
-    PROTOCOL_ERROR_ID = 4_294_967_295
-  end
-end

data/lib/sass/logger/source_location.rb

@@ -2,7 +2,9 @@
 
 module Sass
   module Logger
-    # The {SourceLocation} in {SourceSpan}.
+    # A specific location within a source file.
+    #
+    # This is always associated with a {SourceSpan} which indicates which file it refers to.
     class SourceLocation
       attr_reader :offset, :line, :column
 
@@ -11,14 +13,6 @@ module Sass
         @line = line
         @column = column
       end
-
-      def self.from_proto(source_location)
-        return nil if source_location.nil?
-
-        SourceLocation.new(source_location.offset,
-                           source_location.line,
-                           source_location.column)
-      end
     end
   end
 end

data/lib/sass/logger/source_span.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'source_location'
-
 module Sass
   module Logger
-    # The {SourceSpan} in {CompileError}.
+    # A span of text within a source file.
     class SourceSpan
       attr_reader :start, :end, :text, :url, :context
 
@@ -15,16 +13,6 @@ module Sass
         @url = url == '' ? nil : url
         @context = context == '' ? nil : context
       end
-
-      def self.from_proto(source_span)
-        return nil if source_span.nil?
-
-        SourceSpan.new(SourceLocation.from_proto(source_span.start),
-                       SourceLocation.from_proto(source_span.end),
-                       source_span.text,
-                       source_span.url,
-                       source_span.context)
-      end
     end
   end
 end

data/lib/sass/logger.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 module Sass
-  # The {Logger} module.
+  # A namespace for built-in Loggers.
   module Logger
     module_function
 
-    # The instance of a silent {Logger}.
+    # A Logger that silently ignores all warnings and debug messages.
     def silent
       Silent
     end
 
-    # The silent {Logger}.
+    # A Logger that silently ignores all warnings and debug messages.
     module Silent
       module_function
 

data/lib/sass/script_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Sass
+  class ScriptError < StandardError; end
+end