bagger 0.0.1 → 0.0.2

data/.travis.yml

@@ -3,4 +3,5 @@ rvm:
   - 1.9.3
   - 1.8.7
   - ree
-  - rbx-head
+  - rbx-2.0
+  - jruby

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# CHANGELOG
+
+## v 0.0.2
+
+* Make file and cache manifest path configurable
+* Validate that the source directory actually exists
+
+## 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
+
+### Known issues
+
+* Paths for manifest and html 5 cache manifest are hardcoded to TARGET_DIR/manifest.json and TARGET_DIR/cache.manifest

data/README.md

@@ -1,37 +1,101 @@
 # bagger
 
-A framework agnostic packaging solution to speed up client side
-rendering by using the following techniques:
+A framework agnostic packaging solution to speed up loading times 
+on the client side by using the following techniques:
 
-* Generating versioned assets to maximize cache efficiency
-* Combine, minify and lint javascript and css files to reduce bandwidth
-* Zip assets to further reduce bandwidth consumption
-* Generating a file manifest to lookup an asset's location
+* Generate versioned assets to maximize cache efficiency
+* Combine and minify javascript and css files to reduce bandwidth
+* Generate a file manifest to lookup an asset's location
+* Generate an HTML 5 cache manifest
 * Rewrite urls in css files with the versioned file name
-* Bundle up the assets as a zip file
 
-## Similar projects
+## Features already implemented in version 0.0.1
 
-* [jammit](https://github.com/documentcloud/jammit)
-* [Rails 3 asset pipeline](http://blog.nodeta.com/2011/06/14/rails-3-1-asset-pipeline-in-the-real-world/)
-* [assets.io](http://www.assets.io/)
+* 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
+
+## Installation
+
+    gem install bagger
+
+## Usage
+	require 'bagger'
+	require 'fileutils'
+	
+	# define source and target directories
+	target_dir = "/tmp/bundled_assets"
+	source_dir = "/applications/my_app/public"
+  
+  # customize paths for file and cache manifest
+  manifest_path = File.join(target_dir, 'file_manifest.json') #defaults
+to manifest.json
+
+  cache_manifest_path = 'cache/cache.manifest' # defaults to
+cache.manifest
+	
+	# list the stylesheets and javascripts to be combined
+	# and minified. The order is important, because otherwhise
+	# the behavior of the stylesheets and javascripts might change
+	stylesheets = ["css/style.css", "css/reset.css"]
+	javascripts = ["js/app.js", "js/utils.js"]
+	
+	# make sure the target directory exists
+	FileUtils.mkdir_p target_dir
+	
+	# define the options hash
+	options = {
+	  :source_dir => target_dir,
+	  :target_dir => source_dir,
+    :manifest_path => manifest_path,
+    :cache_manifest_path => cache_manifest_path,
+	  :combine => {
+	    :stylesheets => stylesheets,
+	    :stylesheet_path => 'css/all.css',
+	    :javascripts => javascripts,
+	    :javascript_path => 'js/combined.js'
+	  }
+	}
+	
+	# run it
+	Bagger::bagit!(options)
+	
+	# TODO: at this point, the paths for the manifest and html 5 cache manifest
+	# are hardcoded.
+	manifest_path = File.join(target_dir, 'manifest.json')
+	cache_manifest_path = File.join(target_dir, 'cache.json')
+	
+## Manifest layout
 
-## Roadmap
+    {
+	  "/css/all.css" : "/css/all.19db9a16e2b73017c575570de577d103.css",
+	  "/js/combined.js" : "/js/combined.19db9a16e2b73017c575570de577d103.js",
+	  "/images/logo.png" : "/images/logo.19db9a16e2b73017c575570de577d103.png" 
+	}
+	
+## HTML 5 cache manifest
 
-### Version 0.0.1 (Minimal Viable Product)
+	CACHE MANIFEST
 
-* Versioned assets
-* Manifest files
-* Combine javascript
-* Combine css
-* Rewrite css urls
-* CLI binary
-* Solid test suite
-* Support for the following Ruby versions (MRI 1.8.7, 1.9.2, REE 1.8.7)
-* Pass all tests on travisci.org
-* Examples on how to integrate it into the development workflow using
-  tools like watch or supervisor
+	# Explicitely cached entries
+	/css/all.19db9a16e2b73017c575570de577d103.css
+	/js/combined.19db9a16e2b73017c575570de577d103.js
+	/images/logo.19db9a16e2b73017c575570de577d103.png
+
+	NETWORK:
+	*
 
 ## Tests
 
 check the build status on [travis.ci](http://travis-ci.org/wooga/bagger)
+
+## Similar projects
+
+* [jammit](https://github.com/documentcloud/jammit)
+* [Rails 3 asset pipeline](http://blog.nodeta.com/2011/06/14/rails-3-1-asset-pipeline-in-the-real-world/)
+* [assets.io](http://www.assets.io/)

data/ROADMAP.md

@@ -0,0 +1,35 @@
+# 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 
+
+* generate custom manifest files e.g with support for file size
+
+    {
+		'/myfile.txt' => {
+							:path => '/myfile.19db9a16e2b73017c575570de577d103.txt'
+							:size => '391'
+						 }
+	}
+
+* support for packages. e.g
+
+	:stylesheets => {
+		:common => ['main.css', 'fonts.css'],
+		:dialogs => ['modal.css', 'info_box.css']
+	}

data/lib/bagger/packager.rb

@@ -10,11 +10,12 @@ module Bagger
 
     def initialize(options)
       @options = options
-      @manifest_name = 'manifest.json'
       @stylesheets = (@options[:combine] || {})[:stylesheets] || []
       @javascripts = (@options[:combine] || {})[:javascripts] || []
       @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'
       @stylesheet_path = (@options[:combine] || {})[:stylesheet_path] || 'combined.css'
       @javascript_path = (@options[:combine] || {})[:javascript_path] || 'combined.js'
       @path_prefix = @options[:path_prefix] || ''
@@ -37,11 +38,8 @@ module Bagger
       @manifest[manifest_key_path] = effective_path
     end
 
-    def manifest_path
-      File.join(@options[:source_dir], @manifest_name)
-    end
-
     def run
+      validate
       combine_css
       combine_js
       version_files
@@ -55,7 +53,7 @@ module Bagger
     end
 
     def write_manifest
-      File.open(manifest_path, 'w') do |f|
+      File.open(@manifest_path, 'w') do |f|
         f.write JSON.pretty_generate(@manifest)
       end
     end
@@ -120,7 +118,9 @@ module Bagger
     end
 
     def generate_and_version_cache_manifest
-      File.open(File.join(@target_dir, 'cache.manifest'), 'w') do |f|
+      path = File.join(@target_dir, @cache_manifest_path)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |f|
         f.puts 'CACHE MANIFEST'
         f.puts ''
         f.puts '# Explicitely cached entries'
@@ -129,7 +129,7 @@ module Bagger
         f.puts 'NETWORK:'
         f.puts '*'
       end
-      to_manifest('cache.manifest')
+      to_manifest(@cache_manifest_path)
     end
 
     private
@@ -144,5 +144,13 @@ module Bagger
       end
       File.open(target_path, "w") { |f| f.write(output) }
     end
+
+    def validate
+      raise_error "Source directory does not exist: #{@source_dir}" unless File.exists?(@source_dir)
+    end
+
+    def raise_error(message)
+      raise ValidationError.new(message)
+    end
   end
 end

data/lib/bagger/version.rb

@@ -1,3 +1,3 @@
 module Bagger
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/bagger.rb

@@ -3,6 +3,8 @@ require 'json'
 require "bagger/packager"
 
 module Bagger
+  class ValidationError < RuntimeError ; end
+
   def self.bagit!(options)
     Bagger::Packager.new(options).run
   end

data/test/bagger_test.rb

@@ -33,12 +33,25 @@ class BaggerTest < Test::Unit::TestCase
     JSON.parse(json) 
   end
 
+  context 'validations' do
+    should 'verify the source directory exists' do
+      assert_raise(Bagger::ValidationError) do
+        Bagger.bagit!(default_options.merge(:source_dir => '/do/not/exist'))
+      end
+    end
+  end
+
   context 'manifest' do
     should 'generate one' do
       Bagger.bagit!(default_options)
       assert File.exists?(File.join(@source_dir, 'manifest.json')), 'manifest was not created'
     end
 
+    should 'not add the manifest itself to the manfiest' do
+      Bagger.bagit!(default_options)
+      assert !manifest['/manifest.json']
+    end
+
     should 'version files with md5' do
       test_content = 'testcontent'
       write_file(File.join(@source_dir, 'test.txt'), test_content)
@@ -60,6 +73,12 @@ class BaggerTest < Test::Unit::TestCase
       Bagger.bagit!(default_options.merge(:path_prefix => '/path_prefix'))
       assert_match /\/path_prefix\/test\..*\.txt/, manifest['/test.txt']
     end
+
+    should 'allow to specify the path' do
+      manifest_path = File.join(@target_dir, 'custom.manifest')
+      Bagger.bagit!(default_options.merge(:manifest_path => manifest_path))
+      assert File.exists?(manifest_path), 'custom manifest path not found'
+    end
   end
 
   context 'html 5 cache manifest' do
@@ -79,6 +98,13 @@ class BaggerTest < Test::Unit::TestCase
       expected_path = File.join(@target_dir, manifest['/cache.manifest'])
       assert File.exists?(expected_path), 'versioned cache manifest not found'
     end
+
+    should 'allow to specify the path' do
+      manifest_path = 'cache/cache.manifest'
+      Bagger.bagit!(default_options.merge(:cache_manifest_path => manifest_path))
+      expected_path = File.join(@target_dir, manifest_path)
+      assert File.exists?(expected_path), 'custom cache manifest path not found'
+    end
   end
 
   context 'css files' do
@@ -249,7 +275,7 @@ class BaggerTest < Test::Unit::TestCase
       assert !File.exists?(File.join(@target_dir, 'js', 'one.js'))
     end
 
-    should 'compress the javascript' do
+    should 'minify the javascript' do
       expected_path = File.join(@target_dir, 'js', 'combined.js')
       Uglifier.expects(:compile).returns('//minified javascript')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bagger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-09 00:00:00.000000000 Z
+date: 2011-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70307486940240 !ruby/object:Gem::Requirement
+  requirement: &70299848703020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70307486940240
+  version_requirements: *70299848703020
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70307486939720 !ruby/object:Gem::Requirement
+  requirement: &70299848702420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70307486939720
+  version_requirements: *70299848702420
 - !ruby/object:Gem::Dependency
   name: uglifier
-  requirement: &70307486939180 !ruby/object:Gem::Requirement
+  requirement: &70299848701860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70307486939180
+  version_requirements: *70299848701860
 - !ruby/object:Gem::Dependency
   name: rainpress
-  requirement: &70307486938540 !ruby/object:Gem::Requirement
+  requirement: &70299848701260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70307486938540
+  version_requirements: *70299848701260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70307486938000 !ruby/object:Gem::Requirement
+  requirement: &70299848700760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70307486938000
+  version_requirements: *70299848700760
 - !ruby/object:Gem::Dependency
   name: shoulda-context
-  requirement: &70307486937460 !ruby/object:Gem::Requirement
+  requirement: &70299848700240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70307486937460
+  version_requirements: *70299848700240
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70307486936940 !ruby/object:Gem::Requirement
+  requirement: &70299848699640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70307486936940
+  version_requirements: *70299848699640
 description: ! 'A framework agnostic packaging solution for your assets: version files,
   combine them, minify them and create a manifest'
 email:
@@ -98,8 +98,10 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - README.md
+- ROADMAP.md
 - Rakefile
 - bagger.gemspec
 - lib/bagger.rb