sass-embedded 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c42f58b6f4f3200d3033fd59e65e7cd33132731ab4520bafb2a375cf55577ec
-  data.tar.gz: 2da13b64dab78a0b3fccd9a90cfcc6bd5affcd09dfe0b978aed53b69b2afa51e
+  metadata.gz: e03d2c1775fdd10b7f9d2b21898ac0a6e31e0be96157139742384c7be9b4275a
+  data.tar.gz: dacdc9589a8da93246b791794f97be2c8818f8a492d77e473c9fa543fd49db9e
 SHA512:
-  metadata.gz: d484872bd432f0092e67f699b18af1e242c982ff0e2019f9d23340593744ca58a015f5d63c76ae83d0a29e05ed362a2015f8f55bdbe472da67488e99c1cdaa8f
-  data.tar.gz: bd452474519dabcd9d793205d8f0dcc64482a5313d48d9eda4464f0a5d6ed8b9d6a34ea1c57e4a8f178beafb008b080481fd6059ab2f3ad53494e2acd272527b
+  metadata.gz: 3be32cd37a7078fceabd16c661cf985fdfc1aa31fbf8b88e6c768cb8edd57749a30e28a77f367d6cc8c6c505710f402e1970ae6c12210b3f46fc10a42cf8d81d
+  data.tar.gz: 5a122cd7c2e883f28b9401ce70d8fb43fcfcf39e1ff64484f5bf036c6978ca1a01cf8d69b1ebbf22f0fde81f98272127cf5a96d381b0279028d316d90775ebfb

data/.github/workflows/build.yml

@@ -27,7 +27,7 @@ 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 }}
 
@@ -41,4 +41,4 @@ jobs:
 
     - name: Test Gem
       run: |-
-        ruby -r sass -e "puts Sass.render({ data: 'h1 { color: black; }' })[:css]"
+        ruby -r sass -e "puts Sass.render(data: 'h1 { color: black; }')[:css]"

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  Exclude:
+    - '**/*_pb.rb'
+    - 'vendor/**/*'
+
+  TargetRubyVersion: 2.6
+
+  NewCops: enable
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics:
+  Enabled: false

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.
@@ -9,9 +11,7 @@ It exposes a Ruby API for Sass that's backed by a native [Dart Sass](https://sas
 ``` ruby
 require "sass"
 
-Sass.render({
-  file: "style.scss"
-})
+Sass.render(file: "style.scss")
 ```
 
 ---

data/Rakefile

@@ -2,15 +2,22 @@
 
 require 'bundler/gem_tasks'
 
-task default: :test
+task default: %i[rubocop test]
 
 desc 'Download dart-sass-embedded'
-task :download do
-  require_relative 'ext/sass_embedded/extconf'
+task :extconf do
+  system('make', '-C', 'ext')
 end
 
 desc 'Run all tests'
-task :test do
+task test: :extconf do
   $LOAD_PATH.unshift('lib', 'test')
   Dir.glob('./test/**/*_test.rb').sort.each { |f| require f }
 end
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  nil
+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,160 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'mkmf'
+require 'json'
+require 'open-uri'
+require 'fileutils'
+require_relative '../lib/sass/platform'
+
+module Sass
+  # Install dependencies for sass-embedded during gem install
+  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..]}-#{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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
+# The Sass module
 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 +14,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,14 +24,21 @@ module Sass
                        end
   end
 
-  def self.render(options)
-    unless defined? @compiler
-      @compiler = Sass::Embedded::Compiler.new
+  # The global render methods. This method automatically instantiates a
+  # global {Sass::Embedded} instance when invoked the first time and call
+  # `:render` method on the instance thereafter. The global {Sass::Embedded}
+  # is automatically closed via {Kernel.at_exit}.
+  # @example
+  #   Sass.render(options)
+  # @return [Hash]
+  def self.render(**kwargs)
+    unless defined? @embedded
+      @embedded = Sass::Embedded.new
       at_exit do
-        @compiler.close
+        @embedded.close
       end
     end
-    @compiler.render options
+    @embedded.render(**kwargs)
   end
 end
 
@@ -38,5 +46,5 @@ 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/transport'
+require_relative 'sass/embedded'

data/lib/sass/embedded.rb

@@ -0,0 +1,317 @@
+# frozen_string_literal: true
+
+module Sass
+  # The interface for using dart-sass-embedded
+  class Embedded
+    def initialize
+      @transport = Transport.new
+      @id_semaphore = Mutex.new
+      @id = 0
+    end
+
+    # rubocop:disable Lint/UnusedMethodArgument
+
+    def render(data: nil,
+               file: nil,
+               indented_syntax: false,
+               include_paths: [],
+               output_style: :expanded,
+               precision: 5,
+               indent_type: :space,
+               indent_width: 2,
+               linefeed: :lf,
+               source_comments: false,
+               source_map: false,
+               out_file: nil,
+               omit_source_map_url: false,
+               source_map_contents: false,
+               source_map_embed: false,
+               source_map_root: '',
+               functions: {},
+               importer: [])
+      # rubocop:enable Lint/UnusedMethodArgument
+
+      start = Util.now
+
+      compilation_id = next_id
+
+      renderer = Renderer.new(
+        data: data,
+        file: file,
+        indented_syntax: indented_syntax,
+        include_paths: include_paths,
+        output_style: output_style,
+        source_map: source_map,
+        out_file: out_file,
+        functions: functions,
+        importer: importer
+      )
+
+      response = @transport.send renderer.compile_request(compilation_id), compilation_id
+
+      loop do
+        case response
+        when EmbeddedProtocol::OutboundMessage::CompileResponse
+          break
+        when EmbeddedProtocol::OutboundMessage::CanonicalizeRequest
+          response = @transport.send renderer.canonicalize_response(response), compilation_id
+        when EmbeddedProtocol::OutboundMessage::ImportRequest
+          response = @transport.send renderer.import_response(response), compilation_id
+        when EmbeddedProtocol::OutboundMessage::FunctionCallRequest
+          response = @transport.send renderer.function_call_response(response), compilation_id
+        when EmbeddedProtocol::ProtocolError
+          raise ProtocolError, response.message
+        else
+          raise ProtocolError, "Unexpected packet received: #{response}"
+        end
+      end
+
+      if response.failure
+        raise RenderError.new(
+          response.failure.message,
+          response.failure.formatted,
+          if response.failure.span
+            response.failure.span.url == '' ? 'stdin' : URI.parse(response.failure.span.url).path
+          end,
+          response.failure.span ? response.failure.span.start.line + 1 : nil,
+          response.failure.span ? response.failure.span.start.column + 1 : nil,
+          1
+        )
+      end
+
+      finish = Util.now
+
+      {
+        css: response.success.css,
+        map: response.success.source_map,
+        stats: {
+          entry: file.nil? ? 'data' : file,
+          start: start,
+          end: finish,
+          duration: finish - start
+        }
+      }
+    end
+
+    def close
+      @transport.close
+      nil
+    end
+
+    private
+
+    def info
+      version_response = @transport.send 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
+
+    # Helper class that maintains render state
+    class Renderer
+      def initialize(data:,
+                     file:,
+                     indented_syntax:,
+                     include_paths:,
+                     output_style:,
+                     source_map:,
+                     out_file:,
+                     functions:,
+                     importer:)
+        raise ArgumentError, 'Either :data or :file must be set.' if file.nil? && data.nil?
+
+        @data = data
+        @file = file
+        @indented_syntax = indented_syntax
+        @include_paths = include_paths
+        @output_style = output_style
+        @source_map = source_map
+        @out_file = out_file
+        @global_functions = functions.keys
+        @functions = functions.transform_keys do |key|
+          key.to_s.split('(')[0].chomp
+        end
+        @importer = importer
+        @import_responses = {}
+      end
+
+      def compile_request(id)
+        EmbeddedProtocol::InboundMessage::CompileRequest.new(
+          id: id,
+          string: string,
+          path: path,
+          style: style,
+          source_map: source_map,
+          importers: importers,
+          global_functions: global_functions,
+          alert_color: $stderr.tty?,
+          alert_ascii: Platform::OS == 'windows'
+        )
+      end
+
+      def canonicalize_response(canonicalize_request)
+        url = Util.file_uri(File.absolute_path(canonicalize_request.url, (@file.nil? ? 'stdin' : @file)))
+
+        begin
+          result = @importer[canonicalize_request.importer_id].call canonicalize_request.url, @file
+          raise result if result.is_a? StandardError
+        rescue StandardError => e
+          return EmbeddedProtocol::InboundMessage::CanonicalizeResponse.new(
+            id: canonicalize_request.id,
+            error: e.message
+          )
+        end
+
+        if result&.key? :contents
+          @import_responses[url] = EmbeddedProtocol::InboundMessage::ImportResponse.new(
+            id: canonicalize_request.id,
+            success: EmbeddedProtocol::InboundMessage::ImportResponse::ImportSuccess.new(
+              contents: result[:contents],
+              syntax: EmbeddedProtocol::Syntax::SCSS,
+              source_map_url: nil
+            )
+          )
+          EmbeddedProtocol::InboundMessage::CanonicalizeResponse.new(
+            id: canonicalize_request.id,
+            url: url
+          )
+        elsif result&.key? :file
+          canonicalized_url = Util.file_uri(result[:file])
+
+          # TODO: FileImportRequest is not supported yet.
+          # Workaround by reading contents and return it when server asks
+          @import_responses[canonicalized_url] = EmbeddedProtocol::InboundMessage::ImportResponse.new(
+            id: canonicalize_request.id,
+            success: EmbeddedProtocol::InboundMessage::ImportResponse::ImportSuccess.new(
+              contents: File.read(result[:file]),
+              syntax: EmbeddedProtocol::Syntax::SCSS,
+              source_map_url: nil
+            )
+          )
+
+          EmbeddedProtocol::InboundMessage::CanonicalizeResponse.new(
+            id: canonicalize_request.id,
+            url: canonicalized_url
+          )
+        else
+          EmbeddedProtocol::InboundMessage::CanonicalizeResponse.new(
+            id: canonicalize_request.id
+          )
+        end
+      end
+
+      def import_response(import_request)
+        url = import_request.url
+
+        if @import_responses.key? url
+          @import_responses[url].id = import_request.id
+        else
+          @import_responses[url] = EmbeddedProtocol::InboundMessage::ImportResponse.new(
+            id: import_request.id,
+            error: "Failed to import: #{url}"
+          )
+        end
+
+        @import_responses[url]
+      end
+
+      def function_call_response(function_call_request)
+        EmbeddedProtocol::InboundMessage::FunctionCallResponse.new(
+          id: function_call_request.id,
+          success: @functions[function_call_request.name].call(*function_call_request.arguments)
+        )
+      rescue StandardError => e
+        EmbeddedProtocol::InboundMessage::FunctionCallResponse.new(
+          id: function_call_request.id,
+          error: e.message
+        )
+      end
+
+      private
+
+      def syntax
+        if @indented_syntax == true
+          EmbeddedProtocol::Syntax::INDENTED
+        else
+          EmbeddedProtocol::Syntax::SCSS
+        end
+      end
+
+      def url
+        return if @file.nil?
+
+        Util.file_uri(@file)
+      end
+
+      def string
+        return if @data.nil?
+
+        EmbeddedProtocol::InboundMessage::CompileRequest::StringInput.new(
+          source: @data,
+          url: url,
+          syntax: syntax
+        )
+      end
+
+      def path
+        @file if @data.nil?
+      end
+
+      def style
+        case @output_style.to_sym
+        when :expanded
+          EmbeddedProtocol::OutputStyle::EXPANDED
+        when :compressed
+          EmbeddedProtocol::OutputStyle::COMPRESSED
+        when :nested, :compact
+          raise ArgumentError, "#{@output_style} is not a supported output_style"
+        else
+          raise ArgumentError, "#{@output_style} is not a valid utput_style"
+        end
+      end
+
+      def source_map
+        @source_map.is_a?(String) || (@source_map == true && !@out_file.nil?)
+      end
+
+      attr_reader :global_functions
+
+      # Order
+      # 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.
+      def importers
+        custom_importers = @importer.map.with_index do |_, id|
+          EmbeddedProtocol::InboundMessage::CompileRequest::Importer.new(
+            importer_id: id
+          )
+        end
+
+        include_path_importers = @include_paths
+                                 .concat(Sass.include_paths)
+                                 .map do |include_path|
+          EmbeddedProtocol::InboundMessage::CompileRequest::Importer.new(
+            path: File.absolute_path(include_path)
+          )
+        end
+
+        custom_importers.concat include_path_importers
+      end
+    end
+  end
+end