sqweeze 0.0.2 → 0.0.4

data/README.rdoc

@@ -9,7 +9,8 @@ With a little help from a number of well known open source third party tools, _S
 * Lossless compresses .PNG, .JPEG and .GIF image assets. 
 * Compresses and concatenates into single files multiple Stylesheets and Javascript files.
 * Embeds the compressed assets referenced into the stylesheet, using using {Data-uris}[https://developer.mozilla.org/En/The_data_URL_scheme] (for proper browsers and IE8) and {MHTML}[http://en.wikipedia.org/wiki/MHTML] (for IE6-7). 
-* Finally, it provides some basic functionality to linking the compressed Javascript and CSS files back to the document. 
+* Finally, it provides some basic functionality for linking the compressed Javascript and CSS just created to the main HTML document, 
+  and removing automatically the links pointing to the old uncompressed ones.  
 
 === Installing it
 
@@ -18,11 +19,22 @@ On an Ubuntu box, you can install these by running a single command line
  
   sudo apt-get install pngcrush gifsicle libjpeg-progs  
 
-(Mac OSX users can install the first two as Macports packages. The third (part of libjpeg) instead, has to be 
-{compiled manually}[http://www.phpied.com/installing-jpegtran-mac-unix-linux]. However, Jpegtrain will not be needed as long as you do not have Jpeg files into your project.)
+Mac OSX users can install the first two as Macports packages. The third (part of libjpeg) instead, has to be 
+{compiled manually}[http://www.phpied.com/installing-jpegtran-mac-unix-linux]. 
 
-Once installed the requirements above, you can install sqweeze, and its ruby dependencies, through ruby gems
+Once installed these, you can install _Sqweeze_ using rubygems
 
  gem install sqweeze
 
-   
+=== Configuration
+
+When run for the first time, the script creates a config file in the user's $HOME directory and sets therein the default paths of command line tools such as pngcrush and friends. 
+ 
+ # file $HOME/.sqweeze.yml
+
+ bin_paths:
+    - pngcrush: /usr/bin/pngcrush
+    - jpegtran: /usr/bin/jpegtran
+    - gifsicle: /usr/bin/gifsicle
+ 
+If you have installed these anywhere else than in /usr/bin+, you will have to edit this file so that sqweeze can find them.    

data/bin/sqweeze

@@ -2,7 +2,7 @@
 # rubygems
 %w[rubygems yui/compressor closure-compiler hpricot].each{|lib| require lib}
 # ruby standard library
-%w[logger singleton yaml base64 open-uri pathname optparse].each{|lib| require lib}
+%w[logger singleton yaml base64 open-uri pathname optparse fileutils].each{|lib| require lib}
 
 # add lib sub-directories to load path
 SQWEEZE_DIR=File.expand_path( File.dirname(File.dirname(__FILE__)))
@@ -77,6 +77,16 @@ op=OptionParser.new do |opts|
     options[:default_js_compressor] = j.downcase.to_sym
   end
 
+  opts.separator ""
+  opts.separator "Console output:"
+  
+  opts.on('-q',"--quite", "suppress console output ") do |q|  
+      options[:suppress_warn] = true
+      options[:suppress_info] = true
+  end
+  opts.on('-d',"--debug", "show debug information") do |q|  
+      options[:suppress_debug] = false
+  end
 end
 
 begin 
@@ -86,7 +96,6 @@ begin
              exit(1) }.call unless File.exists?(ARGV[0])
   
 
-  $log=Logger.new( STDERR )
   cm=ConfManager.instance
   cm.prepare(ARGV[0], ARGV[1], options)
    

data/lib/compilers/cssDomCompiler.rb

@@ -1,8 +1,9 @@
+# Turn link to extenrnal stylesheets into inline style elements..
+
 class CssDomCompiler < DOMCompiler
-  
   def compile
     iterate_over('link[@rel="stylesheet"]') do |elm, doc|
-      next unless elm.has_attribute?('href') and not elm.get_attribute('href').nil?
+      next unless elm.has_attribute?('href') and not elm.get_attribute('href').empty?
       
       fbody=get_resource(elm.get_attribute('href'))
       
@@ -11,7 +12,6 @@ class CssDomCompiler < DOMCompiler
       
       style_html = "<style type=\"text/css\">\n" + css_cdata(fbody,:compress) + '</style>'
       doc.search('head').append(style_html)
- 
     end
   end
 

data/lib/compressor.rb

@@ -82,7 +82,7 @@ class Compressor
                  gsub('%input%',inputpath).
                  gsub('%output%', output_path)
      system(cl)
-     $log.debug("run command #{cl}, pid=#{$?.pid} exitstatus=#{$?.exitstatus}")  
+     notify("run command #{cl}, pid=#{$?.pid} exitstatus=#{$?.exitstatus}", :debug)  
      output_path
   end
 
@@ -101,7 +101,10 @@ class Compressor
     files.each do |path|
       output_path=process(path,cmd)
       size_check(path,output_path) unless %w(.css .js).include?( File.extname(output_path))   
-    end  
+    end
+    
+    # summarise compression stats
+    print_summary  unless ['.css','.js' ].include?(@input_file_extensions)
   end
   
   # Makes sure that the byteweight of a compressed file is not larger that the original one.  
@@ -110,10 +113,10 @@ class Compressor
     before_size, after_size = byteweight(input_path), byteweight(output_path)
       # if the compressed file is bigger than the original one, copy the original in the target dir
     if after_size < before_size 
-          $log.info("compressed #{input_path} to the #{ compression_percentage(before_size,after_size)}% of its original size  (from: #{before_size} to #{after_size} bytes ) ")
+          notify("compressed #{input_path} to the #{ compression_percentage(before_size,after_size)}% of its original size  (from: #{before_size} to #{after_size} bytes ) ", :debug)
           @byteweight_after+=after_size
       else
-          $log.debug("Oppss!!! output(#{after_size}) >= input(#{before_size}), using the original file #{input_path} ")  
+          notify("output(#{after_size}) >= input(#{before_size}), keeping the original file #{input_path}",:debug)  
           FileUtils.cp(input_path,output_path)
           @byteweight_after+=before_size
       end
@@ -124,5 +127,11 @@ class Compressor
   def concatenate_files
     @input_files.collect{|f|File.open(f,'r').read}.join("\n")
   end
+  
+  def print_summary    
+       notify("Compressed #{ansi_bold(@input_files.size)} #{@input_file_extensions.first.upcase} files".ljust(60) +
+             "#{ansi_green(compression_percentage(@byteweight_before,@byteweight_after)+'%')} (was #{ansi_bold(@byteweight_before)}, is #{ansi_bold(@byteweight_after)} bytes now) \n", 
+             :info) unless @byteweight_before == 0
+  end
 
-end
+end

data/lib/compressors/cssCompressor.rb

@@ -40,6 +40,9 @@ class CssCompressor < Compressor
     
     unless compressed_output.chomp.empty?
      write_file(compressed_output,"#{@cm.target_dir}/stylesheets.min.css") 
+     
+     # set the total byte-weight 
+     @byteweight_after=byteweight(compressed_output) 
      embed_datauris( compressed_output )     
      embed_mhtml( compressed_output ) if @cm.get_conf(:mhtml_root) 
     end

data/lib/compressors/jsCompressor.rb

@@ -7,18 +7,20 @@ class JsCompressor < Compressor
 
 
   def process(input_str,cmd=nil)
-   unless @cm.get_conf(:default_js_compressor) == :closure
-        compressor, method = YUI::JavaScriptCompressor.new( :munge => true), :compress
-   else
+   if @cm.get_conf(:default_js_compressor) == :closure
         compressor, method = Closure::Compiler.new, :compiler
+   else
+        compressor, method = YUI::JavaScriptCompressor.new( :munge => true), :compress
    end
-
    fout= (@concatenate_input)? "#{@cm.target_dir}/javascripts.min.js" : @cm.get_target_path(inputpath)
+   
 
    File.open(fout,'w') do |f|
       f.write(compressor.send( method, input_str))
    end
-    
+
+   # set the total byte-weight 
+   @byteweight_after=byteweight(fout) 
    fout
   end
  

data/lib/confManager.rb

@@ -1,7 +1,8 @@
 # Main component for handling Sqweeze's file and command-line configuration parameters
 
 
-class ConfManager  
+class ConfManager 
+  include SqweezeUtils
   include Singleton
   # Class constructor.  
   # 
@@ -17,6 +18,10 @@ class ConfManager
     @files=[]
     
     @conf={
+      :suppress_info => false,
+      :suppress_debug => true,
+      :suppress_warn => false,
+      :suppress_error => false,
       :bin_paths => {},
       :dom_documents => [],
       :include_files => [],
@@ -62,7 +67,8 @@ class ConfManager
     else 
       target 
     end
-        
+    copy_source
+
     write_globalconf
     # Parses the global configuration file in $HOME.
     parse_conf
@@ -76,7 +82,7 @@ class ConfManager
     # Creates the list of the files in the project directory.
     
     list_files
-    copy_source
+
   end
  
   # Copies the source into the target directory.
@@ -123,7 +129,7 @@ class ConfManager
   # Parses configuration files and sets user-defined file inclusion/exlusion patterns.
   
   def parse_conf(configfile="#{ENV['HOME']}/#{@conf_filename}")
-    $log.debug("Parsing configuration file: #{configfile}") 
+    notify("Parsing configuration file: #{configfile}",:debug) 
     conf=YAML::load_file( configfile ) 
      
     bin_paths={}
@@ -150,7 +156,8 @@ class ConfManager
     
     # others..
     %w(include exclude).each {|k| set_conf(k, conf[k].to_a)}
-    %w(optimisation_strategy append_scripts_to).each{|k| set_conf(k,conf[k]) if conf[k]}
+    %w(optimisation_strategy append_scripts_to 
+      suppress_messagess suppress_debug suppress_warnings).each{|k| set_conf(k,conf[k]) if conf[k]}
   end
  
   # Explodes the inclusion/exclusion patterns provided by the user into a list, and populates the @files attribute.   
@@ -170,12 +177,11 @@ class ConfManager
     exclude_files=get_files(get_conf(:exclude))
     
     
-    $log.debug("Excluding #{exclude_files.size} file/s from user list")
+    notify("Excluding #{exclude_files.size} file/s from user list", :debug)
     @files -= exclude_files
-    $log.info("#{@files.size} file/s found")
+    notify("#{@files.size} file/s found", :info)
   end
 
-
   # Get all the files matching an array of patterns 
   #
   # (Any file expansion patterns accepted ruby's Dir[] method can be used).

data/lib/domCompiler.rb

@@ -29,7 +29,7 @@ class DOMCompiler
       write_file(doc.innerHTML, path )
     end
       else
-      $log.error("DOMCompiler cannot parse #{path}")  
+      notify("DOMCompiler cannot parse #{path}",:error)  
     end
    end
   end

data/lib/sqweezeUtils.rb

@@ -12,6 +12,7 @@ module SqweezeUtils
       '.otf' => 'font/opentype'
   } 
   
+
   def write_file(fbody,fpath)
     File.open(fpath,'w') do |f|
       f.write(fbody)
@@ -75,12 +76,50 @@ module SqweezeUtils
   # TODO: rewrite this! (it sucks..)
 
   def find_file_in_targetdir(endpath)
-    pattern=  [@cm.target_dir,"**/*#{File.extname(endpath)}"].join('/')
+    pattern=  [get_confManager.target_dir,"**/*#{File.extname(endpath)}"].join('/')
     #puts "searcing for files in #{pattern} ending with #{endpath}"
     Dir[pattern].find{|path| path =~ Regexp.new("#{endpath}$")}
   end
   
-  
-  
-  
-end
+
+  # Prints to STDERR and adds a log entry. 
+  # 
+  # Log entries can be of four types:
+  #
+  # * info
+  # * warning
+  # * error
+  # * debug
+  #
+
+  def notify( message, log_level=:info)
+     raise "Log level #{log_level} does not exist!" unless [:info,:warn,:error,:debug].include?(log_level.to_sym)
+     cm=get_confManager
+   
+     $log=Logger.new( "#{cm.target_dir}/sqweeze.log"  ) unless $log 
+     $log.send(log_level, ansi_nocolour(message)) 
+  
+     puts message unless cm.get_conf( "suppress_#{log_level}".to_sym)
+  end  
+
+  def ansi_bold(bold) 
+    "\033[1m#{bold}\033[0m"
+  end
+  def ansi_red(red)
+    "\033[31m#{red}\033[0m"
+  end
+  def ansi_green(green) 
+    "\033[32m#{green}\033[0m"
+  end
+  def ansi_yellow(yellow)
+    "\033[33m#{yellow}\033[0m" 
+  end
+  def ansi_nocolour(text)
+    text.gsub(/\033\[[0-9]{1,2}/,'')
+  end
+
+  private
+  def get_confManager
+     (@cm) ? @cm : self
+  end
+end

data/sqweeze.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sqweeze}
-  s.version = "0.0.2"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrea Fiore"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Andrea Fiore