Class: Sass::CSS

Inherits:
Object
  • Object
show all
Defined in:
/var/www/sass-pages/.sass/lib/sass/css.rb

Overview

This class converts CSS documents into Sass or SCSS templates. It works by parsing the CSS document into a Sass::Tree structure, and then applying various transformations to the structure to produce more concise and idiomatic Sass/SCSS.

Example usage:

Sass::CSS.new("p { color: blue }").render(:sass) #=> "p\n  color: blue"
Sass::CSS.new("p { color: blue }").render(:scss) #=> "p {\n  color: blue; }"

Instance Method Summary

Constructor Details

- (CSS) initialize(template, options = {})

A new instance of CSS

Parameters:

  • (String) template — The CSS stylesheet. This stylesheet can be encoded using any encoding that can be converted to Unicode. If the stylesheet contains an @charset declaration, that overrides the Ruby encoding (see the encoding documentation)

Options Hash (options):

  • (Boolean) :old — default: false —Whether or not to output old property syntax (:color blue as opposed to color: blue). This is only meaningful when generating Sass code, rather than SCSS. 


27
28
29
30
31
32
33
34
35
36
 
# File '/var/www/sass-pages/.sass/lib/sass/css.rb', line 27

def initialize(template, options = {})
  if template.is_a? IO
    template = template.read
  end

  @options = options.dup
  # Backwards compatibility
  @options[:old] = true if @options[:alternate] == false
  @template = template
end

Instance Method Details

- (String) render(fmt = :sass)

Converts the CSS template into Sass or SCSS code.

Parameters:

  • (Symbol) fmt (defaults to: :sass) — :sass or :scss, designating the format to return.

Returns:

  • (String) — The resulting Sass or SCSS code

Raises:



43
44
45
46
47
48
49
 
# File '/var/www/sass-pages/.sass/lib/sass/css.rb', line 43

def render(fmt = :sass)
  check_encoding!
  build_tree.send("to_#{fmt}", @options).strip + "\n"
rescue Sass::SyntaxError => err
  err.modify_backtrace(:filename => @options[:filename] || '(css)')
  raise err
end

- (Encoding?) source_encoding

Returns the original encoding of the document, or nil under Ruby 1.8.

Returns:

  • (Encoding, nil)

Raises:

  • (Encoding::UndefinedConversionError) — if the source encoding cannot be converted to UTF-8
  • (ArgumentError) — if the document uses an unknown encoding with @charset 


58
59
60
61
 
# File '/var/www/sass-pages/.sass/lib/sass/css.rb', line 58

def source_encoding
  check_encoding!
  @original_encoding
end