Module: Compass::Configuration::Helpers

### Home Classes Methods

### In Files

- lib/compass/configuration/helpers.rb

### Methods

- #add_project_configuration
- #compiler
- #configuration_for
- #configure_sass_plugin!
- #detect_configuration_file
- #handle_configuration_change!
- #sass_compiler
- #sass_engine_options
- #sass_plugin_configuration

### Class/Module Index

Quicksearch

- Compass
- Compass::Actions
- Compass::AppIntegration
- Compass::AppIntegration::Helpers
- Compass::AppIntegration::StandAlone
- Compass::AppIntegration::StandAlone::ConfigurationDefaults
- Compass::AppIntegration::StandAlone::Installer
- Compass::Commands
- Compass::Commands::Base
- Compass::Commands::CleanProject
- Compass::Commands::CleanProjectOptionsParser
- Compass::Commands::CompileProjectOptionsParser
- Compass::Commands::ConfigurationOptionsParser
- Compass::Commands::CreateProject
- Compass::Commands::CreateProjectOptionsParser
- Compass::Commands::Default
- Compass::Commands::DefaultOptionsParser
- Compass::Commands::ExtensionCommand
- Compass::Commands::ExtensionOptionsParser
- Compass::Commands::ExtensionsOptionParser
- Compass::Commands::Help
- Compass::Commands::HelpOptionsParser
- Compass::Commands::Imports
- Compass::Commands::InstallerCommand
- Compass::Commands::Interactive
- Compass::Commands::InteractiveOptionsParser
- Compass::Commands::ListFrameworks
- Compass::Commands::PrintVersion
- Compass::Commands::ProjectBase
- Compass::Commands::ProjectStats
- Compass::Commands::Registry
- Compass::Commands::Sprite
- Compass::Commands::SpriteOptionsParser
- Compass::Commands::StampPattern
- Compass::Commands::StampPatternOptionsParser
- Compass::Commands::StatsOptionsParser
- Compass::Commands::StructureOptionsParser
- Compass::Commands::UnpackExtension
- Compass::Commands::UpdateProject
- Compass::Commands::ValidateProject
- Compass::Commands::ValidationOptionsParser
- Compass::Commands::VersionOptionsParser
- Compass::Commands::WriteConfiguration
- Compass::Compiler
- Compass::Configuration
- Compass::Configuration::Comments
- Compass::Configuration::Data
- Compass::Configuration::FileData
- Compass::Configuration::Helpers
- Compass::Configuration::Serialization
- Compass::Deprecation
- Compass::Exec
- Compass::Exec::CommandOptionParser
- Compass::Exec::GlobalOptionsParser
- Compass::Exec::Helpers
- Compass::Exec::ProjectOptionsParser
- Compass::Exec::SubCommandUI
- Compass::FilesystemConflict
- Compass::Installers
- Compass::Installers::BareInstaller
- Compass::Installers::Base
- Compass::Installers::Manifest
- Compass::Installers::Manifest::Entry
- Compass::Installers::ManifestInstaller
- Compass::Installers::TemplateContext
- Compass::Logger
- Compass::MissingDependency
- Compass::NullLogger
- Compass::SassCompiler
- Compass::SassExtensions
- Compass::SassExtensions::Functions
- Compass::SassExtensions::Functions::SassDeclarationHelper
- Compass::SassExtensions::Functions::Sprites
- Compass::SassExtensions::Functions::Sprites::VariableReader
- Compass::SassExtensions::Sprites
- Compass::SassExtensions::Sprites::ChunkyPngEngine
- Compass::SassExtensions::Sprites::Engine
- Compass::SassExtensions::Sprites::Image
- Compass::SassExtensions::Sprites::ImageMethods
- Compass::SassExtensions::Sprites::ImageRow
- Compass::SassExtensions::Sprites::Images
- Compass::SassExtensions::Sprites::Layout
- Compass::SassExtensions::Sprites::Layout::Diagonal
- Compass::SassExtensions::Sprites::Layout::Horizontal
- Compass::SassExtensions::Sprites::Layout::Smart
- Compass::SassExtensions::Sprites::Layout::SpriteLayout
- Compass::SassExtensions::Sprites::Layout::Vertical
- Compass::SassExtensions::Sprites::LayoutMethods
- Compass::SassExtensions::Sprites::RowFitter
- Compass::SassExtensions::Sprites::SpriteMap
- Compass::SassExtensions::Sprites::SpriteMethods
- Compass::SpriteException
- Compass::SpriteImporter
- Compass::Sprites
- Compass::Sprites::Binding
- Compass::Stats
- Compass::Stats::CssFile
- Compass::Stats::SassFile
- Compass::Stats::StatsVisitor
- Compass::TestCase
- Compass::Version
- Sass
- Sass::Script
- Sass::Script::Functions
- QuickCache

No matching classes.

# Compass::Configuration::Helpers

The helpers are available as methods on the Compass module. E.g. Compass.configuration

### Constants

KNOWN_CONFIG_LOCATIONS

  TODO: Deprecate the src/config.rb location.

### Public Instance Methods

add_project_configuration(*args) click to toggle source

Read the configuration file for this project

    # File lib/compass/configuration/helpers.rb, line 64
    def add_project_configuration(*args)
      options = args.last.is_a?(Hash) ? args.pop : {}
      configuration_file_path = args.shift || detect_configuration_file

      raise ArgumentError, "Too many arguments" if args.any?
      if AppIntegration.default? && data = configuration_for(configuration_file_path, nil, configuration_for(options[:defaults]))
        if data.raw_project_type
          add_configuration(data.raw_project_type.to_sym)
        elsif options[:project_type]
          add_configuration(options[:project_type])
        else
          add_configuration(:stand_alone)
        end
        add_configuration(data)
      else
        add_configuration(options[:project_type] || configuration.project_type_without_default || (yield if block_given?) || :stand_alone)
      end
    end

compiler() click to toggle source

@deprecated

    # File lib/compass/configuration/helpers.rb, line 99
    def compiler
      Compass::Deprecation.deprecated!(:compiler_accessor,
        "Compass.compiler is deprecated. Use Compass.sass_compiler instead.")
      Compass::Deprecation.mark_as_issued(:compass_compiler_constructor)
      Compass::Compiler.new(*Compass.configuration.to_compiler_arguments)
    end

configuration_for(config, filename = nil, defaults = nil) click to toggle source

    # File lib/compass/configuration/helpers.rb, line 6
    def configuration_for(config, filename = nil, defaults = nil)
      if config.nil?
        nil
      elsif config.is_a?(Compass::Configuration::Data)
        config
      elsif config.instance_of?(Hash)
        Compass::Configuration::Data.new(filename, config)
      elsif config.respond_to?(:read)
        filename ||= config.to_s if config.is_a?(Pathname)
        Compass::Configuration::FileData.new_from_string(config.read, filename, defaults)
      elsif config.is_a?(Hash)
        Compass::Configuration::Data.new(filename, config)
      elsif config.is_a?(String)
        Compass::Configuration::FileData.new_from_file(config, defaults)
      elsif config.is_a?(Symbol)
        Compass::AppIntegration.lookup(config).configuration
      else
        raise "I don't know what to do with: #{config.inspect}"
      end
    end

configure_sass_plugin!() click to toggle source

    # File lib/compass/configuration/helpers.rb, line 31
    def configure_sass_plugin!
      require 'sass/plugin'
      config = sass_plugin_configuration
      locations = config.delete(:template_location)
      Sass::Plugin.options.merge!(config)
      locations.each do |sass_dir, css_dir|
        unless Sass::Plugin.engine_options[:load_paths].include?(sass_dir)
          Sass::Plugin.add_template_location sass_dir, css_dir
        end
      end
      unless @callbacks_loaded
        on_saved = Proc.new do |sass_file, css_file|
                     Compass.configuration.run_stylesheet_saved(css_file)
                   end
        if Sass::Plugin.respond_to?(:on_updated_stylesheet)
          Sass::Plugin.on_updated_stylesheet(&on_saved)
        else
          Sass::Plugin.on_updating_stylesheet(&on_saved)
        end

        Sass::Plugin.on_compilation_error do |e, filename, css|
          Compass.configuration.run_stylesheet_error(filename, e.message)
        end

        @callbacks_loaded = true
      end
    end

detect_configuration_file(project_path = nil) click to toggle source

Finds the configuration file, if it exists in a known location.

    # File lib/compass/configuration/helpers.rb, line 87
    def detect_configuration_file(project_path = nil)
      possible_files = KNOWN_CONFIG_LOCATIONS.map{|f| projectize(f, project_path) }
      possible_files.detect{|f| File.exists?(f)}
    end

handle_configuration_change!() click to toggle source

    # File lib/compass/configuration/helpers.rb, line 92
    def handle_configuration_change!
      if (compiler = Compass.compiler).new_config?
        compiler.clean!
      end
    end

sass_compiler(*args) click to toggle source

    # File lib/compass/configuration/helpers.rb, line 106
    def sass_compiler(*args)
      Compass::SassCompiler.new(*args)
    end

sass_engine_options() click to toggle source

    # File lib/compass/configuration/helpers.rb, line 59
    def sass_engine_options
      configuration.to_sass_engine_options
    end

sass_plugin_configuration() click to toggle source

    # File lib/compass/configuration/helpers.rb, line 27
    def sass_plugin_configuration
      configuration.to_sass_plugin_options
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.