compass-rails31 0.12.0.alpha.0.91a748a

data/lib/compass/app_integration/rails.rb

@@ -0,0 +1,83 @@
+%w(configuration_defaults installer).each do |lib|
+  require "compass/app_integration/rails/#{lib}"
+end
+
+require 'compass/app_integration/rails/runtime' if defined?(ActionController::Base)
+
+
+module Compass
+  module AppIntegration
+    module Rails
+
+      extend self
+
+      def booted!
+        Compass::AppIntegration::Rails.const_set(:BOOTED, true)
+      end
+
+      def booted?
+        defined?(Compass::AppIntegration::Rails::BOOTED) && Compass::AppIntegration::Rails::BOOTED
+      end
+
+      def installer(*args)
+        Installer.new(*args)
+      end
+
+      def configuration
+        config = Compass::Configuration::Data.new('rails')
+        config.extend(ConfigurationDefaults)
+        config.extend(ConfigurationDefaultsWithAssetPipeline) if Sass::Util.ap_geq?('3.1.0.beta')
+        config
+      end
+
+      def env
+        env_production? ? :production : :development
+      end
+
+      def env_production?
+        if defined?(::Rails) && ::Rails.respond_to?(:env)
+          ::Rails.env.production?
+        elsif defined?(RAILS_ENV)
+          RAILS_ENV == "production"
+        end
+      end
+
+      def root
+        if defined?(::Rails) && ::Rails.respond_to?(:root)
+          ::Rails.root
+        elsif defined?(RAILS_ROOT)
+          RAILS_ROOT
+        end
+      end
+
+      def check_for_double_boot!
+        if booted?
+          Compass::Util.compass_warn("Warning: Compass was booted twice. Compass has a Railtie now; please remove your initializer.")
+        else
+          booted!
+        end
+      end
+
+      def sass_plugin_enabled?
+        unless Sass::Util.ap_geq?('3.1.0.beta')
+          defined?(Sass::Plugin) && !Sass::Plugin.options[:never_update]
+        end
+      end
+
+      def rails_compilation_enabled?
+        Sass::Util.ap_geq?('3.1.0.beta') && defined?(Sass::Rails) # XXX check if there's some other way(s) to disable the asset pipeline.
+      end
+
+      # Rails 2.x projects use this in their compass initializer.
+      def initialize!(config = nil)
+        check_for_double_boot!
+        config ||= Compass.detect_configuration_file(root)
+        Compass.add_project_configuration(config, :project_type => :rails)
+        Compass.discover_extensions!
+        Compass.configure_sass_plugin!
+        Compass.handle_configuration_change! if sass_plugin_enabled? || rails_compilation_enabled?
+      end
+    end
+  end
+end
+

data/lib/compass/app_integration/rails/actionpack2x.rb

@@ -0,0 +1,10 @@
+%w(action_controller sass_plugin urls).each do |lib|
+  require "compass/app_integration/rails/actionpack2x/#{lib}"
+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
+  private
+  include ActionView::Helpers::AssetTagHelper
+end

data/lib/compass/app_integration/rails/actionpack2x/action_controller.rb

@@ -0,0 +1,15 @@
+# :stopdoc:
+module ActionController
+  class Base
+    def process_with_compass(*args)
+      Sass::Plugin.rails_controller = self
+      begin
+        process_without_compass(*args)
+      ensure
+        Sass::Plugin.rails_controller = nil
+      end
+    end
+    alias_method_chain :process, :compass
+  end
+end
+# :startdoc:

data/lib/compass/app_integration/rails/actionpack2x/sass_plugin.rb

@@ -0,0 +1,5 @@
+module Sass::Plugin
+  class << self
+    attr_accessor :rails_controller
+  end
+end

data/lib/compass/app_integration/rails/actionpack2x/urls.rb

@@ -0,0 +1,18 @@
+module Compass::SassExtensions::Functions::Urls
+  def image_url_with_rails_integration(path, only_path = Sass::Script::Bool.new(false), cache_buster = Sass::Script::Bool.new(true))
+    if (@controller = Sass::Plugin.rails_controller) && @controller.respond_to?(:request) && @controller.request
+      begin
+        if only_path.to_bool
+          Sass::Script::String.new image_path(path.value)
+        else
+          Sass::Script::String.new "url(#{image_path(path.value)})"
+        end
+      ensure
+        @controller = nil
+      end
+    else
+      image_url_without_rails_integration(path, only_path, cache_buster)
+    end
+  end
+  alias_method_chain :image_url, :rails_integration
+end

data/lib/compass/app_integration/rails/actionpack30.rb

@@ -0,0 +1,11 @@
+# TODO figure something out so image_path works with rails integration
+%w(railtie).each do |lib|
+  require "compass/app_integration/rails/actionpack30/#{lib}"
+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
+  private
+  include ActionView::Helpers::AssetTagHelper
+end

data/lib/compass/app_integration/rails/actionpack30/railtie.rb

@@ -0,0 +1,49 @@
+require 'compass'
+require 'rails'
+
+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("project")
+      end
+      data.project_type = :rails # Forcing this makes sure all the rails defaults will be loaded.
+      data
+    end
+  end
+end
+
+module Compass
+  class Railtie < Rails::Railtie
+    initializer "compass.initialize_rails" do |app|
+      # Configure compass for use within rails, and provide the project configuration
+      # that came via the rails boot process.
+      Compass::AppIntegration::Rails.check_for_double_boot!
+      Compass.discover_extensions!
+      Compass.configure_sass_plugin!
+      Compass.handle_configuration_change!
+    end
+  end
+end

data/lib/compass/app_integration/rails/actionpack31.rb

@@ -0,0 +1,5 @@
+# TODO figure something out so image_path works with rails integration
+%w(railtie).each do |lib|
+  require "compass/app_integration/rails/actionpack31/#{lib}"
+end
+

data/lib/compass/app_integration/rails/actionpack31/railtie.rb

@@ -0,0 +1,50 @@
+require 'compass'
+require 'rails'
+
+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_project_configuration(data)
+      data
+    end
+    @compass
+  end
+end
+
+module Compass
+  class Railtie < Rails::Railtie
+    initializer "compass.initialize_rails" do |app|
+      # Configure compass for use within rails, and provide the project configuration
+      # that came via the rails boot process.
+      Compass::AppIntegration::Rails.check_for_double_boot!
+      Compass.discover_extensions!
+      Compass.configure_rails!(app)
+    end
+  end
+end

data/lib/compass/app_integration/rails/configuration_defaults.rb

@@ -0,0 +1,111 @@
+module Compass
+  module AppIntegration
+    module Rails
+
+      module ConfigurationDefaultsWithAssetPipeline
+        # These methods overwrite the old rails defaults
+        # when rails 3.1 is detected.
+
+        def default_sass_dir
+          File.join("app", "assets", "stylesheets")
+        end
+
+        def default_images_dir
+          File.join("app", "assets", "images")
+        end
+
+        def default_fonts_dir
+          File.join("app", "assets", "fonts")
+        end
+
+        def default_javascripts_dir
+          File.join("app", "assets", "javascripts")
+        end
+
+        def default_http_path
+          ::Rails.application.config.assets.prefix
+        end
+
+        def default_http_images_path
+          "#{top_level.http_path}"
+        end
+
+        def default_http_javascripts_path
+          "#{top_level.http_path}"
+        end
+
+        def default_http_fonts_path
+          "#{top_level.http_path}"
+        end
+
+        def default_http_stylesheets_path
+          "#{top_level.http_path}"
+        end
+      end
+
+      module ConfigurationDefaults
+
+        def project_type_without_default
+          :rails
+        end
+
+        def default_sass_dir
+          File.join("app", "stylesheets")
+        end
+
+        def default_css_dir
+          File.join("public", "stylesheets")
+        end
+
+        def default_images_dir
+          File.join("public", "images")
+        end
+
+        def default_fonts_dir
+          File.join("public", "fonts")
+        end
+
+        def default_javascripts_dir
+          File.join("public", "javascripts")
+        end
+
+        def default_http_images_path
+          "#{top_level.http_path}images"
+        end
+
+        def default_http_javascripts_path
+          "#{top_level.http_path}javascripts"
+        end
+
+        def default_http_fonts_path
+          "#{top_level.http_path}fonts"
+        end
+
+        def default_http_stylesheets_path
+          "#{top_level.http_path}stylesheets"
+        end
+
+        def default_extensions_dir
+          File.join("vendor", "plugins", "compass_extensions")
+        end
+
+        def default_cache_dir
+          File.join("tmp", "sass-cache")
+        end
+
+        def default_project_path
+          project_path = Compass::AppIntegration::Rails.root
+        end
+
+        def default_http_path
+          "/" # XXX Where is/was this stored in the Rails config?
+        end
+
+        def default_environment
+          Compass::AppIntegration::Rails.env
+        end
+
+      end
+    end
+  end
+end

data/lib/compass/app_integration/rails/installer.rb

@@ -0,0 +1,182 @@
+module Compass
+  module Installers
+    class Base
+    end
+    class ManifestInstaller < Base
+    end
+  end
+
+  module AppIntegration
+    module Rails    
+      class Installer < Compass::Installers::ManifestInstaller
+
+        def completed_configuration
+          config = {}
+          config[:sass_dir] = prompt_sass_dir unless sass_dir_without_default
+          config[:css_dir] = prompt_css_dir unless css_dir_without_default
+          config unless config.empty?
+        end
+
+        def write_configuration_files(config_file = nil)
+          config_file ||= targetize('config/compass.rb')
+          unless File.exists?(config_file)
+            directory File.dirname(config_file)
+            write_file config_file, config_contents
+          end
+          unless rails3?
+            directory File.dirname(targetize('config/initializers/compass.rb'))
+            write_file targetize('config/initializers/compass.rb'), initializer_contents
+          end
+        end
+
+        def rails3?
+          File.exists?(targetize('config/application.rb'))
+        end
+
+        def prepare
+          write_configuration_files
+        end
+
+        def gem_config_instructions
+          if rails3?
+            %Q{Add the following to your Gemfile:\n\n    gem "compass", ">= #{Compass::VERSION}"}
+          else
+            %Q{Add the following to your environment.rb:\n\n    config.gem "compass", :version => ">= #{Compass::VERSION}"}
+          end
+        end
+
+        def finalize(options = {})
+          if options[:create]
+            puts <<-NEXTSTEPS
+
+Congratulations! Your rails project has been configured to use Compass.
+Just a couple more things left to do.
+
+#{gem_config_instructions}
+
+Then, make sure you restart your server.
+
+Sass will automatically compile your stylesheets during the next
+page request and keep them up to date when they change.
+NEXTSTEPS
+          end
+          unless options[:prepare]
+            if manifest.has_stylesheet?
+              puts "\nNow add these lines to the head of your layout(s):\n\n"
+              puts stylesheet_links
+            end
+          end
+        end
+
+        def hamlize?
+          # XXX Is there a better way to detect haml in a particular rails project?
+          require 'haml'
+          true
+        rescue LoadError
+          false
+        end
+
+        def install_location_for_html(to, options)
+          separate("public/#{pattern_name_as_dir}#{to}")
+        end
+
+        def prompt_sass_dir
+          if rails3?
+            nil
+          else
+            recommended_location = separate('app/stylesheets')
+            default_location = separate('public/stylesheets/sass')
+            print %Q{Compass recommends that you keep your stylesheets in #{recommended_location}
+  instead of the Sass default location of #{default_location}.
+  Is this OK? (Y/n) }
+            answer = $stdin.gets.downcase[0]
+            answer == ?n ? default_location : recommended_location
+          end
+        end
+
+        def prompt_css_dir
+          if rails3?
+            nil
+          else
+            recommended_location = separate("public/stylesheets/compiled")
+            default_location = separate("public/stylesheets")
+            puts
+            print %Q{Compass recommends that you keep your compiled css in #{recommended_location}/
+  instead the Sass default of #{default_location}/.
+  However, if you're exclusively using Sass, then #{default_location}/ is recommended.
+  Emit compiled stylesheets to #{recommended_location}/? (Y/n) }
+            answer = $stdin.gets
+            answer = answer.downcase[0]
+            answer == ?n ? default_location : recommended_location
+          end
+        end
+
+        def config_contents
+          project_path, Compass.configuration.project_path = Compass.configuration.project_path, nil
+          ("# This configuration file works with both the Compass command line tool and within Rails.\n" +
+           Compass.configuration.serialize)
+        ensure
+          Compass.configuration.project_path = project_path
+        end
+
+        def initializer_contents
+          %Q{require 'compass'
+            |require 'compass/app_integration/rails'
+            |Compass::AppIntegration::Rails.initialize!
+            |}.gsub(/^\s+\|/,'')
+        end
+
+        def stylesheet_prefix
+          if css_dir.length >= 19
+            "#{css_dir[19..-1]}/"
+          else
+            nil
+          end
+        end
+
+        def stylesheet_links
+          if hamlize?
+            haml_stylesheet_links
+          else
+            html_stylesheet_links
+          end
+        end
+
+        def haml_stylesheet_links
+          html = "%head\n"
+          manifest.each_stylesheet do |stylesheet|
+            # Skip partials.
+            next if File.basename(stylesheet.from)[0..0] == "_"
+            ss_line = "  = stylesheet_link_tag '#{stylesheet_prefix}#{stylesheet.to.sub(/\.s[ac]ss$/,'.css')}'"
+            if stylesheet.options[:media]
+              ss_line += ", :media => '#{stylesheet.options[:media]}'"
+            end
+            if stylesheet.options[:condition]
+              ss_line = "  /[if #{stylesheet.options[:condition]}]\n  " + ss_line
+            end
+            html << ss_line + "\n"
+          end
+          html
+        end
+        def html_stylesheet_links
+          html = "<head>\n"
+          manifest.each_stylesheet do |stylesheet|
+            # Skip partials.
+            next if File.basename(stylesheet.from)[0..0] == "_"
+            ss_line = "<%= stylesheet_link_tag '#{stylesheet_prefix}#{stylesheet.to.sub(/\.s[ac]ss$/,'.css')}'"
+            if stylesheet.options[:media]
+              ss_line += ", :media => '#{stylesheet.options[:media]}'"
+            end
+            ss_line += " %>"
+            if stylesheet.options[:condition]
+              ss_line = "<!--[if #{stylesheet.options[:condition]}]>" + ss_line + "<![endif]-->"
+            end
+            html << "  #{ss_line}\n"
+          end
+          html << "</head>"
+          html
+        end
+      end
+    end
+  end
+end