jake 0.9.3 → 1.0.0

data/History.txt

@@ -1,6 +1,44 @@
-=== 1.0.0 / 2008-07-04
+=== 1.0.0 / 2009-07-06
 
-* 1 major enhancement
+* A proper test suite is now in place.
 
-  * Birthday!
+* Helper methods and event hooks and  are now separated. Use `jake_helper`
+  and `jake_hook` instead of just `jake`.
+
+* :after_build event is now called :build_complete, and we added
+  a :file_created event that is called whenever a new package file is
+  written to disk.
+
+* Metadata can be added to packages using the :meta option. This
+  data is available as Package#meta inside event hooks.
+
+* Erubis is now used instead of ERB if available.
+
+
+=== 0.9.3 / 2009-05-10
+
+* Adds an 'extends' option to packages to allow one package to
+  inherit config from another. Useful for making packages that include
+  all the files from another, plus a few extras.
+
+* Helper methods have access to commandline input via `options`.
+
+
+=== 0.9.2 / 2008-11-14
+
+* Allows '-min' suffixes to be omitted.
+
+* Supports use of ERB in the jake.yml file to generate configs.
+
+
+=== 0.9.1 / 2008-09-11
+
+* Adds ERB support to header files.
+
+
+=== 0.9.0 / 2008-09-11
+
+* First release, supports packages, bundles, ERB code generation.
+
+* Supports :after_build event hook for post-build tasks.
 

data/Manifest.txt

@@ -4,8 +4,30 @@ README.txt
 Rakefile
 bin/jake
 lib/jake.rb
+lib/jake/helper.rb
 lib/jake/build.rb
 lib/jake/buildable.rb
 lib/jake/package.rb
 lib/jake/bundle.rb
 test/test_jake.rb
+test/jake.yml
+test/Jakefile
+test/packages.erb
+test/expected/combo/box.js
+test/expected/combo/box-min.js
+test/expected/sub/dir/foo.js
+test/expected/sub/dir/foo-min.js
+test/expected/sub/path/bar.js
+test/expected/sub/path/bar-min.js
+test/expected/basic.js
+test/expected/basic-min.js
+test/expected/ext.js
+test/expected/ext-min.js
+test/expected/LISTING
+test/expected/README
+test/src/foo/bar.js
+test/src/foo/foo.js
+test/src/basic.js
+test/src/basic-ext.js
+test/src/head.js
+test/src/head2.js

data/README.txt

@@ -2,97 +2,267 @@
 
 * http://github.com/jcoglan/jake
 
-== Description
+Jake is a command line tool for building JavaScript packages from source
+code. Using simple YAML config files, you can specify any number of build
+files to be generated by concatenating and minifying groups of source files.
+It allows ERB to be used inside source files to generate code, and provides
+event hooks into the build process so you can extend it for your own needs.
 
-Jake is a tool for building JavaScript library packages from source code. It allows
-builds to be specified using simple YAML files, and provides a command-line tool for
-generating package files. It also allows ERB to be embedded in JavaScript source code
-so that build data or new code can be generated during the build process.
 
 == Features
 
-* Easy automated builds of JavaScript packages with a single command
-* Uses lightweight YAML to specify files and compression options
-* Compression is configurable both globally and per-package
-* Multiple builds with different compression setups
-* Headers such as copyright information can be injected into all build files
-* ERB can be used to inject code at build time using Ruby functions
+* Concatenate and minify groups of source files for distribution
+* Configured using simple YAML files
+* Easily generate multiple distros with different compression settings
+* Use ERB templating to generate source code
+* Extensible using Ruby/ERB and event hooks during the build process
+* Tested on Ruby 1.8.6, 1.8.7, 1.9.1
 
-== Usage
 
-Jake builds are configured using a YAML file and (optionally) a 'Jakefile' containing
-helper methods for use with Jake's ERB features. You place a file called <tt>jake.yml</tt>
-in the root directory of your project (you will run the +jake+ command from this
-directory). If you use a Jakefile, place this in the same directory.
+== Installation
+
+  sudo gem install jake
 
-This example <tt>jake.yml</tt> demonstrates the layout of the file:
 
-  --
-  source_directory:     src
-  build_directory:      dist
+== Usage
+
+To begin with, create a file called <tt>jake.yml</tt> in the root directory
+of your project; you will run the +jake+ command from here. A basic config
+looks like this:
+
+  ---
+  source_directory:     source
+  build_directory:      build
+  
+  layout:               together
+  
   header:               COPYRIGHT
-  packer:
-    shrink_vars:        true
-    private:            true
-    base62:             true
+  
+  builds:
+    src:
+      packer:           false
+    min:
+      shrink_vars:      true
+      private:          true
   
   packages:
-    foo:                foo
+    [ DESCRIBED BELOW ]
+
+* +source_directory+ is the directory relative to <tt>jake.yml</tt> where
+  your source files are, and +build_directory+ is where all the generated
+  build files will be placed.
+* +layout+ describes whether files from separate builds should go in
+  separate directories. For example if you have a package called +foo+,
+  with the above config the +together+ layout will generate
+  <tt>build/foo-src.js</tt> and <tt>build/foo-min.js</tt>, whereas a
+  +layout+ value of +apart+ will generate <tt>build/src/foo.js</tt> and
+  <tt>build/min/foo.js</tt>.
+* +header+ specifies a file whose content should appear at the top of
+  all generated build files. The content of this file will typically be
+  JavaScript comments containing copyright and license information. This
+  content is never minified. The +header+ option may be omitted.
+
+
+=== Build listing
+
+The build listing, given by the +builds+ option in the config file, lists
+all the builds you want to produce for distribution, and what minification
+settings each build should use. JavaScript projects typically distribute
+both compressed and uncompressed copies of their code to suit both production
+and development environments.
+
+You can have as many builds as you like and the names are up to you. I'm
+using +src+ and +min+ as readily understood examples. Each build may specify
+some combination of the following options:
+
+* <tt>packer: false</tt> - disables minification for this build. This
+  precludes use of further minification options.
+* <tt>shrink_vars: true</tt> - tells the minifier to compress local
+  variable names inside functions.
+* <tt>private: true</tt> - tells the minifier to obfuscate 'private'
+  variables with numeric replacements. JavaScript convention is that any
+  name beginning with an underscore, e.g. <tt>_foo</tt> or <tt>obj._bar</tt>
+  should be considered private. They are replaced with <tt>_0</tt>,
+  <tt>_1</tt>, etc.
+* <tt>base62: true</tt> - produces base-62 encoded minification.
+* <tt>suffix: false</tt> - files from this build should not have a
+  suffix if using the +together+ layout, so you get <tt>build/foo.js</tt>
+  rather than <tt>build/foo-src.js</tt>, for example. Only one build
+  may use this option, otherwise file name clashes will occur.
+
+
+=== Package listing
+
+The package listing, given under the +packages+ config option, describes
+the packages you want to produce and which source files are used to generate
+them. A package is named using the path under +build_directory+ where it
+should be generated, e.g. <tt>foo</tt> or <tt>ext/awesome</tt> (you may
+omit the <tt>.js</tt> extension). Each package lists one or more source
+files used to build it, and may optionally list some extra options as described
+below.
+
+For the examples, assume the source directory is +src+ and the build
+directory is +dist+. This package uses a single source file <tt>src/foo.js</tt>
+and generates <tt>dist/foo_dist.js</tt>:
+
+  foo_dist:     foo
+
+This package generates <tt>dist/bar.js</tt> from <tt>src/bar1.js</tt> and
+<tt>src/bar2.js</tt>
+
+  bar:
+    - bar1
+    - bar2
+
+This generates a package at <tt>dist/sub/dir.js</tt> from <tt>src/path/file.js</tt>
+and <tt>src/path/baz.js</tt>:
+
+  sub/dir:
+    - path/file
+    - path/baz
+
+If all the source files for a package live in the same subdirectory, you
+can tidy things up using the +directory+ option. If you use any package-level
+options, you must list the files under the +files+ option (the above examples
+are just syntactic shorthands for this):
+
+  sub/dir:
+    directory:  path
+    files:
+      - file
+      - baz
+
+The full list of package options is as follows:
+
+* +files+ - lists the source files used to build the package. Shorthand may
+  be used as above if no further options are used.
+* +extends+ - name of another package from which to inherit configuration.
+  Useful for making a package that includes all the files from another,]
+  plus a few extras.
+* +directory+ - the directory under +source_directory+ in which to find
+  source files. May be omitted.
+* +header+ - a custom header file to use on this package. Overrides the
+  root +header+ option. May be omitted.
+* +packer+ - lists minification settings that override settings being used
+  for the current build. If a build listed above uses <tt>packer: false</tt>,
+  this takes precedence over package-specific instructions. Typically used
+  to override options for the minified build.
+* +meta+ - should be a YAML dictionary containing arbitrary data useful to
+  user-defined build events. May be omitted. See 'Event hooks' below.
+
+For example, here's a package listing that uses all the options:
+
+  packages:
+    foo_dist:         foo
     
     bar:
-      - bar_file1
-      - bar_file2
+      - bar1
+      - bar2
+    
+    sub/whizz:
+      extends:        foo_dist
+      directory:      path
+      header:         CUSTOM_HEADER
+      files:
+        - file1
+        - file2
     
-    baz:
-      directory:        baz
-      header:           COPYRIGHT
+    last:
       packer:
-        base62:         false
+        private:      false
+      meta:
+        requires:
+          - jQuery
+          - GMap2
       files:
-        - model
-        - view
-        - controller
-  
-  bundles:
-    my_lib:
-      - foo
-      - bar
-      - baz
-
-This configuration would match a project layed out as follows:
+        - one_file
+        - another_file
+      
+In conjunction with the build options listed above, this matches the
+following project layout (omitting build name suffixes for brevity):
 
-  - dist/
+  - build/
+      - sub/
+          - whizz.js
       - bar.js
-      - baz.js
-      - foo.js
-      - my_lib.js
-  - src/
-      - baz/
-          - controller.js
-          - COPYRIGHT
-          - model.js
-          - view.js
-      - bar_file1.js
-      - bar_file2.js
+      - foo_dist.js
+      - last.js
+  - source/
+      - path/
+          - CUSTOM_HEADER
+          - file1.js
+          - file2.js
+      - another_file.js
+      - bar1.js
+      - bar2.js
       - foo.js
+      - one_file.js
   - COPYRIGHT
   - jake.yml
 
-== Requirements
 
-* Rubygems
-* Oyster
-* PackR
+=== Using ERB in source files
 
-== Installation
+Jake lets you use Ruby's ERB templating system within your source code so
+you can insert values generated from Ruby functions. To use this feature,
+you need to create a file called <tt>Jakefile</tt> in the root of your project.
+This contains helper functions that are called in your source code to inject data.
+
+For example, say you want to extract a version number from your version control
+system and inject it into your code along with the build name. Your source code
+should contain something like this:
+
+  MyJavaScriptLib.VERSION = "<%= version %>-<%= build %>";
+
+And your <tt>Jakefile</tt> should contain a helper called +version+:
+
+  jake_helper :version do
+    # extract version number from svn, git, whatever
+    # e.g. return '1.0'
+  end
+
+Jake has a built-in helper called +build+ that returns the current build
+name. When built, the output would contain the following:
+
+  MyJavaScriptLib.VERSION = "1.0-src";    // or "1.0-min" for the 'min' build
+
+
+=== Event hooks
+
+The +Jakefile+ may also define event hooks that are fired during a build when
+interesting things happen. This allows you to extend your build process using
+configuration data from Jake. All event callbacks are passed a +Build+ object
+as the first argument, and may receive additional arguments depending on the
+event type. We currently have two events:
+
++file_created+ is fired whenever a new build file is created. The callback is
+passed the +Buildable+ package object, the current build type (+src+ or +min+
+using the above examples), and the full path to the newly created file.
+The package object may contain metadata (set using the +meta+ option, see
+above) which you can use for further code generation.
+
++build_complete+ is fired after a build has finished running, that is after
+all sets of minification options have been run. At this point you can use any
+metadata you've gathered to generate more code, copy files to your distribution
+directory, etc.
+
+  $register = {}
+  
+  jake_hook :file_created do |build, pkg, build_type, path|
+    $register[path] = pkg.meta
+  end
+  
+  jake_hook :build_complete do |build|
+    FileUtils.cp 'README', build.build_directory + '/README'
+    # generate code from $register
+  end
 
-* sudo gem install jake -y
 
 == License
 
 (The MIT License)
 
-Copyright (c) 2008 James Coglan
+Copyright (c) 2008-2009 James Coglan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -4,10 +4,10 @@ require 'rubygems'
 require 'hoe'
 require './lib/jake.rb'
 
-Hoe.new('jake', Jake::VERSION) do |p|
+Hoe.spec('jake') do |p|
   # p.rubyforge_name = 'jakex' # if different than lowercase project name
   p.developer('James Coglan', 'jcoglan@googlemail.com')
-  p.extra_deps = %w(oyster packr)
+  p.extra_deps = %w(eventful packr oyster)
 end
 
 # vim: syntax=Ruby

data/bin/jake

@@ -27,5 +27,19 @@ begin; opts = spec.parse
 rescue Oyster::HelpRendered; exit
 end
 
-Jake.build(File.expand_path(opts[:unclaimed].first || '.'), opts)
+LOG_FORMAT = "%-020s %-10s %-040s %-07s"
+
+dir   = File.expand_path(opts[:unclaimed].first || '.')
+build = Jake::Build.new(dir, opts)
+
+build.on(:file_created) do |build, pkg, build_type, path|
+  size = (File.size(path) / 1024.0).ceil
+  puts LOG_FORMAT % [pkg.name, build_type, path.gsub(dir, ''), "#{ size } kB"]
+end
+
+build.on(:file_not_changed) do |build, pkg, build_type, path|
+  puts LOG_FORMAT % [pkg.name, build_type, path.gsub(dir, ''), 'UP-TO-DATE']
+end
+
+build.run!
 

data/lib/jake.rb

@@ -1,21 +1,45 @@
+require 'erb'
+require 'fileutils'
+require 'observer'
+require 'yaml'
+require 'rubygems'
+require 'packr'
+require 'eventful'
+
+begin
+  require 'erubis'
+rescue LoadError
+end
+
 module Jake
-  VERSION = '0.9.3'
+  VERSION = '1.0.0'
   
   CONFIG_FILE = 'jake.yml'
   HELPER_FILE = 'Jakefile'
+  EXTENSION   = '.js'
   
-  def self.build(path, options = {})
-    build = Build.new(path, nil, options)
-    build.force! if options[:force]
+  # Runs a build in the given directory. The directory must contain a jake.yml
+  # file, and may contain a Jakefile. See README for example YAML configurations.
+  def self.build!(path, options = {})
+    build = Build.new(path, options)
     build.run!
   end
   
+  # Removes all registered build event hooks.
+  def self.clear_hooks!
+    Build.delete_observers
+  end
+  
+  # Returns the contents of the given path, which may be missing a .js extension.
   def self.read(path)
     path = File.expand_path(path)
-    path = File.file?(path) ? path : ( File.file?("#{path}.js") ? "#{path}.js" : nil )
-    path and File.read(path).strip
+    [path, "#{path}#{EXTENSION}"].each do |p|
+      return File.read(p).strip if File.file?(p)
+    end
+    return nil
   end
   
+  # Returns a copy of the given hash with the keys cast to symbols.
   def self.symbolize_hash(hash, deep = true)
     hash.inject({}) do |output, (key, value)|
       value = Jake.symbolize_hash(value) if deep and value.is_a?(Hash)
@@ -24,27 +48,27 @@ module Jake
     end
   end
   
-  class Helper
-    attr_accessor :build
-    attr_reader :options
-    
-    def initialize(options = {})
-      @options = options
-    end
-    
-    def scope; binding; end
+  # Returns either an Erubis or ERB instance, depending on what's available.
+  def self.erb(template)
+    defined?(Erubis) ? Erubis::Eruby.new(template) : ERB.new(template)
   end
+  
 end
 
-require 'erb'
-
-%w(build buildable package bundle).each do |file|
+%w(helper build buildable package bundle).each do |file|
   require File.dirname(__FILE__) + '/jake/' + file
 end
 
-def jake(name, &block)
+# Adds a helper method that can be called from ERB.
+def jake_helper(name, &block)
   Jake::Helper.class_eval do
     define_method(name, &block)
   end
 end
- 
+alias :jake :jake_helper
+
+# Registers an event listener that will fire whenever a build is run.
+def jake_hook(type, &block)
+  Jake::Build.on(type, &block)
+end
+

data/lib/jake/build.rb

@@ -1,22 +1,27 @@
-require 'yaml'
-require 'fileutils'
-
 module Jake
+  # A +Build+ encapsulates a single instance of running <tt>Jake.build!</tt>. It
+  # is responsible for running the build and provides access to any configuration
+  # data used to set up the build.
   class Build
+    include Eventful
     
     DEFAULT_LAYOUT = 'together'
     
     include Enumerable
     attr_reader :helper
     
-    def initialize(dir, config = nil, options = {})
-      @dir = File.expand_path(dir)
+    # Builds are initialized using a directory in which to run the build, and an
+    # options hash. Options are passed through to helper methods in the +options+
+    # object.
+    def initialize(dir, options = {})
+      @dir    = File.expand_path(dir)
       @helper = Helper.new(options)
+      force! if options[:force]
       
-      path = "#{dir}/#{CONFIG_FILE}"
-      yaml = File.read(path)
+      path    = "#{dir}/#{CONFIG_FILE}"
+      yaml    = File.read(path)
       
-      @config = Jake.symbolize_hash( config || YAML.load(ERB.new(yaml).result(@helper.scope)) )
+      @config = Jake.symbolize_hash( YAML.load(Jake.erb(yaml).result(@helper.scope)) )
       
       helpers = "#{dir}/#{HELPER_FILE}"
       load helpers if File.file?(helpers)
@@ -34,54 +39,81 @@ module Jake
       end
     end
     
+    # Yields to the block for each build in the group.
     def each(&block)
       @builds.each(&block)
     end
     
+    # Forces the build to generate new files even if target files appear up-to-date.
     def force!
       @forced = true
     end
     
+    # Returns +true+ iff this is a forced build.
     def forced?
-      !!@forced
+      defined?(@forced)
+    end
+    
+    # Returns a list of names for all packages in the build.
+    def packages
+      list = []
+      @packages.each { |name, pkg| list << name }
+      @bundles.each  { |name, pkg| list << name }
+      list
     end
     
+    # Returns the +Buildable+ with the given name.
     def package(name)
       @packages[name.to_sym] || @bundles[name.to_sym]
     end
     
+    # Runs the build, generating new files in +build_directory+.
     def run!
-      @packages.each { |name, pkg| pkg.write! }
-      @bundles.each  { |name, pkg| pkg.write! }
-      @helper.after_build(self) if @helper.respond_to?(:after_build)
+      FileUtils.cd(@dir) do
+        @packages.each { |name, pkg| pkg.write! }
+        @bundles.each  { |name, pkg| pkg.write! }
+        fire(:build_complete)
+      end
     end
     
+    # Returns the path to the build directory, where generated files appear.
     def build_directory
       "#{ @dir }/#{ @config[:build_directory] || '.' }"
     end
+    alias :build_dir :build_directory
     
+    # Returns the path to the source directory, where source code is read from.
     def source_directory
       "#{ @dir }/#{ @config[:source_directory] || '.' }"
     end
+    alias :source_dir :source_directory
     
+    # Returns the header string used for the build, or an empty string if no
+    # header file has been set.
     def header
       @config[:header] ?
           Jake.read("#{ source_directory }/#{ @config[:header] }") :
           ""
     end
     
+    # Returns the minification settings for PackR for the given build name. Each
+    # +Build+ object can build all its packages multiple times with different
+    # minification settings in each run.
     def packer_settings(build_name)
       build = @builds[build_name.to_sym]
       return false unless build
       build[:packer].nil? ? build : build[:packer]
     end
     
+    # Returns +true+ iff filename suffixes based on build name should be added
+    # to generated files for the given build name.
     def use_suffix?(build_name)
       build = @builds[build_name.to_sym]
       return true unless build
       build[:suffix] != false
     end
     
+    # Returns the name of the layout being used, either +together+ or +apart+.
     def layout
       @config[:layout] || DEFAULT_LAYOUT
     end

data/lib/jake/buildable.rb

@@ -1,11 +1,15 @@
-require 'fileutils'
-require 'packr'
-
 module Jake
+  # A +Buildable+ represents a group of files that may be merged to form a single
+  # build file. There are two subtypes of +Buildable+; a +Package+ takes several
+  # source files and produces a build file, and a +Bundle+ takes several +Package+
+  # build files to produce another build file. This class should be considered
+  # abstract as some of its methods must be filled in by subtypes.
   class Buildable
     
     attr_reader :name
     
+    # Create a new +Buildable+ using a +Build+ container, a name and a configuration
+    # hash, typically a subsection of jake.yml.
     def initialize(build, name, config)
       @build, @name = build, name
       @config = case config
@@ -16,17 +20,21 @@ module Jake
       @code = {}
     end
     
+    # Returns the parent +Buildable+ set using the +extends+ option, or +nil+ if
+    # there is no parent.
     def parent
       return nil unless @config[:extends]
       @parent ||= @build.package(@config[:extends])
     end
     
+    # Returns the source directory for this package.
     def directory
       dir = @config[:directory]
       return parent.directory if parent && !dir
       "#{ @build.source_directory }/#{ @config[:directory] }"
     end
     
+    # Returns the path to the output file from this package for the given build name.
     def build_path(build_name)
       suffix = @build.use_suffix?(build_name) ? "-#{ build_name }" : ""
       @build.layout == 'together' ?
@@ -34,6 +42,8 @@ module Jake
           "#{ @build.build_directory }/#{ build_name }/#{ @name }.js"
     end
     
+    # Returns +true+ if the build file for the given build name is out of date and
+    # should be regenerated.
     def build_needed?(name)
       return true if @build.forced?
       path = build_path(name)
@@ -42,13 +52,15 @@ module Jake
       files.any? { |path| File.mtime(path) > build_time }
     end
     
+    # Returns the header string being used for this package.
     def header
       content = @config[:header] ?
           Jake.read("#{ directory }/#{ @config[:header] }") :
           (parent ? parent.header : @build.header)
-      ERB.new(content).result(@build.helper.scope).strip
+      Jake.erb(content).result(@build.helper.scope).strip
     end
     
+    # Returns the PackR settings to use for this package during the given build.
     def packer_settings(build_name)
       global = @build.packer_settings(build_name)
       local  = @config[:packer]
@@ -57,20 +69,28 @@ module Jake
       {}.merge(global || {}).merge(local || {})
     end
     
+    # Returns a hash containing any metadata attached to the package in the config.
+    def meta
+      @config[:meta] || {}
+    end
+    
+    # Generates all the build files for this package by looping over all the
+    # required builds and compressing the source code using each set of minification
+    # options. Files are only generated if they are out of date or the build has
+    # been forced.
     def write!
-      puts "Package #{@name}..."
-      
       @build.each do |name, settings|
-        next unless build_needed?(name)
-        
-        @build.helper.build = name
         path = build_path(name)
+        @build.fire(:file_not_changed, self, name, path) and next unless build_needed?(name)
+        
+        @build.helper.build = name.to_s
         FileUtils.mkdir_p(File.dirname(path))
         File.open(path, 'wb') { |f| f.write( (header + "\n\n" + code(name)).strip ) }
         
+        @build.fire(:file_created, self, name, path)
+        
         size = (File.size(path)/1024.0).ceil
         path = path.sub(@build.build_directory, '')
-        puts "  -- build '#{ name }' created #{ path }, #{ size } kb"
       end
     end
     

data/lib/jake/bundle.rb

@@ -1,15 +1,22 @@
 module Jake
   class Bundle < Buildable
     
+    # Returns a list of paths to all the files used to build this package.
     def files
       base = parent ? parent.files : []
       base + @config[:files].map { |pkg| @build.package(pkg).files }.flatten
     end
     
+    # Returns the full uncompressed source code of this package, before
+    # ERB processing. ERB output will be build-dependent; this method
+    # simply builds the raw template for further processing by other
+    # methods.
     def source
       @source ||= @config[:files].map { |pkg| @build.package(pkg).source }.join("\n\n\n")
     end
     
+    # Returns the result of building the source template and minifying
+    # the output using the given named set of PackR settings.
     def code(name)
       joiner = (packer_settings(name) == false) ? "\n\n\n" : "\n"
       @code[name] ||= @config[:files].map { |pkg| @build.package(pkg).code(name) }.join(joiner)

data/lib/jake/helper.rb

@@ -0,0 +1,15 @@
+module Jake
+  # The +Helper+ class stores helper methods that can be called from ERB
+  # when generating source code. Use +jake_helper+ to define new helpers.
+  class Helper
+    attr_accessor :build
+    attr_reader :options
+    
+    def initialize(options = {})
+      @options = options
+    end
+    
+    def scope; binding; end
+  end
+end
+

data/lib/jake/package.rb

@@ -1,6 +1,7 @@
 module Jake
   class Package < Buildable
     
+    # Returns a list of paths to all the files used to build this package.
     def files
       base = parent ? parent.files : []
       base + @config[:files].map do |path|
@@ -9,22 +10,23 @@ module Jake
       end
     end
     
+    # Returns the full uncompressed source code of this package, before
+    # ERB processing. ERB output will be build-dependent; this method
+    # simply builds the raw template for further processing by other
+    # methods.
     def source
       @source ||= files.map { |path| Jake.read(path) }.join("\n\n\n")
     end
     
+    # Returns the result of building the source template and minifying
+    # the output using the given named set of PackR settings.
     def code(name)
       return @code[name] if @code[name]
       settings = packer_settings(name)
-      output = ERB.new(source).result(@build.helper.scope)
+      output = Jake.erb(source).result(@build.helper.scope)
       @code[name] = settings ? Packr.pack(output, settings) : output
     end
     
-    def header
-      reqs = @config[:requires] || []
-      [super, *reqs.map { |r| "// @require #{r}" }].join("\n")
-    end
-    
   end
 end
 

data/test/Jakefile

@@ -0,0 +1,22 @@
+jake_helper :version do
+  "0.5.0"
+end
+
+FILES = []
+DEPS  = {}
+
+jake_hook :file_created do |build, package, build_type, path|
+  FILES << File.basename(path)
+  DEPS[path] = package.meta if build_type == :min
+end
+
+jake_hook :build_complete do |build|
+  write = lambda do |file, content|
+    File.open(File.join(build.build_dir, file), 'w') { |f| f.write(content) }
+  end
+  write['README', 'Should be generated after build']
+  write['LISTING', FILES.sort * "\n"]
+  
+  write['packages.js', ERB.new(File.read('packages.erb')).result(binding)]
+end
+

data/test/expected/LISTING

@@ -0,0 +1,10 @@
+bar-min.js
+bar.js
+basic-min.js
+basic.js
+box-min.js
+box.js
+ext-min.js
+ext.js
+foo-min.js
+foo.js

data/test/expected/README

@@ -0,0 +1 @@
+Should be generated after build

data/test/expected/basic-min.js

@@ -0,0 +1,7 @@
+/**
+ * Jake test files should all include this
+ * even if they have been minified.
+ * 0.5.0-min
+ **/
+
+Basic={VERSION:"0.5.0-min",function(a){var b=4;return b+this._0+a}};

data/test/expected/basic.js

@@ -0,0 +1,14 @@
+/**
+ * Jake test files should all include this
+ * even if they have been minified.
+ * 0.5.0-src
+ **/
+
+Basic = {
+  VERSION:  "0.5.0-src",
+  
+  function(something) {
+    var myVar = 4;
+    return myVar + this._foo + something;
+  }
+};

data/test/expected/combo/box-min.js

@@ -0,0 +1,8 @@
+/**
+ * Jake test files should all include this
+ * even if they have been minified.
+ * 0.5.0-min
+ **/
+
+Foo=(function(b,c){var a=true;return{_0:null,field:a,global:foo}})(window,something);
+Basic={VERSION:"0.5.0-min",function(a){var b=4;return b+this._foo+a}};Basic.Ext="MIN";

data/test/expected/combo/box.js

@@ -0,0 +1,28 @@
+/**
+ * Jake test files should all include this
+ * even if they have been minified.
+ * 0.5.0-src
+ **/
+
+Foo = (function(my, vars) {
+  var another = true;
+  
+  return {
+    _priv:  null,
+    field:  another,
+    global: foo
+  };
+})(window, something);
+
+
+Basic = {
+  VERSION:  "0.5.0-src",
+  
+  function(something) {
+    var myVar = 4;
+    return myVar + this._foo + something;
+  }
+};
+
+
+Basic.Ext = "SRC";

data/test/expected/ext-min.js

@@ -0,0 +1,7 @@
+/**
+ * Jake test files should all include this
+ * even if they have been minified.
+ * 0.5.0-min
+ **/
+
+Basic={VERSION:"0.5.0-min",function(a){var b=4;return b+this._foo+a}};Basic.Ext="MIN";

data/test/expected/ext.js

@@ -0,0 +1,17 @@
+/**
+ * Jake test files should all include this
+ * even if they have been minified.
+ * 0.5.0-src
+ **/
+
+Basic = {
+  VERSION:  "0.5.0-src",
+  
+  function(something) {
+    var myVar = 4;
+    return myVar + this._foo + something;
+  }
+};
+
+
+Basic.Ext = "SRC";

data/test/expected/sub/dir/foo-min.js

@@ -0,0 +1,7 @@
+/**
+ * Jake test files should all include this
+ * even if they have been minified.
+ * 0.5.0-min
+ **/
+
+Foo=(function(b,c){var a=true;return{_0:null,field:a,global:foo}})(window,something);

data/test/expected/sub/dir/foo.js

@@ -0,0 +1,15 @@
+/**
+ * Jake test files should all include this
+ * even if they have been minified.
+ * 0.5.0-src
+ **/
+
+Foo = (function(my, vars) {
+  var another = true;
+  
+  return {
+    _priv:  null,
+    field:  another,
+    global: foo
+  };
+})(window, something);

data/test/expected/sub/path/bar-min.js

@@ -0,0 +1,3 @@
+/** Alternate header 0.5.0-min **/
+
+(function(object){var Bar={_0:object}})();

data/test/expected/sub/path/bar.js

@@ -0,0 +1,5 @@
+/** Alternate header 0.5.0-src **/
+
+(function(object) {
+  var Bar = {_another: object};
+})();

data/test/jake.yml

@@ -0,0 +1,38 @@
+---
+source_directory:   src
+build_directory:    output
+builds:
+  min:
+    shrink_vars:    true
+    private:        true
+  src:
+    packer:         false
+    suffix:         false
+header:             head
+packages:
+  basic:            basic
+  ext:
+    extends:        basic
+    packer:
+      private:      false
+    files:
+      - basic-ext
+    meta:
+      provides:
+        - Basic
+      requires:
+        - Foo
+  sub/dir/foo:
+    - foo/foo
+  sub/path/bar:
+    directory:      foo
+    header:         ../head2
+    packer:
+      shrink_vars:  false
+    files:
+      - bar
+bundles:
+  combo/box:
+    - sub/dir/foo
+    - ext
+

data/test/packages.erb

@@ -0,0 +1,8 @@
+JS.Packages(function() { with(this) {
+<% DEPS.each do |path, meta| %>
+    file('<%= path %>')
+        .provides(<%= (meta[:provides] || []).map { |p| p.inspect } * ', ' %>)
+        .requires(<%= (meta[:requires] || []).map { |p| p.inspect } * ', ' %>);
+<% end %>
+}});
+

data/test/src/basic-ext.js

@@ -0,0 +1,2 @@
+Basic.Ext = "<%= build.upcase %>";
+

data/test/src/basic.js

@@ -0,0 +1,9 @@
+Basic = {
+  VERSION:  "<%= version %>-<%= build %>",
+  
+  function(something) {
+    var myVar = 4;
+    return myVar + this._foo + something;
+  }
+};
+

data/test/src/foo/bar.js

@@ -0,0 +1,4 @@
+(function(object) {
+  var Bar = {_another: object};
+})();
+

data/test/src/foo/foo.js

@@ -0,0 +1,10 @@
+Foo = (function(my, vars) {
+  var another = true;
+  
+  return {
+    _priv:  null,
+    field:  another,
+    global: foo
+  };
+})(window, something);
+

data/test/src/head.js

@@ -0,0 +1,6 @@
+/**
+ * Jake test files should all include this
+ * even if they have been minified.
+ * <%= version %>-<%= build %>
+ **/
+

data/test/src/head2.js

@@ -0,0 +1,7 @@
+
+
+
+/** Alternate header <%= version %>-<%= build %> **/
+
+
+

data/test/test_jake.rb

@@ -0,0 +1,29 @@
+require "test/unit"
+require "jake"
+require "fileutils"
+require "find"
+
+class TestJake < Test::Unit::TestCase
+  DIR = File.dirname(__FILE__)
+  
+  def setup
+    FileUtils.rm_rf(File.join(DIR, 'output'))
+  end
+  
+  def test_build
+    Jake.clear_hooks!
+    Jake.build!(DIR)
+    expected = File.join(DIR, 'expected')
+    actual   = File.join(DIR, 'output')
+    Find.find(expected) do |path|
+      next unless File.file?(path)
+      actual_path = actual + path.gsub(expected, '')
+      
+      flunk "File #{actual_path} is missing" unless File.file?(actual_path)
+      
+      assert_equal File.read(path).strip, File.read(actual_path),
+                   "File #{actual_path} does not match #{path}"
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jake
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
+  version: 1.0.0
 platform: ruby
 authors: 
 - James Coglan
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-10 00:00:00 +01:00
+date: 2009-07-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: oyster
+  name: eventful
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: oyster
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -40,9 +50,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.12.1
+        version: 2.0.0
     version: 
-description: Jake is a tool for building JavaScript library packages from source code. It allows builds to be specified using simple YAML files, and provides a command-line tool for generating package files. It also allows ERB to be embedded in JavaScript source code so that build data or new code can be generated during the build process.
+description: ""
 email: 
 - jcoglan@googlemail.com
 executables: 
@@ -60,13 +70,37 @@ files:
 - Rakefile
 - bin/jake
 - lib/jake.rb
+- lib/jake/helper.rb
 - lib/jake/build.rb
 - lib/jake/buildable.rb
 - lib/jake/package.rb
 - lib/jake/bundle.rb
 - test/test_jake.rb
+- test/jake.yml
+- test/Jakefile
+- test/packages.erb
+- test/expected/combo/box.js
+- test/expected/combo/box-min.js
+- test/expected/sub/dir/foo.js
+- test/expected/sub/dir/foo-min.js
+- test/expected/sub/path/bar.js
+- test/expected/sub/path/bar-min.js
+- test/expected/basic.js
+- test/expected/basic-min.js
+- test/expected/ext.js
+- test/expected/ext-min.js
+- test/expected/LISTING
+- test/expected/README
+- test/src/foo/bar.js
+- test/src/foo/foo.js
+- test/src/basic.js
+- test/src/basic-ext.js
+- test/src/head.js
+- test/src/head2.js
 has_rdoc: true
 homepage: http://github.com/jcoglan/jake
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -88,9 +122,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: jake
-rubygems_version: 1.3.1
+rubygems_version: 1.3.3
 signing_key: 
-specification_version: 2
-summary: Jake is a tool for building JavaScript library packages from source code
+specification_version: 3
+summary: ""
 test_files: 
 - test/test_jake.rb