sprockets-commonjs 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sprockets-commonjs.gemspec
+gemspec

data/README.md

@@ -0,0 +1,32 @@
+This library adds CommonJS support to [Sprockets](https://github.com/sstephenson/sprockets).
+
+## What is CommonJS?
+
+The CommonJS module format is a way of encapsulating JavaScript libraries, ensuring they have to explicitly require and export properties they use. In a nutshell:
+
+1. You require in files using `require()`:
+
+    var Asset = require('models/asset');
+
+2. You export properties using `module.exports`:
+
+    var Asset = function(){ /* ... */ };
+    module.exports = Asset;
+
+## This library
+
+This library adds CommonJS support to Sprockets, so it can wrap up JavaScript files as modules, and serve them appropriately. This is done by giving any JS files you want as modules, the `.module.js` extension.
+
+Sprockets will then wrap up the JS library when it's requested, with the following:
+
+    require.define({'library/name': function(exports, require, module){ /* Your library */ }});
+
+`require.define()` is defined inside `commonjs.js`, which you'll need to include in the page before any modules are loaded.
+
+One caveat to the approach this library takes, is that dependencies loaded through `require()` will not be added to the dependency graph. This library will not parse the AST tree for require calls. This decision has been made for a variety of reasons, but it does mean you need to require files through both CommonJS and Sprockets.
+
+## Usage
+
+1. Add `gem 'sprockets-commonjs'` to your `Gemfile`
+1. Add `.module.js` to any JavaScript files you want as modules, i.e. `users.module.js`
+1. Require all the modules, e.g.: `//= require_tree ./modules`

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler/gem_tasks'
+require 'sprockets'
+require 'sprockets/commonjs'
+require 'rake/testtask'
+
+task :example do
+  env = Sprockets::Environment.new(File.expand_path('..', __FILE__))
+  env.append_path 'examples/'
+
+  target = File.expand_path('../examples/example.js', __FILE__)
+  env['application.js'].write_to target
+end
+
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.warning = true
+end

data/examples/application.js

@@ -0,0 +1,3 @@
+//= require_tree ./modules
+
+var self = 'application.js';

data/examples/example.js

@@ -0,0 +1,74 @@
+(function() {
+  var modules = {}, cache = {};
+
+  if (this.require && this.require.modules) {
+    modules = this.require.modules;
+  }
+
+  var require = function(name, root) {
+    var path = expand(root, name), indexPath = expand(path, './index'), module, fn;
+    module   = cache[path] || cache[indexPath];
+    if (module) {
+      return module;
+    } else if (fn = modules[path] || modules[path = indexPath]) {
+      module = {id: path, exports: {}};
+      cache[path] = module.exports;
+      fn(module.exports, function(name) {
+        return require(name, dirname(path));
+      }, module);
+      return cache[path] = module.exports;
+    } else {
+      throw 'module ' + name + ' not found';
+    }
+  };
+
+  var expand = function(root, name) {
+    var results = [], parts, part;
+    // If path is relative
+    if (/^\.\.?(\/|$)/.test(name)) {
+      parts = [root, name].join('/').split('/');
+    } else {
+      parts = name.split('/');
+    }
+    for (var i = 0, length = parts.length; i < length; i++) {
+      part = parts[i];
+      if (part == '..') {
+        results.pop();
+      } else if (part != '.' && part != '') {
+        results.push(part);
+      }
+    }
+    return results.join('/');
+  };
+
+  var dirname = function(path) {
+    return path.split('/').slice(0, -1).join('/');
+  };
+
+  this.require = function(name) {
+    return require(name, '');
+  };
+
+  this.require.define = function(bundle) {
+    for (var key in bundle) {
+      modules[key] = bundle[key];
+    }
+  };
+
+  this.require.modules = modules;
+  this.require.cache   = cache;
+  return this.require;
+}).call(this);
+this.require.define({"modules/program.module":function(exports, require, module){module.exports = function(){
+  alert('Long live the Programs!');
+};
+;}});
+this.require.define({"modules/user.module":function(exports, require, module){var Program = require('modules/program');
+
+module.exports = function(){
+  alert('Long live the Users');
+  Program();
+};
+;}});
+
+var self = 'application.js';

data/examples/index.html

@@ -0,0 +1,4 @@
+<script src="example.js" type="text/javascript" charset="utf-8"></script>
+<script type="text/javascript" charset="utf-8">
+  require('modules/user')();
+</script>

data/examples/modules/program.module.js

@@ -0,0 +1,3 @@
+module.exports = function(){
+  alert('Long live the Programs!');
+};

data/examples/modules/user.module.js

@@ -0,0 +1,6 @@
+var Program = require('modules/program');
+
+module.exports = function(){
+  alert('Long live the Users');
+  Program();
+};

data/lib/sprockets/commonjs.js

@@ -0,0 +1,60 @@
+(function() {
+  if (!this.require) {
+    var modules = {}, cache = {};
+
+    var require = function(name, root) {
+      var path = expand(root, name), indexPath = expand(path, './index'), module, fn;
+      module   = cache[path] || cache[indexPath];
+      if (module) {
+        return module;
+      } else if (fn = modules[path] || modules[path = indexPath]) {
+        module = {id: path, exports: {}};
+        cache[path] = module.exports;
+        fn(module.exports, function(name) {
+          return require(name, dirname(path));
+        }, module);
+        return cache[path] = module.exports;
+      } else {
+        throw 'module ' + name + ' not found';
+      }
+    };
+
+    var expand = function(root, name) {
+      var results = [], parts, part;
+      // If path is relative
+      if (/^\.\.?(\/|$)/.test(name)) {
+        parts = [root, name].join('/').split('/');
+      } else {
+        parts = name.split('/');
+      }
+      for (var i = 0, length = parts.length; i < length; i++) {
+        part = parts[i];
+        if (part == '..') {
+          results.pop();
+        } else if (part != '.' && part != '') {
+          results.push(part);
+        }
+      }
+      return results.join('/');
+    };
+
+    var dirname = function(path) {
+      return path.split('/').slice(0, -1).join('/');
+    };
+
+    this.require = function(name) {
+      return require(name, '');
+    };
+
+    this.require.define = function(bundle) {
+      for (var key in bundle) {
+        modules[key] = bundle[key];
+      }
+    };
+
+    this.require.modules = modules;
+    this.require.cache   = cache;
+  }
+
+  return this.require;
+}).call(this);

data/lib/sprockets/commonjs.rb

@@ -0,0 +1,40 @@
+require 'sprockets'
+require 'tilt'
+
+module Sprockets
+  class CommonJS < Tilt::Template
+    self.default_mime_type = 'application/javascript'
+
+    def self.default_namespace
+      'this.require'
+    end
+
+    def prepare
+      @namespace = self.class.default_namespace
+    end
+
+    attr_reader :namespace
+
+    def evaluate(scope, locals, &block)
+      if File.extname(scope.logical_path) == '.module'
+        path = scope.logical_path
+        path = File.join(File.dirname(path), File.basename(path, '.module'))
+        path = path.inspect
+
+        scope.require_asset 'sprockets/commonjs'
+
+        code = ''
+        code << "#{namespace}.define({#{path}:"
+        code << 'function(exports, require, module){'
+        code << data
+        code << ";}});\n"
+        code
+      else
+        data
+      end
+    end
+  end
+
+  register_postprocessor 'application/javascript', CommonJS
+  append_path File.expand_path('../..', __FILE__)
+end

data/sprockets-commonjs.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "sprockets-commonjs"
+  s.version     = '0.0.2'
+  s.authors     = ["Alex MacCaw"]
+  s.email       = ["info@eribium.org"]
+  s.homepage    = ""
+  s.summary     = %q{Adds CommonJS support to Sprockets}
+  s.description = s.summary
+
+  s.rubyforge_project = "sprockets-commonjs"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "sprockets", "~>2.4.0"
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: sprockets-commonjs
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Alex MacCaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: &70172867486660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70172867486660
+description: Adds CommonJS support to Sprockets
+email:
+- info@eribium.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- examples/application.js
+- examples/example.js
+- examples/index.html
+- examples/modules/program.module.js
+- examples/modules/user.module.js
+- lib/sprockets/commonjs.js
+- lib/sprockets/commonjs.rb
+- sprockets-commonjs.gemspec
+homepage: ''
+licenses: []
+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: sprockets-commonjs
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Adds CommonJS support to Sprockets
+test_files: []