Class: CssParser::Parser

Inherits:
Object
  • Object
show all
Defined in:
lib/css_parser/parser.rb

Overview

Parser class

All CSS is converted to UTF-8.

When calling Parser#new there are some configuaration options:

absolute_paths

Convert relative paths to absolute paths (href, src and url(''). Boolean, default is false.

import

Follow @import rules. Boolean, default is true.

io_exceptions

Throw an exception if a link can not be found. Boolean, default is true.

Constant Summary collapse

USER_AGENT = 
"Ruby CSS Parser/#{CssParser::VERSION} (http://github.com/alexdunae/css_parser)"
STRIP_CSS_COMMENTS_RX = 
/\/\*.*?\*\//m
STRIP_HTML_COMMENTS_RX = 
/\<\!\-\-|\-\-\>/m
RE_AT_IMPORT_RULE =

Initial parsing

/\@import\s*(?:url\s*)?(?:\()?(?:\s*)["']?([^'"\s\)]*)["']?\)?([\w\s\,^\]\(\))]*)\)?[;\n]?/

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Parser

Returns a new instance of Parser.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/css_parser/parser.rb', line 34

def initialize(options = {})
  @options = {:absolute_paths => false,
              :import => true,
              :io_exceptions => true}.merge(options)

  # array of RuleSets
  @rules = []


  @loaded_uris = []

  # unprocessed blocks of CSS
  @blocks = []
  reset!
end

Class Attribute Details

.folded_declaration_cache ⇒ Object (readonly)

Returns the value of attribute folded_declaration_cache.



32
33
34
 
# File 'lib/css_parser/parser.rb', line 32

def folded_declaration_cache
  @folded_declaration_cache
end

Instance Attribute Details

#loaded_uris ⇒ Object (readonly)

Array of CSS files that have been loaded.



26
27
28
 
# File 'lib/css_parser/parser.rb', line 26

def loaded_uris
  @loaded_uris
end

Instance Method Details

#add_block!(block, options = {}) ⇒ Object

Add a raw block of CSS.

In order to follow @import rules you must supply either a :base_dir or :base_uri option.

Use the :media_types option to set the media type(s) for this block. Takes an array of symbols.

Use the :only_media_types option to selectively follow @import rules. Takes an array of symbols.

Example

css = <<-EOT
  body { font-size: 10pt }
  p { margin: 0px; }
  @media screen, print {
    body { line-height: 1.2 }
  }
EOT

parser = CssParser::Parser.new
parser.add_block!(css)



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/css_parser/parser.rb', line 110

def add_block!(block, options = {})
  options = {:base_uri => nil, :base_dir => nil, :charset => nil, :media_types => :all, :only_media_types => :all}.merge(options)
  options[:media_types] = [options[:media_types]].flatten.collect { |mt| CssParser.sanitize_media_query(mt)}
  options[:only_media_types] = [options[:only_media_types]].flatten.collect { |mt| CssParser.sanitize_media_query(mt)}

  block = cleanup_block(block)

  if options[:base_uri] and @options[:absolute_paths]
    block = CssParser.convert_uris(block, options[:base_uri])
  end

  # Load @imported CSS
  block.scan(RE_AT_IMPORT_RULE).each do |import_rule|
    media_types = []
    if media_string = import_rule[-1]
      media_string.split(/[,]/).each do |t|
        media_types << CssParser.sanitize_media_query(t) unless t.empty?
      end
    else
      media_types = [:all]
    end

    next unless options[:only_media_types].include?(:all) or media_types.length < 1 or (media_types & options[:only_media_types]).length > 0

    import_path = import_rule[0].to_s.gsub(/['"]*/, '').strip

    if options[:base_uri]
      import_uri = Addressable::URI.parse(options[:base_uri].to_s) + Addressable::URI.parse(import_path)
      load_uri!(import_uri, options[:base_uri], media_types)
    elsif options[:base_dir]
      load_file!(import_path, options[:base_dir], media_types)
    end
  end

  # Remove @import declarations
  block.gsub!(RE_AT_IMPORT_RULE, '')

  parse_block_into_rule_sets!(block, options)
end

#add_rule!(selectors, declarations, media_types = :all) ⇒ Object

Add a CSS rule by setting the selectors, declarations and media_types.

media_types can be a symbol or an array of symbols.



153
154
155
156
 
# File 'lib/css_parser/parser.rb', line 153

def add_rule!(selectors, declarations, media_types = :all)
  rule_set = RuleSet.new(selectors, declarations)
  add_rule_set!(rule_set, media_types)
end

#add_rule_set!(ruleset, media_types = :all) ⇒ Object

Add a CssParser RuleSet object.

media_types can be a symbol or an array of symbols.

Raises:

  • (ArgumentError) 


161
162
163
164
165
166
167
 
# File 'lib/css_parser/parser.rb', line 161

def add_rule_set!(ruleset, media_types = :all)
  raise ArgumentError unless ruleset.kind_of?(CssParser::RuleSet)

  media_types = [media_types].flatten.collect { |mt| CssParser.sanitize_media_query(mt)}

  @rules << {:media_types => media_types, :rules => ruleset}
end

#compact! ⇒ Object

Merge declarations with the same selector.



240
241
242
243
244
 
# File 'lib/css_parser/parser.rb', line 240

def compact! # :nodoc:
  compacted = []

  compacted
end

#each_rule_set(media_types = :all) ⇒ Object

Iterate through RuleSet objects.

media_types can be a symbol or an array of symbols.



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/css_parser/parser.rb', line 172

def each_rule_set(media_types = :all) # :yields: rule_set, media_types
  media_types = [:all] if media_types.nil?
  media_types = [media_types].flatten.collect { |mt| CssParser.sanitize_media_query(mt)}

  @rules.each do |block|
    if media_types.include?(:all) or block[:media_types].any? { |mt| media_types.include?(mt) }
      yield(block[:rules], block[:media_types])
    end
  end
end

#each_selector(media_types = :all, options = {}) ⇒ Object

Iterate through CSS selectors.

media_types can be a symbol or an array of symbols. See RuleSet#each_selector for options.



187
188
189
190
191
192
193
 
# File 'lib/css_parser/parser.rb', line 187

def each_selector(media_types = :all, options = {}) # :yields: selectors, declarations, specificity, media_types
  each_rule_set(media_types) do |rule_set, media_types|
    rule_set.each_selector(options) do |selectors, declarations, specificity|
      yield selectors, declarations, specificity, media_types
    end
  end
end

#find_by_selector(selector, media_types = :all) ⇒ Object Also known as: []

Get declarations by selector.

media_types are optional, and can be a symbol or an array of symbols. The default value is :all.

Examples

find_by_selector('#content')
=> 'font-size: 13px; line-height: 1.2;'

find_by_selector('#content', [:screen, :handheld])
=> 'font-size: 13px; line-height: 1.2;'

find_by_selector('#content', :print)
=> 'font-size: 11pt; line-height: 1.2;'

Returns an array of declarations.



66
67
68
69
70
71
72
 
# File 'lib/css_parser/parser.rb', line 66

def find_by_selector(selector, media_types = :all)
  out = []
  each_selector(media_types) do |sel, dec, spec|
    out << dec if sel.strip == selector.strip
  end
  out
end

#find_rule_sets(selectors, media_types = :all) ⇒ Object

Finds the rule sets that match the given selectors



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/css_parser/parser.rb', line 76

def find_rule_sets(selectors, media_types = :all)
  rule_sets = []

  selectors.each do |selector|
    each_rule_set(media_types) do |rule_set, media_type|
      if !rule_sets.member?(rule_set) && rule_set.selectors.member?(selector)
        rule_sets << rule_set
      end
    end
  end

  rule_sets
end

#load_file!(file_name, base_dir = nil, media_types = :all) ⇒ Object

Load a local CSS file.



381
382
383
384
385
386
387
388
389
390
 
# File 'lib/css_parser/parser.rb', line 381

def load_file!(file_name, base_dir = nil, media_types = :all)
  file_name = File.expand_path(file_name, base_dir)
  return unless File.readable?(file_name)
  return unless circular_reference_check(file_name)

  src = IO.read(file_name)
  base_dir = File.dirname(file_name)

  add_block!(src, {:media_types => media_types, :base_dir => base_dir})
end

#load_string!(src, base_dir = nil, media_types = :all) ⇒ Object

Load a local CSS string.



393
394
395
 
# File 'lib/css_parser/parser.rb', line 393

def load_string!(src, base_dir = nil, media_types = :all)
  add_block!(src, {:media_types => media_types, :base_dir => base_dir})
end

#load_uri!(uri, options = {}, deprecated = nil) ⇒ Object

Load a remote CSS file.

You can also pass in file://test.css

See add_block! for options.

Deprecated: originally accepted three params: ‘uri`, `base_uri` and `media_types`



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/css_parser/parser.rb', line 354

def load_uri!(uri, options = {}, deprecated = nil)
  uri = Addressable::URI.parse(uri) unless uri.respond_to? :scheme
  #base_uri = nil, media_types = :all, options = {}

  opts = {:base_uri => nil, :media_types => :all}

  if options.is_a? Hash
    opts.merge!(options)
  else
    opts[:base_uri] = options if options.is_a? String
    opts[:media_types] = deprecated if deprecated
  end

  if uri.scheme == 'file' or uri.scheme.nil?
    uri.path = File.expand_path(uri.path)
    uri.scheme = 'file'
  end

  opts[:base_uri] = uri if opts[:base_uri].nil?

  src, charset = read_remote_file(uri)
  if src
    add_block!(src, opts)
  end
end

#parse_block_into_rule_sets!(block, options = {}) ⇒ Object

:nodoc:



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/css_parser/parser.rb', line 246

def parse_block_into_rule_sets!(block, options = {}) # :nodoc:
  current_media_queries = [:all]
  if options[:media_types]
    current_media_queries = options[:media_types].flatten.collect { |mt| CssParser.sanitize_media_query(mt)}
  end

  in_declarations = 0
  block_depth = 0

  in_charset = false # @charset is ignored for now
  in_string = false
  in_at_media_rule = false
  in_media_block = false

  current_selectors = ''
  current_media_query = ''
  current_declarations = ''

  block.scan(/([\\]?[{}\s"]|(.[^\s"{}\\]*))/).each do |matches|
    token = matches[0]

    if token =~ /\A"/ # found un-escaped double quote
      in_string = !in_string
    end

    if in_declarations > 0
      # too deep, malformed declaration block
      if in_declarations > 1
        in_declarations -= 1 if token =~ /\}/
        next
      end

      if token =~ /\{/
        in_declarations += 1
        next
      end

      current_declarations += token

      if token =~ /\}/ and not in_string
        current_declarations.gsub!(/\}[\s]*$/, '')

        in_declarations -= 1

        unless current_declarations.strip.empty?
          add_rule!(current_selectors, current_declarations, current_media_queries)
        end

        current_selectors = ''
        current_declarations = ''
      end
    elsif token =~ /@media/i
      # found '@media', reset current media_types
      in_at_media_rule = true
      current_media_queries = []
    elsif in_at_media_rule
      if token =~ /\{/
        block_depth = block_depth + 1
        in_at_media_rule = false
        in_media_block = true
        current_media_queries << CssParser.sanitize_media_query(current_media_query)
        current_media_query = ''
      elsif token =~ /[,]/
        # new media query begins
        token.gsub!(/[,]/, ' ')
        current_media_query += token.strip + ' '
        current_media_queries << CssParser.sanitize_media_query(current_media_query)
        current_media_query = ''
      else
        current_media_query += token.strip + ' '
      end
    elsif in_charset or token =~ /@charset/i
      # iterate until we are out of the charset declaration
      in_charset = (token =~ /;/ ? false : true)
    else
      if token =~ /\}/ and not in_string
        block_depth = block_depth - 1

        # reset the current media query scope
        if in_media_block
          current_media_queries = []
          in_media_block = false
        end
      else
        if token =~ /\{/ and not in_string
          current_selectors.gsub!(/^[\s]*/, '')
          current_selectors.gsub!(/[\s]*$/, '')
          in_declarations += 1
        else
          current_selectors += token
        end
      end
    end
  end

  # check for unclosed braces
  if in_declarations > 0
    add_rule!(current_selectors, current_declarations, current_media_queries)
  end
end

#rules_by_media_query ⇒ Object

A hash of { :media_query => rule_sets }



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/css_parser/parser.rb', line 225

def rules_by_media_query
  rules_by_media = {}
  @rules.each do |block|
    block[:media_types].each do |mt|
      unless rules_by_media.has_key?(mt)
        rules_by_media[mt] = []
      end
      rules_by_media[mt] << block[:rules]
    end
  end

  rules_by_media
end

#to_s(media_types = :all) ⇒ Object

Output all CSS rules as a single stylesheet.



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/css_parser/parser.rb', line 196

def to_s(media_types = :all)
  out = ''
  styles_by_media_types = {}
  each_selector(media_types) do |selectors, declarations, specificity, media_types|
    media_types.each do |media_type|
      styles_by_media_types[media_type] ||= []
      styles_by_media_types[media_type] << [selectors, declarations]
    end
  end

  styles_by_media_types.each_pair do |media_type, media_styles|
    media_block = (media_type != :all)
    out += "@media #{media_type} {\n" if media_block

    media_styles.each do |media_style|
      if media_block
        out += "  #{media_style[0]} {\n    #{media_style[1]}\n  }\n"
      else
        out += "#{media_style[0]} {\n#{media_style[1]}\n}\n"
      end
    end

    out += "}\n" if media_block
  end

  out
end