marcosinger-css_parser 1.3.0

data/lib/css_parser/regexps.rb

@@ -0,0 +1,75 @@
+module CssParser
+  # :stopdoc:
+  # Base types
+  RE_NL = Regexp.new('(\n|\r\n|\r|\f)')
+  RE_NON_ASCII = Regexp.new('([\x00-\xFF])', Regexp::IGNORECASE, 'n')  #[^\0-\177]
+  RE_UNICODE = Regexp.new('(\\\\[0-9a-f]{1,6}(\r\n|[ \n\r\t\f])*)', Regexp::IGNORECASE | Regexp::EXTENDED | Regexp::MULTILINE, 'n')
+  RE_ESCAPE = Regexp.union(RE_UNICODE, '|(\\\\[^\n\r\f0-9a-f])')
+  RE_IDENT = Regexp.new("[\-]?([_a-z]|#{RE_NON_ASCII}|#{RE_ESCAPE})([_a-z0-9\-]|#{RE_NON_ASCII}|#{RE_ESCAPE})*", Regexp::IGNORECASE, 'n')
+
+  # General strings
+  RE_STRING1 = Regexp.new('(\"(.[^\n\r\f\\"]*|\\\\' + RE_NL.to_s + '|' + RE_ESCAPE.to_s + ')*\")')
+  RE_STRING2 = Regexp.new('(\'(.[^\n\r\f\\\']*|\\\\' + RE_NL.to_s + '|' + RE_ESCAPE.to_s + ')*\')')
+  RE_STRING = Regexp.union(RE_STRING1, RE_STRING2)
+
+  RE_URI = Regexp.new('(url\([\s]*([\s]*' + RE_STRING.to_s + '[\s]*)[\s]*\))|(url\([\s]*([!#$%&*\-~]|' + RE_NON_ASCII.to_s + '|' + RE_ESCAPE.to_s + ')*[\s]*)\)', Regexp::IGNORECASE | Regexp::EXTENDED  | Regexp::MULTILINE, 'n')
+  URI_RX = /url\(("([^"]*)"|'([^']*)'|([^)]*))\)/im
+
+  # Initial parsing
+  RE_AT_IMPORT_RULE = /\@import[\s]+(url\()?["''"]?(.[^'"\s"']*)["''"]?\)?([\w\s\,^\])]*)\)?;?/
+  
+  #--
+  #RE_AT_MEDIA_RULE = Regexp.new('(\"(.[^\n\r\f\\"]*|\\\\' + RE_NL.to_s + '|' + RE_ESCAPE.to_s + ')*\")')
+  
+  #RE_AT_IMPORT_RULE = Regexp.new('@import[\s]*(' + RE_STRING.to_s + ')([\w\s\,]*)[;]?', Regexp::IGNORECASE) -- should handle url() even though it is not allowed
+  #++
+  IMPORTANT_IN_PROPERTY_RX = /[\s]*\!important[\s]*/i
+  STRIP_CSS_COMMENTS_RX = /\/\*.*?\*\//m
+  STRIP_HTML_COMMENTS_RX = /\<\!\-\-|\-\-\>/m
+
+  # Special units
+  BOX_MODEL_UNITS_RX = /(auto|inherit|0|([\-]*([0-9]+|[0-9]*\.[0-9]+)(e[mx]+|px|[cm]+m|p[tc+]|in|\%)))([\s;]|\Z)/imx
+  RE_LENGTH_OR_PERCENTAGE = Regexp.new('([\-]*(([0-9]*\.[0-9]+)|[0-9]+)(e[mx]+|px|[cm]+m|p[tc+]|in|\%))', Regexp::IGNORECASE)
+  RE_BACKGROUND_POSITION = Regexp.new("((((#{RE_LENGTH_OR_PERCENTAGE})|left|center|right|top|bottom)[\s]*){1,2})", Regexp::IGNORECASE | Regexp::EXTENDED)
+  FONT_UNITS_RX = /(([x]+\-)*small|medium|large[r]*|auto|inherit|([0-9]+|[0-9]*\.[0-9]+)(e[mx]+|px|[cm]+m|p[tc+]|in|\%)*)/i
+  RE_BORDER_STYLE = /([\s]*^)?(none|hidden|dotted|dashed|solid|double|dot-dash|dot-dot-dash|wave|groove|ridge|inset|outset)([\s]*$)?/imx
+  RE_BORDER_UNITS = Regexp.union(BOX_MODEL_UNITS_RX, /(thin|medium|thick)/i)
+  
+ 
+  # Patterns for specificity calculations
+  NON_ID_ATTRIBUTES_AND_PSEUDO_CLASSES_RX= /
+    (\.[\w]+)                     # classes
+    |
+    \[(\w+)                       # attributes
+    |
+    (\:(                          # pseudo classes
+      link|visited|active
+      |hover|focus
+      |lang
+      |target
+      |enabled|disabled|checked|indeterminate
+      |root
+      |nth-child|nth-last-child|nth-of-type|nth-last-of-type
+      |first-child|last-child|first-of-type|last-of-type
+      |only-child|only-of-type
+      |empty|contains
+    ))
+  /ix
+  ELEMENTS_AND_PSEUDO_ELEMENTS_RX = /
+    ((^|[\s\+\>\~]+)[\w]+       # elements
+    |                   
+    \:{1,2}(                    # pseudo-elements
+      after|before
+      |first-letter|first-line
+      |selection
+    )
+  )/ix
+
+  # Colours
+  RE_COLOUR_NUMERIC = Regexp.new('((hsl|rgb)[\s]*\([\s-]*[\d]+(\.[\d]+)?[%\s]*,[\s-]*[\d]+(\.[\d]+)?[%\s]*,[\s-]*[\d]+(\.[\d]+)?[%\s]*\))', Regexp::IGNORECASE)
+  RE_COLOUR_NUMERIC_ALPHA = Regexp.new('((hsla|rgba)[\s]*\([\s-]*[\d]+(\.[\d]+)?[%\s]*,[\s-]*[\d]+(\.[\d]+)?[%\s]*,[\s-]*[\d]+(\.[\d]+)?[%\s]*,[\s-]*[\d]+(\.[\d]+)?[%\s]*\))', Regexp::IGNORECASE)
+  RE_COLOUR_HEX = /(#([0-9a-f]{6}|[0-9a-f]{3})([\s;]|$))/i
+  RE_COLOUR_NAMED = /([\s]*^)?(aqua|black|blue|fuchsia|gray|green|lime|maroon|navy|olive|orange|purple|red|silver|teal|white|yellow|transparent)([\s]*$)?/i
+  RE_COLOUR = Regexp.union(RE_COLOUR_NUMERIC, RE_COLOUR_NUMERIC_ALPHA, RE_COLOUR_HEX, RE_COLOUR_NAMED)
+  # :startdoc:
+end

data/lib/css_parser/rule_set.rb

@@ -0,0 +1,451 @@
+module CssParser
+  class RuleSet
+    # Patterns for specificity calculations
+    RE_ELEMENTS_AND_PSEUDO_ELEMENTS = /((^|[\s\+\>]+)[\w]+|\:(first\-line|first\-letter|before|after))/i
+    RE_NON_ID_ATTRIBUTES_AND_PSEUDO_CLASSES = /(\.[\w]+)|(\[[\w]+)|(\:(link|first\-child|lang))/i
+
+    # Array of selector strings.
+    attr_reader   :selectors
+    
+    # Integer with the specificity to use for this RuleSet.
+    attr_accessor   :specificity
+
+    def initialize(selectors, block, specificity = nil)
+      @selectors = []
+      @specificity = specificity
+      @declarations = {}
+      @order = 0
+      parse_selectors!(selectors) if selectors
+      parse_declarations!(block)
+    end
+
+
+    # Get the value of a property
+    def get_value(property)
+      return '' unless property and not property.empty?
+
+      property = property.downcase.strip
+      properties = @declarations.inject('') do |val, (key, data)|
+        #puts "COMPARING #{key} #{key.inspect} against #{property} #{property.inspect}"
+        importance = data[:is_important] ? ' !important' : ''
+        val << "#{data[:value]}#{importance}; " if key.downcase.strip == property
+        val
+      end
+      return properties ? properties.strip : ''
+    end
+    alias_method :[], :get_value
+
+    # Add a CSS declaration to the current RuleSet.
+    #
+    #  rule_set.add_declaration!('color', 'blue')
+    #
+    #  puts rule_set['color']
+    #  => 'blue;'
+    #
+    #  rule_set.add_declaration!('margin', '0px auto !important')
+    #
+    #  puts rule_set['margin']
+    #  => '0px auto !important;'
+    #
+    # If the property already exists its value will be over-written.
+    def add_declaration!(property, value)
+      if value.nil? or value.empty?
+        @declarations.delete(property)
+        return
+      end
+      
+      value.gsub!(/;\Z/, '')
+      is_important = !value.gsub!(CssParser::IMPORTANT_IN_PROPERTY_RX, '').nil?
+      property = property.downcase.strip
+      #puts "SAVING #{property}  #{value} #{is_important.inspect}"
+      @declarations[property] = {
+        :value => value, :is_important => is_important, :order => @order += 1
+      }
+    end
+    alias_method :[]=, :add_declaration!
+
+    # Remove CSS declaration from the current RuleSet.
+    #
+    #  rule_set.remove_declaration!('color')
+    def remove_declaration!(property)
+      @declarations.delete(property)
+    end
+
+    # Iterate through selectors.
+    #
+    # Options
+    # -  +force_important+ -- boolean
+    #
+    # ==== Example
+    #   ruleset.each_selector do |sel, dec, spec|
+    #     ...
+    #   end
+    def each_selector(options = {}) # :yields: selector, declarations, specificity
+      declarations = declarations_to_s(options)
+      if @specificity
+        @selectors.each { |sel| yield sel.strip, declarations, @specificity }
+      else
+        @selectors.each { |sel| yield sel.strip, declarations, CssParser.calculate_specificity(sel) }
+      end
+    end
+
+    # Iterate through declarations.
+    def each_declaration # :yields: property, value, is_important
+      decs = @declarations.sort { |a,b| a[1][:order].nil? || b[1][:order].nil? ? 0 : a[1][:order] <=> b[1][:order] }
+      decs.each do |property, data|
+        value = data[:value]
+        yield property.downcase.strip, value.strip, data[:is_important]
+      end
+    end
+
+    # Return all declarations as a string.
+    #--
+    # TODO: Clean-up regexp doesn't seem to work
+    #++
+    def declarations_to_s(options = {})
+     options = {:force_important => false}.merge(options)
+     str = ''
+     each_declaration do |prop, val, is_important|
+       importance = (options[:force_important] || is_important) ? ' !important' : ''
+       str += "#{prop}: #{val}#{importance}; "
+     end
+     str.gsub(/^[\s^(\{)]+|[\n\r\f\t]*|[\s]+$/mx, '').strip
+    end
+
+    # Return the CSS rule set as a string.
+    def to_s
+      decs = declarations_to_s
+      "#{@selectors.join} { #{decs} }"
+    end
+
+    # Split shorthand declarations (e.g. +margin+ or +font+) into their constituent parts.
+    def expand_shorthand!
+      # border must be expanded before dimensions
+      expand_border_shorthand!
+      expand_dimensions_shorthand!
+      expand_font_shorthand!
+      expand_background_shorthand!
+    end
+
+    # Create shorthand declarations (e.g. +margin+ or +font+) whenever possible.
+    def create_shorthand!
+      create_background_shorthand!
+      create_dimensions_shorthand!
+      # border must be shortened after dimensions
+      create_border_shorthand!
+      create_font_shorthand!
+    end
+    
+    # Split shorthand border declarations (e.g. <tt>border: 1px red;</tt>)
+    # Additional splitting happens in expand_dimensions_shorthand!
+    def expand_border_shorthand! # :nodoc:
+      ['border', 'border-left', 'border-right', 'border-top', 'border-bottom'].each do |k|
+        next unless @declarations.has_key?(k)
+
+        value = @declarations[k][:value]
+
+        split_declaration(k, "#{k}-width", value.slice!(CssParser::RE_BORDER_UNITS))
+        split_declaration(k, "#{k}-color", value.slice!(CssParser::RE_COLOUR))
+        split_declaration(k, "#{k}-style", value.slice!(CssParser::RE_BORDER_STYLE))
+
+        @declarations.delete(k)   
+      end
+    end
+
+    # Split shorthand dimensional declarations (e.g. <tt>margin: 0px auto;</tt>)
+    # into their constituent parts.  Handles margin, padding, border-color, border-style and border-width.
+    def expand_dimensions_shorthand! # :nodoc:
+      {'margin'       => 'margin-%s',
+       'padding'      => 'padding-%s',
+       'border-color' => 'border-%s-color', 
+       'border-style' => 'border-%s-style', 
+       'border-width' => 'border-%s-width'}.each do |property, expanded|
+
+        next unless @declarations.has_key?(property)
+        
+        value = @declarations[property][:value]
+
+        # RGB and HSL values in borders are the only units that can have spaces (within params).
+        # We cheat a bit here by stripping spaces after commas in RGB and HSL values so that we 
+        # can split easily on spaces.
+        #
+        # TODO: rgba, hsl, hsla
+        value.gsub!(RE_COLOUR) { |c| c.gsub(/[\s]+/, '') }
+
+        matches = value.strip.split(/[\s]+/)
+
+        t, r, b, l = nil
+
+        case matches.length
+          when 1
+            t, r, b, l = matches[0], matches[0], matches[0], matches[0]
+          when 2
+            t, b = matches[0], matches[0]
+            r, l = matches[1], matches[1]
+          when 3
+            t =  matches[0]
+            r, l = matches[1], matches[1]
+            b =  matches[2]
+          when 4
+            t =  matches[0]
+            r = matches[1]
+            b =  matches[2]
+            l = matches[3]
+        end
+
+        values = @declarations[property]
+        
+        split_declaration(property, expanded % 'top', t)
+        split_declaration(property, expanded % 'right', r)
+        split_declaration(property, expanded % 'bottom', b)
+        split_declaration(property, expanded % 'left', l)
+
+        @declarations.delete(property)
+      end
+    end
+
+    # Convert shorthand font declarations (e.g. <tt>font: 300 italic 11px/14px verdana, helvetica, sans-serif;</tt>)
+    # into their constituent parts.
+    def expand_font_shorthand! # :nodoc:
+      return unless @declarations.has_key?('font')
+
+      font_props = {}
+
+      # reset properties to 'normal' per http://www.w3.org/TR/CSS21/fonts.html#font-shorthand
+      ['font-style', 'font-variant', 'font-weight', 'font-size',
+       'line-height'].each do |prop|
+        font_props[prop] = 'normal'
+       end
+
+      value = @declarations['font'][:value]
+      is_important = @declarations['font'][:is_important]
+      order = @declarations['font'][:order]
+
+      in_fonts = false
+
+      matches = value.scan(/("(.*[^"])"|'(.*[^'])'|(\w[^ ,]+))/)
+      matches.each do |match|
+        m = match[0].to_s.strip
+        m.gsub!(/[;]$/, '')
+
+        if in_fonts
+          if font_props.has_key?('font-family')
+            font_props['font-family'] += ', ' + m
+          else
+            font_props['font-family'] = m
+          end
+        elsif m =~ /normal|inherit/i
+          ['font-style', 'font-weight', 'font-variant'].each do |font_prop|
+            font_props[font_prop] = m unless font_props.has_key?(font_prop)
+          end
+        elsif m =~ /italic|oblique/i
+          font_props['font-style'] = m
+        elsif m =~ /small\-caps/i
+          font_props['font-variant'] = m
+        elsif m =~ /[1-9]00$|bold|bolder|lighter/i
+          font_props['font-weight'] = m
+        elsif m =~ CssParser::FONT_UNITS_RX
+          if m =~ /\//
+            font_props['font-size'], font_props['line-height'] = m.split('/')
+          else
+            font_props['font-size'] = m
+          end
+          in_fonts = true
+        end
+      end
+
+      font_props.each { |font_prop, font_val| @declarations[font_prop] = {:value => font_val, :is_important => is_important, :order => order} }
+
+      @declarations.delete('font')
+    end
+
+    # Convert shorthand background declarations (e.g. <tt>background: url("chess.png") gray 50% repeat fixed;</tt>)
+    # into their constituent parts.
+    #
+    # See http://www.w3.org/TR/CSS21/colors.html#propdef-background
+    def expand_background_shorthand! # :nodoc:
+      return unless @declarations.has_key?('background')
+
+      value = @declarations['background'][:value]
+
+      if value =~ /([\s]*^)?inherit([\s]*$)?/i
+        ['background-color', 'background-image', 'background-attachment', 'background-repeat', 'background-position'].each do |prop|
+          split_declaration('background', prop, 'inherit')          
+        end
+      end
+
+      split_declaration('background', 'background-image', value.slice!(Regexp.union(CssParser::URI_RX, /none/i)))
+      split_declaration('background', 'background-attachment', value.slice!(/([\s]*^)?(scroll|fixed)([\s]*$)?/i))
+      split_declaration('background', 'background-repeat', value.slice!(/([\s]*^)?(repeat(\-x|\-y)*|no\-repeat)([\s]*$)?/i))
+      split_declaration('background', 'background-color', value.slice!(CssParser::RE_COLOUR))
+      split_declaration('background', 'background-position', value.slice(CssParser::RE_BACKGROUND_POSITION))
+
+      @declarations.delete('background')
+    end
+
+    # Looks for long format CSS background properties (e.g. <tt>background-color</tt>) and 
+    # converts them into a shorthand CSS <tt>background</tt> property.
+    #
+    # Leaves properties declared !important alone.
+    def create_background_shorthand! # :nodoc:
+      new_value = ''
+      ['background-color', 'background-image', 'background-repeat', 
+       'background-position', 'background-attachment'].each do |property|
+        if @declarations.has_key?(property) and not @declarations[property][:is_important]
+          new_value += @declarations[property][:value] + ' '
+          @declarations.delete(property)
+        end
+      end
+
+      unless new_value.strip.empty?
+        @declarations['background'] = {:value => new_value.gsub(/[\s]+/, ' ').strip}
+      end
+    end
+    
+    # Combine border-color, border-style and border-width into border
+    # Should be run after create_dimensions_shorthand!
+    #
+    # TODO: this is extremely similar to create_background_shorthand! and should be combined
+    def create_border_shorthand! # :nodoc:
+      new_value = ''
+      
+      ['border-width', 'border-style', 'border-color'].each do |property|
+        if @declarations.has_key?(property) and not @declarations[property][:is_important]
+          
+          # can't merge if any value contains a space (i.e. has multiple values)
+          return if @declarations[property][:value].strip =~ /[\s]/
+          new_value += @declarations[property][:value] + ' '
+        end
+      end
+
+      @declarations.delete('border-width')
+      @declarations.delete('border-style')
+      @declarations.delete('border-color')
+
+      unless new_value.strip.empty?
+        @declarations['border'] = {:value => new_value.gsub(/[\s]+/, ' ').strip}
+      end
+    end
+    
+    # Looks for long format CSS dimensional properties (margin, padding, border-color, border-style and border-width) 
+    # and converts them into shorthand CSS properties.
+    def create_dimensions_shorthand! # :nodoc:
+      directions = ['top', 'right', 'bottom', 'left']
+
+      {'margin'       => 'margin-%s',
+       'padding'      => 'padding-%s',
+       'border-color' => 'border-%s-color', 
+       'border-style' => 'border-%s-style', 
+       'border-width' => 'border-%s-width'}.each do |property, expanded|
+
+        foldable = @declarations.select do |dim, val| 
+          dim == expanded % 'top' or dim == expanded % 'right' or dim == expanded % 'bottom' or dim == expanded % 'left'
+        end
+        # All four dimensions must be present
+        if foldable.length == 4
+          values = {}
+
+          directions.each { |d| values[d.to_sym] = @declarations[expanded % d][:value].downcase.strip }
+
+          if values[:left] == values[:right]
+            if values[:top] == values[:bottom] 
+              if values[:top] == values[:left] # All four sides are equal
+                new_value = values[:top]
+              else # Top and bottom are equal, left and right are equal
+                new_value = values[:top] + ' ' + values[:left]
+              end
+            else # Only left and right are equal
+              new_value = values[:top] + ' ' + values[:left] + ' ' + values[:bottom]
+            end
+          else # No sides are equal
+            new_value = values[:top] + ' ' + values[:right] + ' ' + values[:bottom] + ' ' + values[:left]
+          end
+
+          new_value.strip!
+          @declarations[property] = {:value => new_value.strip} unless new_value.empty?
+
+          # Delete the longhand values
+          directions.each { |d| @declarations.delete(expanded % d) }
+        end
+      end
+    end
+
+
+    # Looks for long format CSS font properties (e.g. <tt>font-weight</tt>) and 
+    # tries to convert them into a shorthand CSS <tt>font</tt> property.  All 
+    # font properties must be present in order to create a shorthand declaration.
+    def create_font_shorthand! # :nodoc:
+      ['font-style', 'font-variant', 'font-weight', 'font-size',
+       'line-height', 'font-family'].each do |prop|
+        return unless @declarations.has_key?(prop)
+      end
+
+      new_value = ''
+      ['font-style', 'font-variant', 'font-weight'].each do |property|
+        unless @declarations[property][:value] == 'normal'
+          new_value += @declarations[property][:value] + ' '
+        end
+      end
+
+      new_value += @declarations['font-size'][:value]
+
+      unless @declarations['line-height'][:value] == 'normal'
+        new_value += '/' + @declarations['line-height'][:value]
+      end
+
+      new_value += ' ' + @declarations['font-family'][:value]
+
+      @declarations['font'] = {:value => new_value.gsub(/[\s]+/, ' ').strip}
+
+      ['font-style', 'font-variant', 'font-weight', 'font-size',
+       'line-height', 'font-family'].each do |prop|
+       @declarations.delete(prop)
+      end
+
+    end
+
+  private
+
+    # utility method for re-assign shorthand elements to longhand versions
+    def split_declaration(src, dest, v)  # :nodoc:
+      return unless v and not v.empty?
+
+      atts = @declarations[src]
+
+      if @declarations.has_key?(dest)
+        #puts "dest #{dest} already exists"
+      
+        if @declarations[dest][:order] > @declarations[src][:order]
+          #puts "skipping #{dest}:#{v} due to order "        
+          return
+        else
+          @declarations[dest] = {}    
+        end
+      end
+      @declarations[dest] = @declarations[src].merge({:value => v.to_s.strip})    
+    end
+  
+    def parse_declarations!(block) # :nodoc:
+      @declarations = {}
+
+      return unless block
+
+      block.gsub!(/(^[\s]*)|([\s]*$)/, '')
+
+      block.split(/[\;$]+/m).each do |decs|
+        if matches = decs.match(/(.[^:]*)\:(.[^;]*)(;|\Z)/i)
+          property, value, end_of_declaration = matches.captures
+
+          add_declaration!(property, value)
+        end
+      end
+    end
+
+    #--
+    # TODO: way too simplistic
+    #++
+    def parse_selectors!(selectors) # :nodoc:
+      @selectors = selectors.split(',') 
+    end
+  end
+end