jsrebuild 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+doc
+test/build
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/History.txt

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+=== 1.0.0 / 2011-08-12
+
+* Initial release.

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2011, the OTHER media.
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+    * Neither the name of the OTHER media nor the names of other contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,55 @@
+jsrebuild
+=========
+
+**jsrebuild** dynamically runs the [Jake] build tool to rebuild JavaScript
+projects in development environments.
+
+[Jake]: https://github.com/jcoglan/jake
+
+Overview
+--------
+
+Jake is often run as part of a website's build process, building JavaScript
+packages from source files. This often leads to a tedious situation for
+projects which use Jake, as the developer must continually run the `jake`
+command to rebuild their JavaScript files as they make changes to the source
+code.
+
+The `jsrebuild` utility provides a solution to this problem: it watches a
+source directory and rebuilds the project whenever changes are made to the
+source files, `jake.yml` config file and the `Jakefile` helper file.
+
+
+Installation
+------------
+
+jsrebuild uses the [Cool.io] library which depends on [libev], a low-level
+event loop library, so you will need to have libev installed before attempting
+to install the jsrebuild gem.
+
+jsrebuild is available from RubyGems, so you can install it and its
+dependencies simply by running
+
+    gem install jsrebuild
+
+[cool.io]: https://github.com/tarcieri/cool.io
+[libev]: http://software.schmorp.de/pkg/libev.html
+
+
+Running `jsrebuild`
+-------------------
+
+To watch a particular directory such as `~/projects/mywebapp` for changes, just
+run
+
+    jsrebuild ~/projects/mywebapp
+
+The `jsrebuild` tool takes a number of command-line arguments, allowing you to
+set options such as the interval at which it checks files for changes, and
+whether or not to force all the project's packages to be rebuild whenever a
+change is made.
+
+For a full list of options, run `jsrebuild --help`.
+
+`jsrebuild` will happily run daemonised. To shut down the process, simply send
+it `SIGHUP` and it will shut down the event loop and exit cleanly.

data/bin/jsrebuild

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+lib = File.dirname(__FILE__) + '/../lib'
+$:.unshift(lib) unless $:.include?(lib)
+
+require 'oyster'
+require 'jsrebuild'
+
+spec = Oyster.spec do
+  name "jsrebuild -- dynamic rebuilder for JavaScript projects"
+  
+  synopsis <<-EOS
+    jsrebuild [--force] [--interval TIME] [DIR]
+  EOS
+  
+  description <<-EOS
+    Dynamically runs the Jake build tool to rebuild JavaScript
+    projects in development environments.
+  EOS
+  
+  flag  :force,    :default => false,
+        :desc => "Force a rebuild of all files when any change is made"
+  
+  float :interval, :default => 0.5,
+        :desc => <<-EOS
+          Set the frequency (in seconds) with which files are checked for
+          modifications.
+        EOS
+  
+  author "Benedict Eastaugh <benedict@eastaugh.net>"
+end
+
+begin
+    opts = spec.parse
+  rescue Oyster::HelpRendered
+    exit(true)
+end
+
+dir          = File.expand_path(opts[:unclaimed].first || '.')
+interval     = opts[:interval]
+jake_options = {
+  :force => opts[:force]
+}
+
+unless File.directory?(dir)
+  $stderr.puts "Directory \"#{dir}\" does not exist"
+  exit(false)
+end
+
+
+unless File.readable?(dir)
+  $stderr.puts "Directory \"#{dir}\" is not readable"
+  exit(false)
+end
+
+runner = JSRebuild::Runner.new(dir, interval, jake_options)
+runner.run!

data/jsrebuild.gemspec

@@ -0,0 +1,32 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'jsrebuild/version'
+
+Gem::Specification.new do |gem|
+  gem.name         = "jsrebuild"
+  gem.version      = JSRebuild::VERSION
+  gem.platform     = Gem::Platform::RUBY
+  
+  gem.author       = "Benedict Eastaugh"
+  gem.email        = "benedict@eastaugh.net"
+  gem.homepage     = "https://github.com/othermedia/jsrebuild"
+  
+  gem.summary      = "Dynamic rebuilder for JavaScript projects"
+  gem.description  = "Dynamically runs the Jake build tool to rebuild JavaScript
+                      projects in development environments.".sub(/\s+/, " ")
+  
+  gem.license      = "BSD"
+  
+  gem.add_dependency "cool.io",  ">= 1.1.0"
+  gem.add_dependency "eventful", ">= 1.0.0"
+  gem.add_dependency "jake",     ">= 1.0.1"
+  gem.add_dependency "oyster",   ">= 0.9.5"
+  
+  gem.executables  = ['jsrebuild']
+  gem.require_path = 'lib'
+  gem.files        = `git ls-files`.split(/\s+/)
+end

data/lib/jsrebuild.rb

@@ -0,0 +1,17 @@
+require 'time'
+
+require 'coolio'
+require 'eventful'
+require 'jake'
+
+module JSRebuild
+  CONFIG_FILE = Jake::CONFIG_FILE
+  HELPER_FILE = Jake::HELPER_FILE
+  
+  LOG_FORMAT  = "%-020s %-10s %-040s %-07s"
+  
+  require 'jsrebuild/version'
+  require 'jsrebuild/config'
+  require 'jsrebuild/watcher'
+  require 'jsrebuild/runner'
+end

data/lib/jsrebuild/config.rb

@@ -0,0 +1,18 @@
+module JSRebuild
+  
+  class Config < Jake::Build
+    def source_files
+      @packages.inject([]) { |files, (_, pkg)|
+        files.concat(pkg.files)
+      }
+    end
+    
+    def config_file
+      Jake.path(@dir, Jake::CONFIG_FILE)
+    end
+    
+    def helper_file
+      Jake.path(@dir, Jake::HELPER_FILE)
+    end
+  end
+end

data/lib/jsrebuild/runner.rb

@@ -0,0 +1,64 @@
+module JSRebuild
+  class Runner
+    def initialize(dir, interval, jake_options)
+      @dir          = Jake.path(dir || Dir.getwd)
+      @jake_options = jake_options
+      @config       = load_config!
+      @watcher      = Watcher.new(interval, @config)
+    end
+    
+    def rebuild!
+      Jake::Build.delete_observers
+      
+      build = Jake::Build.new(@dir, @jake_options)
+      
+      build.on(:file_created) do |build, pkg, build_type, path|
+        size = (File.size(path) / 1024.0).ceil
+        $stderr.puts LOG_FORMAT % [pkg.name, build_type, path.gsub(@dir, ''), "#{ size } kB"]
+      end
+      
+      build.on(:file_not_changed) do |build, pkg, build_type, path|
+        $stderr.puts LOG_FORMAT % [pkg.name, build_type, path.gsub(@dir, ''), 'UP-TO-DATE']
+      end
+      
+      begin
+        build.run!
+      rescue => err
+        $stderr.puts err.message + "\n" + (err.backtrace * "\n")
+      end
+    end
+    
+    def load_config!
+      @config = Config.new(@dir, @jake_options)
+    end
+    
+    def run!
+      %w{HUP INT}.each do |sig|
+        Signal.trap(sig) { exit! }
+      end
+      
+      @watcher.on :config_change do |w, path|
+        load_config!
+        rebuild!
+      end
+      
+      @watcher.on :helper_change do |w, path|
+        load_config!
+        rebuild!
+      end
+      
+      @watcher.on :source_change do |w, path|
+        rebuild!
+      end
+      
+      rebuild!
+      
+      @watcher.start
+    end
+    
+    def exit!
+      @watcher.stop
+      exit(true)
+    end
+  end
+end

data/lib/jsrebuild/version.rb

@@ -0,0 +1,3 @@
+module JSRebuild
+  VERSION = "1.0.0"
+end

data/lib/jsrebuild/watcher.rb

@@ -0,0 +1,112 @@
+module JSRebuild
+  # Every jsrebuild process has a Watcher, which keeps tabs on the config,
+  # helper and source files and notifies the application if any of them change.
+  class Watcher
+    include Eventful
+    
+    # Set the interval at which files should be checked for changes, and pass
+    # in a JSRebuild::Config object which tells the watch which config, helper
+    # and source files it should watch.
+    def initialize(interval = 0.5, config)
+      @interval       = interval
+      @config         = config
+      @loop           = nil
+      @watchers       = nil
+      @config_watcher = nil
+      @helper_watcher = nil
+    end
+    
+    # Start the watcher process.
+    def start
+      return unless @loop.nil?
+      
+      config_file      = @config.config_file
+      helper_file      = @config.helper_file
+      
+      @loop            = Coolio::Loop.default
+      
+      @config_watcher  = FileWatcher.new(config_file, @interval)
+      @helper_watcher  = FileWatcher.new(helper_file, @interval)
+      
+      @config_watcher.on :change do
+        fire(:config_change, config_file)
+        reattach_source_watchers
+      end
+      
+      @helper_watcher.on :change do
+        fire(:helper_change, helper_file)
+        reattach_source_watchers
+      end
+      
+      @config_watcher.attach(@loop)
+      @helper_watcher.attach(@loop)
+      
+      attach_source_watchers
+      
+      @loop.run
+    end
+    
+    # Detach all current source watchers and attach new ones.
+    #
+    # This is a simple and robust way of ensuring that when changes are made
+    # which change which files should be watched, only those files which should
+    # be watched are watched, and no others.
+    def reattach_source_watchers
+      detach_source_watchers
+      attach_source_watchers
+    end
+    
+    # Attach a file watcher to each source file.
+    def attach_source_watchers
+      @source_watchers = {}
+      
+      @config.source_files.each do |file|
+        watcher = FileWatcher.new(file, @interval)
+        @source_watchers[file] = watcher
+        
+        watcher.on :change do
+          fire(:source_change, file)
+        end
+        
+        watcher.attach(@loop)
+      end
+    end
+    
+    # Detach all current source watchers.
+    def detach_source_watchers
+      unless @source_watchers.nil? || @source_watchers.empty?
+        @source_watchers.each do |file, watcher|
+          watcher.detach
+        end
+      end
+    end
+    
+    # Detach all watchers and stop the event loop.
+    def stop
+      detach_source_watchers
+      
+      @config_watcher.detach
+      @helper_watcher.detach
+      
+      @loop.stop
+    end
+  end
+  
+  # The FileWatcher class is a small extension to the Coolio::StatWatcher class
+  # which encapsulates one further piece of information, the last time the
+  # watched file was changed.
+  #
+  # When the watched file changes, FileWatcher objects notify any observers
+  # only when the file has been modified since it was last checked.
+  class FileWatcher < Coolio::StatWatcher
+    include Eventful
+    
+    # Notify any observers if either the file no longer exists, or if the file
+    # has been modified since it was last checked.
+    def on_change(prev, current)
+      fire(:change) and return unless File.exists?(path)
+      
+      fire(:change) if current.ctime > prev.ctime
+    end
+  end
+end

data/test/Jakefile

@@ -0,0 +1 @@
+$stderr.puts "Jake helper file running..."

data/test/jake.yml

@@ -0,0 +1,18 @@
+---
+source_directory: source
+build_directory:  build
+layout:           together
+
+builds:
+  source:
+    suffix:       false
+    packer:       false
+  min:
+    shrink_vars:  true
+    private:      true
+
+packages:
+  fake:
+    files:
+      - fake_core
+      - fake_ui

data/test/source/fake_core.js

@@ -0,0 +1 @@
+var Fake = {};

data/test/source/fake_ui.js

@@ -0,0 +1,3 @@
+var Faker = function(bar) {
+    this._foo = bar;
+};

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: jsrebuild
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Benedict Eastaugh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cool.io
+  requirement: &2152045800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152045800
+- !ruby/object:Gem::Dependency
+  name: eventful
+  requirement: &2152045300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152045300
+- !ruby/object:Gem::Dependency
+  name: jake
+  requirement: &2152044840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152044840
+- !ruby/object:Gem::Dependency
+  name: oyster
+  requirement: &2152044380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152044380
+description: ! "Dynamically runs the Jake build tool to rebuild JavaScript\n                      projects
+  in development environments."
+email: benedict@eastaugh.net
+executables:
+- jsrebuild
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- History.txt
+- LICENSE
+- README.md
+- bin/jsrebuild
+- jsrebuild.gemspec
+- lib/jsrebuild.rb
+- lib/jsrebuild/config.rb
+- lib/jsrebuild/runner.rb
+- lib/jsrebuild/version.rb
+- lib/jsrebuild/watcher.rb
+- test/Jakefile
+- test/jake.yml
+- test/source/fake_core.js
+- test/source/fake_ui.js
+homepage: https://github.com/othermedia/jsrebuild
+licenses:
+- BSD
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Dynamic rebuilder for JavaScript projects
+test_files: []