jake 0.9.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-07-04
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/jake
+lib/jake.rb
+lib/jake/build.rb
+lib/jake/buildable.rb
+lib/jake/package.rb
+lib/jake/bundle.rb
+test/test_jake.rb

data/README.txt

@@ -0,0 +1,114 @@
+= Jake
+
+* http://github.com/jcoglan/jake
+
+== 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.
+
+== 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
+
+== 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.
+
+This example <tt>jake.yml</tt> demonstrates the layout of the file:
+
+  --
+  source_directory:     src
+  build_directory:      dist
+  header:               COPYRIGHT
+  packer:
+    shrink_vars:        true
+    private:            true
+    base62:             true
+  
+  packages:
+    foo:                foo
+    
+    bar:
+      - bar_file1
+      - bar_file2
+    
+    baz:
+      directory:        baz
+      header:           COPYRIGHT
+      packer:
+        base62:         false
+      files:
+        - model
+        - view
+        - controller
+  
+  bundles:
+    my_lib:
+      - foo
+      - bar
+      - baz
+
+This configuration would match a project layed out as follows:
+
+  - dist/
+      - 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.js
+  - COPYRIGHT
+  - jake.yml
+
+== Requirements
+
+* Rubygems
+* Oyster
+* PackR
+
+== Installation
+
+* sudo gem install jake -y
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2008 James Coglan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/jake.rb'
+
+Hoe.new('jake', Jake::VERSION) 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)
+end
+
+# vim: syntax=Ruby

data/bin/jake

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby
+require 'rubygems'
+require 'oyster'
+require 'jake'
+
+spec = Oyster.spec do
+  name    'jake -- automated build tool for JavaScript projects'
+  
+  synopsis <<-EOS
+  jake [--force] [DIR]
+  EOS
+  
+  description <<-EOS
+  Jake builds JavaScript library packages from source code using PackR and
+  ERB. Use --force to force a rebuild of files deemed up-to-date. DIR specifies
+  where to find the jake.yml configuration file, by default this is set to the
+  current working directory.
+  EOS
+  
+  flag :force, :default => false,
+  :desc => 'Force a rebuild even if files are up-to-date'
+  
+  author 'James Coglan <jcoglan@googlemail.com>'
+end
+
+begin; opts = spec.parse
+rescue Oyster::HelpRendered; exit
+end
+
+Jake.build(File.expand_path(opts[:unclaimed].first || '.'), opts[:force])
+

data/lib/jake/build.rb

@@ -0,0 +1,76 @@
+require 'yaml'
+require 'fileutils'
+
+module Jake
+  class Build
+    
+    DEFAULT_LAYOUT = 'together'
+    
+    attr_reader :helper, :builds
+    
+    def initialize(dir, config = nil)
+      @dir = File.expand_path(dir)
+      @helper = Helper.new
+      
+      path = "#{dir}/#{CONFIG_FILE}"
+      @config = Jake.symbolize_hash( config || YAML.load(File.read(path)) )
+      
+      helpers = "#{dir}/#{HELPER_FILE}"
+      load helpers if File.file?(helpers)
+      
+      @builds = @config[:builds] || {:src => false, :min => @config[:packer]}
+      
+      @packages = @config[:packages].inject({}) do |pkgs, (name, conf)|
+        pkgs[name] = Package.new(self, name, conf)
+        pkgs
+      end
+      
+      @bundles = (@config[:bundles] || {}).inject({}) do |pkgs, (name, conf)|
+        pkgs[name] = Bundle.new(self, name, conf)
+        pkgs
+      end
+    end
+    
+    def force!
+      @forced = true
+    end
+    
+    def forced?
+      !!@forced
+    end
+    
+    def package(name)
+      @packages[name.to_sym]
+    end
+    
+    def run!
+      @packages.each { |name, pkg| pkg.write! }
+      @bundles.each  { |name, pkg| pkg.write! }
+      @helper.after_build(self) if @helper.respond_to? :after_build
+    end
+    
+    def build_directory
+      "#{ @dir }/#{ @config[:build_directory] || '.' }"
+    end
+    
+    def source_directory
+      "#{ @dir }/#{ @config[:source_directory] || '.' }"
+    end
+    
+    def header
+      @config[:header] ?
+          Jake.read("#{ source_directory }/#{ @config[:header] }") :
+          ""
+    end
+    
+    def packer_settings(build_name)
+      @builds[build_name] || false
+    end
+    
+    def layout
+      @config[:layout] || DEFAULT_LAYOUT
+    end
+    
+  end
+end
+

data/lib/jake/buildable.rb

@@ -0,0 +1,69 @@
+require 'fileutils'
+require 'packr'
+
+module Jake
+  class Buildable
+    
+    attr_reader :name
+    
+    def initialize(build, name, config)
+      @build, @name = build, name
+      @config = case config
+      when Hash   then config
+      when String then {:files => [config]}
+      when Array  then {:files => config}
+      end
+      @code = {}
+    end
+    
+    def directory
+      "#{ @build.source_directory }/#{ @config[:directory] }"
+    end
+    
+    def build_path(build_name)
+      @build.layout == 'together' ?
+          "#{ @build.build_directory }/#{ @name }-#{ build_name }.js" :
+          "#{ @build.build_directory }/#{ build_name }/#{ @name }.js"
+    end
+    
+    def build_needed?(name)
+      return true if @build.forced?
+      path = build_path(name)
+      return true unless File.file?(path)
+      build_time = File.mtime(path)
+      files.any? { |path| File.mtime(path) > build_time }
+    end
+    
+    def header
+      @config[:header] ?
+          Jake.read("#{ directory }/#{ @config[:header] }") :
+          @build.header
+    end
+    
+    def packer_settings(build_name)
+      global = @build.packer_settings(build_name)
+      local  = @config[:packer]
+      return false if global == false or local == false
+      {}.merge(global || {}).merge(local || {})
+    end
+    
+    def write!
+      puts "Package #{@name}..."
+      
+      @build.builds.each do |name, settings|
+        next unless build_needed?(name)
+        
+        @build.helper.build = name
+        path = build_path(name)
+        FileUtils.mkdir_p(File.dirname(path))
+        File.open(path, 'wb') { |f| f.write( (header + "\n\n" + code(name)).strip ) }
+        
+        size = (File.size(path)/1024.0).ceil
+        path = path.sub(@build.build_directory, '')
+        puts "  -- build '#{ name }' created #{ path }, #{ size } kb"
+      end
+    end
+    
+  end
+end
+

data/lib/jake/bundle.rb

@@ -0,0 +1,18 @@
+module Jake
+  class Bundle < Buildable
+    
+    def files
+      @config[:files].map { |pkg| @build.package(pkg).files }.flatten
+    end
+    
+    def source
+      @source ||= @config[:files].map { |pkg| @build.package(pkg).source }.join("\n\n\n")
+    end
+    
+    def code(name)
+      @code[name] ||= @config[:files].map { |pkg| @build.package(pkg).code(name) }.join("\n\n\n")
+    end
+    
+  end
+end
+

data/lib/jake/package.rb

@@ -0,0 +1,31 @@
+require 'erb'
+
+module Jake
+  class Package < Buildable
+    
+    def files
+      @config[:files].map do |path|
+        path = "#{ directory }/#{ path }"
+        File.file?(path) ? path : "#{ path }.js"
+      end
+    end
+    
+    def source
+      @source ||= files.map { |path| Jake.read(path) }.join("\n\n\n")
+    end
+    
+    def code(name)
+      return @code[name] if @code[name]
+      settings = packer_settings(name)
+      output = ERB.new(source).result(@build.helper.get_binding)
+      @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/lib/jake.rb

@@ -0,0 +1,43 @@
+module Jake
+  VERSION = '0.9.0'
+  
+  CONFIG_FILE = 'jake.yml'
+  HELPER_FILE = 'Jakefile'
+  
+  def self.build(path, force = false)
+    build = Build.new(path)
+    build.force! if force
+    build.run!
+  end
+  
+  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
+  end
+  
+  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)
+      output[(key.to_sym rescue key) || key] = value
+      output
+    end
+  end
+  
+  class Helper
+    attr_accessor :build
+    def get_binding; binding; end
+  end
+end
+
+require File.dirname(__FILE__) + '/jake/build'
+require File.dirname(__FILE__) + '/jake/buildable'
+require File.dirname(__FILE__) + '/jake/package'
+require File.dirname(__FILE__) + '/jake/bundle'
+
+def jake(name, &block)
+  Jake::Helper.class_eval do
+    define_method(name, &block)
+  end
+end
+ 

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: jake
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- James Coglan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-11 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !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: packr
+  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
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.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.
+email: 
+- jcoglan@googlemail.com
+executables: 
+- jake
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/jake
+- lib/jake.rb
+- lib/jake/build.rb
+- lib/jake/buildable.rb
+- lib/jake/package.rb
+- lib/jake/bundle.rb
+- test/test_jake.rb
+has_rdoc: true
+homepage: http://github.com/jcoglan/jake
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: jake
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Jake is a tool for building JavaScript library packages from source code
+test_files: 
+- test/test_jake.rb