jekyll-sass-converter 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca94d9c890d30769bc4e8f02c40c36204492b3756d812832545811de2f9adbe2
-  data.tar.gz: ca4c611652bb77f15c0ddedfef1c49c5921b323a97c097fb8a9e6bbb906258ab
+  metadata.gz: 209c38f2d63adbcdca7275d57fa6e967f7adcdc8bd91d5b4b1e789e91d523889
+  data.tar.gz: 81cc00baf45c4d2375dd1b9bbe004b0c76daaaefbfb391e2b3233743704e51e6
 SHA512:
-  metadata.gz: 34cbbcef544e99bed2b8373ce339cf8040e123e2428beec54f0affb6895bfc2a4d47b4549d0c73d131719afaa375a109da07da51ab0b05abcbef7add1ac77ebd
-  data.tar.gz: 4d877c97804a9a59ef2febe1298c34bf9fa9a80199b6c664792aa5937c1c2a0844f6b49bb6bdf13fb6022355bdb0c79eb1321e1225cd5464e0fff9c2d3f9babd
+  metadata.gz: 5a35508f75db53b77b32b8d662a29857086b83e9f7d73608d6d25ff0daf56e48b1d43b54be20efe54b4ac1093a292c68f3054bf734d9153b632059d6edd1065c
+  data.tar.gz: d53beb7e645c9da162debcfae72246ead2d2fd71381eb5f2da65e6bd77f41e1cc05902ddb88136e9145674bdf68d6290f83ba42c3f44977bc4b7042eff09b811

data/lib/jekyll/converters/sass.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "sassc"
-require "jekyll/utils"
 require "jekyll/converters/scss"
 
 module Jekyll
@@ -13,7 +11,7 @@ module Jekyll
       priority :low
 
       def syntax
-        :sass
+        :indented
       end
     end
   end

data/lib/jekyll/converters/scss.rb

@@ -1,13 +1,18 @@
 # frozen_string_literal: true
 
-require "sassc"
-require "jekyll/utils"
-require "jekyll/source_map_page"
+# stdlib
+require "json"
+
+# 3rd party
+require "addressable/uri"
+require "sass-embedded"
+
+# internal
+require_relative "../source_map_page"
 
 module Jekyll
   module Converters
     class Scss < Converter
-      BYTE_ORDER_MARK = %r!^\xEF\xBB\xBF!.freeze
       EXTENSION_PATTERN = %r!^\.scss$!i.freeze
 
       SyntaxError = Class.new(ArgumentError)
@@ -35,7 +40,7 @@ module Jekyll
         end
       end
 
-      ALLOWED_STYLES = %w(nested expanded compact compressed).freeze
+      ALLOWED_STYLES = %w(expanded compressed).freeze
 
       # Associate this Converter with the "page" object that manages input and output files for
       # this converter.
@@ -84,25 +89,12 @@ module Jekyll
         @jekyll_sass_configuration ||= begin
           options = @config["sass"] || {}
           unless options["style"].nil?
-            options["style"] = options["style"].to_s.gsub(%r!\A:!, "").to_sym
+            options["style"] = options["style"].to_s.delete_prefix(":").to_sym
           end
           options
         end
       end
 
-      def sass_build_configuration_options(overrides)
-        if safe?
-          overrides
-        else
-          Jekyll::Utils.symbolize_hash_keys(
-            Jekyll::Utils.deep_merge_hashes(
-              jekyll_sass_configuration,
-              overrides
-            )
-          )
-        end
-      end
-
       def syntax
         :scss
       end
@@ -114,8 +106,8 @@ module Jekyll
       end
 
       def sass_style
-        style = jekyll_sass_configuration.fetch("style", :compact)
-        ALLOWED_STYLES.include?(style.to_s) ? style.to_sym : :compact
+        style = jekyll_sass_configuration["style"]
+        ALLOWED_STYLES.include?(style.to_s) ? style.to_sym : :expanded
       end
 
       def user_sass_load_paths
@@ -123,31 +115,24 @@ module Jekyll
       end
 
       def sass_dir_relative_to_site_source
-        @sass_dir_relative_to_site_source ||= begin
+        @sass_dir_relative_to_site_source ||=
           Jekyll.sanitized_path(site_source, sass_dir).sub(site.source + "/", "")
-        end
       end
 
       # rubocop:disable Metrics/AbcSize
       def sass_load_paths
         paths = user_sass_load_paths + [sass_dir_relative_to_site_source]
 
-        if safe?
-          # Sanitize paths to prevent any attack vectors (.e.g. `/**/*`)
-          paths.map! { |path| Jekyll.sanitized_path(site_source, path) }
-        end
+        # Sanitize paths to prevent any attack vectors (.e.g. `/**/*`)
+        paths.map! { |path| Jekyll.sanitized_path(site_source, path) } if safe?
 
         # Expand file globs (e.g. `node_modules/*/node_modules` )
         Dir.chdir(site_source) do
           paths = paths.flat_map { |path| Dir.glob(path) }
 
           paths.map! do |path|
-            if safe?
-              # Sanitize again in case globbing was able to do something crazy.
-              Jekyll.sanitized_path(site_source, path)
-            else
-              File.expand_path(path)
-            end
+            # Sanitize again in case globbing was able to do something crazy.
+            safe? ? Jekyll.sanitized_path(site_source, path) : File.expand_path(path)
           end
         end
 
@@ -157,37 +142,37 @@ module Jekyll
       end
       # rubocop:enable Metrics/AbcSize
 
-      def allow_caching?
-        !safe?
-      end
-
-      def add_charset?
-        !!jekyll_sass_configuration["add_charset"]
-      end
-
       def sass_configs
-        sass_build_configuration_options(
-          :style                => sass_style,
-          :syntax               => syntax,
-          :filename             => filename,
-          :output_path          => output_path,
-          :source_map_file      => source_map_file,
-          :load_paths           => sass_load_paths,
-          :omit_source_map_url  => !sourcemap_required?,
-          :source_map_contents  => true,
-          :line_comments_option => line_comments_option
-        )
+        {
+          :load_paths                 => sass_load_paths,
+          :charset                    => !associate_page_failed?,
+          :source_map                 => sourcemap_required?,
+          :source_map_include_sources => true,
+          :style                      => sass_style,
+          :syntax                     => syntax,
+          :url                        => sass_file_url,
+          :quiet_deps                 => quiet_deps_option,
+          :verbose                    => verbose_option,
+        }
       end
 
       def convert(content)
-        config = sass_configs
-        engine = SassC::Engine.new(content.dup, config)
-        output = engine.render
-        generate_source_map(engine) if sourcemap_required?
-        replacement = add_charset? ? '@charset "UTF-8";' : ""
-        output.sub(BYTE_ORDER_MARK, replacement)
-      rescue SassC::SyntaxError => e
-        raise SyntaxError, e.to_s
+        output = ::Sass.compile_string(content, **sass_configs)
+        result = output.css
+
+        if sourcemap_required?
+          source_map = process_source_map(output.source_map)
+          generate_source_map_page(source_map)
+
+          if (sm_url = source_mapping_url)
+            result += "#{sass_style == :compressed ? "" : "\n\n"}/*# sourceMappingURL=#{sm_url} */"
+          end
+        end
+
+        result
+      rescue ::Sass::CompileError => e
+        Jekyll.logger.error e.full_message
+        raise SyntaxError, e.message
       end
 
       private
@@ -199,23 +184,11 @@ module Jekyll
         !sass_page
       end
 
-      # The name of the input scss (or sass) file. This information will be used for error
-      # reporting and will written into the source map file as main source.
-      #
-      # Returns the name of the input file or "stdin" if #associate_page failed
-      def filename
-        return "stdin" if associate_page_failed?
-
-        sass_page.name
-      end
+      # The URL of the input scss (or sass) file. This information will be used for error reporting.
+      def sass_file_url
+        return if associate_page_failed?
 
-      # The value of the `line_comments` option.
-      # When set to `true` causes the line number and filename of the source be emitted into the
-      # compiled CSS-file. Useful for debugging when the source-map is not available.
-      #
-      # Returns the value of the `line_comments`-option chosen by the user or 'false' by default.
-      def line_comments_option
-        jekyll_sass_configuration.fetch("line_comments", false)
+        file_url_from_path(Jekyll.sanitized_path(site_source, sass_page.relative_path))
       end
 
       # The value of the `sourcemap` option chosen by the user.
@@ -237,55 +210,72 @@ module Jekyll
         !(sourcemap_option == :development && Jekyll.env != "development")
       end
 
-      # The name of the generated css file. This information will be written into the source map
-      # file as a backward reference to the input.
-      #
-      # Returns the name of the css file or "stdin.css" if #associate_page failed
-      def output_path
-        return "stdin.css" if associate_page_failed?
+      def source_map_page
+        return if associate_page_failed?
 
-        sass_page.basename + ".css"
+        @source_map_page ||= SourceMapPage.new(sass_page)
       end
 
-      # The name of the generated source map file. This information will be written into the
-      # css file to reference to the source map.
-      #
-      # Returns the name of the css file or "" if #associate_page failed
-      def source_map_file
-        return "" if associate_page_failed?
+      # Returns the directory that source map sources are relative to.
+      def sass_source_root
+        if associate_page_failed?
+          site_source
+        else
+          Jekyll.sanitized_path(site_source, File.dirname(sass_page.relative_path))
+        end
+      end
 
-        sass_page.basename + ".css.map"
+      # Converts file urls in source map to relative paths.
+      #
+      # Returns processed source map string.
+      def process_source_map(source_map)
+        map_data = JSON.parse(source_map)
+        unless associate_page_failed?
+          map_data["file"] = Addressable::URI.encode(sass_page.basename + ".css")
+        end
+        source_root_url = Addressable::URI.parse(file_url_from_path("#{sass_source_root}/"))
+        map_data["sources"].map! do |s|
+          s.start_with?("file:") ? Addressable::URI.parse(s).route_from(source_root_url).to_s : s
+        end
+        JSON.generate(map_data)
       end
 
-      def source_map_page
+      # Adds the source-map to the source-map-page and adds it to `site.pages`.
+      def generate_source_map_page(source_map)
         return if associate_page_failed?
 
-        @source_map_page ||= SourceMapPage.new(sass_page)
+        source_map_page.source_map(source_map)
+        site.pages << source_map_page
       end
 
-      # Reads the source-map from the engine and adds it to the source-map-page.
-      #
-      # @param [::SassC::Engine] engine The sass Compiler engine.
-      def generate_source_map(engine)
+      # Returns a source mapping url for given source-map.
+      def source_mapping_url
         return if associate_page_failed?
 
-        source_map_page.source_map(engine.source_map)
-        site.pages << source_map_page
-      rescue ::SassC::NotRenderedError => e
-        Jekyll.logger.warn "Could not generate source map #{e.message} => #{e.cause}"
+        Addressable::URI.encode(sass_page.basename + ".css.map")
       end
 
       def site
-        if associate_page_failed?
-          Jekyll.sites.last
-        else
-          sass_page.site
-        end
+        associate_page_failed? ? Jekyll.sites.last : sass_page.site
       end
 
       def site_source
         site.source
       end
+
+      def file_url_from_path(path)
+        Addressable::URI.encode("file://#{path.start_with?("/") ? "" : "/"}#{path}")
+      end
+
+      # Returns the value of the `quiet_deps`-option chosen by the user or 'false' by default.
+      def quiet_deps_option
+        !!jekyll_sass_configuration.fetch("quiet_deps", false)
+      end
+
+      # Returns the value of the `verbose`-option chosen by the user or 'false' by default.
+      def verbose_option
+        !!jekyll_sass_configuration.fetch("verbose", false)
+      end
     end
   end
 end

data/lib/jekyll/source_map_page.rb

@@ -29,6 +29,10 @@ module Jekyll
       true
     end
 
+    def render_with_liquid?
+      false
+    end
+
     # @return[String] the object as a debug String.
     def inspect
       "#<#{self.class} @name=#{name.inspect}>"

data/lib/jekyll-sass-converter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllSassConverter
-  VERSION = "2.1.0"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-sass-converter
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-05 00:00:00.000000000 Z
+date: 2022-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sassc
+  name: sass-embedded
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 2.0.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.54'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 2.0.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.54'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.12.0
 description: 
 email:
 - parkrmoore@gmail.com
@@ -110,14 +104,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A basic Sass converter for Jekyll.