jekyll-sass-converter 1.4.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 71288fcd81a667822653dc71bd95ccedd9be0428
-  data.tar.gz: 71e8375de0f5aa7795850292b905c079a33054ba
+SHA256:
+  metadata.gz: c5b921d811e2917d86c33ad5cef0e1ecabe286eaf4ec33ee5e8c117fba6dfaab
+  data.tar.gz: 80f915a76b159e6f0b28cbd55ffc2d02b85cb4f445972adfd33aff1310dbb373
 SHA512:
-  metadata.gz: 0cc730a8eac61db90a74430bf0c0d865b580262bd19e2d0697fb66b0edb2bc704c10ec2996dbb7db826e1485223e5cda882434e92ad564a02bbee3ef252ea060
-  data.tar.gz: fee08ad83bd90778f43e144e48775ea00594d820c8e78f435f9f14eed19fb9584f9d41497e5217d4184cc51d1c05501b42ab07dc8a14131c077ceca975371163
+  metadata.gz: 4655abdc23cd0fa9439a5756d0a87b28419ace412327944c18adda840cbf9b3a8fc8132b05cc27a246b44e00811b23e2454003380888b6e78e7804d8818bf1c6
+  data.tar.gz: c8761b552a2b8ea6847af50f0083489d99f536fb53862001ff21b5a5fb72ab839955a388523147e1b83ee0c1f533072267f2182315165bd12cea345a5ae7a5e9

data/lib/jekyll-sass-converter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "jekyll-sass-converter/version"
 require "jekyll/converters/scss"
 require "jekyll/converters/sass"

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllSassConverter
-  VERSION = "1.4.0"
+  VERSION = "2.0.1"
 end

data/lib/jekyll/converters/sass.rb

@@ -1,17 +1,17 @@
-require 'sass'
-require 'jekyll/utils'
-require 'jekyll/converters/scss'
+# frozen_string_literal: true
+
+require "sassc"
+require "jekyll/utils"
+require "jekyll/converters/scss"
 
 module Jekyll
   module Converters
     class Sass < Scss
+      EXTENSION_PATTERN = %r!^\.sass$!i.freeze
+
       safe true
       priority :low
 
-      def matches(ext)
-        ext =~ /^\.sass$/i
-      end
-
       def syntax
         :sass
       end

data/lib/jekyll/converters/scss.rb

@@ -1,24 +1,78 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'sass'
-require 'jekyll/utils'
+require "sassc"
+require "jekyll/utils"
+require "jekyll/source_map_page"
 
 module Jekyll
   module Converters
     class Scss < Converter
-      BYTE_ORDER_MARK = /^\xEF\xBB\xBF/
+      BYTE_ORDER_MARK = %r!^\xEF\xBB\xBF!.freeze
+      EXTENSION_PATTERN = %r!^\.scss$!i.freeze
+
       SyntaxError = Class.new(ArgumentError)
 
       safe true
       priority :low
 
+      # 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
+      end
+
+      # 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_STYLES = %w(nested expanded compact compressed).freeze
 
+      # Associate this Converter with the "page" object that manages input and output files for
+      # this converter.
+      #
+      # Note: changing the associated sass_page during the live time of this Converter instance
+      # may result in inconsistent results.
+      #
+      # @param [Jekyll:Page] page The sass_page for which this object acts as converter.
+      def associate_page(page)
+        if @sass_page
+          Jekyll.logger.debug "Sass Converter:",
+                              "sass_page re-assigned: #{@sass_page.name} to #{page.name}"
+          dissociate_page(page)
+          return
+        end
+        @sass_page = page
+      end
+
+      # Dissociate this Converter with the "page" object.
+      #
+      # @param [Jekyll:Page] page The sass_page for which this object has acted as a converter.
+      def dissociate_page(page)
+        unless page.equal?(@sass_page)
+          Jekyll.logger.debug "Sass Converter:",
+                              "dissociating a page that was never associated #{page.name}"
+        end
+
+        @source_map_page = nil
+        @sass_page = nil
+        @site = nil
+      end
+
       def matches(ext)
-        ext =~ /^\.scss$/i
+        ext =~ self.class::EXTENSION_PATTERN
       end
 
-      def output_ext(ext)
+      def output_ext(_ext)
         ".css"
       end
 
@@ -27,21 +81,18 @@ module Jekyll
       end
 
       def jekyll_sass_configuration
-        options = @config["sass"] || {}
-        unless options["style"].nil?
-          options["style"] = options["style"].to_s.gsub(/\A:/, '').to_sym
+        @jekyll_sass_configuration ||= begin
+          options = @config["sass"] || {}
+          unless options["style"].nil?
+            options["style"] = options["style"].to_s.gsub(%r!\A:!, "").to_sym
+          end
+          options
         end
-        options
       end
 
       def sass_build_configuration_options(overrides)
         if safe?
-          {
-            :load_paths => sass_load_paths,
-            :syntax     => syntax,
-            :style      => sass_style,
-            :cache      => false
-          }
+          overrides
         else
           Jekyll::Utils.symbolize_hash_keys(
             Jekyll::Utils.deep_merge_hashes(
@@ -58,6 +109,7 @@ module Jekyll
 
       def sass_dir
         return "_sass" if jekyll_sass_configuration["sass_dir"].to_s.empty?
+
         jekyll_sass_configuration["sass_dir"]
       end
 
@@ -71,16 +123,36 @@ module Jekyll
       end
 
       def sass_dir_relative_to_site_source
-        Jekyll.sanitized_path(@config["source"], sass_dir)
+        Jekyll.sanitized_path(site_source, sass_dir)
       end
 
+      # rubocop:disable Metrics/AbcSize
       def sass_load_paths
+        paths = user_sass_load_paths + [sass_dir_relative_to_site_source]
+
         if safe?
-          [sass_dir_relative_to_site_source]
-        else
-          (user_sass_load_paths + [sass_dir_relative_to_site_source]).uniq
-        end.select { |load_path| File.directory?(load_path) }
+          # Sanitize paths to prevent any attack vectors (.e.g. `/**/*`)
+          paths.map! { |path| Jekyll.sanitized_path(site_source, path) }
+        end
+
+        # Expand file globs (e.g. `node_modules/*/node_modules` )
+        Dir.chdir(site_source) do
+          paths = paths.flat_map { |path| Dir.glob(path) }.uniq
+
+          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
+          end
+        end
+
+        paths << site.theme.sass_path if site.theme&.sass_path
+        paths.select { |path| File.directory?(path) }
       end
+      # rubocop:enable Metrics/AbcSize
 
       def allow_caching?
         !safe?
@@ -91,19 +163,125 @@ module Jekyll
       end
 
       def sass_configs
-        sass_build_configuration_options({
-          "syntax"     => syntax,
-          "cache"      => allow_caching?,
-          "load_paths" => sass_load_paths
-        })
+        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
+        )
       end
 
       def convert(content)
-        output = ::Sass.compile(content, sass_configs)
-        replacement = add_charset? ? '@charset "UTF-8";' : ''
+        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 ::Sass::SyntaxError => e
-        raise SyntaxError.new("#{e.to_s} on line #{e.sass_line}")
+      rescue SassC::SyntaxError => e
+        raise SyntaxError, e.to_s
+      end
+
+      private
+
+      # The Page instance for which this object acts as a converter.
+      attr_reader :sass_page
+
+      def associate_page_failed?
+        !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 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)
+      end
+
+      # The value of the `sourcemap` option chosen by the user.
+      #
+      # This option controls when sourcemaps shall be generated or not.
+      #
+      # Returns the value of the `sourcemap`-option chosen by the user or ':always' by default.
+      def sourcemap_option
+        jekyll_sass_configuration.fetch("sourcemap", :always).to_sym
+      end
+
+      # Determines whether a sourcemap shall be generated or not.
+      #
+      # Returns `true` if a sourcemap shall be generated, `false` otherwise.
+      def sourcemap_required?
+        return false if associate_page_failed? || sourcemap_option == :never
+        return true  if sourcemap_option == :always
+
+        !(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?
+
+        sass_page.basename + ".css"
+      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?
+
+        sass_page.basename + ".css.map"
+      end
+
+      def source_map_page
+        return if associate_page_failed?
+
+        @source_map_page ||= SourceMapPage.new(sass_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)
+        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}"
+      end
+
+      def site
+        if associate_page_failed?
+          Jekyll.sites.last
+        else
+          sass_page.site
+        end
+      end
+
+      def site_source
+        site.source
       end
     end
   end

data/lib/jekyll/source_map_page.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Jekyll
+  # A Jekyll::Page subclass to manage the source map file associated with
+  # a given scss / sass page.
+  class SourceMapPage < Page
+    # Initialize a new SourceMapPage.
+    #
+    # @param [Jekyll::Page] css_page The Page object that manages the css file.
+    def initialize(css_page)
+      @site = css_page.site
+      @dir  = css_page.dir
+      @data = css_page.data
+      @name = css_page.basename + ".css.map"
+
+      process(@name)
+      Jekyll::Hooks.trigger :pages, :post_init, self
+    end
+
+    def source_map(map)
+      self.content = map
+    end
+
+    def ext
+      ".map"
+    end
+
+    def asset_file?
+      true
+    end
+
+    # @return[String] the object as a debug String.
+    def inspect
+      "#<#{self.class} @name=#{name.inspect}>"
+    end
+  end
+end

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-sass-converter
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-26 00:00:00.000000000 Z
+date: 2019-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sass
+  name: sassc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.0'
   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.4'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +73,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: rubocop-jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.4'
 description: 
 email:
 - parkrmoore@gmail.com
@@ -91,6 +97,7 @@ files:
 - lib/jekyll-sass-converter/version.rb
 - lib/jekyll/converters/sass.rb
 - lib/jekyll/converters/scss.rb
+- lib/jekyll/source_map_page.rb
 homepage: https://github.com/jekyll/jekyll-sass-converter
 licenses:
 - MIT
@@ -103,15 +110,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A basic Sass converter for Jekyll.