jbundle 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+*.gem
+.bundle
+spec/dist/*
+.rvmrc
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in jbundle.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    jbundle (0.0.1)
+      closure-compiler
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    closure-compiler (0.3.3)
+    rspec (1.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  closure-compiler
+  jbundle!
+  rspec (= 1.3.1)

data/README.md

@@ -0,0 +1,107 @@
+## JBundle (in progress)
+
+Define a set of javascript files to bundle and minify
+
+    JBundle.config do
+      version '1.6.1'
+
+      src_dir File.dirname(__FILE__) + '/src'
+
+      bundle 'foo.js' do
+        file 'file1.js'
+        file 'file2.js'
+      end
+
+      bundle 'foo2.js' do
+        file 'file3.js'
+        file 'file4.js'
+      end
+
+      file 'file4.js'
+
+      file 'text.txt'
+      
+      # Filters can be use for string substitution
+      filter do |src, config|
+        src.gsub!(/<VERSION>/, config.version)
+      end
+
+    end
+    
+Then write them to a directory
+
+    JBundle.write_to './dist'
+    
+This will write the following files:
+
+    'dist/1.6.1/foo.js'
+    'dist/1.6.1/foo.min.js'
+    'dist/1.6.1/foo2.js'
+    'dist/1.6.1/foo2.min.js'
+    'dist/1.6.1/file4.js'
+    'dist/1.6.1/file4.min.js'
+    'dist/1.6.1/text.txt'
+    
+    'dist/1.6/foo.js'
+    'dist/1.6/foo.min.js'
+    'dist/1.6/foo2.js'
+    'dist/1.6/foo2.min.js'
+    'dist/1.6/file4.js'
+    'dist/1.6/file4.min.js'
+    'dist/1.6/text.txt'
+    
+Or you can build a single bundle/file dinamically (ie. for testing, or for serving and caching dinamically)
+
+    JBundle.build('foo.js').src
+    
+Or
+
+    JBundle.build('foo.js').min
+    
+You can bundle licenses in bundles. Licenses will not be minified even if though they end up as part of minified files
+
+    bundle 'foo2.js' do
+      license 'license.txt'
+      file 'file3.js'
+      file 'file4.js'
+    end
+    
+All defined filters will run on the src for all these cases.
+
+## JBundlefile
+
+You can add configuration in a JBundlefile in the root of your project.
+
+    version '1.0.1'
+
+    src_dir './'
+
+    bundle 'foo.js' do
+      license 'license.txt'
+      file 'file1.js'
+      file 'file2.js'
+    end
+
+    file 'page.html'
+
+    filter do |src, config|
+      src.gsub! /<VERSION>/, config.version
+    end
+
+    target_dir 'dist'
+    
+Then you can bundle everything up with the command line tool
+
+    $ jbundle
+    
+## Pre-releases
+
+If you want a prerelease not to overwrite the previous point release, suffix it with "-pre", as in:
+
+    version '1.0.1-pre'
+    
+
+## TODO
+
+- DRY up stuff, better error handling for missing config
+    

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+  t.spec_opts = %w{-f s -c -L mtime}
+end
+
+task :default => :spec

data/bin/jbundle

@@ -0,0 +1,9 @@
+require 'jbundle'
+
+JBUNDLE_FILE = 'JBundlefile'
+
+if ::File.exists?(JBUNDLE_FILE)
+  JBundle.run( ::File.read(JBUNDLE_FILE) )
+else
+  puts "You need to define ./#{JBUNDLE_FILE}"
+end

data/jbundle.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/jbundle/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "jbundle"
+  s.version     = JBundle::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Ismael Celis']
+  s.email       = ['ismaelct@gmail.com']
+  s.homepage    = "http://github.com/ismasan/jbundle"
+  s.summary     = "Writes versioned, bundled and minified javascript files and dependencies"
+  s.description = "Good for releasing javascript libraries composed of many files. Writes files apt for deploying to CDNs."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "jbundle"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", '1.3.1'
+  s.add_dependency 'closure-compiler'
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/lib/jbundle/builder.rb

@@ -0,0 +1,88 @@
+require 'closure-compiler'
+
+module JBundle
+  
+  class Compiler
+    
+    BUILDABLE_FILES = ['.js']
+    
+    attr_reader :name, :src_dir
+    
+    def initialize(name, file_list, src_dir = 'src')
+      @name, @file_list, @src_dir = name.to_s, file_list, src_dir
+    end
+    
+    def buildable?
+      BUILDABLE_FILES.include?(::File.extname(name))
+    end
+    
+    # This only makes sense for one-file objects
+    def src_path
+      ::File.join(@src_dir, name)
+    end
+    
+    def src
+      @src ||= licenses + raw_src
+    end
+    
+    def min
+      @min ||= licenses + Closure::Compiler.new.compile(raw_src)
+    end
+    
+    def min_name
+      @min_name ||= (
+        ext = ::File.extname(name)
+        name.sub(ext, '') + '.min' + ext
+      )
+    end
+    
+    def licenses
+      @licenses ||= if @file_list.respond_to?(:licenses)
+        read_files @file_list.licenses
+      else
+        ''
+      end
+    end
+    
+    def raw_src
+      @raw_src ||= read_files(@file_list)
+    end
+    
+    protected
+    
+    def read_files(file_names)
+      file_names.inject('') do |mem, file_name|
+        mem << ::File.read(::File.join(src_dir, file_name))
+        mem << "\n"
+        mem
+      end
+    end
+    
+  end
+  
+  
+  class Builder
+    
+    def initialize(config)
+      @config = config
+      @sources = []
+    end
+    
+    def build!
+      @sources = @config.bundles_and_files.map do |b|
+        build_one b
+      end
+    end
+    
+    def build_one(f)
+      compiler = Compiler.new(f.name, f, @config.src_dir)
+      @config.filters.each do |filter|
+        filter.call(compiler.licenses, @config)
+        filter.call(compiler.raw_src, @config)
+      end
+      compiler
+    end
+    
+  end
+  
+end

data/lib/jbundle/bundle.rb

@@ -0,0 +1,29 @@
+module JBundle
+  
+  class Bundle
+    
+    include Enumerable
+    
+    attr_reader :name, :licenses
+
+    def initialize(name)
+      @name = name.to_s
+      @files = []
+      @licenses = []
+    end
+    
+    def file(f)
+      @files << f
+    end
+    
+    def license(license_file)
+      @licenses << license_file
+    end
+    
+    def each(&block)
+      @files.each &block
+    end
+    
+  end
+  
+end

data/lib/jbundle/config.rb

@@ -0,0 +1,51 @@
+module JBundle
+  
+  class Config
+    
+    attr_reader :bundles, :files, :src_dir, :filters
+    
+    def initialize
+      @bundles = []
+      @files = []
+      @filters = []
+    end
+    
+    def version(v = nil)
+      @version = v if v
+      @version
+    end
+    
+    def src_dir(dir = nil)
+      @src_dir = dir if dir
+      @src_dir
+    end
+    
+    def target_dir(dir = nil)
+      @target_dir = dir if dir
+      @target_dir
+    end
+    
+    def bundle(name, &block)
+      name = name.to_sym
+      if !b = @bundles.detect{|a| a.name == name}
+        b = Bundle.new(name)
+        @bundles << b
+      end
+      b.instance_eval &block
+      b
+    end
+    
+    def file(f)
+      @files << JBundle::File.new(f)
+    end
+    
+    def filter(&block)
+      filters << block
+    end
+    
+    def bundles_and_files
+      @bundles + @files
+    end
+    
+  end
+end

data/lib/jbundle/file.rb

@@ -0,0 +1,19 @@
+module JBundle
+  
+  class File
+    
+    include Enumerable
+    
+    attr_reader :name
+    
+    def initialize(name)
+      @name = name.to_s
+    end
+    
+    def each(&block)
+      yield name
+    end
+    
+  end
+  
+end

data/lib/jbundle/version.rb

@@ -0,0 +1,3 @@
+module JBundle
+  VERSION = "0.0.1"
+end

data/lib/jbundle/writer.rb

@@ -0,0 +1,69 @@
+module JBundle
+  
+  class Version
+
+    def initialize(string)
+      @major, @minor, @patch = string.split('.')
+      raise "require (major.minor.patch) eg: 1.3.1" unless @major && @minor && @patch
+    end
+
+    def full
+      [@major, @minor, @patch].join('.')
+    end
+
+    def major_minor 
+      [@major, @minor].join('.')
+    end
+
+    def releaseable
+      prerelease? ? [full] : [full, major_minor]
+    end
+    
+    def to_s
+      full
+    end
+
+    protected
+
+    def prerelease?
+      @patch =~ /-pre/
+    end
+
+  end
+  
+  class Writer
+    
+    def initialize(compiler, version, target_dir)
+      @compiler, @version, @target_dir = compiler, Version.new(version), target_dir
+    end
+    
+    def write
+      @version.releaseable.each do |version_dir|
+        if @compiler.buildable?
+          write_file @compiler.src, ::File.join(@target_dir, version_dir), @compiler.name
+          write_file @compiler.min, ::File.join(@target_dir, version_dir), @compiler.min_name
+        else
+          copy_file @compiler.src_path, ::File.join(@target_dir, version_dir, @compiler.name)
+        end
+      end
+    end
+    
+    protected
+    
+    def copy_file(src, target)
+      JBundle.log("Copying to #{target}")
+      FileUtils.cp src, target
+    end
+    
+    def write_file(content, dir_name, file_name)
+      FileUtils.mkdir_p dir_name
+      path = ::File.join(dir_name, file_name)
+      JBundle.log("Writing to #{path}")
+      ::File.open(path, 'w') do |f|
+        f.write content
+      end
+    end
+    
+  end
+  
+end

data/lib/jbundle.rb

@@ -0,0 +1,55 @@
+require 'fileutils'
+require 'jbundle/config'
+require 'jbundle/file'
+require 'jbundle/bundle'
+require 'jbundle/builder'
+require 'jbundle/writer'
+
+module JBundle
+  
+  class << self
+    
+    attr_accessor :logger
+    
+    def log(msg)
+      logger.call(msg)
+    end
+    
+    def config(&block)
+      @current_config ||= JBundle::Config.new
+      @current_config.instance_eval(&block) if block_given?
+      @current_config
+    end
+    
+    def output
+      @output ||= Builder.new(config).build!
+    end
+    
+    def reset!
+      @current_config = nil
+      @output = nil
+      self
+    end
+    
+    def write_to(target_dir)
+      output.each do |compiler|
+        Writer.new(compiler, config.version, target_dir).write
+      end
+    end
+    
+    def build(name)
+      found = config.bundles_and_files.detect {|f| f.name == name}
+      raise "No bundle or file found with name #{name}" unless found
+      Builder.new(config).build_one found
+    end
+    
+    def run(content)
+      config.instance_eval content
+      write_to config.target_dir || './dist'
+    end
+    
+  end
+  
+  self.logger = lambda {|msg| puts "#{msg}\n"}
+  
+end

data/spec/.rspec

@@ -0,0 +1 @@
+--color

data/spec/jbundle_spec.rb

@@ -0,0 +1,98 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'fileutils'
+
+describe "JBundle" do
+  
+  before do
+    
+    JBundle.reset!
+    
+    JBundle.config do
+      version '1.6.1'
+      
+      src_dir File.dirname(__FILE__) + '/test_src'
+      
+      bundle 'foo.js' do
+        file 'file1.js'
+        file 'file2.js'
+      end
+      
+      bundle 'foo2.js' do
+        license 'license.txt'
+        file 'file3.js'
+        file 'file4.js'
+      end
+      
+      file 'file4.js'
+      
+      file 'text.txt'
+      
+      filter do |src, config|
+        src.gsub!(/<VERSION>/, config.version)
+      end
+      
+    end
+    
+  end
+  
+  it 'should have a version' do
+    JBundle.config.version.to_s.should == '1.6.1'
+  end
+  
+  it 'should have bundles' do
+    JBundle.config.bundles[0].name.should == 'foo.js'
+    JBundle.config.bundles[1].name.should == 'foo2.js'
+  end
+  
+  context 'bundling' do
+    
+    it 'should build single bundles' do
+      JBundle.build('foo.js').src.should == "var VERSION = '1.6.1';\nvar a1 = 1;\nvar a2 = 2;\n"
+      JBundle.build('file4.js').min.should == "var a4=4;\n"
+    end
+    
+    it 'should bundle bundles' do
+      JBundle.output.size.should == 4
+      JBundle.output[0].name.should == 'foo.js'
+      JBundle.output[0].src.should == "var VERSION = '1.6.1';\nvar a1 = 1;\nvar a2 = 2;\n"
+      JBundle.output[0].min.should == "var VERSION=\"1.6.1\",a1=1,a2=2;\n"
+    end
+    
+    it 'should not minify licenses' do
+      JBundle.build('foo2.js').src.should == "/* Version: 1.6.1\nThis is a license\n-----------------------*/\nvar a3 = 3;\nvar a4 = 4;\n"
+      JBundle.build('foo2.js').min.should == "/* Version: 1.6.1\nThis is a license\n-----------------------*/\nvar a3=3,a4=4;\n"
+    end
+    
+  end
+  
+  context 'writing' do
+    
+    before do
+      @dist = File.dirname(__FILE__)+'/dist'
+      FileUtils.rm_rf @dist
+    end
+    
+    it 'should write files' do
+      JBundle.write_to(@dist)
+      
+      File.exist?(@dist + '/1.6.1/foo.js').should be_true
+      File.exist?(@dist + '/1.6.1/foo.min.js').should be_true
+      File.exist?(@dist + '/1.6.1/foo2.js').should be_true
+      File.exist?(@dist + '/1.6.1/foo2.min.js').should be_true
+      File.exist?(@dist + '/1.6.1/file4.js').should be_true
+      File.exist?(@dist + '/1.6.1/file4.min.js').should be_true
+      File.exist?(@dist + '/1.6.1/text.txt').should be_true
+      File.exist?(@dist + '/1.6.1/text.min.txt').should be_false
+      
+      File.exist?(@dist + '/1.6/foo.js').should be_true
+      File.exist?(@dist + '/1.6/foo.min.js').should be_true
+      File.exist?(@dist + '/1.6/foo2.js').should be_true
+      File.exist?(@dist + '/1.6/foo2.min.js').should be_true
+      File.exist?(@dist + '/1.6/file4.js').should be_true
+      File.exist?(@dist + '/1.6/file4.min.js').should be_true
+      File.exist?(@dist + '/1.6/text.txt').should be_true
+      File.exist?(@dist + '/1.6/text.min.txt').should be_false
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'jbundle'
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end

data/spec/test_src/file1.js

@@ -0,0 +1,2 @@
+var VERSION = '<VERSION>';
+var a1 = 1;

data/spec/test_src/file2.js

@@ -0,0 +1 @@
+var a2 = 2;

data/spec/test_src/file3.js

@@ -0,0 +1 @@
+var a3 = 3;

data/spec/test_src/file4.js

@@ -0,0 +1 @@
+var a4 = 4;

data/spec/test_src/license.txt

@@ -0,0 +1,3 @@
+/* Version: <VERSION>
+This is a license
+-----------------------*/

data/spec/test_src/text.txt

@@ -0,0 +1 @@
+Foo

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: jbundle
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ismael Celis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-03 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: closure-compiler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Good for releasing javascript libraries composed of many files. Writes files apt for deploying to CDNs.
+email: 
+- ismaelct@gmail.com
+executables: 
+- jbundle
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/jbundle
+- jbundle.gemspec
+- lib/jbundle.rb
+- lib/jbundle/builder.rb
+- lib/jbundle/bundle.rb
+- lib/jbundle/config.rb
+- lib/jbundle/file.rb
+- lib/jbundle/version.rb
+- lib/jbundle/writer.rb
+- spec/.rspec
+- spec/jbundle_spec.rb
+- spec/spec_helper.rb
+- spec/test_src/file1.js
+- spec/test_src/file2.js
+- spec/test_src/file3.js
+- spec/test_src/file4.js
+- spec/test_src/license.txt
+- spec/test_src/text.txt
+has_rdoc: true
+homepage: http://github.com/ismasan/jbundle
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: jbundle
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Writes versioned, bundled and minified javascript files and dependencies
+test_files: []
+