compass-rails 1.0.3 → 1.1.0

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+gemfiles/*.gemfile.lock
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.travis.yml

@@ -1,5 +1,4 @@
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
 script: "bundle exec rake appraisal:install test"

data/Appraisals

@@ -1,7 +1,3 @@
-appraise "rails2" do
-  gem "rails", "2.3.14"
-end
-
 appraise "rails3" do
   gem "rails", "3.0.11"
 end
@@ -14,4 +10,9 @@ end
 appraise "rails32" do
   gem "rails", "~> 3.2"
   gem "sass-rails"
-end
+end
+
+appraise "rails40" do
+  gem "rails", "~> 4.0.0"
+  gem "sass-rails"
+end

data/Gemfile

@@ -4,13 +4,14 @@ source 'https://rubygems.org'
 gemspec
 
 group :assets do
-  gem 'compass'
-  gem 'compass-rails', :path => '.'
+  gem "compass", '~> 0.13.alpha.0'
+  gem "compass-rails", :path=>"."
+  gem 'compass-blueprint'
 end
 
 group :test do
   gem 'mocha'
-  gem "appraisal", :git => 'git://github.com/scottdavis/appraisal.git'
+  gem "appraisal", :git => 'https://github.com/scottdavis/appraisal.git'
   gem 'rainbow'
 end
 

data/README.md

@@ -1,12 +1,14 @@
 # CompassRails
 
+[![Build Status](https://travis-ci.org/Compass/compass-rails.png?branch=stable)](https://travis-ci.org/Compass/compass-rails)
+
 Compass rails is an adapter for the [Compass Stylesheet Authoring
-Framework](http://compass-style.org) for [Ruby on Rails](http://http://rubyonrails.org/).
+Framework](http://compass-style.org) for [Ruby on Rails](http://rubyonrails.org/).
 
 Since Compass v0.12, this adapter is the only way to install compass
 into your rails application.
 
-This adapter supports rails versions 2.3 and greater. Rails 2.3 and 3.0 users
+This adapter supports rails versions 3.0 and greater. Rails 3.0 users
 please read the caveats below.
 
 ## Installation
@@ -27,6 +29,8 @@ And then execute:
 
     $ bundle
 
+## Optional
+
 To set up your project with starter stylesheets and a configuration
 file:
 
@@ -38,21 +42,28 @@ If using a compass-based framework (like [susy](http://susy.oddbird.net/) or [bl
 
 Note that the `compass init` step is optional if you have a project running Rails 3.0 or greater.
 
-## Upgrading existing rails projects using Compass to CompassRails
+## Usage
 
-First and foremost, follow the installation instructions above.
+Change your `application.css` to `application.css.scss` or `application.css.sass` and use `@import` to your hearts content. Ex:
 
-CompassRails uses the rails convention for stylesheet locations even in
-older versions of rails that do not use the assets pipeline.
-If you have your stylesheets already in `app/stylesheets`, you have two choices:
+```scss
+@import "project/mixins";
+@import "project/base";
 
-1. Move your stylesheets to `app/assets/stylesheets`.
-2. Configure your project to look in the **legacy location** of
-   `app/stylesheets` by setting `config.compass.sass_dir =
-   "app/stylesheets"` in your rails configuration or by setting
-   `sass_dir = "app/stylesheets"` in your compass configuration file.
+```
+
+*or*
+
+Use `application.css` to require files that use compass features. Ex:
+```css
+/*
+ *= require styleguide_full_of_compass_stuff
+ */
+```
+
+*Don't* use `*= require something` within your SCSS or SASS files. You're gonna have a bad time.
 
-## Configuration
+### Configuration
 
 If you have a compass configuration file (recommended) then you can
 use the [Compass configuration 
@@ -62,12 +73,17 @@ files, then you should understand that the compass configuration
 options explained there will be methods and properties on the `config.compass`
 configuration object exposed to rails within any configuration block.
 
-## Usage
+### Notes On Sprockets Directives
+
+Sprockets, used by the rails asset pipeline, provides directives for
+doing things like requiring. These **must not** be used with Sass files.
+Instead use the sass `@import` directive. In rails projects, the
+`@import` directive is configured to work with sprockets via `sass-rails`. For more information on importing in rails 3.1 or greater see the [Sass-Rails README](https://github.com/rails/sass-rails/blob/master/README.md)
 
 ### Developing with Rails-based Compilation
 
 By default, your sass files in `app/assets/stylesheets` will be
-automatically compiled by the the [`Sass::Plugin`](http://sass-lang.com/docs/yardoc/Sass/Plugin.html) or the [Rails asset
+automatically compiled by the [`Sass::Plugin`](http://sass-lang.com/docs/yardoc/Sass/Plugin.html) or the [Rails asset
 pipeline](http://guides.rubyonrails.org/asset_pipeline.html) depending on the version of rails that you use.
 
 When using this approach you will need to reload your webpage in order
@@ -93,11 +109,7 @@ end
 To return to using the Rails-based compilation mode, simply delete
 the compiled stylesheets and remove any configuration changes.
 
-### Compiling for Production
-
-If using the Rails asset pipeline run:
-
-    $ rake assets:precompile
+### Compiling for Production without Asset Pipeline
 
 If not using the asset pipeline run:
 
@@ -109,10 +121,7 @@ stylesheets.
 
 ### Installing Compass extensions
 
-Step 1: If the extension is a rubygem, Add it to your Gemfile in the
-`:assets` group and run the `bundle` command to install it.
-If the extension is a zip file, unzip it into the
-`vendor/plugins/compass_extensions` directory of your project.
+Step 1: Add it to your Gemfile in the `:assets` group and run the `bundle` command to install it.
 
 Step 2: Install the extension's assets: `bundle exec compass install 
 <extension/template>`
@@ -140,18 +149,9 @@ config.compass.require "susy"
 
 to your application.rb configuration file.
 
-
-### Notes On Sprockets Directives
-
-Sprockets, used by the rails asset pipeline, provides directives for
-doing things like requiring. These **must not** be used with Sass files.
-Instead use the sass `@import` directive. In rails projects, the
-`@import` directive is configured to work with sprockets via `sass-rails`. For more information on importing in rails 3.1 or greater see the [Sass-Rails README](https://github.com/rails/sass-rails/blob/master/README.markdown)
-
 ## Rails 3.1 Caveats
 
-There was a bug in rails 3.1.0 -- please make sure you are running 3.1.1
-at the earliest for this version of rails.
+compass-rails requires Rails 3.1.1 and greater. Also, Rails 3.1 is out of support so consider upgrading.
 
 ## Rails 3.0 Caveats
 
@@ -168,34 +168,21 @@ to this:
 Bundler.require(:default, :assets, Rails.env) if defined?(Bundler)
 ```
 
-## Rails 2.3 Caveats
-
-Compass requires that your rails 2.3 project is using Bundler to manage
-your rubygems. If you haven't yet set up your rails 2.3 project to use Bundler,
-please do so prior to upgrading. [Bundler installation guide for rails
-2.3](http://gembundler.com/rails23.html).
+ Also, Rails 3.0 is out of support so consider upgrading.
 
-After following the instructions there, if you want rails to compile
-your stylesheets (instead of using the compass watcher) you need
-edit `config/boot.rb` and change this:
+## Upgrading Rails 3.0 and older projects to compass-rails
 
-```ruby
-Rails::Initializer.class_eval do
-  def load_gems
-    @bundler_loaded ||= Bundler.require :default, Rails.env
-  end
-end
-```
+First and foremost, follow the installation instructions above.
 
-To this:
+CompassRails uses the rails convention for stylesheet locations even in
+older versions of rails that do not use the assets pipeline.
+If you have your stylesheets already in `app/stylesheets`, you have two choices:
 
-```ruby
-Rails::Initializer.class_eval do
-  def load_gems
-    @bundler_loaded ||= Bundler.require :default, :assets, Rails.env
-  end
-end
-```
+1. Move your stylesheets to `app/assets/stylesheets`.
+2. Configure your project to look in the **legacy location** of
+   `app/stylesheets` by setting `config.compass.sass_dir =
+   "app/stylesheets"` in your rails configuration or by setting
+   `sass_dir = "app/stylesheets"` in your compass configuration file.
 
 ## Contributing
 

data/changelog.markdown

@@ -0,0 +1,11 @@
+# Compass Rails
+
+## 2.0.alpha.0
+
+* Removed rails 2.x support
+* Added Alpha support for rails 4
+
+## 1.0.3
+
+* StaticCompiler hack so sprite source files dont show up in manifest
+* Compass version bump to 0.12.2

data/compass-rails.gemspec

@@ -3,9 +3,9 @@ require File.expand_path('../lib/compass-rails/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Scott Davis", "Chris Eppstein"]
-  gem.email         = ["jetviper21@gmail.com", "chris@eppsteins.net"]
-  gem.description   = %q{Integrate Compass into Rails 2.3 and up.}
-  gem.summary       = %q{Integrate Compass into Rails 2.3 and up.}
+  gem.email         = ["jetviper21@gmail.com", "chris@eppsteins.net", "craig.mcnamara@gmail.com"]
+  gem.description   = %q{Integrate Compass into Rails 3.0 and up.}
+  gem.summary       = %q{Integrate Compass into Rails 3.0 and up.}
   gem.homepage      = "https://github.com/Compass/compass-rails"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/gemfiles/rails3.gemfile

@@ -9,12 +9,13 @@ gem "guard-test"
 gem "rails", "3.0.11"
 
 group :assets do
-  gem "compass"
+  gem "compass", "~> 0.13.alpha.0"
   gem "compass-rails", :path=>".."
+  gem "compass-blueprint"
 end
 group :test do
   gem "mocha"
-  gem "appraisal", :git=>"git://github.com/scottdavis/appraisal.git"
+  gem "appraisal", :git=>"https://github.com/scottdavis/appraisal.git"
   gem "rainbow"
 end
 

data/gemfiles/rails31.gemfile

@@ -10,12 +10,13 @@ gem "rails", "3.1.3"
 gem "sass-rails"
 
 group :assets do
-  gem "compass"
+  gem "compass", "~> 0.13.alpha.0"
   gem "compass-rails", :path=>".."
+  gem "compass-blueprint"
 end
 group :test do
   gem "mocha"
-  gem "appraisal", :git=>"git://github.com/scottdavis/appraisal.git"
+  gem "appraisal", :git=>"https://github.com/scottdavis/appraisal.git"
   gem "rainbow"
 end
 

data/gemfiles/rails32.gemfile

@@ -10,12 +10,13 @@ gem "rails", "~> 3.2"
 gem "sass-rails"
 
 group :assets do
-  gem "compass"
+  gem "compass", "~> 0.13.alpha.0"
   gem "compass-rails", :path=>".."
+  gem "compass-blueprint"
 end
 group :test do
   gem "mocha"
-  gem "appraisal", :git=>"git://github.com/scottdavis/appraisal.git"
+  gem "appraisal", :git=>"https://github.com/scottdavis/appraisal.git"
   gem "rainbow"
 end
 

data/gemfiles/{rails2.gemfile → rails40.gemfile}

@@ -6,15 +6,17 @@ gem "rb-fsevent", :require=>false
 gem "ruby_gntp", :require=>false
 gem "guard"
 gem "guard-test"
-gem "rails", "2.3.14"
+gem "rails", "~> 4.0.0"
+gem "sass-rails"
 
 group :assets do
-  gem "compass"
+  gem "compass", "~> 0.13.alpha.0"
   gem "compass-rails", :path=>".."
+  gem "compass-blueprint"
 end
 group :test do
   gem "mocha"
-  gem "appraisal", :git=>"git://github.com/scottdavis/appraisal.git"
+  gem "appraisal", :git=>"https://github.com/scottdavis/appraisal.git"
   gem "rainbow"
 end
 

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

@@ -42,6 +42,10 @@ module CompassRails
         ::Rails.application.config.sass.preferred_syntax rescue nil
       end
 
+      def default_sprite_load_path
+        CompassRails.sprockets.paths
+      end
+
     end
   end
 end

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

@@ -2,6 +2,11 @@ require 'compass-rails/patches/static_compiler'
 
 module Sass::Script::Functions
   def generated_image_url(path, only_path = nil)
+    path = if Compass.configuration.generated_images_dir
+             full_path = File.join(Compass.configuration.generated_images_dir, path.value)
+             Sass::Script::String.new full_path.sub(File.join('app', 'assets', 'images'), "")[1..-1]
+           end
+
     asset_url(path, Sass::Script::String.new("image"))
   end
 end
@@ -9,7 +14,7 @@ end
 
 module Compass::RailsImageFunctionPatch
   private
-  
+
   def image_path_for_size(image_file)
     begin
       file = ::Rails.application.assets.find_asset(image_file)

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

@@ -0,0 +1,30 @@
+require 'compass-rails/patches/sass_importer'
+require 'compass-rails/patches/sprite_importer'
+module Sass::Script::Functions
+  def generated_image_url(path, only_path = nil)
+    asset_url(path)
+  end
+end
+
+
+module Compass::RailsImageFunctionPatch
+  private
+  
+  def image_path_for_size(image_file)
+    begin
+      file = ::Rails.application.assets.find_asset(image_file)
+      return file
+    rescue ::Sprockets::FileOutsidePaths
+      return super(image_file)
+    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/sass_importer.rb

@@ -0,0 +1,31 @@
+module Sprockets
+  class SassTemplate < Tilt::Template
+    def evaluate(context, locals, &block)
+      # Use custom importer that knows about Sprockets Caching
+      cache_store = SassCacheStore.new(context.environment)
+      paths  = context.environment.paths.map { |path| CompassRails::SpriteImporter.new(context, path) }
+      paths += context.environment.paths.map { |path| SassImporter.new(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 => SassImporter.new(context, context.pathname),
+        :load_paths => paths,
+        :sprockets => {
+          :context => context,
+          :environment => context.environment
+        }
+      })
+
+      ::Sass::Engine.new(data, options).render
+    rescue ::Sass::SyntaxError => e
+      # Annotates exception message with parse line number
+      context.__LINE__ = e.sass_backtrace.first[:line]
+      raise e
+    end
+  end
+end

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

@@ -1,38 +1,30 @@
 require 'sprockets'
 require 'compass/sprite_importer'
 
-module Compass
-  class SpriteImporter < Sass::Importers::Base
+module CompassRails
+  class SpriteImporter < Compass::SpriteImporter
+    attr_reader :context, :root
 
-    alias :old_find :find
+    def initialize(context, root)
+      @context = context
+      @root = root
+    end
 
     def find(uri, options)
-
-      if old = old_find(uri, options)
-        @_options = options
+      if old = super(uri, options)
         self.class.files(uri).each do |file|
-          if pathname = resolve(file)
-            context.depend_on(pathname)
+          puts file.inspect
+          relative_path = Pathname.new(file).relative_path_from(Pathname.new(root))
+          begin
+            pathname = context.resolve(relative_path)
+            context.depend_on_asset(pathname)
+          rescue Sprockets::FileNotFound
+
           end
         end
       end
 
       old
     end
-
-  private
-
-    def resolve(uri)
-      resolver.resolve(Pathname.new(uri))
-    end
-
-    def context
-     resolver.context
-    end
-
-    def resolver
-      @_options[:custom][:resolver]
-    end
-
   end
 end

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

@@ -1,5 +1,4 @@
 require 'sprockets/static_compiler'
-
 module Sprockets
   class StaticCompiler
     cattr_accessor :generated_sprites
@@ -10,3 +9,4 @@ module Sprockets
     alias_method_chain :write_manifest, :sprites
   end
 end
+

data/lib/compass-rails/patches.rb

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

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

@@ -88,12 +88,16 @@ module CompassRails
   class Railtie < Rails::Railtie
 
     initializer "compass.initialize_rails", :group => :all do |app|
-      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)
+      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
     end
   end
 end

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

@@ -0,0 +1,102 @@
+#3.1.3
+require 'compass'
+require 'rails/railtie'
+
+class Rails::Railtie::Configuration
+  # Adds compass configuration accessor to the application configuration.
+  #
+  # If a configuration file for compass exists, it will be read in and
+  # the project's configuration values will already be set on the config
+  # object.
+  #
+  # For example:
+  #
+  #     module MyApp
+  #       class Application < Rails::Application
+  #          config.compass.line_comments = !Rails.env.production?
+  #          config.compass.fonts_dir = "app/assets/fonts"
+  #       end
+  #     end
+  #
+  # It is suggested that you create a compass configuration file if you
+  # want a quicker boot time when using the compass command line tool.
+  #
+  # For more information on available configuration options see:
+  # http://compass-style.org/help/tutorials/configuration-reference/
+  def compass
+    @compass ||= begin
+      data = if (config_file = Compass.detect_configuration_file) && (config_data = Compass.configuration_for(config_file))
+        config_data
+      else
+        Compass::Configuration::Data.new("rails_config")
+      end
+      data.project_type = :rails # Forcing this makes sure all the rails defaults will be loaded.
+      Compass.add_configuration(:rails)
+      Compass.add_configuration(data)
+      Compass.configuration.on_sprite_saved do |filename|
+        # This is a huge hack based on reading through the sprockets internals.
+        # Sprockets needs an API for adding assets during precompilation.
+        # At a minimum sprockets should provide this API:
+        #
+        #     #filename is a path in the asset source directory
+        #     Rails.application.assets.new_asset!(filename)
+        #
+        #     # logical_path is how devs refer to it, data is the contents of it.
+        #     Rails.application.assets.new_asset!(logical_path, data)
+        #
+        # I would also like to select one of the above calls based on whether
+        # the user is precompiling or not:
+        #
+        #     Rails.application.assets.precompiling? #=> true or false
+        #
+        # But even the above is not an ideal API. The issue is that compass sprites need to
+        # avoid generation if the sprite file is already generated (which can be quite time
+        # consuming). To do this, compass has it's own uniqueness hash based on the user's
+        # inputs instead of being based on the file contents. So if we could provide our own
+        # hash or some metadata that is opaque to sprockets that could be read from the
+        # asset's attributes, we could avoid cluttering the assets directory with generated
+        # sprites and always just use the logical_path + data version of the api.
+        if Rails.application.config.assets.digest && # if digesting is enabled
+            caller.grep(%r{/sprockets/rails/task.rb}).any? && #OMG HAX - check if we're being precompiled
+            Compass.configuration.generated_images_path[Compass.configuration.images_path.to_s] # if the generated images path is not in the assets images directory, we don't have to do these backflips
+
+          # 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))
+
+          pathname      = Pathname.new(filename)
+          logical_path  = pathname.relative_path_from(Pathname.new(Compass.configuration.images_path))
+          asset         = Rails.application.assets.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
+
+
+          # Adds the fingerprinted asset to the public directory
+          FileUtils.mkdir_p File.dirname(target)
+          asset.write_to target
+
+        end
+      end
+      data
+    end
+    @compass
+  end
+end
+
+module CompassRails
+  class Railtie < Rails::Railtie
+
+    initializer "compass.initialize_rails", :group => :all do |app|
+      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
+  end
+end

data/lib/compass-rails/railties.rb

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

data/lib/compass-rails/version.rb

@@ -1,5 +1,5 @@
 module CompassRails
   unless defined?(::CompassRails::VERSION)
-    VERSION = "1.0.3"
+    VERSION = "1.1.0"
   end
 end