bagger 0.4.0 → 0.5.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+# v 0.5.0
+  
+  * gzip support for stylesheets and javascripts (Christian Lundgren)
+  * Extended manifest with info file size (Christian Lundgren)
+  * verbose option
+
 # v 0.4.0
 
   * Support for css_path_prefix allows rewritten urls in stylesheets to

data/README.md

@@ -56,14 +56,16 @@ on the client side by using the following techniques:
 	
 	# define the options hash
 	options = {
-		:source_dir => target_dir,
-		:target_dir => source_dir,
+		:source_dir => source_dir,
+		:target_dir => target_dir,
 		:manifest_path => manifest_path,
+    :gzip => false,
+    :verbose => false,
 		:cache_manifest_path => cache_manifest_path,
-    :path_prefix => '',
-    :css_path_prefix => '',
-    :exclude_pattern => /.*\.less/,
-    :exclude_files => [ 'css/main.sass', 'css/style.sass' ]
+    		:path_prefix => '',
+    		:css_path_prefix => '',
+    		:exclude_pattern => /.*\.less/,
+    		:exclude_files => [ 'css/main.sass', 'css/style.sass' ]
 		:combine => {
 		 :stylesheets => [
 		    {

data/ROADMAP.md

@@ -1,46 +1,7 @@
 # ROADMAP
 
-## v 0.0.1
-
-* Combines javascript
-* Minfies javascript with [UglifyJS](https://github.com/mishoo/UglifyJS)
-* Combines stylesheets
-* Rewrites urls in stylesheets
-* Minfies stylesheets with [rainpress](https://rubygems.org/gems/rainpress)
-* Generates versioned file names e.g /images/logo.19db9a16e2b73017c575570de577d103.png
-* Generates a manifest file in JSON
-* Generates an HTML 5 cache manifest
-
-## v 0.0.2
-
-* allow to specify the the paths for cache.manifest and manifest.json
-* better validation
-
-## v 0.1.0 
-
-* support for packages. e.g
-
-	:stylesheets => {
-		:common => ['main.css', 'fonts.css'],
-		:dialogs => ['modal.css', 'info_box.css']
-	}
-
-## v 0.2.0
-
-* Support for multiple cache manifests (useful if you have different
-  resources for different devices)
-
 ## v 1.0.0
 
-* generate custom manifest files e.g with support for file size.
-  This can be useful for preloaders
-
-  {
-		'/myfile.txt' => {
-							:path => '/myfile.19db9a16e2b73017c575570de577d103.txt'
-							:size => '391'
-						 }
-	}
 * Support for lesscss as a preprocessor
 * Support for sass as a preprocessor
 * Support for gzipping files

data/lib/bagger/packager.rb

@@ -4,6 +4,7 @@ require 'digest/md5'
 require 'addressable/uri'
 require 'uglifier'
 require 'rainpress'
+require 'zlib'
 
 module Bagger
   class Packager
@@ -12,8 +13,6 @@ module Bagger
       @options = options
       @source_dir = @options[:source_dir]
       @target_dir = @options[:target_dir]
-      @source_dir = @options[:source_dir]
-      @target_dir = @options[:target_dir]
       @manifest_path = @options[:manifest_path] || File.join(@source_dir, 'manifest.json')
       @cache_manifest_path = @options[:cache_manifest_path] || 'cache.manifest'
       @path_prefix = @options[:path_prefix] || ''
@@ -24,10 +23,18 @@ module Bagger
     end
 
     def add_to_manifest(key, path)
-      @manifest[key] = File.expand_path(@path_prefix + "/" + path)
+      if @options[:extended_manifest]
+        @manifest[key] = {
+          :path => File.expand_path(@path_prefix + "/" + path),
+          :size => File.size(File.join(@target_dir, path))
+        }
+      else
+        @manifest[key] = File.expand_path(@path_prefix + "/" + path)
+      end
     end
 
     def to_manifest(path, keep_original = true)
+      debug "adding: #{path}"
       content = File.open(File.join(@target_dir, path)) { |f| f.read }
       extension = File.extname(path)
       basename = File.basename(path, extension)
@@ -51,12 +58,14 @@ module Bagger
     end
 
    def run
+      debug "reading files from #{@source_dir}"
       validate
       version_files
       combine_css
       combine_js
       generate_cache_manifests
       write_manifest
+      debug "files written to #{@target_dir}"
     end
 
     def write_manifest
@@ -85,6 +94,7 @@ module Bagger
         rewrite_urls_in_css(config[:target_path])
         compress_css(config[:target_path])
         to_manifest(config[:target_path], false)
+        gzip_target(config[:target_path]) if @options[:gzip]
       end
     end
 
@@ -125,6 +135,7 @@ module Bagger
         combine_files(config[:files], config[:target_path])
         compress_js(config[:target_path])
         to_manifest(config[:target_path], false)
+        gzip_target(config[:target_path]) if @options[:gzip]
       end
     end
 
@@ -181,6 +192,15 @@ module Bagger
       File.open(target_path, "w") { |f| f.write(output) }
     end
 
+    def gzip_target(target_path)
+      versioned_path = @manifest[File.join('/', target_path)]
+      versioned_path.sub!(@path_prefix, '')
+      gz_path = File.join(@target_dir, "#{versioned_path}.gz")
+      Zlib::GzipWriter.open(gz_path) do |gz|
+        gz << File.open(File.join(@target_dir, versioned_path)) { |f| f.read }
+      end
+    end
+
     def calculate_stylesheets
       if @options[:combine] && @options[:combine][:stylesheets]
         @options[:combine][:stylesheets]
@@ -208,5 +228,9 @@ module Bagger
     def exclude_file?(path)
       path =~ /\.(css|js)$/ || @exclude_files.include?(path) || (@exclude_pattern && path =~ @exclude_pattern)
     end
+
+    def debug(message)
+      STDOUT.puts message if @options[:verbose]
+    end
   end
 end

data/lib/bagger/version.rb

@@ -1,3 +1,3 @@
 module Bagger
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/test/bagger_test.rb

@@ -91,6 +91,15 @@ class BaggerTest < Test::Unit::TestCase
       Bagger.bagit!(default_options.merge(:exclude_pattern => /.*\.txt/))
       assert_nil manifest['/test.txt']
     end
+
+    should 'support file sizes in an extended manifest' do
+      path = File.join(@source_dir, 'test.txt')
+      write_file(path, 'foo')
+      file_size = File.size(path)
+      Bagger.bagit!(default_options.merge(:extended_manifest => true))
+      assert_match /\/test\..*\.txt/, manifest['/test.txt']['path']
+      assert_equal file_size, manifest['/test.txt']['size']
+    end
   end
 
   context 'html 5 cache manifest' do
@@ -219,6 +228,24 @@ class BaggerTest < Test::Unit::TestCase
       assert_equal '//super minified css', compressed_content , 'combined css not found'
     end
 
+    should 'support gzipping css targets' do
+      Rainpress.stubs(:compress).returns('//minified css');
+      Bagger.bagit!(
+        :source_dir => @source_dir,
+        :target_dir => @target_dir,
+        :gzip => true,
+        :combine => @config
+      )
+
+      expected_file_path = File.join(@target_dir, manifest['/css/combined.css'])
+      assert File.exists?(expected_file_path), 'original target does not exist'
+      assert_nil manifest['/css/combined.css.gz'], 'gzipped copy should not be in manifest'
+      expected_file_path << '.gz'
+      assert File.exists?(expected_file_path), 'gzipped copy does not exist'
+      gz_content = Zlib::GzipReader.open(expected_file_path){|gz| gz.read}
+      assert_equal '//minified css', gz_content, 'gzipped copy does not match original'
+    end
+
     context 'url rewriting' do
       setup do
         css = <<-EOF
@@ -389,6 +416,24 @@ class BaggerTest < Test::Unit::TestCase
       expected_file_path = File.join(@target_dir, manifest['/js/combined.js'])
       assert_equal '//minified javascript', File.open(expected_file_path){|f| f.read}
     end
+
+    should 'support gzipping js targets' do
+      Uglifier.expects(:compile).returns('//minified js')
+      Bagger.bagit!(
+        :source_dir => @source_dir,
+        :target_dir => @target_dir,
+        :gzip => true,
+        :combine => @config
+      )
+
+      expected_file_path = File.join(@target_dir, manifest['/js/combined.js'])
+      assert File.exists?(expected_file_path), 'original target does not exist'
+      assert_nil manifest['/js/combined.js.gz'], 'gzipped copy should not be in manifest'
+      expected_file_path << '.gz'
+      assert File.exists?(expected_file_path), 'gzipped copy does not exist'
+      gz_content = Zlib::GzipReader.open(expected_file_path){|gz| gz.read}
+      assert_equal '//minified js', gz_content, 'gzipped copy does not match original'
+    end
   end
 
   context 'packages' do

data/tests.watchr

@@ -25,7 +25,7 @@ def ruby(*paths)
 end
 
 def tests
-  Dir['test/**/test_*.rb'] - ['test/test_helper.rb']
+  Dir['test/**/*_test.rb'] - ['test/test_helper.rb']
 end
 
 def run( cmd )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bagger
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-07 00:00:00.000000000 Z
+date: 2012-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70146760709180 !ruby/object:Gem::Requirement
+  requirement: &70159436784000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70146760709180
+  version_requirements: *70159436784000
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70146760708560 !ruby/object:Gem::Requirement
+  requirement: &70159436783540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70146760708560
+  version_requirements: *70159436783540
 - !ruby/object:Gem::Dependency
   name: uglifier
-  requirement: &70146760708000 !ruby/object:Gem::Requirement
+  requirement: &70159436783080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70146760708000
+  version_requirements: *70159436783080
 - !ruby/object:Gem::Dependency
   name: rainpress
-  requirement: &70146760707480 !ruby/object:Gem::Requirement
+  requirement: &70159436782300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70146760707480
+  version_requirements: *70159436782300
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70146760706920 !ruby/object:Gem::Requirement
+  requirement: &70159436781580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70146760706920
+  version_requirements: *70159436781580
 - !ruby/object:Gem::Dependency
   name: shoulda-context
-  requirement: &70146760706460 !ruby/object:Gem::Requirement
+  requirement: &70159436781140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70146760706460
+  version_requirements: *70159436781140
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70146760706000 !ruby/object:Gem::Requirement
+  requirement: &70159436780460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70146760706000
+  version_requirements: *70159436780460
 description: ! 'A framework agnostic packaging solution for your assets: version files,
   combine them, minify them and create a manifest'
 email: