compass-rails 2.0.0 → 4.0.0

data/lib/compass-rails/patches.rb

@@ -1,6 +1,3 @@
 if CompassRails.rails31? || CompassRails.rails32?
-  CompassRails.load_rails
   require 'compass-rails/patches/importer'
-elsif CompassRails.rails4?
-  CompassRails.load_rails
 end

data/lib/compass-rails/patches/3_1.rb

@@ -1,17 +1,8 @@
 require 'compass-rails/patches/compass'
 require 'compass-rails/patches/static_compiler'
 
-module Sass::Script::Functions
-  def generated_image_url(path, only_path = nil)
-    asset_url(path, Sass::Script::String.new("image"))
+Compass::Core::SassExtensions::Functions::Urls::GeneratedImageUrl.module_eval do
+  def generated_image_url(path, cache_buster = Sass::Script::Bool.new(false))
+    asset_url(path, Sass::Script::String.new('image'))
   end
 end
-
-module Sass::Script::Functions
-  include Compass::RailsImageFunctionPatch
-end
-
-# Wierd that this has to be re-included to pick up sub-modules. Ruby bug?
-class Sass::Script::Functions::EvaluationContext
-  include Sass::Script::Functions
-end

data/lib/compass-rails/patches/4_0.rb

@@ -2,44 +2,38 @@ require 'compass-rails/patches/compass'
 require 'compass-rails/patches/sass_importer'
 require 'compass-rails/patches/sprite_importer'
 
-module Sass::Script::Functions
-  def generated_image_url(path, only_path = nil)
-    pathobject = Pathname.new(path.to_s)
-    subdirectory = pathobject.dirname.to_s
-
-    cachebust_generated_images(path, subdirectory)
+Compass::Core::SassExtensions::Functions::Urls::GeneratedImageUrl.module_eval do
+  def generated_image_url(path, cache_buster = Sass::Script::Bool.new(false))
+    cachebust_generated_images(path)
     asset_url(path)
   end
 
-  def cachebust_generated_images(image_path, subdirectory = nil)
-    generated_images_path = Rails.root.join(Compass.configuration.generated_images_dir).to_s
-    if subdirectory.nil? 
-        bust_cache_path = generated_images_path
+  def cachebust_generated_images(path)
+    generated_images_dir = Compass.configuration.generated_images_dir
+    generated_images_dir = Rails.root.join(generated_images_dir)
+
+    sprockets_env = options[:sprockets][:environment]
+
+    if sprockets_env.respond_to?(:trail, true)
+      sprockets_trail = sprockets_env.send(:trail)
     else
-        bust_cache_path = generated_images_path + "/" + subdirectory
+      sprockets_trail = sprockets_env.index
     end
-    bust_image_stat_path = generated_images_path + "/" + image_path.to_s
 
-    sprockets_entries = options[:sprockets][:environment].send(:trail).instance_variable_get(:@entries)
+    sprockets_entries = sprockets_trail.instance_variable_get(:@entries) || {}
+    sprockets_stats   = sprockets_trail.instance_variable_get(:@stats) || {}
 
-    # sprockets_entries.delete(generated_images_path) if sprockets_entries.has_key? generated_images_path
-    if sprockets_entries.has_key? generated_images_path
-        # sprockets_entries.delete(generated_images_path) 
+    if sprockets_entries.key?(generated_images_dir.to_s)
+      path = path.value
+      dir  = File.dirname(path)
 
-        # Delete the entries (directories) which cache the files/dirs in a directory
-        options[:sprockets][:environment].send(:trail).instance_variable_get(:@entries).delete(bust_cache_path) 
+      # Delete the entries (directories) which cache the files/dirs in a directory
+      entry = generated_images_dir.join(dir).to_s
+      sprockets_entries.delete(entry)
 
-        # Delete the stats (file/dir info) which cache the what kind of file/dir each image is
-        options[:sprockets][:environment].send(:trail).instance_variable_get(:@stats).delete(bust_image_stat_path) 
+      # Delete the stats (file/dir info) which cache the what kind of file/dir each image is
+      stat = generated_images_dir.join(path).to_s
+      sprockets_stats.delete(stat)
     end
   end
 end
-
-module Sass::Script::Functions
-  include Compass::RailsImageFunctionPatch
-end
-
-# Wierd that this has to be re-included to pick up sub-modules. Ruby bug?
-class Sass::Script::Functions::EvaluationContext
-  include Sass::Script::Functions
-end

data/lib/compass-rails/patches/compass.rb

@@ -1,10 +1,10 @@
-module Compass::RailsImageFunctionPatch
+Compass::Core::SassExtensions::Functions::ImageSize.class_eval do
   private
 
   def image_path_for_size(image_file)
     begin
-      file = ::Rails.application.assets.find_asset(image_file)
-      return file
+      file = ::CompassRails.sprockets.find_asset(image_file)
+      return (file.respond_to?(:pathname) ? file.pathname.to_s : file)
     rescue ::Sprockets::FileOutsidePaths
       return super(image_file)
     end

data/lib/compass-rails/patches/importer.rb

@@ -4,18 +4,16 @@ module Compass
     attr_accessor :sass_options
     STYLESHEET = /stylesheet/
     def sass_options
-      if CompassRails.asset_pipeline_enabled?
-        @sass_options[:custom] ||= {}
-        @sass_options[:custom] = {:resolver => ::Sass::Rails::Resolver.new(CompassRails.context)}
-        @sass_options[:load_paths] ||= []
-        unless @sass_options[:load_paths].any? {|k| k.is_a?(::Sass::Rails::Importer) }
-          ::Rails.application.assets.paths.each do |path|
-            next unless path.to_s =~ STYLESHEET
-            Dir["#{path}/**/*"].each do |pathname|
-              # args are: sprockets environment, the logical_path ex. 'stylesheets', and the full path name for the render
-              context = ::CompassRails.context.new(::Rails.application.assets, File.basename(path), Pathname.new(pathname))
-              @sass_options[:load_paths] << ::Sass::Rails::Importer.new(context)
-            end
+      @sass_options[:custom] ||= {}
+      @sass_options[:custom] = {:resolver => ::Sass::Rails::Resolver.new(CompassRails.context)}
+      @sass_options[:load_paths] ||= []
+      unless @sass_options[:load_paths].any? {|k| k.is_a?(::Sass::Rails::Importer) }
+        ::CompassRails.sprockets.paths.each do |path|
+          next unless path.to_s =~ STYLESHEET
+          Dir["#{path}/**/*"].each do |pathname|
+            # args are: sprockets environment, the logical_path ex. 'stylesheets', and the full path name for the render
+            context = ::CompassRails.context.new(::CompassRails.sprockets, File.basename(path), Pathname.new(pathname))
+            @sass_options[:load_paths] << ::Sass::Rails::Importer.new(context)
           end
         end
       end

data/lib/compass-rails/patches/sass_importer.rb

@@ -7,18 +7,23 @@ end
 klass.class_eval do
   def evaluate(context, locals, &block)
     # Use custom importer that knows about Sprockets Caching
-    cache_store = Sprockets::SassCacheStore.new(context.environment)
-    paths  = context.environment.paths.map { |path| CompassRails::SpriteImporter.new(context, path) }
-    paths += context.environment.paths.map { |path| self.class.parent::SassImporter.new(context, path) }
-    paths += ::Rails.application.config.sass.load_paths
+    cache_store =
+      if defined?(Sprockets::SassProcessor::CacheStore)
+        Sprockets::SassProcessor::CacheStore.new(sprockets_cache_store, context.environment)
+      else
+        Sprockets::SassCacheStore.new(context.environment)
+      end
 
+    paths  = context.environment.paths.map { |path| CompassRails::SpriteImporter.new(path) }
+    paths += context.environment.paths.map { |path| sass_importer(context, path) }
+    paths += ::Rails.application.config.sass.load_paths
 
     options = CompassRails.sass_config.merge( {
       :filename => eval_file,
       :line => line,
       :syntax => syntax,
       :cache_store => cache_store,
-      :importer => self.class.parent::SassImporter.new(context, context.pathname),
+      :importer => sass_importer(context, context.pathname),
       :load_paths => paths,
       :sprockets => {
         :context => context,
@@ -26,11 +31,66 @@ klass.class_eval do
       }
     })
 
-    ::Sass::Engine.new(data, options).render
+    engine = ::Sass::Engine.new(data, options)
+
+    engine.dependencies.map do |dependency|
+      filename = dependency.options[:filename]
+      if filename.include?('*') # Handle sprite globs
+        image_path = Rails.root.join(Compass.configuration.images_dir).to_s
+        Dir[File.join(image_path, filename)].each do |f|
+          context.depend_on(f)
+        end
+      else
+        context.depend_on(filename) if File.exist?(filename)
+      end
+    end
+
+    engine.render
   rescue ::Sass::SyntaxError => e
     # Annotates exception message with parse line number
     context.__LINE__ = e.sass_backtrace.first[:line]
     raise e
   end
-end    
 
+  private
+
+  def sass_importer_artiy
+    @sass_importer_artiy ||= sass_importer_class.instance_method(:initialize).arity
+  end
+
+  def sass_importer(context, path)
+    case sass_importer_artiy.abs
+    when 1
+      sass_importer_class.new(path)
+    else
+      sass_importer_class.new(context, path)
+    end
+  end
+
+  # if using haml-rails, self.class.parent = Haml::Filters (which doesn't have an implementation)
+  def sass_importer_class
+    @sass_importer_class ||= if defined?(self.class.parent::SassImporter)
+                               self.class.parent::SassImporter
+                             elsif defined?(Sass::Rails::SassTemplate)
+                               Sass::Rails::SassImporter
+                             else
+                               Sprockets::SassImporter
+                             end
+  end
+
+  def sprockets_cache_store
+    cache =
+      case Rails.application.config.assets.cache_store
+      when :null_store
+        Sprockets::Cache::NullStore.new
+      when :memory_store, :mem_cache_store
+        Sprockets::Cache::MemoryStore.new
+      else
+        path = "#{Rails.application.config.root}/tmp/cache/assets/#{Rails.env}"
+
+        Sprockets::Cache::FileStore.new(path)
+      end
+
+    Sprockets::Cache.new(cache, Rails.logger)
+  end
+end

data/lib/compass-rails/patches/sprite_importer.rb

@@ -3,19 +3,19 @@ require 'compass/sprite_importer'
 
 module CompassRails
   class SpriteImporter < Compass::SpriteImporter
-    attr_reader :context, :root
+    attr_reader :root
 
-    def initialize(context, root)
-      @context = context
+    def initialize(root)
       @root = root
     end
 
     def find(uri, options)
       if old = super(uri, options)
+        context = options[:sprockets][:context]
         self.class.files(uri).each do |file|
           relative_path = Pathname.new(file).relative_path_from(Pathname.new(root))
           begin
-            pathname = context.resolve(relative_path)
+            pathname = context.resolve(relative_path.to_s)
             context.depend_on_asset(pathname)
           rescue Sprockets::FileNotFound
 

data/lib/compass-rails/railties.rb

@@ -1,9 +1,7 @@
 if defined?(::Rails)
   if CompassRails.rails31? || CompassRails.rails32?
     require "compass-rails/railties/3_1"
-  elsif CompassRails.rails4?
-    require "compass-rails/railties/4_0"
   else
-    $stderr.puts "Unsupported rails environment for compass"
+    require "compass-rails/railties/4_0"
   end
 end

data/lib/compass-rails/railties/3_1.rb

@@ -3,16 +3,9 @@ module CompassRails
 
     initializer "compass.initialize_rails", :group => :all do |app|
       require 'compass'
-      if CompassRails.asset_pipeline_enabled?
-        require 'compass-rails/patches/3_1'
-        # Configure compass for use within rails, and provide the project configuration
-        # that came via the rails boot process.
-        CompassRails.check_for_double_boot!
-        Compass.discover_extensions!
-        CompassRails.configure_rails!(app)
-      else
-        CompassRails.initialize!(app.config.compass)
-      end
+      require 'compass-rails/patches/3_1'
+      Compass.discover_extensions!
+      CompassRails.configure_rails!(app)
     end
 
     config.compass = begin
@@ -32,11 +25,11 @@ module CompassRails
 
             # Clear entries in Hike::Index for this sprite's directory.
             # This makes sure the asset can be found by find_assets
-            Rails.application.assets.send(:trail).instance_variable_get(:@entries).delete(File.dirname(filename))
+            CompassRails.sprockets.send(:trail).instance_variable_get(:@entries).delete(File.dirname(filename))
 
             pathname      = Pathname.new(filename)
             logical_path  = pathname.relative_path_from(Pathname.new(Compass.configuration.images_path))
-            asset         = Rails.application.assets.find_asset(logical_path)
+            asset         = CompassRails.sprockets.find_asset(logical_path)
             target        = File.join(Rails.public_path, Rails.application.config.assets.prefix, asset.digest_path)
 
             # Adds the asset to the manifest file.

data/lib/compass-rails/railties/4_0.rb

@@ -4,9 +4,6 @@ module CompassRails
     initializer "compass.initialize_rails", :group => :all do |app|
       require 'compass'
       require 'compass-rails/patches/4_0'
-      # Configure compass for use within rails, and provide the project configuration
-      # that came via the rails boot process.
-      CompassRails.check_for_double_boot!
       Compass.discover_extensions!
       CompassRails.configure_rails!(app)
     end
@@ -28,19 +25,24 @@ module CompassRails
 
             # Clear entries in Hike::Index for this sprite's directory.
             # This makes sure the asset can be found by find_assets
-            trail = Rails.application.assets.send(:trail)
-            trail.instance_variable_get(:@entries).delete(File.dirname(filename))
-            trail.instance_variable_get(:@stats).delete(filename)
+            if CompassRails.sprockets.respond_to?(:trail, true)
+              index = CompassRails.sprockets.send(:trail).index
+            else
+              index = CompassRails.sprockets.index
+            end
+
+            index.instance_variable_get(:@entries).delete(File.dirname(filename))
+            index.instance_variable_get(:@stats).delete(filename)
 
             pathname      = Pathname.new(filename)
-            logical_path  = pathname.relative_path_from(Pathname.new(Compass.configuration.images_path))
-            asset         = Rails.application.assets.find_asset(logical_path)
+            logical_path  = pathname.relative_path_from(Pathname.new(Compass.configuration.images_path)).to_s
+            asset         = CompassRails.sprockets.find_asset(logical_path)
             target        = File.join(Rails.public_path, Rails.application.config.assets.prefix, asset.digest_path)
 
             # Adds the asset to the manifest file.
 
             manifest = ActionView::Base.assets_manifest
-            manifest.assets[logical_path.to_s] = asset.digest_path
+            manifest.assets[logical_path] = asset.digest_path
 
 
             # Adds the fingerprinted asset to the public directory

data/lib/compass-rails/version.rb

@@ -1,5 +1,3 @@
 module CompassRails
-  unless defined?(::CompassRails::VERSION)
-    VERSION = "2.0.0"
-  end
+  VERSION = '4.0.0' unless defined?(::CompassRails::VERSION)
 end

data/test/compass_rails_spec.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+describe CompassRails do
+  include CompassRails::Test::RailsHelpers
+
+  it "compiles a basic compass stylesheet" do
+    within_rails_app('test_railtie') do |project|
+      project.setup_asset_fixtures!
+
+      assert project.boots?
+
+      project.precompile!
+
+      project.compiled_stylesheet 'public/assets/application*.css' do |css|
+        refute css.empty?
+        assert_match 'body container', css
+        assert_match "-webkit-linear-gradient", css
+        assert_match "-moz-border-radius", css
+        assert_match '.numbers-sprite-1', css
+        assert_match '.numbers-sprite-2', css
+        assert_match '.letters-a', css
+        assert_match '.letters-a', css
+      end
+    end
+  end
+
+  it "supports rails config arguments" do
+    within_rails_app('test_railtie') do |project|
+      assert_equal "scss", project.rails_property("sass.preferred_syntax")
+      assert_equal "public/assets", project.rails_property("compass.css_dir")
+
+      project.set_rails('sass.preferred_syntax', :sass)
+      project.set_rails('compass.css_dir', "public/stylesheets")
+
+      assert_equal "sass", project.rails_property("sass.preferred_syntax")
+      assert_equal "public/stylesheets", project.rails_property("compass.css_dir")
+    end
+  end unless ENV['DEBUG_COMPILE']
+
+  it "compiles when in production mode" do
+    within_rails_app('test_railtie') do |project|
+      project.setup_asset_fixtures!
+
+      # Mimic Rails production mode
+      project.set_rails('assets.compile', false)
+
+      assert project.boots?
+
+      project.precompile!
+
+      project.compiled_stylesheet 'public/assets/application*.css' do |css|
+        refute css.empty?
+        assert_match 'body container', css
+        assert_match '.numbers-sprite-1', css
+      end
+    end
+  end
+end

data/test/fixtures/assets/stylesheets/application.css.scss

@@ -0,0 +1,23 @@
+// Import Compass
+@import "compass";
+
+// Glob import SCSS partials
+@import "partials/*";
+
+// Import Sprites
+@import "letters/*.png";
+@include all-letters-sprites;
+
+// Inline Sprites
+$numbers-inline: true;
+@import "numbers/sprite-*.png";
+@include all-numbers-sprites;
+
+// Try out some compass stuff
+body{
+  @include background-image(linear-gradient(white, #aaaaaa));
+
+  container{
+    @include border-radius(4px, 4px);
+  }
+}