Class: Sass::Compiler

Inherits:
Object
  • Object
show all
Defined in:
lib/sass/compiler.rb,
lib/sass/compiler/host.rb,
lib/sass/compiler/varint.rb,
lib/sass/compiler/channel.rb,
lib/sass/compiler/connection.rb,
lib/sass/compiler/dispatcher.rb,
lib/sass/compiler/host/protofier.rb,
lib/sass/compiler/host/structifier.rb,
lib/sass/compiler/host/logger_registry.rb,
lib/sass/compiler/host/function_registry.rb,
lib/sass/compiler/host/importer_registry.rb

Overview

A synchronous Compiler. Each compiler instance exposes the #compile and #compile_string methods within the lifespan of the compiler.

Examples:

sass = Sass::Compiler.new
result = sass.compile_string('h1 { font-size: 40px; }')
result = sass.compile('style.scss')
sass.close

See Also:

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Compiler 



32
33
34
 
# File 'lib/sass/compiler.rb', line 32

def initialize
  @channel = Channel.new(Dispatcher)
end

Instance Method Details

#close ⇒ Object 



186
187
188
 
# File 'lib/sass/compiler.rb', line 186

def close
  @channel.close
end

#closed? ⇒ Boolean 



190
191
192
 
# File 'lib/sass/compiler.rb', line 190

def closed?
  @channel.closed?
end

#compile(path, load_paths: [], charset: true, source_map: false, source_map_include_sources: false, style: :expanded, functions: {}, importers: [], alert_ascii: false, alert_color: nil, logger: nil, quiet_deps: false, verbose: false) ⇒ CompileResult

Compiles the Sass file at path to CSS.

Raises:

See Also:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/sass/compiler.rb', line 64

def compile(path,
            load_paths: [],

            charset: true,
            source_map: false,
            source_map_include_sources: false,
            style: :expanded,

            functions: {},
            importers: [],

            alert_ascii: false,
            alert_color: nil,
            logger: nil,
            quiet_deps: false,
            verbose: false)
  raise ArgumentError, 'path must be set' if path.nil?

  Host.new(@channel).compile_request(
    path:,
    source: nil,
    importer: nil,
    load_paths:,
    syntax: nil,
    url: nil,
    charset:,
    source_map:,
    source_map_include_sources:,
    style:,
    functions:,
    importers:,
    alert_color:,
    alert_ascii:,
    logger:,
    quiet_deps:,
    verbose:
  )
end

#compile_string(source, importer: nil, load_paths: [], syntax: :scss, url: nil, charset: true, source_map: false, source_map_include_sources: false, style: :expanded, functions: {}, importers: [], alert_ascii: false, alert_color: nil, logger: nil, quiet_deps: false, verbose: false) ⇒ CompileResult

Compiles a stylesheet whose contents is source to CSS.

Raises:

See Also:



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/sass/compiler.rb', line 135

def compile_string(source,
                   importer: nil,
                   load_paths: [],
                   syntax: :scss,
                   url: nil,

                   charset: true,
                   source_map: false,
                   source_map_include_sources: false,
                   style: :expanded,

                   functions: {},
                   importers: [],

                   alert_ascii: false,
                   alert_color: nil,
                   logger: nil,
                   quiet_deps: false,
                   verbose: false)
  raise ArgumentError, 'source must be set' if source.nil?

  Host.new(@channel).compile_request(
    path: nil,
    source:,
    importer:,
    load_paths:,
    syntax:,
    url:,
    charset:,
    source_map:,
    source_map_include_sources:,
    style:,
    functions:,
    importers:,
    alert_color:,
    alert_ascii:,
    logger:,
    quiet_deps:,
    verbose:
  )
end

#info ⇒ String

Returns Information about the Sass implementation.

See Also:



179
180
181
182
183
184
 
# File 'lib/sass/compiler.rb', line 179

def info
  @info ||= [
    ['sass-embedded', Embedded::VERSION, '(Embedded Host)', '[Ruby]'].join("\t"),
    Host.new(@channel).version_request.join("\t")
  ].join("\n").freeze
end