The Compiler class handles compilation of multiple files and/or directories, including checking which CSS files are out-of-date and need to be updated and calling Sass to perform the compilation on those files.
{Sass::Plugin} uses this class to update stylesheets for a single application. Unlike {Sass::Plugin}, though, the Compiler class has no global state, and so multiple instances may be created and used independently.
If you need to compile a Sass string into CSS, please see the {Sass::Engine} class.
Unlike {Sass::Plugin}, this class doesn’t keep track of whether or how many times a stylesheet should be updated. Therefore, the following `Sass::Plugin` options are ignored by the Compiler:
`:never_update`
`:always_check`
Non-destructively modifies {#options} so that default values are properly set, and returns the result.
@param additional_options [{Symbol => Object}] An options hash with which to merge {#options} @return [{Symbol => Object}] The modified options hash
# File lib/sass/plugin/compiler.rb, line 265 def engine_options(additional_options = {}) opts = options.merge(additional_options) opts[:load_paths] = load_paths(opts) opts end
Compass expects this to exist
# File lib/sass/plugin/compiler.rb, line 272 def stylesheet_needs_update?(css_file, template_file) StalenessChecker.stylesheet_needs_update?(css_file, template_file) end
Updates out-of-date stylesheets.
Checks each Sass/SCSS file in {file:SASS_REFERENCE.md#template_location-option `:template_location`} to see if it’s been modified more recently than the corresponding CSS file in {file:SASS_REFERENCE.md#css_location-option `:css_location`}. If it has, it updates the CSS file.
@param individual_files [Array<(String, String)>]
A list of files to check for updates **in addition to those specified by the {file:SASS_REFERENCE.md#template_location-option `:template_location` option}.** The first string in each pair is the location of the Sass/SCSS file, the second is the location of the CSS file that it should be compiled to.
# File lib/sass/plugin/compiler.rb, line 171 def update_stylesheets(individual_files = []) individual_files = individual_files.dup Sass::Plugin.checked_for_updates = true staleness_checker = StalenessChecker.new(engine_options) template_location_array.each do |template_location, css_location| Sass::Util.glob(File.join(template_location, "**", "[^_]*.s[ca]ss")).sort.each do |file| # Get the relative path to the file name = file.sub(template_location.to_s.sub(/\/*$/, '/'), "") css = css_filename(name, css_location) sourcemap = Sass::Util.sourcemap_name(css) if engine_options[:sourcemap] individual_files << [file, css, sourcemap] end end individual_files.each do |file, css, sourcemap| # TODO: Does staleness_checker need to check the sourcemap file as well? if options[:always_update] || staleness_checker.stylesheet_needs_update?(css, file) update_stylesheet(file, css, sourcemap) else run_not_updating_stylesheet(file, css, sourcemap) end end end
Watches the template directory (or directories) and updates the CSS files whenever the related Sass/SCSS files change. `watch` never returns.
Whenever a change is detected to a Sass/SCSS file in {file:SASS_REFERENCE.md#template_location-option `:template_location`}, the corresponding CSS file in {file:SASS_REFERENCE.md#css_location-option `:css_location`} will be recompiled. The CSS files of any Sass/SCSS files that import the changed file will also be recompiled.
Before the watching starts in earnest, `watch` calls {#update_stylesheets}.
Note that `watch` uses the [Listen](github.com/guard/listen) library to monitor the filesystem for changes. Listen isn’t loaded until `watch` is run. The version of Listen distributed with Sass is loaded by default, but if another version has already been loaded that will be used instead.
@param individual_files [Array<(String, String)>]
A list of files to watch for updates **in addition to those specified by the {file:SASS_REFERENCE.md#template_location-option `:template_location` option}.** The first string in each pair is the location of the Sass/SCSS file, the second is the location of the CSS file that it should be compiled to.
# File lib/sass/plugin/compiler.rb, line 220 def watch(individual_files = []) update_stylesheets(individual_files) directories = watched_paths individual_files.each do |(source, _, _)| directories << File.dirname(File.expand_path(source)) end directories = remove_redundant_directories(directories) # A Listen version prior to 2.0 will write a test file to a directory to # see if a watcher supports watching that directory. That breaks horribly # on read-only directories, so we filter those out. directories.reject {|d| File.writable?(d)} unless Sass::Util.listen_geq_2? # TODO: Keep better track of what depends on what # so we don't have to run a global update every time anything changes. listener_args = directories + [{:relative_paths => false}] # The native windows listener is much slower than the polling option, according to # https://github.com/nex3/sass/commit/a3031856b22bc834a5417dedecb038b7be9b9e3e poll = @options[:poll] || Sass::Util.windows? if poll && Sass::Util.listen_geq_2? # In Listen 2.0.0 and on, :force_polling is an option. In earlier # versions, it's a method on the listener (called below). listener_args.last[:force_polling] = true end listener = create_listener(*listener_args) do |modified, added, removed| on_file_changed(individual_files, modified, added, removed) end if poll && !Sass::Util.listen_geq_2? # In Listen 2.0.0 and on, :force_polling is an option (set above). In # earlier versions, it's a method on the listener. listener.force_polling(true) end listen_to(listener) end
Generated with the Darkfish Rdoc Generator 2.