sqweeze 0.0.8 → 0.0.9

data/README.rdoc

@@ -6,31 +6,30 @@ A command line web asset optimisation tool.
 _Sqweeze_ cuts the unnecessary bytes out of your web assets, helping you delivering your web project more fast and efficiently. 
 With a little help from a number of well known open source third party tools, _Sqweeze_ does the following:
 
-* 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 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.  
+1. Lossless compresses .PNG, .JPEG and .GIF image assets. 
+2. Compresses and concatenates into single files multiple Stylesheets and Javascript files.
+3. Embeds the compressed image assets into the stylesheet, 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 and IE7). 
+4. 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
 
 Sqweeze relies on a few command-line image compression tools, namely Pngcrush, Jpegtrain, and Gifsicle, which have to be installed first. 
-On an Ubuntu box, you can install these by running a single command line
+On an Ubuntu box, you can install these all in once by running a single command line
  
-  sudo apt-get install pngcrush gifsicle libjpeg-progs  
-
-(This assumes you have ruby, ruby1.8-dev, and gem installed).
+ 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]. 
 
-Once installed these, you can install _Sqweeze_ using rubygems
+Once installed these third party tools, you can install _Sqweeze_ using the rubygems package manager 
+
+ sudo gem install sqweeze
 
- gem install sqweeze
+(this assumes that you have both ruby and rugygems installed). 
 
 === 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. 
+When run for the first time, the script creates a configuration file in the user's $HOME directory, and sets therein the default file paths of Pngcrush and friends. 
  
  # file $HOME/.sqweeze.yml
 
@@ -39,4 +38,46 @@ When run for the first time, the script creates a config file in the user's $HOM
     - 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.    
+If you have installed those anywhere else than in <code>/usr/bin</code>, you will have to edit this file with your own paths, so that sqweeze can find them.  
+
+=== Usage 
+
+
+ sqweeze input_dir [target_dir]
+
+When invoked with no options, sqweeze will simply copy the content of a source directory, compress its image assets, and finally generate three new files in the target directory:
+
+[javascripts.min.js]
+   A file concatenating and compressing together all the other javascript files in the source directory
+[stylesheets.min.js] 
+   A file concatenating and compressing together all the other Stylesheets in the source directory
+[stylesheets.min.datauri.js] 
+   Same as stylesheets.min.js, but embedding the image referenced in the stylesheets through the data URI scheme.
+
+==== MHTML Support
+
+Whilst the generated <code>stylesheets.all.datauri.css</code> will work fine in most recent web-browsers (i.e Chrome, Safari, Firefox, IE 8), it will fail displaying images in Internet Explorer 6 and 7. A viable way around to this limitation, however, is that of using
+Microsoft's MIME HTML. In order to have sqweeze generate also a MHTML stylesheet suitable to be read by IE6 and IE7, one has to specify the parameter <code>--MHTML-ROOT</code>; that is the URL of the directory where the stylesheet will be deployed. 
+
+ sqweeze --mhtml-root=http://example.com/css example-sourcedir
+
+At this point, both the Data URI and the MHTML stylesheet can be linked to the main index.html and loaded selectively through {Internet Explorer's Conditional Comments}[http://en.wikipedia.org/wiki/Conditional_comment]
+
+    <!--[if (!IE)|(gte IE 8)]><!-->
+         <link href="css/stylesheets.min.datauri.css" media="screen" rel="stylesheet" type="text/css" />
+    <!--<![endif]-->
+    <!--[if lte IE 7]>
+         <link href="css/stylesheets.min.mhtml.css" media="screen" rel="stylesheet" type="text/css" />
+   <![endif]-->
+
+This latter step can be automated by supplying the <code>-D</code> (DOM-Documents) parameter to the script. In this case, Sqweeze will simply delete from the DOM all the pre-existing <code>SCRIPT</code> and <code>LINK</code> elements having a src (or a href)  attribute, and append the generated ones to the document's <code>HEAD</code>. However, this functionality is rather crude at the moment, and most certainly will require some manual tweaking on the user side. 
+
+
+==== Inline asset optimisation (experimental)
+
+Although the optimisation strategy described above is probably effective in most of the cases, in some cases it can be useful to reduce the amount of HTTP requests by placing compressed assets inline, directly within the HTML file, rather than in external stylesheets. Sqweeze provides functionality for compiling assets inline into the DOM document This is still experimental at the moment, and does not yet support base64 image embedding. 
+
+  sqweeze -S all_inline -D source_dir/index.html source_dir
+
+[....]
+

data/bin/sqweeze

@@ -38,7 +38,7 @@ op=OptionParser.new do |opts|
   opts.on('-e','--exclude-files=PATTERN', "Exclude a file/directory pattern (e.g. doc/**/*.* )") do |exc|
     options[:exclude_files] = exc
   end
-  opts.on('-d','--dom-documents=PATTERN', "Dom document/s to which CSS/JS  should be linked (e.g. **/index.html )") do |dom|
+  opts.on('-D','--dom-documents=PATTERN', "Dom document/s to which CSS/JS  should be linked (e.g. **/index.html )") do |dom|
     options[:dom_documents] = dom
   end  
 
@@ -119,6 +119,7 @@ begin
       }.each do |opt, cmp|
          cmp.compress unless cm.get_conf(opt) == false
       end
+
       # link assets to main HTML file
       AssetLinker.new.compile unless cm.get_conf(:dom_documents).empty?
   end

data/lib/compilers/assetLinker.rb

@@ -1,6 +1,8 @@
 class AssetLinker < DOMCompiler
   
   def compile
+
+
     iterate_over("link[@rel='stylesheet'], script[@src]") do |elm,doc|
       # Skip if the script has an absolute link
       next if elm.get_attribute('src') =~ /^http:\/\// 

data/lib/confManager.rb

@@ -15,8 +15,7 @@ class ConfManager
     @conf_filename='.sqweeze.yml'
     @source_dir=nil
     @target_dir=nil
-    @files=[]
-    
+    @files=[]    
     @conf={
       :suppress_info => false,
       :suppress_debug => true,
@@ -62,6 +61,8 @@ class ConfManager
   def prepare(source,target=nil,override_conf={})
     
     @source_dir=source
+    raise 'Cannot sqweeze current directory' if source == '.'
+
     @target_dir=unless target
       "#{File.basename(source)}_sqweezed"            
     else 

data/sqweeze.gemspec

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sqweeze
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Andrea Fiore