css_toolkit 1.3

data/lib/modules/css_properties.rb

@@ -0,0 +1,195 @@
+module CssTidy
+
+	# parser current context
+	NONE				= 0
+	IN_SELECTOR = 1
+	IN_PROPERTY = 2
+	IN_VALUE		= 3
+	IN_STRING		= 4
+	IN_COMMENT	= 5
+	IN_AT_BLOCK	= 6
+
+	# All whitespace allowed in CSS
+	WHITESPACE = [' ',"\n","\t","\r","\x0B"]
+
+	# All CSS tokens used by tidy
+	TOKENS = %w[/ @ } { ; : = ' " ( , \\ ! $ % & ) * + . < > ? [ ] ^ ` | ~]
+	# All CSS units (CSS 3 units included)
+	units = ['in','cm','mm','pt','pc','px','rem','em','%','ex','gd','vw','vh','vm','deg','grad','rad','ms','s','khz','hz']
+
+	# Available at-rules
+	AT_RULES = {
+		'page' => IN_SELECTOR,
+		'font-face' => IN_SELECTOR,
+		'charset' => IN_VALUE,
+		'import' => IN_VALUE,
+		'namespace' => IN_VALUE,
+		'media' => IN_AT_BLOCK
+	}
+
+	# Properties that need a value with unit
+	unit_values = [
+		'background', 'background-position',
+		'border', 'border-top', 'border-right', 'border-bottom', 'border-left', 'border-width',
+		'border-top-width', 'border-right-width', 'border-left-width', 'border-bottom-width',
+		'bottom', 'border-spacing', 'font-size', 'height', 'left',
+		'margin', 'margin-top', 'margin-right', 'margin-bottom', 'margin-left',
+		'max-height', 'max-width', 'min-height', 'min-width', 'outline-width',
+		'padding', 'padding-top', 'padding-right', 'padding-bottom', 'padding-left',
+    'position', 'right', 'top', 'text-indent', 'letter-spacing', 'word-spacing', 'width'
+	]
+
+	# Properties that allow <color> as value
+	color_values = [
+		'background-color', 'border-color', 'border-top-color', 'border-right-color',
+		'border-bottom-color', 'border-left-color', 'color', 'outline-color'
+	]
+
+	# Default values for the background properties
+	background_prop_default = {
+		'background-image' 			=> 'none',
+		'background-size'				=> 'auto',
+		'background-repeat' 		=> 'repeat',
+		'background-position'		=> '0 0',
+		'background-attachment'	=> 'scroll',
+		'background-clip'				=> 'border',
+		'background-origin'			=> 'padding',
+		'background-color'			=> 'transparent',
+	}
+
+	# A list of all shorthand properties that are devided into four properties and/or have four subvalues
+	SHORTHANDS = {
+		'border-color'	=> ['border-top-color','border-right-color','border-bottom-color','border-left-color'],
+		'border-style'	=> ['border-top-style','border-right-style','border-bottom-style','border-left-style'],
+		'border-width'	=> ['border-top-width','border-right-width','border-bottom-width','border-left-width'],
+		'margin'				=> ['margin-top','margin-right','margin-bottom','margin-left'],
+		'padding'				=> ['padding-top','padding-right','padding-bottom','padding-left'],
+	}
+
+	# All CSS Properties
+	PROPERTIES = {
+		'background' 						=> '1.0,2.0,2.1',
+		'background-color' 			=> '1.0,2.0,2.1',
+		'background-image' 			=> '1.0,2.0,2.1',
+		'background-repeat' 		=> '1.0,2.0,2.1',
+		'background-attachment' => '1.0,2.0,2.1',
+		'background-position' 	=> '1.0,2.0,2.1',
+		'border' 								=> '1.0,2.0,2.1',
+		'border-top' 						=> '1.0,2.0,2.1',
+		'border-right' 					=> '1.0,2.0,2.1',
+		'border-bottom' 				=> '1.0,2.0,2.1',
+		'border-left' 					=> '1.0,2.0,2.1',
+		'border-color' 					=> '1.0,2.0,2.1',
+		'border-top-color' 			=> '2.0,2.1',
+		'border-bottom-color' 	=> '2.0,2.1',
+		'border-left-color' 		=> '2.0,2.1',
+		'border-right-color'	 	=> '2.0,2.1',
+		'border-style' 					=> '1.0,2.0,2.1',
+		'border-top-style' 			=> '2.0,2.1',
+		'border-right-style' 		=> '2.0,2.1',
+		'border-left-style' 		=> '2.0,2.1',
+		'border-bottom-style' 	=> '2.0,2.1',
+		'border-width' 					=> '1.0,2.0,2.1',
+		'border-top-width' 			=> '1.0,2.0,2.1',
+		'border-right-width' 		=> '1.0,2.0,2.1',
+		'border-left-width' 		=> '1.0,2.0,2.1',
+		'border-bottom-width' 	=> '1.0,2.0,2.1',
+		'border-collapse' 			=> '2.0,2.1',
+		'border-spacing' 				=> '2.0,2.1',
+		'bottom' 								=> '2.0,2.1',
+		'caption-side' 					=> '2.0,2.1',
+		'content' 							=> '2.0,2.1',
+		'clear' 								=> '1.0,2.0,2.1',
+		'clip' 									=> '1.0,2.0,2.1',
+		'color' 								=> '1.0,2.0,2.1',
+		'counter-reset' 				=> '2.0,2.1',
+		'counter-increment' 		=> '2.0,2.1',
+		'cursor'			 					=> '2.0,2.1',
+		'empty-cells' 					=> '2.0,2.1',
+		'display' 							=> '1.0,2.0,2.1',
+		'direction' 						=> '2.0,2.1',
+		'float' 								=> '1.0,2.0,2.1',
+		'font' 									=> '1.0,2.0,2.1',
+		'font-family' 					=> '1.0,2.0,2.1',
+		'font-style' 						=> '1.0,2.0,2.1',
+		'font-variant' 					=> '1.0,2.0,2.1',
+		'font-weight' 					=> '1.0,2.0,2.1',
+		'font-stretch' 					=> '2.0',
+		'font-size-adjust' 			=> '2.0',
+		'font-size' 						=> '1.0,2.0,2.1',
+		'height' 								=> '1.0,2.0,2.1',
+		'left' 									=> '1.0,2.0,2.1',
+		'line-height' 					=> '1.0,2.0,2.1',
+		'list-style' 						=> '1.0,2.0,2.1',
+		'list-style-type' 			=> '1.0,2.0,2.1',
+		'list-style-image' 			=> '1.0,2.0,2.1',
+		'list-style-position' 	=> '1.0,2.0,2.1',
+		'margin' 								=> '1.0,2.0,2.1',
+		'margin-top' 						=> '1.0,2.0,2.1',
+		'margin-right' 					=> '1.0,2.0,2.1',
+		'margin-bottom' 				=> '1.0,2.0,2.1',
+		'margin-left' 					=> '1.0,2.0,2.1',
+		'marks' 								=> '1.0,2.0',
+		'marker-offset' 				=> '2.0',
+		'max-height'			 			=> '2.0,2.1',
+		'max-width' 						=> '2.0,2.1',
+		'min-height' 						=> '2.0,2.1',
+		'min-width' 						=> '2.0,2.1',
+		'overflow' 							=> '1.0,2.0,2.1',
+		'orphans' 							=> '2.0,2.1',
+		'outline' 							=> '2.0,2.1',
+		'outline-width' 				=> '2.0,2.1',
+		'outline-style' 				=> '2.0,2.1',
+		'outline-color' 				=> '2.0,2.1',
+		'padding' 							=> '1.0,2.0,2.1',
+		'padding-top' 					=> '1.0,2.0,2.1',
+		'padding-right' 				=> '1.0,2.0,2.1',
+		'padding-bottom' 				=> '1.0,2.0,2.1',
+		'padding-left' 					=> '1.0,2.0,2.1',
+		'page-break-before' 		=> '1.0,2.0,2.1',
+		'page-break-after' 			=> '1.0,2.0,2.1',
+		'page-break-inside' 		=> '2.0,2.1',
+		'page' 									=> '2.0',
+		'position' 							=> '1.0,2.0,2.1',
+		'quotes' 								=> '2.0,2.1',
+		'right' 								=> '2.0,2.1',
+		'size' 									=> '1.0,2.0',
+		'speak-header' 					=> '2.0,2.1',
+		'table-layout' 					=> '2.0,2.1',
+		'top' 									=> '1.0,2.0,2.1',
+		'text-indent' 					=> '1.0,2.0,2.1',
+		'text-align' 						=> '1.0,2.0,2.1',
+		'text-decoration' 			=> '1.0,2.0,2.1',
+		'text-shadow' 					=> '2.0',
+		'letter-spacing' 				=> '1.0,2.0,2.1',
+		'word-spacing' 					=> '1.0,2.0,2.1',
+		'text-transform' 				=> '1.0,2.0,2.1',
+		'white-space' 					=> '1.0,2.0,2.1',
+		'unicode-bidi' 					=> '2.0,2.1',
+		'vertical-align' 				=> '1.0,2.0,2.1',
+		'visibility' 						=> '1.0,2.0,2.1',
+		'width' 								=> '1.0,2.0,2.1',
+		'widows' 								=> '2.0,2.1',
+		'z-index' 							=> '1.0,2.0,2.1',
+		# Speech
+		'volume' 								=> '2.0,2.1',
+		'speak' 								=> '2.0,2.1',
+		'pause' 								=> '2.0,2.1',
+		'pause-before' 					=> '2.0,2.1',
+		'pause-after'	 					=> '2.0,2.1',
+		'cue' 									=> '2.0,2.1',
+		'cue-before' 						=> '2.0,2.1',
+		'cue-after' 						=> '2.0,2.1',
+		'play-during' 					=> '2.0,2.1',
+		'azimuth' 							=> '2.0,2.1',
+		'elevation' 						=> '2.0,2.1',
+		'speech-rate' 					=> '2.0,2.1',
+		'voice-family'	 				=> '2.0,2.1',
+		'pitch' 								=> '2.0,2.1',
+		'pitch-range' 					=> '2.0,2.1',
+		'stress' 								=> '2.0,2.1',
+		'richness' 							=> '2.0,2.1',
+		'speak-punctuation' 		=> '2.0,2.1',
+		'speak-numeral' 				=> '2.0,2.1',
+	}
+end

data/lib/modules/css_rule_set.rb

@@ -0,0 +1,197 @@
+$:.unshift File.dirname(__FILE__)
+require 'css_properties'
+
+module CssTidy
+
+	# The RuleSet class takes ONE selector and a set of declarations
+	# Declarations are stored in order to allow for hacks such as the box model hacks
+	class RuleSet < CssBase
+		attr_accessor :declarations, :selectors
+
+		def initialize(opts={})
+      @selectors = []
+
+			# declarations are made up of:  property S* ':' S* value;
+			@declarations = []
+			add_rule(opts)
+		end
+
+		def add_rule(opts={})
+			if opts[:selector] && opts[:declarations]
+			# we assume the declarations are valid, but top and tail whitespace
+			# and avoid duplicate selectors
+				@selectors << opts[:selector].strip unless @selectors.member?( opts[:selector])
+	      opts[:declarations].strip.split(/[\;$]+/m).each do |declaration|
+	        if matches = declaration.match(/(.[^:]*)\:(.[^;]*)(;|\Z)/i)
+	          property, value, end_of_declaration = matches.captures
+						@declarations << CssTidy::Declaration.new(property.strip, value.strip)
+	        end
+	      end
+				opts[:declarations].strip.split(';').each do |declaration|
+					property, value = declaration.strip.split(/:/)
+				end
+			end
+			self
+		end
+
+		def << (declaration)
+			property, value = declaration.strip.split(':')
+			@declarations << CssTidy::Declaration.new(property.strip, value.strip)
+		end
+
+		def to_hash
+			declarations = []
+			@declarations.each do |declaration|
+				declarations << declaration.to_s
+			end
+			{@selectors, declarations}
+		end
+
+		def to_s(format=:one_line)
+			return '' if @selectors.empty? || @declarations.empty?
+
+			declarations = []
+			@declarations.each do |declaration|
+				declarations << declaration.to_s
+			end
+
+			case format
+			when :one_line
+				@selectors.join(',') + '{' + declarations.join(';') + '}'
+			when :multi_line
+				@selectors.join(',') + "{\n  " + declarations.join(";\n  ") + "\n}"
+			end
+		end
+
+		# Rule Sets know how to optimise themselves
+
+		def optimize(options)
+			merge_4_part_longhands
+			@declarations.each do |declaration|
+				declaration.optimize_colors 			 	if options[:optimize_colors]
+				declaration.fix_invalid_colors 			if options[:fix_invalid_colors]
+				declaration.downcase_property 		 	if options[:downcase_properties]
+				declaration.optimize_zeros				 	if options[:optimize_zeros]
+				declaration.optimize_mp_shorthands 	if options[:optimize_margin_padding]
+				declaration.optimize_filters			 	if options[:optimize_filters]
+				declaration.optimize_urls						if options[:optimize_urls]
+				declaration.optimize_font_weight		if options[:optimize_font_weight]
+				declaration.optimize_punctuation  # no option
+			end
+			optimize_selectors(options)
+		end
+
+		def merge_4_part_longhands
+			SHORTHANDS.each do |shorthand, longhands|
+				values = []
+				important_count = 0
+				@declarations.each_with_index do |declaration, idx|
+					# if one is important, the new merged rule will be important.
+					# this will probably break CSS in some rare cases
+					important_count = declaration.important? ? important_count + 1 : important_count + 0
+					case declaration.property
+					when longhands[0]
+						values[0] = declaration.value
+					when longhands[1]
+						values[1] = declaration.value
+					when longhands[2]
+						values[2] = declaration.value
+					when longhands[3]
+						values[3] = declaration.value
+					end
+				end
+				# remove nil values
+				values.compact!
+				if values.size == 4
+					# remove the old ones
+					@declarations.delete_if do |decl|
+						longhands.include?(decl.property)
+					end
+					values.map!{|v| v.gsub(/!important/, '').strip}
+					important = important_count > 0 ? '!important' : ''
+					# add the new rule
+					@declarations << CssTidy::Declaration.new(shorthand, values.join(' ') + important)
+				end
+			end
+		end
+
+		def optimize_selectors(options)
+			@selectors.map do |selector|
+				# squish up IE comment in selector hack
+				selector.gsub!(/\s*>\s*\/\*\s*\*\/\s*/, '>/**/' )
+	      # special case for IE
+	      selector.gsub!(/:first-(line|letter)(,|\Z)/, ':first-\1 \2')
+				# remove any kind of comment string
+				if options[:keep_ie7_selector_comments]
+					selector.gsub!(/\/\*\*\//, '_IE7_') # protect from next options
+				end
+				if ! options[:keep_selector_comments]
+					selector.gsub!(/(\s+)?\/\*(.|[\r\n])*?\*\/(\s+)?/, '')
+				end
+				selector.gsub!(/_IE7_/, '/**/') # restore hack comments
+
+			end
+		end
+
+		# starting with colors
+		def optimize_colors
+			@declarations.each do |declaration|
+				declaration.optimize_colors
+			end
+		end
+
+		# starting with colors
+		def downcase_selectors
+			@selectors.map {|selector| selector.downcase }
+		end
+
+		def empty?
+			@declarations.empty?
+		end
+
+		def == (other_set)
+			# must at least have the same number of declarations and be same type of object
+			if other_set.respond_to?(:declaration_count) && declaration_count == other_set.declaration_count
+				number_of_identical_declations = 0
+				other_set.declarations.each do |other_dec|
+					@declarations.each do |this_dec|
+						if this_dec == other_dec
+							number_of_identical_declations += 1
+						end
+					end
+				end
+				true if declaration_count == number_of_identical_declations
+			end
+		end
+
+		def + (other_set)
+			@selectors += other_set.selectors
+			self
+		end
+
+		def declaration_count
+			@declarations.length
+		end
+
+		def inspect(indent='')
+			puts indent + " + " + @selectors.join(',')
+			 @declarations.each do |decl|
+				puts indent * 2 + "| " + decl.to_s
+			end
+		end
+
+		def clear
+      @selectors = []
+			@declarations = []
+		end
+
+		private
+
+
+		def each_declaration
+			@values.each_index do |index|
+				yield @properties[index], @values[index]
+			end
+		end
+	end
+end

data/lib/modules/css_stylesheet.rb

@@ -0,0 +1,119 @@
+module CssTidy
+
+	class StyleSheet
+		attr_accessor :in_media
+		alias :end_at_block :in_media
+
+		def initialize
+			# nodes can contain any kind of object:
+			# * charset
+			# * media (which can contain media or rulesets)
+			# * rulesets
+			@nodes = []
+			@charset = ''
+			@in_media = false
+		end
+
+		def << (object)
+			# if we are in media block, then add object to the last node
+			if @in_media
+				if object.class == CssTidy::MediaSet
+					@nodes << object
+				else
+					@nodes.last << object
+				end
+			else
+				@nodes << object
+				if object.class == CssTidy::MediaSet
+					@in_media = true
+				end
+			end
+		end
+
+		def to_s(format=:one_line)
+			css = ''
+			if ! @charset.empty?
+				css << "@charset #{@charset};" + ((format == :multi_line) ? "\n" : '')
+			end
+
+			@nodes.each do |node|
+				css << node.to_s(format) + ((format == :multi_line) ? "\n" : '')
+			end
+			css
+		end
+
+		def charset=(charset)
+			if @charset.empty?
+				@charset = charset.strip
+				return true
+			else
+				return false
+			end
+		end
+
+		def charset
+			@charset
+		end
+
+		def optimize(options={})
+			keep_next_comment = false
+
+			@nodes.each_with_index do |node, idx|
+				if node.class == CssTidy::Comment
+					if node.is_special? && options[:keep_special_comments]
+						next # do nothing
+					elsif node.is_ie5_hack? && options[:keep_ie5_comment_hack] && ! options[:optimize_selectors]
+						node.text = '\\'  # replace it
+						keep_next_comment = true
+					elsif keep_next_comment
+						node.text = ''  # replace it
+						keep_next_comment = false
+					elsif ! options[:keep_comments]
+						node.printable = false # don't print this one
+					end
+				end
+				node.optimize(options)
+			end
+
+			if options[:optimize_selectors]
+				nodes_to_remove = []
+				length = @nodes.length
+				@nodes.each_with_index do |node, index|
+					if node.class == CssTidy::RuleSet
+						idx = index
+						# Check if properties also exist in another RuleSet
+						while idx < length -1
+							idx += 1 # start at the next one
+							# just Rulsets
+							if @nodes[idx].class == CssTidy::RuleSet
+								if ! node.empty? && node == @nodes[idx]
+									node += @nodes[idx]
+									nodes_to_remove << idx
+									@nodes[idx].clear
+								end
+					 		end
+ 			      end
+					end
+				end
+			end
+
+		end
+
+		def inspect
+			indent = '  '
+			puts "Stylesheet"
+			@nodes.each_with_index do |node, idx|
+				case node.class.to_s
+				when 'CssTidy::RuleSet'
+					puts " + RuleSet"
+				when 'CssTidy::Comment'
+					puts " + Comment"
+				end
+				node.inspect(indent)
+#				puts node.class
+			end
+		end
+
+	end
+
+end