sprockets-sass 1.3.1 → 2.0.0.beta1

data/lib/sprockets/sass/v4/functions.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require_relative '../v3/functions'
+module Sprockets
+  module Sass
+    module V4
+      # Module used to inject helpers into SASS engine
+      module Functions
+        include Sprockets::Sass::V3::Functions
+      end
+    end
+  end
+end

data/lib/sprockets/sass/v4/importer.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+require_relative '../v3/importer'
+module Sprockets
+  module Sass
+    module V4
+      # class used for importing files from SCCS and SASS files
+      class Importer < Sprockets::Sass::V3::Importer
+        def syntax_mime_type(path)
+          "text/#{syntax(path)}"
+        end
+
+        def engine_from_glob(glob, base_path, options)
+          context = options[:custom][:sprockets_context]
+          engine_imports = resolve_glob(context, glob, base_path).reduce(''.dup) do |imports, path|
+            context.depend_on path[:file_url]
+            relative_path = path[:path].relative_path_from Pathname.new(base_path).dirname
+            imports << %(@import "#{relative_path}";\n)
+          end
+          return nil if engine_imports.empty?
+          ::Sass::Engine.new engine_imports, options.merge(
+            filename: base_path.to_s,
+            syntax: syntax(base_path.to_s),
+            importer: self,
+            custom: { sprockets_context: context }
+          )
+        end
+
+        # Finds all of the assets using the given glob.
+        def resolve_glob(context, glob, base_path)
+          base_path      = Pathname.new(base_path)
+          path_with_glob = base_path.dirname.join(glob).to_s
+
+          glob_files = Pathname.glob(path_with_glob).sort.reduce([]) do |imports, path|
+            pathname = resolve(context, path, base_path)
+            asset_requirable = asset_requirable?(context, pathname)
+            imports << { file_url: pathname, path: path } if path != context.filename && asset_requirable
+          end
+          glob_files
+        end
+
+        def possible_files(context, path, base_path)
+          filename = check_path_before_process(context, base_path)
+          base_path = (filename.is_a?(Pathname) ? filename : Pathname.new(filename))
+          super(context, path, base_path)
+        end
+
+        def check_path_before_process(context, path, a = nil)
+          if path.to_s.start_with?('file://')
+            path = Pathname.new(path.to_s.gsub(/\?type\=(.*)/, "?type=text/#{syntax(path)}"))  # @TODO : investigate why sometimes file:/// URLS are ending in ?type=text instead of ?type=text/scss
+            asset = context.environment.load(path) # because resolve now returns file://
+            asset.filename
+          else
+            path
+          end
+        end
+
+        def stat_of_pathname(context, pathname, _path)
+          filename = check_path_before_process(context, pathname)
+          context.environment.stat(filename)
+        end
+
+        # @TODO find better alternative than scanning file:// string for mime type
+        def content_type_of_path(context, path)
+          pathname = context.resolve(path)
+          content_type = pathname.nil? ? nil : pathname.to_s.scan(/\?type\=(.*)/).flatten.first unless pathname.nil?
+          attributes = {}
+          [content_type, attributes]
+        end
+
+        def get_context_transformers(context, content_type, path)
+          available_transformers =  context.environment.transformers[content_type]
+          additional_transformers = available_transformers.key?(syntax_mime_type(path)) ? available_transformers[syntax_mime_type(path)] : []
+          additional_transformers.is_a?(Array) ? additional_transformers : [additional_transformers]
+          css_transformers = available_transformers.key?('text/css') ? available_transformers['text/css'] : []
+          css_transformers = css_transformers.is_a?(Array) ? css_transformers : [css_transformers]
+          additional_transformers = additional_transformers.concat(css_transformers)
+          additional_transformers
+        end
+
+        def filter_all_processors(processors)
+          processors.delete_if do |processor|
+            filtered_processor_classes.include?(processor) || filtered_processor_classes.any? do |filtered_processor|
+              !processor.is_a?(Proc) && ((processor.class != Class && processor.class < filtered_processor) || (processor.class == Class && processor < filtered_processor))
+            end
+          end
+        end
+
+        def call_processor_input(processor, context, input, processors)
+          if processor.respond_to?(:processors)
+            processor.processors = filter_all_processors(processor.processors)
+          end
+          super(processor, context, input, processors)
+        end
+
+        def filtered_processor_classes
+          classes = super
+          classes << Sprockets::SassCompressor if defined?(Sprockets::SassCompressor)
+          classes << Sprockets::SasscCompressor if defined?(Sprockets::SasscCompressor)
+          classes << Sprockets::YUICompressor if defined?(Sprockets::YUICompressor)
+          classes
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/sass/v4/sass_template.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require_relative '../v3/sass_template'
+module Sprockets
+  module Sass
+    module V4
+      # Preprocessor for SASS files
+      class SassTemplate < Sprockets::Sass::V3::SassTemplate
+        # This is removed
+        # def self.default_mime_type
+        #   "text/#{syntax}"
+        # end
+        #
+        def self.syntax
+          :sass
+        end
+
+        def custom_cache_store(*args)
+          Sprockets::Sass::V4::CacheStore.new(*args)
+        end
+
+        def custom_importer_class(*_args)
+          Sprockets::Sass::V4::Importer.new
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/sass/v4/scss_template.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require_relative './sass_template'
+
+# @TODO refactor the Sprockets::Sass::Functions , logical_path is unavailable
+module Sprockets
+  module Sass
+    module V4
+      # Preprocessor for SCSS files
+      class ScssTemplate < Sprockets::Sass::V4::SassTemplate
+        def self.syntax
+          :scss
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/sass/version.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module Sprockets
   module Sass
-    VERSION = '1.3.1'
+    VERSION = '2.0.0.beta1'
   end
 end

data/spec/custom_importer_spec.rb

@@ -12,20 +12,18 @@ describe Sprockets::Sass::SassTemplate do
     @assets = @root.directory 'assets'
     @env = Sprockets::Environment.new @root.to_s
     @env.append_path @assets.to_s
-    @env.register_postprocessor 'text/css', :fail_postprocessor do |_, data|
-      data.gsub /@import/, 'fail engine'
-    end
+    @env.register_postprocessor 'text/css', FailPostProcessor
   end
 
   after :each do
     @root.destroy!
+    #Sprockets::Sass.options[:importer] = nil
   end
 
   it 'allow specifying custom sass importer' do
-    @assets.file 'main.css.scss', %(@import "dep";)
+    @assets.file 'main.css.scss', %(@import "dep")
     @assets.file 'dep.css.scss', "$color: blue;\nbody { color: $color; }"
-    @env['main.css']
-
+    asset = @env['main.css']
     expect(@custom_importer.has_been_used).to be_truthy
   end
 

data/spec/spec_helper.rb

@@ -1,18 +1,45 @@
+require 'rubygems'
+require 'bundler/setup'
 require 'sprockets'
 require 'sprockets-sass'
 require 'sprockets-helpers'
 require 'compass'
 require 'test_construct'
 
+RSpec.configure do |config|
+  config.include TestConstruct::Helpers
+end
+
 Compass.configuration do |compass|
   compass.line_comments = false
   compass.output_style  = :nested
 end
-
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
-RSpec.configure do |config|
-  config.include TestConstruct::Helpers
+
+def compile_asset_and_return_compilation(env, public_dir, filename )
+  if Sprockets::Sass::Utils.version_of_sprockets < 3
+    manifest = Sprockets::Manifest.new(env, public_dir)
+  else
+    manifest = Sprockets::Manifest.new(env, public_dir, File.join(public_dir ,'manifest.json'))
+  end
+  manifest.compile(filename)
+  res = File.read(File.join(public_dir, manifest.files.keys.first))
+  manifest.clobber
+  res
+end
+
+def write_asset(filename, contents, mtime = nil)
+  mtime ||= [Time.now.to_i, File.stat(filename).mtime.to_i].max + 1
+  File.open(filename, 'w') do |f|
+    f.write(contents)
+  end
+  if Sprockets::Sass::Utils.version_of_sprockets >= 3
+    File.utime(mtime, mtime, filename)
+  else
+    mtime = Time.now + 1
+    filename.utime mtime, mtime
+  end
 end

data/spec/sprockets-sass_spec.rb

@@ -4,11 +4,10 @@ describe Sprockets::Sass do
   before :each do
     @root = create_construct
     @assets = @root.directory 'assets'
+    @public_dir = @root.directory 'public'
     @env = Sprockets::Environment.new @root.to_s
     @env.append_path @assets.to_s
-    @env.register_postprocessor 'text/css', :fail_postprocessor do |context, data|
-      data.gsub /@import/, 'fail engine'
-    end
+    @env.register_postprocessor 'text/css', FailPostProcessor
   end
 
   after :each do
@@ -16,12 +15,21 @@ describe Sprockets::Sass do
   end
 
   it 'processes scss files normally' do
-    @assets.file 'main.css.scss', '//= require dep'
-    @assets.file 'dep.css.scss', 'body { color: blue; }'
+    @assets.file 'main.css.scss', '//= require "dep"'
+    @assets.file 'dep.css.scss', 'body{ color: blue; }'
     asset = @env['main.css']
     expect(asset.to_s).to eql("body {\n  color: blue; }\n")
   end
 
+  if Sprockets::Sass::Utils.version_of_sprockets < 4
+    it 'processes scss files normally without the .css extension' do
+      @assets.file 'main.scss', '//= require dep'
+      @assets.file 'dep.scss', 'body { color: blue; }'
+      asset = @env['main']
+      expect(asset.to_s).to eql("body {\n  color: blue; }\n")
+    end
+  end
+
   it 'processes sass files normally' do
     @assets.file 'main.css.sass', '//= require dep'
     @assets.file 'dep.css.sass', "body\n  color: blue"
@@ -45,7 +53,7 @@ describe Sprockets::Sass do
 
   it 'imports other syntax' do
     @assets.file 'main.css.scss', %(@import "dep";\nbody { color: $color; })
-    @assets.file 'dep.sass', "$color: blue\nhtml\n  height: 100%"
+    @assets.file 'dep.css.sass', "$color: blue\nhtml\n  height: 100%"
     asset = @env['main.css']
     expect(asset.to_s).to eql("html {\n  height: 100%; }\n\nbody {\n  color: blue; }\n")
   end
@@ -69,7 +77,7 @@ describe Sprockets::Sass do
   it 'imports files with additional processors' do
     @assets.file 'main.css.scss', %(@import "dep";\nbody { color: $color; })
     @assets.file 'dep.css.scss.erb', "$color: <%= 'blue' %>;"
-    asset = @env['main.css']
+    asset = @env['main.css.scss']
     expect(asset.to_s).to eql("body {\n  color: blue; }\n")
   end
 
@@ -90,10 +98,10 @@ describe Sprockets::Sass do
   end
 
   it 'imports deeply nested relative partials' do
-    @assets.file 'package-prime/stylesheets/main.scss', %(@import "package-dep/src/stylesheets/variables";\nbody { background-color: $background-color; color: $color; })
-    @assets.file 'package-dep/src/stylesheets/_variables.scss', %(@import "./colors";\n$background-color: red;)
-    @assets.file 'package-dep/src/stylesheets/_colors.scss', '$color: blue;'
-    asset = @env['package-prime/stylesheets/main.scss']
+    @assets.file 'package-prime/stylesheets/main.css.scss', %(@import "package-dep/src/stylesheets/variables";\nbody { background-color: $background-color; color: $color; })
+    @assets.file 'package-dep/src/stylesheets/_variables.css.scss', %(@import "./colors";\n$background-color: red;)
+    @assets.file 'package-dep/src/stylesheets/_colors.css.scss', '$color: blue;'
+    asset = @env['package-prime/stylesheets/main.css.scss']
     expect(asset.to_s).to eql("body {\n  background-color: red;\n  color: blue; }\n")
   end
 
@@ -129,8 +137,8 @@ describe Sprockets::Sass do
 
   it 'shares Sass environment with other imports' do
     @assets.file 'main.css.scss', %(@import "dep-1";\n@import "dep-2";)
-    @assets.file '_dep-1.scss', '$color: blue;'
-    @assets.file '_dep-2.scss', 'body { color: $color; }'
+    @assets.file '_dep-1.css.scss', '$color: blue;'
+    @assets.file '_dep-2.css.scss', 'body { color: $color; }'
     asset = @env['main.css']
     expect(asset.to_s).to eql("body {\n  color: blue; }\n")
   end
@@ -151,8 +159,8 @@ describe Sprockets::Sass do
 
     @assets.file 'folder/main.css.scss', %(@import "dep";\nbody { color: $color; })
     vendor.file 'dep.css.scss', '@import "folder1/dep1";'
-    vendor.file 'folder1/_dep1.scss', '@import "folder2/dep2";'
-    vendor.file 'folder1/folder2/_dep2.scss', '$color: blue;'
+    vendor.file 'folder1/_dep1.css.scss', '@import "folder2/dep2";'
+    vendor.file 'folder1/folder2/_dep2.css.scss', '$color: blue;'
     asset = @env['folder/main.css']
     expect(asset.to_s).to eql("body {\n  color: blue; }\n")
   end
@@ -163,8 +171,8 @@ describe Sprockets::Sass do
 
     @assets.file 'folder/main.css.scss', %(@import "dep";\nbody { color: $color; })
     vendor.file 'dep.css.scss', '@import "folder1/dep1";'
-    vendor.file 'folder1/_dep1.scss', '@import "folder2/*";'
-    vendor.file 'folder1/folder2/_dep2.scss', '$color: blue;'
+    vendor.file 'folder1/_dep1.css.scss', '@import "folder2/*";'
+    vendor.file 'folder1/folder2/_dep2.css.scss', '$color: blue;'
     asset = @env['folder/main.css']
     expect(asset.to_s).to eql("body {\n  color: blue; }\n")
   end
@@ -209,13 +217,13 @@ describe Sprockets::Sass do
     dep = @assets.file 'dep.css.scss', '$color: blue;'
 
     asset = @env['main.css']
-    expect(asset).to be_fresh(@env)
+    old_asset = asset.dup
+    expect(asset).to be_fresh(@env, old_asset)
 
-    mtime = Time.now + 1
-    dep.open('w') { |f| f.write '$color: red;' }
-    dep.utime mtime, mtime
+    write_asset(dep, '$color: red;')
 
-    expect(asset).to_not be_fresh(@env)
+    asset = Sprockets::Sass::Utils.version_of_sprockets >= 3 ? @env['main.css'] : asset
+    expect(asset).to_not be_fresh(@env, old_asset)
   end
 
   it 'adds dependencies from assets when imported' do
@@ -224,28 +232,29 @@ describe Sprockets::Sass do
     dep = @assets.file 'dep-2.css.scss', '$color: blue;'
 
     asset = @env['main.css']
-    expect(asset).to be_fresh(@env)
+    old_asset = asset.dup
+    expect(asset).to be_fresh(@env, old_asset)
 
-    mtime = Time.now + 1
-    dep.open('w') { |f| f.write '$color: red;' }
-    dep.utime mtime, mtime
+    write_asset(dep, '$color: red;')
 
-    expect(asset).to_not be_fresh(@env)
+    asset = Sprockets::Sass::Utils.version_of_sprockets >= 3 ? @env['main.css'] : asset
+    expect(asset).to_not be_fresh(@env, old_asset)
   end
 
   it 'adds dependencies when imported from a glob' do
     @assets.file 'main.css.scss', %(@import "folder/*";\nbody { color: $color; background: $bg-color; })
-    @assets.file 'folder/_dep-1.scss', '$color: blue;'
-    dep = @assets.file 'folder/_dep-2.scss', '$bg-color: red;'
+    @assets.file 'folder/_dep-1.css.scss', '$color: blue;'
+    dep = @assets.file 'folder/_dep-2.css.scss', '$bg-color: red;'
 
     asset = @env['main.css']
-    expect(asset).to be_fresh(@env)
+    old_asset = asset.dup
+    expect(asset).to be_fresh(@env, old_asset)
+
+    write_asset(dep, "$bg-color: white;" )
 
-    mtime = Time.now + 1
-    dep.open('w') { |f| f.write "$bg-color: white;" }
-    dep.utime mtime, mtime
+    asset = Sprockets::Sass::Utils.version_of_sprockets >= 3 ? @env['main.css'] : asset
 
-    expect(asset).to_not be_fresh(@env)
+    expect(asset).to_not be_fresh(@env, old_asset)
   end
 
   it "uses the environment's cache" do
@@ -255,10 +264,14 @@ describe Sprockets::Sass do
     @assets.file 'main.css.scss', %($color: blue;\nbody { color: $color; })
 
     @env['main.css'].to_s
-    if Sass.version[:minor] > 2
-      sass_cache = cache.detect.detect { |key, value| value['pathname'] =~ /main\.css\.scss/ }
+    if Sprockets::Sass::Utils.version_of_sprockets < 3
+      if Sass.version[:minor] > 2
+        sass_cache = cache.detect { |key, value| value['pathname'] =~ /main\.css\.scss/ }
+      else
+        sass_cache = cache.keys.detect { |key| key =~ /main\.css\.scss/ }
+      end
     else
-      sass_cache = cache.keys.detect { |key| key =~ /main\.css\.scss/ }
+      sass_cache = cache.detect { |key, value| value =~ /main\.css\.scss/ }
     end
     expect(sass_cache).to_not be_nil
   end
@@ -345,42 +358,69 @@ describe Sprockets::Sass do
     expect(@env['bullets.css'].to_s).to match(%r[background: url\("/assets/bullet\.gif"\)])
   end
 
-  it 'compresses css' do
-    css = "div {\n  color: red;\n}\n"
-    compressed_css = Sprockets::Sass::Compressor.new.compress(css)
-    expect(compressed_css).to eql("div{color:red}\n")
+  if Sprockets::Sass::Utils.version_of_sprockets < 3
+    it 'compresses css from string' do
+      compressor = Sprockets::Sass::V2::Compressor.new
+      compressed_css = compressor.compress("div {\n  color: red;\n}\n")
+      expect(compressed_css).to eql("div{color:red}\n")
+    end
+  end
+
+  if Sprockets::Sass::Utils.version_of_sprockets >= 3
+    it 'compresses css from filename' do
+      file_path = @assets.file 'asset_path.css.scss', %(div {\n  color: red;\n}\n)
+      compressor = Sprockets::Sass::V3::Compressor.new
+      compressed_css = compressor.run(file_path)
+      expect(compressed_css).to eql("div{color:red}\n")
+    end
+
+    it 'compresses css from string' do
+      compressor = Sprockets::Sass::V3::Compressor.new
+      compressed_css = compressor.run("div {\n  color: red;\n}\n")
+      expect(compressed_css).to eql("div{color:red}\n")
+    end
+  end
+
+  if Sprockets::Sass::Utils.version_of_sprockets < 3
+    it 'compresses css using the environment compressor' do
+      @env.css_compressor =  Sprockets::Sass::V2::Compressor
+      @assets.file 'asset_path.css.scss', %(div {\n  color: red;\n}\n)
+      res = compile_asset_and_return_compilation(@env, @public_dir, "asset_path.css")
+      expect(res).to  eql("div{color:red}\n")
+    end
+  else
+    it 'compresses css using the environment compressor' do
+      @env.css_compressor = :sprockets_sass
+      @assets.file 'asset_path.css.scss', %(div {\n  color: red;\n}\n)
+      res = compile_asset_and_return_compilation(@env, @public_dir, "asset_path.css")
+      expect(res).to  eql("div{color:red}\n")
+    end
   end
+  
 
   describe Sprockets::Sass::SassTemplate do
-    describe 'initialize_engine' do
-      it 'initializes super if super is uninitinalized' do
-        Tilt::SassTemplate.stub(:engine_initialized?).and_return false
-        template = Sprockets::Sass::SassTemplate.new {}
-        template.should_receive(:require_template_library) # called from Tilt::SassTemplate.initialize
-        template.initialize_engine
-      end
 
-      it 'does not initializes super if super is initinalized to silence warnings' do
-        Tilt::SassTemplate.stub(:engine_initialized?).and_return true
-        template = Sprockets::Sass::SassTemplate.new {}
-        template.should_not_receive(:require_template_library) # called from Tilt::SassTemplate.initialize
-        template.initialize_engine
+    let(:template) do
+      Sprockets::Sass::SassTemplate.new(@assets.file 'bullet.gif') do
+        # nothing
       end
+    end
+    describe 'initialize_engine' do
 
-      it 'does not add Sass functions if sprockets-helpers is not available' do
-        template = Sprockets::Sass::SassTemplate.new {}
-        template.should_receive(:require).with('sprockets/helpers').and_raise LoadError
-        template.should_not_receive(:require).with 'sprockets/sass/functions'
-        template.initialize_engine
-        expect(Sprockets::Sass::SassTemplate.engine_initialized?).to be_truthy
+      it 'does add Sass functions if sprockets-helpers is not available' do
+        Sprockets::Sass::SassTemplate.sass_functions_initialized = false
+        Sprockets::Sass.add_sass_functions = true
+        Sprockets::Sass::SassTemplate.any_instance.should_receive(:require).with('sprockets/helpers').and_raise LoadError
+        Sprockets::Sass::SassTemplate.any_instance.should_not_receive(:require).with 'sprockets/sass/functions'
+        template
+        expect(Sprockets::Sass::SassTemplate.engine_initialized?).to be_falsy
       end
 
       it 'does not add Sass functions if add_sass_functions is false' do
         Sprockets::Sass.add_sass_functions = false
-        template = Sprockets::Sass::SassTemplate.new {}
         template.should_not_receive(:require).with 'sprockets/sass/functions'
         template.initialize_engine
-        expect(Sprockets::Sass::SassTemplate.engine_initialized?).to be_truthy
+        expect(Sprockets::Sass::SassTemplate.engine_initialized?).to be_falsy
         Sprockets::Sass.add_sass_functions = true
       end
     end