csspress 0.0.1

data/lib/csspress/declaration.rb

@@ -0,0 +1,144 @@
+#!/usr/local/bin/ruby -w
+
+# declaration.rb
+#
+# Created by David Madden on 2008-05-14.
+# Copyright 2008 David Madden. All rights reserved.
+#
+# This is Free Software.  See LICENSE for details.
+
+# Declaration represents a declaration in a style sheet rule.
+# It is composed of a property and a value. The property must be
+# valid.
+# 
+# Declaration takes a string and populates itself.
+# 
+# Example:
+#   d = declaration.new ( "border-color : blue" )
+#   puts d.property #=> "border-color"
+#   puts d.value    #=> "blue"
+#
+class Declaration
+  
+  # Declaration property
+  attr_reader :property
+  # Declaration value
+  attr_reader :value
+  
+  # internal error for invalid property types
+  # 
+  class PropertyError < StandardError
+    # do nothing - just creating a specific error
+  end
+  
+  # Properties for CSS1 to CSS3
+  VALID_PROPERTIES = %w(
+    alignment-adjust alignment-baseline appearance azimuth background background-attachment background-break
+    background-clip background-color background-image background-origin background-position background-repeat
+    background-size baseline-shift binding bookmark-label bookmark-level bookmark-target border border-bottom
+    border-bottom-color border-bottom-left-radius border-bottom-right-radius border-bottom-style border-bottom-width
+    border-break border-collapse border-color border-image border-left border-left-color border-left-style
+    border-left-width border-length border-radius border-right border-right-color border-right-style border-right-width
+    border-spacing border-style border-top border-top-color border-top-left-radius border-top-right-radius border-top-style
+    border-top-width border-width bottom box-align box-direction box-flex box-flex-group box-lines box-orient box-pack
+    box-shadow box-sizing caption-side clear clip color color-profile column-break-after column-break-before column-count
+    column-fill column-gap column-rule column-rule-color column-rule-style column-rule-width column-span column-width columns
+    content counter-increment counter-reset crop cue cue-after cue-before cursor direction display dominant-baseline
+    drop-initial-after-adjust drop-initial-after-align drop-initial-before-adjust drop-initial-before-align
+    drop-initial-size drop-initial-value elevation empty-cells fit fit-position float float-offset font
+    font-effect font-emphasize font-emphasize-position font-emphasize-style font-family font-size font-size-adjust
+    font-smooth font-stretch font-style font-variant font-weight grid-columns grid-rows hanging-punctuation height
+    hyphenate-after hyphenate-before hyphenate-character hyphenate-lines hyphenate-resource hyphens icon image-orientation
+    image-resolution inline-box-align left letter-spacing line-height line-stacking line-stacking-ruby line-stacking-shift
+    line-stacking-strategy list-style list-style-image list-style-position list-style-type margin margin-bottom margin-left
+    margin-right margin-top mark mark-after mark-before marker-offset marks marquee-direction marquee-loop marquee-speed
+    marquee-style max-height max-width min-height min-width move-to nav-down nav-index nav-left nav-right nav-up opacity orphans
+    outline outline-color outline-offset outline-style outline-width overflow overflow-style overflow-x overflow-y padding
+    padding-bottom padding-left padding-right padding-top page page-break-after page-break-before page-break-inside page-policy
+    pause pause-after pause-before phonemes pitch pitch-range play-during position presentation-level punctuation-trim quotes
+    rendering-intent resize rest rest-after rest-before richness right rotation rotation-point ruby-align ruby-overhang ruby-position
+    ruby-span size speak speak-header speak-numeral speak-punctuation speech-rate stress string-set tab-side table-layout target
+    target-name target-new target-position text-align text-align-last text-decoration text-emphasis text-height text-indent
+    text-justify text-outline text-replace text-shadow text-transform text-wrap top unicode-bidi vertical-align visibility
+    voice-balance voice-duration voice-family voice-pitch voice-pitch-range voice-rate voice-stress voice-volume volume
+    white-space white-space-collapse widows width word-break word-spacing word-wrap z-index
+  )
+  
+  ## Create a new Declaration from a string
+  # (The string should be valid CSS!)
+  #
+  def initialize(text)
+    dp = DeclarationParser.new(text)
+    @property = dp.property
+    @value = dp.value
+  end
+  
+  # Print out the rule neatly
+  #
+  def to_s
+   "#{@property}:#{@value}"
+  end
+  
+  private 
+  
+  # This class parses the text entered and makes the
+  # property and value available to the Declaration that
+  # initialised it.
+  #
+  class DeclarationParser #:nodoc:
+    attr_reader :property, :value
+    
+    def initialize(raw_data)
+      @raw_data = raw_data
+      @property = ""
+      @value = ""
+      parse
+    end
+    
+    private
+    
+    # Call methods to parse @raw_data and
+    # extract the property and name.
+    # 
+    # Raise an error if the property found
+    # is invalid.
+    # 
+    def parse
+      @property = get_property
+      raise PropertyError, "Invalid property type found: #{@property}" unless VALID_PROPERTIES.include? @property
+      @value = get_value
+    end
+    
+    # Get the property from @raw_data
+    #---
+    # The property is the part of @raw_data
+    # before the ':' character.
+    #+++
+    # 
+    def get_property
+      @raw_data.slice(0, @raw_data.index(":")).strip
+    end
+    
+    # Get the value from @raw_data
+    #---
+    # The value is the part of @raw_data
+    # after the ':' character.
+    #+++
+    # 
+    def get_value
+      @raw_data.slice(@raw_data.index(":")+1..@raw_data.size-1).strip
+    end
+  end
+end
+
+
+
+if __FILE__ == $0
+  begin
+    d = Declaration.new("backgrond-color: sdfds")
+    puts d.property
+    puts d.value
+  rescue PropertyError => e
+    puts e.message
+  end
+end

data/lib/csspress/rule.rb

@@ -0,0 +1,123 @@
+#!/usr/local/bin/ruby -w
+
+# rule.rb
+#
+# Created by David Madden on 2008-05-14.
+# Copyright 2008 David Madden. All rights reserved.
+#
+# This is Free Software.  See LICENSE for details.
+
+# Rule represents a rule in a style sheet.
+# An example of a rule would be:
+#   body { margin : 0; padding : 0 }
+# 
+# The components of a rule are:
+#   name { declarations }
+# 
+# All declarations of Rule can be accessed using the
+# .each_declaration(){} method where each declaration
+# is passed to the block as a Declaration object.
+# 
+# Example:
+#   r = Rule.new ( "foo { margin: 0; padding: 0 }" )
+#   r.each_declaration do |dec|
+#     puts dec
+#   end
+#   puts r.name
+# 
+class Rule
+  
+  # name of the Rule
+  attr_reader :name
+  # declarations contained within Rule
+  attr_reader :declarations
+  
+  # Create a new Rule from a string
+  # (The string should be a valid CSS rule!)
+  # 
+  def initialize( string )
+    rp = RuleParser.new( string )
+    @name = rp.name
+    @declarations = rp.declarations
+  end
+  
+  # Yeild all declarations for self
+  # 
+  def each_declaration
+    @declarations.each do |declaration|
+      yield declaration
+    end
+  end
+  
+  # Print out the rule neatly
+  # 
+  def to_s
+    "#{@name}{#{@declarations.join(";")}}"
+  end
+  
+  private
+  
+  # This class parses the text entered and makes the
+  # name and declarations available to the Rule that
+  # initialised it.
+  # 
+  class RuleParser #:nodoc:
+    
+    attr_reader :name, :declarations
+    
+    # Create a new RuleParser and parse raw_data
+    # 
+    def initialize( raw_data )
+      @raw_data = raw_data
+      @name = ""
+      @declarations = []
+      parse
+    end
+    
+    private
+    
+    # Calls the methods needed to retrieve the
+    # information from @raw_data
+    # 
+    def parse
+      @name = get_rule_name
+      @declarations = get_declarations
+    end
+    
+    # Get the name of the rule from @raw_data
+    #---
+    # Simply a case of cutting the front off the
+    # @raw data string up to the first '{' and
+    # remove any white space
+    # +++
+    # 
+    def get_rule_name
+      @raw_data.slice(0, @raw_data.index("{")).strip
+    end
+    
+    # Get an array of declartaions for the Rule.
+    #---
+    # Get the part of @raw_data between '{'..'}'
+    # This is all of the declaration text.
+    # Declarations are delimeted by ';' so
+    # the string is split on the semi-colon and
+    # a new Declaration object is created for each
+    # one.
+    #+++
+    # 
+    def get_declarations
+      tmp = []
+      raw = @raw_data.slice(@raw_data.index("{")+1..@raw_data.index("}")-1).strip
+      raw.split(";").each do |line|
+        tmp << Declaration.new(line.strip)
+      end
+      tmp
+    end
+  end
+end
+
+if __FILE__ == $0
+  r = Rule.new("this is a test { background-color: sdfds; color:adlkasdj}")
+  puts r.name
+  puts r.declarations
+end

data/lib/csspress/style_sheet.rb

@@ -0,0 +1,243 @@
+#!/usr/local/bin/ruby -w
+
+# style_sheet.rb
+#
+# Created by David Madden on 2008-05-14.
+# Copyright 2008 David Madden. All rights reserved.
+#
+# This is Free Software.  See LICENSE for details.
+
+# StyleSheet is a container class for Rule objects which can be added
+# individually using the .add() method. The Rule objects that StyleSheet
+# contains can be accessed using the .each_rule(){} method which yields
+# each Rule to the block.
+# 
+# StyleSheet can also accept a CSS file as a paramiter to .new or using the
+# .load() method. This file is then converted into Rule objects and they are
+# added to StyleSheet. A compressed version of StyleSheet can be output using
+# a TemplateBuilder object and passing it StyleSheet as a parameter.
+# 
+# Example:
+#   ss = StyleSheet.new ( "foo.css" )
+#   tb = TemplateBuilder.new ( ss )
+#   puts tb.publish # output compressed version of ss
+# 
+class StyleSheet
+  
+  # rule objects
+  #---
+  # TODO: remove this and only allow access through each_rule.
+  # +++
+  attr_reader :rules
+  
+  # Creates a new StyleSheet object. Can also accept a file name
+  # and parse the contents to initalize the StyleSheet with the file's
+  # contents.
+  # 
+  def initialize(file=nil)
+    @rules = []
+    load file unless file.nil?
+  end
+  
+  # Yeild each style rule in self
+  #
+  def each_rule
+    @rules.each do |rule|
+      yield rule
+    end
+  end
+  
+  # Output a compressed version of self
+  # 
+  #def compress
+  #  out = ""
+  #  self.each_style do |rule|
+  #    out << rule.compress
+  #  end
+  #  out
+  #end
+  
+  # Load a CSS file into self
+  # 
+  def load(file)
+    ssp = StyleSheetParser.new(file)
+    ssp.each { |rule| add(rule) }
+  end
+  
+  # Add a rule to self
+  # 
+  def add(rule)
+    @rules << Rule.new(rule)
+    self
+  end
+  
+  # Output self as String
+  # 
+  def to_s
+    out = ""
+    self.each_rule do |rule|
+      out << "#{rule}\n"
+    end
+    out
+  end
+  
+  # Number of Rules in Self
+  #
+  def size
+    @rules.size
+  end
+  
+  # Alias of size
+  # 
+  def length
+    size
+  end
+  
+  private
+  
+  # This class is responsible for processing a CSS file
+  # and allows iteration over the rules contained within
+  # the file to add to a StyleSheet object.
+  #--
+  # Due to the flexible nature of CSS syntax most of the
+  # work performed by the parser is envolved in normalizing
+  # the text into an array of style rules with the
+  # comments striped out.
+  # 
+  # This parser uses patern matching and string manupulation
+  # rather than analysing the file byte, by byte. This may or
+  # may not be proved to be a good thing.
+  # 
+  # At present all '@import' statements with in the CSS file are
+  # ignored!
+  # 
+  # A file is processed as follows:
+  # 1. The file is read into an array (@raw_data)
+  # 2. White space is removed from the beginnig and end of each field in the @raw_data
+  # 3. Comments are sepatated into there own array fields as they could be mixed into style code
+  # 4. All fields with comments and empty fields are removed from @raw_data
+  # 5. All style rules are put in their own array field
+  # 6. Each field has any white space removed
+  # Data clean!
+  # 
+  # Only the file in gerneral is parsed. Parsing of Rules and Declarations
+  # is handled by them internaly.
+  #++
+  # 
+  class StyleSheetParser #:nodoc:
+    attr_reader :lines
+    
+    # Creates new StyleSheetParser to parse the file 
+    # file_name
+    # 
+    def initialize( file_name )
+      @file = file_name
+      @raw_data = []
+      parse
+    end
+    
+    # Yield each rule in the parsed file
+    # 
+    def each
+      @raw_data.each do |rule|
+        yield rule
+      end
+    end
+    
+    private
+    
+    # Controls the processing of the data by calling
+    # a number of private functions.
+    # 
+    # The order of the method calls is important and
+    # the successful removal of comments depends
+    # upon it!
+    # 
+    def parse
+      get_lines
+      remove_white_space
+      separate_comments
+      delete_comments_and_blank_lines
+      separate_rules
+      remove_white_space
+    end
+    
+    # Read in all lines of @file to @raw_data.
+    # Will raise an error if there is any problem with
+    # accessing the file.
+    # 
+    def get_lines
+      begin
+        f = File.open( @file, 'r' )
+        @raw_data = f.readlines
+      rescue
+        raise IOError, "Could not process file: #{@file}"
+      ensure
+        f.close unless f.nil?
+      end
+    end
+    
+    # This removes white space from the beginning
+    # and end of every field in the @raw_data array,
+    # as well as removing runs of space characters.
+    # 
+    def remove_white_space
+      @raw_data.each do |line|
+        line.strip!           # remove white space from line beginnig and end
+        line.squeeze!( " " )  # remove runs of spaces 
+      end
+    end
+    
+    # Put a linebreak before and after every comment
+    # in @raw_data
+    # 
+    def separate_comments
+      tmp = @raw_data.join(" ")     # convert to string
+      tmp.gsub!( '/*', "\n/*" )     # add new line before comment
+      tmp.gsub!( '*/', "*/\n" )     # add new line after comment
+      @raw_data = tmp.split( "\n" ) # convert to array
+    end
+    
+    # Remove comments and blank lines from @raw_data.
+    # 
+    # This method currently also removes import stetments.
+    # TODO: move import handleing to separate method.
+    # 
+    def delete_comments_and_blank_lines
+      tmp = []
+      @raw_data.each do |line|
+        line.strip!               # remove any white space
+        next if line.length < 1   # ignore blank line
+        next if line =~ /\/\*/    # ignore comments
+        next if line =~ /import/  # ignore imports specially
+        tmp << line
+      end
+      @raw_data = tmp
+    end
+    
+    # Add a new line character after every style rule
+    # in @raw_data
+    # 
+    def separate_rules
+      tmp = @raw_data.join( " " )   # convert to string
+      tmp.gsub!( '}', "}\n" )       # add a new line after every style rule
+      @raw_data = tmp.split( "\n" ) # convert to array
+    end 
+  end
+end
+
+
+if __FILE__ == $0
+  begin
+    ss = StyleSheet.new( "../test_data/style.css" )
+    #ss.load( "../test_data/style.css" )
+    tb = TemplateBuilder.new(ss)
+    puts tb.publish
+  rescue Declaration::PropertyError => e
+    puts e
+  rescue IOError => e
+    puts e
+  rescue Error => e
+    puts e
+  end
+end