jekyll-sass-converter 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c051522099eb9c977d893591246ad37863d0ff38feec276b8992c9f16cfa6b3b
-  data.tar.gz: 388b71b1d56dcde5f45b9860b28ba932291951cf2385e42560032b3c4e144c5f
+  metadata.gz: 8210a4fb569272e154c0f114f04ec1a3d71ae306c9c4f2afc1fa19d96437f0c7
+  data.tar.gz: 02be36d0eef40d451be28efb65396093de0e1cee3b44843bb41cc19fb0e5a02b
 SHA512:
-  metadata.gz: 0b2c4cd74ba4ee2612c92394011d98f6db389078d3668ccebe3cf96ef855c5a1a72c9dbe47057f3cc586b1dac2937379ee02356e289fdbf96869ad860e2ad1c3
-  data.tar.gz: 275e76080d121f8693b42d1ca46088a0328013b111c8eddc4a998baafd04990ed9ff6cad5ac7246198c79bf63aad7e3ff556a2bbe9d6ffd0a0582dc259daec68
+  metadata.gz: 8e5420795ee103377c6562ec3e9435991af4a85981f96605f6e2c99e8ec203182ed9b21ea0a5ceabc4a7e5335fc4558fd53920f1958efafac22c0d3da4783c64
+  data.tar.gz: 2da5d0b5f96885c5e3357d1790679c62d129bb2cfa261578ead2e9dc5be562a7baf488118b441effd3c6619adebe7a10698c756d4a7e2eac92c2560d63fd2518

data/lib/jekyll/converters/scss.rb

@@ -18,6 +18,8 @@ module Jekyll
       # This hook is triggered just before the method {#convert(content)} is executed, it
       # associates the Scss (and Sass) converters with their respective sass_page objects.
       Jekyll::Hooks.register :pages, :pre_render do |page|
+        next unless page.is_a?(Jekyll::Page)
+
         page.converters.each do |converter|
           converter.associate_page(page) if converter.is_a?(Jekyll::Converters::Scss)
         end
@@ -26,11 +28,14 @@ module Jekyll
       # This hook is triggered just after the method {#convert(content)} has been executed, it
       # dissociates the Scss (and Sass) converters with their respective sass_page objects.
       Jekyll::Hooks.register :pages, :post_render do |page|
+        next unless page.is_a?(Jekyll::Page)
+
         page.converters.each do |converter|
           converter.dissociate_page(page) if converter.is_a?(Jekyll::Converters::Scss)
         end
       end
 
+      ALLOWED_IMPLEMENTATIONS = %w(sassc sass-embedded).freeze
       ALLOWED_STYLES = %w(nested expanded compact compressed).freeze
 
       # Associate this Converter with the "page" object that manages input and output files for
@@ -87,16 +92,11 @@ module Jekyll
       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
+        return overrides if safe?
+
+        Jekyll::Utils.symbolize_hash_keys(
+          Jekyll::Utils.deep_merge_hashes(jekyll_sass_configuration, overrides)
+        )
       end
 
       def syntax
@@ -109,9 +109,17 @@ module Jekyll
         jekyll_sass_configuration["sass_dir"]
       end
 
+      def sass_implementation
+        implementation = jekyll_sass_configuration["implementation"]
+        ALLOWED_IMPLEMENTATIONS.include?(implementation) ? implementation : "sassc"
+      end
+
       def sass_style
-        style = jekyll_sass_configuration.fetch("style", :compact)
-        ALLOWED_STYLES.include?(style.to_s) ? style.to_sym : :compact
+        # `:expanded` is the default output style for newer sass implementations.
+        # For backward compatibility, `:compact` is kept as the default output style for sassc.
+        default = sass_implementation == "sassc" ? :compact : :expanded
+        style = jekyll_sass_configuration.fetch("style", default)
+        ALLOWED_STYLES.include?(style.to_s) ? style.to_sym : default
       end
 
       def user_sass_load_paths
@@ -119,33 +127,30 @@ module Jekyll
       end
 
       def sass_dir_relative_to_site_source
-        Jekyll.sanitized_path(site_source, sass_dir)
+        @sass_dir_relative_to_site_source ||= begin
+          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]
-        paths << site.theme.sass_path if site.theme&.sass_path
 
-        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) }.uniq
+          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
 
+        paths.uniq!
+        paths << site.theme.sass_path if site.theme&.sass_path
         paths.select { |path| File.directory?(path) }
       end
       # rubocop:enable Metrics/AbcSize
@@ -173,17 +178,50 @@ module Jekyll
       end
 
       def convert(content)
+        case sass_implementation
+        when "sass-embedded"
+          Jekyll::External.require_with_graceful_fail("sass-embedded")
+          sass_embedded_convert(content)
+        when "sassc"
+          sass_convert(content)
+        end
+      end
+
+      private
+
+      def sass_convert(content)
         config = sass_configs
         engine = SassC::Engine.new(content.dup, config)
         output = engine.render
-        generate_source_map(engine) if sourcemap_required?
+        sass_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
       end
 
-      private
+      def sass_embedded_config
+        {
+          :load_paths                 => sass_load_paths,
+          :source_map                 => sourcemap_required?,
+          :source_map_include_sources => true,
+          :style                      => sass_style,
+          :syntax                     => syntax == :sass ? :indented : syntax,
+          :url                        => sass_file_url,
+        }
+      end
+
+      def sass_embedded_convert(content)
+        output = ::Sass.compile_string(content, **sass_embedded_config)
+        sass_embedded_generate_source_map(output.source_map) if sourcemap_required?
+        replacement = add_charset? ? '@charset "UTF-8";' : ""
+        source_mapping_url = Addressable::URI.encode(File.basename(source_map_file))
+        eof = sourcemap_required? ? "\n\n/*# sourceMappingURL=#{source_mapping_url} */" : "\n"
+        output.css.sub(BYTE_ORDER_MARK, replacement) + eof
+      rescue ::Sass::CompileError => e
+        Jekyll.logger.error e.full_message
+        raise SyntaxError, e.message
+      end
 
       # The Page instance for which this object acts as a converter.
       attr_reader :sass_page
@@ -199,7 +237,14 @@ module Jekyll
       def filename
         return "stdin" if associate_page_failed?
 
-        sass_page.name
+        File.join(site_source_relative_from_pwd, 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?
+
+        file_url_from_path(File.join(site_source, sass_page.relative_path))
       end
 
       # The value of the `line_comments` option.
@@ -237,7 +282,7 @@ module Jekyll
       def output_path
         return "stdin.css" if associate_page_failed?
 
-        sass_page.basename + ".css"
+        File.join(site_source_relative_from_pwd, sass_page.basename + ".css")
       end
 
       # The name of the generated source map file. This information will be written into the
@@ -247,7 +292,7 @@ module Jekyll
       def source_map_file
         return "" if associate_page_failed?
 
-        sass_page.basename + ".css.map"
+        File.join(site_source_relative_from_pwd, sass_page.basename + ".css.map")
       end
 
       def source_map_page
@@ -259,7 +304,7 @@ module Jekyll
       # 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)
+      def sass_generate_source_map(engine)
         return if associate_page_failed?
 
         source_map_page.source_map(engine.source_map)
@@ -268,17 +313,40 @@ module Jekyll
         Jekyll.logger.warn "Could not generate source map #{e.message} => #{e.cause}"
       end
 
-      def site
-        if associate_page_failed?
-          Jekyll.sites.last
-        else
-          sass_page.site
+      # Reads the source-map and adds it to the source-map-page.
+      def sass_embedded_generate_source_map(source_map)
+        return if associate_page_failed?
+
+        map_data = JSON.parse(source_map)
+        map_data["file"] = Addressable::URI.encode(File.basename(output_path))
+        map_data["sources"].map! do |s|
+          s.start_with?("file:") ? Addressable::URI.parse(s).route_from(site_source_url) : s
         end
+
+        source_map_page.source_map(JSON.generate(map_data))
+        site.pages << source_map_page
+      end
+
+      def site
+        associate_page_failed? ? Jekyll.sites.last : sass_page.site
       end
 
       def site_source
         site.source
       end
+
+      def site_source_relative_from_pwd
+        @site_source_relative_from_pwd ||=
+          Pathname.new(site_source).relative_path_from(Pathname.new(Dir.pwd)).to_s
+      end
+
+      def site_source_url
+        @site_source_url ||= file_url_from_path("#{site_source}/")
+      end
+
+      def file_url_from_path(path)
+        Addressable::URI.encode("file://#{path.start_with?("/") ? "" : "/"}#{path}")
+      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.0.0"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-sass-converter
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-14 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sassc
@@ -78,14 +78,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 +110,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A basic Sass converter for Jekyll.