rapper 0.0.1 → 0.0.2

data/README.markdown

@@ -29,7 +29,7 @@ Rapper is configured using a YAML file that defines the settings to be used in v
       <<: *base
       bundle: false     # optional, default: true
       compress: false   # optional, default: true
-      versions: false   # optional, default: true
+      version: false    # optional, default: true
       log: stdout       # optional, ["stdout", file path], default: off
       log_verbose: true # optional, default: off
     
@@ -37,7 +37,7 @@ Rapper is configured using a YAML file that defines the settings to be used in v
       <<: *base
       bundle: true
       compress: true
-      versions: true
+      version: true
       # optional, passed to Google Closure Compiler
       closure_compiler:
         # default: SIMPLE_OPTIMIZATIONS
@@ -55,7 +55,7 @@ The following defaults are applied if not defined in your configuration:
     bundle: true
     compress: true
     tag_style: html5
-    versions: true
+    version: true
     closure_compiler:
       compilation_level: SIMPLE_OPTIMIZATIONS
 
@@ -123,6 +123,7 @@ Browsers will automatically re-download and cache the new asset.
 
 ## Version history
 
+* **0.0.2** - Compression now works and is specced.
 * **0.0.1** - Initial release. Functioning bundler, minus the view helpers.
 
 ## Contributing to rapper

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/rapper.rb

@@ -55,6 +55,11 @@ module Rapper
           
           log :verbose, "Joining #{definition["assets"].count} files to #{name}"
           join_files( source_files, destination_file )
+          
+          if get_config( "compress" )
+            log :verbose, "Compressing #{name}"
+            compress( destination_file )
+          end
         end
       end
       

data/lib/rapper/compressors.rb

@@ -1,46 +1,105 @@
 require File.expand_path( File.dirname( __FILE__ ) + "/../yui/css_compressor.rb" )
 require "closure-compiler"
+require 'fileutils'
 
 module Rapper
-  # Compression methods for various types of assets.
+  # Compression handlers for various types of assets. And by "various" I mean
+  # JavaScript and CSS.
   module Compressors
     
-    # Use Richard Hulse's port of the YUI CSS Compressor to compress the
-    # contents of a source file to a destination file.
+    # Compress a file in-place. Relies on the file's suffix to determine type.
     # 
-    # @param [String] source Path to source CSS file.
-    # 
-    # @param [String] destination Path to destination CSS file.
-    #   written to.
-    def compress_css( source, destination )
-      log :verbose, "Compressing #{source}"
-      
-      source = readable_file( source )
-      destination = writable_file( source )
-      
-      destination.write( YUI::CSS.compress( source.read ) )
-      destination.write "\n"
-      
-      source.close && destination.close
+    # @param [String] file Path to the file to compress.
+    def compress( file )
+      opts = {}
+      # TODO: Someday this goes away.
+      opts = get_config( "closure_compiler" ) if file =~ /\.js/
+      Rapper::Compressors::Compressor.compress( file, opts )
     end
     
-    # Use Google's Closure Compiler to compress the JavaScript from a source
-    # file to a destination file.
-    # 
-    # @param [String] source Path to source JavaScript file.
-    # 
-    # @param [String] destination Path to destination JavaScript file.
-    def compress_js( source, destination, opts={} )
-      log :verbose, "Compressing #{source}"
-      
-      source = readable_file( source )
-      destination = writable_file( source )
-      closure = Closure::Compiler.new( opts )
+    protected
+    
+    # Base class for a compression handler.
+    class Compressor
+      class << self
+        
+        # Get the compressor for a given file.
+        # 
+        # @param [String] file Path to the file to fetch the Compressor for
+        # @return [Types] Description
+        def compress( file_path, opts={} )
+          unless compressor = @extensions[File.extname( file_path )]
+            raise Rapper::Errors::UnknownFileExtension,
+              "Rapper doesn't know how to compress #{file_path}"
+          end
+          
+          compressor.do_compress( file_path, opts )
+        end
+        
+        protected
+        
+        attr_accessor :extensions
+        
+        # Register `self` as a file compressor.
+        # 
+        # @param [String] extension The file extension `self` handles.
+        def register( extension )
+          superclass.extensions ||= {}
+          superclass.extensions[extension] = self
+        end
+        
+        # Compress a file.
+        def do_compress( file_path )
+          raise NotImplementedError
+        end
+        
+        # @param [String] path Path to a file.
+        # 
+        # @return [String] The contents of the file.
+        def read_file( path )
+          File.new( path, 'r' ).read
+        end
+        
+        # @param [String] path Path to the desired file.
+        # 
+        # @return [File] Writable file instance with 0644 permissions.
+        def writable_file( path )
+          File.new( path, 'w', 0644 )
+        end
+      end
+    end
+    
+    # Use Richard Hulse's Ruby port of the YUI CSS Compressor to compress the
+    # contents of a CSS file.
+    class CSSCompressor < Compressor
+      register ".css"
       
-      destination.write( closure.compile( destination ) )
-      destination.write "\n"
+      def self.do_compress( file_path, opts={} )
+        css = read_file( file_path )
+        css = YUI::CSS.compress( css )
+        destination = writable_file( file_path )
+        
+        destination.write( css )
+        destination.write "\n"
+        destination.close
+      end
+    end
+    
+    # Uses Google's Closure Compiler (via DocumentCloud's closure-compiler gem)
+    # to compress JavaScrpt.
+    class JSCompressor < Compressor
+      register ".js"
       
-      source.close && destination.close
+      def self.do_compress( file_path, opts={} )
+        closure = Closure::Compiler.new( opts )
+        
+        js = read_file( file_path )
+        destination = writable_file( file_path )
+        
+        destination.write( closure.compile( js ) )
+        destination.write "\n"
+        destination.close
+      end
     end
     
   end

data/lib/rapper/config.rb

@@ -45,7 +45,7 @@ module Rapper
       if default_config[key].is_a?( Hash )
         default_config[key].merge( env_config[key] || {} )
       else
-        env_config[key] || default_config[key]
+        env_config.key?( key ) ? env_config[key] : default_config[key]
       end
     end
     
@@ -74,7 +74,7 @@ module Rapper
         "bundle" => true,
         "compress" => true,
         "tag_style" => "html5",
-        "versions" => true,
+        "version" => true,
         "closure_compiler" => {
           "compilation_level" => "SIMPLE_OPTIMIZATIONS"
         }

data/lib/rapper/errors.rb

@@ -19,5 +19,8 @@ module Rapper
     # is one not defined in a given definition file.
     class InvalidAssetName < StandardError; end
     
+    # Raised when attempting to compress a file with an extension that Rapper
+    # doesn't recognize.
+    class UnknownFileExtension < StandardError; end
   end
 end

data/lib/rapper/utils.rb

@@ -12,7 +12,7 @@ module Rapper
     # 
     # @return [String] Path to the definition file for the given asset type.
     def definition_path( type )
-      File.join( env_config["definition_root"], "#{type}.yml")
+      File.join( get_config( "definition_root" ), "#{type}.yml")
     end
     
     # @param [String] type Asset type.
@@ -64,20 +64,6 @@ module Rapper
     # = Files =
     # =========
     
-    # @param [String] path Path to the desired file.
-    # 
-    # @return [File] Readable File instance.
-    def readable_file( path )
-      File.new( path, 'r' )
-    end
-    
-    # @param [String] path Path to the desired file.
-    # 
-    # @return [File] Writable file instance with 0644 permissions.
-    def writable_file( path )
-      File.new( path, 'w', 0644 )
-    end
-    
     # Contatenate one or more files. Uses <code>cat</code>.
     # 
     # @param [Array<String>,String] source_files A  path or array of paths to

data/rapper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rapper}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tyson Tate"]
-  s.date = %q{2011-02-04}
+  s.date = %q{2011-02-05}
   s.description = %q{Static asset packager and compressor with versioning and built-in view helpers. Easy to configure, easy to use, and easy to ignore when you want to. No crazy JavaScript comment DSLs, either.}
   s.email = %q{tyson@tysontate.com}
   s.extra_rdoc_files = [
@@ -42,6 +42,13 @@ Gem::Specification.new do |s|
     "spec/fixtures/javascripts/simple_2.js",
     "spec/fixtures/stylesheets/simple_1.css",
     "spec/fixtures/stylesheets/simple_2.css",
+    "spec/fixtures/test_cases/compression/assets.yml",
+    "spec/fixtures/test_cases/compression/definitions/css.yml",
+    "spec/fixtures/test_cases/compression/definitions/js.yml",
+    "spec/fixtures/test_cases/compression/expected/base.css",
+    "spec/fixtures/test_cases/compression/expected/base.js",
+    "spec/fixtures/test_cases/compression/expected/base_reversed.css",
+    "spec/fixtures/test_cases/compression/expected/base_reversed.js",
     "spec/fixtures/test_cases/concatenation/assets.yml",
     "spec/fixtures/test_cases/concatenation/definitions/css.yml",
     "spec/fixtures/test_cases/concatenation/definitions/js.yml",

data/spec/fixtures/config/assets.yml

@@ -5,7 +5,7 @@ test:
   bundle: true
   compress: true
   tag_style: html
-  versions: false
+  version: false
   closure_compiler:
     compilation_level: ADVANCED_OPTIMIZATIONS
     formatting: pretty_print

data/spec/fixtures/javascripts/simple_1.js

@@ -1,5 +1,5 @@
 var x = 1;
 var y = 2;
-function() {
+function a() {
   return true;
 }

data/spec/fixtures/javascripts/simple_2.js

@@ -1,5 +1,5 @@
 a = 1;
 b = 2;
-function() {
+function b() {
   return false;
 }

data/spec/fixtures/test_cases/compression/assets.yml

@@ -0,0 +1,5 @@
+test:
+  definition_root: spec/fixtures/test_cases/concatenation/definitions
+  bundle: true
+  compress: true
+  version: false

data/spec/fixtures/test_cases/compression/definitions/css.yml

@@ -0,0 +1,15 @@
+--- !omap 
+- source_root: spec/fixtures/stylesheets
+- destination_root: tmp
+- suffix: css
+- assets: 
+  - base: 
+    - files: 
+      - simple_1
+      - simple_2
+    - version: 683e
+  - base_reversed: 
+    - files: 
+      - simple_2
+      - simple_1
+    - version: 4a04

data/spec/fixtures/test_cases/compression/definitions/js.yml

@@ -0,0 +1,15 @@
+--- !omap 
+- source_root: spec/fixtures/javascripts
+- destination_root: tmp
+- suffix: js
+- assets: 
+  - base: 
+    - files: 
+      - simple_1
+      - simple_2
+    - version: 7b06
+  - base_reversed: 
+    - files: 
+      - simple_2
+      - simple_1
+    - version: db62

data/spec/fixtures/test_cases/compression/expected/base.css

@@ -0,0 +1 @@
+body{margin:0;color:#333}*{margin:0;color:#fff}

data/spec/fixtures/test_cases/compression/expected/base.js

@@ -0,0 +1,2 @@
+var x=1,y=2;function a(){return true}a=1;b=2;function b(){return false};
+

data/spec/fixtures/test_cases/compression/expected/base_reversed.css

@@ -0,0 +1 @@
+*{margin:0;color:#fff}body{margin:0;color:#333}

data/spec/fixtures/test_cases/compression/expected/base_reversed.js

@@ -0,0 +1,2 @@
+a=1;b=2;function b(){return false}var x=1,y=2;function a(){return true};
+

data/spec/fixtures/test_cases/concatenation/assets.yml

@@ -2,4 +2,4 @@ test:
   definition_root: spec/fixtures/test_cases/concatenation/definitions
   bundle: true
   compress: false
-  versions: false
+  version: false

data/spec/fixtures/test_cases/concatenation/definitions/js.yml

@@ -7,9 +7,9 @@
     - files: 
       - simple_1
       - simple_2
-    - version: 7b06
+    - version: f3d9
   - base_reversed: 
     - files: 
       - simple_2
       - simple_1
-    - version: db62
+    - version: fcfe

data/spec/fixtures/test_cases/concatenation/expected/base.js

@@ -1,10 +1,10 @@
 var x = 1;
 var y = 2;
-function() {
+function a() {
   return true;
 }
 a = 1;
 b = 2;
-function() {
+function b() {
   return false;
 }

data/spec/fixtures/test_cases/concatenation/expected/base_reversed.js

@@ -1,10 +1,10 @@
 a = 1;
 b = 2;
-function() {
+function b() {
   return false;
 }
 var x = 1;
 var y = 2;
-function() {
+function a() {
   return true;
 }

data/spec/rapper_spec.rb

@@ -40,7 +40,7 @@ describe Rapper do
       # private
       rapper.send( :get_config, "bundle" ).should be_true
       rapper.send( :get_config, "compress" ).should be_true
-      rapper.send( :get_config, "versions" ).should be_true
+      rapper.send( :get_config, "version" ).should be_true
       rapper.send( :get_config, "closure_compiler" ).should == {
         "compilation_level" => "SIMPLE_OPTIMIZATIONS"
       }
@@ -111,7 +111,6 @@ describe Rapper do
         
         results.each_index do |i|
           unless File.read( results[i] ) == File.read( expecteds[i] )
-            # p File.read( results[i] )
             raise "#{results[i]} did not match #{expecteds[i]}"
           end
         end
@@ -123,10 +122,6 @@ describe Rapper do
     it "raises an error if a file doesn't exist"
   end
   
-  describe "compressing" do
-    it "can be turned off"
-  end
-  
   describe "view helpers" do
     it "returns tags for component files when bundling is off"
     it "returns tabs for asset when bundling is on"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rapper
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Tyson Tate
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-04 00:00:00 -08:00
+date: 2011-02-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -245,6 +245,13 @@ files:
 - spec/fixtures/javascripts/simple_2.js
 - spec/fixtures/stylesheets/simple_1.css
 - spec/fixtures/stylesheets/simple_2.css
+- spec/fixtures/test_cases/compression/assets.yml
+- spec/fixtures/test_cases/compression/definitions/css.yml
+- spec/fixtures/test_cases/compression/definitions/js.yml
+- spec/fixtures/test_cases/compression/expected/base.css
+- spec/fixtures/test_cases/compression/expected/base.js
+- spec/fixtures/test_cases/compression/expected/base_reversed.css
+- spec/fixtures/test_cases/compression/expected/base_reversed.js
 - spec/fixtures/test_cases/concatenation/assets.yml
 - spec/fixtures/test_cases/concatenation/definitions/css.yml
 - spec/fixtures/test_cases/concatenation/definitions/js.yml