sprockets-cjs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64898acf10d5fe233bdd169808758a84fce68076
+  data.tar.gz: 1c6fcc6b441b0f1273cbec13080b3b5042cefb8a
+SHA512:
+  metadata.gz: 411b66b90a36da5426b002df41a05bd87eb6afff0c13a023a91a1c8ea8f4f72c9063c9af83bf1d39850b8c94d9d4688c4d321e156f84317041cbfe1b8726d8b7
+  data.tar.gz: cfba1fe22f96ebc00ce6355712cbc40aba10bf10aa33bbbead9f7e37272566d4585281f122ae9fab2fbd44a53efb6432e4fdd471f1fae1e0000efe98f1608753

data/.gitignore

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

data/Appraisals

@@ -0,0 +1,31 @@
+appraise "sprockets-2-1" do
+  gem 'sprockets', '~> 2.1.3'
+end
+
+appraise "sprockets-2-2" do
+  gem 'sprockets', '~> 2.2.2'
+end
+
+appraise "sprockets-2-3" do
+  gem 'sprockets', '~> 2.3.2'
+end
+
+appraise "sprockets-2-4" do
+  gem 'sprockets', '~> 2.4.5'
+end
+
+appraise "sprockets-2-5" do
+  gem 'sprockets', '~> 2.5.0'
+end
+
+appraise "sprockets-2-6" do
+  gem 'sprockets', '~> 2.6.0'
+end
+
+appraise "sprockets-2-7" do
+  gem 'sprockets', '~> 2.7.0'
+end
+
+appraise "sprockets-2-8" do
+  gem 'sprockets', '~> 2.8.2'
+end

data/Gemfile

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

data/README.md

@@ -0,0 +1,39 @@
+This library adds CommonJS support to [Sprockets](https://github.com/sstephenson/sprockets).
+
+## About
+
+This project is a fork of the original [sprockets-commonjs](https://github.com/maccman/sprockets-commonjs). 
+
+Due to the lack of maintainance of the original project, I decided to create a new one based on it, make some changes and publish it as a new gem.
+
+## 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 storing any JS files you want in a folder called `modules`
+
+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-cjs'` to your `Gemfile`
+1. Add your javascript files inside a  `modules` folder
+1. Require all the modules, e.g.: `//= require_tree ./modules`
+1. Or, require individual modules, e.g.: `//= require ./modules/users`

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/gem_tasks'
+require 'sprockets'
+require 'sprockets/cjs'
+require 'rake/testtask'
+require 'appraisal'
+
+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.test_files = FileList['test/**/*_test.rb']
+  t.libs << 'lib' << '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,11 @@
+module.exports = function(){
+  alert('Long live the Programs!');
+};
+var Program = require('./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.js

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

data/examples/modules/user.js

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

data/gemfiles/sprockets_2_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.1.3"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_1.gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: /Users/jamesarosen/Projects/sprockets-commonjs
+  specs:
+    sprockets-commonjs (0.0.4)
+      sprockets (~> 2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    appraisal (0.5.1)
+      bundler
+      rake
+    hike (1.2.1)
+    rack (1.4.1)
+    rake (10.0.3)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.5.1)
+  sprockets (~> 2.1.3)
+  sprockets-commonjs!

data/gemfiles/sprockets_2_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.2.2"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_2.gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: /Users/jamesarosen/Projects/sprockets-commonjs
+  specs:
+    sprockets-commonjs (0.0.4)
+      sprockets (~> 2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    appraisal (0.5.1)
+      bundler
+      rake
+    hike (1.2.1)
+    multi_json (1.5.0)
+    rack (1.4.1)
+    rake (10.0.3)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.5.1)
+  sprockets (~> 2.2.2)
+  sprockets-commonjs!

data/gemfiles/sprockets_2_3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.3.2"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_3.gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: /Users/jamesarosen/Projects/sprockets-commonjs
+  specs:
+    sprockets-commonjs (0.0.4)
+      sprockets (~> 2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    appraisal (0.5.1)
+      bundler
+      rake
+    hike (1.2.1)
+    multi_json (1.5.0)
+    rack (1.4.1)
+    rake (10.0.3)
+    sprockets (2.3.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.5.1)
+  sprockets (~> 2.3.2)
+  sprockets-commonjs!

data/gemfiles/sprockets_2_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.4.5"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_4.gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: /Users/jamesarosen/Projects/sprockets-commonjs
+  specs:
+    sprockets-commonjs (0.0.4)
+      sprockets (~> 2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    appraisal (0.5.1)
+      bundler
+      rake
+    hike (1.2.1)
+    multi_json (1.5.0)
+    rack (1.4.1)
+    rake (10.0.3)
+    sprockets (2.4.5)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.5.1)
+  sprockets (~> 2.4.5)
+  sprockets-commonjs!

data/gemfiles/sprockets_2_5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.5.0"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_5.gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: /Users/jamesarosen/Projects/sprockets-commonjs
+  specs:
+    sprockets-commonjs (0.0.4)
+      sprockets (~> 2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    appraisal (0.5.1)
+      bundler
+      rake
+    hike (1.2.1)
+    multi_json (1.5.0)
+    rack (1.4.1)
+    rake (10.0.3)
+    sprockets (2.5.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.5.1)
+  sprockets (~> 2.5.0)
+  sprockets-commonjs!

data/gemfiles/sprockets_2_6.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.6.0"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_6.gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: /Users/jamesarosen/Projects/sprockets-commonjs
+  specs:
+    sprockets-commonjs (0.0.4)
+      sprockets (~> 2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    appraisal (0.5.1)
+      bundler
+      rake
+    hike (1.2.1)
+    multi_json (1.5.0)
+    rack (1.4.1)
+    rake (10.0.3)
+    sprockets (2.6.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.5.1)
+  sprockets (~> 2.6.0)
+  sprockets-commonjs!

data/gemfiles/sprockets_2_7.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.7.0"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_7.gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: /Users/jamesarosen/Projects/sprockets-commonjs
+  specs:
+    sprockets-commonjs (0.0.4)
+      sprockets (~> 2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    appraisal (0.5.1)
+      bundler
+      rake
+    hike (1.2.1)
+    multi_json (1.5.0)
+    rack (1.4.1)
+    rake (10.0.3)
+    sprockets (2.7.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.5.1)
+  sprockets (~> 2.7.0)
+  sprockets-commonjs!

data/gemfiles/sprockets_2_8.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "sprockets", "~> 2.8.2"
+
+gemspec :path=>"../"

data/gemfiles/sprockets_2_8.gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: /Users/jamesarosen/Projects/sprockets-commonjs
+  specs:
+    sprockets-commonjs (0.0.4)
+      sprockets (~> 2.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    appraisal (0.5.1)
+      bundler
+      rake
+    hike (1.2.1)
+    multi_json (1.5.0)
+    rack (1.4.1)
+    rake (10.0.3)
+    sprockets (2.8.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 0.5.1)
+  sprockets (~> 2.8.2)
+  sprockets-commonjs!

data/lib/assets/javascripts/sprockets/cjs.js

@@ -0,0 +1,61 @@
+(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) {
+          cache[path] = module.exports;
+          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/cjs/engine.rb

@@ -0,0 +1,15 @@
+require 'sprockets/cjs'
+
+if defined?(Rails)
+  module Sprockets
+    class CJS
+
+      class Engine < ::Rails::Engine
+        initializer :setup_commonjs, :after => "sprockets.environment", :group => :all do |app|
+          app.assets.register_postprocessor 'application/javascript', CJS
+        end
+      end
+
+    end
+  end
+end

data/lib/sprockets/cjs.rb

@@ -0,0 +1,49 @@
+require 'sprockets'
+require 'tilt'
+
+module Sprockets
+  class CJS < Tilt::Template
+
+    WRAPPER = '%s.define({"%s":' +
+              'function(exports, require, module){' +
+              '%s' +
+              ";}});\n"
+
+    class << self
+      attr_accessor :default_namespace
+    end
+
+    self.default_mime_type = 'application/javascript'
+    self.default_namespace = 'this.require'
+
+    protected
+
+    def prepare
+      @namespace = self.class.default_namespace
+    end
+
+    def evaluate(scope, locals, &block)
+      if commonjs_module?(scope)
+        scope.require_asset 'sprockets/cjs'
+        WRAPPER % [ namespace, commonjs_module_name(scope), data ]
+      else
+        data
+      end
+    end
+
+    private
+
+    attr_reader :namespace
+
+    def commonjs_module?(scope)
+      scope.pathname.to_s.include?('modules')
+    end
+
+    def commonjs_module_name(scope)
+      scope.logical_path.to_s
+    end
+
+  end
+end
+
+require 'sprockets/cjs/engine'

data/lib/sprockets-cjs.rb

@@ -0,0 +1,2 @@
+require 'sprockets/cjs'
+require 'sprockets/cjs/engine'

data/sprockets-cjs.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "sprockets-cjs"
+  s.version     = '0.1.0'
+  s.authors     = ["Alex MacCaw, Giulian Drimba"]
+  s.email       = ["info@eribium.org","giuliandrimba@gmail.com"]
+  s.homepage    = ""
+  s.license     = 'MIT'
+  s.summary     = %q{Adds CommonJS support to Sprockets}
+  s.description = s.summary
+
+  s.rubyforge_project = "sprockets-cjs"
+
+  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.1"
+  s.add_development_dependency 'appraisal', '~> 0.5.1'
+end

data/test/bar.js

@@ -0,0 +1 @@
+window.bar = "Bar!"

data/test/modules/foo.js

@@ -0,0 +1 @@
+module.exports = "Foo!";

data/test/source.js

@@ -0,0 +1,2 @@
+//= require ./modules/foo.js
+//= require bar.js

data/test/sprockets_cjs_test.rb

@@ -0,0 +1,35 @@
+require 'test/unit'
+require 'tempfile'
+require 'sprockets-cjs'
+
+class SprocketsCJSTest < Test::Unit::TestCase
+
+  TEST_DIR = File.expand_path('..', __FILE__)
+  LIB_DIR  = File.expand_path('../lib/assets/javascripts', TEST_DIR)
+
+  attr_reader :output
+
+  def setup
+    env = Sprockets::Environment.new
+    env.register_postprocessor 'application/javascript', Sprockets::CJS
+    env.append_path TEST_DIR
+    env.append_path LIB_DIR
+    outfile = Tempfile.new('sprockets-output')
+    env['source.js'].write_to outfile.path
+    @output = File.read outfile.path
+  end
+
+  def test_adds_commonjs_require
+    assert_match %r[var require = function\(name, root\) {], @output
+  end
+
+  def test_modularizes_modules
+    assert_match %r[require.define\({\"modules/foo\":function], @output
+    assert_match %r["Foo!"], @output
+  end
+
+  def test_does_not_modularize_non_modules
+    assert_no_match %r[require.define\({\"bar\":function], @output
+  end
+
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: sprockets-cjs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex MacCaw, Giulian Drimba
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+description: Adds CommonJS support to Sprockets
+email:
+- info@eribium.org
+- giuliandrimba@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Appraisals
+- Gemfile
+- README.md
+- Rakefile
+- examples/application.js
+- examples/example.js
+- examples/index.html
+- examples/modules/program.js
+- examples/modules/user.js
+- gemfiles/sprockets_2_1.gemfile
+- gemfiles/sprockets_2_1.gemfile.lock
+- gemfiles/sprockets_2_2.gemfile
+- gemfiles/sprockets_2_2.gemfile.lock
+- gemfiles/sprockets_2_3.gemfile
+- gemfiles/sprockets_2_3.gemfile.lock
+- gemfiles/sprockets_2_4.gemfile
+- gemfiles/sprockets_2_4.gemfile.lock
+- gemfiles/sprockets_2_5.gemfile
+- gemfiles/sprockets_2_5.gemfile.lock
+- gemfiles/sprockets_2_6.gemfile
+- gemfiles/sprockets_2_6.gemfile.lock
+- gemfiles/sprockets_2_7.gemfile
+- gemfiles/sprockets_2_7.gemfile.lock
+- gemfiles/sprockets_2_8.gemfile
+- gemfiles/sprockets_2_8.gemfile.lock
+- lib/assets/javascripts/sprockets/cjs.js
+- lib/sprockets-cjs.rb
+- lib/sprockets/cjs.rb
+- lib/sprockets/cjs/engine.rb
+- sprockets-cjs.gemspec
+- test/bar.js
+- test/modules/foo.js
+- test/source.js
+- test/sprockets_cjs_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: sprockets-cjs
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Adds CommonJS support to Sprockets
+test_files:
+- test/bar.js
+- test/modules/foo.js
+- test/source.js
+- test/sprockets_cjs_test.rb