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.



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/css_parser/parser.rb', line 37

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.



35
36
37
 
# File 'lib/css_parser/parser.rb', line 35

def folded_declaration_cache
  @folded_declaration_cache
end

Instance Attribute Details

#loaded_uris ⇒ Object (readonly)

Array of CSS files that have been loaded.



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

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)



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
149
150
151
152
153
154
155
 
# File 'lib/css_parser/parser.rb', line 119

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
  options[:only_media_types] = [options[:only_media_types]].flatten

  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(/\s|\,/).each do |t|
        media_types << t.to_sym unless t.empty?
      end
    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 = URI.parse(options[:base_uri].to_s).merge(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.



160
161
162
163
 
# File 'lib/css_parser/parser.rb', line 160

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) 


168
169
170
171
172
173
174
 
# File 'lib/css_parser/parser.rb', line 168

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

  media_types = [media_types] if media_types.kind_of?(Symbol)

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

#compact! ⇒ Object

Merge declarations with the same selector.



213
214
215
216
217
 
# File 'lib/css_parser/parser.rb', line 213

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.



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/css_parser/parser.rb', line 179

def each_rule_set(media_types = :all) # :yields: rule_set
  media_types = [:all] if media_types.nil?
  media_types = [media_types] if media_types.kind_of?(Symbol)

  @rules.each do |block|
    if media_types.include?(:all) or block[:media_types].any? { |mt| media_types.include?(mt) }
      yield block[:rules]
    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.



194
195
196
197
198
199
200
201
 
# File 'lib/css_parser/parser.rb', line 194

def each_selector(media_types = :all, options = {}) # :yields: selectors, declarations, specificity
  each_rule_set(media_types) do |rule_set|
    #puts rule_set
    rule_set.each_selector(options) do |selectors, declarations, specificity|
      yield selectors, declarations, specificity
    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;'

Now you can use Regexp too

Examples

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

find_by_selector('/\.content/') # Don't forget use escape with dot(\)
=> 'float:left;'

find_by_selector('/content/')
=> {'#content' => {'font-size' => '11pt;', 'line-height' => '1.2;'}, '.content' => {'float' => 'left'}}

Returns an array or hash of declarations.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/css_parser/parser.rb', line 81

def find_by_selector(selector, media_types = :all)
  out       = []
  out_hash  = {}
  
  each_selector(media_types) do |sel, dec, spec|
    if selector.is_a?(Regexp)
      dec_hash = {}
      dec.split(';').map{|x| dec_hash.merge!({x.split(':').first.lstrip => x.split(":").last.lstrip})}
      out_hash.merge!({sel => dec_hash}){ |key, v1, v2| "#{v1} #{v2}"} if sel.strip =~ selector
    elsif selector.is_a?(String)
      out << dec if sel.strip == selector.strip;
    end        
  end
  selector.is_a?(Regexp) ? (out_hash.size < 2 ? out_hash.values : out_hash) : out
end

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

Load a local CSS file.



344
345
346
347
348
349
350
351
352
 
# File 'lib/css_parser/parser.rb', line 344

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)

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

  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`



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
 
# File 'lib/css_parser/parser.rb', line 315

def load_uri!(uri, options = {}, deprecated = nil)
  uri = 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:



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
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
 
# File 'lib/css_parser/parser.rb', line 219

def parse_block_into_rule_sets!(block, options = {}) # :nodoc:
  options = {:media_types => :all}.merge(options)
  media_types = options[:media_types]

  in_declarations = 0

  block_depth = 0

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

  current_selectors = ''
  current_declarations = ''

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

    #puts "TOKEN: #{token}" unless token =~ /^[\s]*$/
    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?
          #puts "SAVING #{current_selectors} -> #{current_declarations}"
          add_rule!(current_selectors, current_declarations, media_types)
        end

        current_selectors = ''
        current_declarations = ''
      end
    elsif token =~ /@media/i
      # found '@media', reset current media_types
      in_at_media_rule = true
      media_types = []
    elsif in_at_media_rule
      if token =~ /\{/
        block_depth = block_depth + 1
        in_at_media_rule = false
      else
        token.gsub!(/[,\s]*/, '')
        media_types << token.strip.downcase.to_sym unless token.empty?
      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
      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, media_types)
  end        
end

#to_s(media_types = :all) ⇒ Object

Output all CSS rules as a single stylesheet.



204
205
206
207
208
209
210
 
# File 'lib/css_parser/parser.rb', line 204

def to_s(media_types = :all)
  out = ''
  each_selector(media_types) do |selectors, declarations, specificity|
    out << "#{selectors} {\n#{declarations}\n}\n"
  end
  out
end