sass-embedded 0.1.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8152265aec1c4adf4ec89b826191a97f202b14bf86cf4093e679f8c24cd2d5af
-  data.tar.gz: 7b0d5d870ed38bf59562f617ad75cf2a3085704e0cc802989d21e15e9f14ee9b
+  metadata.gz: e345b143aa337d47b0f28d6d58d2a5636f84fb69b4f5ed739b6613ab39327a2d
+  data.tar.gz: 72c0bae0108414a5a989ea6b2f5eac86406eb83faa9c3fa1f1f642e609930afd
 SHA512:
-  metadata.gz: 0d037a1fe518298f2976d99d947544642325fa763315e539115422fb78b0f185d35f6c3b97cb97ec373ae04b70984f772f3915ec35974a450095e1f5f3366d88
-  data.tar.gz: 3844e6926954c302259f55a609e2e63a971c472580026ada05d13753dbebb4fb7bc4a13299c47b93a643b9fceaf742063e8a8b7b78f4ae541408eb4041e877b0
+  metadata.gz: 478a33de83120ace9665efd401d9988a956a291ed19b905f77d129486fd3e796bb90a66d6e3ee4f8f1fde47eddbb285918e84f5d8795d2a9f3546c82c431ef88
+  data.tar.gz: d9512132067039d511bafc684132ae010238b0b7b9ad1c37e3d7c6a4cb6463caa620eed87b05af3fc671c9200246f81af591b82d8c0d01b38429cafb87667394

data/.github/workflows/build.yml

@@ -27,16 +27,13 @@ jobs:
         bundler-cache: true
 
     - name: Download dart-sass-embedded
-      run: bundle exec rake download
+      run: bundle exec rake extconf
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     - name: Test
       run: bundle exec rake
 
-    - name: Build Gem
-      run: rake build
-
     - name: Install Gem
       run: rake install
       env:

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/README.md

@@ -1,5 +1,7 @@
 # Embedded Sass Host for Ruby
 
+[![build](https://github.com/ntkme/embedded-host-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/ntkme/embedded-host-ruby/actions/workflows/build.yml)
+
 This is a Ruby library that implements the host side of the [Embedded Sass protocol](https://github.com/sass/sass-embedded-protocol).
 
 It exposes a Ruby API for Sass that's backed by a native [Dart Sass](https://sass-lang.com/dart-sass) executable.

data/Rakefile

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 task default: :test
 
 desc 'Download dart-sass-embedded'
-task :download do
-  require_relative 'ext/sass_embedded/extconf'
+task :extconf do
+  system('make', '-C', 'ext', 'distclean')
+  require_relative 'ext/extconf'
+  system('make', '-C', 'ext')
 end
 
 desc 'Run all tests'
 task :test do
   $LOAD_PATH.unshift('lib', 'test')
-  Dir.glob('./test/**/*_test.rb') { |f| require f }
+  Dir.glob('./test/**/*_test.rb').sort.each { |f| require f }
 end

data/ext/Makefile

@@ -0,0 +1,51 @@
+ifeq ($(OS),Windows_NT)
+RM = cmd /c del /f /q /s
+else
+RM = rm -fr
+endif
+EXTCONF = ruby -- extconf.rb --without-sass-embedded --without-sass-embedded-protocol --without-protoc
+
+.PHONY: all
+all: sass_embedded embedded_sass_pb.rb
+
+.PHONY: install
+install:
+
+.PHONY: clean
+clean:
+	$(RM) embedded_sass_pb.rb protoc sass_embedded
+
+.PHONY: distclean
+distclean: clean
+	$(RM) embedded_sass.proto protoc-*.zip sass_embedded-*.tar.gz
+
+ifeq ($(OS),Windows_NT)
+sass_embedded-*.zip:
+else
+sass_embedded-*.tar.gz:
+endif
+	$(EXTCONF) --with-sass-embedded
+
+ifeq ($(OS),Windows_NT)
+sass_embedded: sass_embedded-*.zip
+	powershell -c "Get-Item $< | Expand-Archive -DestinationPath . -Force"
+else
+sass_embedded: sass_embedded-*.tar.gz
+	tar -vxzf $<
+endif
+
+protoc-*.zip:
+	$(EXTCONF) --with-protoc
+
+protoc: protoc-*.zip
+ifeq ($(OS),Windows_NT)
+	powershell -c "Get-Item $< | Expand-Archive -DestinationPath $@ -Force"
+else
+	unzip -od $@ $<
+endif
+
+embedded_sass.proto:
+	$(EXTCONF) --with-sass-embedded-protocol
+
+%_pb.rb: %.proto protoc
+	./protoc/bin/protoc --ruby_out=. $<

data/ext/extconf.rb

@@ -0,0 +1,159 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'mkmf'
+require 'json'
+require 'open-uri'
+require 'fileutils'
+require_relative '../lib/sass/platform'
+
+module Sass
+  class Extconf
+    def initialize
+      get_with_config('sass-embedded', true) { latest_sass_embedded }
+      get_with_config('sass-embedded-protocol', true) { latest_sass_embedded_protocol }
+      get_with_config('protoc', true) { latest_protoc }
+    end
+
+    private
+
+    def get_with_config(config, default)
+      val = with_config(config, default)
+      case val
+      when true
+        if block_given?
+          get yield
+        else
+          get default
+        end
+      when false
+        nil
+      else
+        get val
+      end
+    end
+
+    def get(uri_s)
+      uri = URI.parse(uri_s)
+      path = File.absolute_path(File.basename(uri.path), __dir__)
+      if uri.is_a?(URI::File) || uri.instance_of?(URI::Generic)
+        FileUtils.copy_file uri.path, path
+      elsif uri.respond_to? :open
+        uri.open do |source|
+          File.open(path, 'wb') do |destination|
+            destination.write source.read
+          end
+        end
+      else
+        raise
+      end
+    rescue StandardError
+      raise "Failed to get: #{uri}"
+    end
+
+    def latest_release(repo, prerelease: false)
+      if prerelease
+        headers = {}
+        headers['Authorization'] = "token #{ENV['GITHUB_TOKEN']}" if ENV['GITHUB_TOKEN']
+        URI.parse("https://api.github.com/repos/#{repo}/releases").open(headers) do |file|
+          JSON.parse(file.read)[0]['tag_name']
+        end
+      else
+        URI.parse("https://github.com/#{repo}/releases/latest").open do |file|
+          File.basename file.base_uri.to_s
+        end
+      end
+    end
+
+    def latest_sass_embedded
+      repo = 'sass/dart-sass-embedded'
+
+      # TODO, don't use prerelease once a release is available
+      tag_name = latest_release repo, prerelease: true
+
+      os = case Sass::Platform::OS
+           when 'darwin'
+             'macos'
+           when 'linux'
+             'linux'
+           when 'windows'
+             'windows'
+           else
+             raise "Unsupported OS: #{Sass::Platform::OS}"
+           end
+
+      arch = case Sass::Platform::ARCH
+             when 'x86_64'
+               'x64'
+             when 'i386'
+               'ia32'
+             else
+               raise "Unsupported Arch: #{Sass::Platform::ARCH}"
+             end
+
+      ext = case os
+            when 'windows'
+              'zip'
+            else
+              'tar.gz'
+            end
+
+      "https://github.com/#{repo}/releases/download/#{tag_name}/sass_embedded-#{tag_name}-#{os}-#{arch}.#{ext}"
+    end
+
+    def latest_protoc
+      repo = 'protocolbuffers/protobuf'
+
+      tag_name = latest_release repo
+
+      os = case Sass::Platform::OS
+           when 'darwin'
+             'osx'
+           when 'linux'
+             'linux'
+           when 'windows'
+             'win'
+           else
+             raise "Unsupported OS: #{Sass::Platform::OS}"
+           end
+
+      arch = case Sass::Platform::ARCH
+             when 'aarch64'
+               'aarch_64'
+             when 'sparcv9'
+               's390'
+             when 'i386'
+               'x86_32'
+             when 'x86_64'
+               'x86_64'
+             when 'powerpc64'
+               'ppcle_64'
+             else
+               raise "Unsupported Arch: #{Sass::Platform::ARCH}"
+             end
+
+      os_arch = case os
+                when 'win'
+                  os + arch.split('_').last
+                else
+                  "#{os}-#{arch}"
+                end
+
+      ext = 'zip'
+
+      "https://github.com/#{repo}/releases/download/#{tag_name}/protoc-#{tag_name[1..-1]}-#{os_arch}.#{ext}"
+    end
+
+    def latest_sass_embedded_protocol
+      repo = 'sass/embedded-protocol'
+
+      # TODO: use latest release once available
+      # tag_name = latest_release repo
+      tag_name = 'HEAD'
+
+      "https://raw.githubusercontent.com/#{repo}/#{tag_name}/embedded_sass.proto"
+    end
+  end
+end
+
+Sass::Extconf.new

data/lib/sass.rb

@@ -4,8 +4,8 @@ module Sass
   # 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 `@imported`. This include path is used by every instance of
-  # {Sass::Embedded::Compiler}. They are lower-precedence than any include
-  # paths passed in via the `:include_paths` option.
+  # {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.
@@ -13,7 +13,7 @@ module Sass
   # (semicolon-separated on Windows).
   #
   # @example
-  #   Sass.include_paths << File.dirname(__FILE__ + '/sass')
+  #   Sass.include_paths << File.dirname(__FILE__) + '/sass'
   # @return [Array<String, Pathname>]
   def self.include_paths
     @include_paths ||= if ENV['SASS_PATH']
@@ -23,15 +23,20 @@ module Sass
                        end
   end
 
-  def self.render options
-    @compiler ||= Sass::Embedded::Compiler.new
-    @compiler.render options
+  def self.render(options)
+    unless defined? @embedded
+      @embedded = Sass::Embedded.new
+      at_exit do
+        @embedded.close
+      end
+    end
+    @embedded.render options
   end
 end
 
-require_relative "sass/version"
-require_relative "sass/error"
-require_relative "sass/platform"
-require_relative "sass/util"
-require_relative "sass/embedded/transport"
-require_relative "sass/embedded/compiler"
+require_relative 'sass/version'
+require_relative 'sass/error'
+require_relative 'sass/platform'
+require_relative 'sass/util'
+require_relative 'sass/transport'
+require_relative 'sass/embedded'

data/lib/sass/embedded.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+module Sass
+  class Embedded
+    def initialize
+      @transport = Transport.new
+      @id_semaphore = Mutex.new
+      @id = 0
+    end
+
+    def render(options)
+      start = Sass::Util.now
+
+      raise Sass::NotRenderedError, 'Either :data or :file must be set.' if options[:file].nil? && options[:data].nil?
+
+      string = if options[:data]
+                 Sass::EmbeddedProtocol::InboundMessage::CompileRequest::StringInput.new(
+                   source: options[:data],
+                   url: options[:file] ? Sass::Util.file_uri(options[:file]) : 'stdin',
+                   syntax: options[:indented_syntax] == true ? Sass::EmbeddedProtocol::Syntax::INDENTED : Sass::EmbeddedProtocol::Syntax::SCSS
+                 )
+               end
+
+      path = options[:data] ? nil : options[:file]
+
+      style = case options[:output_style]&.to_sym
+              when :expanded, nil
+                Sass::EmbeddedProtocol::OutputStyle::EXPANDED
+              when :compressed
+                Sass::EmbeddedProtocol::OutputStyle::COMPRESSED
+              when :nested, :compact
+                raise Sass::UnsupportedValue, "#{options[:output_style]} is not a supported :output_style"
+              else
+                raise Sass::InvalidStyleError, "#{options[:output_style]} is not a valid :output_style"
+              end
+
+      source_map = options[:source_map].is_a?(String) || (options[:source_map] == true && !options[:out_file].nil?)
+
+      # 1. Loading a file relative to the file in which the @use or @import appeared.
+      # 2. Each custom importer.
+      # 3. Loading a file relative to the current working directory.
+      # 4. Each load path in includePaths
+      # 5. Each load path specified in the SASS_PATH environment variable, which should be semicolon-separated on Windows and colon-separated elsewhere.
+      importers = (if options[:importer]
+                     [
+                       Sass::EmbeddedProtocol::InboundMessage::CompileRequest::Importer.new(importer_id: 0)
+                     ]
+                   else
+                     []
+                   end).concat(
+                     (options[:include_paths] || []).concat(Sass.include_paths)
+                     .map do |include_path|
+                       Sass::EmbeddedProtocol::InboundMessage::CompileRequest::Importer.new(
+                         path: File.absolute_path(include_path)
+                       )
+                     end
+                   )
+
+      signatures = []
+      functions = {}
+      options[:functions]&.each do |signature, function|
+        signatures.push signature
+        functions[signature.to_s.split('(')[0].chomp] = function
+      end
+
+      compilation_id = next_id
+
+      compile_request = Sass::EmbeddedProtocol::InboundMessage::CompileRequest.new(
+        id: compilation_id,
+        string: string,
+        path: path,
+        style: style,
+        source_map: source_map,
+        importers: importers,
+        global_functions: options[:functions] ? signatures : [],
+        alert_color: true,
+        alert_ascii: true
+      )
+
+      response = @transport.send compile_request, compilation_id
+
+      file = options[:file] || 'stdin'
+      canonicalizations = {}
+      imports = {}
+
+      loop do
+        case response
+        when Sass::EmbeddedProtocol::OutboundMessage::CompileResponse
+          break
+        when Sass::EmbeddedProtocol::OutboundMessage::CanonicalizeRequest
+          url = Sass::Util.file_uri(File.absolute_path(response.url, File.dirname(file)))
+
+          if canonicalizations.key? url
+            canonicalizations[url].id = response.id
+          else
+            resolved = nil
+            options[:importer].each do |importer|
+              begin
+                resolved = importer.call response.url, file
+              rescue StandardError => e
+                resolved = e
+              end
+              break if resolved
+            end
+            if resolved.nil?
+              canonicalizations[url] = Sass::EmbeddedProtocol::InboundMessage::CanonicalizeResponse.new(
+                id: response.id,
+                url: url
+              )
+            elsif resolved.is_a? StandardError
+              canonicalizations[url] = Sass::EmbeddedProtocol::InboundMessage::CanonicalizeResponse.new(
+                id: response.id,
+                error: resolved.message
+              )
+            elsif resolved.key? :contents
+              canonicalizations[url] = Sass::EmbeddedProtocol::InboundMessage::CanonicalizeResponse.new(
+                id: response.id,
+                url: url
+              )
+              imports[url] = Sass::EmbeddedProtocol::InboundMessage::ImportResponse.new(
+                id: response.id,
+                success: Sass::EmbeddedProtocol::InboundMessage::ImportResponse::ImportSuccess.new(
+                  contents: resolved[:contents],
+                  syntax: Sass::EmbeddedProtocol::Syntax::SCSS,
+                  source_map_url: nil
+                )
+              )
+            elsif resolved.key? :file
+              canonicalized_url = Sass::Util.file_uri(resolved[:file])
+              canonicalizations[url] = Sass::EmbeddedProtocol::InboundMessage::CanonicalizeResponse.new(
+                id: response.id,
+                url: canonicalized_url
+              )
+              imports[canonicalized_url] = Sass::EmbeddedProtocol::InboundMessage::ImportResponse.new(
+                id: response.id,
+                success: Sass::EmbeddedProtocol::InboundMessage::ImportResponse::ImportSuccess.new(
+                  contents: File.read(resolved[:file]),
+                  syntax: Sass::EmbeddedProtocol::Syntax::SCSS,
+                  source_map_url: nil
+                )
+              )
+            else
+              canonicalizations[url] = Sass::EmbeddedProtocol::InboundMessage::CanonicalizeResponse.new(
+                id: response.id,
+                error: "Unexpected value returned from importer: #{resolved}"
+              )
+            end
+          end
+
+          response = @transport.send canonicalizations[url], compilation_id
+        when Sass::EmbeddedProtocol::OutboundMessage::ImportRequest
+          url = response.url
+
+          if imports.key? url
+            imports[url].id = response.id
+          else
+            imports[url] = Sass::EmbeddedProtocol::InboundMessage::ImportResponse.new(
+              id: response.id,
+              error: "Failed to import: #{url}"
+            )
+          end
+
+          response = @transport.send imports[url], compilation_id
+        when Sass::EmbeddedProtocol::OutboundMessage::FunctionCallRequest
+          begin
+            message = Sass::EmbeddedProtocol::InboundMessage::FunctionCallResponse.new(
+              id: response.id,
+              success: functions[response.name].call(*response.arguments)
+            )
+          rescue StandardError => e
+            message = Sass::EmbeddedProtocol::InboundMessage::FunctionCallResponse.new(
+              id: response.id,
+              error: e.message
+            )
+          end
+
+          response = @transport.send message, compilation_id
+        when Sass::EmbeddedProtocol::ProtocolError
+          raise Sass::ProtocolError, response.message
+        else
+          raise Sass::ProtocolError, "Unexpected packet received: #{response}"
+        end
+      end
+
+      if response.failure
+        raise Sass::CompilationError.new(
+          response.failure.message,
+          response.failure.formatted,
+          response.failure.span ? response.failure.span.url : nil,
+          response.failure.span ? response.failure.span.start.line + 1 : nil,
+          response.failure.span ? response.failure.span.start.column + 1 : nil,
+          1
+        )
+      end
+
+      finish = Sass::Util.now
+
+      {
+        css: response.success.css,
+        map: response.success.source_map,
+        stats: {
+          entry: options[:file] || 'data',
+          start: start,
+          end: finish,
+          duration: finish - start
+        }
+      }
+    end
+
+    def close
+      @transport.close
+      nil
+    end
+
+    private
+
+    def info
+      version_response = @transport.send Sass::EmbeddedProtocol::InboundMessage::VersionRequest.new(
+        id: next_id
+      )
+      {
+        compiler_version: version_response.compiler_version,
+        protocol_version: version_response.protocol_version,
+        implementation_name: version_response.implementation_name,
+        implementation_version: version_response.implementation_version
+      }
+    end
+
+    def next_id
+      @id_semaphore.synchronize do
+        @id += 1
+        @id = 0 if @id == Transport::PROTOCOL_ERROR_ID
+        @id
+      end
+    end
+  end
+end