bagger 0.0.2 → 0.1.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v 0.1.0
+
+* Combine javascript and stylesheets into several packages
+* Change of configuration API. The javascript and stylesheets are now
+  defined as an array. See the updated README.md for an example
+
 ## v 0.0.2
 
 * Make file and cache manifest path configurable

data/README.md

@@ -55,10 +55,18 @@ cache.manifest
     :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'
+	    :stylesheets => [
+        {
+          :target_path => 'css/all.css',
+          :files => stylesheets
+        }
+      ],
+	    :javascripts => [
+        {
+          :target_path => 'js/combined.js',
+          :files => javascripts
+        }
+      ]
 	  }
 	}
 	

data/ROADMAP.md

@@ -18,18 +18,21 @@
 
 ## v 0.1.0 
 
-* generate custom manifest files e.g with support for file size
+* support for packages. e.g
+
+	:stylesheets => {
+		:common => ['main.css', 'fonts.css'],
+		:dialogs => ['modal.css', 'info_box.css']
+	}
+
+## v 0.2.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 packages. e.g
-
-	:stylesheets => {
-		:common => ['main.css', 'fonts.css'],
-		:dialogs => ['modal.css', 'info_box.css']
-	}

data/lib/bagger/packager.rb

@@ -10,14 +10,12 @@ module Bagger
 
     def initialize(options)
       @options = options
-      @stylesheets = (@options[:combine] || {})[:stylesheets] || []
-      @javascripts = (@options[:combine] || {})[:javascripts] || []
+      @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'
-      @stylesheet_path = (@options[:combine] || {})[:stylesheet_path] || 'combined.css'
-      @javascript_path = (@options[:combine] || {})[:javascript_path] || 'combined.js'
       @path_prefix = @options[:path_prefix] || ''
       @manifest = {}
     end
@@ -38,16 +36,19 @@ module Bagger
       @manifest[manifest_key_path] = effective_path
     end
 
-    def run
+    def stylesheets
+      @stylesheets ||= calculate_stylesheets
+    end
+
+    def javascripts
+      @javascripts ||= calculate_javascripts
+    end
+
+   def run
       validate
+      version_files
       combine_css
       combine_js
-      version_files
-      rewrite_urls_in_css
-      compress_css
-      to_manifest(@stylesheet_path, false)
-      compress_js
-      to_manifest(@javascript_path, false)
       generate_and_version_cache_manifest
       write_manifest
     end
@@ -72,14 +73,19 @@ module Bagger
     end
 
     def combine_css
-      combine_files(@stylesheets, @stylesheet_path)
+      stylesheets.each do |config|
+        combine_files(config[:files], config[:target_path])
+        rewrite_urls_in_css(config[:target_path])
+        compress_css(config[:target_path])
+        to_manifest(config[:target_path], false)
+      end
     end
 
-    def rewrite_urls_in_css
+    def rewrite_urls_in_css(stylesheet_path)
       url_regex = /(^|[{;])(.*?url\(\s*['"]?)(.*?)(['"]?\s*\).*?)([;}]|$)/ui
       behavior_regex = /behavior:\s*url/ui
       data_regex = /^\s*data:/ui
-      input = File.open(File.join(@target_dir, @stylesheet_path)){|f| f.read}
+      input = File.open(File.join(@target_dir, stylesheet_path)){|f| f.read}
       output = input.gsub(url_regex) do |full_match|
         pre, url_match, post = ($1 + $2), $3, ($4 + $5)
         if behavior_regex.match(pre) || data_regex.match(url_match)
@@ -94,27 +100,31 @@ module Bagger
           end
         end
       end
-      File.open(File.join(@target_dir, @stylesheet_path), 'w') do |f|
+      File.open(File.join(@target_dir, stylesheet_path), 'w') do |f|
         f.write output
       end
     end
 
-    def compress_css
-      css = File.open(File.join(@target_dir, @stylesheet_path)){|f| f.read}
+    def compress_css(stylesheet_path)
+      css = File.open(File.join(@target_dir, stylesheet_path)){|f| f.read}
       compressed = Rainpress.compress(css)
-      File.open(File.join(@target_dir, @stylesheet_path), 'w') do |f|
+      File.open(File.join(@target_dir, stylesheet_path), 'w') do |f|
         f.write compressed
       end
     end
 
     def combine_js
-      combine_files(@javascripts, @javascript_path)
+      javascripts.each do |config|
+        combine_files(config[:files], config[:target_path])
+        compress_js(config[:target_path])
+        to_manifest(config[:target_path], false)
+      end
     end
 
-    def compress_js
-      javascript = File.open(File.join(@target_dir, @javascript_path)){|f| f.read}
+    def compress_js(javascript_path)
+      javascript = File.open(File.join(@target_dir, javascript_path)){|f| f.read}
       compressed = Uglifier.compile(javascript)
-      File.open(File.join(@target_dir, @javascript_path), 'w'){|f| f.write compressed}
+      File.open(File.join(@target_dir, javascript_path), 'w'){|f| f.write compressed}
     end
 
     def generate_and_version_cache_manifest
@@ -132,7 +142,7 @@ module Bagger
       to_manifest(@cache_manifest_path)
     end
 
-    private
+    protected
 
     def combine_files(files, path)
       output = ''
@@ -145,6 +155,22 @@ module Bagger
       File.open(target_path, "w") { |f| f.write(output) }
     end
 
+    def calculate_stylesheets
+      if @options[:combine] && @options[:combine][:stylesheets]
+        @options[:combine][:stylesheets]
+      else
+        []
+      end
+    end
+
+    def calculate_javascripts
+      if @options[:combine] && @options[:combine][:javascripts]
+        @options[:combine][:javascripts]
+      else
+        []
+      end
+    end
+
     def validate
       raise_error "Source directory does not exist: #{@source_dir}" unless File.exists?(@source_dir)
     end

data/lib/bagger/version.rb

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

data/test/bagger_test.rb

@@ -6,7 +6,7 @@ class BaggerTest < Test::Unit::TestCase
   def setup
     @source_dir = Dir.mktmpdir
     @target_dir = Dir.mktmpdir
-    Uglifier.stubs(:compile).returns('//minfied js');
+    Uglifier.stubs(:compile).returns('//minified js');
   end
 
   def teardown
@@ -110,8 +110,10 @@ class BaggerTest < Test::Unit::TestCase
   context 'css files' do
     setup do
       @config = {
-        :stylesheets => [],
-        :stylesheet_path => 'css/combined.css'
+        :stylesheets => [{
+          :target_path => 'css/combined.css',
+          :files => []
+        }]
       }
       @css_dir = File.join(@source_dir, 'css')
       FileUtils.mkdir_p(@css_dir)
@@ -120,7 +122,7 @@ class BaggerTest < Test::Unit::TestCase
                     File.join(@css_dir, "#{file}.css"),
                     ".#{file}{}"
                   )
-        @config[:stylesheets] << "css/#{file}.css"
+        @config[:stylesheets][0][:files] << "css/#{file}.css"
       end
     end
 
@@ -153,7 +155,7 @@ class BaggerTest < Test::Unit::TestCase
       assert !File.exists?(File.join(@target_dir, 'css', 'one.css'))
     end
 
-    should 'compress it' do
+    should 'minify it' do
       Rainpress.stubs(:compress).returns('//super minified css');
       Bagger.bagit!(
         :source_dir => @source_dir,
@@ -179,7 +181,7 @@ class BaggerTest < Test::Unit::TestCase
         }
         EOF
         write_file(File.join(@css_dir, "urled.css"), css)
-        @config[:stylesheets] << 'css/urled.css'
+        @config[:stylesheets][0][:files] << 'css/urled.css'
         FileUtils.mkdir_p(File.join(@source_dir, 'images'))
         %w(root relative absolute).each do |type|
           FileUtils.touch(File.join(@source_dir, 'images', "#{type}.png"))
@@ -233,8 +235,12 @@ class BaggerTest < Test::Unit::TestCase
   context 'combine javascript' do
     setup do
       @config = {
-        :javascripts => [],
-        :javascript_path => 'js/combined.js'
+        :javascripts => [
+          {
+            :target_path => 'js/combined.js',
+            :files => []
+          }
+        ]
       }
       @js_dir = File.join(@source_dir, 'js')
       FileUtils.mkdir_p(@js_dir)
@@ -243,7 +249,7 @@ class BaggerTest < Test::Unit::TestCase
                     File.join(@js_dir, "#{file}.js"),
                     "var #{file} = 1;"
                   )
-        @config[:javascripts] << "js/#{file}.js"
+        @config[:javascripts][0][:files] << "js/#{file}.js"
       end
     end
 
@@ -288,4 +294,79 @@ class BaggerTest < Test::Unit::TestCase
       assert_equal '//minified javascript', File.open(expected_file_path){|f| f.read}
     end
   end
+
+  context 'packages' do
+
+    setup do
+      @config = {
+        :javascripts => [
+          {
+            :target_path => 'js/common.js',
+            :files => []
+          },
+          {
+            :target_path => 'js/navigation.js',
+            :files => []
+          }
+        ],
+        :stylesheets => [
+          {
+            :target_path => 'css/common.css',
+            :files => []
+          },
+          {
+            :target_path => 'css/navigation.css',
+            :files => []
+          }
+        ]
+      }
+      @js_dir = File.join(@source_dir, 'js')
+      FileUtils.mkdir_p(@js_dir)
+      @css_dir = File.join(@source_dir, 'css')
+      FileUtils.mkdir_p(@css_dir)
+
+      %w(one two).each do |file|
+        write_file(
+                    File.join(@js_dir, "#{file}.js"),
+                    "var #{file} = 1;"
+                  )
+        write_file(
+                    File.join(@css_dir, "#{file}.css"),
+                    "##{file} { color : black }"
+                  )
+      end
+      @config[:javascripts][0][:files] << 'js/one.js';
+      @config[:javascripts][1][:files] << 'js/two.js';
+      @config[:stylesheets][0][:files] << 'css/one.css';
+      @config[:stylesheets][1][:files] << 'css/two.css';
+
+      Rainpress.stubs(:compress).returns('//minified css');
+    end
+
+
+    should 'allow to bundle javascript into packages' do
+      Bagger.bagit!(
+        :source_dir => @source_dir,
+        :target_dir => @target_dir,
+        :combine => @config
+      )
+      expected_file_path = File.join(@target_dir, manifest['/js/common.js'])
+      assert_equal '//minified js', File.open(expected_file_path){|f| f.read}
+      expected_file_path = File.join(@target_dir, manifest['/js/navigation.js'])
+      assert_equal '//minified js', File.open(expected_file_path){|f| f.read}
+    end
+
+    should 'allow to bundle stylesheets into packages' do
+      Bagger.bagit!(
+        :source_dir => @source_dir,
+        :target_dir => @target_dir,
+        :combine => @config
+      )
+      expected_file_path = File.join(@target_dir, manifest['/css/common.css'])
+      assert_equal '//minified css', File.open(expected_file_path){|f| f.read}
+      expected_file_path = File.join(@target_dir, manifest['/css/navigation.css'])
+      assert_equal '//minified css', File.open(expected_file_path){|f| f.read}
+    end
+
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bagger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70299848703020 !ruby/object:Gem::Requirement
+  requirement: &70153224223720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70299848703020
+  version_requirements: *70153224223720
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70299848702420 !ruby/object:Gem::Requirement
+  requirement: &70153224223120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70299848702420
+  version_requirements: *70153224223120
 - !ruby/object:Gem::Dependency
   name: uglifier
-  requirement: &70299848701860 !ruby/object:Gem::Requirement
+  requirement: &70153224222560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70299848701860
+  version_requirements: *70153224222560
 - !ruby/object:Gem::Dependency
   name: rainpress
-  requirement: &70299848701260 !ruby/object:Gem::Requirement
+  requirement: &70153224221960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70299848701260
+  version_requirements: *70153224221960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70299848700760 !ruby/object:Gem::Requirement
+  requirement: &70153224221440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299848700760
+  version_requirements: *70153224221440
 - !ruby/object:Gem::Dependency
   name: shoulda-context
-  requirement: &70299848700240 !ruby/object:Gem::Requirement
+  requirement: &70153224220920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299848700240
+  version_requirements: *70153224220920
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70299848699640 !ruby/object:Gem::Requirement
+  requirement: &70153224220300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70299848699640
+  version_requirements: *70153224220300
 description: ! 'A framework agnostic packaging solution for your assets: version files,
   combine them, minify them and create a manifest'
 email: